Data Types

Data Types
A breakdown of the types represented in this document

ActionMode

Enumeration with the available ROM action modes.

Possible Values

NoneProduction mode, when a snapshot file is generated each time a design point is updated.
No action. Consumption
ProductionConsumption mode, when a ROM project is used to evaluate the results.


AdaptKrigOutType

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

Possible Values

AK_MAXOUTAll Outputs
Maximum Output AK_SUMOUT
AK_ALLOUTSum of Outputs


Aggressive

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

Possible Values

MeetTargetMaintainGeometry
Modify the geometry as needed to meet quality target. Compromise targets to maintain geometry.


AlgorithmType

Available contact detection algorithm types.

Possible Values

Unknown
ProximityBased
TrajectoryBased


AllowedContinuousValues

Enumeration of the possible continuous input parameter types.

Possible Values

AnyManufacturable Values
Any SnapToGrid
ManufacturableValuesSnapToGrid


AnalysisType

No details are provided for this entry.

Possible Values

StressLife
StrainLife


AnalysisType

3D/2D import option

Possible Values

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


APAMAdvancedSizeFunction

No details are provided for this entry.

Possible Values

ProgramControlled
Curvature
Proximity
ProximityCurvature
Fixed


APAMMidsideNodeOrder

Options for mid side nodes to determine the element order either linear or quadratic.

Possible Values

ProgramControlled
Dropped
Kept


APAMProximitySizeFunctionSources

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


ApplicationMethod

Possible options for the applied force

Possible Values

TotalForce
ForcePerUnitArea
ForcePerUnitLength


ApplicationMethod

Possible options for the applying heat generation

Possible Values

TotalHeat
PerUnitVolume
Unknown


AssociationType

Construction strategy.

Possible Values

GLOBALLOCAL
One ROM for all the regions of a field. One ROM per region of a field.


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

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


AxialDirectionDefinedBy

This enum is used for axial direction to be defined by either geometry selection or reference frame.

Possible Values

GeometrySelection
ReferenceFrame


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


BeamSectionOffsetType

Available section offset types for beams.

Possible Values

Centroid
ShearCenter
Origin
UserDefined


BeamSectionType

Available section types for beams.

Possible Values

Unknown
Circular
Rectangular
Quadrilateral
TubeShaped
ChannelShaped
ZShaped
LShaped
IShaped
TShaped
HatShaped
HollowRectanglar
ArbitraryShaped
MeshCrossSection


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

IGVRotor
IGV OGV
RotorOGV


BladeType

Blade type for export to BladeGen

Possible Values

IGVRotor
IGV OGV
RotorOGV


BMunitsType

BladeGen/BladeEditor units type

Possible Values

mCreate blade model in mm
Create blade model in metres inches
cmCreate blade model in inches
Create blade model in cm ft
mmCreate blade model in feet


BMunitsType

BladeGen/BladeEditor units type

Possible Values

mminches
Create blade model in mm Create blade model in inches


BodyGroupingType

Type of geometry that is being attached.

Possible Values

MaterialNumber
MaterialNumberAndThickness
NoGrouping


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

TotalThicknessMesher ensures smooth rate of volume change using local tetrahedral element size.
Creates constant boundary layers using the values of Number of Layers and Growth Rate. FirstAspectRatio
FirstLayerThicknessCreates boundary layers using values of First Aspect Ratio, Maximum Layers and Growth Rate.
Creates constant bounadry layers using values of First Layer Height, Maximum Layers and Growth Rate. LastAspectRatio
SmoothTransitionCreates constant boundary layers using values of First Layer Height, Maximum Layers and Aspect Ratio.


BoxCushionType

Box cushion type options.

Possible Values

UniformNonuniform
Uniform cushion around box. Non-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_NoneImport editable parameters -- default value (like old true value)
Do NOT import parameters CADImportParameterType_All
CADImportParameterType_IndependentImport 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

UnknownComputation of the dynamic response of a system under excitation
Indicates analysis was never set FrequencyResponse
NoneFrequency domain analysis of a system
Indicates analysis was set then cleared Optimization
StaticTopology optimization analysis
Computation of the system that is time independent. EigenvalueBuckling
TimeDependentEigenvalue buckling
Computation of the system that is time dependent. All
ModalAll domains.


CandidatesColoringMethods

Enumeration of the Coloring methods used for Candidates chart.

Possible Values

ColoringPerPointTypeColoringPerOutputNature
The color is used to distinguish the different types of candidate points (Starting Points, Candidate Points, etc). The 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

CappingSurfaceFacesConstraintCappingSurfaceLoopsConstraint
Construct capping surface by capping all laminar loops of selected faces. Construct capping surface by capping all specified loops.
CappingSurfaceEdgesConstraintCappingSurfaceVerticesConstraint
Construct capping surface by capping all loops of selected edges. Construct 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_TEMPLATECCD_ENHANCED_TEMPLATE
Standard Enhanced


CentralCompositeDesignType

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

Possible Values

CCDTYPE_FACE_CENTVIF-Optimality
Face-Centered CCDTYPE_G_OPT
CCDTYPE_ROTG-Optimality
Rotatable CCDTYPE_AUTO
CCDTYPE_VIF_OPTAuto Defined


ChartAxes

The possible chart axes.

Possible Values

XAxisXTopAxis
X axis Secondary X axis drawn at the top of the chart.
YAxisYRightAxis
Y axis Secondary Y axis drawn at the right of the chart.
ZAxisSweepAxis
Z axis An axis used to sweep over an additional parameter.


ChartColoringMethods

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

Possible Values

ColoringPerFrontColoringPerSample
A different color for each Pareto fronts (several samples have the same color). A different color for each sample.


ChartStyle

Allowed styles of a multi-axis chart.

Possible Values

PCPSpider
Parallel Coordinate Plot Spider Plot


ChartType

Enumeration for the chart type.

Possible Values

ChartUnknownChartDesignPointsCurves
Unknown Design Points vs. Parameters
ChartResponseChartDetermination
Response Determination Matrix
ChartTradeoffChartPredictedvsObserved
Tradeoff Predicted vs. Observed
ChartSamplesChartDeterminationHistogram
Samples Determination Histogram
ChartDistributionsChartConvergence
Distributions Convergence
ChartCorrelationChartLocalSensitivityCurves
Correlation Local Sensitivity Curves
ChartSpiderResponsesChartCustom
Spider Custom Chart
ChartLocalSensitivityChartCandidates
Local Sensitivity Candidates
ChartSensitivitiesChartHistory
Sensitivities History
ChartStatisticsChartConvergenceCriteria
Statistics History
ChartCorrelationScatterChartParameterRelationship
Correlation Scatter History
ChartDesignPointsParallelChartPredictionErrorScatterPlot
Parameters Parallel Prediction Errors


ClearanceType

inpeller clearance type

Possible Values

RatioUser
tip clearance specified as a ratio tip clearance specified directly


ClearanceType

Enumeration of the tip clearance specification options.

Possible Values

None
RelativeLayer
AbsoluteLayer


ClearMessagesOption

Options when deleting messages.

Possible Values

KeepMessagesIfSourceMatchedClearMessagesIfSourceNotMatched
Do not delete message if its source matches the specified one. Delete message if its source does not match the specified one.
ClearMessagesIfSourceMatchedIgnoreSource
Delete message if its source matches the specified one. Do 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

NoneBoundary layers are compressed in collision areas.
No check for layer collisions. StairStepping
LayerCompressionPrism 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.

ColorDistributionOption

Supported color distributions.

Possible Values

Linear
Logarithmic


ColorSpaceSetting

Options for color space.

Possible Values

Linear
sRGB


ComparePartsOnUpdateMethod

Compare parts on update options

Possible Values

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


ComparePartsTolerance

Compare parts on update tolerance options

Possible Values

ComparePartsTolerance_LooseLooser tolerance than default to allow some wiggle room for slight deviations
A greater loosening of the default tolerance ComparePartsTolerance_Tight
ComparePartsTolerance_NormalDefault, existing behavior


ComponentConfigType

List of available component configurations

Possible Values

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


ConductanceControlType

Switch to use program controlled conductance value or enter value.

Possible Values

ProgramControlled
Manual


ConnectionEndBehavior

Possible options for connection end behavior

Possible Values

kProgramControlled
kDeformable
kRigid
kCoupled


ConstraintHandlingType

Enumeration of the Constraint Handling types.

Possible Values

AsGoalsAsHardConstraints
Relaxed constraint. Strict constraint.


ConstraintType

Enumeration of the possible optimization constraint types.

Possible Values

CT_NoPreferenceLess than target.
No constraint defined. CT_GreaterThanTarget
CT_NearTargetGreater than target.
Equals target. CT_InsideBounds
CT_LessThanTargetInside bounds.


ConstraintType

This enum is used to indicate how the member size is defined

Possible Values

ProgramControlled
Manual


ConstructionAlgorithm

Options for choosing construction algorithm for capping surface.

Possible Values

DelaunayConvexHull
Construct capping surface by using delaunay triangulation. Construct capping surface by using convex hull approach.
FillHoleAutomatic
Construct capping surface by using hole filling algorithms. Construct capping surface by choosing appropriate construction algorithm.


ConstructionType

Construction type

Possible Values

FIXED_NB_MODEFIXED_ACCURACY
Fixed number of modes Fixed error


ContactConstraintType

Possible options for contact constraint type.

Possible Values

ProgramControlled
TargetNormalUncoupleUtoROT
TargetNormalCoupleUtoROT
InsidePinballCoupleUtoROT


ContactDetectionPoint

Possible options for contact detection point.

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


ConvergenceOption

No details are provided for this entry.

Possible Values

NumericalResiduals
AutoHalt
UserHalt


CoordinateInputMethod

Options for definining vectors

Possible Values

Entry
Location


CoordinateSystemType

Enumeration to specify the coordinate system type for imported data.

Possible Values

Cartesian
Cylindrical


CorrelationAutoStopType

Enumeration of the correlation Auto Stop types.

Possible Values

ExecuteAllSimulationsEnableAutoStop
Execute all Simulations. Enable 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

UndefinedTransient
This is internal option used to cache the user selection of analysis type. It cannot be specified by the user. Define the coupling by time intervals
GeneralHarmonic
Define the coupling by time steps Define 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


CurrentSpecificationMethod

No details are provided for this entry.

Possible Values

TotalCurrent
CurrentPerUnitArea
Unknown


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

ColumnRow
Column-major Row-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.

DataTransferType

Enumeration of the data transfer options.

Possible Values

BGD
NDF


DataTypeEnumeration

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

Possible Values

ATypeVectorRAZ
An unknown type A vector in r, a, and z components
ScalarVectorRI
A scalar A vector in r and i components
VectorXYVectorIA
A vector in x and y components A vector in i and a components
VectorYZVectorRIA
A vector in y and z components A vector in r, i, and a components
VectorXZTensor2XYZ
A vector in x and z components A 2D tensor
VectorXYZTensor4XYZ
A vector in x, y, and z components A 4D Tensor
VectorRASymTensor2XYZ
A vector in r and a components A 2D symmetric tensor
VectorAZSymTensor4XYZ
A vector in a and z components A 4D symmetric tensor
VectorRZAntisymTensor2XYZ
A vector in r and z components An 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.

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


DefinitionState

State of the definition

Possible Values

CompleteEmpty definition
Fully defined ConnectionFailed
IncompleteConnection with DCS has failed
Data are missing Failed
EmptyPost Operation has failed


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_CentralDifferenceDA_ForwardDifference
Central Difference Forward Difference


DesignPointParameter

No details are provided for this entry.

DesignPointRetainedOrExportedUpdate

No details are provided for this entry.

Possible Values

Parameters
FullProject


DesignPointState

Indicates a design point parameter's current state.

Possible Values

NeverSolvedAndFailedOutOfDate
Parameter has never been successfully updated and the last update failed. Parameter 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.
NeverSolvedInterrupted
Parameter has never been updated. Parameter is updated but the update was interrupted
FailedUpToDate
Parameter was previously UpToDate but last update failed. Parameter is successfully updated.


DesignPointUpdateOrder

No details are provided for this entry.

Possible Values

UpdateFromCurrentDesignPoint
UpdateDesignPointsInOrder


DesignTypes

Possible design goals for a topology optimization analysis

Possible Values

Strength
NaturalFrequency


DeterminationCoefficientChartModes

Enumeration of the Determination Coefficient chart modes.

Possible Values

LinearQuadratic
Display linear determination coefficients. Display 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

VanedVaneless
vaned diffuser vaneless diffuser


DimensionsType

Enumeration to specify the dimensionality of imported data.

Possible Values

Dimension2D
Dimension3D


DirectionType

Identifiers for direction type.

Possible Values

NoMagnetization
Cartesian
Cylindrical
Spherical


DirectionType

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

Possible Values

Backward
Forward
Both


DirectionType

This enum is used to indicate the direction of the selected axis

Possible Values

AlongAxis
OppositeToAxis
BothDirection


DisplacementType

Possible options for displacement.

Possible Values

Unknown
TranslationAndRotation
TranslationOnly
RotationOnly


DisplayLevelType

Level of Display of Log File

Possible Values

LowMedium
Low High
MediumHigh


DistributedMassType

No details are provided for this entry.

Possible Values

TotalMass
MassPerUnitArea


DistributionType

Enumeration of the possible parameter distribution types.

Possible Values

UniformLogNorm
Uniform Lognormal
TriangularExponential
Triangular Exponential
GaussBeta
Normal Beta
TruncGaussWeibull
Truncated Normal Weibull


DoF

No details are provided for this entry.

Possible Values

None
X
Y
Z
All


DOFBehavior

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

Possible Values

Fixed
Free


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.

DpUpdateOptions

No details are provided for this entry.

DurationType

The methods used to specify duration

Possible Values

NumberOfStepsEndTime
The coupling will end at a given number of steps The coupling will end at a given time


EdgeEdgeTreatment

No details are provided for this entry.

Possible Values

Both
ParallelOnly
PerpendicularOnly


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

AutomaticVolumetric efficiency calculated. Hydraulic, mechanical and overall pump efficiencies user defined.
Efficiencies calculated from correlations Mechanical
HydraulicMechanical efficiency calculated. Hydraulic, volumetric and overall pump efficiencies user defined.
Hydraulic efficiency calculated. Volumetric, mechanical and overall pump efficiencies user defined. Pump
VolumetricOverall pump efficiency calculated. Hydraulic, volumetric and mechanical efficiencies user defined.


ElasticityType

No details are provided for this entry.

Possible Values

IsotropicElasticity
OrthotropicElasticity
NeoHookeanHyperElasticity


ElementMidsideNodes

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

Possible Values

UseEngineeringIntentElements are created without midside nodes.
Determine whether midside nodes are kept or dropped based on the Engineering Intent. Kept
DroppedElements 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


EndBehavior

Possible options for connection end behavior

Possible Values

ProgramControlled
HeatFluxDistributed
Isothermal
Coupled


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 a structural, electric conduction and/or thermal simulation.
Intent of this process is not yet known due to insufficient information in connected Physics task(s). FluidFlow
StructuralOrThermalOrElectricConductionIntent 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-Marty correlation
Casey-Robinson correlation Rodgers
CaseyMartyRodgers correlation


EtaCorrelType

Efficiency correlation type

Possible Values

SuhrmannBaines
Suhrmann's correlation Baines' correlation


EtaImpType

impeller isentropic efficiency type

Possible Values

LinkToStageUser
linked to stage efficiency user specified efficiency


EtaType

Stage efficiency type

Possible Values

UserCorrelation
User defined efficiency Efficiency calculated from correlation


EtaType

Stage efficiency type

Possible Values

UserCorrelation
User defined efficiency Efficiency calculated from correlation


EtaUserType

User specified stage efficiency type

Possible Values

IsentropicPolytropic
user-specified isentropic efficiency user-specified polytropic efficiency


ExcelConnectionState

Enumeration for the Excel Connection states

Possible Values

NotConnectedThe connection is alive
The connection with Excel is not established ConnectionLost
ConnectionAliveThe 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

AbsoluteRelative
Absolute exit angle Relative 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 expression without dependency on other parameter.
An undefined(null) expression. Derived
ConstantAn expression with dependency on other parameters.


FaceEdgePreference

Preference for face to edge contact detection.

Possible Values

FaceAndEdgeOfDifferentParts
EdgesOfSolidBodies
EdgesOfSurfaceBodies
All


FaceFacePreference

Preference for face to face contact detection.

Possible Values

FacesOfDifferentParts
All


FatigueUnitType

No details are provided for this entry.

Possible Values

Cycles
Blocks
Seconds
Minutes
Hours
Days
Months


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_SRSFITTINGTYPE_NN
Standard Response Surface - Full second order Polynomials Neural Network
FITTINGTYPE_KRIGINGFITTINGTYPE_SPARSEGRID
Kriging Sparse Grid
FITTINGTYPE_MARSFITTINGTYPE_GRS
Non Parametric Regression Genetic 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


FlowSpecification

No details are provided for this entry.

Possible Values

In
Out


FlowType

Enumeration of the flow boundary condition options.

Possible Values

MassFlow
PressureRatio
PressureDifference


FluentBoundary

No details are provided for this entry.

FluidType

Enumeration of the types of available fluids.

Possible Values

IdealGas
RealGas
Liquid


FormatType

Enumeration to specify the format type for imported data.

Possible Values

UserDefined
Delimited
Cdb
Axdt
Tgz
Anf
Brd
Mcm
Sip
Bool
Cond
Edb


FormulationType

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

Possible Values

ProgramControlled
MultiPointConstraint
PurePenalty
NormalLagrange
AugmentedLagrange


GARefinementOutType

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

Possible Values

GA_MAXOUTGA_ALLOUT
Maximum Output All Outputs


GARefinementStatusType

Enumeration for the convergence status for the GARS algorithm.

Possible Values

CS_UNKNOWNMaximum Number of Points Reached
Unknown CS_STOPPED
CS_NOTCONVERGEDStopped by the User
Not Converged CS_CONVERGED
CS_MAXPTSConverged


GasModelType

gas model type

Possible Values

IdealReal
ideal gas model real gas model


GasPropType

Gas properties type

Possible Values

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


GeneralSettings

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

GeometryAttachType

Type of geometry that is being attached.

Possible Values

ThreeDimensional
TwoDimensional
Unknown


GeometryAttachType

Type of geometry that is being attached.

Possible Values

ThreeDimensional
TwoDimensional
Unknown


GeometryStyleType

Geometry export style type

Possible Values

InteractiveParametric
Create interactive geometry Create parametric geometry


GoalType

Enumeration of the possible optimization objective types.

Possible Values

GT_NoPreferenceGT_MinimumPossible
No objective defined. Minimize.
GT_MaximumPossibleGT_SeekTarget
Maximize. Seek target.


GPUAccelerator

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

Possible Values

None
NVIDIA


GravityDefinition

GravityDefinition defines the three components of gravity and the reference frame it is relative to.

GroundedLocation

Possible locations to be grounded in a spring

Possible Values

None
Location1
Location2


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 geometrically.
Height of boundary layer determined exponentially. Linear
GeometricHeight of boundary layer determined linearly.


HubLEBetaType

Hub and Mean LE blade angle option

Possible Values

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


ICCombustionSimulationType

Type of IC Engine Combustion simulation type.

Possible Values

ICSector1 for full engine full cycle
0 for sector ICFullEngineClosedValves
ICFullEngineFullCycle2 for full engine IVC to EVO


ICIVCandEVOoption

IVC and EVO options

Possible Values

ICLiftCurvICIVCandEVO
0 lift curv profile 1 for IVC EVO option


ICSimulationType

Type of IC Engine Simulation.

Possible Values

ICSimulationColdFlow1 for Port Flow Simulation
0 for Cold Flow Simulation ICSimulationCombustion
ICSimulationPortFLow2 for Combustion Flow Simulation


ImpellerExportType

Impeller export type

Possible Values

CoupledIsolated
Coupled to volute Isolated impeller


ImpellerLengthType

impeller length ratio type

Possible Values

AutomaticUser
automatic user specified


ImpellerType

List of available impeller types

Possible Values

UnshroudedShrouded
unshrouded impeller shrouded impeller


ImportAnalysis

No details are provided for this entry.

Possible Values

NaturalFreq
HarmonicVibe
Ictanalysis
MechanicalShock
RandomVibe


ImportanceLevel

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

Possible Values

GI_MediumImportantLower
Default GI_HighImportant
GI_LowImportantHigher


ImportFacetQuality

Preference for imported facet Quality

Possible Values

PlugInFacetQuality_VeryCoarsePlugInFacetQuality_Fine
Very Coarse Fine
PlugInFacetQuality_CoarsePlugInFacetQuality_VeryFine
Coarse - Very Fine -
PlugInFacetQuality_NormalPlugInFacetQuality_Source
Normal - Source -


ImportParameterType

Defines the compare parts on update option during geometry import.

Possible Values

None
Independent
All


ImportStitchPreference

Stitch Import Preference

Possible Values

kStitchPreference_NoneStitch surfaces, but allow the program to determine the tolerance for the stitching
Do NOT stitch surfaces on import kStitchPreference_UserTolerance
kStitchPreference_ProgramToleranceStitch surfaces, execute the stitching using the user's specified tolerance value


ImportStitchType

Defines the stitching option type during geometry import.

Possible Values

None
ProgramDefined
UserDefined


ImportWeightclass

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

Possible Values

ImportWeightclass_HeavyweightImportWeightclass_Lightweight
Heavyweight - all geometry and topology Lightweight - each body consists of a single facetted face
ImportWeightclass_MiddleweightImportWeightclass_Featherweight
Middleweight - facet only faces Featherweight - parts are created along with the tree hierarchy, but no topology


IncidenceType

Incidence type

Possible Values

incidencechoke
specified incidence specified choke


InitialContactTreatment

An enumeration for initial contact treatment.

Possible Values

ProgramControlled
IgnoreInitialCondition
AutoCorrectInitialCondition


InitialInterfaceTreatmentType

Possible types for initial interface of a contact pair is treated.

Possible Values

Unknown
AdjustToTouch
OffsetWithRamping
OffsetWithoutRamping
ProgramControlled


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

ProgramControlledStart Time
Program Controlled RestartStepTime
StartTimeRestart Step and Time


InletAngleType

Inlet angle type

Possible Values

AbsoluteRelative inlet angle
Absolute inlet angle Calculated
RelativeOBSOLETE OPTION. RETAINED IN R16.0 FOR PURELY FOR BACKWARDS COMPATIBILITY Calculated from nozzle area


InletType

No details are provided for this entry.

Possible Values

NormalSpeed
Swirl
Pressure
MassFlow


int

This type represents an Integer number.

long

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

IntegrationOptions

No details are provided for this entry.

Possible Values

ProgramControlled
PreIntegrated
Mesh


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

Possible interface detection types for auto contact generation.

Possible Values

FaceToFace
FaceToEdge
EdgeToEdge


InterfaceModelSpecification

No details are provided for this entry.

Possible Values

None
Thermal


InterfaceSideSelection

No details are provided for this entry.

Possible Values

Automatic
SpecifyFace


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

The enum values for the Interpolation property to use for the AlternatingStress property charting

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

Possible options for defining equilibrium iterations key for non-linear solution in MAPDL solver

Possible Values

Unchanged
ProgramControlled
ForceToOne
ManuallySpecified


JobRunMode

The job running modes

Possible Values

ForegroundBackground mode.
Forground mode. RemoteSolveManager
BackgroundSubmitted to Remote Solve Manager to run the job.


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


JointTrimOptimization

JointTrimOptimization is an enumeration used by Joint to trim elements for face-face joints

Possible Values

ProgramControlled
Off


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

VARIABLECONSTANT
Variable Constant


LegendColoring

Types of allowed legend coloring.

Possible Values

Banded
Smooth


LevelDisplayType

Enumeration for the level of display type.

Possible Values

LD_OffFinal with details
Off LD_Iterative
LD_FinalIterative
Final LD_IterativeWithDetails
LD_FinalWithDetailsIterative with details


LinearCorrelationType

Enumeration of the Correlation types.

Possible Values

SpearmanPearson
Spearman Pearson


LineModelType

No details are provided for this entry.

Possible Values

Unknown
Beam
Truss
Spring
Cable
ThermalFluid
Pipe


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.

LoadCaseType

Load Case Type for Material Designer

Possible Values

TensileX
TensileY
TensileZ
ShearXY
ShearXZ
ShearYZ


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 stringsModel reference string with hit point
["BODY1", "FACE5"][('FACE13', ('0.062 [m]', '0.197 [m]', '0.35 [m]')),('FACE23', ('0.07 [m]', '0.569 [m]', '0.502 [m]'))]
Objects with LocationSetLocationSet returned from a function
[selectionSet1, selectionSet2]AllBodies()

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

PumpAxial Turbine
Pump RadialTurbine
AxialCompressorRadial Turbine
Axial Compressor HydraulicTurbine
CentrifugalCompressorHydraulic Turbine
Centrifugal Compressor Unknown
FanUndefined machine type
Fan Other
AxialTurbineObsolete option, use 'Unknown' instead.


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

AirPropylene
Air R123
CarbonDioxideR123
Carbon dioxide R125
HydrogenR125
Hydrogen R134a
MethaneR134a
Methane R141b
NitrogenR141b
Nitrogen R142b
OxygenR142b
Oxygen R245fa
ParahydrogenR245fa
Parahydrogen Water
PropyleneWater


MaterialPropsType

material properties type

Possible Values

DatabaseUser
select material from database user specified material properties


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 user defined defeaturing tolerance value on dirty geometry.
Automatically removes features smaller than or equal to the calculated default tolerance value on dirty geometry. Off
UserDefinedNo 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

NoneWarping factor is computed for quadrilateral shell elements and quadrilateral faces of bricks, wedges and pyramids.
No mesh metric type is selected. ParallelDeviation
ElementQualityParallel deviation is computed ignoring midside nodes and based on unit vectors along each element size.
A composite quality metric is computed ranging between 0 and 1. MaximumCornerAngle
AspectRatioMaximum corner angles are computed between adjacent edges and high corner angles can degrade element performance.
Aspect ratio is calculated based only on corner nodes of elements. Skewness
JacobianRatioSkewness is one primary quality measure that determines how close to ideal (that is, equilateral or equiangular) a face or cell is.
Jacobian ratio is computed for all elements except those with no midside nodes or perfectly centered midside nodes. OrthogonalQuality
WarpingFactorOrthogonal quality is computed using face normal vectors and ranges from 0 to 1.


MeshReading

Indicates the type of restart.

Possible Values

DirectConvert
In this mode, one loads directly the mesh (no conversion). In 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

NoUpstreamMeshFileSingleMeshFile
in this mode, no mesh file is selected from the upstream polyflow system. in 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

InformationDebug
An informational message for the user.A debug message.
WarningProgress
A warning message for the user.A progress message for the user.
ErrorNews
An error message for the user.A news update for the user.
FatalAttentionRequired
A 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.A message that requires user action to address
ProblemsStandard
Problem messages (WARNING + ERROR + FATAL).All 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


MetricErrorScatterType

Enumeration of the metric types supported.

Possible Values

ErrNrmInf
RelErrNrm2


MirrorTransformOptionsForMeshing

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

MirrorTransformOptionsForSimulation

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

MixedImportPref

Mixed import preference option for mixed dimension parts

Possible Values

MixedImport_NoneMixedImport_SolidsAndSurfaces
If mixed dimension part, import None If mixed dimension part, import Solids and Surfaces only
MixedImport_SolidsMixedImport_SolidsAndLines
If mixed dimension part, import Solids only If mixed dimension part, import Solids and Surfaces only
MixedImport_SurfacesMixedImport_SurfacesAndLines
If mixed dimension part, import Surfaces only If mixed dimension part, import Surfaces and Lines only
MixedImport_LinesMixedImport_SolidsSurfacesAndLines
If mixed dimension part, import Lines only If 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


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
IntelMPI
MSMPI
OpenMPI


MpiTypeValue

No details are provided for this entry.

Possible Values

Ibmmpi
Intel


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


NegativeBucklingLoadMultiplier

This is used for allowing negative load multiplier for eigenvalue buckling analysis.

Possible Values

ProgramControlled
No
Yes


NeoHookeanHyperElasticityDependents

Neo-Hookean Hyperelasticity dependents.

NewtonRaphsonOption

Possible ways of using Newton-Raphson method.

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_CCDPure quadratic model samples
CCD samples SFD_CROSSQUAD
SFD_LINEARFull quadratic model samples
Linear model samples SFD_USER
SFD_PUREQUADUser-defined samples


NuUserType

kinematic viscosity calculation type (obsolete)

Possible Values

SutherlandUser
calculate viscosity from Sutherland's Law (using coeffs for air) user 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_MDISTCentered L2
Max-Min Distance SFDTYPE_MAXENT
SFDTYPE_CL2Maximum entropy


OptimizationMethodSelection

Enumeration of the available optimization method selections.

Possible Values

OMS_AutoOMS_Manual
Automated selection - Optimization Method and its settings are controlled automatically by DesignXplorer Manual - Optimization Method and its settings are defined by the User


OptimizationSolverType

Possible selection for optimization solver type

Possible Values

ProgramControlled
SequentialConvexProgramming
OptimalityCriteria


OrientationDefineBy

No details are provided for this entry.

Possible Values

ReferenceFrame
Geometry


OrientationStyle

Allowed orientation of a legend. Default is Vertical

Possible Values

Vertical
Horizontal
Default


OrthotropicElasticityDependents

The Orthotropic Elasticity dependents.

OutletType

No details are provided for this entry.

Possible Values

Pressure
MassFlow
NormalSpeed


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

NoneEvery Coupling Step
No intermediate result files StepInterval
EveryStepAt defined interval


OutputSource

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

Possible Values

UserEditedThe output values are obtained by a real simulation.
The output values are edited by the user. ResponseSurface
SimulationThe 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
ElementEnergies


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

NatureContinuousObsolete. Instead of defining a usability parameter, define a continuous parameter with the UseManufacturableValues set to True.
Continuous NatureDiscrete
NatureUsabilityDiscrete


ParameterRelationshipType

Enumeration of the possible parameter relationship types.

Possible Values

PRT_LessThanOrEqualToPRT_GreaterThanOrEqualTo
Less Than or Equal To Greater Than or Equal To


ParameterUsage

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

Possible Values

InputAn output parameter whose value is based on an expression. The parameter cannot be associated directly with the data model.
A parameter whose value will be used by the data model. DirectOutput
ExpressionOutputA 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

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


PartialDesignPointUpdate

No details are provided for this entry.

Possible Values

None
Geometry


ParticleTrackColorOption

No details are provided for this entry.

Possible Values

None
Time
TimeStep
Position
TrackId
Velocity
Diameter
Temperature


ParticleTrackDisplayStyle

No details are provided for this entry.

Possible Values

Lines
LinesAndSymbols
Symbols


ParticleTrackShapeDef

No details are provided for this entry.

Possible Values

Wire
Tube


ParticleTrackStyle

No details are provided for this entry.

Possible Values

Continuous
Segments


PeriodicSurfType

Enumeration of the periodic surface options.

Possible Values

OnePiece
ThreePieces


PersistablePosition

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

UnknownYou 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.
Indicates physics type was never set Extrusion
NoneSimulation 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.
Indicates physics type was set and then cleared Electromagnetics
StructuralDenotes static and low frequency electromagnetic physics for analysis of electromechanical, etc. systems.
A 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. BlowMolding
ElectricConductionSimulation of molten polymers for blow molding / thermoforming (in the laminar regime). The fluid can be modeled by a generalized newtonian law or by a viscoelastic law. It is a transient simulation, involving deformation of the flow domain, and contact with one or more molds.
An electric analysis supports Steady-State Electric Conduction. ElectroStatic
FluidAn electric analysis supports Steady-State electric field
A fluid flow analysis that simulates fluid passing through or around an object. All
ThermalAll physics types.


PIFType

power input factor type

Possible Values

CorrelationUser
correlation user 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

Identifiers specifying plasticity types.

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


PorosityMediaMaterial

No details are provided for this entry.

Possible Values

Default
Specified


PorosityType

No details are provided for this entry.

Possible Values

Isotropic
Directional


PositionType

No details are provided for this entry.

Possible Values

Default
Left
Right
Above
Below


PostReportNamesType

CFD Post reports

Possible Values

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


PredictionErrorScatterType

Enumeration of the scatter types.

Possible Values

MetricErrorvsSnapshotCDFError
Metric Error vs Snapshots Empirical Cumulative Distribution of Error on Snapshots


PredictorKey

Possible options to activate predictor for non-linear solution in MAPDL solver.

Possible Values

Unchanged
ProgramControlled
Off
OnAfterFirstSubstep
OnForAllSubsteps


PreferenceType

Possible options for detecting contacts -- between bodies, or between bodies of different parts or all

Possible Values

BetweenBodies
BetweenBodiesOfDifferentParts
All


PreswirlType

Preswirl type

Possible Values

constantFree vortex
Constant inlet angle forced
freeSolid body rotation


PreswirlType

Preswirl type

Possible Values

constantforced
Constant inlet angle Solid body rotation
freelinear
Free vortex Linear variation of Vw


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
kTorque


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

ByEntitySelectionByCoordinate
Box can be created by enclosing single or multiple entities. Box can be created by specifying diagonal coordinates.


PriorityType

Options for override priority.

Possible Values

FaceOverride
EdgeOverride
All


ProcessDistributionOption

No details are provided for this entry.

Possible Values

LocalComputer
MultipleComputers


ProcessorUnit

Various Processore Unit options available for Microsoft Scheduler

Possible Values

Core
Socket
Node


ProgramControlType

Possible values of the underlying property in the current load step

Possible Values

Unchanged
ProgramControlled
On
Off


ProjectHandler

Handle a project file (and optional associated files). This class handles the lifecycle of the file, the instanciation of the ROM API project object and the calls to this object for ROM evaluation.

ProjectionStrategy

Projection strategy for traitement of multi-field and/or multi-component fields

Possible Values

STATE_VECTOR_PROJECTIONDedicated projection coefficient for each physics
Same projection coefficient for all physics MIXTE_PROJECTION
MULTI_FIELD_PROJECTIONDedicated projection coefficient for each physics and same projection for all component of a field of vector


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 that most mathematical operations return results in computational units for the current unit system, but this is not guaranteed, and may change in the future for performance or other reasons. If you need to ensure that results are in a particular unit, you should always apply a conversion to the final result of the calculation.

There is an FAQ on units at {Albion}/CoreAddins/Units/FAQ.md

There is a detailed description of the units string syntax at {Albion}/CoreAddins/Units/UnitSyntax.md

RadiationSpecification

No details are provided for this entry.

Possible Values

None
DiscreteOrdinates
MonteCarlo


RadiusDefineBy

No details are provided for this entry.

Possible Values

ProgramControlled
Manual


RampingType

Enum providing ramping options.

Possible Values

NoneLinear
No ramping. Linear 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


ReductionType

ReductionType enum specifies the objective options for the optimization process

Possible Values

Mass
Volume


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

Options for specifying convergence reference value: Program controlled or Manual

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.


RegionInterface2

No details are provided for this entry.

RelativeToType

Options for selecting a which reference frame to define relative to

Possible Values

Local
Parent


ResponseChartModes

Enumeration of the available Response chart modes.

Possible Values

Curve2D3D response chart where an output parameter is plotted versus two input parameters.
2D response chart where an output parameter is plotted versus an input parameter. Slices2D
Surface3D2D 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_NONEAutomated
None REFINEMENT_MANUAL
REFINEMENT_AUTOManual


ResultReference

No details are provided for this entry.

Possible Values

Relative
Absolute


ResultType

No details are provided for this entry.

Possible Values

Displacement
Velocity
Acceleration


ReverseEdgeLoopOrientation

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

Possible Values

NoYes
Construct capping surface by using default loop orientation. Construct 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

RomEngine

Engine powering the ROM

Possible Values

DEMOSVD_GA
Demo mode building ROMs suitable for testing the workflow. Build ROMs based SVD with genetic aggregation response surface


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

MachinedCast
machined surface finish cast 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

SSH
Other
RSH

RsmQueueDetails

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

RunTimeIndex

Enumeration of the available run time indexes.

Possible Values

RTI_1
RTI_2
RTI_3
RTI_4
RTI_5
RTI_6
RTI_7
RTI_8
RTI_9


SampleGenType

Enumeration for the Sampling type.

Possible Values

SAMPLE_GEN_LHSSAMPLE_GEN_WLHS
LHS WLHS


SamplesChartModes

Enumeration of the available Samples chart modes.

Possible Values

CandidatesParetoFront
Draw the samples and highlight the optimization candidates. Draw the samples using colors that represent their Pareto front.


SamplingType

Enumeration of the correlation Sampling types.

Possible Values

AutoCustom
Automated - Samples generation is controlled automatically by DesignXplorer. Custom - Samples are defined by the User.


Scale

Enum to define the scale of the axis.

Possible Values

Linear
CommonLog
NaturalLog


Scale

Enum to define the scale of the axis.

Possible Values

LinearCommon or log base 10 scale
Linear scale NaturalLog
CommonLogNatural log scale


ScaleFactor

No details are provided for this entry.

Possible Values

One
Two
Three
UserDefined


SchedulerSpecification

Various Job Schedulers available on Unix/Linux.

Possible Values

LSF
SGE
PBSPro
SLURM


SearchDirectionMethod

Possible options for detection direction method.

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

Thickness distribution type of surface bodies.

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

BarChartPieChart
2D Bar chart 2D 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
Unknown


Setup

Entity which manages the setup of the ROM feature. This DataObject must be held by a solver addin container. The solver addin container will then be used as an identifier for the solver addin system.

ShapeChecking

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

Possible Values

UseEngineeringIntentSpecifies the aggressive mechanical shape checking algorithm for structural simulations.
Determine which algorithm to use based on the Engineering Intent. CFD
StandardMechanicalSpecifies the CFD shape checking algorithm for flow simulations.
Specifies the standard mechanical shape checking algorithm for structural simulations. None
AggressiveMechanicalDisable shape checking.


ShrLEBetaType

Shroud LE blade angle option

Possible Values

IncidenceUser
Shroud LE blade angle calculated from specified incidence User defined shroud LE blade angle


ShroudDiameterType

shroud diameter type

Possible Values

Diameteruser specified shroud vane inlet angle
user specified shroud inlet diameter Optimum
Angleoptimised shroud inlet diameter (minimum Mrel)


SimulationTopOptAction

No details are provided for this entry.

Possible Values

KExportInitialPmdbAndFinalStl
KExportInitialPmdbAndFinalObj


SimulationType

Enumeration of the simulation types of a parameter.

Possible Values

DesignVariableUncertaintyVariable
Design variable Uncertainty variable


float

This type represents a single-precision floating point number.

SixSigmaTableTypes

Enumeration of the Probability Table types.

Possible Values

ProbabilityTableInverseProbabilityTable
Quantile-percentile Percentile-quantile


SizingBehavior

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

Possible Values

Soft
Hard


SlipSpecification

No details are provided for this entry.

Possible Values

NoSlip
FreeSlip


SmallSlidingSetting

Possible options for small sliding to occur in bonded or no separation contacts.

Possible Values

ProgramControlled
On
Off


Smoothing

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

Possible Values

Low
Medium
High


SnapshotCacheHandler

Handle a single snapshot cache file. This class ensure the correct registration and deregistration of the snapshot cache files and expose push/pull methods with Workbench objects.

SolutionProgression

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

SolutionStep

Solution Step

SolutionUpdateOption

System Coupling Solution Update option

Possible Values

ForegroundForeground update


SolverRestartMode

Indicates the type of restart.

Possible Values

NoRestartFileCombineCsvRestartFiles
In this mode, no restart file is used to initialize time scheme and fields. In this mode, a csv file is used to initialize fields and a restart file is used to initialize time scheme (starting time + derivates).
SingleResultFileManyResultFiles
In this mode, a result file is used to initialize fields. In 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).
CombineResultRestartFilesManyCsvFiles
In this mode, a result file is used to initialize fields and a restart file is used to initialize time scheme (starting time + derivates). In 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.
SingleCsvFileInitializationFromCsvFiles
In this mode, a csv file is used to initialize fields. In 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

GeneralRadial
Blade exported using general spanwise distribution Blade exported using radial spanwise distribution


SpringBehaviorType

No details are provided for this entry.

Possible Values

OneDSpring
ThreeDSpring


SpringPreloadType

Possible pre-loading types for a spring connection

Possible Values

None
Load
Length
Torque
Rotation


SpringType

Possible types for a spring connection

Possible Values

Longitudinal
Torsional


StabilizationKey

Possible options for stabilization key

Possible Values

Off
ConstantEnergyDissipation
ReducedEnergyDissipation
ConstantDampingFactor
ReducedDampingFactor


StackingType

stacking type

Possible Values

RadialBeta calculated from tangent
Radial stacking Sin
TanBeta calculated from sin


StateOfMatter

Identifiers specifying states of matter.

Possible Values

Unknown
None
Solid
Liquid
Gas
Plasma


Status

The current calculation status of the Excel file.

Possible Values

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


StepSizeType

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

Possible Values

Automatic
Fixed


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


StressType

StressType is an enum for the stress types

Possible Values

EquivalentStress
StressIntensity
MaximumShearStress


string

This type represents a String value.

SubStepOption

Possible settings for sub step options

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

Possible types of support

Possible Values

Unknown
Fixed
Frictionless
UserSpecified


SurfaceMonitorChainingOperation

No details are provided for this entry.

Possible Values

And
Or


SurfaceMonitorOperation

No details are provided for this entry.

Possible Values

Monitor
Halt


SurfaceMonitorVariable

No details are provided for this entry.

Possible Values

TotalPressure
StaticPressure
MassFlowRate
NormalSpeed
Temperature
DragX
DragY
DragZ
HeatFlux
MinTotalPressure
MaxTotalPressure
MinStaticPressure
MaxStaticPressure
MinNormalSpeed
MaxNormalSpeed
MinTemperature
MaxTemperature
VolumeFlowRate
HeatFlow
XVelocity
YVelocity
ZVelocity
VelocityMagnitude


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

No details are provided for this entry.

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

NoneLinear
No interpolation is done. A 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

ConstantZero
his option will cause the value returned to be the data at the index nearest to the requested index. This option will cause the value returned to be zero if the index is outside of the bounds of the table.
FitError
This 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. If the data cannot be determined from the given index (outside of the bounds) then an error will occur.


TessellationRefinement

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

Possible Values

AutomaticallyDeterminedSets tessellation refinement to user defined value.
Sets tessellation refinement to 10% of the value of Min Size/Proximity Min Size. Off
UserDefinedTessellation refinement is not performed.


ThermalWallSpecification

No details are provided for this entry.

Possible Values

Insulated
HeatFlux
HeatFlow
Temperature
Convection
Radiation
Mixed


TimeOption

No details are provided for this entry.

Possible Values

EndTime
UserDefined


TipDiamType

Impeller tip diameter option

Possible Values

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


TopologyType

All of the possible values for topology.

Possible Values

PointSurface
A topological point A topological surface
CurveVolume
A topological curve A topological volume


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

Curve2DSurface3D
2D tradeoff chart where a parameter is plotted versus another parameter. 3D 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

StartOfStepStartOfIteration
Transfer data at start of step. Transfer data at start of iteration.


TransferDataFromNewComponentSpec

No details are provided for this entry.

TransferDataToNewComponentSpec

No details are provided for this entry.

TransferType

Transfer type from ACP

Possible Values

Shell
Solid
None


Transform4x4

Represents a combined rotation and translation matrix Rotation matrix is the first 3 rows and columns in row-major order Translation matrix is the 4th column

TransformationType

Enumeration of the available transformation types applicable to a parameter.

Possible Values

TransTypeNoneBox-Cox
No transformation TransTypeYeo
TransTypeBoxYeo-Johnson


TransformType

Transform type for assembly

Possible Values

RotationAndTranslation
Mirroring


TransformType

Transform type for assembly

Possible Values

RotationAndTranslation
Mirroring


TransformType

Transform type for assembly

Possible Values

RotationAndTranslation
Mirroring


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

ProgramControlledAdvancingFront
Mesher determines usage of Delaunay or Advancing Front algorithm. Mesher 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


TurbulenceSpecification

No details are provided for this entry.

Possible Values

Laminar
SpalartAllmaras
KEpsilonStandard
KEpsilonRealizable
KOmegaStandard
KOmegaSst


TypeOfInitialSampling

Enumeration for the Initial Sampling Type.

Possible Values

E_ScreeningOptimal Space-Filling
Screening E_ConstrainedSampling
E_OSFConstrained 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

Unknownlast update of the entity gave an error.
entity state can not be defined. OutOfDateWithError
OutOfDateentity is out of date and last update of the entity gave an error.
entity is out of date. UpToDateWithError
UpToDateentity is up of date and last update of the entity gave an error.
entity is up to date. RefreshRequired
Errorentity needs a refresh.


UpdateContinuation

No details are provided for this entry.

Possible Values

None
TargetOnly
All


UpdateErrorBehavior

No details are provided for this entry.

Possible Values

Stop
SkipDesignPoint
Continue


UpdateStiffnessControlType

Possible options to update the stifness in a contact analysis.

Possible Values

ProgramControlled
EachEquilibriumIteration
EachEquilibriumIterationAggressive
Never
EachEquilibriumIterationNominal
EachEquilibriumIterationExponential


UseAdvancedLocalSizeFunction

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

Possible Values

ProgramControlled
ProximityCurvature
Curvature
Proximity
Fixed


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

YesNo
Automatically detects and utilizes all available processors for meshing parts of an assembly in parallel. Manually 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


UserObject

No details are provided for this entry.

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

StandardExpert
Default Expert


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

SutherlandUser-specified dynamic viscosity
Viscosity calculated using Sutherland's Law (2 coefficient method) Kinematic
DynamicUser specified kinematic viscosity


VolumeDataInput

This class defines input parameters used for Rapid Results Exploration(RRE).

VoluteType

Volute style option

Possible Values

EllipticRectangular
Elliptic/circular cross sections Rectangular cross sections


WallMotionSpecification

No details are provided for this entry.

Possible Values

Stationary
Rotating


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 separate zone for each body.
Creates a single zone for each part. Face
BodyCreates a separate zone for each face.