Study
This container holds Study data for an instance of Study.
The Data Manager is a utility object intended for use by the ImportEngineeringData command. It is used to load an applicable manager for the type of data being managed as well the source of the data which the manager will use to bring the data into the project.
Return
The newly created Data Manager DataReference.
Optional Arguments
This example creates a Data Manager in the study.
dataManagerThermal = study1.CreateDataManager(
Sources=[r"C:\ANSYSDev\Program Files\Ansys Inc\v151\Addins\EngineeringData\Samples\Thermal_Materials.xml"],
Provider="ANSYS")
Create AIM objects of the requested Type.
Return
An instance of the Type.Required Arguments
Optional Arguments
This example shows the steps preceding the CreateEntity, and then creates a PhysicsRegion object.
system1 = GetSystem(Name="Study")
physicsDefinitionComponent1 = Study.CreateTask(
Type="Physics Definition",
System=system1)
study1 = system1.GetContainer(ComponentName="Study")
physicsDefinition1 = physicsDefinitionComponent1.GetTaskObject()
physicsRegion1 = study1.CreateEntity(
Type="PhysicsRegion",
Association=physicsDefinition1)
CreateTable is a convenience command which performs the following commands:
| Creates a table and associates with the Parent. See the CreateEntity command, where Type="Table" and AssociatedObject=Parent. |
| Adds columns corresponding to the Columns parameter. See the AddTableColumn command. |
Return The DataReference of the newly created table.
Required Arguments
This example illustrates creating a table and setting data in the table.
# drContainer is the DataContainerReference of an object that has been previously created (e.g. study1)
# drParent is the DataReference of an object that has been previously created (e.g. material1)
table1 = drContainer.CreateTable(drParent, Columns=[("Temperature","Temperature"),("Displacement","Length")])
table1.AddRow(Data=["100 [C]","1.0 [m]"])
table1.AddRow(Data=["200 [C]",".02 [m]"])
table1.AddRow(Data=["300 [C]",".06 [m]"])
table1.GetData()
Obtains a AEMLaunchControls instance by name from the supplied container.
Return
The AEMLaunchControls instance.Required Arguments
Obtains a AFDPhysicsOptions instance by name from the supplied container.
Return
The AFDPhysicsOptions instance.Required Arguments
Obtains a BodyTemperature instance by name from the supplied container.
Return
The BodyTemperature instance.Required Arguments
Obtains a BoltPretension instance by name from the supplied container.
Return
The BoltPretension instance.Required Arguments
Obtains a Boundary instance by name from the supplied container.
Return
The Boundary instance.Required Arguments
Obtains a BoundaryCondition instance by name from the supplied container.
Return
The BoundaryCondition instance.Required Arguments
Obtains a CappingSurface instance by name from the supplied container.
Return
The CappingSurface instance.Required Arguments
Obtains a ConditionGroup instance by name from the supplied container.
Return
The ConditionGroup instance.Required Arguments
Obtains a Configuration instance by name from the supplied container.
Return
The Configuration instance.Required Arguments
Obtains a Connection instance by name from the supplied container.
Return
The Connection instance.Required Arguments
Obtains a ConnectionBehavior instance by name from the supplied container.
Return
The ConnectionBehavior instance.Required Arguments
Obtains a Constraint instance by name from the supplied container.
Return
The Constraint instance.Required Arguments
Obtains a Contact instance by name from the supplied container.
Return
The Contact instance.Required Arguments
Obtains a ContactBehavior instance by name from the supplied container.
Return
The ContactBehavior instance.Required Arguments
Obtains a ContactDetection instance by name from the supplied container.
Return
The ContactDetection instance.Required Arguments
Obtains a ContourResult instance by name from the supplied container.
Return
The ContourResult instance.Required Arguments
Obtains a Convection instance by name from the supplied container.
Return
The Convection instance.Required Arguments
Obtains a CoreLossComputation instance by name from the supplied container.
Return
The CoreLossComputation instance.Required Arguments
Obtains a Current instance by name from the supplied container.
Return
The Current instance.Required Arguments
Obtains a Displacement instance by name from the supplied container.
Return
The Displacement instance.Required Arguments
Obtains a EddyEffectComputation instance by name from the supplied container.
Return
The EddyEffectComputation instance.Required Arguments
Obtains a Equipotential instance by name from the supplied container.
Return
The Equipotential instance.Required Arguments
Obtains a FatigueSettings instance by name from the supplied container.
Return
The FatigueSettings instance.Required Arguments
Obtains a FluidBoundary instance by name from the supplied container.
Return
The FluidBoundary instance.Required Arguments
Obtains a Force instance by name from the supplied container.
Return
The Force instance.Required Arguments
Obtains a ForceComputation instance by name from the supplied container.
Return
The ForceComputation instance.Required Arguments
Obtains a GeneralPhysicsOptions instance by name from the supplied container.
Return
The GeneralPhysicsOptions instance.Required Arguments
Obtains a GeometryImportSource instance by name from the supplied container.
Return
The GeometryImportSource instance.Required Arguments
Obtains a GravityDefinition instance by name from the supplied container.
Return
The GravityDefinition instance.Required Arguments
Obtains a GroundLocation instance by name from the supplied container.
Return
The GroundLocation instance.Required Arguments
Obtains a HeatFlow instance by name from the supplied container.
Return
The HeatFlow instance.Required Arguments
Obtains a HeatFlux instance by name from the supplied container.
Return
The HeatFlux instance.Required Arguments
Obtains a HeatGeneration instance by name from the supplied container.
Return
The HeatGeneration instance.Required Arguments
Obtains a HeatSource instance by name from the supplied container.
Return
The HeatSource instance.Required Arguments
Obtains a HeatSrc instance by name from the supplied container.
Return
The HeatSrc instance.Required Arguments
Obtains a Import instance by name from the supplied container.
Return
The Import instance.Required Arguments
Obtains a InertiaLoad instance by name from the supplied container.
Return
The InertiaLoad instance.Required Arguments
Obtains a InitialCondition instance by name from the supplied container.
Return
The InitialCondition instance.Required Arguments
Obtains a InitialConditions instance by name from the supplied container.
Return
The InitialConditions instance.Required Arguments
Obtains a InitialTemperature instance by name from the supplied container.
Return
The InitialTemperature instance.Required Arguments
Obtains a Insulating instance by name from the supplied container.
Return
The Insulating instance.Required Arguments
Obtains a InterfaceGenerator instance by name from the supplied container.
Return
The InterfaceGenerator instance.Required Arguments
Obtains a IsoSurface instance by name from the supplied container.
Return
The IsoSurface instance.Required Arguments
Obtains a Joint instance by name from the supplied container.
Return
The Joint instance.Required Arguments
Obtains a JointBehavior instance by name from the supplied container.
Return
The JointBehavior instance.Required Arguments
Obtains a LaunchSettings instance by name from the supplied container.
Return
The LaunchSettings instance.Required Arguments
Obtains a Load instance by name from the supplied container.
Return
The Load instance.Required Arguments
Obtains a Material instance by name from the supplied container.
Return
The Material instance.Required Arguments
Obtains a MaterialAssignment instance by name from the supplied container.
Return
The MaterialAssignment instance.Required Arguments
Obtains a MaterialAtState instance by name from the supplied container.
Return
The MaterialAtState instance.Required Arguments
Obtains a MechanicalPhysicsOptions instance by name from the supplied container.
Return
The MechanicalPhysicsOptions instance.Required Arguments
Obtains a Mesh instance by name from the supplied container.
Return
The Mesh instance.Required Arguments
Obtains a MeshControl instance by name from the supplied container.
Return
The MeshControl instance.Required Arguments
Obtains a MeshControlBodySizing instance by name from the supplied container.
Return
The MeshControlBodySizing instance.Required Arguments
Obtains a MeshControlEdgeSizing instance by name from the supplied container.
Return
The MeshControlEdgeSizing instance.Required Arguments
Obtains a MeshControlElementShape instance by name from the supplied container.
Return
The MeshControlElementShape instance.Required Arguments
Obtains a MeshControlFaceSizing instance by name from the supplied container.
Return
The MeshControlFaceSizing instance.Required Arguments
Obtains a MeshControlLocalBoundaryLayer instance by name from the supplied container.
Return
The MeshControlLocalBoundaryLayer instance.Required Arguments
Obtains a MeshDiagnostics instance by name from the supplied container.
Return
The MeshDiagnostics instance.Required Arguments
Obtains a Meshing instance by name from the supplied container.
Return
The Meshing instance.Required Arguments
Obtains a MeshModeling instance by name from the supplied container.
Return
The MeshModeling instance.Required Arguments
Obtains a Modeling instance by name from the supplied container.
Return
The Modeling instance.Required Arguments
Obtains a ModelingImportSource instance by name from the supplied container.
Return
The ModelingImportSource instance.Required Arguments
Obtains a Moment instance by name from the supplied container.
Return
The Moment instance.Required Arguments
Obtains a MomentumSource instance by name from the supplied container.
Return
The MomentumSource instance.Required Arguments
Obtains a MomentumSrc instance by name from the supplied container.
Return
The MomentumSrc instance.Required Arguments
Obtains a MonitorChart instance by name from the supplied container.
Return
The MonitorChart instance.Required Arguments
Obtains a MoveRotateControl instance by name from the supplied container.
Return
The MoveRotateControl instance.Required Arguments
Obtains a NumericalControls instance by name from the supplied container.
Return
The NumericalControls instance.Required Arguments
Obtains a OptimizationConstraint instance by name from the supplied container.
Return
The OptimizationConstraint instance.Required Arguments
Obtains a OutputControl instance by name from the supplied container.
Return
The OutputControl instance.Required Arguments
Obtains a OutputControls instance by name from the supplied container.
Return
The OutputControls instance.Required Arguments
Obtains a ParticleInjection instance by name from the supplied container.
Return
The ParticleInjection instance.Required Arguments
Obtains a PhysicsCoupling instance by name from the supplied container.
Return
The PhysicsCoupling instance.Required Arguments
Obtains a PhysicsDefinition instance by name from the supplied container.
Return
The PhysicsDefinition instance.Required Arguments
Obtains a PhysicsOptions instance by name from the supplied container.
Return
The PhysicsOptions instance.Required Arguments
Obtains a PhysicsRegion instance by name from the supplied container.
Return
The PhysicsRegion instance.Required Arguments
Obtains a Plane instance by name from the supplied container.
Return
The Plane instance.Required Arguments
Obtains a Point instance by name from the supplied container.
Return
The Point instance.Required Arguments
Obtains a PolyflowCondition instance by name from the supplied container.
Return
The PolyflowCondition instance.Required Arguments
Obtains a PolyflowConvection instance by name from the supplied container.
Return
The PolyflowConvection instance.Required Arguments
Obtains a PolyflowDieDeformation instance by name from the supplied container.
Return
The PolyflowDieDeformation instance.Required Arguments
Obtains a PolyflowFluidSolidInterfaceBehavior instance by name from the supplied container.
Return
The PolyflowFluidSolidInterfaceBehavior instance.Required Arguments
Obtains a PolyflowFreejetExit instance by name from the supplied container.
Return
The PolyflowFreejetExit instance.Required Arguments
Obtains a PolyflowFreeSurface instance by name from the supplied container.
Return
The PolyflowFreeSurface instance.Required Arguments
Obtains a PolyflowHeatFlux instance by name from the supplied container.
Return
The PolyflowHeatFlux instance.Required Arguments
Obtains a PolyflowInflow instance by name from the supplied container.
Return
The PolyflowInflow instance.Required Arguments
Obtains a PolyflowInitialTemperature instance by name from the supplied container.
Return
The PolyflowInitialTemperature instance.Required Arguments
Obtains a PolyflowInsulated instance by name from the supplied container.
Return
The PolyflowInsulated instance.Required Arguments
Obtains a PolyflowLaunchControls instance by name from the supplied container.
Return
The PolyflowLaunchControls instance.Required Arguments
Obtains a PolyflowNumericalControls instance by name from the supplied container.
Return
The PolyflowNumericalControls instance.Required Arguments
Obtains a PolyflowOutflow instance by name from the supplied container.
Return
The PolyflowOutflow instance.Required Arguments
Obtains a PolyflowOutputControls instance by name from the supplied container.
Return
The PolyflowOutputControls instance.Required Arguments
Obtains a PolyflowPhysicsOptions instance by name from the supplied container.
Return
The PolyflowPhysicsOptions instance.Required Arguments
Obtains a PolyflowRegionInterface instance by name from the supplied container.
Return
The PolyflowRegionInterface instance.Required Arguments
Obtains a PolyflowRemeshing instance by name from the supplied container.
Return
The PolyflowRemeshing instance.Required Arguments
Obtains a PolyflowSolutionControls instance by name from the supplied container.
Return
The PolyflowSolutionControls instance.Required Arguments
Obtains a PolyflowSymmetry instance by name from the supplied container.
Return
The PolyflowSymmetry instance.Required Arguments
Obtains a PolyflowTemperatureImposed instance by name from the supplied container.
Return
The PolyflowTemperatureImposed instance.Required Arguments
Obtains a PolyflowWall instance by name from the supplied container.
Return
The PolyflowWall instance.Required Arguments
Obtains a PolyflowWallBase instance by name from the supplied container.
Return
The PolyflowWallBase instance.Required Arguments
Obtains a PorositySrc instance by name from the supplied container.
Return
The PorositySrc instance.Required Arguments
Obtains a PorousMedium instance by name from the supplied container.
Return
The PorousMedium instance.Required Arguments
Obtains a Pressure instance by name from the supplied container.
Return
The Pressure instance.Required Arguments
Obtains a Radiation instance by name from the supplied container.
Return
The Radiation instance.Required Arguments
Obtains a ReferenceFrame instance by name from the supplied container.
Return
The ReferenceFrame instance.Required Arguments
Obtains a RegionInterface instance by name from the supplied container.
Return
The RegionInterface instance.Required Arguments
Obtains a RegionInterfaceGenerator instance by name from the supplied container.
Return
The RegionInterfaceGenerator instance.Required Arguments
Obtains a ResultObject instance by name from the supplied container.
Return
The ResultObject instance.Required Arguments
Obtains a Results instance by name from the supplied container.
Return
The Results instance.Required Arguments
Obtains a ScalarConstraint instance by name from the supplied container.
Return
The ScalarConstraint instance.Required Arguments
Obtains a ScalarInitialCondition instance by name from the supplied container.
Return
The ScalarInitialCondition instance.Required Arguments
Obtains a ScalarLoad instance by name from the supplied container.
Return
The ScalarLoad instance.Required Arguments
Obtains a SectionLayer instance by name from the supplied container.
Return
The SectionLayer instance.Required Arguments
Obtains a SectionOffset instance by name from the supplied container.
Return
The SectionOffset instance.Required Arguments
Obtains a SelectionSet instance by name from the supplied container.
Return
The SelectionSet instance.Required Arguments
Obtains a Shape instance by name from the supplied container.
Return
The Shape instance.Required Arguments
Obtains a ShapeTaskStatistics instance by name from the supplied container.
Return
The ShapeTaskStatistics instance.Required Arguments
Obtains a ShellThickness instance by name from the supplied container.
Return
The ShellThickness instance.Required Arguments
Obtains a Simulation instance by name from the supplied container.
Return
The Simulation instance.Required Arguments
Obtains a SingleValueResult instance by name from the supplied container.
Return
The SingleValueResult instance.Required Arguments
Obtains a SkinDepthResolution instance by name from the supplied container.
Return
The SkinDepthResolution instance.Required Arguments
Obtains a SolutionControls instance by name from the supplied container.
Return
The SolutionControls instance.Required Arguments
Obtains a SolutionProgression instance by name from the supplied container.
Return
The SolutionProgression instance.Required Arguments
Obtains a SolutionStep instance by name from the supplied container.
Return
The SolutionStep instance.Required Arguments
Obtains a SolvePhysics instance by name from the supplied container.
Return
The SolvePhysics instance.Required Arguments
Obtains a SolverSettings instance by name from the supplied container.
Return
The SolverSettings instance.Required Arguments
Obtains a Statistics instance by name from the supplied container.
Return
The Statistics instance.Required Arguments
Obtains a StatusGroup instance by name from the supplied container.
Return
The StatusGroup instance.Required Arguments
Obtains a StreamLine instance by name from the supplied container.
Return
The StreamLine instance.Required Arguments
Obtains a Support instance by name from the supplied container.
Return
The Support instance.Required Arguments
Obtains a SuppressControl instance by name from the supplied container.
Return
The SuppressControl instance.Required Arguments
Obtains a TableResult instance by name from the supplied container.
Return
The TableResult instance.Required Arguments
Obtains a TaskGroup instance by name from the supplied container.
Return
The TaskGroup instance.
Required Arguments
Obtains a TemperatureCondition instance by name from the supplied container.
Return
The TemperatureCondition instance.Required Arguments
Obtains a TemperatureConstraint instance by name from the supplied container.
Return
The TemperatureConstraint instance.Required Arguments
Obtains a Terminal instance by name from the supplied container.
Return
The Terminal instance.Required Arguments
Obtains a TorqueComputation instance by name from the supplied container.
Return
The TorqueComputation instance.Required Arguments
Obtains a Transcript instance by name from the supplied container.
Return
The Transcript instance.Required Arguments
Obtains a UserCommands instance by name from the supplied container.
Return
The UserCommands instance.Required Arguments
Query to return a list of valid material model tuples, where each tuple has the strings for use on the CreateMaterialContent command. The tuple is in the following form (Model, Definition, Behavior)
Optional Arguments
This example requests all the valid material properties including the names.
validContent = Study.GetValidMaterialContent(IncludeName=true)
Obtains a VectorConstraint instance by name from the supplied container.
Return
The VectorConstraint instance.Required Arguments
Obtains a VectorInitialCondition instance by name from the supplied container.
Return
The VectorInitialCondition instance.Required Arguments
Obtains a VectorLoad instance by name from the supplied container.
Return
The VectorLoad instance.Required Arguments
Obtains a VectorResult instance by name from the supplied container.
Return
The VectorResult instance.Required Arguments
Obtains a VirtualPrimitiveBox instance by name from the supplied container.
Return
The VirtualPrimitiveBox instance.Required Arguments
Obtains a Voltage instance by name from the supplied container.
Return
The Voltage instance.Required Arguments
Obtains a VolumeExtractionRegion instance by name from the supplied container.
Return
The VolumeExtractionRegion instance.Required Arguments
Obtains a VolumeSimplificationRegion instance by name from the supplied container.
Return
The VolumeSimplificationRegion instance.Required Arguments
Obtains a Winding instance by name from the supplied container.
Return
The Winding instance.Required Arguments
Obtains a WizardStep instance by name from the supplied container.
Return
The WizardStep instance.Required Arguments
Obtains a Wrap instance by name from the supplied container.
Return
The Wrap instance.Required Arguments
Create AIM objects of the requested Type.
Return
An instance of the Type.Required Arguments
Optional Arguments
This example shows the steps preceding the CreateEntity, and then creates a PhysicsRegion object.
system1 = GetSystem(Name="Study")
physicsDefinitionComponent1 = Study.CreateTask(
Type="Physics Definition",
System=system1)
study1 = system1.GetContainer(ComponentName="Study")
physicsDefinition1 = physicsDefinitionComponent1.GetTaskObject()
physicsRegion1 = study1.CreateEntity(
Type="PhysicsRegion",
Association=physicsDefinition1)
Create AIM objects of the requested Type.
Return
An instance of the Type.Required Arguments
Optional Arguments
This example shows the steps preceding the CreateEntity, and then creates a PhysicsRegion object.
system1 = GetSystem(Name="Study")
physicsDefinitionComponent1 = Study.CreateTask(
Type="Physics Definition",
System=system1)
study1 = system1.GetContainer(ComponentName="Study")
physicsDefinition1 = physicsDefinitionComponent1.GetTaskObject()
physicsRegion1 = study1.CreateEntity(
Type="PhysicsRegion",
Association=physicsDefinition1)
Create AIM objects of the requested Type.
Return
An instance of the Type.Required Arguments
Optional Arguments
This example shows the steps preceding the CreateEntity, and then creates a PhysicsRegion object.
system1 = GetSystem(Name="Study")
physicsDefinitionComponent1 = Study.CreateTask(
Type="Physics Definition",
System=system1)
study1 = system1.GetContainer(ComponentName="Study")
physicsDefinition1 = physicsDefinitionComponent1.GetTaskObject()
physicsRegion1 = study1.CreateEntity(
Type="PhysicsRegion",
Association=physicsDefinition1)
Obtains a AEMLaunchControls instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The AEMLaunchControls instance.Required Arguments
Obtains a AFDPhysicsOptions instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The AFDPhysicsOptions instance.Required Arguments
Obtains a BodyTemperature instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The BodyTemperature instance.Required Arguments
Obtains a BoltPretension instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The BoltPretension instance.Required Arguments
Obtains a Boundary instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Boundary instance.Required Arguments
Obtains a BoundaryCondition instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The BoundaryCondition instance.Required Arguments
Obtains a CappingSurface instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The CappingSurface instance.Required Arguments
Obtains a ConditionGroup instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The ConditionGroup instance.Required Arguments
Obtains a Configuration instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Configuration instance.Required Arguments
Obtains a Connection instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Connection instance.Required Arguments
Obtains a ConnectionBehavior instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The ConnectionBehavior instance.Required Arguments
Obtains a Constraint instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Constraint instance.Required Arguments
Obtains a Contact instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Contact instance.Required Arguments
Obtains a ContactBehavior instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The ContactBehavior instance.Required Arguments
Obtains a ContactDetection instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The ContactDetection instance.Required Arguments
Obtains a ContourResult instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The ContourResult instance.Required Arguments
Obtains a Convection instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Convection instance.Required Arguments
Obtains a CoreLossComputation instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The CoreLossComputation instance.Required Arguments
Obtains a Current instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Current instance.Required Arguments
Obtains a Displacement instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Displacement instance.Required Arguments
Obtains a EddyEffectComputation instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The EddyEffectComputation instance.Required Arguments
Obtains a Equipotential instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Equipotential instance.Required Arguments
Obtains a FatigueSettings instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The FatigueSettings instance.Required Arguments
Obtains a FluidBoundary instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The FluidBoundary instance.Required Arguments
Obtains a Force instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Force instance.Required Arguments
Obtains a ForceComputation instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The ForceComputation instance.Required Arguments
Obtains a GeneralPhysicsOptions instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The GeneralPhysicsOptions instance.Required Arguments
Obtains a GeometryImportSource instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The GeometryImportSource instance.Required Arguments
Obtains a GravityDefinition instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The GravityDefinition instance.Required Arguments
Obtains a GroundLocation instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The GroundLocation instance.Required Arguments
Obtains a HeatFlow instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The HeatFlow instance.Required Arguments
Obtains a HeatFlux instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The HeatFlux instance.Required Arguments
Obtains a HeatGeneration instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The HeatGeneration instance.Required Arguments
Obtains a HeatSource instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The HeatSource instance.Required Arguments
Obtains a HeatSrc instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The HeatSrc instance.Required Arguments
Obtains a Import instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Import instance.Required Arguments
Obtains a InertiaLoad instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The InertiaLoad instance.Required Arguments
Obtains a InitialCondition instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The InitialCondition instance.Required Arguments
Obtains a InitialConditions instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The InitialConditions instance.Required Arguments
Obtains a InitialTemperature instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The InitialTemperature instance.Required Arguments
Obtains a Insulating instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Insulating instance.Required Arguments
Obtains a InterfaceGenerator instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The InterfaceGenerator instance.Required Arguments
Obtains a IsoSurface instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The IsoSurface instance.Required Arguments
Obtains a Joint instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Joint instance.Required Arguments
Obtains a JointBehavior instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The JointBehavior instance.Required Arguments
Obtains a LaunchSettings instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The LaunchSettings instance.Required Arguments
Obtains a Load instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Load instance.Required Arguments
Obtains a Material instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Material instance.Required Arguments
Obtains a MaterialAssignment instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The MaterialAssignment instance.Required Arguments
Obtains a MaterialAtState instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The MaterialAtState instance.Required Arguments
Obtains a MechanicalPhysicsOptions instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The MechanicalPhysicsOptions instance.Required Arguments
Obtains a Mesh instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Mesh instance.Required Arguments
Obtains a MeshControl instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The MeshControl instance.Required Arguments
Obtains a MeshControlBodySizing instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The MeshControlBodySizing instance.Required Arguments
Obtains a MeshControlEdgeSizing instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The MeshControlEdgeSizing instance.Required Arguments
Obtains a MeshControlElementShape instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The MeshControlElementShape instance.Required Arguments
Obtains a MeshControlFaceSizing instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The MeshControlFaceSizing instance.Required Arguments
Obtains a MeshControlLocalBoundaryLayer instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The MeshControlLocalBoundaryLayer instance.Required Arguments
Obtains a MeshDiagnostics instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The MeshDiagnostics instance.Required Arguments
Obtains a Meshing instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Meshing instance.Required Arguments
Obtains a MeshModeling instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The MeshModeling instance.Required Arguments
Obtains a Modeling instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Modeling instance.Required Arguments
Obtains a ModelingImportSource instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The ModelingImportSource instance.Required Arguments
Obtains a Moment instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Moment instance.Required Arguments
Obtains a MomentumSource instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The MomentumSource instance.Required Arguments
Obtains a MomentumSrc instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The MomentumSrc instance.Required Arguments
Obtains a MonitorChart instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The MonitorChart instance.Required Arguments
Obtains a MoveRotateControl instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The MoveRotateControl instance.Required Arguments
Obtains a NumericalControls instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The NumericalControls instance.Required Arguments
Obtains a OptimizationConstraint instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The OptimizationConstraint instance.Required Arguments
Obtains a OutputControl instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The OutputControl instance.Required Arguments
Obtains a OutputControls instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The OutputControls instance.Required Arguments
Obtains a ParticleInjection instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The ParticleInjection instance.Required Arguments
Obtains a PhysicsCoupling instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PhysicsCoupling instance.Required Arguments
Obtains a PhysicsDefinition instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PhysicsDefinition instance.Required Arguments
Obtains a PhysicsOptions instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PhysicsOptions instance.Required Arguments
Obtains a PhysicsRegion instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PhysicsRegion instance.Required Arguments
Obtains a Plane instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Plane instance.Required Arguments
Obtains a Point instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Point instance.Required Arguments
Obtains a PolyflowCondition instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PolyflowCondition instance.Required Arguments
Obtains a PolyflowConvection instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PolyflowConvection instance.Required Arguments
Obtains a PolyflowDieDeformation instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PolyflowDieDeformation instance.Required Arguments
Obtains a PolyflowFluidSolidInterfaceBehavior instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PolyflowFluidSolidInterfaceBehavior instance.Required Arguments
Obtains a PolyflowFreejetExit instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PolyflowFreejetExit instance.Required Arguments
Obtains a PolyflowFreeSurface instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PolyflowFreeSurface instance.Required Arguments
Obtains a PolyflowHeatFlux instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PolyflowHeatFlux instance.Required Arguments
Obtains a PolyflowInflow instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PolyflowInflow instance.Required Arguments
Obtains a PolyflowInitialTemperature instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PolyflowInitialTemperature instance.Required Arguments
Obtains a PolyflowInsulated instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PolyflowInsulated instance.Required Arguments
Obtains a PolyflowLaunchControls instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PolyflowLaunchControls instance.Required Arguments
Obtains a PolyflowNumericalControls instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PolyflowNumericalControls instance.Required Arguments
Obtains a PolyflowOutflow instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PolyflowOutflow instance.Required Arguments
Obtains a PolyflowOutputControls instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PolyflowOutputControls instance.Required Arguments
Obtains a PolyflowPhysicsOptions instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PolyflowPhysicsOptions instance.Required Arguments
Obtains a PolyflowRegionInterface instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PolyflowRegionInterface instance.Required Arguments
Obtains a PolyflowRemeshing instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PolyflowRemeshing instance.Required Arguments
Obtains a PolyflowSolutionControls instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PolyflowSolutionControls instance.Required Arguments
Obtains a PolyflowSymmetry instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PolyflowSymmetry instance.Required Arguments
Obtains a PolyflowTemperatureImposed instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PolyflowTemperatureImposed instance.Required Arguments
Obtains a PolyflowWall instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PolyflowWall instance.Required Arguments
Obtains a PolyflowWallBase instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PolyflowWallBase instance.Required Arguments
Obtains a PorositySrc instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PorositySrc instance.Required Arguments
Obtains a PorousMedium instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The PorousMedium instance.Required Arguments
Obtains a Pressure instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Pressure instance.Required Arguments
Obtains a Radiation instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Radiation instance.Required Arguments
Obtains a ReferenceFrame instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The ReferenceFrame instance.Required Arguments
Obtains a RegionInterface instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The RegionInterface instance.Required Arguments
Obtains a RegionInterfaceGenerator instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The RegionInterfaceGenerator instance.Required Arguments
Obtains a ResultObject instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The ResultObject instance.Required Arguments
Obtains a Results instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Results instance.Required Arguments
Obtains a ScalarConstraint instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The ScalarConstraint instance.Required Arguments
Obtains a ScalarInitialCondition instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The ScalarInitialCondition instance.Required Arguments
Obtains a ScalarLoad instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The ScalarLoad instance.Required Arguments
Obtains a SectionLayer instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The SectionLayer instance.Required Arguments
Obtains a SectionOffset instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The SectionOffset instance.Required Arguments
Obtains a SelectionSet instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The SelectionSet instance.Required Arguments
Obtains a Shape instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Shape instance.Required Arguments
Obtains a ShapeTaskStatistics instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The ShapeTaskStatistics instance.Required Arguments
Obtains a ShellThickness instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The ShellThickness instance.Required Arguments
Obtains a Simulation instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Simulation instance.Required Arguments
Obtains a SingleValueResult instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The SingleValueResult instance.Required Arguments
Obtains a SkinDepthResolution instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The SkinDepthResolution instance.Required Arguments
Obtains a SolutionControls instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The SolutionControls instance.Required Arguments
Obtains a SolutionProgression instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The SolutionProgression instance.Required Arguments
Obtains a SolutionStep instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The SolutionStep instance.Required Arguments
Obtains a SolvePhysics instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The SolvePhysics instance.Required Arguments
Obtains a SolverSettings instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The SolverSettings instance.Required Arguments
Obtains a Statistics instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Statistics instance.Required Arguments
Obtains a StatusGroup instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The StatusGroup instance.Required Arguments
Obtains a StreamLine instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The StreamLine instance.Required Arguments
Obtains a Support instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Support instance.Required Arguments
Obtains a SuppressControl instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The SuppressControl instance.Required Arguments
Obtains a TableResult instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The TableResult instance.Required Arguments
Obtains a TemperatureCondition instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The TemperatureCondition instance.Required Arguments
Obtains a TemperatureConstraint instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The TemperatureConstraint instance.Required Arguments
Obtains a Terminal instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Terminal instance.Required Arguments
Obtains a TorqueComputation instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The TorqueComputation instance.Required Arguments
Obtains a Transcript instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Transcript instance.Required Arguments
Obtains a UserCommands instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The UserCommands instance.Required Arguments
Obtains a VectorConstraint instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The VectorConstraint instance.Required Arguments
Obtains a VectorInitialCondition instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The VectorInitialCondition instance.Required Arguments
Obtains a VectorLoad instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The VectorLoad instance.Required Arguments
Obtains a VectorResult instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The VectorResult instance.Required Arguments
Obtains a VirtualPrimitiveBox instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The VirtualPrimitiveBox instance.Required Arguments
Obtains a Voltage instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Voltage instance.Required Arguments
Obtains a VolumeExtractionRegion instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The VolumeExtractionRegion instance.Required Arguments
Obtains a VolumeSimplificationRegion instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The VolumeSimplificationRegion instance.Required Arguments
Obtains a Winding instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Winding instance.Required Arguments
Obtains a WizardStep instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The WizardStep instance.Required Arguments
Obtains a Wrap instance by name from the supplied container, falling back to an alternate name if the first is not found.
Return
The Wrap instance.Required Arguments
The Alternating Stress material model.
The Magnitude is an expresion which evaluates to a Quantity with the correct units.
The Appearance Properties material model.
Material Density - used to define how much contribution diffuse color has on the output.
Defines an axis from a vector or point.
The B-H Curve model.
Can be applied to Magnetic analyses
The Magnitude allows for tabular input through the expresson language.
Implementation for IProvideChartData
Calculated value monitor objects are used to present graphical charts tracking aspects of the solution results, such as max(displacements.x)@Body1.
A CappingSurface creates an analytic surface based on a set of bounding edges or faces.
Specifies the method used to create the Capping Surface.
Provides additional information to a Capping Surface when it is constructed based on a set of edges.
The algorithm used to construct the capping surface.
Sets the orientation of the edge loop, if the algorithm is a Convex Hull.
Provides additional information to a Capping Surface when it is constructed based on the internal loops of a set of faces.
The algorithm used to construct the capping surface.
Sets the orientation of the edge loop, if the algorithm is a Convex Hull.
Provides additional information to a Capping Surface when it is constructed based on a set of edge loops.
The algorithm used to construct the capping surface.
Sets the orientation of the edge loop, if the algorithm is a Convex Hull.
Provides additional information to a Capping Surface when it is constructed based on the internal loops of a set of faces.
The algorithm used to construct the capping surface.
Sets the orientation of the edge loop, if the algorithm is a Convex Hull.
Triplet represented in cartesian coordinates
Collection of UserObjects (Loads, Constraints, Contacts) and their selected StatusGroup for each step Key is SolutionStep DataReference, Value is UserObject DataReference
List of DataReferences for UserObjects (Loads, Constraints, Contacts, etc.)
Dictionary of SolutionStep DataReference and StatusGroup DataReferences
The entity that represents a Configuration Task. Holds the list of configure controls objects.
Configure controls:
| Suppress control | Allows the suppression selected part components. |
| Move/rotate control | Allows the transformation selected part components. |
No Properties.
Inserts a primitive axis-alinged box that can be used to define an enclosure.
Required Arguments
Displays the contour of a selected variable on a specified location.
Set to true if averages are to be calculated as part of the Result evaluation.
Whether or not to evaluate all time points in the evaluation
This allows for the required settings (such as Fatigue Settings) to be added to the contour result.
The Simulation Step object reference for a multi-step analysis.
Triplet represented in cylindrical coordinates
Angle from the +X axis in the XY plane (a.k.a. theta or phi) phi = arctan(y / x) 0 <= theta < 2PI
Distance from the origin in the XY plane (positive) r = sqrt(x^2 + y^2)
The DataManager is used to access readers and writers. This allows engineering data to be read and written to and from files.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
Deletes the specified DataManager.
This example creates and then deletes a DataManager
dataManagerThermal = study1.CreateDataManager(
Sources=[r"C:\ANSYSDev\Program Files\Ansys Inc\v151\Addins\EngineeringData\Samples\Thermal_Materials.xml"],
Provider="ANSYS")
Study.DeleteDataManager(dataManagerThermal)
Finds items in the Data Manager, where the item's Description contains the supplied text.
Required Arguments
This example create a data manager and searches for a match in the description.
dataManagerThermal = study1.CreateDataManager(
Sources=[r"C:\ANSYSDev\Program Files\Ansys Inc\v151\Addins\EngineeringData\Samples\Thermal_Materials.xml"],
Provider="ANSYS")
matList = Study.FindByDescription(dataManagerThermal, "Thermal Properties")
Finds materials in the Data Manager, where the material contains a matching model for the supplied arguments.
Required Arguments
Optional Arguments
This example creates a data manager and searches for materials that have an Isotropic Elasticity model.
dataManagerGeneral = study1.CreateDataManager(
Sources=[r"C:\ANSYSDev\Program Files\Ansys Inc\v151\Addins\EngineeringData\Samples\General_Materials.xml"],
Provider="ANSYS")
matList = Study.FindByModel(dataManagerGeneral, "Elasticity", Behavior="Isotropic")
Finds items in the Data Manager, where the item's name contains the supplied string.
Required Arguments
This example creates a data manager and searches for any material having Alloy in the name.
dataManagerGeneral = study1.CreateDataManager(
Sources=[r"C:\ANSYSDev\Program Files\Ansys Inc\v151\Addins\EngineeringData\Samples\General_Materials.xml"],
Provider="ANSYS")
matList = Study.FindByName(dataManagerGeneral, "Alloy")
Finds items in the Data Manager, where the item has the property and a value within the specified range.
Required Arguments
This example creates a data manager and searches for any material having density in the range of 7000 [kg m^-3] to 9000 [kg m^-3].
dataManagerGeneral = study1.CreateDataManager(
Sources=[r"C:\ANSYSDev\Program Files\Ansys Inc\v151\Addins\EngineeringData\Samples\General_Materials.xml"],
Provider="ANSYS")
matList = Study.FindByRange(dataManagerGeneral, "Density", "7000 [kg m^-3]" ,"9000 [kg m^-3]")
Gets the names of all the items in the Data Manager.
Optional Arguments
This example creates a data manager and returns the items it is managing.
dataManagerGeneral = study1.CreateDataManager(
Sources=[r"C:\ANSYSDev\Program Files\Ansys Inc\v151\Addins\EngineeringData\Samples\General_Materials.xml"],
Provider="ANSYS")
contents = Study.GetValidContentNames(dataManagerGeneral)
The Density model provided via a specified expression.
The Magnitude is an expresion which evaluates to a Quantity with the correct units.
Dimension parameter imported from CAD.
Defines an imported geometry source through direct file browsing or an active CAD attach source. Provides the ability to update the geometry from the source system.
Material assignments brought in by this import.
Displays the current plugin name when the source has been defined by an active CAD attach.
Controls how the source selection if defined.
Selection Types:
| BrowseSource | Source is specified using the file browser dialog. |
| ActiveCADAttach | Source is specified by an active CAD attach source. |
Sets an import source file location through a file browser dialog.
Required Arguments
Defines geometry import preferences used during the initial geometry import and any subsequent updates.
Allows the specification of a key that is used to filter processed CAD System coordinate systema during import. The key must be present at the beginning or the end of a coordinate system's name to be valid for import. The Coordinate System Key supports multiple prefixes/suffixes with each value separated by a semicolon. If the value is empty, all coordinate systems are imported. The key is empty by default.
Enables the decomposition of disjoint faces into separate face entities. The default is No.
Allows the specification of a key that is used to filter processed CAD System Parameters during import. The key must be present at the beginning or the end of a CAD Parameter's name to be valid for import. The Dimension Key supports multiple prefixes/suffixes with each value separated by a semicolon. If the value is empty, all Dimensions are imported. The default key is "DS".
Specifies whether coordinate systems created in the CAD System are imported as Reference Frame objects. The default is No.
Enables Dimension processing. Dimension processing can have a negative impact on overall import performance. The default is Independent.
Enables processing of CAD System Named Selections that result in the creation of Selection Sets. The default is No.
Allows parts of mixed dimension to be imported as components of assemblies which have parts of different dimensions. The default is None.
The following options control what is imported when there are bodies of mixed dimension in a multi-body part:
| None | Nothing is imported. |
| Solid | Only solids are imported. |
| Sheet | Only sheet surfaces are imported. |
| SolidSheet | Only solids and sheet surfaces are imported. |
Allows the specification of a key that is used to filter processed CAD System Named Selections during import. The key must be present at the beginning or end of a CAD Named Selection's name to be valid for import. The Selection Set Key supports multiple prefixes/suffixes with each value separated by a semicolon. If the value is empty, all Selection Sets are imported. The default key is "NS".
Indicates if action should be taken to allow associativity. Associativity processing can have a negative impact on import performance. The default is Yes.
Enables the processing of enclosure and symmetry CAD System Named Selections. The default is Yes.
Enables saving of the internal part files generated from the geometry import during the import/update action. The default is No.
Honors a geometry import's part instances during processing to produce faster import times and allow smaller database sizes. The default is Yes.
GlobalMeshAdvancedAttributes specifies the global advanced properties for Part Meshing.
Available options:
| ShapeChecking | Determines the shape checking algorithm to be used by the mesher. |
| TriangleSurfaceMesher | Determines surface meshing algorithm to be used by patch conforming mesher. |
| ElementMidsideNodes | Determines whether elements are with or without midside nodes. |
| StraightSidedElements | Specifies meshing to straight edge elements. |
| LoopRemovalTolerance | Specifies the tolerance value for sheet loop removal. |
| MeshBasedDefeaturing | Specifies automatic defeaturing of dirty geometries. |
| DefeaturingTolerance | Specifies the defeaturing tolerance value. |
| UseAllProcessors | Specifies if all available processors are used for parallel part-based meshing. |
| ProcessorLimit | Specifies the maximum number of processors to be utilized for parallel part-based meshing. |
Determines whether elements are with or without midside nodes.
Available options:
| UseEngineeringIntent | Determine whether midside nodes are kept or dropped based on the Engineering Intent. |
| Dropped | Elements without midside nodes. |
| Kept | Elements with midside nodes. |
Specifies the tolerance value for sheet loop removal. Any loop with radius less than or equal to Loop Removal Tolerance value is removed by mesher. Setting the tolerance value to 0 means that no loops will be removed.
Specifies automatic defeaturing of dirty geometries.
Available options:
| 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. |
Specifies the number of processors to be used by part-based meshing task to enhance performance and ranges from 0 to 64. Default value of 0 (when Use all processors = Yes) automatically ensures that maximum number of available CPU cores are utilized.
Determines the shape checking algorithm to be used by the mesher.
Available options:
| 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. |
Specifies meshing to straight edge elements.
Available options:
| No |
| Yes |
Determines surface meshing algorithm to be used by patch conforming mesher.
Available options:
| Program Controlled | Mesher determines usage of Delaunay or Advancing Front algorithm. |
| Advancing Front | Mesher uses Advancing Front algorithm but can switch to Delaunay if problems occur. |
Specifies usage of all available processors for parallel part-based meshing.
Available options:
| No | Manually specify the limit to the number of processors that can be utilized for parallel part-based meshing. |
| Yes | Automatically detects and utilizes all available processors for meshing parts of an assembly in parallel. |
GlobalMeshBoundaryLayerAttributes specifies the global boundary layer properties.
Available options:
| CollisionAvoidance | Determines strategy to avoid collision between inflated surface meshes. |
| FixFirstLayer | Determines whether the heights or ratios of the first boundary layer will be modified to avoid collision. |
| GapFactor | Specifies gap between intersecting prisms. |
| MaxHeightOverBase | Specifies maximum allowable prism aspect ratio. |
| GrowthRateType | Determines height of boundary layer for given initial height and height ratio. |
| MaxAngle | Specifies the maximum prism layer growth angle. |
| FilletRatio | Specifies whether fillets proportional to the prism height will be created in corner zones of tetrahedral mesh. |
| UsePostSmoothing | Specifies whether post boundary layer smoothing will be performed. |
| SmoothIterations | Specifies the number of post boundary layer smoothing iterations. |
Determines strategy to avoid collision between inflated surface meshes.
Available options:
| 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. |
Specifies whether fillets proportional to the prism height will be created in corner zones of tetrahedral mesh.
Determines whether the heights or ratios of the first boundary layer will be modified to avoid collision.
Available options:
| No |
| Yes |
Determines height of boundary layers for given initial height and height ratio.
Available options:
| Geometric | Height of boundary layer determined geometrically. |
| Linear | Height of boundary layer determined linearly. |
| Exponential | Height of boundary layer determined exponentially. |
Specifies the number of post boundary layer smoothing iterations.
Specifies whether post boundary layer smoothing will be performed.
Available options:
| No |
| Yes |
GlobalMeshSizingAttributes specifies the global mesh sizing attributes.
Available options:
| InheritanceWrap | Specifies whether the sizing function for sew is inherited from the predecessor wrap task or not. |
| UseAdvancedSizeFunction | Specifies options for advanced size function. |
| MinSize | Specifies the minimum size returned to the mesher. |
| ProximityMinSize | Specifies global minimum size when Advanced Size Function is Proximity and Curvature or Proximity. |
| MaxFaceSize | Specifies maximum size returned to the surface mesher. |
| MaxSize | Specifies the maximum size returned to the mesher. |
| ProximitySizeFunctionSources | Specifies the source type to be used for size function calculation when Advanced Size Function is Proximity or Curvature and proximity. |
| GrowthRate | Specifies the increase in edge length with each succeeding layer of elements. |
| CurvatureNormalAngle | Specifies maximum allowable angle that one element is allowed to span when Advanced Size Function is Proximity and Curvature or Curvature. |
| NumberOfCellsAcrossGap | Specifies minimum number of elements to be generated in gaps when Advanced Size Function is Proximity and Curvature or Proximity. |
| Smoothing | Specifies the number of smoothing iterations. |
| AdaptiveResolution | The scaling value for the arguments of various functions for the adaptive size function. |
Specifies maximum allowable angle that one element is allowed to span when Advanced Size Function is Proximity and Curvature or Curvature.
Specifies the increase in edge length with each succeeding layer of elements.
Specifies minimum number of elements to be generated in gaps when Advanced Size Function is Proximity and Curvature or Proximity.
Specifies global minimum size when Advanced Size Function is Proximity and Curvature or Proximity.
Specifies the source type to be used for size function calculation when Advanced Size Function is Proximity or Curvature and proximity.
Available options:
| Faces |
| Edges |
| FacesAndEdges |
Specifies the number of smoothing iterations.
Available options:
| Low |
| Medium |
| High |
Specifies options for advanced size function.
Available options:
| Adaptive |
| Curvature |
| Proximity |
| Fixed |
| ProximityCurvature |
Specifies use of Fixed Size function for sheets if there are present in the geometry.
Frequency parameters for Results
The Imaginary (damping) component in the computed Frequency.
GlobalWrapSewAdvancedAttributes specifies the global advanced properties for wrap and sew.
Available options:
| TessellationRefinement | Specifies value to be used for tessellation refinement. |
| RefinementTolerance | Specifies the user-defined tolerance for tessellation refinement. |
| EdgeExtractionAngle | Determines which CAD features are captured. |
| CreateIntersectingEdgesForOverlappingBodies | Create intersecting edges for overlapping bodies. |
| Zoning | Specifies options for zoning. |
| TargetMetric | Specifies the measure for mesh quality. |
| MetricValue | Specifies the value at which wrapper surface will be improved. |
| Aggressive | Specifies whether mesh may deviate from geometry as a result of wrapper surface improvement. |
Specifies whether mesh may deviate from geometry as a result of wrapper surface improvement.
Available options:
| MeetTarget |
| MaintainGeometry |
Create intersecting edges for overlapping bodies.
Available options:
| No |
| Yes |
Specifies the refinement tolerance for user defined tessellation refinement.
Specifies the measure for mesh quality.
Available options:
| Skewness |
| SizeChange |
| AspectRatio |
Specifies value to be used for tessellation refinement.
Available options:
| 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. |
No details are provided for this entry.
Main Data Import Task user object. Holds the list of import source objects
No Properties.
Creates a single Geometry Import Source within an Import Task. The import source object will be initialized with its source selection mode set to Active CAD Attach.
Adds a single Geometry Import Source to an Import Task.
Return
Reference to the Geometry Import Source.Optional Arguments
Creates surfaces of constant value of the specified variable.
Whether or not to evaluate all time points in the evaluation
The Simulation Step object reference for a multi-step analysis.
The Isotropic Elasticity material model.
The Isotropic Elasticity values can be entered for one of the following combinations:
| YoungsModulusPoissonsRatio | Young's Modulus and Poisson's Ratio |
| ShearModulusPoissonsRatio | Shear Modulus and Poisson's Ratio |
| BulkModulusPoissonsRatio | Bulk Modulus and Poisson's Ratio |
| YoungsModulusShearModulus | Young's Modulus and Shear Modulus |
| YoungsModulusBulkModulus | Young's Modulus and Bulk Modulus |
| BulkModulusShearModulus | Bulk Modulus and Shear Modulus |
which will then compute the other values using Hooke's law.
The Magnitude is used for an expresion to include variations of the data for any independent variable (e.g. Temperature).
Isotropic bulk conductivity material model.
The Value is an expresion which evaluates to a Quantity with the correct units.
Magnetic Loss Tangent material model.
The Value is an expresion which evaluates to a Quantity with the correct units.
The Isotropic Relative Permeability model.
Can be applied to Magnetic analyses
Isotropic relative permittivity material model.
The Magnitude is an expresion which evaluates to a Quantity with the correct units.
The input for resistivity which is isotropic.
This can be used in an electric/magnetic analysis.
The Isotropic Secant Coefficient of Thermal Expansion material model.
The Magnitude is an expresion which evaluates to a Quantity with the correct units.
Seebeck Coefficient : Isotropic model.
Can be applied to Thermal analyses
The Isotropic Thermal Conductivity material model.
The Magnitude is an expresion which evaluates to a Quantity with the correct units.
Specifies how the legend for the current object should be displayed.
Specifies whether to clip out-of-range values. If not set, the out-of-range values are colored by the Invalid Min/Max Colors.
The distribution used to compute the size of each color band.
Specifies the maximum user range value when variable range is 'User Specified'.
Specifies the minimum user range value when variable range is 'User Specified'.
Specifies 'Local' or 'User Specified' variable range.
Magnetic Coercivity material model.
The material object holds all information that defines the behavior for a specific material.
Information about the original source of this managed engineering data.
This command is used to allow the expression of a property to reference data in the named table. This is a reference and not a copy, and so if the table is used in the expression, and a change is made on the referenced table and the change is in the data being referenced the value of the property will be modified. The command creates table functions in the context of this expression which can be used with constants, field variables, or another named expression. If the property does not support an expression an error will occur.
Return
An int which corresponds to the Index passed in to the command and indicates the comand successfully completed.
Required Arguments
Optional Arguments
tbl1 = pressure1.CreateTable(Columns=[[“X”, “Length”], [“Y”, “Length”], [“Z”, “Length”], [“Pressure”, “Pressure”], [“Temperature”, “Temperature Difference”]])
#
# Use three of the columns from tbl1
bc1.AddPropertyTable(Property=“Magnitude”, Table=tbl1, Index=1, Independents=[“X”, “Y”], Dependents=[“Pressure”])
# In the table function the x and y refer to field variables
bc1.SetPropertyExpression(Entity=bc1, Name=“Magnitude”, Expresssion=“table1(x, y)”)
#
# Use four of the columns from tbl1
bc1.AddPropertyTable(Property=“Temperature”, Table=tbl1, Index=1, Independents=[“X”, “Y”, “Z”], Dependents=[“Temperature”])
# In the table function the x, y, and z refer to field variables
bc1.SetPropertyExpression(Entity=bc1, Name=“Temperature”, Expression=“table1(x, y, z)”)
#
# Use two of the columns from tbl1
bc1.AddPropertyTable(Property=“Magnitude”, Table=tbl1, Index=1, Independents=[“X”], Dependents=[“Pressure”])
# In the table function the x refers to field variables
bc1.SetPropertyExpression(Entity=bc1, Name=“Magnitude”, Expression=“table1(x)”)
#
# Use of a constant
bc1.SetPropertyExpression(Entity=bc1, Name=“Magnitude”, Expression=“table1(20)”)
No details are provided for this entry.
Required Arguments
Required example does not exist.
Includes a physical quantity or the constitutive relation for the physical response of a material.
The material property is created based on the specified optional parameters "Definition" and "Behavior".
You can use the GetValidMaterialContentQuery query to obtain a list of available property/models with the corresponding behavior and/or definition.
Optional Arguments
This example assumes that a material has been created.
It then adds the Isotropic Elasticity model to the material
material1.CreateContent(Model="Elasticity", Definition="", Behavior="Isotropic")
CreatePropertyTable is a convenience command which performs the following commands:
| Creates a table. See the CreateEntity command, where Type="Table". |
| Adds columns corresponding to the Fields parameter and the dependent variables of the Property parameter. See the and AddTableColumn command. |
| Adds the table to the Property parameter. See the AddPropertyTable command. |
| Sets the expression on the Property parameter to “table(Fields)”. See the SetPropertyExpression command. |
Return The DataReference of the newly created table.
Required Arguments
This example creates a new Table for the Isotropic Resistivity property in a material.
# drMaterial is the DataReference of the material having an Isotropic Resistivity property
table1 = material1.CreatePropertyTable(
Property="IsotropicResistivity.Magnitude",
Fields=["Temperature"])
table1.AddRow(Data=["100 [C]",".01 [ohm m]"])
table1.AddRow(Data=["200 [C]",".02 [ohm m]"])
table1.AddRow(Data=["300 [C]",".06 [ohm m]"])
table1.GetData()
Deletes a material model from the specified material.
Required Arguments
Optional Arguments
This example deletes the Isotropic Elasticity model from an already created material.
material1.DeleteContent(Model="Elasticity", Definition="", Behavior="Isotropic")
ExportEngineeringData allows an engineering data object which can be managed to be exported to a source via a DataManager
Required Arguments
Optional Arguments
This example assumes that a material and data manager exist in the Study
dataManager1 = GetDataEntity("/MaterialDataContainer/DataManager:DataManager 1")
material1.ExportEngineeringData(
Source=r"C:\Users\epc\AppData\Roaming\Ansys\v151\Engineering_Data_Library.xml",
DataManager=dataManager1)
ImportEngineeringData allows an engineering data object which can be managed to import data from a source via a DataManager
Required Arguments
Optional Arguments
The example assumes that a material has already been created.
material1.ImportEngineeringData(Name="Aluminum Alloy")
Remove a table reference from a property to prevent its use in an expression. If the property does not support an expression an error will occur.
Required Arguments
tbl1 = pressure1.CreateTable(Columns=[[“X”, “Length”], [“Y”, “Length”], [“Pressure”, “Pressure”]])
bc1.AddPropertyTable(Property=“Magnitude”, Table=tbl1, Independents=[“X”, “Y”], Dependents=[“Pressure”])
# In the table function the x and y refer to field variables
bc1.SetPropertyExpression(Entity=bc1, Name=“Magnitude”, Expression=“table1(x, y)”)
bc1.RemovePropertyTable(Property=“Magnitude”, Index=1);
Assigns a Material to a specified Location.
For UI access only to the reference to the Material, other areas should use MaterialAtState
The material object holds all information that defines the behavior for a specific material.
Information about the original source of this managed engineering data.
This command is used to allow the expression of a property to reference data in the named table. This is a reference and not a copy, and so if the table is used in the expression, and a change is made on the referenced table and the change is in the data being referenced the value of the property will be modified. The command creates table functions in the context of this expression which can be used with constants, field variables, or another named expression. If the property does not support an expression an error will occur.
Return
An int which corresponds to the Index passed in to the command and indicates the comand successfully completed.
Required Arguments
Optional Arguments
tbl1 = pressure1.CreateTable(Columns=[[“X”, “Length”], [“Y”, “Length”], [“Z”, “Length”], [“Pressure”, “Pressure”], [“Temperature”, “Temperature Difference”]])
#
# Use three of the columns from tbl1
bc1.AddPropertyTable(Property=“Magnitude”, Table=tbl1, Index=1, Independents=[“X”, “Y”], Dependents=[“Pressure”])
# In the table function the x and y refer to field variables
bc1.SetPropertyExpression(Entity=bc1, Name=“Magnitude”, Expresssion=“table1(x, y)”)
#
# Use four of the columns from tbl1
bc1.AddPropertyTable(Property=“Temperature”, Table=tbl1, Index=1, Independents=[“X”, “Y”, “Z”], Dependents=[“Temperature”])
# In the table function the x, y, and z refer to field variables
bc1.SetPropertyExpression(Entity=bc1, Name=“Temperature”, Expression=“table1(x, y, z)”)
#
# Use two of the columns from tbl1
bc1.AddPropertyTable(Property=“Magnitude”, Table=tbl1, Index=1, Independents=[“X”], Dependents=[“Pressure”])
# In the table function the x refers to field variables
bc1.SetPropertyExpression(Entity=bc1, Name=“Magnitude”, Expression=“table1(x)”)
#
# Use of a constant
bc1.SetPropertyExpression(Entity=bc1, Name=“Magnitude”, Expression=“table1(20)”)
Remove a table reference from a property to prevent its use in an expression. If the property does not support an expression an error will occur.
Required Arguments
tbl1 = pressure1.CreateTable(Columns=[[“X”, “Length”], [“Y”, “Length”], [“Pressure”, “Pressure”]])
bc1.AddPropertyTable(Property=“Magnitude”, Table=tbl1, Independents=[“X”, “Y”], Dependents=[“Pressure”])
# In the table function the x and y refer to field variables
bc1.SetPropertyExpression(Entity=bc1, Name=“Magnitude”, Expression=“table1(x, y)”)
bc1.RemovePropertyTable(Property=“Magnitude”, Index=1);
Body Sizing control which contains all sizing options a user can place on a Body reference
Specifies whether size control settings can be changed by the mesher (Soft) or not (Hard).
Available options:
| Soft |
| Hard |
Specifies maximum angle that one element edge is allowed to span.
Specifies the maximum size for the edge, face or body sizing control.
Specifies increase in element edge length with each succeeding layer of elements.
Specifies value to override global Min Size on local entities.
A common property for all sub meshing objects with a defined Geometry Filter
A common toggle for all sub meshing objects with a Location property so that it can be automatically set. Currently only visible in Boundary Layer object.
Specifies attributes for edge sizing.
Available options:
| EdgeSizingMethod | Specifies the edge sizing method. |
| EdgeDivisions | Specifies the number of divisions on each edge. |
| BiasMethod | Specifies bias option which is always smooth transition. |
| BiasType | Specifies option for bias type. |
| BiasGrowthRate | Specifies value for bias growth rate. |
Specifies whether size control settings can be changed by the mesher (Soft) or not (Hard).
Available options:
| Soft |
| Hard |
Specifies option for bias type.
Available options:
| Right |
| Left |
| CenterIn |
| CenterOut |
| Constant |
Specifies maximum angle that one element edge is allowed to span.
Specifies the edge sizing method.
Available options:
| ElementSize |
| EdgeDivisions |
Specifies the maximum size for the edge, face or body sizing control.
Specifies increase in element edge length with each succeeding layer of elements.
Specifies value to override global Min Size on local entities.
A common property for all sub meshing objects with a defined Geometry Filter
A common toggle for all sub meshing objects with a Location property so that it can be automatically set. Currently only visible in Boundary Layer object.
Mesh Method properties
Show options to select the Local Element Midside Nodes
A common property for all sub meshing objects with a defined Geometry Filter
A common toggle for all sub meshing objects with a Location property so that it can be automatically set. Currently only visible in Boundary Layer object.
Face Sizing control to be scoped to a topological selection of faces.
Specifies whether size control settings can be changed by the mesher (Soft) or not (Hard).
Available options:
| Soft |
| Hard |
Specifies maximum angle that one element edge is allowed to span.
Specifies the maximum size for the edge, face or body sizing control.
Specifies increase in element edge length with each succeeding layer of elements.
Specifies value to override global Min Size on local entities.
A common property for all sub meshing objects with a defined Geometry Filter
A common toggle for all sub meshing objects with a Location property so that it can be automatically set. Currently only visible in Boundary Layer object.
Specifies local boundary layer attributes.
Available options:
| BoundaryLayerOption | Specifies the way heights of the boundary layers are determined. |
| FirstLayerHeight | Specifies the height of the first boundary layer. |
| FirstAspectRatio | Specifies the aspect ratio of the boundaries that are extruded from the boundary base. |
| TransitionRatio | Specifies the rate at which adjacent elements grow. |
| NumberOfLayers | Specifies the number of boundary layers. |
| MaximumLayers | Specifies the maximum number of boundary layers to be created. |
| GrowthRate | Specifies the value for Growth Rate. |
| AspectRatio | Specifies relative thickness of adjacent boundary layers. |
| MaximumThickness | Specifies the desired maximum thickness of the boundary layer. |
| BoundaryLayerAlgorithm | Specifies pre or post boundary layer algorithm to be used by the mesher. |
Specifies pre or post boundary layer algorithm to be used by the mesher.
Available options:
| Post |
| Pre |
Specifies the way heights of the boundary layers are determined.
Available options:
| SmoothTransition | Mesher ensures smooth rate of volume change using local tetrahedral element size. |
| TotalThickness | Creates constant boundary layers using the values of Number of Layers and Growth Rate. |
| FirstLayerThickness | Creates constant boundary layers using values of First Layer Height, Maximum Layers and Growth Rate. |
| 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. |
Specifies the aspect ratio of the boundaries that are extruded from the boundary base.
A common property for all sub meshing objects with a defined Geometry Filter
Specifies the desired maximum thickness of the boundary layer.
A common toggle for all sub meshing objects with a Location property so that it can be automatically set. Currently only visible in Boundary Layer object.
MeshDiagnostics specifies the settings used to evaluate mesh quality.
Available options:
| GeometryLocation | Specifies the selected topology set or the entire model for which mesh diagnostics are evaluated during part-based Meshing. |
| MeshMetric | Specifies the metric type based on which mesh quality is evaluated. |
| NumNodes | Specifies number of nodes in the mesh. |
| NumElements | Specifies number of elements in the mesh. |
| MinMetric | Specifies the minimum value for chosen metric type. |
| MaxMetric | Specifies the maximum value for chosen metric type. |
| AverageMetric | Specifies the average value for chosen metric type. |
| StandardDeviation | Specifies the standard deviation value for chosen metric type. |
A common property for all sub meshing objects with a defined Geometry Filter
Specifies the metric type based on which mesh quality is evaluated.
Available options:
| 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. |
| None | No mesh metric type is selected. |
Specifies the standard deviation value for chosen metric type.
A common toggle for all sub meshing objects with a Location property so that it can be automatically set. Currently only visible in Boundary Layer object.
Base class for display state objects with reference Ids or reference names.
No Properties.
Object returned by mesh display state queries with reference Ids and their corresponding display state properties.
Available properties:
| State | Meshing state for entity. [ 0 = Unmeshed, 1 = Meshed, 2 = OutOfDate, 3 = Failed, 4 = Suppressed, 5 = Connected, 6 = NeedsConnected ] |
| MeshColor | Color with which the mesh element edges should be drawn by graphics. |
| Translucency | Translucency value with which the mesh element faces should be drawn by graphics. |
| ShowMesh | Flag to tell graphics whether to overlay the mesh on the entity or not. |
| ReferenceIds | A list of entity reference Ids that are associated with a given meshing state. |
No Properties.
Object returned by mesh display state queries with reference names and their corresponding display state properties.
Available properties:
| State | Meshing state for entity. [ 0 = Unmeshed, 1 = Meshed, 2 = OutOfDate, 3 = Failed, 4 = Suppressed, 5 = Connected, 6 = NeedsConnected ] |
| MeshColor | Color with which the mesh element edges should be drawn by graphics. |
| Translucency | Translucency value with which the mesh element faces should be drawn by graphics. |
| ShowMesh | Flag to tell graphics whether to overlay the mesh on the entity or not. |
| ReferenceNames | A list of entity reference names that are associated with a given meshing state. |
No Properties.
Meshing Task is used to determine (in a smart way) which meshing technology to use for meshing the model. A mesh can be generated by either (1) selectively meshing parts or entire assemblies of parts, or (2) filling in the volume of a surface mesh created by a Wrap task.
Available options:
| EngineeringIntent | Defines the kind of physics that is being studied in this simulation process (used in part-based Meshing). |
Used only when there is a connection from AIM Mesh Modeling component to Fluent Setup - part mesh file tranfer
Defines the kind of physics that is being studied in this simulation process (used in part-based Meshing).
Available options:
| StructuralOrThermal | Intent of this process is a structural and/or thermal simulation. |
| FluidFlow | Intent of this process is a fluid flow or fluid solid conduction simulation. |
Will tell the mesher to try again with finer sizing inputs if the first attempt at meshing fails.
Defines the resolution for automatically calculating global meshing inputs. Selecting a higher resolution generates a better quality mesh.
Automatically calculates the global sizing values based on the resolution value.
Main MeshModeling Task user object
Used only when there is a connection from AIM Mesh Modeling component to Fluent Setup - part mesh file tranfer
Main Modeling Task user object
No Properties.
Browses for the geometry import file path and sets it for a Modeling Task.
Required Arguments
Sets the import file path on a Modeling Task.
Required Arguments
Defines an imported modeling source associated with the Modeling Task.
Material assignments brought in by this import.
Displays the current plugin name when the source has been defined by an active CAD attach.
Controls how the source selection if defined.
Selection Types:
| BrowseSource | Source is specified using the file browser dialog. |
| ActiveCADAttach | Source is specified by an active CAD attach source. |
No details are provided for this entry.
The Molar Mass model.
Can be applied to Fluid and Thermal analyses
Class containing a list of monitors to be displayed in a single chart.
No Properties.
The Configuration control to move or rotate the geometry to a new Reference Frame.
No details are provided for this entry.
Defines a reference frame from a local origin and 2 direction vectors
No Properties.
Provides the definition of a Physics Coupling Interface.
The source Physics Region that sends data via the Physics Coupling Interface.
The target Physics Region that receives data via the Physics Coupling Interface.
The source locations for the Physics Coupling Interface. This location can be set to AllCouplingSourceFaces(), AllCouplingSourceBodies(), or specific boundary conditions or selection sets from the Source solution.
The target locations that receive data via the Physics Coupling Interface.
Represents a physics solution.
Provides a list of all Boundary Conditions in this entity. (Deprecated; use GetAllConditionsQuery instead)
Return
A list of DataReferences containing the requested Boundary Conditions.
Provides a list of all (Boundary) Conditions in this entity.
Return
A list of DataReferences containing the requested (Boundary) Conditions.
A query to return all Contact objects in the Solution.
Return
A list of DataReferences containing the requested Contacts.
GetAllObjects may be used to get all of the objects for the given search criteria.
Return
A DataReferenceSet of all the Parent children objects of the given Type.
Optional Arguments
This example displays all of the objects in a default solution.
system1 = GetSystem(Name="Study")
solutionComponent1 = Study.CreateTask(
Name="Solution",
System=system1)
study1 = system1.GetContainer(ComponentName="Study")
solution1 = study1.GetSolution(Name="Solution")
for item in solution1.GetAllObjects():
print item
A query to return all Physics Regions in the Solution.
Return
A list of DataReferences containing the requested Physics Regions.
Gets a list of bodies that are not associated with a physics region.
Required Arguments
Gets a list of bodies that are not associated with a physics region and also the total number of bodies.
Return
Total count of bodies and a list of bodies that are not associated with any physics regions.
Required Arguments
Provides the list of overlapping Material Assignments given an active Model.
Return
A DataReferenceSet of the duplicate material assignments.
Required Arguments
A query to return all Material Assignments in the Analysis.
Return
A list of DataReferences with the requested Material Assignments.
Locates the topologies ( represented by their reference strings ) that currently don't have a material assignment given an active Model.
Required Arguments
The common set of Physics Options.
No Properties.
Specifies the type and location of the fundamental physics in the simulation.
Provides a list of all Boundary Conditions in this entity. (Deprecated; use GetAllConditionsQuery instead)
Return
A list of DataReferences containing the requested Boundary Conditions.
Provides a list of all (Boundary) Conditions in this entity.
Return
A list of DataReferences containing the requested (Boundary) Conditions.
Provides the list of overlapping Material Assignments given an active Model.
Return
A DataReferenceSet of the duplicate material assignments.
Required Arguments
A query to return all Material Assignments in the Analysis.
Return
A list of DataReferences with the requested Material Assignments.
Locates the topologies ( represented by their reference strings ) that currently don't have a material assignment given an active Model.
Required Arguments
The analytic definition of a flat plane where the Z axis is the normal direction.
Definition type for defining a plane from another plane.
Definition type for defining a plane from a reference frame.
Definition type for defining a plane from an origin and 2 axes.
No Properties.
Extension for plane offset and rotation
Point represented by local coordinates relative to a reference frame.
Calculation method for defining the point from geometry.
Collection of properties to define a UniversalPoint
Calculation method for defining the point from geometry
Core Loss Power Ferrite material model.
Frame of reference for modeling and simulation data.
Transform relative to the global reference frame without motion
Default coordinate type for points/vectors in this reference frame.
Used to define and evaluate a quantitative result in an Analysis.
Set to true if averages are to be calculated as part of the Result evaluation.
Whether or not to evaluate all time points in the evaluation
The Simulation Step object reference for a multi-step analysis.
The top-level object for a Results task.
Parameters for Results
Rotates about the X axis by 180 degrees.
Rotates about the Y axis by 180 degrees
Rotates about the Z axis by 180 degrees
Rotates the matrix about a vector relative to the local reference frame.
Define the axis direction relative to Local or Parent.
SectionLayer is a class that represents various section properties as available to a given layer. In general composite shell and beam elements can have multiple layers and each layer can have its own orientation, thickness and offset.
Represents the offset of a section with respect to the reference axis/plane/whatever.
When OffsetType is User Defined, the offset of the beam section with respect to the origin
Offset of the beam cross section, also the location of the nodes in the section
An object that can be used to reference any Location.
The selected location: evaluates to a set of reference ids. See LocationSet for more detail.
Returns the number of selectable entities of the specified SelectionSet.
Return
The number of selectable entities of the specified SelectionSet.
The top-level object for a Shape task.
No details are provided for this entry.
No details are provided for this entry.
When OffsetType is User Defined, the offset of the shell section with respect to the midplane
Offset of the shell section, also the location of the nodes in the section
The top-level object that manages all data in a simulation study.
No Properties.
A query to return all available models in the Simulation.
Return
A list of DataReferences containing the requested Models.
A query to get all data objects in the simulation which reference the topological entity with the given reference ID.
Return
The list of data objects that references the given input Reference string.
Required Arguments
Returns the Physics Regions that contain any of the specified journal reference strings.
Return
The Physics Regions whose location contains the selection.
A result object that can be used to evaluate a single calculated value.
Set to true if averages are to be calculated as part of the Result evaluation.
Whether or not to evaluate all time points in the evaluation
Specifies the type of mesh location (node, element, face, edge) to be used to calculate the value.
The Simulation Step object reference for a multi-step analysis.
SolutionProgression is a class that specifes convergence, stabilization of solution etc, the typical attributes for monitoring and controlling a solution.
No Properties.
Solution quality monitor objects are used to present graphical charts tracking aspects of the solution quality, such as convergence.
Gives the name of a set of fields (assembly of fields of same nature : for contact, for thermal, ..)
No details are provided for this entry.
It displays the solution progression associated with this solution step
Solution variable monitor objects are used to present graphical charts tracking aspects of the solution results, such as displacements.
Gives the name of a set of fields (assembly of fields of same nature : for contact, for thermal, ..)
The common set of solver settings.
No Properties.
The specific heat at constant pressure model provided via a specified expression.
The Magnitude is an expresion which evaluates to a Quantity with the correct units.
Triplet represented in spherical coordinates
Angle in the XY plane counter-clockwise from the +X axis (a.k.a phi) phi = arctan(y / x)
Angle between the +Z axis and the vector (a.k.a. polar angle, theta) theta = arccos(z / r)
For the purpose of using generic in AddProperty need a base for the StateOfMatter
No Properties.
Defines the behavior (suppression, ramping, factor, locked) for a collection of UserObjects
No Properties.
StepControlExtension is a class to represents controls for Simulation
The Strain Life Properties material model.
Fatigue Strength Exponent (Basquin's Exponent)
A result that displays flow paths within a vector field.
The amount my which the maximum integration time is scaled when creating animated streamlines.
Whether or not to evaluate all time points in the evaluation
The size of integration steps in streamline creation when using a fixed step size.
Defines how the mesh is sampled to create seed points.
How many nodes or elements are skipped when sampling mesh to generate seed points.
The method used to determine the size of integration steps in streamline creation.
Controls the display style of the streamlines.
Summary of Result values
The calculated maximum value of the Quantity in this Result.
The calculated minimum value of the Quantity in this Result.
The calculated Sum total of the Quantity being evaluated in this Result.
The calculated Sum total of the X-component of the Quantity evaluated in this Result.
The calculated Sum total of the Y-component of the Quantity evaluated in this Result.
The calculated Sum total of the Z-component of the Quantity evaluated in this Result.
Settings for the suppression of geometry or mesh in a Configuration.
The three coefficient model definition.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
The two coefficient model definition
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
No details are provided for this entry.
Whether or not to evaluate all time points in the evaluation
The Tensile Ultimate Strength model.
Can be applied to Structural analyses
The Tensile Yield Strength model.
Can be applied to Structural analyses
The three coefficient definition
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
Time dependent parameters for post objects
Controls the contents of a Transcript monitor.
Translates a reference frame by a vector.
Define the translation vector relative to Local or Parent. This is a simplification of the TranslationVector RelativeTo property
The two coefficient definition.
Gets or sets the dimensional coefficient B.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
Representation of a point or vector in cartesian, cylindrical, and spherical coordinates
The type of coordinate: Cartesian, Cylindrical, or Spherical
Collection of properties to define a UniversalVector
Calculation method for defining the vector from geometry
Flag to reverse the vector direction when defining from Geometry
Define the vector from magnitude/direction or components
A result object that displays the magnitude and direction of a vector field.
Set to true if averages are to be calculated as part of the Result evaluation.
Whether or not to evaluate all time points in the evaluation
Defines how the mesh is sampled to create seed points.
The Simulation Step object reference for a multi-step analysis.
How many nodes or elements are skipped when sampling mesh to generate seed points.
This class represents box.
This class extends VirtualPrimitiveBox class. Contains properties like Selection Method, Cushioning, Location etc.
Gets or sets the -X cushion value for non-uniform cushion.
Gets or sets the +X cushion value for non-uniform cushion.
Gets or sets the -Y cushion value for non-uniform cushion.
Gets or sets the +Y cushion value for non-uniform cushion.
Gets or sets the -Z cushion value for non-uniform cushion.
Gets or sets the +Z cushion value for non-uniform cushion.
Gets or sets the options for choosing between box creation methods.
Gets or sets the option to select between Uniform or Non-Uniform cushion around box.
Gets or sets the uniform cushion value for uniform cushion.
The viscosity model provided via a specified expression.
The Magnitude is an expresion which evaluates to a Quantity with the correct units.
The Shear Rate and Temperature dependent model.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
Gets or sets the infinite shear viscosity.
The Shear Rate dependent model.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
Gets or sets the infinite shear viscosity.
The Shear Rate and Temperature Dependent model.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
The Shear Rate Dependent model.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
The Shear Rate and Temperature dependent model.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
The Shear Rate dependent model.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
The Shear Rate and Temperature dependent model.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
Gets or sets the maximum viscosity limit.
Gets or sets the minimum viscosity limit.
The Shear Rate dependent model
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
Gets or sets the maximum viscosity limit.
Gets or sets the minimum viscosity limit.
Volume Extraction Region specifies the settings used when extracting a volume region for a wrap task.
Available options:
| GeometryLocation | Specifies the surounding bodies around the volume to be extracted. |
| Point | Specifies a reference point where the volume is located to extact. |
| ExtraRefineLevel | Specifies number of extra refinement levels. |
| ImprintIterations | Specifies number of imprinting iterations for feature capturing. |
| AggressiveImprintIterations | Specifies additional iterations for aggressive imprinting to improve feature capture. |
Sets the Feature Resolution factor to be used for all Mesh Regions.
A common property for all sub meshing objects with a defined Geometry Filter
Specifies the meshing region behavior.
Available options:
| Wrap | Simplifies unclean geometry before sewing. |
| PassThroughToSew | Bypasses simplification of unclean geometry before sewing. |
A common toggle for all sub meshing objects with a Location property so that it can be automatically set. Currently only visible in Boundary Layer object.
Specifies wrap method for the meshing region.
Available options:
| ShrinkWrap |
| CutWrap |
Volume Simplification specifies the settings used when simplifying a model within a wrap task.
Available options:
| GeometryLocation | Specifies the bodies and parts to be wrapped. |
| GroupingOption | Specifies grouping option for the bodies being wrapped. |
| ExtraRefineLevel | Specifies number of extra refinement levels. |
| ImprintIterations | Specifies number of imprinting iterations for feature capturing. |
| AggressiveImprintIterations | Specifies additional iterations for aggressive imprinting to improve feature capture. |
Sets the Feature Resolution factor to be used for all Mesh Regions.
A common property for all sub meshing objects with a defined Geometry Filter
If checked, geometry is simplified by unifying multiple solid surfaces into one and ignoring any interior voids and faces. Otherwise, a conformal, well-connected surface mesh is created for each of the selected bodies.
Specifies the meshing region behavior.
Available options:
| Wrap | Simplifies unclean geometry before sewing. |
| PassThroughToSew | Bypasses simplification of unclean geometry before sewing. |
A common toggle for all sub meshing objects with a Location property so that it can be automatically set. Currently only visible in Boundary Layer object.
Specifies wrap method for the meshing region.
Available options:
| ShrinkWrap |
| CutWrap |
Volume creation task uses specialized boundary wrapping to extract a well-connected surface mesh for the selected geometry.
Defines the resolution for automatically calculating global meshing inputs. Selecting a higher resolution generates a better quality mesh.
Specifies whether the current output model should be used for reassociating so that reference Ids are persistent or whether new references should be created.
Automatically calculates the global sizing values based on the resolution value.
Configure parameters for absorption coefficient in radiation heat transfer.
Specify absorption coefficient for radiation heat transfer.
Set absorptivity parameters.
Specify diffuse hemispherical absorptivity.
Set the acoustics initial conditions.
Set the velocity direction in different coordinate system.
context to be documented
| AcousticPressureAndVelocity |
Set boundary conditions related to Acoustics.
context to be documented
| Admittance |
| NonReflecting |
| Wall |
Set the velocity direction in different coordinate system.
Set the velocity component in Cartesian coordinate system.
Set the velocity component in cylindrical coordinate system.
context to be documented
| CartesianComponents |
| CylindricalComponents |
Configure advance control setting for solver.
Configure solution advancement process for radiation.
Configure solution advancement process for species.
Configure solution advancement process for turbulence.
Configure solution advancement process for user variable.
Configure advection schemes for governing equations
Select default advection scheme used by all equations without explicit overrides.
| BoundedCentralDifference |
| CentralDifference |
| FirstOrderUpwind |
| SecondOrderUpwind |
| UnboundedSecondOrderUpwind |
No details are provided for this entry.
No Properties.
No details are provided for this entry.
Configure reverse flow for the boundary.
Sets the direction of the inflow stream should the flow reverse direction. If you choose Direction Vector, you will define the flow direction components, and if you choose Normal to Boundary or From Neighboring Cell, no inputs are required.
Select the option to specify the backflow pressure.
Enable/Disable reverse flow.
| No |
| Yes |
Configure parameters for angular discretization and pixelation for the DO mode.
Set Phi Divisions, which is the number of control angles used to discretize each octant of the angular space.
Set Phi Pixels, which is used to control the pixelation that accounts for any control volume overhang.
Set Theta Divisions, which is the number of control angles used to discretize each octant of the angular space.
Set Theta Pixels, which is used to control the pixelation that accounts for any control volume overhang.
Sets the direction of the inflow stream should the flow reverse direction. If you choose Direction Vector, you will define the flow direction components, and if you choose Normal to Boundary or From Neighboring Cell, no inputs are required.
Set the component in the different direction.
Set the component in the different direction.
Select option for backflow direction specification.
| Cartesian |
| Cylindrical |
| FromNeighboringCell |
| NormalToBoundary |
Select the option to specify the backflow pressure.
Select option for backflow pressure specification.
| EntrainmentPressure |
| TotalPressure |
Configure radiation beam direction.
Choose a beam direction from the available options.
| SpecifiedValue |
| UseSolarLoadModelSetting |
Set beam width for an external semi-transparent wall in terms of the Theta and Phi extents.
Set boundary.
Set the reference frame for boundary from (physics region or all available reference frames).
Set different boundary type.
| Axis |
| Farfield |
| Inlet |
| Opening |
| Outlet |
| Solid |
| Symmetry |
| Wall |
Set the reference frame for total pressure and total temperature.
No details are provided for this entry.
No Properties.
Set the reference frame for boundary from (physics region or all available reference frames).
Set the reference frame for boundary from (physics region or all available reference frames).
| SpecifyFrame |
| UseFromPhysicsRegion |
Configure Buoyancy Model.
Sets location where hydrostatic pressure due to buoyancy is zero.
context to be documented
| Off |
| On |
| ParticleBuoyancyOnly |
Configure Buoyancy Model.
Sets the operating temperature to use with the Boussinesq approximation.
context to be documented
| Boussinesq |
| DensityDifference |
Sets the thermal expansion coefficient value.
Sets location where hydrostatic pressure due to buoyancy is zero.
Sets the coordinates value of reference pressure location.
context to be documented
| Automatic |
| CartesianCoordinates |
Configure calculation specific settings.
Provides high-level control over the solver convergence rate. The default is 0. A more aggressive value like +1 often accelerates slow convergence, while a more conservative value like -0.5 may improve stalled or oscillatory convergence. See the 'Judging Convergence' help topic for more details.
Set the orthotropic inertial resistance coefficients in cartesian coordinates.
Set the orthotropic viscous resistance coefficients (inverse permeability) in cartesian coordinates.
Configure methods and settings for creating surface clusters.
sets the number of faces per surface cluster for the wall.
Set maximum distance of a zone form a critical zone for which view factors will be calculated.
Set Maximum Faces Per Surface Cluster, which is maximum number of faces per surface cluster automatically assigned to non-critical wall zones adjacent to fluid zones.
Allows to specify the velocity component in different coordinate system.
Set the velocity component in Cartesian coordinate system.
Set the velocity component in cylindrical coordinate system.
Allows to specify the velocity component in different coordinate system.
| Cartesian |
| Cylindrical |
Choose connection type for interface.
context to be documented
| Periodic |
| Standard |
No details are provided for this entry.
Set boundary.
Set the reference frame for boundary from (physics region or all available reference frames).
Set different boundary type.
| Axis |
| Farfield |
| Inlet |
| Opening |
| Outlet |
| Solid |
| Symmetry |
| Wall |
Set the reference frame for total pressure and total temperature.
Set boundary.
Set the reference frame for boundary from (physics region or all available reference frames).
Set different boundary type.
| Axis |
| Farfield |
| Inlet |
| Opening |
| Outlet |
| Solid |
| Symmetry |
| Wall |
Set the reference frame for total pressure and total temperature.
Configure convergence criteria for residual, monitor, etc.
Configure convergence criteria for residuals.
Configure coupled controls.
Configure parameters that control the V, W and F cycles.
Configure settings for solution advancement.
Allows to choose solver formulations for density based solver.
Allows to choose different schemes for pressure-velocity coupling.
Set the orthotropic inertial resistance coefficients in cylindrical coordinates.
Set the orthotropic viscous resistance coefficients (inverse permeability) in cylindrical coordinates.
Define how the Damping layer must behave.
context to be documented
| Off |
| On |
Set the thickness of the damping layer, starting from the NRBC.
Specifies turbulent flow to be calculated using the Detached Eddy Simulation model.
Choose among the shielding functions.
| DDES |
| IDDES |
Configure Diffuse Solar Irradiation, which is the amount of energy per unit area due to diffuse solar irradiation.
Configure the diffusion flux of species.
Allows to choose between the models to calculate the diffusion fluxes.
| FicksLaw |
| MixtureAveraged |
| StefanMaxwellDiffusion |
| UnityLewisNumber |
Allows to choose between Cartesian or cylindrical component to specify direction.
Set the vector component in Cartesian coordinate system.
Set the vector component in cylindrical coordinate system.
Allows to choose between Cartesian or cylindrical component to specify direction.
| CartesianComponents |
| CylindricalComponents |
Configure Direct Solar Irradiation, which is the amount of energy per unit area due to direct solar irradiation.
Configure conversion of scalar transport equations to discrete algebraic equations
Configure interpolation of convection terms of quantities to control volumes
No details are provided for this entry.
No Properties.
Configure KOmega BSL model constants.
Constant used in modeling the Turbulence Dissipation.
Set C-epsilon1 for EARSMRg K-Omega Mean Base Line (BSL) Model.
Set C-epsilon1 for EARSMRg K-Omega Mean Base Line (BSL) Model.
Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Turbulence Eddy Frequency (omega) condition.
Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Turbulence Eddy Frequency (omega) condition.
Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of turbulence kinetic energy via turbulent transport.
Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of turbulence kinetic energy via turbulent transport.
Configure KOmega BSL model constants.
Set this parameter to damp the turbulent viscosity causing a low-Reynolds number correction.
Set constant used in modeling the Turbulence Dissipation.
Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Turbulence Eddy Frequency (omega) condition.
Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Turbulence Eddy Frequency (omega) condition.
Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of turbulence kinetic energy via turbulent transport.
Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of turbulence kinetic energy via turbulent transport.
Allows to choose between different energy initial condition.
Allows to choose between different energy initial condition.
| Automatic |
| Temperature |
Set boundary conditions related to Energy.
Specify entrainment temperature for thermal analysis.
Set boundary conditions related to Energy.
| Convection |
| ConvectionAndRadiation |
| EntrainmentTemperature |
| HeatFlow |
| HeatFlux |
| Insulated |
| Radiation |
| StationaryFrameTotalEnthalpy |
| Temperature |
| TotalEnthalpy |
| TotalTemperature |
Set external radiation temperature at wall.
Configure solution advancement process for energy.
Applies pseudo transient under-relaxation method. The under-relaxation is controlled through pseudo time step size.
Set the value of under-relaxation factor for current equation.
Allows to choose between relaxation factor, Courant number and pseudo-transient.
| CourantNumber |
| None |
| PseudoTransient |
| RelaxationFactor |
Configure Energy Model.
Configure Energy Model for phase interaction.
Configure Energy Model.
| Off |
| On |
| PhaseDependent |
Configure Energy Model for turbulence interaction.
Enable viscous heating.
| Off |
| On |
Incorporate near wall treatment for energy interaction model.
Allows to choose between different energy wall treatment definitions.
| Jayatilleke |
| LaunderSpalding |
Allows to choose between different energy periodicity models.
Set the upstream bulk temperature value.
Applies pseudo transient under-relaxation method. The under-relaxation is controlled through pseudo time step size.
Allows one to choose how the length scale is determined when using pseudo transient solution advancement.
Allows one to select how the pseudo transient time scale is calculated for the energy equation.
| Automatic |
| Off |
| UserSpecified |
Set time scaling factor relative to the one specified for flow advancement
Set a scaling factor used to scale the calculated time step.
to be documented
context to be documented
| SourceDensity |
| TotalSource |
Set the reference frame for source terms.
Configure External Black Body Temperature, which allows to take into account the influence of the temperature of the gas and the walls beyond the inlet/exit boundaries.
Used to model a free-stream condition at infinity.
Set the mach number (ratio of speed of an object moving through a fluid and the local speed of sound).
Set boundary.
Set the reference frame for boundary from (physics region or all available reference frames).
Set different boundary type.
| Axis |
| Farfield |
| Inlet |
| Opening |
| Outlet |
| Solid |
| Symmetry |
| Wall |
Set the reference frame for total pressure and total temperature.
Configure parameters that control the V, W and F cycles.
Controls the number of equations on each successively coarser grid level. Number of equations on each level will be 1/CoarseningRate of the number on the previous level.
Choose smoother for coupled equations with fixed cycles.
| GaussSeidel |
| ILU |
Set the maximum number of coarse levels that will be built by multigrid solver.
Set the number of sweeps to perform after coarser level corrections have been applied.
Configure parameters that control the V, W and F cycles.
Controls the number of equations on each successively coarser grid level. Number of equations on each level will be 1/CoarseningRate of the number on the previous level.
Set the maximum number of coarse levels that will be built by multigrid solver.
Set the number of sweeps to perform after coarser level corrections have been applied.
Choose smoother for scalars with fixed cycles.
| GaussSeidel |
| ILU |
Configure parameters that control the flexible multigrid cycle.
Set the number of times to apply the smoothing method each time a relaxation is performed.
Configure the initial conditions.
Enable to maintain constant velocity magnitude throughout the computational domain.
Configure the initial conditions.
| Automatic |
| StaticPressureAndVelocity |
Allows to specify the velocity direction in different coordinate system.
Configure flow specification for the boundary.
Allows to specify the flow direction in different coordinate system.
Configure the fully developed flow boundary condition.
Select boundary specification option.
| Farfield |
| FreeSlip |
| FullyDevelopedFlow |
| MarangoniStress |
| MassFlow |
| NoSlip |
| Pressure |
| SpecifiedShear |
| SpecularityCoefficient |
| Velocity |
Configure solution advancement process for momentum.
Applies pseudo transient under-relaxation method. The under-relaxation is controlled through pseudo time step size.
Set the value of under-relaxation factor for current equation.
Allows to choose between relaxation factor, Courant number and pseudo-transient.
| CourantNumber |
| None |
| PseudoTransient |
| RelaxationFactor |
Allows to choose solver formulations for density based solver.
Allows to choose different methods to specify direction.
| Explicit |
| Implicit |
Allows to specify the flow direction in different coordinate system.
Set the component in the different direction.
Set the component in the different direction.
Allows to specify the flow direction in different coordinate system.
| Cartesian |
| Cylindrical |
| CylindricalWithTangentialVelocity |
| NormalToBoundary |
Configure Flow Model.
Sets the parameters related to operating conditions in the model.
Allows to choose between different flow periodicity models.
Allows to specify the flow direction in different coordinate system.
Applies pseudo transient under-relaxation method. The under-relaxation is controlled through pseudo time step size.
Allows one to choose how the length scale is determined when using pseudo transient solution advancement.
Allows to choose 'Automatic' or manually specify the settings.
| Automatic |
| UserSpecified |
Set a scaling factor used to scale the calculated time step.
Configure flow solver.
Allows to choose pressure or density based solver.
| DensityBased |
| PressureBased |
No details are provided for this entry.
No details are provided for this entry.
to be documented
context to be documented
| SourceDensity |
| TotalSource |
Set the reference frame for source terms.
Configure the fully developed flow boundary condition.
Set the flow rate weighting factor (what portion of the outflow is through the boundary).
Configure the parameters to define the position of solar radiation.
Set the local time zone of the desired location in hours relative to GMT.
Set boundary.
Set the reference frame for boundary from (physics region or all available reference frames).
Set different boundary type.
| Axis |
| Farfield |
| Inlet |
| Opening |
| Outlet |
| Solid |
| Symmetry |
| Wall |
Set the reference frame for total pressure and total temperature.
Set boundary.
Set the reference frame for boundary from (physics region or all available reference frames).
Set different boundary type.
| Axis |
| Farfield |
| Inlet |
| Opening |
| Outlet |
| Solid |
| Symmetry |
| Wall |
Set the reference frame for total pressure and total temperature.
No details are provided for this entry.
No details are provided for this entry.
Configure High Order Rhie Chow scheme
Shows active High Order Rhie Chow scheme
| FirstOrderMomentumWeighted |
| SecondOrderMomentumWeighted |
Configure relaxation of high order terms.
Enables to set the default value of relaxation factor.
| Off |
| On |
Configure relaxation for high order terms for current equation.
Configure imbalance convergence.
Configure imbalance default settings.
Allows to choose default or equation based settings.
| DefaultSettings |
| EquationBasedSettings |
Configure imbalance default settings.
Allows to set default value for convergence criteria of imbalance.
| None |
| SpecifyImbalanceTolerance |
Set the initial condition.
Set the reference frame for initial condition.
Set the initial condition.
Set the reference frame for initial condition.
Allows to specify the flow direction in different coordinate system.
Set the component in the different direction.
Set the component in the different direction.
Allows to specify the flow direction in different coordinate system.
| Cartesian |
| Cylindrical |
| NormalToBoundary |
to be documented
context to be documented
| PerElementFace |
| Random |
Set boundary.
Set the reference frame for boundary from (physics region or all available reference frames).
Set different boundary type.
| Axis |
| Farfield |
| Inlet |
| Opening |
| Outlet |
| Solid |
| Symmetry |
| Wall |
Set the reference frame for total pressure and total temperature.
Set boundary.
Set the reference frame for boundary from (physics region or all available reference frames).
Set different boundary type.
| Axis |
| Farfield |
| Inlet |
| Opening |
| Outlet |
| Solid |
| Symmetry |
| Wall |
Set the reference frame for total pressure and total temperature.
Set the physics region on either side of interface.
Set the physics region and their topology ids on this side of interface.
configure to create matching or nonmatching interface.
If parent face normals deviate from each other by more than this angle, they will not be intersected.
A bounding box is used to search for and identify possible face intersections. Since the box has a finite size, use this parameter to control the amount by which the bounding box should be made larger (as a fraction of the original span). Note that a larger bounding box impacts the time required to identify face intersections.
Enable this option if the geometries on the two sides of the interface match, to prevent the possibility of nonoverlap faces being generated during intersection.
If parent faces are separated by more than this threshold (as a fraction of parent face edge length), they will not be intersected.
If an intersected face has an area magnitude smaller than this threshold (as a fraction of the parent area magnitude), it will be ignored.
Configure settings for iteration control.
Configure convergence criteria for residual, monitor, etc.
Set the frequency with which the radiation terms are updated as the continuous phase solution proceeds.
Set the maximum number of iterations of the radiation calculation during each global iteration.
Set the value to determine when the radiation intensity update is converged.
Configure realizable K-Epsilon model constants.
Set Effective Prandtl number for transport of the turbulent dissipation rate.
Set Effective Prandtl number for transport of Turbulence Kinetic energy, which defines the ratio of the momentum diffusivity to the diffusivity of turbulence kinetic energy via turbulent transport.
Configure standard k-Epsilon model constants.
Set constant in the equation of Standard k-epsilon turbulent flow.
Set constant in the equation of Standard k-epsilon turbulent flow.
Set Effective Prandtl number for transport of the turbulent dissipation rate.
Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of turbulence kinetic energy via turbulent transport.
Configure kOmega Mean Base Line (BSL) Model Constants.
Constant used in modeling the Turbulence Dissipation.
Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Turbulence Eddy Frequency (omega) condition.
Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Turbulence Eddy Frequency (omega) condition.
Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of turbulence kinetic energy via turbulent transport.
Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of turbulence kinetic energy via turbulent transport.
Configure K-Omega SST model constants.
Set to damp the turbulent viscosity causing a low-Reynolds number correction.
Constant used in the Turbulence Dissipation of omega for the SST k-omega Model.
Constant used in the Turbulence Dissipation of omega for the SST k-omega Model.
Constant used in modeling the Turbulence Dissipation of omega for the SST k-omega Model.
Constant used in modeling the Turbulence Dissipation of omega for the SST k-omega Model.
Set Effective Prandtl number for the transport of the specific dissipation rate inside the near-wall region.
Set Effective Prandtl number for the transport of the specific dissipation rate outside the near-wall region.
Set Effective Prandtl number for the transport of turbulence kinetic energy inside the near-wall region.
Set Effective Prandtl number for the transport of turbulence kinetic energy outside the near-wall region.
No details are provided for this entry.
Allows one to choose how the length scale is determined when using pseudo transient solution advancement.
Set the value of length scale. Useful in problems that have a specific length scale that is difficult to determine from overall geometry such as airfoil.
Allows to choose different length scale methods.
| Aggressive |
| Conservative |
| GeometricMean |
| UserSpecified |
Configure generic setting related to advanced solution controls.
Configure parameters that control the flexible multigrid cycle.
Configure linear solver settings for current equation.
Controls the amount of information that is printed out by the linear solver for monitoring purposes.
Configure mass flow specifications for the boundary.
Select option for mass flow specification.
| MassFlowRate |
| MassFlux |
Configure mass flow update options.
Set the gauge static pressure value at minimum radial location.
Specify the Lower Limit of Absolute Pressure.
Select option for mass flow update.
| ScaleMassFlows |
| ShiftPressure |
| UniformFlux |
Configure pressure averaging - allows the pressure along the outlet boundary to vary, but maintain an average equivalent.
Specify the Upper Limit of Absolute Pressure.
No details are provided for this entry.
Controls mesh check settings
context to be documented
| Basic |
| Full |
| None |
| Verbose |
No details are provided for this entry.
No details are provided for this entry.
Select method for non-iterative time advancement
Specify sub-iteration correction factor for non-iterative time advancement
Configure input fields for material properties that are required for active physical models.
Configure parameters for absorption coefficient in radiation heat transfer.
to be documented
context to be documented
| SourceDensity |
| TotalSource |
Set the reference frame for source terms.
Allows to specify the source components in different coordinate systems.
to be documented
context to be documented
| SourceDensity |
| TotalSource |
Set the reference frame for source terms.
Allows to specify the source components in different coordinate systems.
No details are provided for this entry.
No details are provided for this entry.
Set convergence criteria for monitors.
Set convergence criteria for monitors.
| MonitorTolerance |
| None |
Configure Monitor Frequency.
Allows to choose between different monitor frequency options.
| Iteration |
| None |
Set the monopole characteristics
Set the coordinates of reference pressure location.
context to be documented
| Off |
| On |
Configure moving wall in the model.
Allows to specify the velocity component in different coordinate system.
Allows to choose between Cartesian or cylindrical component to specify direction.
Configure moving wall in the model.
| Components |
| MagnitudeAndDirection |
| Rotating |
Set the multiphase model type.
to be documented
to be documented
to be documented
| Lagrangian |
context to be documented
| Dispersed |
Configure the near-wall treatment to be used for modeling turbulence.
Set this parameter to lower Reynolds Number near Wall Damping.
Allows to choose different methods for near wall treatment.
| LegacyFormulation |
| NonEquilibriumWallFunction |
| ScalableWallFunction |
| StandardWallFunction |
| yPlusInsensitive |
| yPlusInsensitiveMenterLechner |
| yPlusInsensitiveTwoLayer |
Allows one to choose to normalize residuals with respect to a residual at a particular iteration number.
Set the number of iterations for which largest residual will be searched to normalize by.
Allows whether or not to normalize residual for each variable.
| Automatic |
| None |
Select reference frame for total pressure
Specifies the maximum number of bands to use for the radial pressure profile evaluation.
Select total pressure reference frame among global and boundary frames.
| Automatic |
| SpecifiedMaximum |
Configure region wise numerics related controls.
Configure conversion of scalar transport equations to discrete algebraic equations
Configure region wise numerics related controls.
Configure conversion of scalar transport equations to discrete algebraic equations
Set boundary.
Set the reference frame for boundary from (physics region or all available reference frames).
Set different boundary type.
| Axis |
| Farfield |
| Inlet |
| Opening |
| Outlet |
| Solid |
| Symmetry |
| Wall |
Set the reference frame for total pressure and total temperature.
Sets the parameters related to operating conditions in the model.
Allows to choose between the fixed or floating operating pressure.
Sets location for reference pressure for operating conditions.
Allows to choose between the fixed or floating operating pressure.
Allows to choose between the fixed or floating operating pressure.
| Fixed |
| Floating |
Set boundary.
Set the reference frame for boundary from (physics region or all available reference frames).
Set different boundary type.
| Axis |
| Farfield |
| Inlet |
| Opening |
| Outlet |
| Solid |
| Symmetry |
| Wall |
Set the reference frame for total pressure and total temperature.
Define output controls.
Allows to choose between different persistence types.
| AllVariables |
Define output controls.
Allows to choose between different persistence types.
| AllVariables |
to be documented
context to be documented
| High |
| Iterations |
| Low |
| Medium |
| TimeInterval |
| TimeSteps |
Configure settings related to the hemicube and ray tracing methods for computing the view factors.
Set ratio of the minimum face separation to the effective diameter of the face.
to be documented
context to be documented
| ConstantDiameter |
| NormalDistribution |
| RosinRammlerDistribution |
| UniformDistribution |
to be documented
context to be documented
| Temperature |
to be documented
Allows to specify the flow direction in different coordinate system.
context to be documented
| MassFlowAndVelocity |
Configure velocity specifications for the boundary.
to be documented
to be documented
to be documented
to be documented
No details are provided for this entry.
Choose periodicity type.
context to be documented
| Rotational |
| Translational |
No details are provided for this entry.
No details are provided for this entry.
Create phase definition.
Specify the material behavior name.
Configure phase interactions.
Configure phase interactions between different phases.
Set the physics models.
Set the physics models.
Use physics weight for partition
context to be documented
| Off |
| On |
Set the areas within the geometry that you want to assign physical properties.
Set the physics region on interface.
Set the physics region on either side of interface.
configure to create matching or nonmatching interface.
Choose reference frame for region interface
Set the physics region on interface.
Set the physics region on either side of interface.
configure to create matching or nonmatching interface.
Choose reference frame for region interface
Set the physics type.
to be documented
| Fluid |
| Solid |
Controls whether mesh will be converted to polyhedra
Convert mesh to polyhedra.
| Convert |
| None |
No details are provided for this entry.
No details are provided for this entry.
to be documented
Set the inertial resistance coefficient value.
Specifies whether porous loss coefficients multiply superficial or physical velocity.
| Physical |
| Superficial |
Set the viscous resistance coefficient value (inverse permeability).
to be documented
Set the reference frame for source terms.
to be documented
Set the reference frame for source terms.
Configure pressure specifications for the boundary.
Set the gauge entrainment pressure value.
Set the gauge static pressure value at minimum radial location.
Sets the gauge total (or stagnation) pressure of the inflow stream.
Configure pressure averaging - allows the pressure along the outlet boundary to vary, but maintain an average equivalent.
Select pressure specification option.
| EntrainmentPressure |
| TotalPressure |
Configure pressure averaging - allows the pressure along the outlet boundary to vary, but maintain an average equivalent.
Select option for pressure averaging.
| Average |
| None |
Factor that blends between the specified pressure profile and a floating pressure profile. For a Pressure Profile Blend factor of zero the specified pressure is used only to enforce the average pressure.
Select how pressure is interpolated from cells to faces
See active pressure scheme
| BodyForceWeighted |
| FirstOrder |
| Linear |
| PRESTO |
| SecondOrder |
Allows to choose different methods to specify direction.
| Automatic |
| BodyForceWeighted |
| Expert |
| FirstOrder |
| Hybrid |
| Linear |
| PRESTO |
| SecondOrder |
Allows to choose different schemes for pressure-velocity coupling.
Specify sub-iteration correction factor for non-iterative time advancement
Allows to choose different schemes for pressure-velocity coupling.
| Coupled |
| PISO |
| SIMPLE |
| SIMPLEC |
Enables the SIMPLEC and PISO skewness correction for highly skewed meshes, if the value (number of iterations) is greater than 0.
Enables the PISO neighbor correction, which is recommended for transient calculations.
Configure to limit the production term in the turbulence equation.
Enable to limit the production term in the turbulence equation.
| Off |
| On |
Configure the parameter and constant for production setting.
Choose to set compressible production in the model.
| Off |
| On |
Choose from options to limit the production term in the turbulence equation.
| KatoLaunder |
| Standard |
Configure to limit the production term in the turbulence equation.
Configure radiation specifications for boundary.
When enabled, assumes the value of direct irradiation specify is parallel to beam direction.
Set beam width for an external semi-transparent wall in terms of the Theta and Phi extents.
Specify the fraction of the irradiation that is to be treated as diffuse.
Specify the value of the irradiation flux.
Specify the value of the irradiation flux.
Configure External Black Body Temperature, which allows to take into account the influence of the temperature of the gas and the walls beyond the inlet/exit boundaries.
sets the number of faces per surface cluster for the wall.
Specify the internal emissivity of the wall in each wavelength band.
Enable/Disable whether wall participates in the view factor calculation.
Specify transparency option.
| Opaque |
| SemiTransparent |
Set boundary.
Set the reference frame for boundary from (physics region or all available reference frames).
Set different boundary type.
| Axis |
| Farfield |
| Inlet |
| Opening |
| Outlet |
| Solid |
| Symmetry |
| Wall |
Set the reference frame for total pressure and total temperature.
Configure Radiation Model.
Configure parameters for angular discretization and pixelation for the DO mode.
Set Couples energy and DO (Discrete Ordinates) intensity equations at each cell.
Configure input fields for material properties that are required for active physical models.
Allows to choose between different radiation models.
| DiscreteOrdinates |
| Off |
| P1 |
| SurfaceToSurface |
Configure parameters for surface clusters and view factors calculation.
Configure options for specifying the viscous model.
Choose options for Boundary Layer Transition model.
| Intermittency |
| IntermittencyReTheta |
| None |
Include buoyancy effects in the turbulence model.
| Full |
| Off |
| ProductionOnly |
When enabled, modifies the turbulence production term to sensitize the standard eddy-viscosity models to the effects of streamline curvature and system rotation.
| Off |
| On |
Set Curvature Correction Coefficient.
Specifies turbulent flow to be calculated using the Detached Eddy Simulation model.
Configure KOmega BSL model constants.
Configure KOmega BSL model constants.
Configure k-e 1e Standard model constants.
Configure realizable K-Epsilon model constants.
Configure standard k-Epsilon model constants.
Configure kOmega Mean Base Line (BSL) Model Constants.
Configure K-Omega SST model constants.
Specifies whether corrections that improve the accuracy in predicting low Reynolds number flows should be included.
Configure the near-wall treatment to be used for modeling turbulence.
Allows to choose between different RANS models.
| EARSMRumseyGatskiKOmegaBSL |
| EARSMWallinJohanssonKOmegaBSL |
| RSMEpsilon |
| RSMOmega |
| SpalartAllmaras |
| kEpsilonRealizable |
| kEpsilonStandard |
| kOmegaBSL |
| kOmegaSST |
| ke1eStandard |
Configure the parameter and constant for production setting.
Configure Reynolds Stress Model-Epsilon constants.
Configure model constants in Omega Reynolds Stress Model.
Configure parameters for the turbulent flow to be calculated using the Spalart-Allmaras model.
Choose from the options whether the flow is vorticity based or Strain Vorticity based in Spalart-Allmaras model.
| StrainVorticityBased |
| VorticityBased |
Choose from the options to block either Turbulence Production or Turbulence Viscosity Production or None in DES Model.
| NoTurbulenceProduction |
| NoTurbulenceViscosityAndProduction |
| None |
Set the reference frame for initial condition.
Set the reference frame for initial condition.
| SpecifyFrame |
| UseFromPhysicsRegion |
Choose reference frame for region interface
Set the physics region of which reference frame to used.
Set the reference frame for source terms.
Set the reference frame for source terms.
| SpecifyFrame |
| UseFromPhysicsRegion |
Sets location for reference pressure for operating conditions.
Sets the coordinates value of reference pressure location.
Allows one to select where in your simulation the reference pressure is set.
| Automatic |
| CartesianCoordinates |
Set refractive index for the material.
Specify refractive index for the material.
Configure flow regime.
Select regime among mixed, subsonic and supersonic.
| Mixed |
| Subsonic |
| Supersonic |
No details are provided for this entry.
No details are provided for this entry.
No details are provided for this entry.
Configure settings to control residual information.
Allows one to choose to normalize residuals with respect to a residual at a particular iteration number.
Allows one to choose how control volume equation residuals are scaled so that they are dimensionless.
Configure convergence criteria for residuals.
Set default value of convergence criteria for residual.
Set convergence criteria for current equation.
Set default value of convergence criteria for residual.
Set default value of convergence criteria for residual.
| None |
| Tolerance |
Allows one to choose how control volume equation residuals are scaled so that they are dimensionless.
Allows to choose different options for local scaling of residuals.
| Maximum |
| RMS |
Allows one to choose different options for residuals scaling.
| GlobalScaling |
| LocalScaling |
| None |
Configure Reynolds stress model.
Set turbulent flow to be calculated using the RSM.
| Isotropic |
| RSMComponents |
Configure Reynolds Stress Model-Epsilon constants.
Set constant used in the transport equation for Epsilon.
Set constant used in the transport equation for Epsilon.
Set constant used in the transport equation for Epsilon.
Set Effective Prandtl number for transport of the turbulent dissipation rate.
Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of turbulence kinetic energy via turbulent transport.
Configure model constants in Omega Reynolds Stress Model.
Set coefficient used in the Production of Omega.
Set constant used in modeling the Turbulence Dissipation.
Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Turbulence Eddy Frequency (omega) condition.
Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of turbulence kinetic energy via turbulent transport.
Allows to choose between different sampling types.
context to be documented
| ByTime |
| ByTimeStep |
Configure scalar controls.
Configure parameters that control the V, W and F cycles.
Configure shear conditions at the wall.
Configure shear conditions at the wall
| Cartesian |
| Cylindrical |
Configure parameters related to the calculation of solar load models.
Configure the parameters to define the position of solar radiation.
Configure the orientation as the vectors for North and East.
Choose parameters of the solar irradiation method
| FairWeatherConditions |
| TheoreticalMaximum |
Set Sunshine Factor, which is linear reduction factor for the computed incident load that allows for cloud cover to be accounted
to be documented
context to be documented
| SourceDensity |
| TotalSource |
Set the reference frame for source terms.
Configure common solution parameters.
Allows to set the value of under-relaxation factors.
Configure relaxation of high order terms.
Configure generic setting related to advanced solution controls.
Configure generic settings for solution controls.
Configure generic settings for solution controls.
Configure bounds for solution fields
Specify positivity rate for rate of reduction of temperature
Specify upper bound for absolute pressure
Specify upper bound for turbulent viscosity ratio
Specify lower bound for absolute pressure
Specify lower bound for turbulent dissipation rate
Specify lower bound for turbulent eddy frequency
Specify lower bound for turbulent viscosity ratio
Specify positivity rate for temperature
Controls related to solver meshing
Controls whether mesh will be converted to polyhedra
Allows to specify the source components in different coordinate systems.
Allows to specify the source components in different coordinate system.
| Cartesian |
| Cylindrical |
Configure parameters for the turbulent flow to be calculated using the Spalart-Allmaras model.
Set the parameter to model the Turbulent Viscosity when strain/vorticity-based production option is used.
Set Prandtl number (ratio of momentum diffusivity to thermal diffusivity).
Configure interpolation of convection terms of quantities to control volumes
Method for computing cell gradients.
| Automatic |
| GreenGaussCellBased |
| GreenGaussNodeBased |
| H1CellBased |
| LeastSquaresCellBased |
Select how pressure is interpolated from cells to faces
Configure supported Spectral models.
Allows to choose between different spectral models.
| Gray |
| MultipleBands |
Choose Spectral Variable from the options.
| Frequency |
| WavelengthInVacuum |
| WavenumberInVacuum |
to be documented
to be documented
Allows to choose between different streamwise periodicity models.
Allows to choose between different energy periodicity models.
Allows to choose between different flow periodicity models.
Configure Stress Strain Model.
Allows to choose between different viscous and inviscid model.
| Inviscid |
| Viscous |
Set boundary.
Set the reference frame for boundary from (physics region or all available reference frames).
Set different boundary type.
| Axis |
| Farfield |
| Inlet |
| Opening |
| Outlet |
| Solid |
| Symmetry |
| Wall |
Set the reference frame for total pressure and total temperature.
Set boundary.
Set the reference frame for boundary from (physics region or all available reference frames).
Set different boundary type.
| Axis |
| Farfield |
| Inlet |
| Opening |
| Outlet |
| Solid |
| Symmetry |
| Wall |
Set the reference frame for total pressure and total temperature.
Set the reference frame for total pressure and total temperature.
Allows to choose different methods to specify direction.
| BoundaryFrame |
| GlobalFrame |
Configure integration of transient terms in governing equations
Specify default transient scheme
| BoundedSecondOrderBackwardEuler |
| FirstOrderBackwardEuler |
| FirstOrderExplicit |
| SecondOrderBackwardEuler |
| SecondOrderExplicit |
| TimeExplicit |
Configure transient scheme for an equation.
Specifies how the Damping layer must behave.
Choose between different time schemes
| CrankNicolson |
| FirstOrderBackwardEuler |
| FirstOrderExplicit |
| SecondOrderBackwardEuler |
| SecondOrderExplicit |
Set transmissivity parameters.
Specify diffuse hemispherical transmissivity.
Configure Turbulence initial conditions.
Allows to choose different methods to specify turbulence.
| Automatic |
| HighIntensityAndViscosityRatio |
| HighViscosityRatio |
| IntensityAndHydraulicDiameter |
| IntensityAndLengthScale |
| IntensityAndViscosityRatio |
| LowIntensityAndViscosityRatio |
| LowViscosityRatio |
| MediumIntensityAndViscosityRatio |
| MediumViscosityRatio |
| TransportVariables |
| ViscosityRatio |
Set values for the sub grid kinetic energy.
Set values for the turbulence kinetic energy.
Set turbulence related boundary conditions in the model.
Allows to choose different methods to specify direction.
| DefaultIntensityAndAutocomputeLengthScale |
| HighIntensityAndViscosityRatio |
| HighViscosityRatio |
| IntensityAndAutoComputeLength |
| IntensityAndHydraulicDiameter |
| IntensityAndLengthScale |
| IntensityAndViscosityRatio |
| LowIntensityAndViscosityRatio |
| LowViscosityRatio |
| MediumIntensityAndViscosityRatio |
| MediumViscosityRatio |
| TransportVariables |
| ViscosityRatio |
| kAndEddyViscosityRatio |
| kAndLengthScale |
Choose option, for Synthetic Inflow Turbulence
| HarmonicTurbulenceGenerator |
| NoPerturbations |
| RandomPerturbations |
| SpectralSynthesizer |
| VortexMethod |
Set values for the turbulence kinetic energy.
Configure inputs for defining wall roughness in turbulent calculations.
Configure Energy Model for turbulence interaction.
Incorporate near wall treatment for energy interaction model.
Enable to incorporate near-wall treatment for energy interaction model.
Set turbulence energy interaction constants.
Configure Turbulence Model.
Enable/disable Low Pressure Boundary slip condition; default value is False.
Allows to choose between different turbulence models.
| DetachedEddySimulation |
| DirectNumericalSimulation |
| Laminar |
| LargeEddySimulation |
| ReynoldsAveragedNS |
| ScaleAdaptiveSimulation |
Configure species model for turbulence interaction.
Set turbulence species interaction constants.
Allows to choose between different statistic types.
context to be documented
| Full |
| ScaleResolvingSimulation |
| UserSpecified |
Statistics type.
| MAX |
| MEAN |
| MIN |
| RMS |
| VAR |
Statistics type.
| ParticleVolumeFraction |
| Pressure |
| SurfaceShearStress |
| TurbulenceIntermittency |
| TurbulenceKineticEnergy |
| TurbulenceViscosityRatio |
| Velocity |
Create user defined convergence.
Allows to specify user defined convergence.
| LogicalExpression |
| None |
Allows to specify the velocity direction in different coordinate system.
Set the velocity component in Cartesian coordinate system.
Set the velocity component in cylindrical coordinate system.
Allows to choose between cartesian and cylindrical coordinate system.
| CartesianComponents |
| CylindricalComponents |
Configure velocity specifications for the boundary.
Allows to specify the velocity component in different coordinate system.
Select option for velocity specification.
| Components |
| MagnitudeAndDirection |
Configure velocity specifications for the boundary.
Set the velocity component in Cartesian coordinate system.
Select option for velocity specification.
| Cartesian |
| MagnitudeAndDirection |
| ZeroSlip |
Configure settings for computing the view factors.
Set how surfaces are defined for calculation of view factor.
| ClusterToCluster |
| FaceToFace |
Set method for computing view factors.
| Hemicube |
| RayTracing |
Configure settings related to the hemicube and ray tracing methods for computing the view factors.
Set Surface, the geometric orientation of surface pairs with respect to each other when using hemicube method.
| Blocking |
| NonBlocking |
Configure parameters for surface clusters and view factors calculation.
Configure options related to the modeling of reacting flow.
Allows to choose between different volumetric reaction definitions.
| EddyDissipation |
| FiniteRateEddyDissipation |
| LaminarFiniteRate |
| Off |
Set boundary.
Set the reference frame for boundary from (physics region or all available reference frames).
Set different boundary type.
| Axis |
| Farfield |
| Inlet |
| Opening |
| Outlet |
| Solid |
| Symmetry |
| Wall |
Set the reference frame for total pressure and total temperature.
Configure inputs for defining wall roughness in turbulent calculations.
Configure inputs for defining wall roughness in turbulent calculations.
| Rough |
| Smooth |
Allows to choose between zero thickness wall or thick wall.
Allows to choose different methods to specify direction.
| ZeroThickness |
No details are provided for this entry.
No Properties.
No details are provided for this entry.
No Properties.
A bolt pretension can be used to model a bolt which is holding together two bodies. It can be used to apply a known value of axial load or adjustment (the length which has reduced by screw tightening) to the bolt.
Select the separation surface normal : X, Y or Z axis of the selected reference frame.
Choose how the separation surface is selected : Program controlled or user defined It can be user defined only if a volume is selected. Otherwise it has to be program controlled.
Select a face or an edge to interpret the axial direction of the bolt.
Choose how the bolt is defined : Axial force or Adjustment
Choose how many bolts should be created if multiple volumes are selected : One for all selected volumes or one per selected volume.
BoundaryCondition is the abstraction over load and constraints.
This class represents the properties of a bushing joint connection between two locations. It is added to a JointBehavior if joint type is set as bushing.
No Properties.
A class that holds calculation time of transient analysis.
This is a class that is meant to define different kinds of connections like Contact, Joint, Spring, Beam etc. via one of its behaviors when set Non creatable by a user.
It displays the contact behavior referenced by this connection.
It tells if this connection was created automatically by the program or created manually by the user
This is the first location of the connection. For contact, this normally refers to the source of the contact.
It displays the bodies of the entities referenced in Location 1 of the connection.
This is the second location of the connection. For contact, this normally refers to the target of the contact.
It displays the bodies of the entities referenced in Location 2 of the connection.
ConnectionBehavior is an abstraction over all kinds of connection behaviors such as JointBehavior, BeamBehavior, LinkBehavior, SpringBehavior and ContactBehavior.
No Properties.
This class represents the connection confidence percentage data. It get run-time added to an automatic generated contacts whne the generate confidence setting is turned on.
Show the confidence level for the automatic generated connections
Constraint is an abstraction over all the boundary condtions that provide known values and does not require solution for a given location in the model such as Supports, Displacements, Rotations etc.
This is a class that is meant to define Contact
It displays the contact behavior referenced by this connection.
It tells if this connection was created automatically by the program or created manually by the user
This is the first location of the connection. For contact, this normally refers to the source of the contact.
It displays the bodies of the entities referenced in Location 1 of the connection.
This is the second location of the connection. For contact, this normally refers to the target of the contact.
It displays the bodies of the entities referenced in Location 2 of the connection.
ContactBehavior is ConnectionBehavior to model various kinds of contact behaviors available from Mechanical Solvers such as contact types and their formulations.
Type of contact for eg. Bonded, Frictional, Frictionless, etc.
This class represents the contact damping settings. It get run-time added to a non linear structural contact.
Damping scaling factor along the normal direction to reduce the risk of rigid body motion
Damping scaling factor along the tangential direction to reduce the risk of rigid body motion
This is a class resposible for applying the rules of contact detection
Property for setting the preference for face to edge or edge to face detection between bodies or parts
Property for setting the preference for face to face detection between bodies or parts
Property for setting the preference for detecting contact between bodies, or between bodies of different parts
Property for setting the priority for contact detection. Face override means priority is set for Face to Face -> Face to Edge -> Edge to Edge Edge override means priority is set for Edge to Edge -> Edge to Face -> Face to Face
Property for minimum gap between bodies, to register a contact detection
ContactDetectionDirection is a class to change the normals on shell bodies for contact connections as available from MAPDL solver
Switch to turn on to reverse the contact search direction for location 1
Switch to turn on to reverse the contact search direction for location 2
This is a class resposible for setting elastic slip tolerance at the contact interface.
This propertry decides whether it should use program controlled value or a manually entered factor or value.
This class represents the heat generation due to friction or current
It represents the fraction of frictional dissipated energy converted into heat. It varies from 0 to 1. For an input of true 0, you must enter a very small value (for example, 1E-8).
It represents the weight factor for the distribution of heat between the contact and target surfaces.
This class represents the interface gap adjustment settings. It gets run-time added to Contact and enabled as the contact type becomes frictional, rough, frictionless
Defines how the contact interface of a contact pair is treated.
Defines the contact offset value. A positive value moves the contact closer together and a negative value moves the contact further apart.
This is a class resposible for setting penetration tolerance at the contact interface.
This propertry decides whether it should use program controlled value or a manually entered factor or value.
This is a class resposible for setting pinball value for contact detection.
This propertry decides whether it should use program controlled value or a manually entered factor or value.
This class defines contact properties that can change per contact pair such as Symmetry Behavior etc. as exposed by Mechanical solvers.
Switch to turn on symmetric contact - Additional contact pair will be generated by swapping Location 1 and Location 2
This class represents the various behavior of contact stiffness
Option to set the frequency of updating stifness
This is the base class for pinball, penetration tolerance and the slip tolerance.
This propertry decides whether it should use program controlled value or a manually entered factor or value.
Convection is a Scalar Load to precribe a given value of heat flux at a given location in a model in thermal solutions.
Field variables of the spatial variation expression are defined with respect to this reference frame.
Current is a Scalar Load to precribe a given value of current at a given location in a model in electric solutions.
Field variables of the spatial variation expression are defined with respect to this reference frame.
This class represents the properties of a cylindrical joint connection between two locations. It is added to a JointBehavior if joint type is set as cylindrical.
No Properties.
Displacement is a Vector Constraint used to prescribe a given value of displacement at a given location in the model
This property sets the type of displacement whether it is applied directly or remotely via an originating point
This property sets the type of displacement whether it is translation only or a combo of translation and rotation.
No details are provided for this entry.
This property sets the type of vector specification which could be by Components or MagnitudeAndDirection or NormalToSurface.
Vector components or direction has been specified with respect to this reference frame.
This class represents the eletric conductance at the contact interface. It gets added when selected physics includes electric and formulation is not MPC.
Switch to use program controlled conductance value or enter value.
This is a class that creates an equal voltage on the selection applied.
This is a class that contains the various settings pertaining to Fatigue analysis
Select the type of approach used for fatigue analysis i.e. Stress life or Strain life
Specify how mean stress effects are handled for Strain life fatigue
Specify the maximum life for strain life to avoid skewed contour plots showing very high lives
Select the type of applied constant amplitude loading based on the loading ratio
Specify how mean stress effects are handled for Stress life fatigue
Specify the Ultimate Strength for all materials in the model
Specify the life units used to display fatigue life results
Specify the Yield Strength for all materials in the model
/// Displays the units chosen for Fatigue life and design life.
This class represents the properties of a fixed joint connection between two locations. It is added to a JointBehavior if joint type is set as fixed.
No Properties.
Force is a Vector Load to prescribe external force to a given model at a given location.
Property to control if the force is applied remotely via an originating point or directly.
Property to specify if the applied force value is total force or the force per unit area of the selected surface location.
This class represents only general joint specific settings. It get run-time added to Joint as the joint type is general
No Properties.
This class represents the properties of a general joint connection between two locations. It is added to a JointBehavior if joint type is set as general.
It controls the behavior of rotational DOFs of a general joint
This is a class that is meant to define ground location
The selected location: evaluates to a set of reference ids. See LocationSet for more detail.
Heat Flow is a Scalar Load to precribe a given value of heat flow at a given location in a model in thermal solutions.
Field variables of the spatial variation expression are defined with respect to this reference frame.
Heat Flux is a Scalar Load to precribe a given value of heat flux at a given location in a model in thermal solutions.
Field variables of the spatial variation expression are defined with respect to this reference frame.
Heat Generation is a Scalar Load to prescribe a uniform generation rate internal to a body.
Field variables of the spatial variation expression are defined with respect to this reference frame.
This class represents the properties of a hinge joint connection between two locations. It is added to a JointBehavior if joint type is set as hinge.
No Properties.
InertiaLoad is a Vector Load experienced by a body by the virtue of being in an accelerated reference frame due to its mass properties. It can be prescribed via an Acceleration, Angular Velocity or Angular Acceleration at a given location in the model.
Load Type of Inertia Load such as Acceleration, Angular Velocity or Angular Acceleration.
Initial conditions is the abstraction over all kinds of initial conditions.
This class shows the two reference frames selected for two locations of a joint connection. It is added to a connection if joint behavior is selected.
This class specifes the initial values of the temperature
InterfaceGenerator is class to define various settings for detection of Interface Conditions such a contacts.
It allows you to create one contact behavior and share it or create separate ones for each one of searched interfaces.
Set the detection types for generating the interfaces
It allows to let either program decides the tolerance value for you or you choose to input your own tolerance value
Type of inerfaces to be generated. Select from Contact, Joint and Mesh Interface.
This is a class that is meant to define different kinds of Joint
It displays the contact behavior referenced by this connection.
It tells if this connection was created automatically by the program or created manually by the user
This is the first location of the connection. For contact, this normally refers to the source of the contact.
It displays the bodies of the entities referenced in Location 1 of the connection.
This is the second location of the connection. For contact, this normally refers to the target of the contact.
It displays the bodies of the entities referenced in Location 2 of the connection.
JointBehavior is a ConnectionBehavior that models joint connection between two locations.
Joint type such as fixed, hinge, slot, translational, cylindrical, planar, etc.
This is the base class for all joint types (fixed, hinge, cylindrical, general, etc.)
No Properties.
LaunchSettings is a class that allows defining solver launch controls such as Solver file directory, various solver input file names as exposed by MAPDL solver.
A name for auxiliary solver input file which contains all nodal and elemental components created in MAPDL solution.
A name for auxiliary solver input file which contains all connection elements in MAPDL solution.
Activate Contact Pair Output in MAPDL solution.
Override to keep all solver generated files in MAPDL solution.
A name for master solver input file which assembles all other auxiliary input files (MeshDataFileName, ComponentDataFileName, etc.) for MAPDL Solver.
A name for auxiliary solver input file which contains all load elements in MAPDL solution.
A name for auxiliary solver input file which contains all mesh information(nodes and elements) for all participating bodies in MAPDL solution.
Number of Processors to use for distributed solution in MAPDL solver.
Solver Files Directory where solution happens for MAPDL solver.
Run the solver in batch mode just while solving or keep it live.
Load is Boudary Condition to prescribe external load to a given location in a model. It is an abstraction over scalar and vector loads.
MechanicalPhysicsOptions is a class that represents various ways through which a physics option can be applied to bodies. For example various stress states to be analyzed such as 3DStress State, Plane Stress, Plane Strain, Axisymmetric, etc.
For Rigid bodies, control to model them using a single Inertial Frame or individual ones
Moment is a vector load to prescribe an external moment load to a given location in a model.
OptimizationConstraint is a base class for all optimization constraint classes
No Properties.
OutputControls is a class that specifes the list of output specifications(such as Deformation, Stress, Strain) to control the "what" goes in result file. It also controls "how frequently" results are stored.
No Properties.
This class represents the properties of a planar joint connection between two locations. It is added to a JointBehavior if joint type is set as planar.
No Properties.
Pressure is a scalar load to prescribe an external pressure to a given location(face or element faces) in a model always in a direction normal to the location surface.
Field variables of the pressure spatial variation expression are defined with respect to this reference frame.
It denotes the tolerance upto which nodes below the separation surface are considered to be above the surface. It has an affect of shifting separation surface downwards by this distance.
Choose how pretension tolerance is defined : Program controlled or Manual
Radiation is a scalar load to prescribe an external Radiation to a given location in a model.
Field variables of the spatial variation expression are defined with respect to this reference frame.
This extension is added to boundary condition when it is applied remotely via an originating point.
ScalarConstraint is abstraction over constraints that are scalar by nature such as temperature in thermal solutions or voltage in electric solutions
This is used by scalar initial conditions.
ScalarLoad is abstraction over loads that are scalar by nature such as pressure Radiation etc.
This class represents the properties of a slot joint connection between two locations. It is added to a JointBehavior if joint type is set as slot.
No Properties.
SolidModelingOptions is a class that encapsulates various advanced solver element formulations available to users. Normally an end user never deals with them as solver defaults are good enough, but we do offer a scheme to override it.
IntegrationType of elements used by solvers such as Full or Reduced.
This class represents the properties of a spherical joint connection between two locations. It is added to a JointBehavior if joint type is set as spherical.
No Properties.
Support is a constraint to precribe zero values to active degrees of freedom for a given model at a given location.
Degrees of freedom are defined with respect to this reference frame.
Temperature Condition is scalar load to prescribe temperature to a given location(bodies or elements) in a model in pure structural solutions.
Field variables of the spatial variation expression are defined with respect to this reference frame.
Temperature Constraint is a scalar constraint to precribe known value of temperature in solutions that suppport thermal degrees of freedom.
This class represents the thermal conductance at the contact interface. It gets added when selected physics includes thermal and formulation is not MPC.
Switch to use program controlled conductance value or enter value.
This class represents the properties of a translational joint connection between two locations. It is added to a JointBehavior if joint type is set as translational.
No Properties.
No details are provided for this entry.
Degrees of freedom are defined with respect to this reference frame.
This class represents the properties of a universal joint connection between two locations. It is added to a JointBehavior if joint type is set as universal.
No Properties.
This class is used only for initialization purposes if joint type is unknown.
No Properties.
Vector is class used by all Boundary Conditions and Connection that support a Vector Behavior.
This property sets the type of vector specification which could be by Components or MagnitudeAndDirection or NormalToSurface.
Vector components or direction has been specified with respect to this reference frame.
VectorByComponents is class to define a vector by Components.
The type of coordinate system to be used which could be Cartesian or Cylindrical or Spherical.
Vector components has been specified with respect to this reference frame.
ByGeometry is class to define a vector using geometry.
VectorByMagnitudeAndDirection is class to define a vector by magnitude and direction.
User can select a geometric entity for this property which will be used to infer a direction for the vector.
This property can be used to reverse the direction which is inferred from the geometric selection.
A Vector Constraint is constraint that has an underneath vectors like Displacement, Velocity etc
Initial conditions is the abstraction over all kinds of vector initial conditions.
VectorLoad is an abstraction over loads that are vector by nature such as Force, Moment, Traction etc.
Voltage is a scalar constraint to precribe known value of voltage in solutions that suppport electric degrees of freedom.
No details are provided for this entry.
No Properties.
No details are provided for this entry.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
No details are provided for this entry.
No details are provided for this entry.
No Properties.
No details are provided for this entry.
No Properties.
No details are provided for this entry.
No details are provided for this entry.
No details are provided for this entry.
No details are provided for this entry.
No details are provided for this entry.
No details are provided for this entry.
No details are provided for this entry.
No details are provided for this entry.
No details are provided for this entry.
No details are provided for this entry.
No details are provided for this entry.
No details are provided for this entry.
No details are provided for this entry.
No details are provided for this entry.
No details are provided for this entry.
No details are provided for this entry.
No details are provided for this entry.
No details are provided for this entry.
No details are provided for this entry.
No details are provided for this entry.
No details are provided for this entry.
No details are provided for this entry.
AdditionalConvergenceControls is a Solver Settings class that allows defining nonlinear controls such as line search, predictor etc. as exposed by MAPDL solver.
Choose number of equilibrium iterations for non-linear solution in MAPDL solver.
Choose equilibrium iterations keys for non-linear solution in MAPDL solver.
Activate Line Search for non-linear solution in MAPDL solver.
Activate Predictor for non-linear solution in MAPDL solver.
ContactFormulation is a class to represents various contact formulations as available from MAPDL solver
A flag to notify the program if auto-asymmetry should be used in the physics solution.
Specify the location of contact detection to be used in the analysis in order to obtain a good convergence.
Set the contact formulation to be used by the solver for a particular contact pair.
Switch to include shell thickness or not in the contact analysis
Method for selecting the physics type: Program controlled or Manual
Specified physics type(s) for the contact formulation
ConvergenceControl is Solver Settings class that allows defining various non-linear convergence techniques as exposed by MAPDL solver such as CNVTOL command.
An enumeration to turn on, off Convergence Controls as available from MAPDL solver.
Convergence minimum reference value defined for a given Convergence Control as available from MAPDL solver.
Convergence value defined for a given Convergence Control as available from MAPDL solver.
Method for selecting the specification type: Program controlled or Manual
Convergence tolerance value defined for a given Convergence Control as available from MAPDL solver.
ConvergenceCriterias is a Solution Progression class that allows defining convergence controls as exposed by MAPDL solver.
No Properties.
GeneralNonLinearControls is Solver Settings class that allows defining some general nonlinear techniques such as large deflection or Newton Raphson Methods as exposed by MAPDL solver.
An enumeration to select various Newton Raphson Methods as available from MAPDL solver.
GeneralSolutionControls is Solver Settings class that allows defining some general solution controls such as unit sytems, Equation solver types etc. as exposed by MAPDL solver.
Activate search to a given range of frequencies for frequency domain solutions as available from MAPDL solver.
Equation Solver Types as available from MAPDL solver.
Maximum modes to find for modal solutions as available from MAPDL solver.
A value of maximum frequency for frequency domain solutions with a given range as available from MAPDL solver.
A value of minimum frequency for frequency domain solutions with a given range as available from MAPDL solver.
An enumeration for damped modal solver types as available from MAPDL solver.
MapdlFixedJoint is a class to represents Fixed Joint Connection Behavior as available from MAPDL solver
JointFormulation types used by Mapdl Fixed Joint Connection Behavior
ReductionMethod used by Mapdl Fixed Joint Connection Behavior
This is a class that implements MAPDL expressions like AllContacts(), AllJoints() etc.
The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.
No details are provided for this entry.
No details are provided for this entry.
OutputSpecification is a class that defines each individual item that can be controlled to be stored in a result file such as Deformation, Stress or Strain.
Frequency of OutputSpecification, how often a given output type is written to result file
OutputType for OutputSpecification such as Deformation, Stress or Strain
OutputSpecifications is a class that is repository of individual OutputSpecification such as Deformation, Stress or Strain.
No Properties.
Stabilization is a class that allows defining Stablization parameters for nonlinear solutions as exposed by MAPDL solver.
Activate various Stabilization Keys in MAPDL Solution.
TimeStepOptions is a Solver Settings class that help define the time step controls available in MAPDL solver.
Define Auto Time Stepping by Time or Substeps as available in MAPDL solver.
When defining auto time stepping by substeps, define Initial Substeps as available in MAPDL solver.
When defining auto time stepping by time steps, define Initial Time Step as available in MAPDL solver.
When defining auto time stepping by substeps, define Maximum Substeps as available in MAPDL solver.
When defining auto time stepping by time steps, define Maximum Time Step as available in MAPDL solver.
When defining auto time stepping by substeps, define Minimum Substeps as available in MAPDL solver.
When defining auto time stepping by time steps, define Minimum Time Step as available in MAPDL solver.
When auto time stepping is off define number of substeps as available in MAPDL solver.
Define Substepping options such as specified range, fixed number or program controlled as available in MAPDL solver.
Turn on or off Time Integration for inertia effects as available in MAPDL solver.
When auto time stepping is off define time steps as available in MAPDL solver.
TrimOptimization is a class to represents various trimming options available for contact connection.
Trim Type to control trimming such as keeping it on, off or Program Controllled.
ZeroThermalStrainTemperature is a class that hold temperature at zero thermal strain.
to be documented
to be documented
No details are provided for this entry.