Data Types
A breakdown of the types represented in this document
Enumeration for the Output Variable Combinations type when refining for the Kriging algorithm.
| AK_MAXOUT | Maximum Output |
| AK_ALLOUT | All Outputs |
| AK_SUMOUT | Sum of Outputs |
Used to specify whether mesh may deviate from geometry as a result of wrapper surface improvement. The default value is MeetTarget.
| MeetTarget | Modify the geometry as needed to meet quality target. |
| MaintainGeometry | Compromise targets to maintain geometry. |
No details are provided for this entry.
| Unknown |
| ProximityBased |
| TrajectoryBased |
Enumeration of the possible continuous input parameter types.
| Any | Any |
| ManufacturableValues | Manufacturable Values |
| SnapToGrid | SnapToGrid |
3D/2D import option
| AnalysisType_3D | Import all 3D objects |
| AnalysisType_2D | Import only 2D objects (The model must be in the x-y plane.) |
Define Auto Time Stepping by Time or Substeps as available in MAPDL solver.
| Substeps |
| Time |
Enumeration of the Automatic Range modes for output parameters.
| OutputParameterMinMax | The range of the output parameter axis is determined from the minimum and maximum of the parameter (min-max search of DPs min-max) |
| ChartData | The range of the output parameter axis is determined by the min and max of the chart's data. |
Used to specify the bias option. Currently, this is always SmoothTransition.
| SmoothTransition |
Used to specify the option for bias type. The default value is Constant.
| Right |
| Left |
| CenterIn |
| CenterOut |
| Constant |
Enumeration of the possible blade lofting directions.
| Streamwise |
| Spanwise |
BladeGen/BladeEditor units type
| m | Create blade model in metres |
| cm | Create blade model in cm |
| mm | Create blade model in mm |
| inches | Create blade model in inches |
| ft | Create blade model in feet |
BladeGen/BladeEditor units type
| mm | Create blade model in mm |
| inches | Create blade model in inches |
The body grouping property used when importing the model.
| None | No body grouping action should be performed. |
| Material | The model should be grouped by material IDs. |
| ElementType | The model should be grouped by element type IDs. |
| Thickness | The model should be grouped by thickness IDs. |
| Components | The model should be grouped by component IDs. |
| Unknown | The body grouping property is not set. |
Type of geometry that is being attached.
| MaterialNumber |
| MaterialNumberAndThickness |
| NoGrouping |
Used to specify if pre or post boundary layer algorithm should be used by the mesher. The default value is Pre.
| Post |
| Pre |
Used to specify the way heights of the boundary layers are determined. The default value is SmoothTransition.
| TotalThickness | Creates constant boundary layers using the values of Number of Layers and Growth Rate. |
| FirstLayerThickness | Creates constant bounadry layers using values of First Layer Height, Maximum Layers and Growth Rate. |
| SmoothTransition | Mesher ensures smooth rate of volume change using local tetrahedral element size. |
| FirstAspectRatio | Creates boundary layers using values of First Aspect Ratio, Maximum Layers and Growth Rate. |
| LastAspectRatio | Creates constant boundary layers using values of First Layer Height, Maximum Layers and Aspect Ratio. |
Box cushion type options.
| Uniform | Uniform cushion around box. |
| Nonuniform | Non-Uniform cushion around box. |
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.
| CADImportParameterType_None | Do NOT import parameters |
| CADImportParameterType_Independent | Import editable parameters -- default value (like old true value) |
| CADImportParameterType_All | Import all paramters that match the filter, both independent and dependent (read-only) |
CalculationFrequency specifies the frequency to write the specified solution results of OutputType
| AllTimePoints |
| LastTimePoint |
| EquallySpacedTimePoints |
| SpecifiedRecurrenceRate |
| Never |
The available analysis types for an analysis.
| Unknown | No details are provided for this entry. |
| None | No details are provided for this entry. |
| Static | Computation of the system that is time independent. |
| TimeDependent | Computation of the system that is time dependent. |
| Modal | Computation of the dynamic response of a system under excitation |
| FrequencyResponse | Frequency domain analysis of a system |
| Optimization | Topology optimization analysis |
| All | All domains. |
Enumeration of the Coloring methods used for Candidates chart.
| ColoringPerPointType | The color is used to distinguish the different types of candidate points (Starting Points, Candidate Points, etc). |
| ColoringPerOutputNature | The color is used to distinguish the nature of the output values (Response Surface or Simulation). |
Options for choosing selection method for capping surface.
| CappingSurfaceFacesConstraint | Construct capping surface by capping all laminar loops of selected faces. |
| CappingSurfaceEdgesConstraint | Construct capping surface by capping all loops of selected edges. |
| CappingSurfaceLoopsConstraint | Construct capping surface by capping all specified loops. |
| CappingSurfaceVerticesConstraint | Construct capping surface by capping the loop formed by selected Vertices. |
Enumeration for the Template Type for CCD algorithm.
| CCD_STANDARD_TEMPLATE | Standard |
| CCD_ENHANCED_TEMPLATE | Enhanced |
Enumeration of the available design types for the Central Composite Design algorithm.
| CCDTYPE_FACE_CENT | Face-Centered |
| CCDTYPE_ROT | Rotatable |
| CCDTYPE_VIF_OPT | VIF-Optimality |
| CCDTYPE_G_OPT | G-Optimality |
| CCDTYPE_AUTO | Auto Defined |
The possible chart axes.
| XAxis | X axis |
| YAxis | Y axis |
| ZAxis | Z axis |
| XTopAxis | Secondary X axis drawn at the top of the chart. |
| YRightAxis | Secondary Y axis drawn at the right of the chart. |
| SweepAxis | An axis used to sweep over an additional parameter. |
Enumeration of the Coloring methods used for Tradeoff and Samples charts.
| ColoringPerFront | A different color for each Pareto fronts (several samples have the same color). |
| ColoringPerSample | A different color for each sample. |
Allowed styles of a multi-axis chart.
| PCP | Parallel Coordinate Plot |
| Spider | Spider Plot |
Enumeration for the chart type.
| ChartUnknown | Unknown |
| ChartResponse | Response |
| ChartTradeoff | Tradeoff |
| ChartSamples | Samples |
| ChartDistributions | Distributions |
| ChartCorrelation | Correlation |
| ChartSpiderResponses | Spider |
| ChartLocalSensitivity | Local Sensitivity |
| ChartSensitivities | Sensitivities |
| ChartStatistics | Statistics |
| ChartCorrelationScatter | Correlation Scatter |
| ChartDesignPointsParallel | Parameters Parallel |
| ChartDesignPointsCurves | Design Points vs. Parameters |
| ChartDetermination | Determination Matrix |
| ChartPredictedvsObserved | Predicted vs. Observed |
| ChartDeterminationHistogram | Determination Histogram |
| ChartConvergence | Convergence |
| ChartLocalSensitivityCurves | Local Sensitivity Curves |
| ChartCustom | Custom Chart |
| ChartCandidates | Candidates |
| ChartHistory | History |
| ChartConvergenceCriteria | History |
| ChartParameterRelationship | History |
Enumeration of the tip clearance specification options.
| None |
| RelativeLayer |
| AbsoluteLayer |
inpeller clearance type
| Ratio | tip clearance specified as a ratio |
| User | tip clearance specified directly |
Options when deleting messages.
| KeepMessagesIfSourceMatched | Do not delete message if its source matches the specified one. |
| ClearMessagesIfSourceMatched | Delete message if its source matches the specified one. |
| ClearMessagesIfSourceNotMatched | Delete message if its source does not match the specified one. |
| IgnoreSource | Do not check source attribute. |
Used to specify the strategy to be used for avoiding collisions between inflated surface meshes. The default value is StairStepping.
| None | No check for layer collisions. |
| LayerCompression | Boundary layers are compressed in collision areas. |
| StairStepping | Prism layers are stair stepped to avoid collision and maintain the gap defined by gap factor. |
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.
Compare parts on update options
| ComparePartsMethod_None | Do NOT compare parts on update -- default value |
| ComparePartsMethod_Associatively | Compare parts using associative mechanism, if geometry interface is non-associative expect failures in compare |
| ComparePartsMethod_NonAssociatively | Compare parts using entity comparisons based on index of second model to original attach |
Compare parts on update tolerance options
| ComparePartsTolerance_Loose | A greater loosening of the default tolerance |
| ComparePartsTolerance_Normal | Looser tolerance than default to allow some wiggle room for slight deviations |
| ComparePartsTolerance_Tight | Default, existing behavior |
List of available component configurations
| ImpellerMainOnly | impeller (main blade only) |
| ImpellerOneSplitter | impeller (main blade + 1 splitter) |
| ImpellerTwoSplitters | impeller (main blade + 2 splitters) |
Switch to use program controlled conductance value or enter value.
| ProgramControlled |
| Manual |
Enumeration of the Constraint Handling types.
| AsGoals | Relaxed constraint. |
| AsHardConstraints | Strict constraint. |
Enumeration of the possible optimization constraint types.
| CT_NoPreference | No constraint defined. |
| CT_NearTarget | Equals target. |
| CT_LessThanTarget | Less than target. |
| CT_GreaterThanTarget | Greater than target. |
| CT_InsideBounds | Inside bounds. |
Options for choosing construction algorithm for capping surface.
| Delaunay | Construct capping surface by using delaunay triangulation. |
| FillHole | Construct capping surface by using hole filling algorithms. |
| ConvexHull | Construct capping surface by using convex hull approach. |
| Automatic | Construct capping surface by choosing appropriate construction algorithm. |
No details are provided for this entry.
| ProgramControlled |
| TargetNormalUncoupleUtoROT |
| TargetNormalCoupleUtoROT |
| InsidePinballCoupleUtoROT |
No details are provided for this entry.
| ProgramControlled |
| DetectOnGaussPoint |
| DetectNodalNormalFromContact |
| DetectNodalNormalToTarget |
| DetectNodalProjectedNormalFromContact |
Method for selecting the physics type: Program controlled or Manual
| AllRelevant |
| Specified |
Type of contact for eg. Bonded, Frictional, Frictionless, etc.
| Bonded |
| NoSeparation |
| Frictionless |
| Rough |
| Frictional |
Enumeration to specify the coordinate system type for imported data.
| Cartesian |
| Cylindrical |
Enumeration of the correlation Auto Stop types.
| ExecuteAllSimulations | Execute all Simulations. |
| EnableAutoStop | Enable Auto Stop: execute Simulations iteratively until the process converges or the maximum number of simulation specified is reached. |
The valid coupling types
| Undefined | This is internal option used to cache the user selection of analysis type. It cannot be specified by the user. |
| General | Define the coupling by time steps |
| Transient | Define the coupling by time intervals |
| Harmonic | Define the coupling by frequency intervals. The harmonic coupled analysis is not currently supported. |
Used to specify whether intersecting edges should be created for overlapping bodies. The default value is No.
| Yes |
| No |
Allows clients of a generator to tag objects as created automatically by the program or created manually by the user in a consistent manner.
| Automatic |
| Manual |
No details are provided for this entry.
| Centroid |
| ShearCenter |
| Origin |
| UserDefined |
An enumeration for damped modal solver types as available from MAPDL solver.
| ProgramControlled |
| FullDamped |
| ReducedDamped |
A reference to a data container, similar to a DataReference referring to an entity.
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.
| Column | Column-major |
| Row | Row-major |
A Data Reference holds and manages a reference to a data entity in the Workbench data model.
This type contains an ordered set of DataReferences. No modifications can be made to the contents.
This enumeration represents all of the tensor types supported by the MPC variable.
| AType | An unknown type |
| Scalar | A scalar |
| VectorXY | A vector in x and y components |
| VectorYZ | A vector in y and z components |
| VectorXZ | A vector in x and z components |
| VectorXYZ | A vector in x, y, and z components |
| VectorRA | A vector in r and a components |
| VectorAZ | A vector in a and z components |
| VectorRZ | A vector in r and z components |
| VectorRAZ | A vector in r, a, and z components |
| VectorRI | A vector in r and i components |
| VectorIA | A vector in i and a components |
| VectorRIA | A vector in r, i, and a components |
| Tensor2XYZ | A 2D tensor |
| Tensor4XYZ | A 4D Tensor |
| SymTensor2XYZ | A 2D symmetric tensor |
| SymTensor4XYZ | A 4D symmetric tensor |
| AntisymTensor2XYZ | An anti-symmetric tensor |
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.
Debug levels for the log output. Increasing levels generates more detailed output in the log.
| None | No debug output |
| Level1 | Level 1 |
| Level2 | Level 2 |
| Level3 | Level 3 |
| Level4 | Level 4 |
| Level5 | All Levels |
| Default | Use Default Output Level |
This enum is used to set how tolerance is specified. It can be program controlled or user can manual set the property value.
| ProgramControlled |
| UserDefined |
How much to deform the Results display
| None |
| Actual |
| FiftyPercent |
| OneHundredPercent |
| TwoHundredPercent |
| FiveHundredPercent |
| FiveHundrenPercent |
| Custom |
Enumeration to specify the type of delimiter in imported data.
| Comma |
| Semicolon |
| Space |
| Tab |
| UserDefined |
The enum values for the Derivation property to use for the IsotropicElasticity values.
| Unknown |
| YoungsModulusPoissonsRatio |
| ShearModulusPoissonsRatio |
| BulkModulusPoissonsRatio |
| YoungsModulusShearModulus |
| YoungsModulusBulkModulus |
| BulkModulusShearModulus |
Enumeration for the derivative approximation type.
| DA_CentralDifference | Central Difference |
| DA_ForwardDifference | Forward Difference |
Design point job control to RSM
| OneJobAllDesignPoints | Submit one job for all design points |
| OneJobPerDesignPoint | Submit one job per design point |
| OneJobForGroupDesignPoint | Submit one job for group design point |
License Checkout
| OnDemand | Checkout License on demand |
| Reserved | Checkout License reserved |
Retained or Exported design point update
| Parameters | Update parameters |
| FullProject | Update full project |
Indicates a design point parameter's current state.
| NeverSolvedAndFailed | Parameter has never been successfully updated and the last update failed. |
| NeverSolved | Parameter has never been updated. |
| Failed | Parameter was previously UpToDate but last update failed. |
| OutOfDate | 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. |
| Interrupted | Parameter is updated but the update was interrupted |
| UpToDate | Parameter is successfully updated. |
Design point update order
| UpdateFromCurrentDesignPoint | Update from base |
| UpdateDesignPointsInOrder | Update desing points in order |
Enumeration of the Determination Coefficient chart modes.
| Linear | Display linear determination coefficients. |
| Quadratic | Display quadratic determination coefficients. |
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"
Enumeration to specify the dimensionality of imported data.
| Dimension2D |
| Dimension3D |
No details are provided for this entry.
| NoMagnetization |
| Cartesian |
| Cylindrical |
| Spherical |
The direction the streamline is moving, relative to inlets and outlets
| Backward |
| Forward |
| Both |
No details are provided for this entry.
| Unknown |
| TranslationAndRotation |
| TranslationOnly |
| RotationOnly |
Enumeration of the possible parameter distribution types.
| Uniform | Uniform |
| Triangular | Triangular |
| Gauss | Normal |
| TruncGauss | Truncated Normal |
| LogNorm | Lognormal |
| Exponential | Exponential |
| Beta | Beta |
| Weibull | Weibull |
Styles of dot symbols. Default is none
| None |
| Ellipse |
| Rect |
| Diamond |
| Hexagon |
| Triangle |
| DTriangle |
| UTriangle |
| LTriangle |
| RTriangle |
| Cross |
| XCross |
| Star |
| Default |
The methods used to specify duration
| NumberOfSteps | The coupling will end at a given number of steps |
| EndTime | The coupling will end at a given time |
Used to specify if the edge sizing should be based on the element size or on the number of divisions.
| ElementSize |
| EdgeDivisions |
Impeller efficiency type
| Automatic | Efficiencies calculated from correlations |
| Hydraulic | Hydraulic efficiency calculated. Volumetric, mechanical and overall pump efficiencies user defined. |
| Volumetric | Volumetric efficiency calculated. Hydraulic, mechanical and overall pump efficiencies user defined. |
| Mechanical | Mechanical efficiency calculated. Hydraulic, volumetric and overall pump efficiencies user defined. |
| Pump | Overall pump efficiency calculated. Hydraulic, volumetric and mechanical efficiencies user defined. |
Used to define whether elements are created with or without midside nodes. The default value is UseEngineeringIntent.
| UseEngineeringIntent | Determine whether midside nodes are kept or dropped based on the Engineering Intent. |
| Dropped | Elements are created without midside nodes. |
| Kept | Elements are created with midside nodes. |
Used to specify the mesh element shape for the bodies associated with this control.
| Automatic |
| Tetrahedrons |
| Hexahedrons |
Supported types of engineering data.
| Unknown |
| Material |
| Load |
| BeamSection |
| Mixture |
Used to define the kind of physics that is being studied in this simulation process (used in part-based Meshing).
| Unknown | Intent of this process is not yet known due to insufficient information in connected Physics task(s). |
| StructuralOrThermalOrElectricConduction | Intent of this process is a structural, electric conduction and/or thermal simulation. |
| FluidFlow | Intent of this process is a fluid flow, or a fluid-solid heat conduction simulation. |
Equation Solver Types as available from MAPDL solver.
| ProgramControlled |
| Direct |
| Iterative |
| Unsymmetric |
| Supernode |
| Subspace |
Efficiency correlation type
| CaseyRobinson | Casey-Robinson correlation |
| CaseyMarty | Casey-Marty correlation |
| Rodgers | Rodgers correlation |
Efficiency correlation type
| Suhrmann | Suhrmann's correlation |
| Baines | Baines' correlation |
impeller isentropic efficiency type
| LinkToStage | linked to stage efficiency |
| User | user specified efficiency |
Stage efficiency type
| User | User defined efficiency |
| Correlation | Efficiency calculated from correlation |
Stage efficiency type
| User | User defined efficiency |
| Correlation | Efficiency calculated from correlation |
User specified stage efficiency type
| Isentropic | user-specified isentropic efficiency |
| Polytropic | user-specified polytropic efficiency |
Enumeration for the Excel Connection states
| NotConnected | The connection with Excel is not established |
| ConnectionAlive | The connection is alive |
| ConnectionLost | The connection has been lost |
Options for handling execution control conflicts on Edit
| Default |
| UseSetupExecutionControl |
| UseSetupExecutionControlAlways |
| UseSolutionExecutionControl |
| UseSolutionExecutionControlAlways |
Enumeration for the execution control conflict resolution.
| IssueWarning |
| UseExecutionControlFromSetup |
| UseExecutionControlFromSolution |
Exit angle type
| Absolute | Absolute exit angle |
| Relative | Relative exit angle |
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.
Specifies the possible types of parameter expression.
| Undefined | An undefined(null) expression. |
| Constant | An expression without dependency on other parameter. |
| Derived | An expression with dependency on other parameters. |
No details are provided for this entry.
| FaceAndEdgeOfDifferentParts |
| EdgesOfSolidBodies |
| EdgesOfSurfaceBodies |
| All |
No details are provided for this entry.
| Cycles |
| Blocks |
| Seconds |
| Minutes |
| Hours |
| Days |
| Months |
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.
| Mesh |
| Case |
| Data |
| Bc |
| 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 |
Style of any filled region. The default is None.
| None |
| Solid |
| Dense |
| Medium |
| Sparse |
| Horizontal |
| Vertical |
| Cross |
| BDiagonal |
| FDiagonal |
| CrossDiagonal |
| Gradient |
| Default |
Enumeration for the Response Surface type.
| FITTINGTYPE_SRS | Standard Response Surface - Full second order Polynomials |
| FITTINGTYPE_KRIGING | Kriging |
| FITTINGTYPE_MARS | Non Parametric Regression |
| FITTINGTYPE_NN | Neural Network |
| FITTINGTYPE_SPARSEGRID | Sparse Grid |
| FITTINGTYPE_GRS | Genetic Aggregation |
Used to specify whether the heights or ratios of the first boundary layer will be modified to avoid collision. The default value is No.
| Yes |
| No |
Enumeration of the flow boundary condition options.
| MassFlow |
| PressureRatio |
| PressureDifference |
Enumeration to specify the format type for imported data.
| UserDefined |
| Delimited |
| Cdb |
| Axdt |
| Tgz |
| Anf |
| Brd |
| Mcm |
| Sip |
| Bool |
| Cond |
Set the contact formulation to be used by the solver for a particular contact pair.
| ProgramControlled |
| MultiPointConstraint |
| PurePenalty |
| NormalLagrange |
| AugmentedLagrange |
Enumeration for the Output Variable Combinations type when refining for the GARS algorithm.
| GA_MAXOUT | Maximum Output |
| GA_ALLOUT | All Outputs |
Enumeration for the convergence status for the GARS algorithm.
| CS_UNKNOWN | Unknown |
| CS_NOTCONVERGED | Not Converged |
| CS_MAXPTS | Maximum Number of Points Reached |
| CS_STOPPED | Stopped by the User |
| CS_CONVERGED | Converged |
Gas properties type
| Air | Gas props - Air |
| AFR | Gas props - Air/fuel ratio |
| Fixed | Gas props - Fixed |
This is a class meant to provide an abstraction over different kinds of advanced result settings, such as Fatigue Settings.
3D/2D Geometry import option
| Type3D | Import all 3D objects |
| Type2D | Import only 2D objects (The model must be in the x-y plane.) |
Type of geometry that is being attached.
| ThreeDimensional |
| TwoDimensional |
| Unknown |
Geometry export style type
| Interactive | Create interactive geometry |
| Parametric | Create parametric geometry |
Enumeration of the possible optimization objective types.
| GT_NoPreference | No objective defined. |
| GT_MaximumPossible | Maximize. |
| GT_MinimumPossible | Minimize. |
| GT_SeekTarget | Seek target. |
Enumeration for the graphics acceleration library to be used by the Mechanical APDL editor.
| None |
| Amd |
| Intel |
| NVIDIA |
Determines height of boundary layers for given initial height and height ratio. The default value is Geometric.
| Exponential | Height of boundary layer determined exponentially. |
| Geometric | Height of boundary layer determined geometrically. |
| Linear | Height of boundary layer determined linearly. |
Hub and Mean LE blade angle option
| Cot | Hub/Mean LE blade angle calculated using cotangent (rel to Shroud LE beta) |
| Cos | Hub/Mean LE blade angle calculated using cosine (rel to Shroud LE beta) |
| User | User defined hub and mean LE blade angles |
Type of IC Engine Combustion simulation type.
| ICSector | 0 for sector |
| ICFullEngineFullCycle | 1 for full engine full cycle |
| ICFullEngineClosedValves | 2 for full engine IVC to EVO |
IVC and EVO options
| ICLiftCurv | 0 lift curv profile |
| ICIVCandEVO | 1 for IVC EVO option |
Type of IC Engine Simulation.
| ICSimulationColdFlow | 0 for Cold Flow Simulation |
| ICSimulationPortFLow | 1 for Port Flow Simulation |
| ICSimulationCombustion | 2 for Combustion Flow Simulation |
The ID handling property for the current object.
| None | No action must be carried out when renumbering the attributes of the current object. |
| Automatic | The IDs of the attributes of the current object must be automatically renumbered so that no conflicts will happen. |
| Unknown | The ID Handling property is not set. |
Impeller export type
| Coupled | Coupled to volute |
| Isolated | Isolated impeller |
List of available impeller types
| Unshrouded | unshrouded impeller |
| Shrouded | shrouded impeller |
Enumeration of the importance levels which can be associated with an optimization objective or constraint.
| GI_MediumImportant | Default |
| GI_LowImportant | Lower |
| GI_HighImportant | Higher |
Defines the compare parts on update option during geometry import.
| None |
| Independent |
| All |
Preference for imported weightclass, could be used for identifying weightclasses of imported parts
| ImportWeightclass_Heavyweight | Heavyweight - all geometry and topology |
| ImportWeightclass_Middleweight | Middleweight - facet only faces |
| ImportWeightclass_Lightweight | Lightweight - each body consists of a single facetted face |
| ImportWeightclass_Featherweight | Featherweight - parts are created along with the tree hierarchy, but no topology |
No details are provided for this entry.
| Unknown |
| AdjustToTouch |
| OffsetWithRamping |
| OffsetWithoutRamping |
Initilization Methods
| ProgramControlled |
| SolverControlled |
| ProvideInitialSolution |
Enumeration for the Solution update initialization options.
| Automatic |
| CachedSolutionData |
| CurrentSolutionData |
| InitialConditions |
The initialization settings
| ProgramControlled | Program Controlled |
| StartTime | Start Time |
| RestartStepTime | Restart Step and Time |
Inlet angle type
| Absolute | Absolute inlet angle |
| Relative | Relative inlet angle |
| Calculated | OBSOLETE OPTION. RETAINED IN R16.0 FOR PURELY FOR BACKWARDS COMPATIBILITY Calculated from nozzle area |
IntegrationType of elements used by solvers such as Full or Reduced.
| Unknown |
| ProgramControlled |
| Full |
| Reduced |
InterfaceBehavior is an abstraction over all kinds of interface behaviors such as JointBehavior, BeamBehavior, LinkBehavior, SpringBehavior and ContactBehavior.
It allows you to create one connection behavior and share it or create separate ones for each one of searched interfaces.
| Shared |
| Individual |
No details are provided for this entry.
| FaceToFace |
| FaceToEdge |
| EdgeToEdge |
It allows to let either program decides the tolerance value for you or you choose to input your own tolerance value
| Automatic |
| Manual |
Type of inerfaces to be generated. Select from Contact, Joint and Mesh Interface.
| None |
| Contact |
| Joint |
| MeshInterface |
Used when IsotropicElasticity is constant for all independent variables (e.g. Temperature).
Specifies how to obtain the isovalues for the isosurface
| Manual |
| Automatic |
No details are provided for this entry.
| Unchanged |
| ProgramControlled |
| ForceToOne |
| ManuallySpecified |
The job running modes
| Foreground | Forground mode. |
| Background | Background mode. |
| RemoteSolveManager | Submitted to Remote Solve Manager to run the job. |
| Portal | Submitted to the Portal Web Service |
| Dcp | Submitted to a DCP database (Temporary just for prototyping, this will be replaced by a better mechanism later) |
JointFormulation types used by Mapdl Fixed Joint Connection Behavior
| ProgramControlled |
| RigidLink |
| RigidBeam |
| Weld |
JointReductionMethod is an enumeration used by Mapdl Fixed Joint Connection Behavior formulations
| ProgramControlled |
| DirectEliminationMethod |
| LagrangeMultiplierMethod |
This is a collection of all available joint types.
| Unknown |
| Fixed |
| Hinge |
| Translational |
| Slot |
| Cylindrical |
| Universal |
| Spherical |
| Planar |
| General |
| Bushing |
| PointOnCurve |
Enumeration of the Kernel Variation types.
| VARIABLE | Variable |
| CONSTANT | Constant |
Enumeration for the level of display type.
| LD_Off | Off |
| LD_Final | Final |
| LD_FinalWithDetails | Final with details |
| LD_Iterative | Iterative |
| LD_IterativeWithDetails | Iterative with details |
Enumeration of the Correlation types.
| Spearman | Spearman |
| Pearson | Pearson |
Styles of lines that can be displayed. The default is Solid.
| None |
| Solid |
| Dense |
| Medium |
| Sparse |
| DashShort |
| DashMedium |
| DashLong |
| DashDot |
| DashDotDot |
| DashDashDot |
| Gradient |
| Default |
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.
| UseGlobalSettings |
| Dropped |
| Kept |
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 function | AllBodies() |
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.
| MachineList |
| FileName |
Setup Entity enum definition for machine type
| Pump | Pump |
| AxialCompressor | Axial Compressor |
| CentrifugalCompressor | Centrifugal Compressor |
| Fan | Fan |
| AxialTurbine | Axial Turbine |
| RadialTurbine | Radial Turbine |
| HydraulicTurbine | Hydraulic Turbine |
| Unknown | Undefined machine type |
| Other | Obsolete option, use 'Unknown' instead. |
Run the solver in batch mode just while solving or keep it live.
| Live |
| Batch |
The material object holds all information that defines the behavior for a specific material.
Database materials list Note that this is currently a fixed list which must correspond to the vistaFluids.xml database
| Air | Air |
| CarbonDioxide | Carbon dioxide |
| Hydrogen | Hydrogen |
| Methane | Methane |
| Nitrogen | Nitrogen |
| Oxygen | Oxygen |
| Parahydrogen | Parahydrogen |
| Propylene | Propylene |
| R123 | R123 |
| R125 | R125 |
| R134a | R134a |
| R141b | R141b |
| R142b | R142b |
| R245fa | R245fa |
| Water | Water |
material properties type
| Database | select material from database |
| User | user specified material properties |
No details are provided for this entry.
| ReIm |
| RL |
| Induct |
| FluxLinkage |
| ICCoefficient |
| Resistance |
No details are provided for this entry.
| ProgramControlled |
| UserDefined |
Used to specify the type of automatic defeaturing for dirty geometries. The default value is AutomaticallyDetermined.
| AutomaticallyDetermined | Automatically removes features smaller than or equal to the calculated default tolerance value on dirty geometry. |
| UserDefined | Automatically removes features smaller than or equal to the user defined defeaturing tolerance value on dirty geometry. |
| Off | No defeaturing done on dirty geometry. |
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.
| CFX |
| ICEM_CFD |
| FLUENT |
| POLYFLOW |
| Unknown |
Used to specify the metric type based on which mesh quality is evaluated. The default value is None.
| None | No mesh metric type is selected. |
| ElementQuality | A composite quality metric is computed ranging between 0 and 1. |
| AspectRatio | Aspect ratio is calculated based only on corner nodes of elements. |
| JacobianRatio | Jacobian ratio is computed for all elements except those with no midside nodes or perfectly centered midside nodes. |
| WarpingFactor | Warping factor is computed for quadrilateral shell elements and quadrilateral faces of bricks, wedges and pyramids. |
| ParallelDeviation | Parallel deviation is computed ignoring midside nodes and based on unit vectors along each element size. |
| MaximumCornerAngle | Maximum corner angles are computed between adjacent edges and high corner angles can degrade element performance. |
| Skewness | Skewness is one primary quality measure that determines how close to ideal (that is, equilateral or equiangular) a face or cell is. |
| OrthogonalQuality | Orthogonal quality is computed using face normal vectors and ranges from 0 to 1. |
Indicates the type of restart.
| Direct | In this mode, one loads directly the mesh (no conversion). |
| Convert | In this mode, one converts the *.poly or fluent *.msh into a polyflow *msh file |
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
| NoUpstreamMeshFile | in this mode, no mesh file is selected from the upstream polyflow system. |
| SingleMeshFile | in this mode, a mesh file is selected from a list of meshes coming from the upstream polyflow system. |
The valid message types.
| Information | An informational message for the user. |
| Warning | A warning message for the user. |
| Error | An error message for the user. |
| Fatal | 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. |
| Problems | Problem messages (WARNING + ERROR + FATAL). |
| Debug | A debug message. |
| Progress | A progress message for the user. |
| News | A news update for the user. |
| AttentionRequired | A message that requires user action to address |
| Standard | All non-debug and non-progress messages. |
The method used to create the Single Value Result
| FunctionCalculatorMethod |
| UserDefinedExpressionMethod |
Used to specify the measure to be used for improving the mesh quality. The default value is Skewness.
| Skewness |
| SizeChange |
| AspectRatio |
Mixed import preference option for mixed dimension parts
| MixedImport_None | If mixed dimension part, import None |
| MixedImport_Solids | If mixed dimension part, import Solids only |
| MixedImport_Surfaces | If mixed dimension part, import Surfaces only |
| MixedImport_Lines | If mixed dimension part, import Lines only |
| MixedImport_SolidsAndSurfaces | If mixed dimension part, import Solids and Surfaces only |
| MixedImport_SurfacesAndLines | If mixed dimension part, import Surfaces and Lines only |
Defines the mixed resolution option during geometry import.
| None |
| Solid |
| Sheet |
| Wire |
| Point |
| SolidSheet |
| SolidWire |
| SolidPoint |
| SheetWire |
| SheetPoint |
| WirePoint |
| SheetWirePoint |
| SolidWirePoint |
| SolidSheetPoint |
| SolidSheetWire |
| All |
The type (format) of the model, either from files or data from other systems.
| Abaqus | The model is formatted according to the ABAQUS standard. |
| CFX | The model is formatted according to the CFX standard. |
| CMDB | The model is stored in a Meshing database. |
| Fluent | The model is formatted according to the Fluent standard. |
| Icem | The model is formatted according to the Icem standard. |
| MechAPDLCDB | The model is formatted according to the CDB standard, used in Mechanical APDL. |
| Nastran | The model is formatted according to the Nastran standard. |
| SimulationSetup | The model is stored in a Simulation database. |
| STL | The model is formatted according to the STL standard. |
| ACMO | The model is stored in an ACMO database. |
| MechAPDLRST | The model is formatted according to the RST standard, used in Mechanical APDL. |
| AbaqusResults | The model is formatted according to the results standard used in ABAQUS. |
| NastranResults | The model is formatted according to the results standard used in Nastran. |
| SamcefResults | The model is formatted according to the results standard used in Samcef. |
| FEModeler | Internally used to specify a FE Modeler to FE Modeler connection. |
| Unknown | The model type property is not set. |
Enumeration for the MPI library to be used by the Mechanical APDL solver.
| Undefined |
| IBMMPI |
| MSMPI |
| IntelMPI |
Enumeration for the load options for Multi-configuration Results.
| AllConfigsSingleCase |
| AllConfigsSeparateCases |
| LastConfigOnly |
No details are provided for this entry.
| 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 |
No details are provided for this entry.
| kAuto |
| kFull |
| kModified |
| kInitial |
| kUnsymmetrical |
Enumartion of of the renumbering system
| None |
| Offset |
| Automatic |
Enumeration to specify for the samples type for OSFD algorithm.
| SFD_CCD | CCD samples |
| SFD_LINEAR | Linear model samples |
| SFD_PUREQUAD | Pure quadratic model samples |
| SFD_CROSSQUAD | Full quadratic model samples |
| SFD_USER | User-defined samples |
kinematic viscosity calculation type (obsolete)
| Sutherland | calculate viscosity from Sutherland's Law (using coeffs for air) |
| User | user specified kinematic viscosity |
Controls how objects in Mechanical will be named for models assembled from multiple upstream sources
| Off |
| BasedOnCellId |
| BasedOnSystemName |
| BasedOnUserInput |
Controls how objects in Meshing will be named for models assembled from multiple upstream sources
| Off |
| BasedOnCellId |
| BasedOnSystemName |
| BasedOnUserInput |
Enumeration of the inlet/outlet placement options.
| Manual |
| AdjacentBlade |
Enumeration of the available design types for the Optimal Space Filling algorithm.
| SFDTYPE_MDIST | Max-Min Distance |
| SFDTYPE_CL2 | Centered L2 |
| SFDTYPE_MAXENT | Maximum entropy |
No details are provided for this entry.
| ProgramControlled |
| SequentialConvexProgramming |
| OptimalityCriteria |
Allowed orientation of a legend. Default is Vertical
| Vertical |
| Horizontal |
| Default |
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.
The entitry stores the options to specify frequency of writing result files
| None | No intermediate result files |
| EveryStep | Every Coupling Step |
| StepInterval | At defined interval |
Source of the output values, indicating the method used to obtain them.
| UserEdited | The output values are edited by the user. |
| Simulation | The output values are obtained by a real simulation. |
| ResponseSurface | The output values are obtained by evaluating a response surface approximation. |
OutputType for OutputSpecification such as Deformation, Stress or Strain
| None |
| All |
| Basic |
| NodalDofSolution |
| NodalReactionLoads |
| NodalVelocity |
| NodalAcceleration |
| ElementSolution |
| ElementNodalLoads |
| ElementNodalStresses |
| ElementElasticStrains |
| ElementThermalStrains |
| ElementPlasticStrains |
| ElementCreepStrains |
| ElementDiffusionStrains |
| ElementNodalGradients |
| ElementNodalFluxes |
| IntegrationPointLocations |
| StateVariables |
| ElementMiscellaneousData |
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.
Enumeration of the possible nature of a parameter.
| NatureContinuous | Continuous |
| NatureUsability | Obsolete. Instead of defining a usability parameter, define a continuous parameter with the UseManufacturableValues set to True. |
| NatureDiscrete | Discrete |
Enumeration of the possible parameter relationship types.
| PRT_LessThanOrEqualTo | Less Than or Equal To |
| PRT_GreaterThanOrEqualTo | Greater Than or Equal To |
Specifies the possible ways a parameter can be used or set within the data model.
| Input | A parameter whose value will be used by the data model. |
| ExpressionOutput | An output parameter whose value is based on an expression. The parameter cannot be associated directly with the data model. |
| DirectOutput | A parameter whose value will be provided directly by the data model. The parameter expression has to be undefined(null). |
Type of a parameter value.
| ActualValue | The actual value of the parameter. |
| VariationToReference | The variation of the parameter with respect to the current reference point, as a decimal number. |
Partial design point update
| None | Full design point update |
| Geometry | Update geometry only during design point update |
No details are provided for this entry.
| Error |
| Warning |
| Information |
| Verbose |
The available physics types for an analysis.
| Unknown | Indicates physics type was never set |
| None | Indicates physics type was set and then cleared |
| Structural | 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. |
| ElectricConduction | An electric analysis supports Steady-State Electric Conduction. |
| Fluid | No details are provided for this entry. |
| Thermal | You 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. |
| Extrusion | Simulation 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. |
| Electromagnetics | Denotes static and low frequency electromagnetic physics for analysis of electromechanical, etc. systems. |
| All | All physics types. |
Option for defining the plane construction method
| OriginAndOrientation |
| FromPlane |
| FromReferenceFrame |
Options for calculating a point from geometry selection
| Centroid |
| HitPoint |
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.
| Default | Default position. It is a new "child" of position, by system if given, or a new "root" system otherwise. |
| Left | Positioned left to a system. |
| Right | Positioned right to a system. |
| Above | Positioned above a system. |
| Below | Positioned below a system. |
CFD Post reports
| None |
| AxialCompressorReport |
| AxialCompressorRotorReport |
| CentrifugalCompressorReport |
| CentrifugalCompressorBladeRowReport |
| CentrifugalCompressorRotorReport |
| TurbineReport |
| TurbineRotorReport |
| FanNoiseReport |
| FanReport |
| GenericReport |
| HydraulicTurbineReport |
| HydraulicTurbineRotorReport |
| PumpReport |
| PumpImpellerReport |
| StatorReport |
| TurbineStatorReport |
| Custom |
No details are provided for this entry.
| Unchanged |
| ProgramControlled |
| Off |
| OnAfterFirstSubstep |
| OnForAllSubsteps |
No details are provided for this entry.
| BetweenBodies |
| BetweenBodiesOfDifferentParts |
| All |
Preswirl type
| constant | Constant inlet angle |
| free | Free vortex |
| forced | Solid body rotation |
| linear | Linear variation of Vw |
Preswirl type
| constant | Constant inlet angle |
| free | Free vortex |
| forced | Solid body rotation |
This enum is used to set how bolt pretension is defined. It can be defined by axial foce, adjustment, lLock, open or increment.
| kUnknown |
| kAxialForce |
| kAdjustment |
| kLock |
| kOpen |
| kIncrement |
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.
| Unknown |
| OneBoltForAllLocations |
| OneBoltPerLocation |
Box creation method options.
| VirtualPrimitiveBoxByEntity | Box can be created by enclosing single or multiple entities. |
| VirtualPrimitiveBoxByCoordinate | Box can be created by specifying diagonal coordinates. |
Various Processore Unit options available for Microsoft Scheduler
| Core |
| Socket |
| Node |
No details are provided for this entry.
| Unchanged |
| ProgramControlled |
| On |
| Off |
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.
| Faces |
| Edges |
| FacesAndEdges |
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.
Enum providing ramping options.
| None | No ramping. |
| Linear | Linear profile ramping. |
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.
Enumeration of the available real gas materials
| Air |
| CarbonDioxide |
| Hydrogen |
| Methane |
| Nitrogen |
| Oxygen |
| Parahydrogen |
| Propylene |
| R123 |
| R125 |
| R134a |
| R141b |
| R142b |
| R245fa |
| Water |
| Custom |
Options for reference frame definition types
| OriginAndOrientation |
| CoincidentWithParent |
| Transform |
Defines the topology type for a given reference.
| RTT_NoTopology |
| RTT_Vertex |
| RTT_Edge |
| RTT_Face |
| RTT_Body |
| RTT_Part |
| RTT_Assembly |
| RTT_ConfigurationComponent |
| RTT_Invalid |
No details are provided for this entry.
| ProgramControlled |
| Manual |
Used to specify the meshing region behavior. Currently, the only possible value is Wrap.
| Wrap | Simplifies unclean geometry before sewing. |
Options for selecting a which reference frame to define relative to
| Local |
| Parent |
Enumeration of the available Response chart modes.
| Curve2D | 2D response chart where an output parameter is plotted versus an input parameter. |
| Surface3D | 3D response chart where an output parameter is plotted versus two input parameters. |
| Slices2D | 2D response chart where an output parameter is plotted versus two input parameters, on the X axis and the other varying over several curves. |
Enumeration for the Refinement type.
| REFINEMENT_NONE | None |
| REFINEMENT_AUTO | Automated |
| REFINEMENT_MANUAL | Manual |
Options for choosing loop orientation. Required only if construction algorithm is convex hull.
| No | Construct capping surface by using default loop orientation. |
| Yes | Construct capping surface by reversing loop orientation. |
Class containing all rigid transformation options for Model Assembly workflows in Meshing
Class containing all rigid transformation options for Model Assembly workflows in Mechanical
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.
| FixedAll |
| FreeAll |
| FreeAboutX |
| FreeAboutY |
| FreeAboutZ |
Enumeration of the machine rotational direction options.
| RightHanded |
| LeftHanded |
surface roughness type
| Machined | machined surface finish |
| Cast | cast surface finish |
Client used to connect to the nodes in a cluster of LINUX machines.
'Other' is used for a custom connect command.
| RSH |
| SSH |
| Other |
Enumeration for the Sampling type.
| SAMPLE_GEN_LHS | LHS |
| SAMPLE_GEN_WLHS | WLHS |
Enumeration of the available Samples chart modes.
| Candidates | Draw the samples and highlight the optimization candidates. |
| ParetoFront | Draw the samples using colors that represent their Pareto front. |
Enum to define the scale of the axis.
| Linear | Linear scale |
| CommonLog | Common or log base 10 scale |
| NaturalLog | Natural log scale |
A filter that can be applied to the SearchString used by GetAllObjects query.
| Exact |
| Contains |
| StartsWith |
| EndsWith |
No details are provided for this entry.
| midSurface |
| OneSide |
| userDefined |
Allowable values for seed point sampling.
| UniformSample |
| GridSample |
| Mesh |
Allowable values for how mesh is evaluated when sampling seed points.
| EveryNthElement |
| EveryNthVertex |
Sensitivity chart modes.
| BarChart | 2D Bar chart |
| PieChart | 2D Pie chart |
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.
| X |
| Y |
| Z |
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.
| ReferenceFrame |
| GeometrySelection |
Used to define the shape checking algorithm to be used by the mesher. The default value is UseEngineeringIntent.
| UseEngineeringIntent | Determine which algorithm to use based on the Engineering Intent. |
| StandardMechanical | Specifies the standard mechanical shape checking algorithm for structural simulations. |
| AggressiveMechanical | Specifies the aggressive mechanical shape checking algorithm for structural simulations. |
| CFD | Specifies the CFD shape checking algorithm for flow simulations. |
| None | Disable shape checking. |
Shroud LE blade angle option
| Incidence | Shroud LE blade angle calculated from specified incidence |
| User | User defined shroud LE blade angle |
shroud diameter type
| Diameter | user specified shroud inlet diameter |
| Angle | user specified shroud vane inlet angle |
| Optimum | optimised shroud inlet diameter (minimum Mrel) |
Enumeration of the simulation types of a parameter.
| DesignVariable | Design variable |
| UncertaintyVariable | Uncertainty variable |
Enumeration of the Probability Table types.
| ProbabilityTable | Quantile-percentile |
| InverseProbabilityTable | Percentile-quantile |
Used to specify whether size control settings can be changed by the mesher (Soft) or not (Hard).
| Soft |
| Hard |
Used to specify the level of smoothing iterations to be performed. The default value is Medium.
| Low |
| Medium |
| High |
SolutionProgression is a class that specifes convergence, stabilization of solution etc, the typical attributes for monitoring and controlling a solution.
System Coupling Solution Update option
| Foreground | Foreground update |
Indicates the type of restart.
| NoRestartFile | In this mode, no restart file is used to initialize time scheme and fields. |
| SingleResultFile | In this mode, a result file is used to initialize fields. |
| CombineResultRestartFiles | In this mode, a result file is used to initialize fields and a restart file is used to initialize time scheme (starting time + derivates). |
| SingleCsvFile | In this mode, a csv file is used to initialize fields. |
| CombineCsvRestartFiles | In this mode, a csv file is used to initialize fields and a restart file is used to initialize time scheme (starting time + derivates). |
| ManyResultFiles | 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). |
| ManyCsvFiles | 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. |
| InitializationFromCsvFiles | In this mode, csv files are used to initialize fields. The CSV file(s) will be selected in Polydata. |
Spanwise distribution type
| General | Blade exported using general spanwise distribution |
| Radial | Blade exported using radial spanwise distribution |
No details are provided for this entry.
| Off |
| ConstantEnergyDissipation |
| ReducedEnergyDissipation |
| ConstantDampingFactor |
| ReducedDampingFactor |
stacking type
| Radial | Radial stacking |
| Tan | Beta calculated from tangent |
| Sin | Beta calculated from sin |
The current calculation status of the Excel file.
| UpToDate | The output parameters are up to date. |
| OutOfDate | The values of the input parameters are modified and the values of the output parameters are not recalculated yet. |
| ErrorsWhenCalculating | Errors ocurred during the calculation in Excel. |
The method used to determine the size of integration steps in streamline creation.
| Automatic |
| Fixed |
SDT Algorithm Options
| STLSDTAlgorithm_Curvatures | Curvature based SDT algorithm |
| STLSDTAlgorithm_Angles | Angle based SDT algorithm |
Used to force mesher to create elements with straight edges. The default value is No.
| Yes |
| No |
Allowable values for how a streamline is displayed.
| Lines |
| LinesAndSymbols |
| Symbols |
Define Substepping options such as specified range, fixed number or program controlled as available in MAPDL solver.
| Unchanged |
| ProgramControlled |
| SpecifiedRange |
| FixedNumber |
No details are provided for this entry.
| Unknown |
| Fixed |
| Frictionless |
| UserSpecified |
The allowable values for the control of vector length display.
| BasedOnMagnitude |
| Constant |
The symbol shape used for the associated result
| SymbolShape1DArrowHead |
| SymbolShape1DArrow |
| SymbolShape2DArrowHead |
| SymbolShape2DArrow |
| SymbolShape3DArrowHead |
| SymbolShape3DArrow |
| SymbolShape3DCrossHair |
| SymbolShape3DCube |
| SymbolShape3DSphere |
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.
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.
| None | No interpolation is done. |
| Linear | A linear interpolation will be used to compute the return value. |
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.
| Constant | his option will cause the value returned to be the data at the index nearest to the requested index. |
| Fit | 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. |
| Zero | This option will cause the value returned to be zero if the index is outside of the bounds of the table. |
| Error | If the data cannot be determined from the given index (outside of the bounds) then an error will occur. |
Used to specify value to be used for tessellation refinement. The default value is AutomaticallyDetermined.
| AutomaticallyDetermined | Sets tessellation refinement to 10% of the value of Min Size/Proximity Min Size. |
| UserDefined | Sets tessellation refinement to user defined value. |
| Off | Tessellation refinement is not performed. |
Impeller tip diameter option
| Automatic | D2 calculated automatically (from stability factor) |
| HeadCoeff | D2 calculated from head coefficient |
| User | D2 user defined |
All of the possible values for topology.
| Point | A topological point |
| Curve | A topological curve |
| Surface | A topological surface |
| Volume | A topological volume |
The method used to create the Single Value Result
| Undefined |
| Function |
| UserDefinedExpression |
Enumeration of the available Tradeoff chart modes.
| Curve2D | 2D tradeoff chart where a parameter is plotted versus another parameter. |
| Surface3D | 3D tradeoff chart where a parameter is plotted versus two other parameters. |
The allowable types of output in a Transcript monitor.
| SolverOutput |
| PhysicsCouplingDiagnostic |
| SelectFile |
Enum providing options of when to Transfer Data.
| StartOfStep | Transfer data at start of step. |
| StartOfIteration | Transfer data at start of iteration. |
Specifies the information needed to transfer data from a component that is being created in a new system.
Specifies the information needed to transfer data to a component that is being created in a new system.
Enumeration of the available transformation types applicable to an output parameter.
| TransTypeNone | No transformation |
| TransTypeBox | Box-Cox |
| TransTypeYeo | Yeo-Johnson |
This enum is used to set the translational degree of freedom as fixed or free.
| Fixed |
| Free |
Used to specify the surface meshing algorithm to be used by patch conforming mesher. The default value is ProgramControlled.
| ProgramControlled | Mesher determines usage of Delaunay or Advancing Front algorithm. |
| AdvancingFront | Mesher uses Advancing Front algorithm but can switch to Delaunay if problems occur. |
Trim Type to control trimming such as keeping it on, off or Program Controllled.
| ProgramControlled |
| On |
| Off |
An enumeration to describe the type of Triptlet that is used in Coordinate systems, Reference frames, and Vector objects.
| Cartesian |
| Cylindrical |
| Spherical |
Enumeration for the Initial Sampling Type.
| E_Screening | Screening |
| E_OSF | Optimal Space-Filling |
| E_ConstrainedSampling | Constrained Sampling |
Options for defining the vector
| Components |
| MagnitudeAndDirection |
Types of state an updatable entity can have.
| Unknown | entity state can not be defined. |
| OutOfDate | entity is out of date. |
| UpToDate | entity is up to date. |
| Error | last update of the entity gave an error. |
| OutOfDateWithError | entity is out of date and last update of the entity gave an error. |
| UpToDateWithError | entity is up of date and last update of the entity gave an error. |
| RefreshRequired | entity needs a refresh. |
No details are provided for this entry.
| None | Interrupted components with up-to-date data will not be updated. |
| TargetOnly | If the target component is interrupted with up to date data, it will be updated. |
| All | Any involved component which is interrupted with up to date data will be updated. |
Specifies the types of behavior if an error is encountered when updating multiple design points.
| Stop | Terminate the update immediately on the first error. |
| SkipDesignPoint | Don't do any more work on the failing design point, but continue with the next one if any. |
| Continue | Update as much of the project, and as many design points, as possible. |
No details are provided for this entry.
| ProgramControlled |
| EachEquilibriumIteration |
| EachEquilibriumIterationAggressive |
| Never |
| EachEquilibriumIterationNominal |
Used to specify which advanced size function option should be used by the mesher.
| Adaptive |
| ProximityCurvature |
| Curvature |
| Proximity |
| Fixed |
Used to specify the usage of all available processors for parallel part-based meshing. The default value is Yes.
| Yes | Automatically detects and utilizes all available processors for meshing parts of an assembly in parallel. |
| No | Manually specify the limit to the number of processors that can be utilized for parallel part-based meshing. |
Used to specify whether post boundary smoothing will be performed. The default value is Yes.
| Yes |
| No |
This propertry decides whether it should use program controlled value or a manually entered factor or value.
| Unknown |
| kProgramControlled |
| kPhysicalValue |
| kFactor |
| kAutoDetectValue |
Enumeration to specify the conversion of data
| NoConversion |
| AverageSharedNodes |
| AverageNodesToElement |
| AverageNodesToFace |
| DistributeElementToNodesEqually |
| DistributeFaceToNodesEqually |
| AverageCornerToMidsideNodes |
Level of exposure for variables in the CDI
| Standard | Default |
| Expert | Expert |
Styles that can be used to display the variable. Default is Line
| None |
| Line |
| Spline |
| Step |
| Bar |
| Default |
Options for calculating a vector from geometry selection
| Automatic |
| HitPointNormal |
| WeightedAverageNormal |
| HitPointTangent |
| NearestVertexTangent |
| WeightedAverageTangent |
| CenterAxis |
| TwoVertices |
This enum is a collection of methods by which a vector can be defined : Directional Components, Magnitude and direction or normal to a surface.
| Components |
| MagnitudeAndDirection |
| NormalToSurface |
Motion vector types used in mechanics.
| Unknown |
| Displacement |
| Velocity |
| Acceleration |
| Rotation |
| AngularVelocity |
| AngularAcceleration |
viscosity type
| Sutherland | Viscosity calculated using Sutherland's Law (2 coefficient method) |
| Dynamic | User-specified dynamic viscosity |
| Kinematic | User specified kinematic viscosity |
Volute style option
| Elliptic | Elliptic/circular cross sections |
| Rectangular | Rectangular cross sections |