Data Types

Data Types
A breakdown of the types represented in this document

AdaptKrigOutType

Enumeration for the Output Variable Combinations type when refining for the Kriging algorithm.

Possible Values

AK_MAXOUTMaximum Output
AK_ALLOUTAll Outputs
AK_SUMOUTSum of Outputs


AdaptMeshingFreqType

No details are provided for this entry.

Possible Values

auto
user


Aggressive

Used to specify whether mesh may deviate from geometry as a result of wrapper surface improvement. The default value is MeetTarget.

Possible Values

MeetTargetModify the geometry as needed to meet quality target.
MaintainGeometryCompromise targets to maintain geometry.


AlgorithmType

No details are provided for this entry.

Possible Values

Unknown
ProximityBased
TrajectoryBased


AllowedContinuousValues

Enumeration of the possible continuous input parameter types.

Possible Values

AnyAny
ManufacturableValuesManufacturable Values
SnapToGridSnapToGrid


AnalysisType

3D/2D import option

Possible Values

AnalysisType_3DImport all 3D objects
AnalysisType_2DImport only 2D objects (The model must be in the x-y plane.)


AnalysisType

No details are provided for this entry.

Possible Values

StressLife
StrainLife


ApplicationMethod

No details are provided for this entry.

Possible Values

TotalForce
ForcePerUnitArea


AutoTimeSteppingDefinedBy

Define Auto Time Stepping by Time or Substeps as available in MAPDL solver.

Possible Values

Substeps
Time


AxesRangeModes

Enumeration of the Automatic Range modes for output parameters.

Possible Values

OutputParameterMinMaxThe range of the output parameter axis is determined from the minimum and maximum of the parameter (min-max search of DPs min-max)
ChartDataThe range of the output parameter axis is determined by the min and max of the chart's data.


Axis

The specification of allowed chart axes.

Possible Values

None
X_Axis
Y_Axis
Z_Axis


AxisDefineBy

Options for defining an axis

Possible Values

Direction
Point


AxisType

Options specifying which axis to define

Possible Values

XAxis
YAxis
ZAxis


BiasMethod

Used to specify the bias option. Currently, this is always SmoothTransition.

Possible Values

SmoothTransition


BiasType

Used to specify the option for bias type. The default value is Constant.

Possible Values

Right
Left
CenterIn
CenterOut
Constant


BilinearIsotropicHardeningDependents

The Bilinear Isotropic Hardening dependents.

BladeLoftType

Enumeration of the possible blade lofting directions.

Possible Values

Streamwise
Spanwise


BladeType

Blade type for export to BladeGen

Possible Values

IGVIGV
RotorRotor
OGVOGV


BladeType

Blade type for export to BladeGen

Possible Values

IGVIGV
RotorRotor
OGVOGV


BMunitsType

BladeGen/BladeEditor units type

Possible Values

mCreate blade model in metres
cmCreate blade model in cm
mmCreate blade model in mm
inchesCreate blade model in inches
ftCreate blade model in feet


BMunitsType

BladeGen/BladeEditor units type

Possible Values

mmCreate blade model in mm
inchesCreate blade model in inches


BodyGrouping

The body grouping property used when importing the model.

Possible Values

NoneNo body grouping action should be performed.
MaterialThe model should be grouped by material IDs.
ElementTypeThe model should be grouped by element type IDs.
ThicknessThe model should be grouped by thickness IDs.
ComponentsThe model should be grouped by component IDs.
UnknownThe body grouping property is not set.


BodyGroupingType

Type of geometry that is being attached.

Possible Values

MaterialNumber
MaterialNumberAndThickness
NoGrouping


bool

This type represents a Boolean value. Valid values are 'True' or 'False'.

BoundaryLayerAlgorithm

Used to specify if pre or post boundary layer algorithm should be used by the mesher. The default value is Pre.

Possible Values

Post
Pre


BoundaryLayerOption

Used to specify the way heights of the boundary layers are determined. The default value is SmoothTransition.

Possible Values

TotalThicknessCreates constant boundary layers using the values of Number of Layers and Growth Rate.
FirstLayerThicknessCreates constant bounadry layers using values of First Layer Height, Maximum Layers and Growth Rate.
SmoothTransitionMesher ensures smooth rate of volume change using local tetrahedral element size.
FirstAspectRatioCreates boundary layers using values of First Aspect Ratio, Maximum Layers and Growth Rate.
LastAspectRatioCreates constant boundary layers using values of First Layer Height, Maximum Layers and Aspect Ratio.


BoxCushionType

Box cushion type options.

Possible Values

UniformUniform cushion around box.
NonuniformNon-Uniform cushion around box.


CADImportParameterType

Types of parameters to be imported from CAD True and False ARE NOT enum values to be used, but there to help support the open of old databases.

Possible Values

CADImportParameterType_NoneDo NOT import parameters
CADImportParameterType_IndependentImport editable parameters -- default value (like old true value)
CADImportParameterType_AllImport all paramters that match the filter, both independent and dependent (read-only)


CalculationFrequency

CalculationFrequency specifies the frequency to write the specified solution results of OutputType

Possible Values

AllTimePoints
LastTimePoint
EquallySpacedTimePoints
SpecifiedRecurrenceRate
Never


CalculationType

The available analysis types for an analysis.

Possible Values

UnknownNo details are provided for this entry.
NoneNo details are provided for this entry.
StaticComputation of the system that is time independent.
TimeDependentComputation of the system that is time dependent.
ModalComputation of the dynamic response of a system under excitation
FrequencyResponseFrequency domain analysis of a system
OptimizationTopology optimization analysis
AllAll domains.


CandidatesColoringMethods

Enumeration of the Coloring methods used for Candidates chart.

Possible Values

ColoringPerPointTypeThe color is used to distinguish the different types of candidate points (Starting Points, Candidate Points, etc).
ColoringPerOutputNatureThe color is used to distinguish the nature of the output values (Response Surface or Simulation).


CappingSurfaceConstructionMethod

Options for choosing selection method for capping surface.

Possible Values

CappingSurfaceFacesConstraintConstruct capping surface by capping all laminar loops of selected faces.
CappingSurfaceEdgesConstraintConstruct capping surface by capping all loops of selected edges.
CappingSurfaceLoopsConstraintConstruct capping surface by capping all specified loops.
CappingSurfaceVerticesConstraintConstruct capping surface by capping the loop formed by selected Vertices.


CasePrecision

Precision of FLUENT Session.

Possible Values

Single
Double


CCDTemplateType

Enumeration for the Template Type for CCD algorithm.

Possible Values

CCD_STANDARD_TEMPLATEStandard
CCD_ENHANCED_TEMPLATEEnhanced


CentralCompositeDesignType

Enumeration of the available design types for the Central Composite Design algorithm.

Possible Values

CCDTYPE_FACE_CENTFace-Centered
CCDTYPE_ROTRotatable
CCDTYPE_VIF_OPTVIF-Optimality
CCDTYPE_G_OPTG-Optimality
CCDTYPE_AUTOAuto Defined


ChartAxes

The possible chart axes.

Possible Values

XAxisX axis
YAxisY axis
ZAxisZ axis
XTopAxisSecondary X axis drawn at the top of the chart.
YRightAxisSecondary Y axis drawn at the right of the chart.
SweepAxisAn axis used to sweep over an additional parameter.


ChartColoringMethods

Enumeration of the Coloring methods used for Tradeoff and Samples charts.

Possible Values

ColoringPerFrontA different color for each Pareto fronts (several samples have the same color).
ColoringPerSampleA different color for each sample.


ChartStyle

Allowed styles of a multi-axis chart.

Possible Values

PCPParallel Coordinate Plot
SpiderSpider Plot


ChartType

Enumeration for the chart type.

Possible Values

ChartUnknownUnknown
ChartResponseResponse
ChartTradeoffTradeoff
ChartSamplesSamples
ChartDistributionsDistributions
ChartCorrelationCorrelation
ChartSpiderResponsesSpider
ChartLocalSensitivityLocal Sensitivity
ChartSensitivitiesSensitivities
ChartStatisticsStatistics
ChartCorrelationScatterCorrelation Scatter
ChartDesignPointsParallelParameters Parallel
ChartDesignPointsCurvesDesign Points vs. Parameters
ChartDeterminationDetermination Matrix
ChartPredictedvsObservedPredicted vs. Observed
ChartDeterminationHistogramDetermination Histogram
ChartConvergenceConvergence
ChartLocalSensitivityCurvesLocal Sensitivity Curves
ChartCustomCustom Chart
ChartCandidatesCandidates
ChartHistoryHistory
ChartConvergenceCriteriaHistory
ChartParameterRelationshipHistory


ClearanceType

Enumeration of the tip clearance specification options.

Possible Values

None
RelativeLayer
AbsoluteLayer


ClearanceType

inpeller clearance type

Possible Values

Ratiotip clearance specified as a ratio
Usertip clearance specified directly


ClearMessagesOption

Options when deleting messages.

Possible Values

KeepMessagesIfSourceMatchedDo not delete message if its source matches the specified one.
ClearMessagesIfSourceMatchedDelete message if its source matches the specified one.
ClearMessagesIfSourceNotMatchedDelete message if its source does not match the specified one.
IgnoreSourceDo not check source attribute.


CollisionAvoidance

Used to specify the strategy to be used for avoiding collisions between inflated surface meshes. The default value is StairStepping.

Possible Values

NoneNo check for layer collisions.
LayerCompressionBoundary layers are compressed in collision areas.
StairSteppingPrism layers are stair stepped to avoid collision and maintain the gap defined by gap factor.


Color

This type represents a 32-bit Red/Green/Blue/Alpha color.

When working with Workbench Scripting, a color is represented as a four entry string in the form "R G B A", where each entry is in the range 0-255. Alpha (A) is optional and will be set to 255 (opaque) if not supplied. For example:

    renderStyle1.LineColor = "255 0 0"     # Sets the line to opaque Red.
    renderStyle1.LineColor = "0 0 255 128" # Sets the line to translucent Blue.

ColorBy

Options for coloring the resulting shape model

Possible Values

Usage
Density


ColorDistributionOption

Supported color distributions.

Possible Values

Linear
Logarithmic


ColorSpaceSetting

No details are provided for this entry.

Possible Values

Linear
sRGB


ComparePartsOnUpdateMethod

Compare parts on update options

Possible Values

ComparePartsMethod_NoneDo NOT compare parts on update -- default value
ComparePartsMethod_AssociativelyCompare parts using associative mechanism, if geometry interface is non-associative expect failures in compare
ComparePartsMethod_NonAssociativelyCompare parts using entity comparisons based on index of second model to original attach


ComparePartsTolerance

Compare parts on update tolerance options

Possible Values

ComparePartsTolerance_LooseA greater loosening of the default tolerance
ComparePartsTolerance_NormalLooser tolerance than default to allow some wiggle room for slight deviations
ComparePartsTolerance_TightDefault, existing behavior


ComponentConfigType

List of available component configurations

Possible Values

ImpellerMainOnlyimpeller (main blade only)
ImpellerOneSplitterimpeller (main blade + 1 splitter)
ImpellerTwoSplittersimpeller (main blade + 2 splitters)


ComputationType

No details are provided for this entry.

Possible Values

Auto
User
Off


ConductanceControlType

Switch to use program controlled conductance value or enter value.

Possible Values

ProgramControlled
Manual


ConductivityThresholdType

No details are provided for this entry.

Possible Values

auto
user


ConstraintHandlingType

Enumeration of the Constraint Handling types.

Possible Values

AsGoalsRelaxed constraint.
AsHardConstraintsStrict constraint.


ConstraintType

Enumeration of the possible optimization constraint types.

Possible Values

CT_NoPreferenceNo constraint defined.
CT_NearTargetEquals target.
CT_LessThanTargetLess than target.
CT_GreaterThanTargetGreater than target.
CT_InsideBoundsInside bounds.


ConstructionAlgorithm

Options for choosing construction algorithm for capping surface.

Possible Values

DelaunayConstruct capping surface by using delaunay triangulation.
FillHoleConstruct capping surface by using hole filling algorithms.
ConvexHullConstruct capping surface by using convex hull approach.
AutomaticConstruct capping surface by choosing appropriate construction algorithm.


ContactConstraintType

No details are provided for this entry.

Possible Values

ProgramControlled
TargetNormalUncoupleUtoROT
TargetNormalCoupleUtoROT
InsidePinballCoupleUtoROT


ContactDetectionPoint

No details are provided for this entry.

Possible Values

ProgramControlled
DetectOnGaussPoint
DetectNodalNormalFromContact
DetectNodalNormalToTarget
DetectNodalProjectedNormalFromContact


ContactPairOutputYesNo

Activate Contact Pair Output in MAPDL solution.

Possible Values

kNo
kYes


ContactPhysicsToTransfer

Method for selecting the physics type: Program controlled or Manual

Possible Values

AllRelevant
Specified


ContactType

Type of contact for eg. Bonded, Frictional, Frictionless, etc.

Possible Values

Bonded
NoSeparation
Frictionless
Rough
Frictional


CoordinateInputMethod

Options for definining vectors

Possible Values

Entry
Location


CoordinateSystemType

Enumeration to specify the coordinate system type for imported data.

Possible Values

Cartesian
Cylindrical


CoreLossComputationType

No details are provided for this entry.

Possible Values

Auto
User
Off


CorrelationAutoStopType

Enumeration of the correlation Auto Stop types.

Possible Values

ExecuteAllSimulationsExecute all Simulations.
EnableAutoStopEnable Auto Stop: execute Simulations iteratively until the process converges or the maximum number of simulation specified is reached.


CoupledAnalysisType

The valid coupling types

Possible Values

UndefinedThis is internal option used to cache the user selection of analysis type. It cannot be specified by the user.
GeneralDefine the coupling by time steps
TransientDefine the coupling by time intervals
HarmonicDefine the coupling by frequency intervals. The harmonic coupled analysis is not currently supported.


CreateIntersectingEdgesForOverlappingBodies

Used to specify whether intersecting edges should be created for overlapping bodies. The default value is No.

Possible Values

Yes
No


CreationMode

Allows clients of a generator to tag objects as created automatically by the program or created manually by the user in a consistent manner.

Possible Values

Automatic
Manual


CrossSectionOffsetType

No details are provided for this entry.

Possible Values

Centroid
ShearCenter
Origin
UserDefined


DampedSolverType

An enumeration for damped modal solver types as available from MAPDL solver.

Possible Values

ProgramControlled
FullDamped
ReducedDamped


DataContainerReference

A reference to a data container, similar to a DataReference referring to an entity.

DataObject

Implements the virtual data model concepts for native C# code.

DataOrder

An enum of Row or Column which indicates if the Data is entered in a row-major or column-major order. The default is Row.

Possible Values

ColumnColumn-major
RowRow-major


DataReference

A Data Reference holds and manages a reference to a data entity in the Workbench data model.

DataReferenceSet

This type contains an ordered set of DataReferences. No modifications can be made to the contents.

DataTypeEnumeration

This enumeration represents all of the tensor types supported by the MPC variable.

Possible Values

ATypeAn unknown type
ScalarA scalar
VectorXYA vector in x and y components
VectorYZA vector in y and z components
VectorXZA vector in x and z components
VectorXYZA vector in x, y, and z components
VectorRAA vector in r and a components
VectorAZA vector in a and z components
VectorRZA vector in r and z components
VectorRAZA vector in r, a, and z components
VectorRIA vector in r and i components
VectorIAA vector in i and a components
VectorRIAA vector in r, i, and a components
Tensor2XYZA 2D tensor
Tensor4XYZA 4D Tensor
SymTensor2XYZA 2D symmetric tensor
SymTensor4XYZA 4D symmetric tensor
AntisymTensor2XYZAn anti-symmetric tensor


DateTime

This type represents a date and time. The default format for printing a DateTime object is "DD/MM/YYYY HH:MM:SS AMPM". Additional properties which can be examined on a DateTime object to extract extra detail include Year, Month, Day, Hour, Minute, Second and Date.

DebugLevel

Debug levels for the log output. Increasing levels generates more detailed output in the log.

Possible Values

NoneNo debug output
Level1Level 1
Level2Level 2
Level3Level 3
Level4Level 4
Level5All Levels
DefaultUse Default Output Level


DefineBy

No details are provided for this entry.

Possible Values

ultStrength
SNCurve
Material


DefineBy

This enum is used to set how tolerance is specified. It can be program controlled or user can manual set the property value.

Possible Values

ProgramControlled
UserDefined


DeformationScaling

How much to deform the Results display

Possible Values

None
Actual
FiftyPercent
OneHundredPercent
TwoHundredPercent
FiveHundredPercent
FiveHundrenPercent
Custom


DelimiterType

Enumeration to specify the type of delimiter in imported data.

Possible Values

Comma
Semicolon
Space
Tab
UserDefined


DerivationType

The enum values for the Derivation property to use for the IsotropicElasticity values.

Possible Values

Unknown
YoungsModulusPoissonsRatio
ShearModulusPoissonsRatio
BulkModulusPoissonsRatio
YoungsModulusShearModulus
YoungsModulusBulkModulus
BulkModulusShearModulus


DerivativeApproximationType

Enumeration for the derivative approximation type.

Possible Values

DA_CentralDifferenceCentral Difference
DA_ForwardDifferenceForward Difference


DesignPointJobControl

Design point job control to RSM

Possible Values

OneJobAllDesignPointsSubmit one job for all design points
OneJobPerDesignPointSubmit one job per design point
OneJobForGroupDesignPointSubmit one job for group design point


DesignPointLicenseCheckout

License Checkout

Possible Values

OnDemandCheckout License on demand
ReservedCheckout License reserved


DesignPointRetainedOrExportedUpdate

Retained or Exported design point update

Possible Values

ParametersUpdate parameters
FullProjectUpdate full project


DesignPointState

Indicates a design point parameter's current state.

Possible Values

NeverSolvedAndFailedParameter has never been successfully updated and the last update failed.
NeverSolvedParameter has never been updated.
FailedParameter was previously UpToDate but last update failed.
OutOfDateParameter was previously UpToDate or Failed but has become out of date by either design point input value changes or a non-parametric change within in the project.
InterruptedParameter is updated but the update was interrupted
UpToDateParameter is successfully updated.


DesignPointUpdateOrder

Design point update order

Possible Values

UpdateFromCurrentDesignPointUpdate from base
UpdateDesignPointsInOrderUpdate desing points in order


DeterminationCoefficientChartModes

Enumeration of the Determination Coefficient chart modes.

Possible Values

LinearDisplay linear determination coefficients.
QuadraticDisplay quadratic determination coefficients.


Dictionary<Key, Value>

This type represents a data dictionary, where a Key is used to access an associated Value. When used in scripting, a dictionary is created or printed using the form

myDict = {key1:value1, key2:value2, ...}

Python functionality can be used to examine dictionary keys, test for key existence and perform other useful operations on dictionaries.

The following example shows the use of dictionaries in a Workbench script:

    >>> template1 = GetTemplate(
            TemplateName="Fluid Flow",
            Solver="CFX")
    >>> system1 = template1.CreateSystem()
    >>> solution1 = system1.GetContainer(ComponentName="Solution")
    >>> cfxSolutionProperties1 = solution1.GetCFXSolutionProperties()
    >>> currentProps = cfxSolutionProperties1.GetEntityProperties()
    >>> for key in currentProps.Keys:
            print "%s = %s" % (key, currentProps[key])
            
    SolverCommandMode = Foreground
    DisplayText = Solution Source
    InitializationOption = CurrentSolutionData
    LoadMResOptions = LastConfigOnly
    ResultsFile = None
    >>> myProps={"SolverCommandMode":"Background","InitializationOption":"InitialConditions"}
    >>> cfxSolutionProperties1.SetEntityProperties(Properties=myProps)
          # The above is equivalent to:
          #   cfxSolutionProperties1.InitializationOption ="InitialConditions" 
          #   cfxSolutionProperties1.SolverCommandMode="Background"      
          

DiffuserType

diffuser type

Possible Values

Vanedvaned diffuser
Vanelessvaneless diffuser


DimensionsType

Enumeration to specify the dimensionality of imported data.

Possible Values

Dimension2D
Dimension3D


DirectionType

No details are provided for this entry.

Possible Values

NoMagnetization
Cartesian
Cylindrical
Spherical


DirectionType

The direction the streamline is moving, relative to inlets and outlets

Possible Values

Backward
Forward
Both


DisplacementType

No details are provided for this entry.

Possible Values

Unknown
TranslationAndRotation
TranslationOnly
RotationOnly


DistributionType

Enumeration of the possible parameter distribution types.

Possible Values

UniformUniform
TriangularTriangular
GaussNormal
TruncGaussTruncated Normal
LogNormLognormal
ExponentialExponential
BetaBeta
WeibullWeibull


DotStyles

Styles of dot symbols. Default is none

Possible Values

None
Ellipse
Rect
Diamond
Hexagon
Triangle
DTriangle
UTriangle
LTriangle
RTriangle
Cross
XCross
Star
Default


double

This type represents a double-precision floating point number.

DurationType

The methods used to specify duration

Possible Values

NumberOfStepsThe coupling will end at a given number of steps
EndTimeThe coupling will end at a given time


EdgeSizingMethod

Used to specify if the edge sizing should be based on the element size or on the number of divisions.

Possible Values

ElementSize
EdgeDivisions


EffType

Impeller efficiency type

Possible Values

AutomaticEfficiencies calculated from correlations
HydraulicHydraulic efficiency calculated. Volumetric, mechanical and overall pump efficiencies user defined.
VolumetricVolumetric efficiency calculated. Hydraulic, mechanical and overall pump efficiencies user defined.
MechanicalMechanical efficiency calculated. Hydraulic, volumetric and overall pump efficiencies user defined.
PumpOverall pump efficiency calculated. Hydraulic, volumetric and mechanical efficiencies user defined.


ElementMidsideNodes

Used to define whether elements are created with or without midside nodes. The default value is UseEngineeringIntent.

Possible Values

UseEngineeringIntentDetermine whether midside nodes are kept or dropped based on the Engineering Intent.
DroppedElements are created without midside nodes.
KeptElements are created with midside nodes.


ElementShape

Used to specify the mesh element shape for the bodies associated with this control.

Possible Values

Automatic
Tetrahedrons
Hexahedrons


EngineeringDataType

Supported types of engineering data.

Possible Values

Unknown
Material
Load
BeamSection
Mixture


EngineeringIntent

Used to define the kind of physics that is being studied in this simulation process (used in part-based Meshing).

Possible Values

UnknownIntent of this process is not yet known due to insufficient information in connected Physics task(s).
StructuralOrThermalOrElectricConductionIntent of this process is a structural, electric conduction and/or thermal simulation.
FluidFlowIntent of this process is a fluid flow, or a fluid-solid heat conduction simulation.


ENMeanStressTheory

No details are provided for this entry.

Possible Values

NoneEN
Morrow
SWT


EntityType

Available expression entity types

Possible Values

Node
Face
Element
Edge


EquationSolverType

Equation Solver Types as available from MAPDL solver.

Possible Values

ProgramControlled
Direct
Iterative
Unsymmetric
Supernode
Subspace


EtaCorrelType

Efficiency correlation type

Possible Values

CaseyRobinsonCasey-Robinson correlation
CaseyMartyCasey-Marty correlation
RodgersRodgers correlation


EtaCorrelType

Efficiency correlation type

Possible Values

SuhrmannSuhrmann's correlation
BainesBaines' correlation


EtaImpType

impeller isentropic efficiency type

Possible Values

LinkToStagelinked to stage efficiency
Useruser specified efficiency


EtaType

Stage efficiency type

Possible Values

UserUser defined efficiency
CorrelationEfficiency calculated from correlation


EtaType

Stage efficiency type

Possible Values

UserUser defined efficiency
CorrelationEfficiency calculated from correlation


EtaUserType

User specified stage efficiency type

Possible Values

Isentropicuser-specified isentropic efficiency
Polytropicuser-specified polytropic efficiency


ExcelConnectionState

Enumeration for the Excel Connection states

Possible Values

NotConnectedThe connection with Excel is not established
ConnectionAliveThe connection is alive
ConnectionLostThe connection has been lost


ExecutionControlConflictOptions

Options for handling execution control conflicts on Edit

Possible Values

Default
UseSetupExecutionControl
UseSetupExecutionControlAlways
UseSolutionExecutionControl
UseSolutionExecutionControlAlways


ExecutionControlSource

Enumeration for the execution control conflict resolution.

Possible Values

IssueWarning
UseExecutionControlFromSetup
UseExecutionControlFromSolution


ExitAngleType

Exit angle type

Possible Values

AbsoluteAbsolute exit angle
RelativeRelative exit angle


Expression<Type>

The Expression type is used to hold an expression that returns a result of a given type or a result in a homogenous vector of the given type.

ExpressionType

Specifies the possible types of parameter expression.

Possible Values

UndefinedAn undefined(null) expression.
ConstantAn expression without dependency on other parameter.
DerivedAn expression with dependency on other parameters.


FaceEdgePreference

No details are provided for this entry.

Possible Values

FaceAndEdgeOfDifferentParts
EdgesOfSolidBodies
EdgesOfSurfaceBodies
All


FaceFacePreference

No details are provided for this entry.

Possible Values

FacesOfDifferentParts
All


FatigueUnitType

No details are provided for this entry.

Possible Values

Cycles
Blocks
Seconds
Minutes
Hours
Days
Months


FileType

File Types recognized by FLUENT. Includes native FLUENT files as well as files that FLUENT can import or export. The Unknown File Type is used when FLUENT is unable to recognize the file type.

For more details on the file types recognized by FLUENT, please refer to the FLUENT User's Guide.

Possible Values

Mesh
Case
Data
Bc
Pdf
S2s
Flamelet
Dtrm
Udf
Udflib
UdfSource
Wave
SurfaceMonitors
VolumeMonitors
ReportDefFiles
ParticleInjections
BoundaryProfile
SolutionTranscript
SchemeFile
JOUFile
FluentResidualFile
InterpolateDataFile
registeredTypes
AbaqusFilbin
AbaqusInput
AbaqusOdb
Ansys
AnsysResults
CfxDefn
CfxResults
Cgns
CgnsMeshData
Ensight
Fidap
Fluent4
FluentMesh
Gambit
Hypermesh
IdeasUniv
LstcInput
LstcState
MarcPost
Mechanica
MetisCase
MetisZoneCase
Nastran
NastranOutput
PamDaisy
Patran
PatranResults
Pda
Prebfc
Plot3dGrid
Plot3dResults
StlAscii
StlBinary
TecplotBinary
VkiGeneric
Unknown

FillStyles

Style of any filled region. The default is None.

Possible Values

None
Solid
Dense
Medium
Sparse
Horizontal
Vertical
Cross
BDiagonal
FDiagonal
CrossDiagonal
Gradient
Default


FittingType

Enumeration for the Response Surface type.

Possible Values

FITTINGTYPE_SRSStandard Response Surface - Full second order Polynomials
FITTINGTYPE_KRIGINGKriging
FITTINGTYPE_MARSNon Parametric Regression
FITTINGTYPE_NNNeural Network
FITTINGTYPE_SPARSEGRIDSparse Grid
FITTINGTYPE_GRSGenetic Aggregation


FixFirstLayer

Used to specify whether the heights or ratios of the first boundary layer will be modified to avoid collision. The default value is No.

Possible Values

Yes
No


FlowType

Enumeration of the flow boundary condition options.

Possible Values

MassFlow
PressureRatio
PressureDifference


FluidType

Enumeration of the types of available fluids.

Possible Values

IdealGas
RealGas
Liquid


ForceType

No details are provided for this entry.

Possible Values

DC
AC


ForceTypes

No details are provided for this entry.

Possible Values

Virtual
Lorentz


FormatType

Enumeration to specify the format type for imported data.

Possible Values

UserDefined
Delimited
Cdb
Axdt
Tgz
Anf
Brd
Mcm
Sip
Bool
Cond


FormulationType

Set the contact formulation to be used by the solver for a particular contact pair.

Possible Values

ProgramControlled
MultiPointConstraint
PurePenalty
NormalLagrange
AugmentedLagrange


FreqSpecChoices

No details are provided for this entry.

Possible Values

SingleValue
Range
Tabular


GARefinementOutType

Enumeration for the Output Variable Combinations type when refining for the GARS algorithm.

Possible Values

GA_MAXOUTMaximum Output
GA_ALLOUTAll Outputs


GARefinementStatusType

Enumeration for the convergence status for the GARS algorithm.

Possible Values

CS_UNKNOWNUnknown
CS_NOTCONVERGEDNot Converged
CS_MAXPTSMaximum Number of Points Reached
CS_STOPPEDStopped by the User
CS_CONVERGEDConverged


GasModelType

gas model type

Possible Values

Idealideal gas model
Realreal gas model


GasPropType

Gas properties type

Possible Values

AirGas props - Air
AFRGas props - Air/fuel ratio
FixedGas props - Fixed


GeneralSettings

This is a class meant to provide an abstraction over different kinds of advanced result settings, such as Fatigue Settings.

GeometryAnalysisType

3D/2D Geometry import option

Possible Values

Type3DImport all 3D objects
Type2DImport only 2D objects (The model must be in the x-y plane.)


GeometryAttachType

Type of geometry that is being attached.

Possible Values

ThreeDimensional
TwoDimensional
Unknown


GeometryStyleType

Geometry export style type

Possible Values

InteractiveCreate interactive geometry
ParametricCreate parametric geometry


GoalType

Enumeration of the possible optimization objective types.

Possible Values

GT_NoPreferenceNo objective defined.
GT_MaximumPossibleMaximize.
GT_MinimumPossibleMinimize.
GT_SeekTargetSeek target.


GPUAccelerator

Enumeration for the graphics acceleration library to be used by the Mechanical APDL editor.

Possible Values

None
Amd
Intel
NVIDIA


GrowthRateType

Determines height of boundary layers for given initial height and height ratio. The default value is Geometric.

Possible Values

ExponentialHeight of boundary layer determined exponentially.
GeometricHeight of boundary layer determined geometrically.
LinearHeight of boundary layer determined linearly.


HubLEBetaType

Hub and Mean LE blade angle option

Possible Values

CotHub/Mean LE blade angle calculated using cotangent (rel to Shroud LE beta)
CosHub/Mean LE blade angle calculated using cosine (rel to Shroud LE beta)
UserUser defined hub and mean LE blade angles


ICCombustionSimulationType

Type of IC Engine Combustion simulation type.

Possible Values

ICSector0 for sector
ICFullEngineFullCycle1 for full engine full cycle
ICFullEngineClosedValves2 for full engine IVC to EVO


ICIVCandEVOoption

IVC and EVO options

Possible Values

ICLiftCurv0 lift curv profile
ICIVCandEVO1 for IVC EVO option


ICSimulationType

Type of IC Engine Simulation.

Possible Values

ICSimulationColdFlow0 for Cold Flow Simulation
ICSimulationPortFLow1 for Port Flow Simulation
ICSimulationCombustion2 for Combustion Flow Simulation


IDHandling

The ID handling property for the current object.

Possible Values

NoneNo action must be carried out when renumbering the attributes of the current object.
AutomaticThe IDs of the attributes of the current object must be automatically renumbered so that no conflicts will happen.
UnknownThe ID Handling property is not set.


ImpellerExportType

Impeller export type

Possible Values

CoupledCoupled to volute
IsolatedIsolated impeller


ImpellerLengthType

impeller length ratio type

Possible Values

Automaticautomatic
Useruser specified


ImpellerType

List of available impeller types

Possible Values

Unshroudedunshrouded impeller
Shroudedshrouded impeller


ImportanceLevel

Enumeration of the importance levels which can be associated with an optimization objective or constraint.

Possible Values

GI_MediumImportantDefault
GI_LowImportantLower
GI_HighImportantHigher


ImportParameterType

Defines the compare parts on update option during geometry import.

Possible Values

None
Independent
All


ImportWeightclass

Preference for imported weightclass, could be used for identifying weightclasses of imported parts

Possible Values

ImportWeightclass_HeavyweightHeavyweight - all geometry and topology
ImportWeightclass_MiddleweightMiddleweight - facet only faces
ImportWeightclass_LightweightLightweight - each body consists of a single facetted face
ImportWeightclass_FeatherweightFeatherweight - parts are created along with the tree hierarchy, but no topology


IncidenceType

Incidence type

Possible Values

incidencespecified incidence
chokespecified choke


InitialInterfaceTreatmentType

No details are provided for this entry.

Possible Values

Unknown
AdjustToTouch
OffsetWithRamping
OffsetWithoutRamping


InitializationMethods

Initilization Methods

Possible Values

ProgramControlled
SolverControlled
ProvideInitialSolution


InitializationOption

Enumeration for the Solution update initialization options.

Possible Values

Automatic
CachedSolutionData
CurrentSolutionData
InitialConditions


InitializationType

The initialization settings

Possible Values

ProgramControlledProgram Controlled
StartTimeStart Time
RestartStepTimeRestart Step and Time


InletAngleType

Inlet angle type

Possible Values

AbsoluteAbsolute inlet angle
RelativeRelative inlet angle
CalculatedOBSOLETE OPTION. RETAINED IN R16.0 FOR PURELY FOR BACKWARDS COMPATIBILITY Calculated from nozzle area


int

This type represents an Integer number.

long

This type represents a long (64-bit) Integer number.

IntegrationType

IntegrationType of elements used by solvers such as Full or Reduced.

Possible Values

Unknown
ProgramControlled
Full
Reduced


InterfaceBehavior

InterfaceBehavior is an abstraction over all kinds of interface behaviors such as JointBehavior, BeamBehavior, LinkBehavior, SpringBehavior and ContactBehavior.

InterfaceBehaviorCreation

It allows you to create one connection behavior and share it or create separate ones for each one of searched interfaces.

Possible Values

Shared
Individual


InterfaceDetectionTypes

No details are provided for this entry.

Possible Values

FaceToFace
FaceToEdge
EdgeToEdge


InterfaceToleranceSpecification

It allows to let either program decides the tolerance value for you or you choose to input your own tolerance value

Possible Values

Automatic
Manual


InterfaceType

Type of inerfaces to be generated. Select from Contact, Joint and Mesh Interface.

Possible Values

None
Contact
Joint
MeshInterface


InterpolationType

No details are provided for this entry.

Possible Values

Unknown
Linear
SemiLog
LogLog


IsotropicElasticityDependents

Used when IsotropicElasticity is constant for all independent variables (e.g. Temperature).

IsovalueMethod

Specifies how to obtain the isovalues for the isosurface

Possible Values

Manual
Automatic


IterationKey

No details are provided for this entry.

Possible Values

Unchanged
ProgramControlled
ForceToOne
ManuallySpecified


JobRunMode

The job running modes

Possible Values

ForegroundForground mode.
BackgroundBackground mode.
RemoteSolveManagerSubmitted to Remote Solve Manager to run the job.
PortalSubmitted to the Portal Web Service
DcpSubmitted to a DCP database (Temporary just for prototyping, this will be replaced by a better mechanism later)


JointFormulation

JointFormulation types used by Mapdl Fixed Joint Connection Behavior

Possible Values

ProgramControlled
RigidLink
RigidBeam
Weld


JointReductionMethod

JointReductionMethod is an enumeration used by Mapdl Fixed Joint Connection Behavior formulations

Possible Values

ProgramControlled
DirectEliminationMethod
LagrangeMultiplierMethod


JointType

This is a collection of all available joint types.

Possible Values

Unknown
Fixed
Hinge
Translational
Slot
Cylindrical
Universal
Spherical
Planar
General
Bushing
PointOnCurve


KernelVariationType

Enumeration of the Kernel Variation types.

Possible Values

VARIABLEVariable
CONSTANTConstant


LegendColoring

Types of allowed legend coloring.

Possible Values

Banded
Smooth


LevelDisplayType

Enumeration for the level of display type.

Possible Values

LD_OffOff
LD_FinalFinal
LD_FinalWithDetailsFinal with details
LD_IterativeIterative
LD_IterativeWithDetailsIterative with details


LinearCorrelationType

Enumeration of the Correlation types.

Possible Values

SpearmanSpearman
PearsonPearson


LineStyles

Styles of lines that can be displayed. The default is Solid.

Possible Values

None
Solid
Dense
Medium
Sparse
DashShort
DashMedium
DashLong
DashDot
DashDotDot
DashDashDot
Gradient
Default


List<Type>

This type represents an unordered list of values.

LoadingType

No details are provided for this entry.

Possible Values

FullyReversed
Zero
Ratio


LocalElementMidsideNodes

Used to specify if the elements created for the bodies associated with this control should have midside nodes or not. The default value is UseGlobalSettings.

Possible Values

UseGlobalSettings
Dropped
Kept


LocationSet

An immutable class representing a set of locations

A Location is a key value pair of a model reference string and Point3DUnited (coordinate of the hit point on the model).

The order of the locations is maintained for the lifetime of the object.

In script a LocationSet is represented in one of the following forms:

Model reference strings["BODY1", "FACE5"]
Objects with LocationSet[selectionSet1, selectionSet2]
Model reference string with hit point[('FACE13', ('0.062 [m]', '0.197 [m]', '0.35 [m]')),('FACE23', ('0.07 [m]', '0.569 [m]', '0.502 [m]'))]
LocationSet returned from a functionAllBodies()

LossType

No details are provided for this entry.

Possible Values

kTotalLoss


MachineSpecification

List of computers to be used for a parallel FLUENT session. The list can be specified directly, or a hosts file containing the list can be specified.

For more details on how to specify the machines to be used for a parallel FLUENT session, please refer to the FLUENT User's Guide.

Possible Values

MachineList
FileName

MachineType

Setup Entity enum definition for machine type

Possible Values

PumpPump
AxialCompressorAxial Compressor
CentrifugalCompressorCentrifugal Compressor
FanFan
AxialTurbineAxial Turbine
RadialTurbineRadial Turbine
HydraulicTurbineHydraulic Turbine
UnknownUndefined machine type
OtherObsolete option, use 'Unknown' instead.


MAPDLSolverMode

Run the solver in batch mode just while solving or keep it live.

Possible Values

Live
Batch


Material

The material object holds all information that defines the behavior for a specific material.

MaterialAssignment

Assigns a Material to a specified Location.

MaterialNamesList

Database materials list Note that this is currently a fixed list which must correspond to the vistaFluids.xml database

Possible Values

AirAir
CarbonDioxideCarbon dioxide
HydrogenHydrogen
MethaneMethane
NitrogenNitrogen
OxygenOxygen
ParahydrogenParahydrogen
PropylenePropylene
R123R123
R125R125
R134aR134a
R141bR141b
R142bR142b
R245faR245fa
WaterWater


MaterialPropsType

material properties type

Possible Values

Databaseselect material from database
Useruser specified material properties


MatrixType

No details are provided for this entry.

Possible Values

ReIm
RL
Induct
FluxLinkage
ICCoefficient
Resistance


MaximumPassDefinition

No details are provided for this entry.

Possible Values

ProgramControlled
UserDefined


MeanStressTheory

No details are provided for this entry.

Possible Values

None
Goodman
Soderberg
Gerber


MeshBasedDefeaturing

Used to specify the type of automatic defeaturing for dirty geometries. The default value is AutomaticallyDetermined.

Possible Values

AutomaticallyDeterminedAutomatically removes features smaller than or equal to the calculated default tolerance value on dirty geometry.
UserDefinedAutomatically removes features smaller than or equal to the user defined defeaturing tolerance value on dirty geometry.
OffNo defeaturing done on dirty geometry.


MeshFileType

MeshFileType is used to identify the format of the mesh data file. This is usually the same as the application that generated the data file.

Possible Values

CFX
ICEM_CFD
FLUENT
POLYFLOW
Unknown


MeshMetric

Used to specify the metric type based on which mesh quality is evaluated. The default value is None.

Possible Values

NoneNo mesh metric type is selected.
ElementQualityA composite quality metric is computed ranging between 0 and 1.
AspectRatioAspect ratio is calculated based only on corner nodes of elements.
JacobianRatioJacobian ratio is computed for all elements except those with no midside nodes or perfectly centered midside nodes.
WarpingFactorWarping factor is computed for quadrilateral shell elements and quadrilateral faces of bricks, wedges and pyramids.
ParallelDeviationParallel deviation is computed ignoring midside nodes and based on unit vectors along each element size.
MaximumCornerAngleMaximum corner angles are computed between adjacent edges and high corner angles can degrade element performance.
SkewnessSkewness is one primary quality measure that determines how close to ideal (that is, equilateral or equiangular) a face or cell is.
OrthogonalQualityOrthogonal quality is computed using face normal vectors and ranges from 0 to 1.


MeshReading

Indicates the type of restart.

Possible Values

DirectIn this mode, one loads directly the mesh (no conversion).
ConvertIn this mode, one converts the *.poly or fluent *.msh into a polyflow *msh file


MeshRestartMode

Indicates the type of mesh import we want : - no initialization from upstream system - select a mesh in a list of mesh files coming from an upstream polyflow system

Possible Values

NoUpstreamMeshFilein this mode, no mesh file is selected from the upstream polyflow system.
SingleMeshFilein this mode, a mesh file is selected from a list of meshes coming from the upstream polyflow system.


MessageCategory

The valid message categories.

Possible Values

None
ConditionallyUpToDate


MessageType

The valid message types.

Possible Values

InformationAn informational message for the user.
WarningA warning message for the user.
ErrorAn error message for the user.
FatalA fatal message for the user. On receiving a message of this type, the framework will show the message to the user, and then exit immediately, without giving any chance to save their work or shut down running processes.
ProblemsProblem messages (WARNING + ERROR + FATAL).
DebugA debug message.
ProgressA progress message for the user.
NewsA news update for the user.
AttentionRequiredA message that requires user action to address
StandardAll non-debug and non-progress messages.


Method

The method used to create the Single Value Result

Possible Values

FunctionCalculatorMethod
UserDefinedExpressionMethod


Metric

Used to specify the measure to be used for improving the mesh quality. The default value is Skewness.

Possible Values

Skewness
SizeChange
AspectRatio


MixedImportPref

Mixed import preference option for mixed dimension parts

Possible Values

MixedImport_NoneIf mixed dimension part, import None
MixedImport_SolidsIf mixed dimension part, import Solids only
MixedImport_SurfacesIf mixed dimension part, import Surfaces only
MixedImport_LinesIf mixed dimension part, import Lines only
MixedImport_SolidsAndSurfacesIf mixed dimension part, import Solids and Surfaces only
MixedImport_SurfacesAndLinesIf mixed dimension part, import Surfaces and Lines only


MixedResolutionType

Defines the mixed resolution option during geometry import.

Possible Values

None
Solid
Sheet
Wire
Point
SolidSheet
SolidWire
SolidPoint
SheetWire
SheetPoint
WirePoint
SheetWirePoint
SolidWirePoint
SolidSheetPoint
SolidSheetWire
All


ModelType

The type (format) of the model, either from files or data from other systems.

Possible Values

AbaqusThe model is formatted according to the ABAQUS standard.
CFXThe model is formatted according to the CFX standard.
CMDBThe model is stored in a Meshing database.
FluentThe model is formatted according to the Fluent standard.
IcemThe model is formatted according to the Icem standard.
MechAPDLCDBThe model is formatted according to the CDB standard, used in Mechanical APDL.
NastranThe model is formatted according to the Nastran standard.
SimulationSetupThe model is stored in a Simulation database.
STLThe model is formatted according to the STL standard.
ACMOThe model is stored in an ACMO database.
MechAPDLRSTThe model is formatted according to the RST standard, used in Mechanical APDL.
AbaqusResultsThe model is formatted according to the results standard used in ABAQUS.
NastranResultsThe model is formatted according to the results standard used in Nastran.
SamcefResultsThe model is formatted according to the results standard used in Samcef.
FEModelerInternally used to specify a FE Modeler to FE Modeler connection.
UnknownThe model type property is not set.


MonitorChartType

MonitorChartType enum: Residual or UserDefined

Possible Values

Residual
UserDefined


MPIType

Enumeration for the MPI library to be used by the Mechanical APDL solver.

Possible Values

Undefined
IBMMPI
MSMPI
IntelMPI


MResOptions

Enumeration for the load options for Multi-configuration Results.

Possible Values

AllConfigsSingleCase
AllConfigsSeparateCases
LastConfigOnly


MultiAxisType

No details are provided for this entry.

Possible Values

S_X_TYPE
S_Y_TYPE
S_Z_TYPE
S_XY_TYPE
S_YZ_TYPE
S_XZ_TYPE
S_VON_MISES_TYPE
S_SIGNED_VON_MISES_TYPE
S_MAX_SHEAR_TYPE
S_MAX_PRINCIPAL_TYPE
S_ABS_MAX_PRINCIPAL_TYPE
S_CRITICAL_PLANE_TYPE


NewtonRaphsonOption

No details are provided for this entry.

Possible Values

kAuto
kFull
kModified
kInitial
kUnsymmetrical


NodeAndElementRenumberingMethodType

Enumartion of of the renumbering system

Possible Values

None
Offset
Automatic


NumSampType

Enumeration to specify for the samples type for OSFD algorithm.

Possible Values

SFD_CCDCCD samples
SFD_LINEARLinear model samples
SFD_PUREQUADPure quadratic model samples
SFD_CROSSQUADFull quadratic model samples
SFD_USERUser-defined samples


NuUserType

kinematic viscosity calculation type (obsolete)

Possible Values

Sutherlandcalculate viscosity from Sutherland's Law (using coeffs for air)
Useruser specified kinematic viscosity


Object

This type can represent any generic object. It is used when any type is a valid value.

ObjectRenamingTypeInMechanical

Controls how objects in Mechanical will be named for models assembled from multiple upstream sources

Possible Values

Off
BasedOnCellId
BasedOnSystemName
BasedOnUserInput


ObjectRenamingTypeInMeshing

Controls how objects in Meshing will be named for models assembled from multiple upstream sources

Possible Values

Off
BasedOnCellId
BasedOnSystemName
BasedOnUserInput


OnOffSwitch

This is used for activating or deactivating a setting.

Possible Values

kOn
kOff


OpeningPositionMethod

Enumeration of the inlet/outlet placement options.

Possible Values

Manual
AdjacentBlade


OptimalSpaceFillingType

Enumeration of the available design types for the Optimal Space Filling algorithm.

Possible Values

SFDTYPE_MDISTMax-Min Distance
SFDTYPE_CL2Centered L2
SFDTYPE_MAXENTMaximum entropy


OptimizationSolverType

No details are provided for this entry.

Possible Values

ProgramControlled
SequentialConvexProgramming
OptimalityCriteria


OrientationStyle

Allowed orientation of a legend. Default is Vertical

Possible Values

Vertical
Horizontal
Default


Output<Type>

The Output type is used in select instances where a method returns additional information in a method argument as well as the method return. These output arguments are typically optional, and a output variable must be declared before it is used. Once assignment has been made to an output variable, the return value can be evaluated by using the Get() method on the variable.

The following example shows the declaration and use of an output argument.

    >>> template1 = GetTemplate(TemplateName="EngData")
    >>> system1 = template1.CreateSystem()
    >>> engineeringData1 = system1.GetContainer(ComponentName="Engineering Data")
    >>> matl1 = engineeringData1.GetMaterial(Name="Structural Steel")
    >>> matlProp1 = matl1.GetProperty(Name="Density")
    >>> matlProp1.SetData(
    >>>    Variables="Density",
    >>>    Values="-10 [kg m^-3]")
    >>> from Ansys.Core.Commands import Output
    >>> outMsg = Output[str]()
    >>> if not matl1.IsValid(Message=outMsg):
    >>>    print "Material is not valid for the following reason:"
    >>>    print outMsg.Get()
    Material is not valid for the following reason:
    The value(s) for Density must be greater than zero.
          

OutputFrequencyType

The entitry stores the options to specify frequency of writing result files

Possible Values

NoneNo intermediate result files
EveryStepEvery Coupling Step
StepIntervalAt defined interval


OutputSource

Source of the output values, indicating the method used to obtain them.

Possible Values

UserEditedThe output values are edited by the user.
SimulationThe output values are obtained by a real simulation.
ResponseSurfaceThe output values are obtained by evaluating a response surface approximation.


OutputType

OutputType for OutputSpecification such as Deformation, Stress or Strain

Possible Values

None
All
Basic
NodalDofSolution
NodalReactionLoads
NodalVelocity
NodalAcceleration
ElementSolution
ElementNodalLoads
ElementNodalStresses
ElementElasticStrains
ElementThermalStrains
ElementPlasticStrains
ElementCreepStrains
ElementDiffusionStrains
ElementNodalGradients
ElementNodalFluxes
IntegrationPointLocations
StateVariables
ElementMiscellaneousData


ParameterizedEntityPropertiesCollection

A ReadOnlyDictionary for parameterized properties. The keys are the data references to the entities that hold the properties, the values are the list (one or more) of the parameterized properties.

ParameterNature

Enumeration of the possible nature of a parameter.

Possible Values

NatureContinuousContinuous
NatureUsabilityObsolete. Instead of defining a usability parameter, define a continuous parameter with the UseManufacturableValues set to True.
NatureDiscreteDiscrete


ParameterRelationshipType

Enumeration of the possible parameter relationship types.

Possible Values

PRT_LessThanOrEqualToLess Than or Equal To
PRT_GreaterThanOrEqualToGreater Than or Equal To


ParameterUsage

Specifies the possible ways a parameter can be used or set within the data model.

Possible Values

InputA parameter whose value will be used by the data model.
ExpressionOutputAn output parameter whose value is based on an expression. The parameter cannot be associated directly with the data model.
DirectOutputA parameter whose value will be provided directly by the data model. The parameter expression has to be undefined(null).


ParameterValueType

Type of a parameter value.

Possible Values

ActualValueThe actual value of the parameter.
VariationToReferenceThe variation of the parameter with respect to the current reference point, as a decimal number.


PartialDesignPointUpdate

Partial design point update

Possible Values

NoneFull design point update
GeometryUpdate geometry only during design point update


PeriodicSurfType

Enumeration of the periodic surface options.

Possible Values

OnePiece
ThreePieces


PersistableStateMessage

No details are provided for this entry.

PersistableStateMessageLevel

No details are provided for this entry.

Possible Values

Error
Warning
Information
Verbose


PhysicsRegion

Specifies the type and location of the fundamental physics in the simulation.

PhysicsType

The available physics types for an analysis.

Possible Values

UnknownIndicates physics type was never set
NoneIndicates physics type was set and then cleared
StructuralA mechanical analysis determines the displacements, stresses, strains, and forces in structures or components caused by loads that do not induce significant inertia and damping effects. Steady loading and response conditions are assumed; that is, the loads and the structure's response are assumed to vary slowly with respect to time.
ElectricConductionAn electric analysis supports Steady-State Electric Conduction.
FluidNo details are provided for this entry.
ThermalYou can use a thermal analysis to determine temperatures, thermal gradients, heat flow rates, and heat fluxes in an object that are caused by thermal loads.
ExtrusionSimulation of molten polymers for extrusion (in the laminar regime). The fluid can be modeled by a generalized newtonian law or by a viscoelastic law. Generally, it involves some deformation (needing remeshing) of the flow domain.
ElectromagneticsDenotes static and low frequency electromagnetic physics for analysis of electromechanical, etc. systems.
AllAll physics types.


PIFType

power input factor type

Possible Values

Correlationcorrelation
Useruser specified


Plane

The analytic definition of a flat plane where the Z axis is the normal direction.

PlaneConstructionMethod

Option for defining the plane construction method

Possible Values

OriginAndOrientation
FromPlane
FromReferenceFrame


PlaneOption

Options for selecting a Reference Frame plane.

Possible Values

XY
YZ
ZX


PlasticityType

No details are provided for this entry.

Possible Values

None
BilinearIsotropicHardening


Point

Point represented by local coordinates relative to a reference frame.

PointCalculationMethod

Options for calculating a point from geometry selection

Possible Values

Centroid
HitPoint


PositionType

Specifies the possible positions of a system when it is moved or created. These positions are relative to an existing system, which is specified in a separate argument.

Possible Values

DefaultDefault position. It is a new "child" of position, by system if given, or a new "root" system otherwise.
LeftPositioned left to a system.
RightPositioned right to a system.
AbovePositioned above a system.
BelowPositioned below a system.


PostReportNamesType

CFD Post reports

Possible Values

None
AxialCompressorReport
AxialCompressorRotorReport
CentrifugalCompressorReport
CentrifugalCompressorBladeRowReport
CentrifugalCompressorRotorReport
TurbineReport
TurbineRotorReport
FanNoiseReport
FanReport
GenericReport
HydraulicTurbineReport
HydraulicTurbineRotorReport
PumpReport
PumpImpellerReport
StatorReport
TurbineStatorReport
Custom


PredictorKey

No details are provided for this entry.

Possible Values

Unchanged
ProgramControlled
Off
OnAfterFirstSubstep
OnForAllSubsteps


PreferenceType

No details are provided for this entry.

Possible Values

BetweenBodies
BetweenBodiesOfDifferentParts
All


PreswirlType

Preswirl type

Possible Values

constantConstant inlet angle
freeFree vortex
forcedSolid body rotation
linearLinear variation of Vw


PreswirlType

Preswirl type

Possible Values

constantConstant inlet angle
freeFree vortex
forcedSolid body rotation


PretensionDefineBy

This enum is used to set how bolt pretension is defined. It can be defined by axial foce, adjustment, lLock, open or increment.

Possible Values

kUnknown
kAxialForce
kAdjustment
kLock
kOpen
kIncrement


PretensionModelAs

This enum is used to set how many bolts should be created if location is set to multiple volumes : One for all selected volumes or one per selected volume.

Possible Values

Unknown
OneBoltForAllLocations
OneBoltPerLocation


PrimitiveBoxCreationMethod

Box creation method options.

Possible Values

VirtualPrimitiveBoxByEntityBox can be created by enclosing single or multiple entities.
VirtualPrimitiveBoxByCoordinateBox can be created by specifying diagonal coordinates.


PriorityType

No details are provided for this entry.

Possible Values

FaceOverride
EdgeOverride
All


ProcessorUnit

Various Processore Unit options available for Microsoft Scheduler

Possible Values

Core
Socket
Node


ProgramControlType

No details are provided for this entry.

Possible Values

Unchanged
ProgramControlled
On
Off


ProximitySizeFunctionSources

Used to specify the source type to be used for size function calculation when Advanced Size Function is Proximity or Curvature and proximity. The default value is Faces.

Possible Values

Faces
Edges
FacesAndEdges


Quantity

This class represents a physical quantity that can be measured. It holds a double value and a string that specifies the value's unit of measurement. The Value and Unit can be accessed individually as properties on this type, and a Quantity can be converted to new units.

Mathematical operations can also be performed on Quantities, and these operations calculate and enforce dimensional consistency between units. Note the results of mathematical operations are always converted into the project unit system.

RampingType

Enum providing ramping options.

Possible Values

NoneNo ramping.
LinearLinear profile ramping.


ReadOnlyDictionary<Key, Value>

This type represents a read-only data dictionary, where a Key is used to access an associated Value. When used in scripting, a dictionary is created or printed using the form

myDict = {key1:value1, key2:value2, ...}

Python functionality can be used to examine dictionary keys, test for key existence and perform other useful operations on dictionaries; however, the contents may not be manipulated unless the dictionary or its contents are cloned into a regular dictionary.

RealGas

Enumeration of the available real gas materials

Possible Values

Air
CarbonDioxide
Hydrogen
Methane
Nitrogen
Oxygen
Parahydrogen
Propylene
R123
R125
R134a
R141b
R142b
R245fa
Water
Custom


RefDiameterType

Enumeration of the reference diameter options.

Possible Values

Automatic
User


ReferenceFrame

Frame of reference for modeling and simulation data.

ReferenceFrameDefinitionType

Options for reference frame definition types

Possible Values

OriginAndOrientation
CoincidentWithParent
Transform


ReferenceTopologyType

Defines the topology type for a given reference.

Possible Values

RTT_NoTopology
RTT_Vertex
RTT_Edge
RTT_Face
RTT_Body
RTT_Part
RTT_Assembly
RTT_ConfigurationComponent
RTT_Invalid


ReferenceValueSpecification

No details are provided for this entry.

Possible Values

ProgramControlled
Manual


RegionBehavior

Used to specify the meshing region behavior. Currently, the only possible value is Wrap.

Possible Values

WrapSimplifies unclean geometry before sewing.


RelativeToType

Options for selecting a which reference frame to define relative to

Possible Values

Local
Parent


RepositoryFileInfo

Class to specify a repository file

ResponseChartModes

Enumeration of the available Response chart modes.

Possible Values

Curve2D2D response chart where an output parameter is plotted versus an input parameter.
Surface3D3D response chart where an output parameter is plotted versus two input parameters.
Slices2D2D response chart where an output parameter is plotted versus two input parameters, on the X axis and the other varying over several curves.


ResponseSurfaceRefinementType

Enumeration for the Refinement type.

Possible Values

REFINEMENT_NONENone
REFINEMENT_AUTOAutomated
REFINEMENT_MANUALManual


ReverseEdgeLoopOrientation

Options for choosing loop orientation. Required only if construction algorithm is convex hull.

Possible Values

NoConstruct capping surface by using default loop orientation.
YesConstruct capping surface by reversing loop orientation.


RigidTransformOptionsForMeshing

Class containing all rigid transformation options for Model Assembly workflows in Meshing

RigidTransformOptionsForSimulation

Class containing all rigid transformation options for Model Assembly workflows in Mechanical

RotationalDOFBehavior

This enum is used to set the rotational degree of freedom as fixed all, free all, free about x, free about y or free about z.

Possible Values

FixedAll
FreeAll
FreeAboutX
FreeAboutY
FreeAboutZ


RotationType

Enumeration of the machine rotational direction options.

Possible Values

RightHanded
LeftHanded


RoughnessType

surface roughness type

Possible Values

Machinedmachined surface finish
Castcast surface finish


RshSpecification

Client used to connect to the nodes in a cluster of LINUX machines.

'Other' is used for a custom connect command.

Possible Values

RSH
SSH
Other

RsmQueueDetails

A class to define Rsm Queue details for adding them to UI

SampleGenType

Enumeration for the Sampling type.

Possible Values

SAMPLE_GEN_LHSLHS
SAMPLE_GEN_WLHSWLHS


SamplesChartModes

Enumeration of the available Samples chart modes.

Possible Values

CandidatesDraw the samples and highlight the optimization candidates.
ParetoFrontDraw the samples using colors that represent their Pareto front.


Scale

Enum to define the scale of the axis.

Possible Values

LinearLinear scale
CommonLogCommon or log base 10 scale
NaturalLogNatural log scale


Scale

Enum to define the scale of the axis.

Possible Values

Linear
CommonLog
NaturalLog


SchedulerSpecification

Various Job Schedulers available on Unix/Linux.

Possible Values

LSF
SGE
PBSPro


SearchDirectionMethod

No details are provided for this entry.

Possible Values

ProgramControlled
Manual


SearchPosition

A filter that can be applied to the SearchString used by GetAllObjects query.

Possible Values

Exact
Contains
StartsWith
EndsWith


SectionOffsetType

No details are provided for this entry.

Possible Values

midSurface
OneSide
userDefined


SeedPointDistributionType

Allowable values for seed point sampling.

Possible Values

UniformSample
GridSample
Mesh


SeedPointMeshDistributionType

Allowable values for how mesh is evaluated when sampling seed points.

Possible Values

EveryNthElement
EveryNthVertex


SensitivityChartModes

Sensitivity chart modes.

Possible Values

BarChart2D Bar chart
PieChart2D Pie chart


SeparationSurfaceNormal

This enum is used to set how separation surface and tolerance is specified. It can be program controlled or user can manual set the property value.

Possible Values

X
Y
Z


SeparationSurfaceSpecification

This enum is used to set how separation surface and tolerance is specified. It can be program controlled or user can manual set the property value.

Possible Values

ReferenceFrame
GeometrySelection


ShapeChecking

Used to define the shape checking algorithm to be used by the mesher. The default value is UseEngineeringIntent.

Possible Values

UseEngineeringIntentDetermine which algorithm to use based on the Engineering Intent.
StandardMechanicalSpecifies the standard mechanical shape checking algorithm for structural simulations.
AggressiveMechanicalSpecifies the aggressive mechanical shape checking algorithm for structural simulations.
CFDSpecifies the CFD shape checking algorithm for flow simulations.
NoneDisable shape checking.


ShrLEBetaType

Shroud LE blade angle option

Possible Values

IncidenceShroud LE blade angle calculated from specified incidence
UserUser defined shroud LE blade angle


ShroudDiameterType

shroud diameter type

Possible Values

Diameteruser specified shroud inlet diameter
Angleuser specified shroud vane inlet angle
Optimumoptimised shroud inlet diameter (minimum Mrel)


SimulationType

Enumeration of the simulation types of a parameter.

Possible Values

DesignVariableDesign variable
UncertaintyVariableUncertainty variable


float

This type represents a single-precision floating point number.

SixSigmaTableTypes

Enumeration of the Probability Table types.

Possible Values

ProbabilityTableQuantile-percentile
InverseProbabilityTablePercentile-quantile


SizingBehavior

Used to specify whether size control settings can be changed by the mesher (Soft) or not (Hard).

Possible Values

Soft
Hard


Smoothing

Used to specify the level of smoothing iterations to be performed. The default value is Medium.

Possible Values

Low
Medium
High


SolutionProgression

SolutionProgression is a class that specifes convergence, stabilization of solution etc, the typical attributes for monitoring and controlling a solution.

SolutionStep

No details are provided for this entry.

SolutionUpdateOption

System Coupling Solution Update option

Possible Values

ForegroundForeground update


SolverRestartMode

Indicates the type of restart.

Possible Values

NoRestartFileIn this mode, no restart file is used to initialize time scheme and fields.
SingleResultFileIn this mode, a result file is used to initialize fields.
CombineResultRestartFilesIn this mode, a result file is used to initialize fields and a restart file is used to initialize time scheme (starting time + derivates).
SingleCsvFileIn this mode, a csv file is used to initialize fields.
CombineCsvRestartFilesIn this mode, a csv file is used to initialize fields and a restart file is used to initialize time scheme (starting time + derivates).
ManyResultFilesIn this mode, a list of polyflow result files will be used to define the flow field on which we evaluate a transient mixing task (computation of a set of trajectories).
ManyCsvFilesIn this mode, a list of polyflow csv files will be selected for a conversion into other kinds of results .. for a future mixing task for example.
InitializationFromCsvFilesIn this mode, csv files are used to initialize fields. The CSV file(s) will be selected in Polydata.


SourceInformation

Information about the original source of the Engineering Data.

SourceSelectionType

Options for source selection types

Possible Values

BrowseSource
ActiveCADAttach


SpanwiseDistributionType

Spanwise distribution type

Possible Values

GeneralBlade exported using general spanwise distribution
RadialBlade exported using radial spanwise distribution


StabilizationKey

No details are provided for this entry.

Possible Values

Off
ConstantEnergyDissipation
ReducedEnergyDissipation
ConstantDampingFactor
ReducedDampingFactor


StackingType

stacking type

Possible Values

RadialRadial stacking
TanBeta calculated from tangent
SinBeta calculated from sin


StateOfMatter

No details are provided for this entry.

Possible Values

Unknown
None
Solid
Liquid
Gas
Plasma


Status

The current calculation status of the Excel file.

Possible Values

UpToDateThe output parameters are up to date.
OutOfDateThe values of the input parameters are modified and the values of the output parameters are not recalculated yet.
ErrorsWhenCalculatingErrors ocurred during the calculation in Excel.


StepSizeType

The method used to determine the size of integration steps in streamline creation.

Possible Values

Automatic
Fixed


STLSDTAlgorithm

SDT Algorithm Options

Possible Values

STLSDTAlgorithm_CurvaturesCurvature based SDT algorithm
STLSDTAlgorithm_AnglesAngle based SDT algorithm


StraightSidedElements

Used to force mesher to create elements with straight edges. The default value is No.

Possible Values

Yes
No


StreamlineColorOption

Allowable values for how a streamline is colored.

Possible Values

None
Time


StreamLineDisplayStyle

Allowable values for how a streamline is displayed.

Possible Values

Lines
LinesAndSymbols
Symbols


StreamLineShapeDef

Allowable values for the shape of the streamline

Possible Values

Wire
Ribbon
Tube


StreamLineStyle

Allowable values for the style of the streamline

Possible Values

Continuous
Segments


string

This type represents a String value.

SubStepOption

No details are provided for this entry.

Possible Values

No
Yes
IfNotConverged


Substepping

Define Substepping options such as specified range, fixed number or program controlled as available in MAPDL solver.

Possible Values

Unchanged
ProgramControlled
SpecifiedRange
FixedNumber


SupportFileFormatType

Enumeration for any supporting files

Possible Values

Info


SupportType

No details are provided for this entry.

Possible Values

Unknown
Fixed
Frictionless
UserSpecified


SweepTypes

No details are provided for this entry.

Possible Values

LinearStep
LogScale


SymbolLengthOptions

The allowable values for the control of vector length display.

Possible Values

BasedOnMagnitude
Constant


SymbolShape

The symbol shape used for the associated result

Possible Values

SymbolShape1DArrowHead
SymbolShape1DArrow
SymbolShape2DArrowHead
SymbolShape2DArrow
SymbolShape3DArrowHead
SymbolShape3DArrow
SymbolShape3DCrossHair
SymbolShape3DCube
SymbolShape3DSphere


SystemPropertyDictionary

A dictionary holding system properties. The keys in the dictionary will be of the standard names defined in Ansys.ProjectSchematic.SystemPropertyNames. For each property, the value in the dictionary is a list of all unique values of that property.

TableInterpolation

An enum of the type of interpolation to use when accessing data from the table at a given index. The valid enum values are; None, Linear, Cubic Spline.

Possible Values

NoneNo interpolation is done.
LinearA linear interpolation will be used to compute the return value.


TableInterpolationBeyondBounds

An enum which describes what will occur when the index is outside of the bounds of the table. The valid enum values are; Constant, Fit, Zero, and Error.

Possible Values

Constanthis option will cause the value returned to be the data at the index nearest to the requested index.
FitThis option will ignore the bounds of the table and use the Interpolation algorithm to fit the data and then compute the value at the requested index.
ZeroThis option will cause the value returned to be zero if the index is outside of the bounds of the table.
ErrorIf the data cannot be determined from the given index (outside of the bounds) then an error will occur.


TableType

No details are provided for this entry.

Possible Values

kMatrix
kLossData
kForce


Terminal

No details are provided for this entry.

TessellationRefinement

Used to specify value to be used for tessellation refinement. The default value is AutomaticallyDetermined.

Possible Values

AutomaticallyDeterminedSets tessellation refinement to 10% of the value of Min Size/Proximity Min Size.
UserDefinedSets tessellation refinement to user defined value.
OffTessellation refinement is not performed.


TimeOption

No details are provided for this entry.

Possible Values

EndTime
UserDefined


TipDiamType

Impeller tip diameter option

Possible Values

AutomaticD2 calculated automatically (from stability factor)
HeadCoeffD2 calculated from head coefficient
UserD2 user defined


TopologyType

All of the possible values for topology.

Possible Values

PointA topological point
CurveA topological curve
SurfaceA topological surface
VolumeA topological volume


TorqueDirections

No details are provided for this entry.

Possible Values

Positive
Negative


TorqueTypes

No details are provided for this entry.

Possible Values

Virtual
Lorentz


TrackerMethod

The method used to create the Single Value Result

Possible Values

Undefined
Function
UserDefinedExpression


TradeoffChartModes

Enumeration of the available Tradeoff chart modes.

Possible Values

Curve2D2D tradeoff chart where a parameter is plotted versus another parameter.
Surface3D3D tradeoff chart where a parameter is plotted versus two other parameters.


TranscriptType

The allowable types of output in a Transcript monitor.

Possible Values

SolverOutput
PhysicsCouplingDiagnostic
SelectFile


TransferAtType

Enum providing options of when to Transfer Data.

Possible Values

StartOfStepTransfer data at start of step.
StartOfIterationTransfer data at start of iteration.


TransferDataFromNewComponentSpec

Specifies the information needed to transfer data from a component that is being created in a new system.

TransferDataToNewComponentSpec

Specifies the information needed to transfer data to a component that is being created in a new system.

TransferType

Transfer type from ACP

Possible Values

Shell
Solid
None


Transform4x4

No details are provided for this entry.

TransformationType

Enumeration of the available transformation types applicable to an output parameter.

Possible Values

TransTypeNoneNo transformation
TransTypeBoxBox-Cox
TransTypeYeoYeo-Johnson


TranslationalDOFBehavior

This enum is used to set the translational degree of freedom as fixed or free.

Possible Values

Fixed
Free


TriangleSurfaceMesher

Used to specify the surface meshing algorithm to be used by patch conforming mesher. The default value is ProgramControlled.

Possible Values

ProgramControlledMesher determines usage of Delaunay or Advancing Front algorithm.
AdvancingFrontMesher uses Advancing Front algorithm but can switch to Delaunay if problems occur.


TrimType

Trim Type to control trimming such as keeping it on, off or Program Controllled.

Possible Values

ProgramControlled
On
Off


TripletType

An enumeration to describe the type of Triptlet that is used in Coordinate systems, Reference frames, and Vector objects.

Possible Values

Cartesian
Cylindrical
Spherical


TypeOfInitialSampling

Enumeration for the Initial Sampling Type.

Possible Values

E_ScreeningScreening
E_OSFOptimal Space-Filling
E_ConstrainedSamplingConstrained Sampling


uint

This type represents an unsigned integer number. Negative values are invalid.

UniversalVectorDefineBy

Options for defining the vector

Possible Values

Components
MagnitudeAndDirection


UpdatableEntityState

Types of state an updatable entity can have.

Possible Values

Unknownentity state can not be defined.
OutOfDateentity is out of date.
UpToDateentity is up to date.
Errorlast update of the entity gave an error.
OutOfDateWithErrorentity is out of date and last update of the entity gave an error.
UpToDateWithErrorentity is up of date and last update of the entity gave an error.
RefreshRequiredentity needs a refresh.


UpdateContinuation

No details are provided for this entry.

Possible Values

NoneInterrupted components with up-to-date data will not be updated.
TargetOnlyIf the target component is interrupted with up to date data, it will be updated.
AllAny involved component which is interrupted with up to date data will be updated.


UpdateErrorBehavior

Specifies the types of behavior if an error is encountered when updating multiple design points.

Possible Values

StopTerminate the update immediately on the first error.
SkipDesignPointDon't do any more work on the failing design point, but continue with the next one if any.
ContinueUpdate as much of the project, and as many design points, as possible.


UpdateStiffnessControlType

No details are provided for this entry.

Possible Values

ProgramControlled
EachEquilibriumIteration
EachEquilibriumIterationAggressive
Never
EachEquilibriumIterationNominal


UseAdvancedSizeFunction

Used to specify which advanced size function option should be used by the mesher.

Possible Values

Adaptive
ProximityCurvature
Curvature
Proximity
Fixed


UseAllProcessors

Used to specify the usage of all available processors for parallel part-based meshing. The default value is Yes.

Possible Values

YesAutomatically detects and utilizes all available processors for meshing parts of an assembly in parallel.
NoManually specify the limit to the number of processors that can be utilized for parallel part-based meshing.


UsePostSmoothing

Used to specify whether post boundary smoothing will be performed. The default value is Yes.

Possible Values

Yes
No


ValueDefineBy

This propertry decides whether it should use program controlled value or a manually entered factor or value.

Possible Values

Unknown
kProgramControlled
kPhysicalValue
kFactor
kAutoDetectValue


VariableConversionOption

Enumeration to specify the conversion of data

Possible Values

NoConversion
AverageSharedNodes
AverageNodesToElement
AverageNodesToFace
DistributeElementToNodesEqually
DistributeFaceToNodesEqually
AverageCornerToMidsideNodes


VariableExposure

Level of exposure for variables in the CDI

Possible Values

StandardDefault
ExpertExpert


VariableRangeOption

The variable range options

Possible Values

Local
UserSpecified


VariableStyle

Styles that can be used to display the variable. Default is Line

Possible Values

None
Line
Spline
Step
Bar
Default


VectorCalculationMethod

Options for calculating a vector from geometry selection

Possible Values

Automatic
HitPointNormal
WeightedAverageNormal
HitPointTangent
NearestVertexTangent
WeightedAverageTangent
CenterAxis
TwoVertices


VectorDefineBy

This enum is a collection of methods by which a vector can be defined : Directional Components, Magnitude and direction or normal to a surface.

Possible Values

Components
MagnitudeAndDirection
NormalToSurface


VectorType

Motion vector types used in mechanics.

Possible Values

Unknown
Displacement
Velocity
Acceleration
Rotation
AngularVelocity
AngularAcceleration


ViscosityType

viscosity type

Possible Values

SutherlandViscosity calculated using Sutherland's Law (2 coefficient method)
DynamicUser-specified dynamic viscosity
KinematicUser specified kinematic viscosity


VoluteType

Volute style option

Possible Values

EllipticElliptic/circular cross sections
RectangularRectangular cross sections


WeightingType

Available expression weight types

Possible Values

Simple
Length
Area
Volume
Mass


WrapMethod

Used to specify the wrapping method to be used for the meshing region. The default value is ShrinkWrap.

Possible Values

ShrinkWrap
CutWrap


XAxisQuantity

Enum for quantity used for X-axis.

Possible Values

Iteration
FlowTime
TimeStep


YesOrNo

This is used for activating or deactivating a setting.

Possible Values

kYes
kNo


YN

This is enum for yes/no option

Possible Values

ICYes
ICNo


Zoning

Used to specify the option to be used for zoning. The default value is Body.

Possible Values

PartCreates a single zone for each part.
BodyCreates a separate zone for each body.
FaceCreates a separate zone for each face.



Release 18.2 - © ANSYS, Inc. All rights reserved.