Study

Study
This container holds Study data for an instance of Study.

Common Methods

CreateDataManager

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.
    Type     DataReference

Optional Arguments

Provider    The management provider for the requested Source of data. The provider understands how to convert the data in the sources to AIM.
    Type     string
    Default Value    ANSYS
Sources    The source of the data which will be managed by the Data Manager. If this argument is not provided the Source must be set or provided before the Data Manager is used.
    Type     List<string>
Example

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")


CreateEntity

Create AIM objects of the requested Type.

Return     An instance of the Type.
    Type     DataReference

Required Arguments

Type    The entity Type to create. The entity Type can be seen in the GUI by hovering over the entity's object icon. Also using dir(Study) will show object types for Get<Type> queries, for which the <Type> may be able to be created.
    Type     string

Optional Arguments

AssociatedObject    The object to associate this object to in the AIM dependency graph, which will create a directed edge in the AIM dependency graph. See discussion on Study and Tasks. This is deprecated in favor of Association.
    Type     DataReference
Association    The object to associate this object to in the AIM dependency graph, which will create a directed edge in the AIM dependency graph. See discussion on Study and Tasks.
    Type     DataReference
Location    If the entity has a location property, this will set the property to the provided LocationSet.
    Type     Object
    Default Value    Ansys.Study.Core.Common.Referencing.LocationSet
Location2    If the entity has a second location property, this will set the property to the provided LocationSet.
    Type     Object
    Default Value    Ansys.Study.Core.Common.Referencing.LocationSet
LocationWithHitPoints    If the entity has a location property with hit points, this will set the property to the provided LocationSet.
    Type     Object
    Default Value    Ansys.Study.Core.Common.Referencing.LocationSet
LocationWithHitPoints2    If the entity has a second location property with hit points, this will set the property to the provided LocationSet.
    Type     Object
    Default Value    Ansys.Study.Core.Common.Referencing.LocationSet
ObjectReferences    Future use
    Type     DataReferenceSet
Example

    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

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.
    Type    DataReference

Required Arguments

Columns    A List of tuple (name and physical quantity). The name is used to identify the column and must be unique to this table. The physical quantity (e.g. Density, Pressure, etc.) is used to verify the data has the correct units. The use of integer indexes in other table related commands correspond to the order of the columns, with 0 (zero) being the first item.
    Type    List<List<string>>
Parent    The DataReference of the object to which this table should be created in the scope of
    Type    DataReference
Example

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()


GetAEMLaunchControls

Obtains a AEMLaunchControls instance by name from the supplied container.

Return     The AEMLaunchControls instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetAFDPhysicsOptions

Obtains a AFDPhysicsOptions instance by name from the supplied container.

Return     The AFDPhysicsOptions instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetBodyTemperature

Obtains a BodyTemperature instance by name from the supplied container.

Return     The BodyTemperature instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetBoltPretension

Obtains a BoltPretension instance by name from the supplied container.

Return     The BoltPretension instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetBoundary

Obtains a Boundary instance by name from the supplied container.

Return     The Boundary instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetBoundaryCondition

Obtains a BoundaryCondition instance by name from the supplied container.

Return     The BoundaryCondition instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetCappingSurface

Obtains a CappingSurface instance by name from the supplied container.

Return     The CappingSurface instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetConditionGroup

Obtains a ConditionGroup instance by name from the supplied container.

Return     The ConditionGroup instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetConfiguration

Obtains a Configuration instance by name from the supplied container.

Return     The Configuration instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetConnection

Obtains a Connection instance by name from the supplied container.

Return     The Connection instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetConnectionBehavior

Obtains a ConnectionBehavior instance by name from the supplied container.

Return     The ConnectionBehavior instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetConstraint

Obtains a Constraint instance by name from the supplied container.

Return     The Constraint instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetContact

Obtains a Contact instance by name from the supplied container.

Return     The Contact instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetContactBehavior

Obtains a ContactBehavior instance by name from the supplied container.

Return     The ContactBehavior instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetContactDetection

Obtains a ContactDetection instance by name from the supplied container.

Return     The ContactDetection instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetContourResult

Obtains a ContourResult instance by name from the supplied container.

Return     The ContourResult instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetConvection

Obtains a Convection instance by name from the supplied container.

Return     The Convection instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetCoreLossComputation

Obtains a CoreLossComputation instance by name from the supplied container.

Return     The CoreLossComputation instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetCurrent

Obtains a Current instance by name from the supplied container.

Return     The Current instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetDisplacement

Obtains a Displacement instance by name from the supplied container.

Return     The Displacement instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetEddyEffectComputation

Obtains a EddyEffectComputation instance by name from the supplied container.

Return     The EddyEffectComputation instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetEquipotential

Obtains a Equipotential instance by name from the supplied container.

Return     The Equipotential instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetFatigueSettings

Obtains a FatigueSettings instance by name from the supplied container.

Return     The FatigueSettings instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetFluidBoundary

Obtains a FluidBoundary instance by name from the supplied container.

Return     The FluidBoundary instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetForce

Obtains a Force instance by name from the supplied container.

Return     The Force instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetForceComputation

Obtains a ForceComputation instance by name from the supplied container.

Return     The ForceComputation instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetGeneralPhysicsOptions

Obtains a GeneralPhysicsOptions instance by name from the supplied container.

Return     The GeneralPhysicsOptions instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetGeometryImportSource

Obtains a GeometryImportSource instance by name from the supplied container.

Return     The GeometryImportSource instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetGravityDefinition

Obtains a GravityDefinition instance by name from the supplied container.

Return     The GravityDefinition instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetGroundLocation

Obtains a GroundLocation instance by name from the supplied container.

Return     The GroundLocation instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetHeatFlow

Obtains a HeatFlow instance by name from the supplied container.

Return     The HeatFlow instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetHeatFlux

Obtains a HeatFlux instance by name from the supplied container.

Return     The HeatFlux instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetHeatGeneration

Obtains a HeatGeneration instance by name from the supplied container.

Return     The HeatGeneration instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetHeatSource

Obtains a HeatSource instance by name from the supplied container.

Return     The HeatSource instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetHeatSrc

Obtains a HeatSrc instance by name from the supplied container.

Return     The HeatSrc instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetImport

Obtains a Import instance by name from the supplied container.

Return     The Import instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetInertiaLoad

Obtains a InertiaLoad instance by name from the supplied container.

Return     The InertiaLoad instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetInitialCondition

Obtains a InitialCondition instance by name from the supplied container.

Return     The InitialCondition instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetInitialConditions

Obtains a InitialConditions instance by name from the supplied container.

Return     The InitialConditions instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetInitialTemperature

Obtains a InitialTemperature instance by name from the supplied container.

Return     The InitialTemperature instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetInsulating

Obtains a Insulating instance by name from the supplied container.

Return     The Insulating instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetInterfaceGenerator

Obtains a InterfaceGenerator instance by name from the supplied container.

Return     The InterfaceGenerator instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetIsoSurface

Obtains a IsoSurface instance by name from the supplied container.

Return     The IsoSurface instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetJoint

Obtains a Joint instance by name from the supplied container.

Return     The Joint instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetJointBehavior

Obtains a JointBehavior instance by name from the supplied container.

Return     The JointBehavior instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetLaunchSettings

Obtains a LaunchSettings instance by name from the supplied container.

Return     The LaunchSettings instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetLoad

Obtains a Load instance by name from the supplied container.

Return     The Load instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetMaterial

Obtains a Material instance by name from the supplied container.

Return     The Material instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetMaterialAssignment

Obtains a MaterialAssignment instance by name from the supplied container.

Return     The MaterialAssignment instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetMaterialAtState

Obtains a MaterialAtState instance by name from the supplied container.

Return     The MaterialAtState instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetMechanicalPhysicsOptions

Obtains a MechanicalPhysicsOptions instance by name from the supplied container.

Return     The MechanicalPhysicsOptions instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetMesh

Obtains a Mesh instance by name from the supplied container.

Return     The Mesh instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetMeshControl

Obtains a MeshControl instance by name from the supplied container.

Return     The MeshControl instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetMeshControlBodySizing

Obtains a MeshControlBodySizing instance by name from the supplied container.

Return     The MeshControlBodySizing instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetMeshControlEdgeSizing

Obtains a MeshControlEdgeSizing instance by name from the supplied container.

Return     The MeshControlEdgeSizing instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetMeshControlElementShape

Obtains a MeshControlElementShape instance by name from the supplied container.

Return     The MeshControlElementShape instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetMeshControlFaceSizing

Obtains a MeshControlFaceSizing instance by name from the supplied container.

Return     The MeshControlFaceSizing instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetMeshControlLocalBoundaryLayer

Obtains a MeshControlLocalBoundaryLayer instance by name from the supplied container.

Return     The MeshControlLocalBoundaryLayer instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetMeshDiagnostics

Obtains a MeshDiagnostics instance by name from the supplied container.

Return     The MeshDiagnostics instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetMeshing

Obtains a Meshing instance by name from the supplied container.

Return     The Meshing instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetMeshModeling

Obtains a MeshModeling instance by name from the supplied container.

Return     The MeshModeling instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetModeling

Obtains a Modeling instance by name from the supplied container.

Return     The Modeling instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetModelingImportSource

Obtains a ModelingImportSource instance by name from the supplied container.

Return     The ModelingImportSource instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetMoment

Obtains a Moment instance by name from the supplied container.

Return     The Moment instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetMomentumSource

Obtains a MomentumSource instance by name from the supplied container.

Return     The MomentumSource instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetMomentumSrc

Obtains a MomentumSrc instance by name from the supplied container.

Return     The MomentumSrc instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetMonitorChart

Obtains a MonitorChart instance by name from the supplied container.

Return     The MonitorChart instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetMoveRotateControl

Obtains a MoveRotateControl instance by name from the supplied container.

Return     The MoveRotateControl instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetNumericalControls

Obtains a NumericalControls instance by name from the supplied container.

Return     The NumericalControls instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetOptimizationConstraint

Obtains a OptimizationConstraint instance by name from the supplied container.

Return     The OptimizationConstraint instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetOutputControl

Obtains a OutputControl instance by name from the supplied container.

Return     The OutputControl instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetOutputControls

Obtains a OutputControls instance by name from the supplied container.

Return     The OutputControls instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetParticleInjection

Obtains a ParticleInjection instance by name from the supplied container.

Return     The ParticleInjection instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPhysicsCoupling

Obtains a PhysicsCoupling instance by name from the supplied container.

Return     The PhysicsCoupling instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPhysicsDefinition

Obtains a PhysicsDefinition instance by name from the supplied container.

Return     The PhysicsDefinition instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPhysicsOptions

Obtains a PhysicsOptions instance by name from the supplied container.

Return     The PhysicsOptions instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPhysicsRegion

Obtains a PhysicsRegion instance by name from the supplied container.

Return     The PhysicsRegion instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPlane

Obtains a Plane instance by name from the supplied container.

Return     The Plane instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPoint

Obtains a Point instance by name from the supplied container.

Return     The Point instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPolyflowCondition

Obtains a PolyflowCondition instance by name from the supplied container.

Return     The PolyflowCondition instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPolyflowConvection

Obtains a PolyflowConvection instance by name from the supplied container.

Return     The PolyflowConvection instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPolyflowDieDeformation

Obtains a PolyflowDieDeformation instance by name from the supplied container.

Return     The PolyflowDieDeformation instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPolyflowFluidSolidInterfaceBehavior

Obtains a PolyflowFluidSolidInterfaceBehavior instance by name from the supplied container.

Return     The PolyflowFluidSolidInterfaceBehavior instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPolyflowFreejetExit

Obtains a PolyflowFreejetExit instance by name from the supplied container.

Return     The PolyflowFreejetExit instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPolyflowFreeSurface

Obtains a PolyflowFreeSurface instance by name from the supplied container.

Return     The PolyflowFreeSurface instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPolyflowHeatFlux

Obtains a PolyflowHeatFlux instance by name from the supplied container.

Return     The PolyflowHeatFlux instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPolyflowInflow

Obtains a PolyflowInflow instance by name from the supplied container.

Return     The PolyflowInflow instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPolyflowInitialTemperature

Obtains a PolyflowInitialTemperature instance by name from the supplied container.

Return     The PolyflowInitialTemperature instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPolyflowInsulated

Obtains a PolyflowInsulated instance by name from the supplied container.

Return     The PolyflowInsulated instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPolyflowLaunchControls

Obtains a PolyflowLaunchControls instance by name from the supplied container.

Return     The PolyflowLaunchControls instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPolyflowNumericalControls

Obtains a PolyflowNumericalControls instance by name from the supplied container.

Return     The PolyflowNumericalControls instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPolyflowOutflow

Obtains a PolyflowOutflow instance by name from the supplied container.

Return     The PolyflowOutflow instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPolyflowOutputControls

Obtains a PolyflowOutputControls instance by name from the supplied container.

Return     The PolyflowOutputControls instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPolyflowPhysicsOptions

Obtains a PolyflowPhysicsOptions instance by name from the supplied container.

Return     The PolyflowPhysicsOptions instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPolyflowRegionInterface

Obtains a PolyflowRegionInterface instance by name from the supplied container.

Return     The PolyflowRegionInterface instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPolyflowRemeshing

Obtains a PolyflowRemeshing instance by name from the supplied container.

Return     The PolyflowRemeshing instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPolyflowSolutionControls

Obtains a PolyflowSolutionControls instance by name from the supplied container.

Return     The PolyflowSolutionControls instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPolyflowSymmetry

Obtains a PolyflowSymmetry instance by name from the supplied container.

Return     The PolyflowSymmetry instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPolyflowTemperatureImposed

Obtains a PolyflowTemperatureImposed instance by name from the supplied container.

Return     The PolyflowTemperatureImposed instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPolyflowWall

Obtains a PolyflowWall instance by name from the supplied container.

Return     The PolyflowWall instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPolyflowWallBase

Obtains a PolyflowWallBase instance by name from the supplied container.

Return     The PolyflowWallBase instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPorositySrc

Obtains a PorositySrc instance by name from the supplied container.

Return     The PorositySrc instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPorousMedium

Obtains a PorousMedium instance by name from the supplied container.

Return     The PorousMedium instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetPressure

Obtains a Pressure instance by name from the supplied container.

Return     The Pressure instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetRadiation

Obtains a Radiation instance by name from the supplied container.

Return     The Radiation instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetReferenceFrame

Obtains a ReferenceFrame instance by name from the supplied container.

Return     The ReferenceFrame instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetRegionInterface

Obtains a RegionInterface instance by name from the supplied container.

Return     The RegionInterface instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetRegionInterfaceGenerator

Obtains a RegionInterfaceGenerator instance by name from the supplied container.

Return     The RegionInterfaceGenerator instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetResultObject

Obtains a ResultObject instance by name from the supplied container.

Return     The ResultObject instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetResults

Obtains a Results instance by name from the supplied container.

Return     The Results instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetScalarConstraint

Obtains a ScalarConstraint instance by name from the supplied container.

Return     The ScalarConstraint instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetScalarInitialCondition

Obtains a ScalarInitialCondition instance by name from the supplied container.

Return     The ScalarInitialCondition instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetScalarLoad

Obtains a ScalarLoad instance by name from the supplied container.

Return     The ScalarLoad instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetSectionLayer

Obtains a SectionLayer instance by name from the supplied container.

Return     The SectionLayer instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetSectionOffset

Obtains a SectionOffset instance by name from the supplied container.

Return     The SectionOffset instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetSelectionSet

Obtains a SelectionSet instance by name from the supplied container.

Return     The SelectionSet instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetShape

Obtains a Shape instance by name from the supplied container.

Return     The Shape instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetShapeTaskStatistics

Obtains a ShapeTaskStatistics instance by name from the supplied container.

Return     The ShapeTaskStatistics instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetShellThickness

Obtains a ShellThickness instance by name from the supplied container.

Return     The ShellThickness instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetSimulation

Obtains a Simulation instance by name from the supplied container.

Return     The Simulation instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetSingleValueResult

Obtains a SingleValueResult instance by name from the supplied container.

Return     The SingleValueResult instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetSkinDepthResolution

Obtains a SkinDepthResolution instance by name from the supplied container.

Return     The SkinDepthResolution instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetSolutionControls

Obtains a SolutionControls instance by name from the supplied container.

Return     The SolutionControls instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetSolutionProgression

Obtains a SolutionProgression instance by name from the supplied container.

Return     The SolutionProgression instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetSolutionStep

Obtains a SolutionStep instance by name from the supplied container.

Return     The SolutionStep instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetSolvePhysics

Obtains a SolvePhysics instance by name from the supplied container.

Return     The SolvePhysics instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetSolverSettings

Obtains a SolverSettings instance by name from the supplied container.

Return     The SolverSettings instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetStatistics

Obtains a Statistics instance by name from the supplied container.

Return     The Statistics instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetStatusGroup

Obtains a StatusGroup instance by name from the supplied container.

Return     The StatusGroup instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetStreamLine

Obtains a StreamLine instance by name from the supplied container.

Return     The StreamLine instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetSupport

Obtains a Support instance by name from the supplied container.

Return     The Support instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetSuppressControl

Obtains a SuppressControl instance by name from the supplied container.

Return     The SuppressControl instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetTableResult

Obtains a TableResult instance by name from the supplied container.

Return     The TableResult instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetTaskGroup

Obtains a TaskGroup instance by name from the supplied container.

Return     The TaskGroup instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetTemperatureCondition

Obtains a TemperatureCondition instance by name from the supplied container.

Return     The TemperatureCondition instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetTemperatureConstraint

Obtains a TemperatureConstraint instance by name from the supplied container.

Return     The TemperatureConstraint instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetTerminal

Obtains a Terminal instance by name from the supplied container.

Return     The Terminal instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetTorqueComputation

Obtains a TorqueComputation instance by name from the supplied container.

Return     The TorqueComputation instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetTranscript

Obtains a Transcript instance by name from the supplied container.

Return     The Transcript instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetUserCommands

Obtains a UserCommands instance by name from the supplied container.

Return     The UserCommands instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetValidMaterialContent

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)

Return     A list of the valid material model tuples. The default list returned is in the following form [(Model, Definition, Behavior), ..., (Model, Definition, Behavior)].
    Type     List<Object>

Optional Arguments

IncludeName    Include the user friendly name as the first element of a sub-list and second element is the material model tuple. The list returned is in the following form [[Name, (Model, Definition, Behavior)], ..., [Name, (Model, Definition, Behavior)]]
    Type     bool
    Default Value    False
Example

This example requests all the valid material properties including the names.

    validContent = Study.GetValidMaterialContent(IncludeName=true)


GetVectorConstraint

Obtains a VectorConstraint instance by name from the supplied container.

Return     The VectorConstraint instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetVectorInitialCondition

Obtains a VectorInitialCondition instance by name from the supplied container.

Return     The VectorInitialCondition instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetVectorLoad

Obtains a VectorLoad instance by name from the supplied container.

Return     The VectorLoad instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetVectorResult

Obtains a VectorResult instance by name from the supplied container.

Return     The VectorResult instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetVirtualPrimitiveBox

Obtains a VirtualPrimitiveBox instance by name from the supplied container.

Return     The VirtualPrimitiveBox instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetVoltage

Obtains a Voltage instance by name from the supplied container.

Return     The Voltage instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetVolumeExtractionRegion

Obtains a VolumeExtractionRegion instance by name from the supplied container.

Return     The VolumeExtractionRegion instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetVolumeSimplificationRegion

Obtains a VolumeSimplificationRegion instance by name from the supplied container.

Return     The VolumeSimplificationRegion instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetWinding

Obtains a Winding instance by name from the supplied container.

Return     The Winding instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetWizardStep

Obtains a WizardStep instance by name from the supplied container.

Return     The WizardStep instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

GetWrap

Obtains a Wrap instance by name from the supplied container.

Return     The Wrap instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search.
    Type     string

MigrateDefaultBoltModelAsToOneBoltForAllLocations

Create AIM objects of the requested Type.

Return     An instance of the Type.
    Type     DataReference

Required Arguments

Type    The entity Type to create. The entity Type can be seen in the GUI by hovering over the entity's object icon. Also using dir(Study) will show object types for Get<Type> queries, for which the <Type> may be able to be created.
    Type     string

Optional Arguments

AssociatedObject    The object to associate this object to in the AIM dependency graph, which will create a directed edge in the AIM dependency graph. See discussion on Study and Tasks. This is deprecated in favor of Association.
    Type     DataReference
Association    The object to associate this object to in the AIM dependency graph, which will create a directed edge in the AIM dependency graph. See discussion on Study and Tasks.
    Type     DataReference
Location    If the entity has a location property, this will set the property to the provided LocationSet.
    Type     Object
    Default Value    Ansys.Study.Core.Common.Referencing.LocationSet
Location2    If the entity has a second location property, this will set the property to the provided LocationSet.
    Type     Object
    Default Value    Ansys.Study.Core.Common.Referencing.LocationSet
LocationWithHitPoints    If the entity has a location property with hit points, this will set the property to the provided LocationSet.
    Type     Object
    Default Value    Ansys.Study.Core.Common.Referencing.LocationSet
LocationWithHitPoints2    If the entity has a second location property with hit points, this will set the property to the provided LocationSet.
    Type     Object
    Default Value    Ansys.Study.Core.Common.Referencing.LocationSet
ObjectReferences    Future use
    Type     DataReferenceSet
Example

    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)


MigrateDefaultSupportTypeToUserdefined

Create AIM objects of the requested Type.

Return     An instance of the Type.
    Type     DataReference

Required Arguments

Type    The entity Type to create. The entity Type can be seen in the GUI by hovering over the entity's object icon. Also using dir(Study) will show object types for Get<Type> queries, for which the <Type> may be able to be created.
    Type     string

Optional Arguments

AssociatedObject    The object to associate this object to in the AIM dependency graph, which will create a directed edge in the AIM dependency graph. See discussion on Study and Tasks. This is deprecated in favor of Association.
    Type     DataReference
Association    The object to associate this object to in the AIM dependency graph, which will create a directed edge in the AIM dependency graph. See discussion on Study and Tasks.
    Type     DataReference
Location    If the entity has a location property, this will set the property to the provided LocationSet.
    Type     Object
    Default Value    Ansys.Study.Core.Common.Referencing.LocationSet
Location2    If the entity has a second location property, this will set the property to the provided LocationSet.
    Type     Object
    Default Value    Ansys.Study.Core.Common.Referencing.LocationSet
LocationWithHitPoints    If the entity has a location property with hit points, this will set the property to the provided LocationSet.
    Type     Object
    Default Value    Ansys.Study.Core.Common.Referencing.LocationSet
LocationWithHitPoints2    If the entity has a second location property with hit points, this will set the property to the provided LocationSet.
    Type     Object
    Default Value    Ansys.Study.Core.Common.Referencing.LocationSet
ObjectReferences    Future use
    Type     DataReferenceSet
Example

    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)


MigrateDefaultVectorDefineByToComponents

Create AIM objects of the requested Type.

Return     An instance of the Type.
    Type     DataReference

Required Arguments

Type    The entity Type to create. The entity Type can be seen in the GUI by hovering over the entity's object icon. Also using dir(Study) will show object types for Get<Type> queries, for which the <Type> may be able to be created.
    Type     string

Optional Arguments

AssociatedObject    The object to associate this object to in the AIM dependency graph, which will create a directed edge in the AIM dependency graph. See discussion on Study and Tasks. This is deprecated in favor of Association.
    Type     DataReference
Association    The object to associate this object to in the AIM dependency graph, which will create a directed edge in the AIM dependency graph. See discussion on Study and Tasks.
    Type     DataReference
Location    If the entity has a location property, this will set the property to the provided LocationSet.
    Type     Object
    Default Value    Ansys.Study.Core.Common.Referencing.LocationSet
Location2    If the entity has a second location property, this will set the property to the provided LocationSet.
    Type     Object
    Default Value    Ansys.Study.Core.Common.Referencing.LocationSet
LocationWithHitPoints    If the entity has a location property with hit points, this will set the property to the provided LocationSet.
    Type     Object
    Default Value    Ansys.Study.Core.Common.Referencing.LocationSet
LocationWithHitPoints2    If the entity has a second location property with hit points, this will set the property to the provided LocationSet.
    Type     Object
    Default Value    Ansys.Study.Core.Common.Referencing.LocationSet
ObjectReferences    Future use
    Type     DataReferenceSet
Example

    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)


TryGetAEMLaunchControls

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetAFDPhysicsOptions

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetBodyTemperature

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetBoltPretension

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetBoundary

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetBoundaryCondition

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetCappingSurface

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetConditionGroup

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetConfiguration

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetConnection

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetConnectionBehavior

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetConstraint

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetContact

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetContactBehavior

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetContactDetection

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetContourResult

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetConvection

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetCoreLossComputation

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetCurrent

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetDisplacement

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetEddyEffectComputation

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetEquipotential

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetFatigueSettings

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetFluidBoundary

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetForce

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetForceComputation

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetGeneralPhysicsOptions

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetGeometryImportSource

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetGravityDefinition

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetGroundLocation

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetHeatFlow

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetHeatFlux

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetHeatGeneration

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetHeatSource

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetHeatSrc

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetImport

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetInertiaLoad

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetInitialCondition

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetInitialConditions

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetInitialTemperature

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetInsulating

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetInterfaceGenerator

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetIsoSurface

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetJoint

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetJointBehavior

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetLaunchSettings

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetLoad

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetMaterial

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetMaterialAssignment

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetMaterialAtState

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetMechanicalPhysicsOptions

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetMesh

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetMeshControl

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetMeshControlBodySizing

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetMeshControlEdgeSizing

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetMeshControlElementShape

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetMeshControlFaceSizing

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetMeshControlLocalBoundaryLayer

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetMeshDiagnostics

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetMeshing

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetMeshModeling

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetModeling

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetModelingImportSource

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetMoment

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetMomentumSource

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetMomentumSrc

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetMonitorChart

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetMoveRotateControl

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetNumericalControls

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetOptimizationConstraint

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetOutputControl

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetOutputControls

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetParticleInjection

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPhysicsCoupling

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPhysicsDefinition

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPhysicsOptions

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPhysicsRegion

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPlane

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPoint

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPolyflowCondition

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPolyflowConvection

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPolyflowDieDeformation

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPolyflowFluidSolidInterfaceBehavior

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPolyflowFreejetExit

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPolyflowFreeSurface

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPolyflowHeatFlux

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPolyflowInflow

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPolyflowInitialTemperature

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPolyflowInsulated

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPolyflowLaunchControls

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPolyflowNumericalControls

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPolyflowOutflow

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPolyflowOutputControls

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPolyflowPhysicsOptions

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPolyflowRegionInterface

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPolyflowRemeshing

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPolyflowSolutionControls

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPolyflowSymmetry

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPolyflowTemperatureImposed

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPolyflowWall

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPolyflowWallBase

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPorositySrc

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPorousMedium

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetPressure

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetRadiation

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetReferenceFrame

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetRegionInterface

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetRegionInterfaceGenerator

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetResultObject

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetResults

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetScalarConstraint

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetScalarInitialCondition

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetScalarLoad

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetSectionLayer

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetSectionOffset

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetSelectionSet

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetShape

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetShapeTaskStatistics

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetShellThickness

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetSimulation

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetSingleValueResult

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetSkinDepthResolution

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetSolutionControls

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetSolutionProgression

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetSolutionStep

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetSolvePhysics

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetSolverSettings

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetStatistics

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetStatusGroup

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetStreamLine

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetSupport

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetSuppressControl

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetTableResult

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetTemperatureCondition

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetTemperatureConstraint

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetTerminal

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetTorqueComputation

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetTranscript

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetUserCommands

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetVectorConstraint

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetVectorInitialCondition

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetVectorLoad

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetVectorResult

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetVirtualPrimitiveBox

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetVoltage

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetVolumeExtractionRegion

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetVolumeSimplificationRegion

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetWinding

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetWizardStep

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

TryGetWrap

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.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search.
    Type     string
Name    The entity name for which to search.
    Type     string

Common Data Entities

AlternatingStress

The Alternating Stress material model.

Properties

Interpolation

No details are provided for this entry.

Type     InterpolationType
Read Only    No
Magnitude

The Magnitude is an expresion which evaluates to a Quantity with the correct units.

Type     Expression<Quantity>
Read Only    No

Appearance

The Appearance Properties material model.

Properties

ColorComponentBlue

Material Color Blue Value

Type     double
Read Only    No
ColorComponentGreen

Material Color Green Value

Type     double
Read Only    No
ColorComponentRed

Material Color Red Value

Type     double
Read Only    No
ColorSpace

Material Color Space Value

Type     ColorSpaceSetting
Read Only    No
MaterialMetallic

Material Metallic Value

Type     double
Read Only    No
MaterialOpacity

Material Color Alpha Value

Type     double
Read Only    No
MaterialRoughness

Material Roughness Value

Type     double
Read Only    No
MaterialTransmittance

Material Density - used to define how much contribution diffuse color has on the output.

Type     double
Read Only    No

AxisDirectionDefinition

Defines an axis from a vector or point.

Properties

Automatic

Property to automatically compute the axis direction.

Type     bool
Read Only    No
Axis

Axis being defined.

Type     AxisType
Read Only    No
DefineBy

Option to define the axis.

Type     AxisDefineBy
Read Only    No

BHCurve

The B-H Curve model.

Can be applied to Magnetic analyses

Properties

Value

The Magnitude allows for tabular input through the expresson language.

Type    Expression<Quantity>
Read Only    No

BilinearIsotropicHardening

Implementation for IProvideChartData

Properties

Value

The Magnitude.

Type     Expression<BilinearIsotropicHardeningDependents>
Read Only    No

CalculatedValueMonitor

Calculated value monitor objects are used to present graphical charts tracking aspects of the solution results, such as max(displacements.x)@Body1.

Properties

Component

No details are provided for this entry.

Type     string
Read Only    No
Expression

No details are provided for this entry.

Type     string
Read Only    No
Function

No details are provided for this entry.

Type     string
Read Only    No
Location

No details are provided for this entry.

Type     LocationSet
Read Only    No
Method

The method by which the value is calculated.

Type     TrackerMethod
Read Only    No
MonitorTypeName

No details are provided for this entry.

Type     string
Read Only    No
SubCategory

No details are provided for this entry.

Type     string
Read Only    No

CappingSurface

A CappingSurface creates an analytic surface based on a set of bounding edges or faces.

Properties

CreateSelectionSet

Flag to enable/disable automatic selection set creation.

Type     bool
Read Only    No
SelectionMethod

Specifies the method used to create the Capping Surface.

Type     CappingSurfaceConstructionMethod
Read Only    No

CappingSurfaceEdgesConstraint

Provides additional information to a Capping Surface when it is constructed based on a set of edges.

Properties

Algorithm

The algorithm used to construct the capping surface.

Type     ConstructionAlgorithm
Read Only    No
Edges

The set of selected edges.

Type     LocationSet
Read Only    No
FlipLoopOrientation

Sets the orientation of the edge loop, if the algorithm is a Convex Hull.

Type     ReverseEdgeLoopOrientation
Read Only    No

CappingSurfaceFacesConstraint

Provides additional information to a Capping Surface when it is constructed based on the internal loops of a set of faces.

Properties

Algorithm

The algorithm used to construct the capping surface.

Type     ConstructionAlgorithm
Read Only    No
Faces

The set of selected faces.

Type     LocationSet
Read Only    No
FlipLoopOrientation

Sets the orientation of the edge loop, if the algorithm is a Convex Hull.

Type     ReverseEdgeLoopOrientation
Read Only    No

CappingSurfaceLoopsConstraint

Provides additional information to a Capping Surface when it is constructed based on a set of edge loops.

Properties

Algorithm

The algorithm used to construct the capping surface.

Type     ConstructionAlgorithm
Read Only    No
EdgeLoopCount

Gets or sets edge loop count.

Type     int
Read Only    No
EdgeLoops

The set of selected edge loops.

Type     List<LocationSet>
Read Only    No
FlipLoopOrientation

Sets the orientation of the edge loop, if the algorithm is a Convex Hull.

Type     ReverseEdgeLoopOrientation
Read Only    No

CappingSurfaceVerticesConstraint

Provides additional information to a Capping Surface when it is constructed based on the internal loops of a set of faces.

Properties

Algorithm

The algorithm used to construct the capping surface.

Type     ConstructionAlgorithm
Read Only    No
FlipLoopOrientation

Sets the orientation of the edge loop, if the algorithm is a Convex Hull.

Type     ReverseEdgeLoopOrientation
Read Only    No
Vertices

The set of selected Vertices.

Type     LocationSet
Read Only    No

CartesianTriplet

Triplet represented in cartesian coordinates

Properties

X

X coordinate

Type     Expression<Quantity>
Read Only    No
Y

Y coordinate

Type     Expression<Quantity>
Read Only    No
Z

Z coordinate

Type     Expression<Quantity>
Read Only    No

ConditionGroup

Collection of UserObjects (Loads, Constraints, Contacts) and their selected StatusGroup for each step Key is SolutionStep DataReference, Value is UserObject DataReference

Properties

ConditionDataReferences

List of DataReferences for UserObjects (Loads, Constraints, Contacts, etc.)

Type     List<DataReference>
Read Only    No
SimulationStepStatusGroup

Dictionary of SolutionStep DataReference and StatusGroup DataReferences

Type     Dictionary<DataReference, DataReference>
Read Only    No

Configuration

The entity that represents a Configuration Task. Holds the list of configure controls objects.

Configure controls:

Suppress controlAllows the suppression selected part components.
Move/rotate controlAllows the transformation selected part components.

Properties

No Properties.

Methods

InsertVirtualPrimitiveBox

Inserts a primitive axis-alinged box that can be used to define an enclosure.

Required Arguments

CurrentSelection    Location set used to define the box bounds.
    Type    Object

ContourResult

Displays the contour of a selected variable on a specified location.

Properties

CalculateAverage

Set to true if averages are to be calculated as part of the Result evaluation.

Type     bool
Read Only    No
EvaluateFullRange

Whether or not to evaluate all time points in the evaluation

Type     bool
Read Only    No
LastAutomaticDisplayText

No details are provided for this entry.

Type     string
Read Only    No
Location

The Location over which the Result is to be evaluated.

Type     LocationSet
Read Only    No
RelativeTo

The Reference Frame which the result is relative to

Type     ReferenceFrame
Read Only    No
ResultName

No details are provided for this entry.

Type     string
Read Only    No
Settings

This allows for the required settings (such as Fatigue Settings) to be added to the contour result.

Type     GeneralSettings
Read Only    No
SimulationStep

The Simulation Step object reference for a multi-step analysis.

Type     SolutionStep
Read Only    No
Variable

The solution variable to be displayed

Type     Expression<Quantity>
Read Only    No

CylindricalTriplet

Triplet represented in cylindrical coordinates

Properties

Phi

Angle from the +X axis in the XY plane (a.k.a. theta or phi) phi = arctan(y / x) 0 <= theta < 2PI

Type     Expression<Quantity>
Read Only    No
Rho

Distance from the origin in the XY plane (positive) r = sqrt(x^2 + y^2)

Type     Expression<Quantity>
Read Only    No
Z

Distance from the XY plane (z coordinate)

Type     Expression<Quantity>
Read Only    No

DataManager

The DataManager is used to access readers and writers. This allows engineering data to be read and written to and from files.

Properties

DisplayText

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.

Type     string
Read Only    No
ProviderName

Gets or sets the name of the provider.

Type     string
Read Only    Yes

Methods

DeleteDataManager

Deletes the specified DataManager.

Example

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)

FindByDescription

Finds items in the Data Manager, where the item's Description contains the supplied text.

Return     A list of the names of the items the search found.
    Type     List<string>

Required Arguments

Description    A string containing the text to search for.
    Type     string
Example

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")

FindByModel

Finds materials in the Data Manager, where the material contains a matching model for the supplied arguments.

Return     A list of the names of the items the search found.
    Type     List<string>

Required Arguments

Model    The string to identify the material property/model to be searched for.
    Type     string

Optional Arguments

Behavior    The optional string to identify the behavior of the model.
    Type     string
Definition    The optional string to identify the way in which model is defined.
    Type     string
Example

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")

FindByName

Finds items in the Data Manager, where the item's name contains the supplied string.

Return     A list of the names of the items the search found.
    Type     List<string>

Required Arguments

Name    The string to identify the name of the item to be searched for.
    Type     string
Example

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")

FindByRange

Finds items in the Data Manager, where the item has the property and a value within the specified range.

Return     A list of the names of the items the search found.
    Type     List<string>

Required Arguments

MaximumQuantity    The maximum quantity in the range to search for. i.e. 1 [kPa]
    Type     string
MinimumQuantity    The minimum quantity in the range to search for. i.e. 10 [Pa]
    Type     string
PropertyName    The name of the property to use. i.e Bulk Modulus
    Type     string
Example

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]")

GetValidContentNames

Gets the names of all the items in the Data Manager.

Return     A List of strings containing the names of the items loaded into the DataManager.
    Type     List<string>

Optional Arguments

DataType    The type of data to be returned.
    Type     string
    Default Value    Material
Example

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)


Density

The Density model provided via a specified expression.

Properties

Magnitude

The Magnitude is an expresion which evaluates to a Quantity with the correct units.

Type     Expression<Quantity>
Read Only    No

GeometryDimension

Dimension parameter imported from CAD.

Properties

Value

Dimension parameter value.

Type     Quantity
Read Only    No

GeometryImportSource

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.

Properties

ActiveCADAttachSource

The Active CAD Source chosen from the option list

Type     string
Read Only    No
FilePath

Import source location.

Type     string
Read Only    No
MaterialAssignments

Material assignments brought in by this import.

Type     List<MaterialAssignment>
Read Only    No
PlugInName

Displays the current plugin name when the source has been defined by an active CAD attach.

Type     string
Read Only    Yes
SourceSelectionMode

Controls how the source selection if defined.

Selection Types:

BrowseSourceSource is specified using the file browser dialog.
ActiveCADAttachSource is specified by an active CAD attach source.

Type    SourceSelectionType
Read Only    No
SourceType

Import source type.

Type     string
Read Only    Yes

Methods

BrowseImportSourceOperation

Sets an import source file location through a file browser dialog.

Required Arguments

FilePath    Path to the chosen file.
    Type     string
GenerateImportSourceOperation

Generates the output for a specific Geometry Import Source.

UpdateGeometryImportSource

Updates a specific Geometry Import Source from the source CAD system. Any changed parameter values associated with this import source are pushed to the source CAD system.

UpdateGeometryImportSourceFromCAD

Updates a specific Geometry Import Source from the source CAD system. Parameter values associated with the import source are synchronized with the current values defined in the source CAD system.


GeometryPreferences

Defines geometry import preferences used during the initial geometry import and any subsequent updates.

Properties

CoordinateSystemKey

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.

Type     string
Read Only    No
DecomposeDisjointFaces

Enables the decomposition of disjoint faces into separate face entities. The default is No.

Type     bool
Read Only    No
DimensionKey

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".

Type     string
Read Only    No
ImportCoordinateSystems

Specifies whether coordinate systems created in the CAD System are imported as Reference Frame objects. The default is No.

Type     bool
Read Only    No
ImportDimensions

Enables Dimension processing. Dimension processing can have a negative impact on overall import performance. The default is Independent.

Type     ImportParameterType
Read Only    No
ImportNamedSelections

Enables processing of CAD System Named Selections that result in the creation of Selection Sets. The default is No.

Type     bool
Read Only    No
ImportSheets

Enables the import of surface bodies. The default is Yes.

Type     bool
Read Only    No
ImportSolids

Enables the import of solid bodies. The default is Yes.

Type     bool
Read Only    No
ImportWires

Enables the import of wire/line bodies. The default is No.

Type     bool
Read Only    No
MixedResolution

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:

NoneNothing is imported.
SolidOnly solids are imported.
SheetOnly sheet surfaces are imported.
SolidSheetOnly solids and sheet surfaces are imported.

Type    MixedResolutionType
Read Only    No
NamedSelectionKey

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".

Type     string
Read Only    No
ProcessAssociativity

Indicates if action should be taken to allow associativity. Associativity processing can have a negative impact on import performance. The default is Yes.

Type     bool
Read Only    No
ProcessEnclosures

Enables the processing of enclosure and symmetry CAD System Named Selections. The default is Yes.

Type     bool
Read Only    No
ReaderSaveUpdate

Enables saving of the internal part files generated from the geometry import during the import/update action. The default is No.

Type     bool
Read Only    No
UseInstances

Honors a geometry import's part instances during processing to produce faster import times and allow smaller database sizes. The default is Yes.

Type     bool
Read Only    No

GlobalMeshAdvancedAttributes

GlobalMeshAdvancedAttributes specifies the global advanced properties for Part Meshing.

Available options:

ShapeCheckingDetermines the shape checking algorithm to be used by the mesher.
TriangleSurfaceMesherDetermines surface meshing algorithm to be used by patch conforming mesher.
ElementMidsideNodesDetermines whether elements are with or without midside nodes.
StraightSidedElementsSpecifies meshing to straight edge elements.
LoopRemovalToleranceSpecifies the tolerance value for sheet loop removal.
MeshBasedDefeaturingSpecifies automatic defeaturing of dirty geometries.
DefeaturingToleranceSpecifies the defeaturing tolerance value.
UseAllProcessorsSpecifies if all available processors are used for parallel part-based meshing.
ProcessorLimitSpecifies the maximum number of processors to be utilized for parallel part-based meshing.

Properties

DefeaturingTolerance

Specifies the defeaturing tolerance value.

Type    Quantity
Read Only    No
ElementMidsideNodes

Determines whether elements are with or without midside nodes.

Available options:

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

Type    ElementMidsideNodes
Read Only    No
LoopRemovalTolerance

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.

Type    Quantity
Read Only    No
MeshBasedDefeaturing

Specifies automatic defeaturing of dirty geometries.

Available options:

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

Type    MeshBasedDefeaturing
Read Only    No
ProcessorLimit

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.

Type    uint
Read Only    No
ShapeChecking

Determines the shape checking algorithm to be used by the mesher.

Available options:

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

Type    ShapeChecking
Read Only    No
StraightSidedElements

Specifies meshing to straight edge elements.

Available options:

No
Yes

Type    StraightSidedElements
Read Only    No
TriangleSurfaceMesher

Determines surface meshing algorithm to be used by patch conforming mesher.

Available options:

Program ControlledMesher determines usage of Delaunay or Advancing Front algorithm.
Advancing FrontMesher uses Advancing Front algorithm but can switch to Delaunay if problems occur.

Type    TriangleSurfaceMesher
Read Only    No
UseAllProcessors

Specifies usage of all available processors for parallel part-based meshing.

Available options:

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

Type    UseAllProcessors
Read Only    No

GlobalMeshBoundaryLayerAttributes

GlobalMeshBoundaryLayerAttributes specifies the global boundary layer properties.

Available options:

CollisionAvoidanceDetermines strategy to avoid collision between inflated surface meshes.
FixFirstLayerDetermines whether the heights or ratios of the first boundary layer will be modified to avoid collision.
GapFactorSpecifies gap between intersecting prisms.
MaxHeightOverBaseSpecifies maximum allowable prism aspect ratio.
GrowthRateTypeDetermines height of boundary layer for given initial height and height ratio.
MaxAngleSpecifies the maximum prism layer growth angle.
FilletRatioSpecifies whether fillets proportional to the prism height will be created in corner zones of tetrahedral mesh.
UsePostSmoothingSpecifies whether post boundary layer smoothing will be performed.
SmoothIterationsSpecifies the number of post boundary layer smoothing iterations.

Properties

CollisionAvoidance

Determines strategy to avoid collision between inflated surface meshes.

Available options:

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

Type    CollisionAvoidance
Read Only    No
FilletRatio

Specifies whether fillets proportional to the prism height will be created in corner zones of tetrahedral mesh.

Type    double
Read Only    No
FixFirstLayer

Determines whether the heights or ratios of the first boundary layer will be modified to avoid collision.

Available options:

No
Yes

Type    FixFirstLayer
Read Only    No
GapFactor

Specifies gap between intersecting prisms.

Type    double
Read Only    No
GrowthRateType

Determines height of boundary layers for given initial height and height ratio.

Available options:

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

Type    GrowthRateType
Read Only    No
MaxAngle

Specifies the maximum prism layer growth angle.

Type    Quantity
Read Only    No
MaxHeightOverBase

Specifies maximum allowable prism aspect ratio.

Type    double
Read Only    No
SmoothIterations

Specifies the number of post boundary layer smoothing iterations.

Type    int
Read Only    No
UsePostSmoothing

Specifies whether post boundary layer smoothing will be performed.

Available options:

No
Yes

Type    UsePostSmoothing
Read Only    No

GlobalMeshSizingAttributes

GlobalMeshSizingAttributes specifies the global mesh sizing attributes.

Available options:

InheritanceWrapSpecifies whether the sizing function for sew is inherited from the predecessor wrap task or not.
UseAdvancedSizeFunctionSpecifies options for advanced size function.
MinSizeSpecifies the minimum size returned to the mesher.
ProximityMinSizeSpecifies global minimum size when Advanced Size Function is Proximity and Curvature or Proximity.
MaxFaceSizeSpecifies maximum size returned to the surface mesher.
MaxSizeSpecifies the maximum size returned to the mesher.
ProximitySizeFunctionSourcesSpecifies the source type to be used for size function calculation when Advanced Size Function is Proximity or Curvature and proximity.
GrowthRateSpecifies the increase in edge length with each succeeding layer of elements.
CurvatureNormalAngleSpecifies maximum allowable angle that one element is allowed to span when Advanced Size Function is Proximity and Curvature or Curvature.
NumberOfCellsAcrossGapSpecifies minimum number of elements to be generated in gaps when Advanced Size Function is Proximity and Curvature or Proximity.
SmoothingSpecifies the number of smoothing iterations.
AdaptiveResolutionThe scaling value for the arguments of various functions for the adaptive size function.

Properties

AdaptiveResolution

Specifies adaptive resolution

Type    double
Read Only    No
CurvatureNormalAngle

Specifies maximum allowable angle that one element is allowed to span when Advanced Size Function is Proximity and Curvature or Curvature.

Type    Quantity
Read Only    No
ElementSeedSize

Specifies the element seed size returned to the mesher.

Type    Quantity
Read Only    No
GrowthRate

Specifies the increase in edge length with each succeeding layer of elements.

Type    double
Read Only    No
MaxFaceSize

Specifies maximum size returned to the surface mesher.

Type    Quantity
Read Only    No
MaxSize

Specifies the maximum size returned to the mesher.

Type    Quantity
Read Only    No
MinSize

Specifies the minimum size returned to the mesher.

Type    Quantity
Read Only    No
NumberOfCellsAcrossGap

Specifies minimum number of elements to be generated in gaps when Advanced Size Function is Proximity and Curvature or Proximity.

Type    int
Read Only    No
ProximityMinSize

Specifies global minimum size when Advanced Size Function is Proximity and Curvature or Proximity.

Type    Quantity
Read Only    No
ProximitySizeFunctionSources

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

Type    ProximitySizeFunctionSources
Read Only    No
Smoothing

Specifies the number of smoothing iterations.

Available options:

Low
Medium
High

Type    Smoothing
Read Only    No
UseAdvancedSizeFunction

Specifies options for advanced size function.

Available options:

Adaptive
Curvature
Proximity
Fixed
ProximityCurvature

Type    UseAdvancedSizeFunction
Read Only    No
UseFixedSizeFunctionForSheets

Specifies use of Fixed Size function for sheets if there are present in the geometry.

Type    bool
Read Only    No

GlobalParametersExtension

Frequency parameters for Results

Properties

Frequency

The computed Frequency for this Result.

Type     Quantity
Read Only    Yes
FrequencyImaginary

The Imaginary (damping) component in the computed Frequency.

Type     Quantity
Read Only    Yes
FrequencyReal

The Real (stability) component in the computed Frequency.

Type     Quantity
Read Only    Yes

GlobalWrapSewAdvancedAttributes

GlobalWrapSewAdvancedAttributes specifies the global advanced properties for wrap and sew.

Available options:

TessellationRefinementSpecifies value to be used for tessellation refinement.
RefinementToleranceSpecifies the user-defined tolerance for tessellation refinement.
EdgeExtractionAngleDetermines which CAD features are captured.
CreateIntersectingEdgesForOverlappingBodiesCreate intersecting edges for overlapping bodies.
ZoningSpecifies options for zoning.
TargetMetricSpecifies the measure for mesh quality.
MetricValueSpecifies the value at which wrapper surface will be improved.
AggressiveSpecifies whether mesh may deviate from geometry as a result of wrapper surface improvement.

Properties

Aggressive

Specifies whether mesh may deviate from geometry as a result of wrapper surface improvement.

Available options:

MeetTarget
MaintainGeometry

Type    Aggressive
Read Only    No
CreateIntersectingEdgesForOverlappingBodies

Create intersecting edges for overlapping bodies.

Available options:

No
Yes

Type    CreateIntersectingEdgesForOverlappingBodies
Read Only    No
EdgeExtractionAngle

Determines which CAD features are captured.

Type    Quantity
Read Only    No
MetricValue

Specifies the value at which wrapper surface will be improved.

Type    double
Read Only    No
RefinementTolerance

Specifies the refinement tolerance for user defined tessellation refinement.

Type    Quantity
Read Only    No
TargetMetric

Specifies the measure for mesh quality.

Available options:

Skewness
SizeChange
AspectRatio

Type    Metric
Read Only    No
TessellationRefinement

Specifies value to be used for tessellation refinement.

Available options:

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

Type    TessellationRefinement
Read Only    No
Zoning

Specifies options for zoning.

Available options:

Part
Body
Face

Type    Zoning
Read Only    No

GravityDefinition

No details are provided for this entry.

Properties

RelativeToName

No details are provided for this entry.

Type     string
Read Only    Yes
XComponent

No details are provided for this entry.

Type     Quantity
Read Only    No
YComponent

No details are provided for this entry.

Type     Quantity
Read Only    No
ZComponent

No details are provided for this entry.

Type     Quantity
Read Only    No

Import

Main Data Import Task user object. Holds the list of import source objects

Properties

No Properties.

Methods

AddActiveCADAttachSourceOperation

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.

AddGeometryImportSourceOperation

Adds a single Geometry Import Source to an Import Task.

Return     Reference to the Geometry Import Source.
    Type     DataReference

Optional Arguments

FilePath    Path to the chosen file.
    Type     string
ChooseImportSources

Multiple selection of import source files. The file list is processed and import source objects are created within the Import Task.

Required Arguments

FilePaths    List of paths to the chosen files.
    Type     List<string>

IsoSurface

Creates surfaces of constant value of the specified variable.

Properties

EvaluateFullRange

Whether or not to evaluate all time points in the evaluation

Type     bool
Read Only    No
IsovalueMethod

The method by which isovalues are defined.

Type     IsovalueMethod
Read Only    No
Isovalues

The list of isovalues.

Type     Expression<List<Quantity>>
Read Only    No
LastAutomaticDisplayText

No details are provided for this entry.

Type     string
Read Only    No
Location

The Location over which the Result is to be evaluated.

Type     LocationSet
Read Only    No
NumberOfIsovalues

The number of isovalues.

Type     int
Read Only    No
ResultName

No details are provided for this entry.

Type     string
Read Only    No
SimulationStep

The Simulation Step object reference for a multi-step analysis.

Type     SolutionStep
Read Only    No
Variable

The variable of interest.

Type     Expression<Quantity>
Read Only    No

IsotropicElasticity

The Isotropic Elasticity material model.

Properties

Derivation

The Isotropic Elasticity values can be entered for one of the following combinations:

YoungsModulusPoissonsRatioYoung's Modulus and Poisson's Ratio
ShearModulusPoissonsRatioShear Modulus and Poisson's Ratio
BulkModulusPoissonsRatioBulk Modulus and Poisson's Ratio
YoungsModulusShearModulusYoung's Modulus and Shear Modulus
YoungsModulusBulkModulusYoung's Modulus and Bulk Modulus
BulkModulusShearModulusBulk Modulus and Shear Modulus

which will then compute the other values using Hooke's law.

Type    DerivationType
Read Only    No
Magnitude

The Magnitude is used for an expresion to include variations of the data for any independent variable (e.g. Temperature).

Type     Expression<IsotropicElasticityDependents>
Read Only    No

IsotropicElectricalConductivity

Isotropic bulk conductivity material model.

Properties

Value

The Value is an expresion which evaluates to a Quantity with the correct units.

Type     Expression<Quantity>
Read Only    No

IsotropicMagneticLossTangent

Magnetic Loss Tangent material model.

Properties

Value

The Value is an expresion which evaluates to a Quantity with the correct units.

Type     Expression<Quantity>
Read Only    No

IsotropicRelativePermeability

The Isotropic Relative Permeability model.

Can be applied to Magnetic analyses

Properties

Magnitude

Gets or sets the magnitude.

Type    Expression<Quantity>
Read Only    No

IsotropicRelativePermittivity

Isotropic relative permittivity material model.

Properties

Magnitude

The Magnitude is an expresion which evaluates to a Quantity with the correct units.

Type     Expression<Quantity>
Read Only    No

IsotropicResistivity

The input for resistivity which is isotropic.

This can be used in an electric/magnetic analysis.

Properties

Magnitude

Gets or sets the magnitude.

Type    Expression<Quantity>
Read Only    No

IsotropicSecantCoefficientofThermalExpansion

The Isotropic Secant Coefficient of Thermal Expansion material model.

Properties

Magnitude

The Magnitude is an expresion which evaluates to a Quantity with the correct units.

Type     Expression<Quantity>
Read Only    No

IsotropicSeebeckCoefficient

Seebeck Coefficient : Isotropic model.

Can be applied to Thermal analyses

Properties

Magnitude

Gets or sets the magnitude.

Type    Expression<Quantity>
Read Only    No

IsotropicThermalConductivity

The Isotropic Thermal Conductivity material model.

Properties

Magnitude

The Magnitude is an expresion which evaluates to a Quantity with the correct units.

Type     Expression<Quantity>
Read Only    No

Legend

Specifies how the legend for the current object should be displayed.

Properties

ClipToRange

Specifies whether to clip out-of-range values. If not set, the out-of-range values are colored by the Invalid Min/Max Colors.

Type     bool
Read Only    No
ColorDistribution

The distribution used to compute the size of each color band.

Type     ColorDistributionOption
Read Only    No
Coloring

Specifies smooth or banded coloring.

Type     LegendColoring
Read Only    No
NumberOfColors

The number of colors to be used.

Type     int
Read Only    No
RangeMaximum

Specifies the maximum user range value when variable range is 'User Specified'.

Type     Quantity
Read Only    No
RangeMinimum

Specifies the minimum user range value when variable range is 'User Specified'.

Type     Quantity
Read Only    No
VariableRange

Specifies 'Local' or 'User Specified' variable range.

Type     VariableRangeOption
Read Only    No

MagneticCoercivity

Magnetic Coercivity material model.

Properties

MagnetizationDirectionType

No details are provided for this entry.

Type     DirectionType
Read Only    No
Magnitude

Magnetic coercivity magnitude

Type     Expression<Quantity>
Read Only    No
Primary

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
Secondary

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
Tertiary

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No

Material

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

Properties

DefaultStateOfMatter

No details are provided for this entry.

Type     StateOfMatter
Read Only    No
Description

A description of the material contents.

Type     string
Read Only    No
SourceInformation

Information about the original source of this managed engineering data.

Type     SourceInformation
Read Only    Yes

Methods

AddPropertyTable

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.
    Type     int

Required Arguments

Dependents    A List of the column index(es) to use from the Table which correspond to the dependent variable(s) of the Property. The indexes can be an Integer index or the String name of the column.
    Type     List<Object>
Independents    A List of the column index(es) to use from the Table for use in the expression and correspond to the independent variables of the Property. The indexes can be an Integer index or the String name of the column.
    Type     List<Object>
Index    An integer which uniquely identifies the Table for use in the expression of the Property. In the expression this table can be accessed via tableIndex(args). The table with an index of one can be accessed in the expression as table(args) or table1(args).
    Type     uint
Property    The String which provides the path of the property on the Parent.
    Type     string
Table    The DataReference of the table to add to the Property.
    Type     DataReference

Optional Arguments

Bounds    An enum which describes what will occur when the index is outside of the bounds of the table. The valid enum values are; Constant, Fit, Zero, and Error. The default is Error.
    Type     TableInterpolationBeyondBounds
    Default Value    Error
Interpolation    An enum of the type of interpolation to use when accessing data from the table at a given index. The valid enum values are; None, Linear, Cubic Spline. The default is Linear.
    Type     TableInterpolation
    Default Value    Linear
Example

    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)”)

BindPropertyTableForMaterialMigration

No details are provided for this entry.

Required Arguments

DependentColumnNames    No details are provided for this entry.
    Type     List<string>
Fields    A List of field variable names to be used as the independent variables for this property. The dependent variables are defined by the Property.
    Type     List<string>
IndependentColumnNames    No details are provided for this entry.
    Type     List<string>
Property    The String which provides the path of the property on the Parent.
    Type     string
Table    The DataReference of the newly created table.
    Type     DataReference
Example

Required example does not exist.

CreateContent

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

Behavior    The optional string to identify the behavior of the property/model.
  The behavior typically refers to how the material responds, e.g., the density property could behave as an Ideal Gas or a Real Gas.
    Type    string
Definition    The optional string to identify the way in which new material property/model will be defined.
  In some cases the material property/model may be defined in different ways, e.g., Thermal Expansion can be defined using Secant or Instantaneous.
    Type    string
Model    The string to identify the material property/model to be included.
    Type    string
State    The optional string to identify the physical state of the property/model.
    Type    string
Example

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

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.
    Type    DataReference

Required Arguments

Fields    A List of field variable names to be used as the independent variables for this property. The dependent variables are defined by the Property.
    Type    List<string>
Property    The String which provides the path of the property on the Parent.
    Type    string
Example

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()

DeleteContent

Deletes a material model from the specified material.

Required Arguments

Model    The string to identify the material property/model to be removed.
    Type     string

Optional Arguments

Behavior    The optional string to identify the behavior of the property/model that is to be deleted.
  The behavior typically refers to how the material responds, e.g., the density property could behave as an Ideal Gas or a Real Gas.
    Type    string
Definition    The optional string to identify the way in which material property/model to be deleted was defined.
  In some cases the material property/model may be defined in different ways, e.g., Thermal Expansion can be defined using Secant or Instantaneous.
    Type    string
State    The optional string to identify the physical state to add the property/model.
    Type     string
Example

This example deletes the Isotropic Elasticity model from an already created material.

    material1.DeleteContent(Model="Elasticity", Definition="", Behavior="Isotropic")

ExportEngineeringData

ExportEngineeringData allows an engineering data object which can be managed to be exported to a source via a DataManager

Required Arguments

Source    The source that this data will be exported to, via the Data Manager.
    Type     string

Optional Arguments

DataManager    The data manager which is managing the requested engineering data. If not provided then the DataManager associated with the Entity will be used. If the Entity has no associated DataManager the default ANSYS Data Manager will be used.
    Type     DataReference
Format    The format which the Data Manager should use to save the entity. If it is not provided the DataManager will determine it based on the Source. If the Source does not yet exist the Data Manager will determine the format if it is a single type or throw an exception if the Format is not provided.
    Type     string
    Default Value    HDF5
Example

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

ImportEngineeringData allows an engineering data object which can be managed to import data from a source via a DataManager

Required Arguments

Name    The name of the engineering data to import from the DataManager.
    Type     string

Optional Arguments

DataManager    The data manager which is managing the requested engineering data. If not provided then the DataManager associated with the Entity will be used. If the Entity has no associated DataManager the default ANSYS Data Manager will be used.
    Type     DataReference
Source    The source of the data which will be managed by the Data Manager. If it is not provided the Source property of the DataManager will be used, if it is not set then an exception will occur.
    Type     string
Example

The example assumes that a material has already been created.

    material1.ImportEngineeringData(Name="Aluminum Alloy")

RemovePropertyTable

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

Index    The integer which uniquely identifies the Table for use in the expression of the Property.
    Type     uint
Property    The String which provides the path of the property on the Parent.
    Type     string
Example

    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);


MaterialAssignment

Assigns a Material to a specified Location.

Properties

Location

The Location for the Material.

Type     LocationSet
Read Only    No
Material

For UI access only to the reference to the Material, other areas should use MaterialAtState

Type     Material
Read Only    No
ReferenceFrame

No details are provided for this entry.

Type     ReferenceFrame
Read Only    No
StateOfMatter

The state of matter to use for this context.

Type     StateOfMatter
Read Only    No

MaterialAtState

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

Properties

Description

A description of the material contents.

Type     string
Read Only    No
SourceInformation

Information about the original source of this managed engineering data.

Type     SourceInformation
Read Only    Yes

Methods

AddPropertyTable

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.
    Type     int

Required Arguments

Dependents    A List of the column index(es) to use from the Table which correspond to the dependent variable(s) of the Property. The indexes can be an Integer index or the String name of the column.
    Type     List<Object>
Independents    A List of the column index(es) to use from the Table for use in the expression and correspond to the independent variables of the Property. The indexes can be an Integer index or the String name of the column.
    Type     List<Object>
Index    An integer which uniquely identifies the Table for use in the expression of the Property. In the expression this table can be accessed via tableIndex(args). The table with an index of one can be accessed in the expression as table(args) or table1(args).
    Type     uint
Property    The String which provides the path of the property on the Parent.
    Type     string
Table    The DataReference of the table to add to the Property.
    Type     DataReference

Optional Arguments

Bounds    An enum which describes what will occur when the index is outside of the bounds of the table. The valid enum values are; Constant, Fit, Zero, and Error. The default is Error.
    Type     TableInterpolationBeyondBounds
    Default Value    Error
Interpolation    An enum of the type of interpolation to use when accessing data from the table at a given index. The valid enum values are; None, Linear, Cubic Spline. The default is Linear.
    Type     TableInterpolation
    Default Value    Linear
Example

    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)”)

RemovePropertyTable

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

Index    The integer which uniquely identifies the Table for use in the expression of the Property.
    Type     uint
Property    The String which provides the path of the property on the Parent.
    Type     string
Example

    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);


MeshControlBodySizing

Body Sizing control which contains all sizing options a user can place on a Body reference

Properties

Behavior

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

Available options:

Soft
Hard

Type    SizingBehavior
Read Only    No
CurvatureNormalAngle

Specifies maximum angle that one element edge is allowed to span.

Type     Quantity
Read Only    No
ElementSize

Specifies the maximum size for the edge, face or body sizing control.

Type     Quantity
Read Only    No
GrowthRate

Specifies increase in element edge length with each succeeding layer of elements.

Type     double
Read Only    No
LocalMinSize

Specifies value to override global Min Size on local entities.

Type     Quantity
Read Only    No
Location

A common property for all sub meshing objects with a defined Geometry Filter

Type     LocationSet
Read Only    No
UseAutomaticallyDefinedLocation

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.

Type     bool
Read Only    No

MeshControlEdgeSizing

Specifies attributes for edge sizing.

Available options:

EdgeSizingMethodSpecifies the edge sizing method.
EdgeDivisionsSpecifies the number of divisions on each edge.
BiasMethodSpecifies bias option which is always smooth transition.
BiasTypeSpecifies option for bias type.
BiasGrowthRateSpecifies value for bias growth rate.

Properties

Behavior

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

Available options:

Soft
Hard

Type    SizingBehavior
Read Only    No
BiasGrowthRate

Specifies value for bias growth rate.

Type    double
Read Only    No
BiasMethod

Specifies bias option which is always smooth transition.

Type    BiasMethod
Read Only    No
BiasType

Specifies option for bias type.

Available options:

Right
Left
CenterIn
CenterOut
Constant

Type    BiasType
Read Only    No
CurvatureNormalAngle

Specifies maximum angle that one element edge is allowed to span.

Type    Quantity
Read Only    No
EdgeDivisions

Specifies the number of divisions on each edge.

Type    int
Read Only    No
EdgeSizingMethod

Specifies the edge sizing method.

Available options:

ElementSize
EdgeDivisions

Type    EdgeSizingMethod
Read Only    No
ElementSize

Specifies the maximum size for the edge, face or body sizing control.

Type    Quantity
Read Only    No
GrowthRate

Specifies increase in element edge length with each succeeding layer of elements.

Type    double
Read Only    No
LocalMinSize

Specifies value to override global Min Size on local entities.

Type    Quantity
Read Only    No
Location

A common property for all sub meshing objects with a defined Geometry Filter

Type    LocationSet
Read Only    No
UseAutomaticallyDefinedLocation

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.

Type    bool
Read Only    No

MeshControlElementShape

Mesh Method properties

Properties

LocalElementMidsideNodes

Show options to select the Local Element Midside Nodes

Type     LocalElementMidsideNodes
Read Only    No
Location

A common property for all sub meshing objects with a defined Geometry Filter

Type     LocationSet
Read Only    No
Shape

Show options to select the Mesh Method

Type     ElementShape
Read Only    No
SourceLocation

Source Location for MultiZone/thin Sweep/Sweep Methods

Type     LocationSet
Read Only    No
TargetLocation

Target Location for sweep Method

Type     LocationSet
Read Only    No
UseAutomaticallyDefinedLocation

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.

Type     bool
Read Only    No

MeshControlFaceSizing

Face Sizing control to be scoped to a topological selection of faces.

Properties

Behavior

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

Available options:

Soft
Hard

Type    SizingBehavior
Read Only    No
CurvatureNormalAngle

Specifies maximum angle that one element edge is allowed to span.

Type     Quantity
Read Only    No
ElementSize

Specifies the maximum size for the edge, face or body sizing control.

Type     Quantity
Read Only    No
GrowthRate

Specifies increase in element edge length with each succeeding layer of elements.

Type     double
Read Only    No
LocalMinSize

Specifies value to override global Min Size on local entities.

Type     Quantity
Read Only    No
Location

A common property for all sub meshing objects with a defined Geometry Filter

Type     LocationSet
Read Only    No
UseAutomaticallyDefinedLocation

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.

Type     bool
Read Only    No

MeshControlLocalBoundaryLayer

Specifies local boundary layer attributes.

Available options:

BoundaryLayerOptionSpecifies the way heights of the boundary layers are determined.
FirstLayerHeightSpecifies the height of the first boundary layer.
FirstAspectRatioSpecifies the aspect ratio of the boundaries that are extruded from the boundary base.
TransitionRatioSpecifies the rate at which adjacent elements grow.
NumberOfLayersSpecifies the number of boundary layers.
MaximumLayersSpecifies the maximum number of boundary layers to be created.
GrowthRateSpecifies the value for Growth Rate.
AspectRatioSpecifies relative thickness of adjacent boundary layers.
MaximumThicknessSpecifies the desired maximum thickness of the boundary layer.
BoundaryLayerAlgorithmSpecifies pre or post boundary layer algorithm to be used by the mesher.

Properties

AspectRatio

Specifies relative thickness of adjacent boundary layers.

Type    double
Read Only    No
BoundaryLayerAlgorithm

Specifies pre or post boundary layer algorithm to be used by the mesher.

Available options:

Post
Pre

Type    BoundaryLayerAlgorithm
Read Only    No
DefineBy

Specifies the way heights of the boundary layers are determined.

Available options:

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

Type    BoundaryLayerOption
Read Only    No
FirstAspectRatio

Specifies the aspect ratio of the boundaries that are extruded from the boundary base.

Type    double
Read Only    No
FirstLayerHeight

Specifies the height of the first boundary layer.

Type    Quantity
Read Only    No
GrowthRate

Specifies the value for Growth Rate.

Type    double
Read Only    No
Location

A common property for all sub meshing objects with a defined Geometry Filter

Type    LocationSet
Read Only    No
MaximumLayers

Specifies the maximum number of boundary layers to be created.

Type    int
Read Only    No
MaximumThickness

Specifies the desired maximum thickness of the boundary layer.

Type    Quantity
Read Only    No
NumberOfLayers

Specifies the number of boundary layers.

Type    int
Read Only    No
TransitionRatio

Specifies the rate at which adjacent elements grow.

Type    double
Read Only    No
UseAutomaticallyDefinedLocation

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.

Type    bool
Read Only    No

MeshDiagnostics

MeshDiagnostics specifies the settings used to evaluate mesh quality.

Available options:

GeometryLocationSpecifies the selected topology set or the entire model for which mesh diagnostics are evaluated during part-based Meshing.
MeshMetricSpecifies the metric type based on which mesh quality is evaluated.
NumNodesSpecifies number of nodes in the mesh.
NumElementsSpecifies number of elements in the mesh.
MinMetricSpecifies the minimum value for chosen metric type.
MaxMetricSpecifies the maximum value for chosen metric type.
AverageMetricSpecifies the average value for chosen metric type.
StandardDeviationSpecifies the standard deviation value for chosen metric type.

Properties

AverageMetric

Specifies the average value for chosen metric type.

Type    double
Read Only    No
Location

A common property for all sub meshing objects with a defined Geometry Filter

Type    LocationSet
Read Only    No
MaxMetric

Specifies the maximum value for chosen metric type.

Type    double
Read Only    No
MeshMetric

Specifies the metric type based on which mesh quality is evaluated.

Available options:

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

Type    MeshMetric
Read Only    No
MinMetric

Specifies the minimum value for chosen metric type.

Type    double
Read Only    No
NumElements

Specifies number of elements in the mesh.

Type    int
Read Only    No
NumNodes

Specifies number of nodes in the mesh.

Type    int
Read Only    No
StandardDeviation

Specifies the standard deviation value for chosen metric type.

Type    double
Read Only    No
UseAutomaticallyDefinedLocation

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.

Type    bool
Read Only    No

Methods

EvaluateMeshDiagnostics

Evaluates the output mesh metrics for a given Mesh Diagnostics control.


MeshDisplayProperties

Base class for display state objects with reference Ids or reference names.

Properties

No Properties.


MeshDisplayPropertiesWithIds

Object returned by mesh display state queries with reference Ids and their corresponding display state properties.

Available properties:

StateMeshing state for entity. [ 0 = Unmeshed, 1 = Meshed, 2 = OutOfDate, 3 = Failed, 4 = Suppressed, 5 = Connected, 6 = NeedsConnected ]
MeshColorColor with which the mesh element edges should be drawn by graphics.
TranslucencyTranslucency value with which the mesh element faces should be drawn by graphics.
ShowMeshFlag to tell graphics whether to overlay the mesh on the entity or not.
ReferenceIdsA list of entity reference Ids that are associated with a given meshing state.

Properties

No Properties.


MeshDisplayPropertiesWithStrings

Object returned by mesh display state queries with reference names and their corresponding display state properties.

Available properties:

StateMeshing state for entity. [ 0 = Unmeshed, 1 = Meshed, 2 = OutOfDate, 3 = Failed, 4 = Suppressed, 5 = Connected, 6 = NeedsConnected ]
MeshColorColor with which the mesh element edges should be drawn by graphics.
TranslucencyTranslucency value with which the mesh element faces should be drawn by graphics.
ShowMeshFlag to tell graphics whether to overlay the mesh on the entity or not.
ReferenceNamesA list of entity reference names that are associated with a given meshing state.

Properties

No Properties.


Meshing

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:

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

Properties

DeriveZoneTypeFromName

Used only when there is a connection from AIM Mesh Modeling component to Fluent Setup - part mesh file tranfer

Type    bool
Read Only    No
EngineeringIntent

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

Available options:

StructuralOrThermalIntent of this process is a structural and/or thermal simulation.
FluidFlowIntent of this process is a fluid flow or fluid solid conduction simulation.

Type    EngineeringIntent
Read Only    No
MeshingRetries

Will tell the mesher to try again with finer sizing inputs if the first attempt at meshing fails.

Type    bool
Read Only    No
MeshResolution

Defines the resolution for automatically calculating global meshing inputs. Selecting a higher resolution generates a better quality mesh.

Type    int
Read Only    No
UsePredefinedSettings

Automatically calculates the global sizing values based on the resolution value.

Type    bool
Read Only    No

MeshModeling

Main MeshModeling Task user object

Properties

DeriveZoneTypeFromName

Used only when there is a connection from AIM Mesh Modeling component to Fluent Setup - part mesh file tranfer

Type     bool
Read Only    No

Modeling

Main Modeling Task user object

Properties

No Properties.

Methods

ChooseGeometryImport

Browses for the geometry import file path and sets it for a Modeling Task.

Required Arguments

FilePath    Path to the chosen file.
    Type     string
ResyncGeometry

Forces a resynchronization of the AIM model with the SC document.

SetImportPath

Sets the import file path on a Modeling Task.

Required Arguments

FilePath    No details are provided for this entry.
    Type     string

ModelingImportSource

Defines an imported modeling source associated with the Modeling Task.

Properties

ActiveCADAttachSource

The Active CAD Source chosen from the option list

Type     string
Read Only    No
FilePath

Import source location.

Type     string
Read Only    No
MaterialAssignments

Material assignments brought in by this import.

Type     List<MaterialAssignment>
Read Only    No
PlugInName

Displays the current plugin name when the source has been defined by an active CAD attach.

Type     string
Read Only    Yes
SourceSelectionMode

Controls how the source selection if defined.

Selection Types:

BrowseSourceSource is specified using the file browser dialog.
ActiveCADAttachSource is specified by an active CAD attach source.

Type    SourceSelectionType
Read Only    No
SourceType

Import source type.

Type     string
Read Only    Yes

ModelsPlasticity

No details are provided for this entry.

Properties

As

No details are provided for this entry.

Type     PlasticityType
Read Only    No

MolarMass

The Molar Mass model.

Can be applied to Fluid and Thermal analyses

Properties

Magnitude

Gets or sets the magnitude.

Type    Expression<Quantity>
Read Only    No

MonitorChart

Class containing a list of monitors to be displayed in a single chart.

Properties

No Properties.


MoveRotateControl

The Configuration control to move or rotate the geometry to a new Reference Frame.

Properties

PartSelections

Part selection for suppression

Type     LocationSet
Read Only    No
RelativeTo

The target Reference Frame.

Type     ReferenceFrame
Read Only    No

Methods

GenerateConfigureControlCommand

Generates the output for a specific Configure Control.


MultipleTableEditor

No details are provided for this entry.

Properties

ReferenceValue

No details are provided for this entry.

Type     Dictionary<string, Object>
Read Only    No
Table

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No

OriginAndOrientationDefinitionMethod

Defines a reference frame from a local origin and 2 direction vectors

Properties

No Properties.


PhysicsCoupling

Provides the definition of a Physics Coupling Interface.

Properties

PhysicsRegion1

The source Physics Region that sends data via the Physics Coupling Interface.

Type     PhysicsRegion
Read Only    No
PhysicsRegion2

The target Physics Region that receives data via the Physics Coupling Interface.

Type     PhysicsRegion
Read Only    No
Side1Location

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.

Type     string
Read Only    No
Side2Locations

The target locations that receive data via the Physics Coupling Interface.

Type     LocationSet
Read Only    No
SourceFrequency

No details are provided for this entry.

Type     string
Read Only    No

PhysicsDefinition

Represents a physics solution.

Properties

CalculationType

The calculation type for the solution.

Type     CalculationType
Read Only    No

Methods

GenerateConductionPaths

No details are provided for this entry.

GenerateInitialMesh

No details are provided for this entry.

GetAllBoundaryConditions

Provides a list of all Boundary Conditions in this entity. (Deprecated; use GetAllConditionsQuery instead)

Return     A list of DataReferences containing the requested Boundary Conditions.
    Type     DataReferenceSet
GetAllConditions

Provides a list of all (Boundary) Conditions in this entity.

Return     A list of DataReferences containing the requested (Boundary) Conditions.
    Type     DataReferenceSet
GetAllContacts

A query to return all Contact objects in the Solution.

Return     A list of DataReferences containing the requested Contacts.
    Type     DataReferenceSet
GetAllObjects

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.
    Type     DataReferenceSet

Optional Arguments

SearchLocation    The criteria to use to do the match for the SearchString. This can be Exact, BeginsWith, Contains, or EndsWith and the default is Exact.
    Type     SearchPosition
    Default Value    Exact
SearchString    A search string to filter the return Components for the requested Type.
    Type     string
Example

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

GetAllPhysicsRegions

A query to return all Physics Regions in the Solution.

Return     A list of DataReferences containing the requested Physics Regions.
    Type     DataReferenceSet
GetBodiesOfUnknownPhysicsRegion

Gets a list of bodies that are not associated with a physics region.

Return     A list of bodies that are not associated with any physics regions.
    Type     List<string>

Required Arguments

Model    The DataReference of the model to lookup the bodies in.
    Type     DataReference
GetBodiesOfUnknownPhysicsRegionAndTotalBodyCount

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.
    Type     Dictionary<long, List<string>>

Required Arguments

Model    The DataReference of the model to lookup the bodies in.
    Type     DataReference
GetDuplicateMaterialAssignments

Provides the list of overlapping Material Assignments given an active Model.

Return     A DataReferenceSet of the duplicate material assignments.
    Type     DataReferenceSet

Required Arguments

ActiveModel    The DataReference of the model of interest.
    Type     DataReference
ReferenceTopologyType    The ReferenceTopologyType of interest.
    Type     ReferenceTopologyType
GetMaterialAssignments

A query to return all Material Assignments in the Analysis.

Return     A list of DataReferences with the requested Material Assignments.
    Type     DataReferenceSet
GetTopologyWithoutMaterial

Locates the topologies ( represented by their reference strings ) that currently don't have a material assignment given an active Model.

Return     A list of topology reference strings containing the names of the found bodies.
    Type     List<string>

Required Arguments

ActiveModel    The DataReference of the model of interest.
    Type     DataReference
ReferenceTopologyType    The ReferenceTopologyType of interest.
    Type     ReferenceTopologyType

PhysicsOptions

The common set of Physics Options.

Properties

No Properties.


PhysicsRegion

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

Properties

Location

The location of the Physics Region.

Type     LocationSet
Read Only    No
PhysicsType

The physics type for the physics region.

Type     PhysicsType
Read Only    No

Methods

GetAllBoundaryConditions

Provides a list of all Boundary Conditions in this entity. (Deprecated; use GetAllConditionsQuery instead)

Return     A list of DataReferences containing the requested Boundary Conditions.
    Type     DataReferenceSet
GetAllConditions

Provides a list of all (Boundary) Conditions in this entity.

Return     A list of DataReferences containing the requested (Boundary) Conditions.
    Type     DataReferenceSet
GetDuplicateMaterialAssignments

Provides the list of overlapping Material Assignments given an active Model.

Return     A DataReferenceSet of the duplicate material assignments.
    Type     DataReferenceSet

Required Arguments

ActiveModel    The DataReference of the model of interest.
    Type     DataReference
ReferenceTopologyType    The ReferenceTopologyType of interest.
    Type     ReferenceTopologyType
GetMaterialAssignments

A query to return all Material Assignments in the Analysis.

Return     A list of DataReferences with the requested Material Assignments.
    Type     DataReferenceSet
GetTopologyWithoutMaterial

Locates the topologies ( represented by their reference strings ) that currently don't have a material assignment given an active Model.

Return     A list of topology reference strings containing the names of the found bodies.
    Type     List<string>

Required Arguments

ActiveModel    The DataReference of the model of interest.
    Type     DataReference
ReferenceTopologyType    The ReferenceTopologyType of interest.
    Type     ReferenceTopologyType

Plane

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

Properties

ConstructionMethod

Method for constructing the plane.

Type     PlaneConstructionMethod
Read Only    No
ScopedBodies

Bodies which this plane is scoped to.

Type     LocationSet
Read Only    No
Transform

Plane transform.

Type     Transform4x4
Read Only    Yes

PlaneFromPlaneDefinition

Definition type for defining a plane from another plane.

Properties

BasePlane

Plane to define from.

Type     Plane
Read Only    No

PlaneFromReferenceFrameDefinition

Definition type for defining a plane from a reference frame.

Properties

Plane

The reference frame axes used to define the plane.

Type     PlaneOption
Read Only    No
ReferenceFrame

Reference Frame to define from.

Type     ReferenceFrame
Read Only    No

PlaneOriginAndOrientationDefinition

Definition type for defining a plane from an origin and 2 axes.

Properties

No Properties.


PlaneTransformation

Extension for plane offset and rotation

Properties

RotationAngle

Rotation angle about the rotation axis

Type     Expression<Quantity>
Read Only    No
Suppress

Flag to suppress the transformation

Type     bool
Read Only    No

Point

Point represented by local coordinates relative to a reference frame.

Properties

CalculationMethod

Calculation method for defining the point from geometry.

Type     PointCalculationMethod
Read Only    No
DefineBy

Method for defining the point.

Type     CoordinateInputMethod
Read Only    No
Location

Location to define the point.

Type     LocationSet
Read Only    No
RelativeTo

Frame of reference for the point.

Type     ReferenceFrame
Read Only    No

PointDefinition

Collection of properties to define a UniversalPoint

Properties

CalculationMethod

Calculation method for defining the point from geometry

Type     PointCalculationMethod
Read Only    No
DefineBy

Method for defining the point

Type     CoordinateInputMethod
Read Only    No
Location

Location to define the point

Type     LocationSet
Read Only    No
RelativeTo

Frame of reference for the point

Type     ReferenceFrame
Read Only    No

PowerFerriteCoreLoss

Core Loss Power Ferrite material model.

Properties

CM

Gets or sets the CM.

Type     Expression<Quantity>
Read Only    No
X

Gets or sets the X.

Type     Expression<Quantity>
Read Only    No
Y

Gets or sets the Y.

Type     Expression<Quantity>
Read Only    No

ReferenceFrame

Frame of reference for modeling and simulation data.

Properties

ConfigurationTransform

Transform relative to the global reference frame without motion

Type     Transform4x4
Read Only    Yes
DefinitionType

Reference frame definition type.

Type     ReferenceFrameDefinitionType
Read Only    No
EnablePivot

Flag to Enable/Disable the GUI "Pivot".

Type     bool
Read Only    No
ParentFrame

Parent reference frame.

Type     ReferenceFrame
Read Only    No
PreferredCoordinateType

Default coordinate type for points/vectors in this reference frame.

Type     TripletType
Read Only    No

ResultObject

Used to define and evaluate a quantitative result in an Analysis.

Properties

CalculateAverage

Set to true if averages are to be calculated as part of the Result evaluation.

Type     bool
Read Only    No
EvaluateFullRange

Whether or not to evaluate all time points in the evaluation

Type     bool
Read Only    No
LastAutomaticDisplayText

No details are provided for this entry.

Type     string
Read Only    No
Location

The Location over which the Result is to be evaluated.

Type     LocationSet
Read Only    No
RelativeTo

The Reference Frame which the result is relative to

Type     ReferenceFrame
Read Only    No
ResultName

No details are provided for this entry.

Type     string
Read Only    No
SimulationStep

The Simulation Step object reference for a multi-step analysis.

Type     SolutionStep
Read Only    No
Variable

The solution variable to be displayed

Type     Expression<Quantity>
Read Only    No

Methods

Evaluate

Evaluates the Result's calculated and displayed values based on the current solution.


Results

The top-level object for a Results task.

Properties

AnimationDuration

The length of time an animation takes to play

Type     Quantity
Read Only    No
CustomScaling

Deformation scaling setting for custom scaling

Type     double
Read Only    No
Scaling

How much to deform the Results display

Type     DeformationScaling
Read Only    No

ResultSetParametersExtension

Parameters for Results

Properties

Mode

The mode number for a Modal analysis.

Type     int
Read Only    No
PhaseAngle

The Phase Angle representation of a Complex result.

Type     double
Read Only    No
Substep

The substep number within the simulation step.

Type     int
Read Only    No

ReverseAboutXTransform

Rotates about the X axis by 180 degrees.

Properties

Suppress

Suppress/Unsuppress the transform

Type     bool
Read Only    No

ReverseAboutYTransform

Rotates about the Y axis by 180 degrees

Properties

Suppress

Suppress/Unsuppress the transform

Type     bool
Read Only    No

ReverseAboutZTransform

Rotates about the Z axis by 180 degrees

Properties

Suppress

Suppress/Unsuppress the transform

Type     bool
Read Only    No

RotationTransform

Rotates the matrix about a vector relative to the local reference frame.

Properties

RelativeToType

Define the axis direction relative to Local or Parent.

Type     RelativeToType
Read Only    No
RotationAngle

Angle to rotate by.

Type     Expression<Quantity>
Read Only    No
Suppress

Suppress/Unsuppress the transform

Type     bool
Read Only    No

SectionLayer

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.

Properties

Offset

The offset within the stack up

Type     Quantity
Read Only    No
RelativeTo

Orientation with respect to the element reference frame

Type     ReferenceFrame
Read Only    No
Thickness

Thickness

Type     Quantity
Read Only    No

SectionOffset

Represents the offset of a section with respect to the reference axis/plane/whatever.

Properties

Location

When OffsetType is User Defined, the offset of the beam section with respect to the origin

Type     LocationSet
Read Only    No
OffsetType

Offset of the beam cross section, also the location of the nodes in the section

Type     CrossSectionOffsetType
Read Only    No

SelectionSet

An object that can be used to reference any Location.

Properties

Location

The selected location: evaluates to a set of reference ids. See LocationSet for more detail.

Type     LocationSet
Read Only    No

Methods

GetSelectionSetSelectableEntityCount

Returns the number of selectable entities of the specified SelectionSet.

Return     The number of selectable entities of the specified SelectionSet.
    Type     uint

Shape

The top-level object for a Shape task.

Properties

ColorBy

TODO: Doc team summary when feature further along

Type     ColorBy
Read Only    No
Evolution

TODO: Doc team summary when feature further along

Type     int
Read Only    No
RemoveWholeElements

TODO: Doc team summary when feature further along

Type     bool
Read Only    No
ResultName

No details are provided for this entry.

Type     string
Read Only    No
Sensitivity

TODO: Doc team summary when feature further along

Type     int
Read Only    No
ShowRemovedMaterial

TODO: Doc team summary when feature further along

Type     bool
Read Only    No
SmoothShape

TODO: Doc team summary when feature further along

Type     bool
Read Only    No

ShapeTaskStatistics

No details are provided for this entry.

Properties

MassReduction

TODO: Doc team summary when feature further along

Type     Quantity
Read Only    Yes
OriginalMass

TODO: Doc team summary when feature further along

Type     Quantity
Read Only    Yes
OriginalVolume

TODO: Doc team summary when feature further along

Type     Quantity
Read Only    Yes
ReducedMass

TODO: Doc team summary when feature further along

Type     Quantity
Read Only    Yes
ReducedVolume

TODO: Doc team summary when feature further along

Type     Quantity
Read Only    Yes
VolumeReduction

TODO: Doc team summary when feature further along

Type     Quantity
Read Only    Yes

ShellThickness

No details are provided for this entry.

Properties

IsImportedThickness

Switch to synchronize the thickness value with modeler

Type     bool
Read Only    No
Location

No details are provided for this entry.

Type     LocationSet
Read Only    No
Offset

When OffsetType is User Defined, the offset of the shell section with respect to the midplane

Type     Quantity
Read Only    No
ReverseOffsetDirection

Inertia Relief as available from MAPDL solver.

Type     bool
Read Only    No
Thickness

Total thickness

Type     Expression<Quantity>
Read Only    No
ThicknessDistribution

Offset of the shell section, also the location of the nodes in the section

Type     SectionOffsetType
Read Only    No

Simulation

The top-level object that manages all data in a simulation study.

Properties

No Properties.

Methods

GetAllModels

A query to return all available models in the Simulation.

Return     A list of DataReferences containing the requested Models.
    Type     DataReferenceSet
GetObjectsForReference

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.
    Type     List<DataReference>

Required Arguments

Reference    The toplogical entities reference string such as "BODY1", "FACE16", etc
    Type     string
GetPhysicsRegionForSelection

Returns the Physics Regions that contain any of the specified journal reference strings.

Return     The Physics Regions whose location contains the selection.
    Type     List<DataReference>

Required Arguments

GeometryStrings    The reference strings of the geometry selection of interest.
    Type     List<string>

SingleValueResult

A result object that can be used to evaluate a single calculated value.

Properties

CalculateAverage

Set to true if averages are to be calculated as part of the Result evaluation.

Type     bool
Read Only    No
Condition

The boolean condition used in CountIf and SumIf expressions

Type     string
Read Only    No
EvaluateFullRange

Whether or not to evaluate all time points in the evaluation

Type     bool
Read Only    No
Expression

An expression to be calculated.

Type     Expression<Quantity>
Read Only    No
Function

The function used to calculate the value.

Type     string
Read Only    No
LastAutomaticDisplayText

No details are provided for this entry.

Type     string
Read Only    No
Location

The Location over which the Result is to be evaluated.

Type     LocationSet
Read Only    No
MeshEntity

Specifies the type of mesh location (node, element, face, edge) to be used to calculate the value.

Type     EntityType
Read Only    No
Method

The method by which the value is calculated.

Type     Method
Read Only    No
RelativeTo

The Reference Frame which the result is relative to

Type     ReferenceFrame
Read Only    No
ResultName

No details are provided for this entry.

Type     string
Read Only    No
SimulationStep

The Simulation Step object reference for a multi-step analysis.

Type     SolutionStep
Read Only    No
Value

The current value of the result.

Type     Expression<Quantity>
Read Only    No
Variable

The solution variable to be displayed

Type     Expression<Quantity>
Read Only    No
WeightType

The weight method used to calculate an average value.

Type     WeightingType
Read Only    No

SolutionProgression

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

Properties

No Properties.


SolutionQualityMonitor

Solution quality monitor objects are used to present graphical charts tracking aspects of the solution quality, such as convergence.

Properties

Component

For non-scalar Solution Quality Metrics, defines the component

Type     string
Read Only    No
Location

For scoped Solution Quality Metrics, defines the location

Type     LocationSet
Read Only    No
MonitorTypeName

Gives a type of Solution Quality Metric

Type     string
Read Only    No
SubCategory

Gives the name of a set of fields (assembly of fields of same nature : for contact, for thermal, ..)

Type     string
Read Only    No

SolutionStep

No details are provided for this entry.

Properties

SolutionProgression

It displays the solution progression associated with this solution step

Type     SolutionProgression
Read Only    No

SolutionVariableMonitor

Solution variable monitor objects are used to present graphical charts tracking aspects of the solution results, such as displacements.

Properties

Component

Gives the component of the field

Type     string
Read Only    No
Location

The Location over which the monitor is to be evaluated

Type     LocationSet
Read Only    No
MonitorTypeName

Gives the name of a field

Type     string
Read Only    No
SubCategory

Gives the name of a set of fields (assembly of fields of same nature : for contact, for thermal, ..)

Type     string
Read Only    No

SolverSettings

The common set of solver settings.

Properties

No Properties.


SpecificHeatConstantPressure

The specific heat at constant pressure model provided via a specified expression.

Properties

Magnitude

The Magnitude is an expresion which evaluates to a Quantity with the correct units.

Type     Expression<Quantity>
Read Only    No

SphericalTriplet

Triplet represented in spherical coordinates

Properties

Phi

Angle in the XY plane counter-clockwise from the +X axis (a.k.a phi) phi = arctan(y / x)

Type     Expression<Quantity>
Read Only    No
R

Distance from the origin r = sqrt(x^2 + y^2 + z^2)

Type     Expression<Quantity>
Read Only    No
Theta

Angle between the +Z axis and the vector (a.k.a. polar angle, theta) theta = arccos(z / r)

Type     Expression<Quantity>
Read Only    No

StateOfMatterExtension

For the purpose of using generic in AddProperty need a base for the StateOfMatter

Properties

No Properties.


StatusGroup

Defines the behavior (suppression, ramping, factor, locked) for a collection of UserObjects

Properties

No Properties.


StepControlExtension

StepControlExtension is a class to represents controls for Simulation

Properties

NumberOfSteps

The number of simulation steps for the solution.

Type     int
Read Only    Yes

StrainLifeParameters

The Strain Life Properties material model.

Properties

CyclicStrainHardeningExponent

Cyclic Strain Hardening Exponent

Type     Expression<Quantity>
Read Only    No
CyclicStrengthCoefficient

Cyclic Strength Coefficient

Type     Expression<Quantity>
Read Only    No
DuctilityCoefficient

Fatigue Ductility Coefficient

Type     Expression<Quantity>
Read Only    No
DuctilityExponent

Fatigue Ductility Exponent

Type     Expression<Quantity>
Read Only    No
StrainLifeCurve

Strain Life Curve

Type     Expression<Quantity>
Read Only    Yes
StrengthCoefficient

Fatigue Strength Coefficient

Type     Expression<Quantity>
Read Only    No
StrengthExponent

Fatigue Strength Exponent (Basquin's Exponent)

Type     Expression<Quantity>
Read Only    No
StressStrainCurve

Stress-Strain Curve

Type     Expression<Quantity>
Read Only    Yes

StreamLine

A result that displays flow paths within a vector field.

Properties

Direction

The integration direction to create streamlines.

Type     DirectionType
Read Only    No
Distribution

The method used to distribute seed points.

Type     SeedPointDistributionType
Read Only    No
EndTime

The maximum integration time of streamlines.

Type     Quantity
Read Only    No
EndTimeFactor

The amount my which the maximum integration time is scaled when creating animated streamlines.

Type     float
Read Only    No
EvaluateFullRange

Whether or not to evaluate all time points in the evaluation

Type     bool
Read Only    No
FadeLineSegments

Controls if line segments fade towards the end.

Type     bool
Read Only    No
FixedStepSize

The size of integration steps in streamline creation when using a fixed step size.

Type     float
Read Only    No
LastAutomaticDisplayText

No details are provided for this entry.

Type     string
Read Only    No
Location

The Location over which the Result is to be evaluated.

Type     LocationSet
Read Only    No
MeshDistribution

Defines how the mesh is sampled to create seed points.

Type     SeedPointMeshDistributionType
Read Only    No
NSteps

The maximum number of integration steps in streamline creation.

Type     uint
Read Only    No
ResultName

No details are provided for this entry.

Type     string
Read Only    No
RibbonWidth

The width of streamline ribbon display.

Type     double
Read Only    No
SegmentRatio

The length of segments when displaying dashed streamlines.

Type     float
Read Only    No
SkipFactor

How many nodes or elements are skipped when sampling mesh to generate seed points.

Type     uint
Read Only    No
StepSize

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

Type     StepSizeType
Read Only    No
StreamLineColorOption

How the streamline is colored.

Type     StreamlineColorOption
Read Only    No
StreamLineDisplayStyle

Controls the display style of the streamlines.

Type     StreamLineDisplayStyle
Read Only    No
StreamLineShape

The line display style for the streamlines.

Type     StreamLineShapeDef
Read Only    No
StreamLineStyle

THe streamline line style.

Type     StreamLineStyle
Read Only    No
SymbolScaleFactor

The size factor of streamline symbols.

Type     double
Read Only    No
SymbolSegmentDensity

The number of symbols and segments per streamline

Type     int
Read Only    No
SymbolShape

The symbol used on streamline display.

Type     SymbolShape
Read Only    No
TubeDiameter

The diameter of streamline tube display.

Type     double
Read Only    No
UniformDistributionSize

The target number of seed points.

Type     uint
Read Only    No
Variable

The vector variable used to create the streamlines.

Type     Expression<Quantity>
Read Only    Yes
VolumetricGridSpacing

The spacing of uniform grid sampling.

Type     Quantity
Read Only    No
WireThickness

The thickness of streamline wire display.

Type     double
Read Only    No

SummaryParametersExtension

Summary of Result values

Properties

Average

The calculated average of the Quantity of interest.

Type     Expression<Quantity>
Read Only    Yes
Max

The calculated maximum value of the Quantity in this Result.

Type     Expression<Quantity>
Read Only    Yes
Min

The calculated minimum value of the Quantity in this Result.

Type     Expression<Quantity>
Read Only    Yes
Sum

The calculated Sum total of the Quantity being evaluated in this Result.

Type     Expression<Quantity>
Read Only    Yes
SumX

The calculated Sum total of the X-component of the Quantity evaluated in this Result.

Type     Expression<Quantity>
Read Only    Yes
SumY

The calculated Sum total of the Y-component of the Quantity evaluated in this Result.

Type     Expression<Quantity>
Read Only    Yes
SumZ

The calculated Sum total of the Z-component of the Quantity evaluated in this Result.

Type     Expression<Quantity>
Read Only    Yes

SuppressControl

Settings for the suppression of geometry or mesh in a Configuration.

Properties

PartSelections

Part selection for suppression

Type     LocationSet
Read Only    No

Methods

GenerateConfigureControlCommand

Generates the output for a specific Configure Control.


SutherlandThreeCoefficientDefinition

The three coefficient model definition.

Properties

DisplayText

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.

Type     string
Read Only    No
EffectiveTemperature

Gets or sets the effective temperature.

Type     Expression<Quantity>
Read Only    No
ReferenceTemperature

Gets or sets the reference temperature.

Type     Expression<Quantity>
Read Only    No
ReferenceViscosity

Gets or sets the reference viscosity.

Type     Expression<Quantity>
Read Only    No

SutherlandTwoCoefficientDefinition

The two coefficient model definition

Properties

CoefficientC1

Gets or sets the coefficient c1.

Type     Expression<Quantity>
Read Only    No
CoefficientC2

Gets or sets the coefficient c2.

Type     Expression<Quantity>
Read Only    No
DisplayText

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.

Type     string
Read Only    No

TableResult

No details are provided for this entry.

Properties

Data

No details are provided for this entry.

Type     List<List<Quantity>>
Read Only    Yes
EvaluateFullRange

Whether or not to evaluate all time points in the evaluation

Type     bool
Read Only    No
LastAutomaticDisplayText

No details are provided for this entry.

Type     string
Read Only    No

TensileUltimateStrength

The Tensile Ultimate Strength model.

Can be applied to Structural analyses

Properties

Magnitude

Gets or sets the magnitude.

Type    Expression<Quantity>
Read Only    No

TensileYieldStrength

The Tensile Yield Strength model.

Can be applied to Structural analyses

Properties

Magnitude

Gets or sets the magnitude.

Type    Expression<Quantity>
Read Only    No

ThreeCoefficientDefinition

The three coefficient definition

Properties

DisplayText

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.

Type     string
Read Only    No
ReferenceTemperature

Gets or sets the reference temperature.

Type     Expression<Quantity>
Read Only    No
ReferenceViscosity

Gets or sets the reference viscosity.

Type     Expression<Quantity>
Read Only    No
TemperatureExponent

Gets or sets the temperature exponent.

Type     Expression<Quantity>
Read Only    No

TimeDependentParametersExtension

Time dependent parameters for post objects

Properties

Time

The time for a Transient analysis.

Type     Expression<Quantity>
Read Only    No

Transcript

Controls the contents of a Transcript monitor.

Properties

Filename

The name of the file to be monitored in a Transcript.

Type     string
Read Only    No
SourceType

The data source for the Transcript monitor.

Type     TranscriptType
Read Only    No

TranslationTransform

Translates a reference frame by a vector.

Properties

RelativeToType

Define the translation vector relative to Local or Parent. This is a simplification of the TranslationVector RelativeTo property

Type     RelativeToType
Read Only    No
Suppress

Suppress/Unsuppress the transform

Type     bool
Read Only    No

TwoCoefficientDefinition

The two coefficient definition.

Properties

DimensionalCoefficientB

Gets or sets the dimensional coefficient B.

Type     Expression<Quantity>
Read Only    No
DisplayText

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.

Type     string
Read Only    No
TemperatureExponent

Gets or sets the temperature exponent.

Type     Expression<Quantity>
Read Only    No

UniversalTriplet

Representation of a point or vector in cartesian, cylindrical, and spherical coordinates

Properties

CoordinateType

The type of coordinate: Cartesian, Cylindrical, or Spherical

Type     TripletType
Read Only    No

UniversalVectorDefinition

Collection of properties to define a UniversalVector

Properties

CalculationMethod

Calculation method for defining the vector from geometry

Type     VectorCalculationMethod
Read Only    No
DefineBy

Method for defining the vector

Type     CoordinateInputMethod
Read Only    No
Location

Location to define the vector

Type     LocationSet
Read Only    No
Magnitude

Magnitude of the vector

Type     Expression<Quantity>
Read Only    No
RelativeTo

Frame of reference for the vector

Type     ReferenceFrame
Read Only    No
ReverseDirection

Flag to reverse the vector direction when defining from Geometry

Type     bool
Read Only    No
VectorDefineBy

Define the vector from magnitude/direction or components

Type     UniversalVectorDefineBy
Read Only    No

VectorResult

A result object that displays the magnitude and direction of a vector field.

Properties

CalculateAverage

Set to true if averages are to be calculated as part of the Result evaluation.

Type     bool
Read Only    No
Distribution

The method for defining vector seed points.

Type     SeedPointDistributionType
Read Only    No
EvaluateFullRange

Whether or not to evaluate all time points in the evaluation

Type     bool
Read Only    No
LastAutomaticDisplayText

No details are provided for this entry.

Type     string
Read Only    No
Location

The Location over which the Result is to be evaluated.

Type     LocationSet
Read Only    No
MeshDistribution

Defines how the mesh is sampled to create seed points.

Type     SeedPointMeshDistributionType
Read Only    No
RelativeTo

The Reference Frame which the result is relative to

Type     ReferenceFrame
Read Only    No
ResultName

No details are provided for this entry.

Type     string
Read Only    No
SimulationStep

The Simulation Step object reference for a multi-step analysis.

Type     SolutionStep
Read Only    No
SkipFactor

How many nodes or elements are skipped when sampling mesh to generate seed points.

Type     uint
Read Only    No
SymbolLength

Controls how symbol length is determined.

Type     SymbolLengthOptions
Read Only    No
SymbolScaleFactor

The scale factor for symbol size.

Type     double
Read Only    No
SymbolShape

The symbol to be used to display the vectors.

Type     SymbolShape
Read Only    No
UniformDistributionSize

The approximate number of symbols to be displayed.

Type     uint
Read Only    No
Variable

The solution variable to be displayed

Type     Expression<Quantity>
Read Only    No
VolumetricGridSpacing

The spacing of uniform grid sampling.

Type     Quantity
Read Only    No

VirtualPrimitiveBox

This class represents box.

Properties

CreateSelectionSets

Flag to enable/disable selection set creation

Type     bool
Read Only    No

VirtualPrimitiveBoxConstraint

This class extends VirtualPrimitiveBox class. Contains properties like Selection Method, Cushioning, Location etc.

Properties

CushionXminus

Gets or sets the -X cushion value for non-uniform cushion.

Type     Expression<Quantity>
Read Only    No
CushionXplus

Gets or sets the +X cushion value for non-uniform cushion.

Type     Expression<Quantity>
Read Only    No
CushionYminus

Gets or sets the -Y cushion value for non-uniform cushion.

Type     Expression<Quantity>
Read Only    No
CushionYplus

Gets or sets the +Y cushion value for non-uniform cushion.

Type     Expression<Quantity>
Read Only    No
CushionZminus

Gets or sets the -Z cushion value for non-uniform cushion.

Type     Expression<Quantity>
Read Only    No
CushionZplus

Gets or sets the +Z cushion value for non-uniform cushion.

Type     Expression<Quantity>
Read Only    No
EntitiesInSelection

Gets or sets the entites to be enclosed.

Type     LocationSet
Read Only    No
SelectionMethod

Gets or sets the options for choosing between box creation methods.

Type     PrimitiveBoxCreationMethod
Read Only    No
TypeOfCushion

Gets or sets the option to select between Uniform or Non-Uniform cushion around box.

Type     BoxCushionType
Read Only    No
UniformCushionValue

Gets or sets the uniform cushion value for uniform cushion.

Type     Expression<Quantity>
Read Only    No

Viscosity

The viscosity model provided via a specified expression.

Properties

Magnitude

The Magnitude is an expresion which evaluates to a Quantity with the correct units.

Type     Expression<Quantity>
Read Only    No

ViscosityCarreauShearAndTemperatureDependent

The Shear Rate and Temperature dependent model.

Properties

ActivationEnergy

Gets or sets the activation energy.

Type     Expression<Quantity>
Read Only    No
DisplayText

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.

Type     string
Read Only    No
InfiniteShearViscosity

Gets or sets the infinite shear viscosity.

Type     Expression<Quantity>
Read Only    No
PowerLawIndex

Gets or sets the index of the power law.

Type     Expression<Quantity>
Read Only    No
ReferenceTemperature

Gets or sets the reference temperature.

Type     Expression<Quantity>
Read Only    No
TimeConstant

Gets or sets the time constant.

Type     Expression<Quantity>
Read Only    No
ZeroShearViscosity

Gets or sets the zero shear viscosity.

Type     Expression<Quantity>
Read Only    No

ViscosityCarreauShearRateDependent

The Shear Rate dependent model.

Properties

DisplayText

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.

Type     string
Read Only    No
InfiniteShearViscosity

Gets or sets the infinite shear viscosity.

Type     Expression<Quantity>
Read Only    No
PowerLawIndex

Gets or sets the index of the power law.

Type     Expression<Quantity>
Read Only    No
TimeConstant

Gets or sets the time constant.

Type     Expression<Quantity>
Read Only    No
ZeroShearViscosity

Gets or sets the zero shear viscosity.

Type     Expression<Quantity>
Read Only    No

ViscosityCrossShearAndTemperatureDependent

The Shear Rate and Temperature Dependent model.

Properties

ActivationEnergy

Gets or sets the activation energy.

Type     Expression<Quantity>
Read Only    No
DisplayText

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.

Type     string
Read Only    No
PowerLawIndex

Gets or sets the index of the power law.

Type     Expression<Quantity>
Read Only    No
ReferenceTemperature

Gets or sets the reference temperature.

Type     Expression<Quantity>
Read Only    No
TimeConstant

Gets or sets the time constant.

Type     Expression<Quantity>
Read Only    No
ZeroShearViscosity

Gets or sets the zero shear viscosity.

Type     Expression<Quantity>
Read Only    No

ViscosityCrossShearRateDependent

The Shear Rate Dependent model.

Properties

DisplayText

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.

Type     string
Read Only    No
PowerLawIndex

Gets or sets the index of the power law.

Type     Expression<Quantity>
Read Only    No
TimeConstant

Gets or sets the time constant.

Type     Expression<Quantity>
Read Only    No
ZeroShearViscosity

Gets or sets the zero shear viscosity.

Type     Expression<Quantity>
Read Only    No

ViscosityHerschelBulkleyShearAndTemperatureDependent

The Shear Rate and Temperature dependent model.

Properties

ActivationEnergy

Gets or sets the activation energy.

Type     Expression<Quantity>
Read Only    No
ConsistencyIndex

Gets or sets the index of the consistency.

Type     Expression<Quantity>
Read Only    No
CriticalShearRate

Gets or sets the critical shear rate.

Type     Expression<Quantity>
Read Only    No
DisplayText

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.

Type     string
Read Only    No
PowerLawIndex

Gets or sets the index of the power law.

Type     Expression<Quantity>
Read Only    No
ReferenceTemperature

Gets or sets the reference temperature.

Type     Expression<Quantity>
Read Only    No
YieldStressThreshold

Gets or sets the yield stress threshold.

Type     Expression<Quantity>
Read Only    No

ViscosityHerschelBulkleyShearRateDependent

The Shear Rate dependent model.

Properties

ConsistencyIndex

Gets or sets the index of the consistency.

Type     Expression<Quantity>
Read Only    No
CriticalShearRate

Gets or sets the critical shear rate.

Type     Expression<Quantity>
Read Only    No
DisplayText

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.

Type     string
Read Only    No
PowerLawIndex

Gets or sets the index of the power law.

Type     Expression<Quantity>
Read Only    No
YieldStressThreshold

Gets or sets the yield stress threshold.

Type     Expression<Quantity>
Read Only    No

ViscosityNonNewtonianPowerLawShearAndTemperatureDependent

The Shear Rate and Temperature dependent model.

Properties

ActivationEnergy

Gets or sets the activation energy.

Type     Expression<Quantity>
Read Only    No
ConsistencyIndex

Gets or sets the index of the consistency.

Type     Expression<Quantity>
Read Only    No
DisplayText

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.

Type     string
Read Only    No
MaximumViscosityLimit

Gets or sets the maximum viscosity limit.

Type     Expression<Quantity>
Read Only    No
MinimumViscosityLimit

Gets or sets the minimum viscosity limit.

Type     Expression<Quantity>
Read Only    No
PowerLawIndex

Gets or sets the index of the power law.

Type     Expression<Quantity>
Read Only    No
ReferenceTemperature

Gets or sets the reference temperature.

Type     Expression<Quantity>
Read Only    No

ViscosityNonNewtonianPowerLawShearRateDependent

The Shear Rate dependent model

Properties

ConsistencyIndex

Gets or sets the index of the consistency.

Type     Expression<Quantity>
Read Only    No
DisplayText

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.

Type     string
Read Only    No
MaximumViscosityLimit

Gets or sets the maximum viscosity limit.

Type     Expression<Quantity>
Read Only    No
MinimumViscosityLimit

Gets or sets the minimum viscosity limit.

Type     Expression<Quantity>
Read Only    No
PowerLawIndex

Gets or sets the index of the power law.

Type     Expression<Quantity>
Read Only    No

VolumeExtractionRegion

Volume Extraction Region specifies the settings used when extracting a volume region for a wrap task.

Available options:

GeometryLocationSpecifies the surounding bodies around the volume to be extracted.
PointSpecifies a reference point where the volume is located to extact.
ExtraRefineLevelSpecifies number of extra refinement levels.
ImprintIterationsSpecifies number of imprinting iterations for feature capturing.
AggressiveImprintIterationsSpecifies additional iterations for aggressive imprinting to improve feature capture.

Properties

FeatureResolution

Sets the Feature Resolution factor to be used for all Mesh Regions.

Type    double
Read Only    No
Location

A common property for all sub meshing objects with a defined Geometry Filter

Type    LocationSet
Read Only    No
Point

Specifies a reference point for where the volume to extract is located.

Type    Point
Read Only    No
RegionBehavior

Specifies the meshing region behavior.

Available options:

WrapSimplifies unclean geometry before sewing.
PassThroughToSewBypasses simplification of unclean geometry before sewing.

Type    RegionBehavior
Read Only    No
UseAutomaticallyDefinedLocation

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.

Type    bool
Read Only    No
WrapMethod

Specifies wrap method for the meshing region.

Available options:

ShrinkWrap
CutWrap

Type    WrapMethod
Read Only    No

VolumeSimplificationRegion

Volume Simplification specifies the settings used when simplifying a model within a wrap task.

Available options:

GeometryLocationSpecifies the bodies and parts to be wrapped.
GroupingOptionSpecifies grouping option for the bodies being wrapped.
ExtraRefineLevelSpecifies number of extra refinement levels.
ImprintIterationsSpecifies number of imprinting iterations for feature capturing.
AggressiveImprintIterationsSpecifies additional iterations for aggressive imprinting to improve feature capture.

Properties

FeatureResolution

Sets the Feature Resolution factor to be used for all Mesh Regions.

Type    double
Read Only    No
Location

A common property for all sub meshing objects with a defined Geometry Filter

Type    LocationSet
Read Only    No
MergeBodies

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.

Type    bool
Read Only    No
RegionBehavior

Specifies the meshing region behavior.

Available options:

WrapSimplifies unclean geometry before sewing.
PassThroughToSewBypasses simplification of unclean geometry before sewing.

Type    RegionBehavior
Read Only    No
UseAutomaticallyDefinedLocation

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.

Type    bool
Read Only    No
WrapMethod

Specifies wrap method for the meshing region.

Available options:

ShrinkWrap
CutWrap

Type    WrapMethod
Read Only    No

Wrap

Volume creation task uses specialized boundary wrapping to extract a well-connected surface mesh for the selected geometry.

Properties

MeshResolution

Defines the resolution for automatically calculating global meshing inputs. Selecting a higher resolution generates a better quality mesh.

Type     int
Read Only    No
Reassociate

Specifies whether the current output model should be used for reassociating so that reference Ids are persistent or whether new references should be created.

Type     bool
Read Only    No
UsePredefinedSettings

Automatically calculates the global sizing values based on the resolution value.

Type     bool
Read Only    No

Fluids Data Entities

AbsorptionCoefficientModel

Configure parameters for absorption coefficient in radiation heat transfer.

Properties

MaterialAbsorptionCoefficient

Specify absorption coefficient for radiation heat transfer.

Type     IDictionary<string, Object>
Read Only    No
PathLength

Set path length.

Type     Expression<Quantity>
Read Only    No

Absorptivity

Set absorptivity parameters.

Properties

DiffuseHemispherical

Specify diffuse hemispherical absorptivity.

Type     Expression<Quantity>
Read Only    No
DirectIR

Specify direct infra-red absorptivity.

Type     Expression<Quantity>
Read Only    No
DirectVisible

Specify direct visible absorptivity.

Type     Expression<Quantity>
Read Only    No

Acoustics

Set the acoustics initial conditions.

Properties

AcousticPressure

Set the acoustic pressure value.

Type     Expression<Quantity>
Read Only    No
AcousticVelocity

Set the velocity direction in different coordinate system.

Type     AcousticVelocity
Read Only    No
Option

context to be documented

Type    Option
Possible Values:    
AcousticPressureAndVelocity
Read Only    No

Acoustics

Set boundary conditions related to Acoustics.

Properties

Admittance

Set admittance value for acoustics BC.

Type     Expression<double>
Read Only    No
Option

context to be documented

Type    Option
Possible Values:    
Admittance
NonReflecting
Wall
Read Only    No

AcousticVelocity

Set the velocity direction in different coordinate system.

Properties

CartesianVelocityComponents

Set the velocity component in Cartesian coordinate system.

Type     List<Expression<Quantity>>
Read Only    No
CylindricalVelocityComponents

Set the velocity component in cylindrical coordinate system.

Type     List<Expression<Quantity>>
Read Only    No
Option

context to be documented

Type    Option
Possible Values:    
CartesianComponents
CylindricalComponents
Read Only    No

AdvancementControl

Configure advance control setting for solver.

Properties

EnergyControl

Configure solution advancement process for energy.

Type     EnergyControl
Read Only    No
FlowControl

Configure solution advancement process for momentum.

Type     FlowControl
Read Only    No
RadiationControl

Configure solution advancement process for radiation.

Type     IDictionary<string, Object>
Read Only    No
SpeciesControl

Configure solution advancement process for species.

Type     IDictionary<string, Object>
Read Only    No
TurbulenceControl

Configure solution advancement process for turbulence.

Type     IDictionary<string, Object>
Read Only    No
UseCommonSpeciesSetting

Enables to use same settings for all the species.

Type     bool
Read Only    No
UserVariableControl

Configure solution advancement process for user variable.

Type     IDictionary<string, Object>
Read Only    No

Advection

Configure advection schemes for governing equations

Properties

AdvectionDefaultSetting

Select default advection scheme used by all equations without explicit overrides.

Type    Option
Possible Values:    
BoundedCentralDifference
CentralDifference
FirstOrderUpwind
SecondOrderUpwind
UnboundedSecondOrderUpwind
Read Only    No
AdvectionEquation

Configure advection scheme

Type     IDictionary<string, Object>
Read Only    No
BlendFactor

Specify blend factor

Type     Expression<Quantity>
Read Only    No
FirstToHigherOrderBlending

Turn on first to higher order order blending.

Type     bool
Read Only    No

AFDPhysicsOptions

No details are provided for this entry.

Properties

No Properties.


AFDPhysicsOptions

No details are provided for this entry.

Properties

DisplayText

No details are provided for this entry.

Type     string
Read Only    No

AllowReverseFlow

Configure reverse flow for the boundary.

Properties

BackflowDirection

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.

Type     BackflowDirection
Read Only    No
BackflowPressureSpecification

Select the option to specify the backflow pressure.

Type     BackflowPressureSpecification
Read Only    No
Option

Enable/Disable reverse flow.

Type    Option
Possible Values:    
No
Yes
Read Only    No

AngularDiscretization

Configure parameters for angular discretization and pixelation for the DO mode.

Properties

PhiDivisions

Set Phi Divisions, which is the number of control angles used to discretize each octant of the angular space.

Type     int
Read Only    No
PhiPixels

Set Phi Pixels, which is used to control the pixelation that accounts for any control volume overhang.

Type     int
Read Only    No
ThetaDivisions

Set Theta Divisions, which is the number of control angles used to discretize each octant of the angular space.

Type     int
Read Only    No
ThetaPixels

Set Theta Pixels, which is used to control the pixelation that accounts for any control volume overhang.

Type     int
Read Only    No

BackflowDirection

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.

Properties

CartesianDirectionComponents

Set the component in the different direction.

Type     List<Expression<Quantity>>
Read Only    No
CylindricalDirectionComponents

Set the component in the different direction.

Type     List<Expression<Quantity>>
Read Only    No
Option

Select option for backflow direction specification.

Type    Option
Possible Values:    
Cartesian
Cylindrical
FromNeighboringCell
NormalToBoundary
Read Only    No

BackflowPressureSpecification

Select the option to specify the backflow pressure.

Properties

Option

Select option for backflow pressure specification.

Type    Option
Possible Values:    
EntrainmentPressure
TotalPressure
Read Only    No

BeamDirection

Configure radiation beam direction.

Properties

Option

Choose a beam direction from the available options.

Type    Option
Possible Values:    
SpecifiedValue
UseSolarLoadModelSetting
Read Only    No
Value

Specify beam direction vector.

Type     List<Expression<double>>
Read Only    No

BeamWidth

Set beam width for an external semi-transparent wall in terms of the Theta and Phi extents.

Properties

Phi

Set Phi.

Type     Expression<double>
Read Only    No
Theta

Set Theta.

Type     Expression<double>
Read Only    No

Boundary

Set boundary.

Properties

Acoustics

Set boundary conditions related to Acoustics.

Type     Acoustics
Read Only    No
BoundaryLocations

Set the boundary location.

Type     List<string>
Read Only    No
BoundaryReferenceFrame

Set the reference frame for boundary from (physics region or all available reference frames).

Type     BoundaryReferenceFrame
Read Only    No
BoundaryType

Set different boundary type.

Type    Option
Possible Values:    
Axis
Farfield
Inlet
Opening
Outlet
Solid
Symmetry
Wall
Read Only    No
Energy

Set boundary conditions related to Energy.

Type     Energy
Read Only    No
Flow

Configure flow specification for the boundary.

Type     Flow
Read Only    No
ParticleBoundaryConditions

to be documented

Type     ParticleBoundaryConditions
Read Only    No
Radiation

Configure radiation specifications for boundary.

Type     Radiation
Read Only    No
Regime

Configure flow regime.

Type     Regime
Read Only    No
TotalConditionFrameType

Set the reference frame for total pressure and total temperature.

Type     TotalConditionFrameType
Read Only    No
Turbulence

Set turbulence related boundary conditions in the model.

Type     Turbulence
Read Only    No
UserScalarBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No
UserVectorBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No

BoundaryInitializer

No details are provided for this entry.

Properties

No Properties.


BoundaryReferenceFrame

Set the reference frame for boundary from (physics region or all available reference frames).

Properties

FrameName

Select a frame from the defined reference frames.

Type     DataObject
Read Only    No
Option

Set the reference frame for boundary from (physics region or all available reference frames).

Type    Option
Possible Values:    
SpecifyFrame
UseFromPhysicsRegion
Read Only    No

BuoyancyModel

Configure Buoyancy Model.

Properties

BuoyancyModelDetails

Configure Buoyancy Model.

Type     BuoyancyModelDetails
Read Only    No
BuoyancyReferenceLocation

Sets location where hydrostatic pressure due to buoyancy is zero.

Type     BuoyancyReferenceLocation
Read Only    No
GravityDefinition

Configure gravity definition.

Type     GravityDefinition
Read Only    No
Option

context to be documented

Type    Option
Possible Values:    
Off
On
ParticleBuoyancyOnly
Read Only    No

BuoyancyModelDetails

Configure Buoyancy Model.

Properties

OperatingDensity

Sets the operating density value.

Type     Expression<Quantity>
Read Only    No
OperatingTemperature

Sets the operating temperature to use with the Boussinesq approximation.

Type     Expression<Quantity>
Read Only    No
Option

context to be documented

Type    Option
Possible Values:    
Boussinesq
DensityDifference
Read Only    No
ThermalExpansionCoefficient

Sets the thermal expansion coefficient value.

Type     Expression<Quantity>
Read Only    No

BuoyancyReferenceLocation

Sets location where hydrostatic pressure due to buoyancy is zero.

Properties

Coordinates

Sets the coordinates value of reference pressure location.

Type     List<Expression<Quantity>>
Read Only    No
Option

context to be documented

Type    Option
Possible Values:    
Automatic
CartesianCoordinates
Read Only    No

CalculationControl

Configure calculation specific settings.

Properties

IterationControl

Configure settings for iteration control.

Type     IterationControl
Read Only    No
ResidualControl

Configure settings to control residual information.

Type     ResidualControl
Read Only    No
SolutionAdvancementExponent

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.

Type     Expression<double>
Read Only    No

CartesianInertialResistanceCoefficients

Set the orthotropic inertial resistance coefficients in cartesian coordinates.

Properties

XCoefficient

to be documented

Type     Expression<Quantity>
Read Only    No
YCoefficient

to be documented

Type     Expression<Quantity>
Read Only    No
ZCoefficient

to be documented

Type     Expression<Quantity>
Read Only    No

CartesianViscousResistanceCoefficients

Set the orthotropic viscous resistance coefficients (inverse permeability) in cartesian coordinates.

Properties

XCoefficient

to be documented

Type     Expression<Quantity>
Read Only    No
YCoefficient

to be documented

Type     Expression<Quantity>
Read Only    No
ZCoefficient

to be documented

Type     Expression<Quantity>
Read Only    No

Clustering

Configure methods and settings for creating surface clusters.

Properties

FacesPerSurfaceCluster

sets the number of faces per surface cluster for the wall.

Type     int
Read Only    No
MaximumDistanceFromCriticalZone

Set maximum distance of a zone form a critical zone for which view factors will be calculated.

Type     Expression<Quantity>
Read Only    No
MaximumFacesPerSurfaceCluster

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.

Type     int
Read Only    No

Components

Allows to specify the velocity component in different coordinate system.

Properties

CartesianVelocityComponents

Set the velocity component in Cartesian coordinate system.

Type     List<Expression<Quantity>>
Read Only    No
CylindricalVelocityComponents

Set the velocity component in cylindrical coordinate system.

Type     List<Expression<Quantity>>
Read Only    No
Option

Allows to specify the velocity component in different coordinate system.

Type    Option
Possible Values:    
Cartesian
Cylindrical
Read Only    No

ConnectionType

Choose connection type for interface.

Properties

Option

context to be documented

Type    Option
Possible Values:    
Periodic
Standard
Read Only    No
PeriodicityType

Choose periodicity type.

Type     PeriodicityType
Read Only    No

ContourResultOptions

No details are provided for this entry.

Properties

UseNodeValues

No details are provided for this entry.

Type     bool
Read Only    No

ConvectionAndRadiationBoundary

Set boundary.

Properties

Acoustics

Set boundary conditions related to Acoustics.

Type     Acoustics
Read Only    No
BoundaryLocations

Set the boundary location.

Type     List<string>
Read Only    No
BoundaryReferenceFrame

Set the reference frame for boundary from (physics region or all available reference frames).

Type     BoundaryReferenceFrame
Read Only    No
BoundaryType

Set different boundary type.

Type    Option
Possible Values:    
Axis
Farfield
Inlet
Opening
Outlet
Solid
Symmetry
Wall
Read Only    No
Energy

Set boundary conditions related to Energy.

Type     Energy
Read Only    No
Flow

Configure flow specification for the boundary.

Type     Flow
Read Only    No
ParticleBoundaryConditions

to be documented

Type     ParticleBoundaryConditions
Read Only    No
Radiation

Configure radiation specifications for boundary.

Type     Radiation
Read Only    No
Regime

Configure flow regime.

Type     Regime
Read Only    No
TotalConditionFrameType

Set the reference frame for total pressure and total temperature.

Type     TotalConditionFrameType
Read Only    No
Turbulence

Set turbulence related boundary conditions in the model.

Type     Turbulence
Read Only    No
UserScalarBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No
UserVectorBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No

ConvectionBoundary

Set boundary.

Properties

Acoustics

Set boundary conditions related to Acoustics.

Type     Acoustics
Read Only    No
BoundaryLocations

Set the boundary location.

Type     List<string>
Read Only    No
BoundaryReferenceFrame

Set the reference frame for boundary from (physics region or all available reference frames).

Type     BoundaryReferenceFrame
Read Only    No
BoundaryType

Set different boundary type.

Type    Option
Possible Values:    
Axis
Farfield
Inlet
Opening
Outlet
Solid
Symmetry
Wall
Read Only    No
Energy

Set boundary conditions related to Energy.

Type     Energy
Read Only    No
Flow

Configure flow specification for the boundary.

Type     Flow
Read Only    No
ParticleBoundaryConditions

to be documented

Type     ParticleBoundaryConditions
Read Only    No
Radiation

Configure radiation specifications for boundary.

Type     Radiation
Read Only    No
Regime

Configure flow regime.

Type     Regime
Read Only    No
TotalConditionFrameType

Set the reference frame for total pressure and total temperature.

Type     TotalConditionFrameType
Read Only    No
Turbulence

Set turbulence related boundary conditions in the model.

Type     Turbulence
Read Only    No
UserScalarBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No
UserVectorBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No

ConvergenceCriteria

Configure convergence criteria for residual, monitor, etc.

Properties

ImbalanceConvergence

Configure imbalance convergence.

Type     ImbalanceConvergence
Read Only    No
MonitorConvergence

Set convergence criteria for monitors.

Type     MonitorConvergence
Read Only    No
ResidualConvergence

Configure convergence criteria for residuals.

Type     ResidualConvergence
Read Only    No
UserDefinedConvergence

Create user defined convergence.

Type     UserDefinedConvergence
Read Only    No

CoupledControls

Configure coupled controls.

Properties

FixedCycleControls

Configure parameters that control the V, W and F cycles.

Type     FixedCycleControls
Read Only    No

CouplingControl

Configure settings for solution advancement.

Properties

FlowCoupling

Allows to choose solver formulations for density based solver.

Type     FlowCoupling
Read Only    No
PressureVelocityCoupling

Allows to choose different schemes for pressure-velocity coupling.

Type     PressureVelocityCoupling
Read Only    No

CylindricalInertialResistanceCoefficients

Set the orthotropic inertial resistance coefficients in cylindrical coordinates.

Properties

AxialCoefficient

to be documented

Type     Expression<Quantity>
Read Only    No
RadialCoefficient

to be documented

Type     Expression<Quantity>
Read Only    No
TangentialCoefficient

to be documented

Type     Expression<Quantity>
Read Only    No

CylindricalViscousResistanceCoefficients

Set the orthotropic viscous resistance coefficients (inverse permeability) in cylindrical coordinates.

Properties

AxialCoefficient

to be documented

Type     Expression<Quantity>
Read Only    No
RadialCoefficient

to be documented

Type     Expression<Quantity>
Read Only    No
TangentialCoefficient

to be documented

Type     Expression<Quantity>
Read Only    No

DampingZone

Define how the Damping layer must behave.

Properties

MaximumDamping

Set the maximum damping of the damping layer.

Type     Expression<Quantity>
Read Only    No
Option

context to be documented

Type    Option
Possible Values:    
Off
On
Read Only    No
Thickness

Set the thickness of the damping layer, starting from the NRBC.

Type     Expression<Quantity>
Read Only    No

DateAndTime

Configure parameters to specify date and time.

Properties

DayOfYear

Configure parameters to specify day and month.

Type     DayOfYear
Read Only    No
TimeOfDay

Configure parameters to specify hour and minutes.

Type     TimeOfDay
Read Only    No

DayOfYear

Configure parameters to specify day and month.

Properties

Day

Set parameters to specify day

Type     int
Read Only    No
Month

Set parameters to specify month.

Type     int
Read Only    No

DesModel

Specifies turbulent flow to be calculated using the Detached Eddy Simulation model.

Properties

ShieldingFunction

Choose among the shielding functions.

Type    Option
Possible Values:    
DDES
IDDES
Read Only    No

DiffuseSolarIrradiation

Configure Diffuse Solar Irradiation, which is the amount of energy per unit area due to diffuse solar irradiation.

Properties

Value

Specify the value

Type     Expression<Quantity>
Read Only    No

DiffusionModel

Configure the diffusion flux of species.

Properties

InletDiffusion

Enable/Disable the diffusion flux of species at inlet

Type     bool
Read Only    No
KinematicDiffusivity

Set mixture average diffusivity.

Type     Expression<Quantity>
Read Only    No
Option

Allows to choose between the models to calculate the diffusion fluxes.

Type    Option
Possible Values:    
FicksLaw
MixtureAveraged
StefanMaxwellDiffusion
UnityLewisNumber
Read Only    No
ThermalDiffusion

Enable/Disable the thermal diffusion model

Type     bool
Read Only    No

Direction

Allows to choose between Cartesian or cylindrical component to specify direction.

Properties

CartesianVectorComponents

Set the vector component in Cartesian coordinate system.

Type     List<Expression<Quantity>>
Read Only    No
CylindricalVectorComponents

Set the vector component in cylindrical coordinate system.

Type     List<Expression<Quantity>>
Read Only    No
Option

Allows to choose between Cartesian or cylindrical component to specify direction.

Type    Option
Possible Values:    
CartesianComponents
CylindricalComponents
Read Only    No

DirectSolarIrradiation

Configure Direct Solar Irradiation, which is the amount of energy per unit area due to direct solar irradiation.

Properties

Value

Specify the value, default is 0

Type     Expression<Quantity>
Read Only    No

DiscretizationControl

Configure conversion of scalar transport equations to discrete algebraic equations

Properties

SpatialDiscretization

Configure interpolation of convection terms of quantities to control volumes

Type     SpatialDiscretization
Read Only    No

Duration

No details are provided for this entry.

Properties

No Properties.


EARSMRgKOmegaBSLModelConstants

Configure KOmega BSL model constants.

Properties

Betai1

Constant used in dissipation of Omega.

Type     Expression<double>
Read Only    No
Betai2

Constant used in dissipation of Omega.

Type     Expression<double>
Read Only    No
BetaStarInfinite

Constant used in modeling the Turbulence Dissipation.

Type     Expression<double>
Read Only    No
C1_0

Set model constant.

Type     Expression<double>
Read Only    No
C1_1

Set model constant.

Type     Expression<double>
Read Only    No
C2

Set model constant.

Type     Expression<double>
Read Only    No
C3

Set model constant.

Type     Expression<double>
Read Only    No
C4

Set model constant.

Type     Expression<double>
Read Only    No
Ceps1

Set C-epsilon1 for EARSMRg K-Omega Mean Base Line (BSL) Model.

Type     Expression<double>
Read Only    No
Ceps2

Set C-epsilon1 for EARSMRg K-Omega Mean Base Line (BSL) Model.

Type     Expression<double>
Read Only    No
Cmu

Set model constant.

Type     Expression<Quantity>
Read Only    No
TurbulenceEddyFrequencyPrandtlNumber1

Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Turbulence Eddy Frequency (omega) condition.

Type     Expression<double>
Read Only    No
TurbulenceEddyFrequencyPrandtlNumber2

Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Turbulence Eddy Frequency (omega) condition.

Type     Expression<double>
Read Only    No
TurbulenceKineticEnergyPrandtlNumber1

Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of turbulence kinetic energy via turbulent transport.

Type     Expression<double>
Read Only    No
TurbulenceKineticEnergyPrandtlNumber2

Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of turbulence kinetic energy via turbulent transport.

Type     Expression<double>
Read Only    No

EARSMWjKOmegaBSLModelConstants

Configure KOmega BSL model constants.

Properties

A1

Set model constant.

Type     Expression<double>
Read Only    No
A3

Set model constant.

Type     Expression<double>
Read Only    No
A4

Set model constant.

Type     Expression<double>
Read Only    No
AlphaInfinite

Set coefficient used in the Production of Omega.

Type     Expression<double>
Read Only    No
AlphaStarInfinite

Set this parameter to damp the turbulent viscosity causing a low-Reynolds number correction.

Type     Expression<double>
Read Only    No
Betai1

Set constant used in dissipation of Omega.

Type     Expression<double>
Read Only    No
Betai2

Set constant used in dissipation of Omega.

Type     Expression<double>
Read Only    No
BetaStarInfinite

Set constant used in modeling the Turbulence Dissipation.

Type     Expression<double>
Read Only    No
Cmu

Set model constant.

Type     Expression<Quantity>
Read Only    No
Cs

Set Smagorinsky constant.

Type     Expression<double>
Read Only    No
Mt0

Set Compressibility Correction.

Type     Expression<double>
Read Only    No
TurbulenceEddyFrequencyPrandtlNumber1

Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Turbulence Eddy Frequency (omega) condition.

Type     Expression<double>
Read Only    No
TurbulenceEddyFrequencyPrandtlNumber2

Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Turbulence Eddy Frequency (omega) condition.

Type     Expression<double>
Read Only    No
TurbulenceKineticEnergyPrandtlNumber1

Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of turbulence kinetic energy via turbulent transport.

Type     Expression<double>
Read Only    No
TurbulenceKineticEnergyPrandtlNumber2

Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of turbulence kinetic energy via turbulent transport.

Type     Expression<double>
Read Only    No
ZetaStar

Set model constant used in the Turbulence Dissipation.

Type     Expression<double>
Read Only    No

Energy

Allows to choose between different energy initial condition.

Properties

Option

Allows to choose between different energy initial condition.

Type    Option
Possible Values:    
Automatic
Temperature
Read Only    No
Temperature

Set temperature at wall.

Type     Expression<Quantity>
Read Only    No

Energy

Set boundary conditions related to Energy.

Properties

ConvectionTemperature

Set external temperature at wall.

Type     Expression<Quantity>
Read Only    No
Emissivity

Set external emissivity.

Type     Expression<Quantity>
Read Only    No
EntrainmentTemperature

Specify entrainment temperature for thermal analysis.

Type     Expression<Quantity>
Read Only    No
HeatFlow

Set heat flow for thermal analysis.

Type     Expression<Quantity>
Read Only    No
HeatFlux

Set heat flux for thermal analysis.

Type     Expression<Quantity>
Read Only    No
HeatTransferCoefficient

Set heat transfer coefficient.

Type     Expression<Quantity>
Read Only    No
Option

Set boundary conditions related to Energy.

Type    Option
Possible Values:    
Convection
ConvectionAndRadiation
EntrainmentTemperature
HeatFlow
HeatFlux
Insulated
Radiation
StationaryFrameTotalEnthalpy
Temperature
TotalEnthalpy
TotalTemperature
Read Only    No
RadiationTemperature

Set external radiation temperature at wall.

Type     Expression<Quantity>
Read Only    No
Temperature

Set temperature at wall.

Type     Expression<Quantity>
Read Only    No
TotalTemperature

Set total temperature.

Type     Expression<Quantity>
Read Only    No

EnergyControl

Configure solution advancement process for energy.

Properties

CourantNumber

Set the Courant number for current equation.

Type     Expression<Quantity>
Read Only    No
EnergyPseudoTransient

Applies pseudo transient under-relaxation method. The under-relaxation is controlled through pseudo time step size.

Type     EnergyPseudoTransient
Read Only    No
ImplicitRelaxFactor

Set the value of under-relaxation factor for current equation.

Type     Expression<Quantity>
Read Only    No
Option

Allows to choose between relaxation factor, Courant number and pseudo-transient.

Type    Option
Possible Values:    
CourantNumber
None
PseudoTransient
RelaxationFactor
Read Only    No

EnergyInterfaceModel

Choose energy interface model.

Properties

ThermalResistance

to be documented

Type     Expression<Quantity>
Read Only    No

EnergyModel

Configure Energy Model.

Properties

EnergyModelForPhase

Configure Energy Phase Model.

Type     IDictionary<string, Object>
Read Only    No
EnergyModelPhaseInteraction

Configure Energy Model for phase interaction.

Type     IDictionary<string, Object>
Read Only    No
Option

Configure Energy Model.

Type    Option
Possible Values:    
Off
On
PhaseDependent
Read Only    No
TurbulenceEnergyInteraction

Configure Energy Model for turbulence interaction.

Type     TurbulenceEnergyInteraction
Read Only    No
ViscousHeating

Enable viscous heating.

Type    Option
Possible Values:    
Off
On
Read Only    No

EnergyNearWallTreatment

Incorporate near wall treatment for energy interaction model.

Properties

PFunction

Allows to choose between different energy wall treatment definitions.

Type    Option
Possible Values:    
Jayatilleke
LaunderSpalding
Read Only    No

EnergyPeriodicityModel

Allows to choose between different energy periodicity models.

Properties

UpstreamBulkTemperature

Set the upstream bulk temperature value.

Type     Expression<Quantity>
Read Only    No

EnergyPseudoTransient

Applies pseudo transient under-relaxation method. The under-relaxation is controlled through pseudo time step size.

Properties

LengthScaleCalculationMethod

Allows one to choose how the length scale is determined when using pseudo transient solution advancement.

Type     LengthScaleCalculationMethod
Read Only    No
Option

Allows one to select how the pseudo transient time scale is calculated for the energy equation.

Type    Option
Possible Values:    
Automatic
Off
UserSpecified
Read Only    No
PseudoTimestep

Set pseudo time step size.

Type     Expression<Quantity>
Read Only    No
RelativeScaleFactor

Set time scaling factor relative to the one specified for flow advancement

Type     Expression<double>
Read Only    No
TimestepScalingFactor

Set a scaling factor used to scale the calculated time step.

Type     Expression<Quantity>
Read Only    No

EnergySource

to be documented

Properties

Option

context to be documented

Type    Option
Possible Values:    
SourceDensity
TotalSource
Read Only    No
ReferenceFrameForSource

Set the reference frame for source terms.

Type     ReferenceFrameForSource
Read Only    No
SourceDensity

to be documented

Type     Expression<Quantity>
Read Only    No
SourceLocations

Set the topology locations for volume source.

Type     List<string>
Read Only    No
TotalSource

to be documented

Type     Expression<Quantity>
Read Only    No

ExternalBlackBodyTemperature

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.

Properties

BlackBodyTemperature

Set the black body temperature.

Type     Expression<Quantity>
Read Only    No

Farfield

Used to model a free-stream condition at infinity.

Properties

GaugeStaticPressure

Set the gauge static pressure value.

Type     Expression<Quantity>
Read Only    No
MachNumber

Set the mach number (ratio of speed of an object moving through a fluid and the local speed of sound).

Type     Expression<Quantity>
Read Only    No

FarFieldBoundary

Set boundary.

Properties

Acoustics

Set boundary conditions related to Acoustics.

Type     Acoustics
Read Only    No
BoundaryLocations

Set the boundary location.

Type     List<string>
Read Only    No
BoundaryReferenceFrame

Set the reference frame for boundary from (physics region or all available reference frames).

Type     BoundaryReferenceFrame
Read Only    No
BoundaryType

Set different boundary type.

Type    Option
Possible Values:    
Axis
Farfield
Inlet
Opening
Outlet
Solid
Symmetry
Wall
Read Only    No
Energy

Set boundary conditions related to Energy.

Type     Energy
Read Only    No
Flow

Configure flow specification for the boundary.

Type     Flow
Read Only    No
ParticleBoundaryConditions

to be documented

Type     ParticleBoundaryConditions
Read Only    No
Radiation

Configure radiation specifications for boundary.

Type     Radiation
Read Only    No
Regime

Configure flow regime.

Type     Regime
Read Only    No
TotalConditionFrameType

Set the reference frame for total pressure and total temperature.

Type     TotalConditionFrameType
Read Only    No
Turbulence

Set turbulence related boundary conditions in the model.

Type     Turbulence
Read Only    No
UserScalarBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No
UserVectorBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No

FixedCycleControls

Configure parameters that control the V, W and F cycles.

Properties

CoarseningRate

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.

Type     int
Read Only    No
CoupledFixedCycleSmoother

Choose smoother for coupled equations with fixed cycles.

Type    Option
Possible Values:    
GaussSeidel
ILU
Read Only    No
Factor

Set the value of factor.

Type     Expression<Quantity>
Read Only    No
MaximumCoarseLevels

Set the maximum number of coarse levels that will be built by multigrid solver.

Type     int
Read Only    No
MaximumCycles

Set the maximum number of multigrid cycles to be performed.

Type     int
Read Only    No
PostSweeps

Set the number of sweeps to perform after coarser level corrections have been applied.

Type     int
Read Only    No
PreSweeps

Set the number of sweeps to perform before moving to a coarser level.

Type     int
Read Only    No

FixedCycleControls

Configure parameters that control the V, W and F cycles.

Properties

CoarseningRate

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.

Type     int
Read Only    No
Factor

Set the value of factor.

Type     Expression<Quantity>
Read Only    No
MaximumCoarseLevels

Set the maximum number of coarse levels that will be built by multigrid solver.

Type     int
Read Only    No
MaximumCycles

Set the maximum number of multigrid cycles to be performed.

Type     int
Read Only    No
PostSweeps

Set the number of sweeps to perform after coarser level corrections have been applied.

Type     int
Read Only    No
PreSweeps

Set the number of sweeps to perform before moving to a coarser level.

Type     int
Read Only    No
ScalarFixedCycleSmoother

Choose smoother for scalars with fixed cycles.

Type    Option
Possible Values:    
GaussSeidel
ILU
Read Only    No

FlexibleCycleControls

Configure parameters that control the flexible multigrid cycle.

Properties

MaximumCycles

Set the maximum number of multigrid cycles to be performed.

Type     int
Read Only    No
Sweeps

Set the number of times to apply the smoothing method each time a relaxation is performed.

Type     int
Read Only    No

Flow

Configure the initial conditions.

Properties

GaugeStaticPressure

Set the gauge static pressure value.

Type     Expression<Quantity>
Read Only    No
MaintainConstantVelocityMagnitude

Enable to maintain constant velocity magnitude throughout the computational domain.

Type     bool
Read Only    No
NumberOfIterations

Set the number of iterations.

Type     int
Read Only    No
Option

Configure the initial conditions.

Type    Option
Possible Values:    
Automatic
StaticPressureAndVelocity
Read Only    No
Velocity

Allows to specify the velocity direction in different coordinate system.

Type     Velocity
Read Only    No

Flow

Configure flow specification for the boundary.

Properties

AllowReverseFlow

Configure reverse flow for the boundary.

Type     AllowReverseFlow
Read Only    No
Farfield

Used to model a free-stream condition at infinity.

Type     Farfield
Read Only    No
FlowDirection

Allows to specify the flow direction in different coordinate system.

Type     FlowDirection
Read Only    No
FullyDevelopedFlow

Configure the fully developed flow boundary condition.

Type     FullyDevelopedFlow
Read Only    No
MassFlow

Configure mass flow specifications for the boundary.

Type     MassFlow
Read Only    No
Option

Select boundary specification option.

Type    Option
Possible Values:    
Farfield
FreeSlip
FullyDevelopedFlow
MarangoniStress
MassFlow
NoSlip
Pressure
SpecifiedShear
SpecularityCoefficient
Velocity
Read Only    No
Pressure

Configure pressure specifications for the boundary.

Type     Pressure
Read Only    No
Shear

Configure shear conditions at the wall.

Type     Shear
Read Only    No
SurfaceTensionGradient

Set the surface tension gradient value.

Type     Expression<double>
Read Only    No
Velocity

Configure velocity specifications for the boundary.

Type     Velocity
Read Only    No
WallVelocity

Allows to choose between stationary or moving wall.

Type     WallVelocity
Read Only    No

FlowControl

Configure solution advancement process for momentum.

Properties

CourantNumber

Set the Courant number for current equation.

Type     Expression<Quantity>
Read Only    No
FlowPseudoTransient

Applies pseudo transient under-relaxation method. The under-relaxation is controlled through pseudo time step size.

Type     FlowPseudoTransient
Read Only    No
ImplicitRelaxFactor

Set the value of under-relaxation factor for current equation.

Type     Expression<Quantity>
Read Only    No
Option

Allows to choose between relaxation factor, Courant number and pseudo-transient.

Type    Option
Possible Values:    
CourantNumber
None
PseudoTransient
RelaxationFactor
Read Only    No

FlowCoupling

Allows to choose solver formulations for density based solver.

Properties

Option

Allows to choose different methods to specify direction.

Type    Option
Possible Values:    
Explicit
Implicit
Read Only    No

FlowDirection

Allows to specify the flow direction in different coordinate system.

Properties

AxialComponent

Set the axial component.

Type     Expression<double>
Read Only    No
CartesianDirectionComponents

Set the component in the different direction.

Type     List<Expression<Quantity>>
Read Only    No
CylindricalDirectionComponents

Set the component in the different direction.

Type     List<Expression<Quantity>>
Read Only    No
Option

Allows to specify the flow direction in different coordinate system.

Type    Option
Possible Values:    
Cartesian
Cylindrical
CylindricalWithTangentialVelocity
NormalToBoundary
Read Only    No
RadialComponent

Set the radial component.

Type     Expression<double>
Read Only    No
TangentialVelocity

Set the tangential component.

Type     Expression<Quantity>
Read Only    No

FlowModel

Configure Flow Model.

Properties

BuoyancyModel

Configure Buoyancy Model.

Type     BuoyancyModel
Read Only    No
OperatingConditions

Sets the parameters related to operating conditions in the model.

Type     OperatingConditions
Read Only    No
StressStrainModel

Configure Stress Strain Model.

Type     StressStrainModel
Read Only    No

FlowPeriodicityModel

Allows to choose between different flow periodicity models.

Properties

FlowDirection

Allows to specify the flow direction in different coordinate system.

Type     FlowDirection
Read Only    No
MassFlowRate

Set the mass flow rate value.

Type     Expression<Quantity>
Read Only    No
NumberOfIterations

Set the number of iterations.

Type     int
Read Only    No
PressureGradient

Set the pressure gradient value.

Type     Expression<Quantity>
Read Only    No
RelaxationFactor

Set the value of relaxation factor.

Type     Expression<double>
Read Only    No

FlowPseudoTransient

Applies pseudo transient under-relaxation method. The under-relaxation is controlled through pseudo time step size.

Properties

LengthScaleCalculationMethod

Allows one to choose how the length scale is determined when using pseudo transient solution advancement.

Type     LengthScaleCalculationMethod
Read Only    No
Option

Allows to choose 'Automatic' or manually specify the settings.

Type    Option
Possible Values:    
Automatic
UserSpecified
Read Only    No
PseudoTimestep

Set pseudo time step size.

Type     Expression<Quantity>
Read Only    No
TimestepScalingFactor

Set a scaling factor used to scale the calculated time step.

Type     Expression<Quantity>
Read Only    No
Verbosity

Set the verbosity. Enter a value of 1 to print pseudo time step size.

Type     int
Read Only    No

FlowSolver

Configure flow solver.

Properties

Option

Allows to choose pressure or density based solver.

Type    Option
Possible Values:    
DensityBased
PressureBased
Read Only    No

FluidBoundary

No details are provided for this entry.

Properties

FluentLabel

No details are provided for this entry.

Type     string
Read Only    Yes
Location

No details are provided for this entry.

Type     LocationSet
Read Only    No

FluidBoundary

No details are provided for this entry.

Properties

DisplayText

No details are provided for this entry.

Type     string
Read Only    No
FluentLabel

No details are provided for this entry.

Type     string
Read Only    Yes
Location

No details are provided for this entry.

Type     Object
Read Only    No

FluidHeatSource

to be documented

Properties

Option

context to be documented

Type    Option
Possible Values:    
SourceDensity
TotalSource
Read Only    No
ReferenceFrameForSource

Set the reference frame for source terms.

Type     ReferenceFrameForSource
Read Only    No
SourceDensity

to be documented

Type     Expression<Quantity>
Read Only    No
SourceLocations

Set the topology locations for volume source.

Type     List<string>
Read Only    No
TotalSource

to be documented

Type     Expression<Quantity>
Read Only    No

FullyDevelopedFlow

Configure the fully developed flow boundary condition.

Properties

FlowRateWeighting

Set the flow rate weighting factor (what portion of the outflow is through the boundary).

Type     Expression<Quantity>
Read Only    No

GeneralHybridSettings

to be documented

Properties

No Properties.


GlobalPosition

Configure the parameters to define the position of solar radiation.

Properties

Latitude

Set the latitude of the desired location in degrees.

Type     Expression<Quantity>
Read Only    No
Longitude

Set the longitude of the desired location in degrees.

Type     Expression<Quantity>
Read Only    No
TimeZone

Set the local time zone of the desired location in hours relative to GMT.

Type     Expression<double>
Read Only    No

GravityDefinition

Configure gravity definition.

Properties

GravityName

Select gravity set up from those defined.

Type     DataObject
Read Only    No

HeatFlowBoundary

Set boundary.

Properties

Acoustics

Set boundary conditions related to Acoustics.

Type     Acoustics
Read Only    No
BoundaryLocations

Set the boundary location.

Type     List<string>
Read Only    No
BoundaryReferenceFrame

Set the reference frame for boundary from (physics region or all available reference frames).

Type     BoundaryReferenceFrame
Read Only    No
BoundaryType

Set different boundary type.

Type    Option
Possible Values:    
Axis
Farfield
Inlet
Opening
Outlet
Solid
Symmetry
Wall
Read Only    No
Energy

Set boundary conditions related to Energy.

Type     Energy
Read Only    No
Flow

Configure flow specification for the boundary.

Type     Flow
Read Only    No
ParticleBoundaryConditions

to be documented

Type     ParticleBoundaryConditions
Read Only    No
Radiation

Configure radiation specifications for boundary.

Type     Radiation
Read Only    No
Regime

Configure flow regime.

Type     Regime
Read Only    No
TotalConditionFrameType

Set the reference frame for total pressure and total temperature.

Type     TotalConditionFrameType
Read Only    No
Turbulence

Set turbulence related boundary conditions in the model.

Type     Turbulence
Read Only    No
UserScalarBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No
UserVectorBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No

HeatFluxBoundary

Set boundary.

Properties

Acoustics

Set boundary conditions related to Acoustics.

Type     Acoustics
Read Only    No
BoundaryLocations

Set the boundary location.

Type     List<string>
Read Only    No
BoundaryReferenceFrame

Set the reference frame for boundary from (physics region or all available reference frames).

Type     BoundaryReferenceFrame
Read Only    No
BoundaryType

Set different boundary type.

Type    Option
Possible Values:    
Axis
Farfield
Inlet
Opening
Outlet
Solid
Symmetry
Wall
Read Only    No
Energy

Set boundary conditions related to Energy.

Type     Energy
Read Only    No
Flow

Configure flow specification for the boundary.

Type     Flow
Read Only    No
ParticleBoundaryConditions

to be documented

Type     ParticleBoundaryConditions
Read Only    No
Radiation

Configure radiation specifications for boundary.

Type     Radiation
Read Only    No
Regime

Configure flow regime.

Type     Regime
Read Only    No
TotalConditionFrameType

Set the reference frame for total pressure and total temperature.

Type     TotalConditionFrameType
Read Only    No
Turbulence

Set turbulence related boundary conditions in the model.

Type     Turbulence
Read Only    No
UserScalarBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No
UserVectorBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No

HeatSrc

No details are provided for this entry.

Properties

Location

No details are provided for this entry.

Type     LocationSet
Read Only    No

HeatSrc

No details are provided for this entry.

Properties

DisplayText

No details are provided for this entry.

Type     string
Read Only    No
Location

No details are provided for this entry.

Type     Object
Read Only    No

HighOrderRhieChowScheme

Configure High Order Rhie Chow scheme

Properties

CurrentHighOrderRhieChowScheme

Shows active High Order Rhie Chow scheme

Type    Option
Possible Values:    
FirstOrderMomentumWeighted
SecondOrderMomentumWeighted
Read Only    No

HighOrderTermRelaxation

Configure relaxation of high order terms.

Properties

DefaultSetting

Enables to set the default value of relaxation factor.

Type    Option
Possible Values:    
Off
On
Read Only    No
Equation

Configure relaxation for high order terms for current equation.

Type     IDictionary<string, Object>
Read Only    No
Factor

Set the value of factor.

Type     Expression<Quantity>
Read Only    No

ImbalanceConvergence

Configure imbalance convergence.

Properties

ImbalanceDefaultSetting

Configure imbalance default settings.

Type     ImbalanceDefaultSetting
Read Only    No
Option

Allows to choose default or equation based settings.

Type    Option
Possible Values:    
DefaultSettings
EquationBasedSettings
Read Only    No

ImbalanceDefaultSetting

Configure imbalance default settings.

Properties

ImbalanceTolerance

Set the value of imbalance tolerance.

Type     Expression<double>
Read Only    No
Option

Allows to set default value for convergence criteria of imbalance.

Type    Option
Possible Values:    
None
SpecifyImbalanceTolerance
Read Only    No

InitialConditions

Set the initial condition.

Properties

Acoustics

Set the acoustics initial conditions.

Type     Acoustics
Read Only    No
Energy

Allows to choose between different energy initial condition.

Type     Energy
Read Only    No
Flow

Configure the initial conditions.

Type     Flow
Read Only    No
GeneralHybridSettings

to be documented

Type     GeneralHybridSettings
Read Only    No
ReferenceFrameForInitialConditions

Set the reference frame for initial condition.

Type     ReferenceFrameForInitialConditions
Read Only    No
Turbulence

Configure Turbulence initial conditions.

Type     Turbulence
Read Only    No
TurbulenceHybridSettings

to be documented

Type     TurbulenceHybridSettings
Read Only    No
UserScalarInitialConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No
UserVectorInitialConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No

InitialConditions

Set the initial condition.

Properties

Acoustics

Set the acoustics initial conditions.

Type     Acoustics
Read Only    No
Energy

Allows to choose between different energy initial condition.

Type     Energy
Read Only    No
Flow

Configure the initial conditions.

Type     Flow
Read Only    No
GeneralHybridSettings

to be documented

Type     GeneralHybridSettings
Read Only    No
ReferenceFrameForInitialConditions

Set the reference frame for initial condition.

Type     ReferenceFrameForInitialConditions
Read Only    No
Turbulence

Configure Turbulence initial conditions.

Type     Turbulence
Read Only    No
TurbulenceHybridSettings

to be documented

Type     TurbulenceHybridSettings
Read Only    No
UserScalarInitialConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No
UserVectorInitialConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No

InjectionDirection

Allows to specify the flow direction in different coordinate system.

Properties

CartesianDirectionComponents

Set the component in the different direction.

Type     List<Expression<Quantity>>
Read Only    No
CylindricalDirectionComponents

Set the component in the different direction.

Type     List<Expression<Quantity>>
Read Only    No
Option

Allows to specify the flow direction in different coordinate system.

Type    Option
Possible Values:    
Cartesian
Cylindrical
NormalToBoundary
Read Only    No

InjectionPosition

to be documented

Properties

NumberOfParticles

to be documented

Type     int
Read Only    No
Option

context to be documented

Type    Option
Possible Values:    
PerElementFace
Random
Read Only    No
ParticleStreamsPerElementFace

to be documented

Type     int
Read Only    No

InletBoundary

Set boundary.

Properties

Acoustics

Set boundary conditions related to Acoustics.

Type     Acoustics
Read Only    No
BoundaryLocations

Set the boundary location.

Type     List<string>
Read Only    No
BoundaryReferenceFrame

Set the reference frame for boundary from (physics region or all available reference frames).

Type     BoundaryReferenceFrame
Read Only    No
BoundaryType

Set different boundary type.

Type    Option
Possible Values:    
Axis
Farfield
Inlet
Opening
Outlet
Solid
Symmetry
Wall
Read Only    No
Energy

Set boundary conditions related to Energy.

Type     Energy
Read Only    No
Flow

Configure flow specification for the boundary.

Type     Flow
Read Only    No
ParticleBoundaryConditions

to be documented

Type     ParticleBoundaryConditions
Read Only    No
Radiation

Configure radiation specifications for boundary.

Type     Radiation
Read Only    No
Regime

Configure flow regime.

Type     Regime
Read Only    No
TotalConditionFrameType

Set the reference frame for total pressure and total temperature.

Type     TotalConditionFrameType
Read Only    No
Turbulence

Set turbulence related boundary conditions in the model.

Type     Turbulence
Read Only    No
UserScalarBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No
UserVectorBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No

InsulatedBoundary

Set boundary.

Properties

Acoustics

Set boundary conditions related to Acoustics.

Type     Acoustics
Read Only    No
BoundaryLocations

Set the boundary location.

Type     List<string>
Read Only    No
BoundaryReferenceFrame

Set the reference frame for boundary from (physics region or all available reference frames).

Type     BoundaryReferenceFrame
Read Only    No
BoundaryType

Set different boundary type.

Type    Option
Possible Values:    
Axis
Farfield
Inlet
Opening
Outlet
Solid
Symmetry
Wall
Read Only    No
Energy

Set boundary conditions related to Energy.

Type     Energy
Read Only    No
Flow

Configure flow specification for the boundary.

Type     Flow
Read Only    No
ParticleBoundaryConditions

to be documented

Type     ParticleBoundaryConditions
Read Only    No
Radiation

Configure radiation specifications for boundary.

Type     Radiation
Read Only    No
Regime

Configure flow regime.

Type     Regime
Read Only    No
TotalConditionFrameType

Set the reference frame for total pressure and total temperature.

Type     TotalConditionFrameType
Read Only    No
Turbulence

Set turbulence related boundary conditions in the model.

Type     Turbulence
Read Only    No
UserScalarBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No
UserVectorBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No

InterfaceRegions

Set the physics region on either side of interface.

Properties

Side

Set the physics region and their topology ids on this side of interface.

Type     IDictionary<string, Object>
Read Only    No

IntersectionControl

configure to create matching or nonmatching interface.

Properties

AngularTolerance

If parent face normals deviate from each other by more than this angle, they will not be intersected.

Type     Expression<Quantity>
Read Only    No
BoundExtensionFactor

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.

Type     Expression<Quantity>
Read Only    No
InterfaceGeometriesMatch

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.

Type     bool
Read Only    No
NormalToleranceFactor

If parent faces are separated by more than this threshold (as a fraction of parent face edge length), they will not be intersected.

Type     Expression<Quantity>
Read Only    No
SmallestAreaToleranceFactor

If an intersected face has an area magnitude smaller than this threshold (as a fraction of the parent area magnitude), it will be ignored.

Type     Expression<Quantity>
Read Only    No

IterationControl

Configure settings for iteration control.

Properties

ConvergenceCriteria

Configure convergence criteria for residual, monitor, etc.

Type     ConvergenceCriteria
Read Only    No
EnergyIterationsPerRadiationIteration

Set the frequency with which the radiation terms are updated as the continuous phase solution proceeds.

Type     int
Read Only    No
MaximumNumberOfIterations

Set the maximum number of iteration.

Type     int
Read Only    No
MaximumRadiationIterations

Set the maximum number of iterations of the radiation calculation during each global iteration.

Type     int
Read Only    No
MinimumNumberOfIterations

Set the minimum number of iterations.

Type     int
Read Only    No
ResidualConvergenceCriteria

Set the value to determine when the radiation intensity update is converged.

Type     Expression<Quantity>
Read Only    No

ke1eStandardModelConstants

Configure k-e 1e Standard model constants.

Properties

Aplus

Set model constant.

Type     Expression<double>
Read Only    No
C1

Set model constant.

Type     Expression<double>
Read Only    No
C2

Set model constant.

Type     Expression<double>
Read Only    No
C3

Set model constant.

Type     Expression<double>
Read Only    No
Cs

Set Smagorinsky constant.

Type     Expression<double>
Read Only    No
PrandtlNumber

Set Prandtl number.

Type     Expression<double>
Read Only    No

kEpsilonRealizableModelConstants

Configure realizable K-Epsilon model constants.

Properties

C2Epsilon

Parameter used in the transport equation.

Type     Expression<double>
Read Only    No
TurbulenceDissipationRatePrandtlNumber

Set Effective Prandtl number for transport of the turbulent dissipation rate.

Type     Expression<double>
Read Only    No
TurbulenceKineticEnergyPrandtlNumber

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.

Type     Expression<double>
Read Only    No

kEpsilonStandardModelConstants

Configure standard k-Epsilon model constants.

Properties

C1Epsilon

Set constant in the equation of Standard k-epsilon turbulent flow.

Type     Expression<double>
Read Only    No
C2Epsilon

Set constant in the equation of Standard k-epsilon turbulent flow.

Type     Expression<double>
Read Only    No
Cmu

Set k-Epsilon Standard Model Constant.

Type     Expression<Quantity>
Read Only    No
TurbulenceDissipationRatePrandtlNumber

Set Effective Prandtl number for transport of the turbulent dissipation rate.

Type     Expression<double>
Read Only    No
TurbulenceKineticEnergyPrandtlNumber

Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of turbulence kinetic energy via turbulent transport.

Type     Expression<double>
Read Only    No

kOmegaBSLModelConstants

Configure kOmega Mean Base Line (BSL) Model Constants.

Properties

Betai1

Set Constant used in dissipation of Omega.

Type     Expression<double>
Read Only    No
Betai2

Set Constant used in dissipation of Omega.

Type     Expression<double>
Read Only    No
BetaStarInfinite

Constant used in modeling the Turbulence Dissipation.

Type     Expression<double>
Read Only    No
TurbulenceEddyFrequencyPrandtlNumber1

Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Turbulence Eddy Frequency (omega) condition.

Type     Expression<double>
Read Only    No
TurbulenceEddyFrequencyPrandtlNumber2

Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Turbulence Eddy Frequency (omega) condition.

Type     Expression<double>
Read Only    No
TurbulenceKineticEnergyPrandtlNumber1

Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of turbulence kinetic energy via turbulent transport.

Type     Expression<double>
Read Only    No
TurbulenceKineticEnergyPrandtlNumber2

Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of turbulence kinetic energy via turbulent transport.

Type     Expression<double>
Read Only    No

kOmegaSSTModelConstants

Configure K-Omega SST model constants.

Properties

A1

A1(alpha1)

Type     Expression<double>
Read Only    No
Alpha0

Coefficient used in the Production of Omega.

Type     Expression<double>
Read Only    No
AlphaInfinite

Coefficient used in the Production of Omega.

Type     Expression<double>
Read Only    No
AlphaStarInfinite

Set to damp the turbulent viscosity causing a low-Reynolds number correction.

Type     Expression<double>
Read Only    No
BetaIInner

Constant used in the Turbulence Dissipation of omega for the SST k-omega Model.

Type     Expression<double>
Read Only    No
BetaIOuter

Constant used in the Turbulence Dissipation of omega for the SST k-omega Model.

Type     Expression<double>
Read Only    No
BetaStarInfinite

Constant used in modeling the Turbulence Dissipation of omega for the SST k-omega Model.

Type     Expression<double>
Read Only    No
Rbeta

Constant used in modeling the Turbulence Dissipation of omega for the SST k-omega Model.

Type     Expression<double>
Read Only    No
Rk

Constant used in the low Reynolds Number Correction.

Type     Expression<double>
Read Only    No
Romega

Constant used in the Production of Omega.

Type     Expression<double>
Read Only    No
TurbulenceEddyFrequencyInnerPrandtlNumber

Set Effective Prandtl number for the transport of the specific dissipation rate inside the near-wall region.

Type     Expression<double>
Read Only    No
TurbulenceEddyFrequencyOuterPrandtlNumber

Set Effective Prandtl number for the transport of the specific dissipation rate outside the near-wall region.

Type     Expression<double>
Read Only    No
TurbulenceKineticEnergyInnerPrandtlNumber

Set Effective Prandtl number for the transport of turbulence kinetic energy inside the near-wall region.

Type     Expression<double>
Read Only    No
TurbulenceKineticEnergyOuterPrandtlNumber

Set Effective Prandtl number for the transport of turbulence kinetic energy outside the near-wall region.

Type     Expression<double>
Read Only    No

LaunchControls

No details are provided for this entry.

Properties

AfdRootPath

No details are provided for this entry.

Type     string
Read Only    No
HostFilePath

No details are provided for this entry.

Type     string
Read Only    No
NumberOfProcessors

No details are provided for this entry.

Type     int
Read Only    No
SolverFilesDirectory

No details are provided for this entry.

Type     string
Read Only    Yes

LengthScaleCalculationMethod

Allows one to choose how the length scale is determined when using pseudo transient solution advancement.

Properties

LengthScale

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.

Type     Expression<Quantity>
Read Only    No
Option

Allows to choose different length scale methods.

Type    Option
Possible Values:    
Aggressive
Conservative
GeometricMean
UserSpecified
Read Only    No

LinearSolver

Configure generic setting related to advanced solution controls.

Properties

CoupledControls

Configure coupled controls.

Type     CoupledControls
Read Only    No
FlexibleCycleControls

Configure parameters that control the flexible multigrid cycle.

Type     FlexibleCycleControls
Read Only    No
LinearSolverSettings

Configure linear solver settings for current equation.

Type     IDictionary<string, Object>
Read Only    No
ScalarControls

Configure scalar controls.

Type     ScalarControls
Read Only    No
Verbosity

Controls the amount of information that is printed out by the linear solver for monitoring purposes.

Type     int
Read Only    No

MassFlow

Configure mass flow specifications for the boundary.

Properties

AverageMassFlux

Set the mass flux value.

Type     Expression<Quantity>
Read Only    No
GaugeStaticPressure

Set the gauge static pressure value.

Type     Expression<Quantity>
Read Only    No
MassFlowRate

Set the mass flow rate value.

Type     Expression<Quantity>
Read Only    No
MassFlowUpdate

Configure mass flow update options.

Type     MassFlowUpdate
Read Only    No
MassFlux

Set the mass flux value.

Type     Expression<Quantity>
Read Only    No
Option

Select option for mass flow specification.

Type    Option
Possible Values:    
MassFlowRate
MassFlux
Read Only    No
SpecifyAverageMassFlux

Enable to specify average mass flux through the zone.

Type     bool
Read Only    No

MassFlowUpdate

Configure mass flow update options.

Properties

GaugeStaticPressure

Set the gauge static pressure value.

Type     Expression<Quantity>
Read Only    No
GaugeStaticPressureAtMinimumRadius

Set the gauge static pressure value at minimum radial location.

Type     Expression<Quantity>
Read Only    No
LowerLimitOfAbsolutePressure

Specify the Lower Limit of Absolute Pressure.

Type     Expression<Quantity>
Read Only    No
NumberOfBands

Select reference frame for total pressure

Type     NumberOfBands
Read Only    No
Option

Select option for mass flow update.

Type    Option
Possible Values:    
ScaleMassFlows
ShiftPressure
UniformFlux
Read Only    No
PressureAveraging

Configure pressure averaging - allows the pressure along the outlet boundary to vary, but maintain an average equivalent.

Type     PressureAveraging
Read Only    No
RadialEquilibrium

Enable the radial equilibrium pressure distribution.

Type     bool
Read Only    No
UpperLimitOfAbsolutePressure

Specify the Upper Limit of Absolute Pressure.

Type     Expression<Quantity>
Read Only    No

MaterialModels

No details are provided for this entry.

Properties

MaterialModel

No details are provided for this entry.

Type     string
Read Only    No

MeshCheck

Controls mesh check settings

Properties

Option

context to be documented

Type    Option
Possible Values:    
Basic
Full
None
Verbose
Read Only    No

MeshOrientation

Configure the orientation as the vectors for North and East.

Properties

EastCoordinates

Specify the coordinate

Type     List<Expression<Quantity>>
Read Only    No
NorthCoordinates

Specify the coordinate

Type     List<Expression<Quantity>>
Read Only    No

MessageSource

No details are provided for this entry.

Properties

Id

No details are provided for this entry.

Type     string
Read Only    No
PersistableStateMessages

No details are provided for this entry.

Type     Dictionary<DataReference, List<PersistableStateMessage>>
Read Only    No

Method

Select method for non-iterative time advancement

Properties

NeighborCorrection

Specify sub-iteration correction factor for non-iterative time advancement

Type     int
Read Only    No

ModelProperties

Configure input fields for material properties that are required for active physical models.

Properties

AbsorptionCoefficientModel

Configure parameters for absorption coefficient in radiation heat transfer.

Type     AbsorptionCoefficientModel
Read Only    No
RefractiveIndexModel

Set refractive index for the material.

Type     RefractiveIndexModel
Read Only    No

MomentumSource

to be documented

Properties

Option

context to be documented

Type    Option
Possible Values:    
SourceDensity
TotalSource
Read Only    No
ReferenceFrameForSource

Set the reference frame for source terms.

Type     ReferenceFrameForSource
Read Only    No
SourceComponents

Allows to specify the source components in different coordinate systems.

Type     SourceComponents
Read Only    No
SourceLocations

Set the topology locations for volume source.

Type     List<string>
Read Only    No

MomentumSource

to be documented

Properties

Option

context to be documented

Type    Option
Possible Values:    
SourceDensity
TotalSource
Read Only    No
ReferenceFrameForSource

Set the reference frame for source terms.

Type     ReferenceFrameForSource
Read Only    No
SourceComponents

Allows to specify the source components in different coordinate systems.

Type     SourceComponents
Read Only    No
SourceLocations

Set the topology locations for volume source.

Type     List<string>
Read Only    No

MomentumSrc

No details are provided for this entry.

Properties

Location

No details are provided for this entry.

Type     LocationSet
Read Only    No

MomentumSrc

No details are provided for this entry.

Properties

DisplayText

No details are provided for this entry.

Type     string
Read Only    No
Location

No details are provided for this entry.

Type     Object
Read Only    No

MonitorConvergence

Set convergence criteria for monitors.

Properties

Option

Set convergence criteria for monitors.

Type    Option
Possible Values:    
MonitorTolerance
None
Read Only    No

MonitorFrequency

Configure Monitor Frequency.

Properties

IterationInterval

Set how the iteration interval for monitor updates.

Type     int
Read Only    No
Option

Allows to choose between different monitor frequency options.

Type    Option
Possible Values:    
Iteration
None
Read Only    No

Monopole

Set the monopole characteristics

Properties

Amplitude

Set the amplitude value.

Type     Expression<Quantity>
Read Only    No
Frequency

Set the frequency value.

Type     Expression<Quantity>
Read Only    No
LocationCoordinates

Set the coordinates of reference pressure location.

Type     List<Expression<double>>
Read Only    No
Option

context to be documented

Type    Option
Possible Values:    
Off
On
Read Only    No
RadiusFactor

Set the radius factor.

Type     Expression<Quantity>
Read Only    No

MovingWall

Configure moving wall in the model.

Properties

AngularSpeed

Sets the rotational speed of the wall.

Type     Expression<Quantity>
Read Only    No
Components

Allows to specify the velocity component in different coordinate system.

Type     Components
Read Only    No
Direction

Allows to choose between Cartesian or cylindrical component to specify direction.

Type     Direction
Read Only    No
Magnitude

Set the magnitude of the velocity.

Type     Expression<Quantity>
Read Only    No
Option

Configure moving wall in the model.

Type    Option
Possible Values:    
Components
MagnitudeAndDirection
Rotating
Read Only    No

MultiphaseModels

Set the multiphase model type.

Properties

ContinuousPhase

to be documented

Type    Option
Possible Values:    No options
Read Only    No
DispersedPhases

to be documented

Type    Option
Possible Values:    No options
Read Only    No
DispersedSolver

to be documented

Type    Option
Possible Values:    
Lagrangian
Read Only    No
Option

context to be documented

Type    Option
Possible Values:    
Dispersed
Read Only    No
PhaseInteractions

Configure phase interactions.

Type     PhaseInteractions
Read Only    No

NearWallTreatment

Configure the near-wall treatment to be used for modeling turbulence.

Properties

FullLowReNearWallDamping

Set this parameter to lower Reynolds Number near Wall Damping.

Type     bool
Read Only    No
Option

Allows to choose different methods for near wall treatment.

Type    Option
Possible Values:    
LegacyFormulation
NonEquilibriumWallFunction
ScalableWallFunction
StandardWallFunction
yPlusInsensitive
yPlusInsensitiveMenterLechner
yPlusInsensitiveTwoLayer
Read Only    No
PressureGradientEffects

Enable/disable the pressure gradient effects on Model.

Type     bool
Read Only    No

Normalization

Allows one to choose to normalize residuals with respect to a residual at a particular iteration number.

Properties

Iteration

Set the number of iterations for which largest residual will be searched to normalize by.

Type     int
Read Only    No
Option

Allows whether or not to normalize residual for each variable.

Type    Option
Possible Values:    
Automatic
None
Read Only    No

NumberOfBands

Select reference frame for total pressure

Properties

MaximumNumber

Specifies the maximum number of bands to use for the radial pressure profile evaluation.

Type     int
Read Only    No
Option

Select total pressure reference frame among global and boundary frames.

Type    Option
Possible Values:    
Automatic
SpecifiedMaximum
Read Only    No

NumericalControls

Configure region wise numerics related controls.

Properties

DiscretizationControl

Configure conversion of scalar transport equations to discrete algebraic equations

Type     DiscretizationControl
Read Only    No
FlowSolver

Configure flow solver.

Type     FlowSolver
Read Only    No
SolutionControl

Configure common solution parameters.

Type     SolutionControl
Read Only    No

NumericalControls

Configure region wise numerics related controls.

Properties

DiscretizationControl

Configure conversion of scalar transport equations to discrete algebraic equations

Type     DiscretizationControl
Read Only    No
FlowSolver

Configure flow solver.

Type     FlowSolver
Read Only    No
SolutionControl

Configure common solution parameters.

Type     SolutionControl
Read Only    No

OpeningBoundary

Set boundary.

Properties

Acoustics

Set boundary conditions related to Acoustics.

Type     Acoustics
Read Only    No
BoundaryLocations

Set the boundary location.

Type     List<string>
Read Only    No
BoundaryReferenceFrame

Set the reference frame for boundary from (physics region or all available reference frames).

Type     BoundaryReferenceFrame
Read Only    No
BoundaryType

Set different boundary type.

Type    Option
Possible Values:    
Axis
Farfield
Inlet
Opening
Outlet
Solid
Symmetry
Wall
Read Only    No
Energy

Set boundary conditions related to Energy.

Type     Energy
Read Only    No
Flow

Configure flow specification for the boundary.

Type     Flow
Read Only    No
ParticleBoundaryConditions

to be documented

Type     ParticleBoundaryConditions
Read Only    No
Radiation

Configure radiation specifications for boundary.

Type     Radiation
Read Only    No
Regime

Configure flow regime.

Type     Regime
Read Only    No
TotalConditionFrameType

Set the reference frame for total pressure and total temperature.

Type     TotalConditionFrameType
Read Only    No
Turbulence

Set turbulence related boundary conditions in the model.

Type     Turbulence
Read Only    No
UserScalarBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No
UserVectorBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No

OperatingConditions

Sets the parameters related to operating conditions in the model.

Properties

OperatingPressure

Allows to choose between the fixed or floating operating pressure.

Type     OperatingPressure
Read Only    No
ReferencePressureLocation

Sets location for reference pressure for operating conditions.

Type     ReferencePressureLocation
Read Only    No

OperatingPressure

Allows to choose between the fixed or floating operating pressure.

Properties

Option

Allows to choose between the fixed or floating operating pressure.

Type    Option
Possible Values:    
Fixed
Floating
Read Only    No
Value

Sets the operating pressure value.

Type     Expression<Quantity>
Read Only    No

OutletBoundary

Set boundary.

Properties

Acoustics

Set boundary conditions related to Acoustics.

Type     Acoustics
Read Only    No
BoundaryLocations

Set the boundary location.

Type     List<string>
Read Only    No
BoundaryReferenceFrame

Set the reference frame for boundary from (physics region or all available reference frames).

Type     BoundaryReferenceFrame
Read Only    No
BoundaryType

Set different boundary type.

Type    Option
Possible Values:    
Axis
Farfield
Inlet
Opening
Outlet
Solid
Symmetry
Wall
Read Only    No
Energy

Set boundary conditions related to Energy.

Type     Energy
Read Only    No
Flow

Configure flow specification for the boundary.

Type     Flow
Read Only    No
ParticleBoundaryConditions

to be documented

Type     ParticleBoundaryConditions
Read Only    No
Radiation

Configure radiation specifications for boundary.

Type     Radiation
Read Only    No
Regime

Configure flow regime.

Type     Regime
Read Only    No
TotalConditionFrameType

Set the reference frame for total pressure and total temperature.

Type     TotalConditionFrameType
Read Only    No
Turbulence

Set turbulence related boundary conditions in the model.

Type     Turbulence
Read Only    No
UserScalarBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No
UserVectorBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No

OutputControl

Define output controls.

Properties

OutputData

Allows to choose between different persistence types.

Type    Option
Possible Values:    
AllVariables
Read Only    No
OutputFrequency

to be documented

Type     OutputFrequency
Read Only    No

OutputControl

Define output controls.

Properties

OutputData

Allows to choose between different persistence types.

Type    Option
Possible Values:    
AllVariables
Read Only    No
OutputFrequency

to be documented

Type     OutputFrequency
Read Only    No

OutputFrequency

to be documented

Properties

NumberOfIterations

Set number of iteration.

Type     int
Read Only    No
NumberOfTimeSteps

to be documented

Type     int
Read Only    No
Option

context to be documented

Type    Option
Possible Values:    
High
Iterations
Low
Medium
TimeInterval
TimeSteps
Read Only    No
TimeInterval

to be documented

Type     Expression<Quantity>
Read Only    No

Parameters

Configure settings related to the hemicube and ray tracing methods for computing the view factors.

Properties

NormalizedSeparationDistance

Set ratio of the minimum face separation to the effective diameter of the face.

Type     Expression<Quantity>
Read Only    No
Resolution

Set resolution of the hemicube.

Type     int
Read Only    No
Subdivisions

Set number of subfaces into which each face is divided.

Type     int
Read Only    No

ParticleBoundaryConditions

to be documented

Properties

ParticleFlowBoundaryCondition

to be documented

Type     IDictionary<string, Object>
Read Only    No

ParticleDiameter

to be documented

Properties

ConstantDiameter

to be documented

Type     Expression<Quantity>
Read Only    No
DiameterStandardDeviation

to be documented

Type     Expression<Quantity>
Read Only    No
MaxDiameter

to be documented

Type     Expression<Quantity>
Read Only    No
MaximumDiameter

to be documented

Type     Expression<Quantity>
Read Only    No
MeanDiameter

to be documented

Type     Expression<Quantity>
Read Only    No
MinDiameter

to be documented

Type     Expression<Quantity>
Read Only    No
MinimumDiameter

to be documented

Type     Expression<Quantity>
Read Only    No
Option

context to be documented

Type    Option
Possible Values:    
ConstantDiameter
NormalDistribution
RosinRammlerDistribution
UniformDistribution
Read Only    No
RosinRammlerPower

to be documented

Type     Expression<Quantity>
Read Only    No
SetMaximumDiameter

to be documented

Type     bool
Read Only    No
SetMinimumDiameter

to be documented

Type     bool
Read Only    No

ParticleEnergyInjectionCondition

to be documented

Properties

Option

context to be documented

Type    Option
Possible Values:    
Temperature
Read Only    No
Temperature

Set temperature at wall.

Type     Expression<Quantity>
Read Only    No

ParticleFlowInjectionCondition

to be documented

Properties

InjectionDirection

Allows to specify the flow direction in different coordinate system.

Type     InjectionDirection
Read Only    No
InjectionPosition

to be documented

Type     InjectionPosition
Read Only    No
MassFlowRate

Set the mass flow rate value.

Type     Expression<Quantity>
Read Only    No
Option

context to be documented

Type    Option
Possible Values:    
MassFlowAndVelocity
Read Only    No
ParticleDiameter

to be documented

Type     ParticleDiameter
Read Only    No
VelocityInjectionCondition

Configure velocity specifications for the boundary.

Type     VelocityInjectionCondition
Read Only    No

ParticleInjection

to be documented

Properties

ParticleInjectionConditions

to be documented

Type     ParticleInjectionConditions
Read Only    No
ParticleInjectionLocations

to be documented

Type     List<string>
Read Only    No
ParticleType

to be documented

Type    Option
Possible Values:    No options
Read Only    No

ParticleInjection

to be documented

Properties

ParticleInjectionConditions

to be documented

Type     ParticleInjectionConditions
Read Only    No
ParticleInjectionLocations

to be documented

Type     List<string>
Read Only    No
ParticleType

to be documented

Type    Option
Possible Values:    No options
Read Only    No

ParticleInjectionCnd

No details are provided for this entry.

Properties

DisplayText

No details are provided for this entry.

Type     string
Read Only    No
Location

No details are provided for this entry.

Type     Object
Read Only    No

ParticleInjectionConditions

to be documented

Properties

ParticleEnergyInjectionCondition

to be documented

Type     ParticleEnergyInjectionCondition
Read Only    No
ParticleFlowInjectionCondition

to be documented

Type     ParticleFlowInjectionCondition
Read Only    No

PeriodicityType

Choose periodicity type.

Properties

Option

context to be documented

Type    Option
Possible Values:    
Rotational
Translational
Read Only    No

PersistableStateMessage

No details are provided for this entry.

Properties

Location

No details are provided for this entry.

Type     LocationSet
Read Only    No
Popup

No details are provided for this entry.

Type     bool
Read Only    No
PropertyName

No details are provided for this entry.

Type     string
Read Only    No
StateMessageLevel

No details are provided for this entry.

Type     PersistableStateMessageLevel
Read Only    No
Text

No details are provided for this entry.

Type     string
Read Only    No

PhaseDefinition

Create phase definition.

Properties

MaterialBehaviorName

Specify the material behavior name.

Type    Option
Possible Values:    No options
Read Only    No
MaterialDistribution

to be documented

Type     string
Read Only    No
MaterialLocation

Set the topology locations of the solid material.

Type     List<string>
Read Only    No

PhaseInteractions

Configure phase interactions.

Properties

PhaseInteraction

Configure phase interactions between different phases.

Type     IDictionary<string, Object>
Read Only    No

PhaseModels

Set the physics models.

Properties

EnergyModel

Configure Energy Model.

Type     EnergyModel
Read Only    No
FlowModel

Configure Flow Model.

Type     FlowModel
Read Only    No
MultiphaseModels

Set the multiphase model type.

Type     MultiphaseModels
Read Only    No
RadiationModel

Configure Radiation Model.

Type     RadiationModel
Read Only    No
TurbulenceModel

Configure Turbulence Model.

Type     TurbulenceModel
Read Only    No
UserScalarModel

to be documented

Type     IDictionary<string, Object>
Read Only    No
UserVectorModel

to be documented

Type     IDictionary<string, Object>
Read Only    No

PhaseModels

Set the physics models.

Properties

EnergyModel

Configure Energy Model.

Type     EnergyModel
Read Only    No
FlowModel

Configure Flow Model.

Type     FlowModel
Read Only    No
MultiphaseModels

Set the multiphase model type.

Type     MultiphaseModels
Read Only    No
RadiationModel

Configure Radiation Model.

Type     RadiationModel
Read Only    No
TurbulenceModel

Configure Turbulence Model.

Type     TurbulenceModel
Read Only    No
UserScalarModel

to be documented

Type     IDictionary<string, Object>
Read Only    No
UserVectorModel

to be documented

Type     IDictionary<string, Object>
Read Only    No

PhysicsBasedPartition

Use physics weight for partition

Properties

Option

context to be documented

Type    Option
Possible Values:    
Off
On
Read Only    No

PhysicsRegion

Set the areas within the geometry that you want to assign physical properties.

Properties

PhysicsRegionLocation

Set the topology locations of the physics region.

Type     List<string>
Read Only    No
PhysicsType

Set the physics type.

Type     PhysicsType
Read Only    No

PhysicsRegionInterface

Set the physics region on interface.

Properties

ConnectionType

Choose connection type for interface.

Type     ConnectionType
Read Only    No
InterfaceRegions

Set the physics region on either side of interface.

Type     InterfaceRegions
Read Only    No
IntersectionControl

configure to create matching or nonmatching interface.

Type     IntersectionControl
Read Only    No
ReferenceFrameForRegionInterface

Choose reference frame for region interface

Type     ReferenceFrameForRegionInterface
Read Only    No

PhysicsRegionInterface

Set the physics region on interface.

Properties

ConnectionType

Choose connection type for interface.

Type     ConnectionType
Read Only    No
InterfaceRegions

Set the physics region on either side of interface.

Type     InterfaceRegions
Read Only    No
IntersectionControl

configure to create matching or nonmatching interface.

Type     IntersectionControl
Read Only    No
ReferenceFrameForRegionInterface

Choose reference frame for region interface

Type     ReferenceFrameForRegionInterface
Read Only    No

PhysicsType

Set the physics type.

Properties

PhysicsRegionType

to be documented

Type    Option
Possible Values:    
Fluid
Solid
Read Only    No
PhysicsTypeList

Set the physics type of the region (String list can have Fluid or Thermal or both).

Type     List<string>
Read Only    No

PolyhedralConversion

Controls whether mesh will be converted to polyhedra

Properties

Option

Convert mesh to polyhedra.

Type    Option
Possible Values:    
Convert
None
Read Only    No

PorositySrc

No details are provided for this entry.

Properties

Location

No details are provided for this entry.

Type     LocationSet
Read Only    No

PorositySrc

No details are provided for this entry.

Properties

DisplayText

No details are provided for this entry.

Type     string
Read Only    No
Location

No details are provided for this entry.

Type     Object
Read Only    No

PorousLoss

to be documented

Properties

InertialResistanceCoefficient

Set the inertial resistance coefficient value.

Type     Expression<Quantity>
Read Only    No
ResistanceVelocityType

Specifies whether porous loss coefficients multiply superficial or physical velocity.

Type    Option
Possible Values:    
Physical
Superficial
Read Only    No
ViscousResistanceCoefficient

Set the viscous resistance coefficient value (inverse permeability).

Type     Expression<Quantity>
Read Only    No

PorousMedium

to be documented

Properties

PorousLoss

to be documented

Type     PorousLoss
Read Only    No
ReferenceFrameForSource

Set the reference frame for source terms.

Type     ReferenceFrameForSource
Read Only    No
SourceLocations

Set the topology locations for volume source.

Type     List<string>
Read Only    No
VolumePorosity

to be documented

Type     VolumePorosity
Read Only    No

PorousMedium

to be documented

Properties

PorousLoss

to be documented

Type     PorousLoss
Read Only    No
ReferenceFrameForSource

Set the reference frame for source terms.

Type     ReferenceFrameForSource
Read Only    No
SourceLocations

Set the topology locations for volume source.

Type     List<string>
Read Only    No
VolumePorosity

to be documented

Type     VolumePorosity
Read Only    No

Pressure

Configure pressure specifications for the boundary.

Properties

GaugeEntrainmentPressure

Set the gauge entrainment pressure value.

Type     Expression<Quantity>
Read Only    No
GaugeStaticPressure

Set the gauge static pressure value.

Type     Expression<Quantity>
Read Only    No
GaugeStaticPressureAtMinimumRadius

Set the gauge static pressure value at minimum radial location.

Type     Expression<Quantity>
Read Only    No
GaugeTotalPressure

Sets the gauge total (or stagnation) pressure of the inflow stream.

Type     Expression<Quantity>
Read Only    No
NumberOfBands

Select reference frame for total pressure

Type     NumberOfBands
Read Only    No
PressureAveraging

Configure pressure averaging - allows the pressure along the outlet boundary to vary, but maintain an average equivalent.

Type     PressureAveraging
Read Only    No
PressureOption

Select pressure specification option.

Type    Option
Possible Values:    
EntrainmentPressure
TotalPressure
Read Only    No
RadialEquilibrium

Enable the radial equilibrium pressure distribution.

Type     bool
Read Only    No

PressureAveraging

Configure pressure averaging - allows the pressure along the outlet boundary to vary, but maintain an average equivalent.

Properties

Option

Select option for pressure averaging.

Type    Option
Possible Values:    
Average
None
Read Only    No
PressureProfileBlend

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.

Type     Expression<double>
Read Only    No

PressureScheme

Select how pressure is interpolated from cells to faces

Properties

CurrentPressureScheme

See active pressure scheme

Type    Option
Possible Values:    
BodyForceWeighted
FirstOrder
Linear
PRESTO
SecondOrder
Read Only    No
ImplicitExtrapolation

Enable implicit extrapolation to boundaries.

Type     bool
Read Only    No
Option

Allows to choose different methods to specify direction.

Type    Option
Possible Values:    
Automatic
BodyForceWeighted
Expert
FirstOrder
Hybrid
Linear
PRESTO
SecondOrder
Read Only    No

PressureVelocityCoupling

Allows to choose different schemes for pressure-velocity coupling.

Properties

NeighborCorrection

Specify sub-iteration correction factor for non-iterative time advancement

Type     int
Read Only    No
Option

Allows to choose different schemes for pressure-velocity coupling.

Type    Option
Possible Values:    
Coupled
PISO
SIMPLE
SIMPLEC
Read Only    No
SkewnessCorrection

Enables the SIMPLEC and PISO skewness correction for highly skewed meshes, if the value (number of iterations) is greater than 0.

Type     int
Read Only    No
SkewnessNeighborCoupling

Enables the PISO neighbor correction, which is recommended for transient calculations.

Type     bool
Read Only    No

ProductionLimiter

Configure to limit the production term in the turbulence equation.

Properties

CPkLim

Coefficient used by the Production Limiter.

Type     Expression<double>
Read Only    No
LimiterOption

Enable to limit the production term in the turbulence equation.

Type    Option
Possible Values:    
Off
On
Read Only    No

ProductionSettings

Configure the parameter and constant for production setting.

Properties

CDokMu

Set Model constant

Type     Expression<double>
Read Only    No
CompressibleProduction

Choose to set compressible production in the model.

Type    Option
Possible Values:    
Off
On
Read Only    No
CPkMu

Set Model constant

Type     Expression<double>
Read Only    No
Production

Choose from options to limit the production term in the turbulence equation.

Type    Option
Possible Values:    
KatoLaunder
Standard
Read Only    No
ProductionLimiter

Configure to limit the production term in the turbulence equation.

Type     ProductionLimiter
Read Only    No

Radiation

Configure radiation specifications for boundary.

Properties

ApplyDirectIrradiationParallelToBeam

When enabled, assumes the value of direct irradiation specify is parallel to beam direction.

Type     bool
Read Only    No
BeamDirection

Configure radiation beam direction.

Type     BeamDirection
Read Only    No
BeamWidth

Set beam width for an external semi-transparent wall in terms of the Theta and Phi extents.

Type     BeamWidth
Read Only    No
CriticalZone

Enable/Disable that wall is a critical zone.

Type     bool
Read Only    No
DiffuseFraction

Specify the fraction of the irradiation that is to be treated as diffuse.

Type     IDictionary<string, Object>
Read Only    No
DiffuseIrradiation

Specify the value of the irradiation flux.

Type     IDictionary<string, Object>
Read Only    No
DirectIrradiation

Specify the value of the irradiation flux.

Type     IDictionary<string, Object>
Read Only    No
ExternalBlackBodyTemperature

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.

Type     ExternalBlackBodyTemperature
Read Only    No
FacesPerSurfaceCluster

sets the number of faces per surface cluster for the wall.

Type     int
Read Only    No
InternalEmissivity

Specify the internal emissivity of the wall in each wavelength band.

Type     IDictionary<string, Object>
Read Only    No
ParticipatesInViewFactorCalculation

Enable/Disable whether wall participates in the view factor calculation.

Type     bool
Read Only    No
TransparencyOption

Specify transparency option.

Type    Option
Possible Values:    
Opaque
SemiTransparent
Read Only    No

RadiationBoundary

Set boundary.

Properties

Acoustics

Set boundary conditions related to Acoustics.

Type     Acoustics
Read Only    No
BoundaryLocations

Set the boundary location.

Type     List<string>
Read Only    No
BoundaryReferenceFrame

Set the reference frame for boundary from (physics region or all available reference frames).

Type     BoundaryReferenceFrame
Read Only    No
BoundaryType

Set different boundary type.

Type    Option
Possible Values:    
Axis
Farfield
Inlet
Opening
Outlet
Solid
Symmetry
Wall
Read Only    No
Energy

Set boundary conditions related to Energy.

Type     Energy
Read Only    No
Flow

Configure flow specification for the boundary.

Type     Flow
Read Only    No
ParticleBoundaryConditions

to be documented

Type     ParticleBoundaryConditions
Read Only    No
Radiation

Configure radiation specifications for boundary.

Type     Radiation
Read Only    No
Regime

Configure flow regime.

Type     Regime
Read Only    No
TotalConditionFrameType

Set the reference frame for total pressure and total temperature.

Type     TotalConditionFrameType
Read Only    No
Turbulence

Set turbulence related boundary conditions in the model.

Type     Turbulence
Read Only    No
UserScalarBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No
UserVectorBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No

RadiationModel

Configure Radiation Model.

Properties

AngularDiscretization

Configure parameters for angular discretization and pixelation for the DO mode.

Type     AngularDiscretization
Read Only    No
DOEnergyCoupling

Set Couples energy and DO (Discrete Ordinates) intensity equations at each cell.

Type     bool
Read Only    No
ModelProperties

Configure input fields for material properties that are required for active physical models.

Type     ModelProperties
Read Only    No
Option

Allows to choose between different radiation models.

Type    Option
Possible Values:    
DiscreteOrdinates
Off
P1
SurfaceToSurface
Read Only    No
SpectralModel

Configure supported Spectral models.

Type     SpectralModel
Read Only    No
ViewFactorsAndClustering

Configure parameters for surface clusters and view factors calculation.

Type     ViewFactorsAndClustering
Read Only    No

RANSModel

Configure options for specifying the viscous model.

Properties

BoundaryLayerTransitionModel

Choose options for Boundary Layer Transition model.

Type    Option
Possible Values:    
Intermittency
IntermittencyReTheta
None
Read Only    No
BuoyancyEffects

Include buoyancy effects in the turbulence model.

Type    Option
Possible Values:    
Full
Off
ProductionOnly
Read Only    No
CompressibilityEffects

Enable/disable Compressibility effects.

Type     bool
Read Only    No
CurvatureCorrection

When enabled, modifies the turbulence production term to sensitize the standard eddy-viscosity models to the effects of streamline curvature and system rotation.

Type    Option
Possible Values:    
Off
On
Read Only    No
CurvatureCorrectionCoefficient

Set Curvature Correction Coefficient.

Type     Expression<Quantity>
Read Only    No
DesModel

Specifies turbulent flow to be calculated using the Detached Eddy Simulation model.

Type     DesModel
Read Only    No
EARSMRgKOmegaBSLModelConstants

Configure KOmega BSL model constants.

Type     EARSMRgKOmegaBSLModelConstants
Read Only    No
EARSMWjKOmegaBSLModelConstants

Configure KOmega BSL model constants.

Type     EARSMWjKOmegaBSLModelConstants
Read Only    No
ke1eStandardModelConstants

Configure k-e 1e Standard model constants.

Type     ke1eStandardModelConstants
Read Only    No
kEpsilonRealizableModelConstants

Configure realizable K-Epsilon model constants.

Type     kEpsilonRealizableModelConstants
Read Only    No
kEpsilonStandardModelConstants

Configure standard k-Epsilon model constants.

Type     kEpsilonStandardModelConstants
Read Only    No
kOmegaBSLModelConstants

Configure kOmega Mean Base Line (BSL) Model Constants.

Type     kOmegaBSLModelConstants
Read Only    No
kOmegaSSTModelConstants

Configure K-Omega SST model constants.

Type     kOmegaSSTModelConstants
Read Only    No
LowReCorrections

Specifies whether corrections that improve the accuracy in predicting low Reynolds number flows should be included.

Type     bool
Read Only    No
NearWallTreatment

Configure the near-wall treatment to be used for modeling turbulence.

Type     NearWallTreatment
Read Only    No
Option

Allows to choose between different RANS models.

Type    Option
Possible Values:    
EARSMRumseyGatskiKOmegaBSL
EARSMWallinJohanssonKOmegaBSL
RSMEpsilon
RSMOmega
SpalartAllmaras
kEpsilonRealizable
kEpsilonStandard
kOmegaBSL
kOmegaSST
ke1eStandard
Read Only    No
ProductionSettings

Configure the parameter and constant for production setting.

Type     ProductionSettings
Read Only    No
RSMEpsilonModelConstants

Configure Reynolds Stress Model-Epsilon constants.

Type     RSMEpsilonModelConstants
Read Only    No
RSMOmegaModelConstants

Configure model constants in Omega Reynolds Stress Model.

Type     RSMOmegaModelConstants
Read Only    No
SpalartAllmarasModelConstants

Configure parameters for the turbulent flow to be calculated using the Spalart-Allmaras model.

Type     SpalartAllmarasModelConstants
Read Only    No
SpalartAllmarasProduction

Choose from the options whether the flow is vorticity based or Strain Vorticity based in Spalart-Allmaras model.

Type    Option
Possible Values:    
StrainVorticityBased
VorticityBased
Read Only    No
TurbulenceModelSuppression

Choose from the options to block either Turbulence Production or Turbulence Viscosity Production or None in DES Model.

Type    Option
Possible Values:    
NoTurbulenceProduction
NoTurbulenceViscosityAndProduction
None
Read Only    No

ReferenceFrameForInitialConditions

Set the reference frame for initial condition.

Properties

FrameName

Select a frame from the defined reference frames.

Type     DataObject
Read Only    No
Option

Set the reference frame for initial condition.

Type    Option
Possible Values:    
SpecifyFrame
UseFromPhysicsRegion
Read Only    No

ReferenceFrameForRegionInterface

Choose reference frame for region interface

Properties

AdjacentPhysicsRegion

Set the physics region of which reference frame to used.

Type    Option
Possible Values:    No options
Read Only    No
FrameName

Select a frame from the defined reference frames.

Type     DataObject
Read Only    No

ReferenceFrameForSource

Set the reference frame for source terms.

Properties

FrameName

Select a frame from the defined reference frames.

Type     DataObject
Read Only    No
Option

Set the reference frame for source terms.

Type    Option
Possible Values:    
SpecifyFrame
UseFromPhysicsRegion
Read Only    No

ReferencePressureLocation

Sets location for reference pressure for operating conditions.

Properties

Coordinates

Sets the coordinates value of reference pressure location.

Type     List<Expression<Quantity>>
Read Only    No
Option

Allows one to select where in your simulation the reference pressure is set.

Type    Option
Possible Values:    
Automatic
CartesianCoordinates
Read Only    No

RefractiveIndexModel

Set refractive index for the material.

Properties

MaterialRefractiveIndex

Specify refractive index for the material.

Type     IDictionary<string, Object>
Read Only    No

Regime

Configure flow regime.

Properties

Option

Select regime among mixed, subsonic and supersonic.

Type    Option
Possible Values:    
Mixed
Subsonic
Supersonic
Read Only    No

RegionInterface

No details are provided for this entry.

Properties

DefinitionMethod

No details are provided for this entry.

Type     CreationMode
Read Only    No
Location1

No details are provided for this entry.

Type     LocationSet
Read Only    No
Location2

No details are provided for this entry.

Type     LocationSet
Read Only    No
PhysicsRegions1

No details are provided for this entry.

Type     List<PhysicsRegion>
Read Only    No
PhysicsRegions2

No details are provided for this entry.

Type     List<PhysicsRegion>
Read Only    No

RegionInterface

No details are provided for this entry.

Properties

DefinitionMethod

No details are provided for this entry.

Type     CreationMode
Read Only    No
DisplayText

No details are provided for this entry.

Type     string
Read Only    No
Location1

No details are provided for this entry.

Type     Object
Read Only    No
Location2

No details are provided for this entry.

Type     Object
Read Only    No
PhysicsRegions1

No details are provided for this entry.

Type     List<DataReference>
Read Only    No
PhysicsRegions2

No details are provided for this entry.

Type     List<DataReference>
Read Only    No

RegionInterfaceGenerator

No details are provided for this entry.

Properties

Location

No details are provided for this entry.

Type     LocationSet
Read Only    No
Tolerance

No details are provided for this entry.

Type     Quantity
Read Only    No

ResidualControl

Configure settings to control residual information.

Properties

MonitorFrequency

Configure Monitor Frequency.

Type     MonitorFrequency
Read Only    No
Normalization

Allows one to choose to normalize residuals with respect to a residual at a particular iteration number.

Type     Normalization
Read Only    No
ResidualScaling

Allows one to choose how control volume equation residuals are scaled so that they are dimensionless.

Type     ResidualScaling
Read Only    No

ResidualConvergence

Configure convergence criteria for residuals.

Properties

ResidualDefaultSetting

Set default value of convergence criteria for residual.

Type     ResidualDefaultSetting
Read Only    No
ResidualTolerance

Set convergence criteria for current equation.

Type     IDictionary<string, Object>
Read Only    No

ResidualDefaultSetting

Set default value of convergence criteria for residual.

Properties

Option

Set default value of convergence criteria for residual.

Type    Option
Possible Values:    
None
Tolerance
Read Only    No
Value

Set the default tolerance value.

Type     Expression<double>
Read Only    No

ResidualScaling

Allows one to choose how control volume equation residuals are scaled so that they are dimensionless.

Properties

LocalScalingOption

Allows to choose different options for local scaling of residuals.

Type    Option
Possible Values:    
Maximum
RMS
Read Only    No
Option

Allows one to choose different options for residuals scaling.

Type    Option
Possible Values:    
GlobalScaling
LocalScaling
None
Read Only    No

ReynoldsStresses

Configure Reynolds stress model.

Properties

Option

Set turbulent flow to be calculated using the RSM.

Type    Option
Possible Values:    
Isotropic
RSMComponents
Read Only    No
UU

Specify Reynolds stress components.

Type     Expression<Quantity>
Read Only    No
UV

Specify Reynolds stress components.

Type     Expression<Quantity>
Read Only    No
UW

Specify Reynolds stress components.

Type     Expression<Quantity>
Read Only    No
VV

Specify Reynolds stress components.

Type     Expression<Quantity>
Read Only    No
VW

Specify Reynolds stress components.

Type     Expression<Quantity>
Read Only    No
WW

Specify Reynolds stress components.

Type     Expression<Quantity>
Read Only    No

RSMEpsilonModelConstants

Configure Reynolds Stress Model-Epsilon constants.

Properties

C1Epsilon

Set constant used in the transport equation for Epsilon.

Type     Expression<double>
Read Only    No
C1primePS

Set model constant.

Type     Expression<double>
Read Only    No
C1primeSSGPS

Set model constant.

Type     Expression<double>
Read Only    No
C1PS

Set model constant.

Type     Expression<double>
Read Only    No
C1SSGPS

Set model constant.

Type     Expression<double>
Read Only    No
C2EpsilonLinear

Set constant used in the transport equation for Epsilon.

Type     Expression<double>
Read Only    No
C2EpsilonQuadratic

Set constant used in the transport equation for Epsilon.

Type     Expression<double>
Read Only    No
C2primePS

Set model constant.

Type     Expression<double>
Read Only    No
C2PS

Set model constant.

Type     Expression<double>
Read Only    No
C2SSGPS

Set model constant.

Type     Expression<double>
Read Only    No
C3primeSSGPS

Set model constant.

Type     Expression<double>
Read Only    No
C3SSGPS

Set model constant.

Type     Expression<double>
Read Only    No
C4SSGPS

Set model constant.

Type     Expression<double>
Read Only    No
C5SSGPS

Set model constant.

Type     Expression<double>
Read Only    No
Cmu

Set model constant.

Type     Expression<Quantity>
Read Only    No
TurbulenceDissipationRatePrandtlNumber

Set Effective Prandtl number for transport of the turbulent dissipation rate.

Type     Expression<double>
Read Only    No
TurbulenceKineticEnergyPrandtlNumber

Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of turbulence kinetic energy via turbulent transport.

Type     Expression<double>
Read Only    No

RSMOmegaModelConstants

Configure model constants in Omega Reynolds Stress Model.

Properties

Alpha0

Set coefficient used in the Production of Omega.

Type     Expression<double>
Read Only    No
AlphaInfinite

Set coefficient used in the Production of Omega.

Type     Expression<double>
Read Only    No
AlphaStarInfinite

Set coefficient used in the Production of Omega.

Type     Expression<double>
Read Only    No
Betai

Set constant used in modeling the Turbulence Dissipation.

Type     Expression<double>
Read Only    No
BetaStarInfinite

Set constant used in modeling the Turbulence Dissipation.

Type     Expression<double>
Read Only    No
C1PS

Set model constant.

Type     Expression<double>
Read Only    No
C2PS

Set model constant.

Type     Expression<double>
Read Only    No
Cs

Set model constant.

Type     Expression<double>
Read Only    No
Mt0

Compressibility Correction.

Type     Expression<double>
Read Only    No
Rbeta

Set constant used in modeling the Turbulence Dissipation.

Type     Expression<double>
Read Only    No
Rk

Set constant used in the low Reynolds Number Correction.

Type     Expression<double>
Read Only    No
Romega

Set constant used in the Production of Omega.

Type     Expression<double>
Read Only    No
TurbulenceEddyFrequencyPrandtlNumber

Set Prandtl Number (ratio of kinematic diffusivity to thermal diffusivity) under Turbulence Eddy Frequency (omega) condition.

Type     Expression<double>
Read Only    No
TurbulenceKineticEnergyPrandtlNumber

Set Effective Prandtl number, which defines the ratio of the momentum diffusivity to the diffusivity of turbulence kinetic energy via turbulent transport.

Type     Expression<double>
Read Only    No
ZetaStar

Set model constant used in the Turbulence Dissipation.

Type     Expression<double>
Read Only    No

SamplingDetails

Allows to choose between different sampling types.

Properties

Option

context to be documented

Type    Option
Possible Values:    
ByTime
ByTimeStep
Read Only    No
TimeEnd

to be documented

Type     Expression<Quantity>
Read Only    No
TimeInterval

to be documented

Type     Expression<Quantity>
Read Only    No
TimeStart

to be documented

Type     Expression<Quantity>
Read Only    No
TimeStepEnd

to be documented

Type     int
Read Only    No
TimeStepInterval

to be documented

Type     int
Read Only    No
TimeStepStart

to be documented

Type     int
Read Only    No

ScalarControls

Configure scalar controls.

Properties

FixedCycleControls

Configure parameters that control the V, W and F cycles.

Type     FixedCycleControls
Read Only    No

Shear

Configure shear conditions at the wall.

Properties

Option

Configure shear conditions at the wall

Type    Option
Possible Values:    
Cartesian
Cylindrical
Read Only    No
ShearStress

Set the Pressure Components value.

Type     List<Expression<Quantity>>
Read Only    No

SolarCalculator

Configure parameters related to the calculation of solar load models.

Properties

DateAndTime

Configure parameters to specify date and time.

Type     DateAndTime
Read Only    No
GlobalPosition

Configure the parameters to define the position of solar radiation.

Type     GlobalPosition
Read Only    No
MeshOrientation

Configure the orientation as the vectors for North and East.

Type     MeshOrientation
Read Only    No
SolarIrradiationMethod

Choose parameters of the solar irradiation method

Type    Option
Possible Values:    
FairWeatherConditions
TheoreticalMaximum
Read Only    No
SunshineFactor

Set Sunshine Factor, which is linear reduction factor for the computed incident load that allows for cloud cover to be accounted

Type     Expression<Quantity>
Read Only    No

SolidHeatSource

to be documented

Properties

Option

context to be documented

Type    Option
Possible Values:    
SourceDensity
TotalSource
Read Only    No
ReferenceFrameForSource

Set the reference frame for source terms.

Type     ReferenceFrameForSource
Read Only    No
SourceDensity

to be documented

Type     Expression<Quantity>
Read Only    No
SourceLocations

Set the topology locations for volume source.

Type     List<string>
Read Only    No
TotalSource

to be documented

Type     Expression<Quantity>
Read Only    No

SolutionControl

Configure common solution parameters.

Properties

AdvancementControl

Configure advance control setting for solver.

Type     AdvancementControl
Read Only    No
CouplingControl

Configure settings for solution advancement.

Type     CouplingControl
Read Only    No
ExplicitRelaxation

Allows to set the value of under-relaxation factors.

Type     IDictionary<string, Object>
Read Only    No
HighOrderTermRelaxation

Configure relaxation of high order terms.

Type     HighOrderTermRelaxation
Read Only    No
LinearSolver

Configure generic setting related to advanced solution controls.

Type     LinearSolver
Read Only    No
SolutionLimits

Configure bounds for solution fields

Type     SolutionLimits
Read Only    No

SolutionControls

Configure generic settings for solution controls.

Properties

CalculationControl

Configure calculation specific settings.

Type     CalculationControl
Read Only    No
SolvePrimaryLinearSystem

Turn On to solve primary linear system.

Type     bool
Read Only    No
SolverMeshingControl

Controls related to solver meshing

Type     SolverMeshingControl
Read Only    No
WithRespectTo

Set independent variable.

Type     string
Read Only    No

SolutionControls

Configure generic settings for solution controls.

Properties

CalculationControl

Configure calculation specific settings.

Type     CalculationControl
Read Only    No
SolvePrimaryLinearSystem

Turn On to solve primary linear system.

Type     bool
Read Only    No
SolverMeshingControl

Controls related to solver meshing

Type     SolverMeshingControl
Read Only    No
WithRespectTo

Set independent variable.

Type     string
Read Only    No

SolutionLimits

Configure bounds for solution fields

Properties

AbsolutePressurePositivityRate

Specify positivity rate for rate of reduction of temperature

Type     Expression<Quantity>
Read Only    No
MaximumAbsolutePressure

Specify upper bound for absolute pressure

Type     Expression<Quantity>
Read Only    No
MaximumTemperature

Specify upper bound for temperature

Type     Expression<Quantity>
Read Only    No
MaximumTurbulenceViscosityRatio

Specify upper bound for turbulent viscosity ratio

Type     Expression<Quantity>
Read Only    No
MinimumAbsolutePressure

Specify lower bound for absolute pressure

Type     Expression<Quantity>
Read Only    No
MinimumTemperature

Specify lower bound for temperature

Type     Expression<Quantity>
Read Only    No
MinimumTurbulenceDissipationRate

Specify lower bound for turbulent dissipation rate

Type     Expression<Quantity>
Read Only    No
MinimumTurbulenceEddyFrequency

Specify lower bound for turbulent eddy frequency

Type     Expression<Quantity>
Read Only    No
MinimumTurbulenceKineticEnergy

Specify lower bound for turbulent viscosity ratio

Type     Expression<Quantity>
Read Only    No
MinimumTurbulenceModifiedViscosity

Specify lower bound for nut

Type     Expression<Quantity>
Read Only    No
TemperaturePositivityRate

Specify positivity rate for temperature

Type     Expression<Quantity>
Read Only    No
VolumeFractionCutoff

Specify cutoff for volume fraction

Type     Expression<double>
Read Only    No

SolverMeshingControl

Controls related to solver meshing

Properties

MeshCheck

Controls mesh check settings

Type     MeshCheck
Read Only    No
PhysicsBasedPartition

Use physics weight for partition

Type     PhysicsBasedPartition
Read Only    No
PolyhedralConversion

Controls whether mesh will be converted to polyhedra

Type     PolyhedralConversion
Read Only    No

SourceComponents

Allows to specify the source components in different coordinate systems.

Properties

CartesianSourceComponents

to be documented

Type     List<Expression<Quantity>>
Read Only    No
CylindricalSourceComponents

to be documented

Type     List<Expression<Quantity>>
Read Only    No
Option

Allows to specify the source components in different coordinate system.

Type    Option
Possible Values:    
Cartesian
Cylindrical
Read Only    No

SpalartAllmarasModelConstants

Configure parameters for the turbulent flow to be calculated using the Spalart-Allmaras model.

Properties

Cb1

Set the parameter to model the Turbulent Production.

Type     Expression<double>
Read Only    No
Cb2

Set the parameter to model the Turbulent Production.

Type     Expression<double>
Read Only    No
Cproduction

Set the parameter to model the Turbulent Viscosity when strain/vorticity-based production option is used.

Type     Expression<double>
Read Only    No
Cv1

Set the parameter to model the Turbulent Viscosity.

Type     Expression<double>
Read Only    No
Cw2

Set the parameter to model the Turbulent Viscosity.

Type     Expression<double>
Read Only    No
Cw3

Set the parameter to model the Turbulent Viscosity.

Type     Expression<double>
Read Only    No
PrandtlNumber

Set Prandtl number (ratio of momentum diffusivity to thermal diffusivity).

Type     Expression<double>
Read Only    No

SpatialDiscretization

Configure interpolation of convection terms of quantities to control volumes

Properties

Advection

Configure advection schemes for governing equations

Type     Advection
Read Only    No
GradientMethod

Method for computing cell gradients.

Type    Option
Possible Values:    
Automatic
GreenGaussCellBased
GreenGaussNodeBased
H1CellBased
LeastSquaresCellBased
Read Only    No
PressureScheme

Select how pressure is interpolated from cells to faces

Type     PressureScheme
Read Only    No

SpectralModel

Configure supported Spectral models.

Properties

Interval

Specify interval range.

Type     IDictionary<string, Object>
Read Only    No
NumberOfIntervals

Set number of bands.

Type     int
Read Only    No
Option

Allows to choose between different spectral models.

Type    Option
Possible Values:    
Gray
MultipleBands
Read Only    No
SpectralVariable

Choose Spectral Variable from the options.

Type    Option
Possible Values:    
Frequency
WavelengthInVacuum
WavenumberInVacuum
Read Only    No

Statistics

to be documented

Properties

SamplingDetails

Allows to choose between different sampling types.

Type     SamplingDetails
Read Only    No
Type

Allows to choose between different statistic types.

Type     Type
Read Only    No

Statistics

to be documented

Properties

SamplingDetails

Allows to choose between different sampling types.

Type     SamplingDetails
Read Only    No
Type

Allows to choose between different statistic types.

Type     Type
Read Only    No

StreamwisePeriodicityModel

Allows to choose between different streamwise periodicity models.

Properties

EnergyPeriodicityModel

Allows to choose between different energy periodicity models.

Type     EnergyPeriodicityModel
Read Only    No
FlowPeriodicityModel

Allows to choose between different flow periodicity models.

Type     FlowPeriodicityModel
Read Only    No

StressStrainModel

Configure Stress Strain Model.

Properties

Option

Allows to choose between different viscous and inviscid model.

Type    Option
Possible Values:    
Inviscid
Viscous
Read Only    No

SunDirectionVector

Configure components of sun direction vector.

Properties

Value

Specify vector components

Type     List<Expression<Quantity>>
Read Only    No

SymmetryBoundary

Set boundary.

Properties

Acoustics

Set boundary conditions related to Acoustics.

Type     Acoustics
Read Only    No
BoundaryLocations

Set the boundary location.

Type     List<string>
Read Only    No
BoundaryReferenceFrame

Set the reference frame for boundary from (physics region or all available reference frames).

Type     BoundaryReferenceFrame
Read Only    No
BoundaryType

Set different boundary type.

Type    Option
Possible Values:    
Axis
Farfield
Inlet
Opening
Outlet
Solid
Symmetry
Wall
Read Only    No
Energy

Set boundary conditions related to Energy.

Type     Energy
Read Only    No
Flow

Configure flow specification for the boundary.

Type     Flow
Read Only    No
ParticleBoundaryConditions

to be documented

Type     ParticleBoundaryConditions
Read Only    No
Radiation

Configure radiation specifications for boundary.

Type     Radiation
Read Only    No
Regime

Configure flow regime.

Type     Regime
Read Only    No
TotalConditionFrameType

Set the reference frame for total pressure and total temperature.

Type     TotalConditionFrameType
Read Only    No
Turbulence

Set turbulence related boundary conditions in the model.

Type     Turbulence
Read Only    No
UserScalarBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No
UserVectorBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No

TemperatureBoundary

Set boundary.

Properties

Acoustics

Set boundary conditions related to Acoustics.

Type     Acoustics
Read Only    No
BoundaryLocations

Set the boundary location.

Type     List<string>
Read Only    No
BoundaryReferenceFrame

Set the reference frame for boundary from (physics region or all available reference frames).

Type     BoundaryReferenceFrame
Read Only    No
BoundaryType

Set different boundary type.

Type    Option
Possible Values:    
Axis
Farfield
Inlet
Opening
Outlet
Solid
Symmetry
Wall
Read Only    No
Energy

Set boundary conditions related to Energy.

Type     Energy
Read Only    No
Flow

Configure flow specification for the boundary.

Type     Flow
Read Only    No
ParticleBoundaryConditions

to be documented

Type     ParticleBoundaryConditions
Read Only    No
Radiation

Configure radiation specifications for boundary.

Type     Radiation
Read Only    No
Regime

Configure flow regime.

Type     Regime
Read Only    No
TotalConditionFrameType

Set the reference frame for total pressure and total temperature.

Type     TotalConditionFrameType
Read Only    No
Turbulence

Set turbulence related boundary conditions in the model.

Type     Turbulence
Read Only    No
UserScalarBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No
UserVectorBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No

TimeAdvancementMethod

Configure time advancement method for transient solutions

Properties

Method

Select method for non-iterative time advancement

Type     Method
Read Only    No

TimeOfDay

Configure parameters to specify hour and minutes.

Properties

Hour

Set parameters to specify hour.

Type     int
Read Only    No
Minute

Set parameters to specify minutes.

Type     int
Read Only    No

TotalConditionFrameType

Set the reference frame for total pressure and total temperature.

Properties

Option

Allows to choose different methods to specify direction.

Type    Option
Possible Values:    
BoundaryFrame
GlobalFrame
Read Only    No

TransientScheme

Configure integration of transient terms in governing equations

Properties

TransientDefaultSetting

Specify default transient scheme

Type    Option
Possible Values:    
BoundedSecondOrderBackwardEuler
FirstOrderBackwardEuler
FirstOrderExplicit
SecondOrderBackwardEuler
SecondOrderExplicit
TimeExplicit
Read Only    No
TransientEquation

Configure transient scheme for an equation.

Type     IDictionary<string, Object>
Read Only    No

TransientSettings

Specifies how the Damping layer must behave.

Properties

IterationsPerTimeStep

Number of iterations for schemes.

Type     int
Read Only    No
Scheme

Choose between different time schemes

Type    Option
Possible Values:    
CrankNicolson
FirstOrderBackwardEuler
FirstOrderExplicit
SecondOrderBackwardEuler
SecondOrderExplicit
Read Only    No

Transmissivity

Set transmissivity parameters.

Properties

DiffuseHemispherical

Specify diffuse hemispherical transmissivity.

Type     Expression<Quantity>
Read Only    No
DirectIR

Specify direct infra-red transmissivity.

Type     Expression<Quantity>
Read Only    No
DirectVisible

Specify direct visible transmissivity.

Type     Expression<Quantity>
Read Only    No

Turbulence

Configure Turbulence initial conditions.

Properties

HydraulicDiameter

Set the hydraulic diameter.

Type     Expression<Quantity>
Read Only    No
MomentumThickness

Set the momentum thickness.

Type     Expression<Quantity>
Read Only    No
Option

Allows to choose different methods to specify turbulence.

Type    Option
Possible Values:    
Automatic
HighIntensityAndViscosityRatio
HighViscosityRatio
IntensityAndHydraulicDiameter
IntensityAndLengthScale
IntensityAndViscosityRatio
LowIntensityAndViscosityRatio
LowViscosityRatio
MediumIntensityAndViscosityRatio
MediumViscosityRatio
TransportVariables
ViscosityRatio
Read Only    No
SubgridKineticEnergy

Set values for the sub grid kinetic energy.

Type     Expression<Quantity>
Read Only    No
TurbulenceDissipationRate

Set the turbulence dissipation rate.

Type     Expression<Quantity>
Read Only    No
TurbulenceEddyFrequency

Set the turbulence eddy frequency.

Type     Expression<Quantity>
Read Only    No
TurbulenceIntensity

Set the hydraulic intensity.

Type     Expression<Quantity>
Read Only    No
TurbulenceIntermittency

Set the turbulence intermittency.

Type     Expression<Quantity>
Read Only    No
TurbulenceKineticEnergy

Set values for the turbulence kinetic energy.

Type     Expression<Quantity>
Read Only    No
TurbulenceLengthScale

Set the turbulence length scale.

Type     Expression<Quantity>
Read Only    No
TurbulenceModifiedViscosity

Set the turbulence viscosity.

Type     Expression<Quantity>
Read Only    No
TurbulenceViscosityRatio

Set the turbulence viscosity ratio.

Type     Expression<Quantity>
Read Only    No
UseAveragedQuantities

Set this parameter to use averaged values.

Type     bool
Read Only    No

Turbulence

Set turbulence related boundary conditions in the model.

Properties

HydraulicDiameter

Set the hydraulic diameter.

Type     Expression<Quantity>
Read Only    No
NumberOfVortices

Specify the number of vortices.

Type     Expression<double>
Read Only    No
Option

Allows to choose different methods to specify direction.

Type    Option
Possible Values:    
DefaultIntensityAndAutocomputeLengthScale
HighIntensityAndViscosityRatio
HighViscosityRatio
IntensityAndAutoComputeLength
IntensityAndHydraulicDiameter
IntensityAndLengthScale
IntensityAndViscosityRatio
LowIntensityAndViscosityRatio
LowViscosityRatio
MediumIntensityAndViscosityRatio
MediumViscosityRatio
TransportVariables
ViscosityRatio
kAndEddyViscosityRatio
kAndLengthScale
Read Only    No
ReynoldsStresses

Configure Reynolds stress model.

Type     ReynoldsStresses
Read Only    No
SyntheticInflowTurbulence

Choose option, for Synthetic Inflow Turbulence

Type    Option
Possible Values:    
HarmonicTurbulenceGenerator
NoPerturbations
RandomPerturbations
SpectralSynthesizer
VortexMethod
Read Only    No
TurbulenceDissipationRate

Set the turbulence dissipation rate.

Type     Expression<Quantity>
Read Only    No
TurbulenceEddyFrequency

Set the turbulence eddy frequency.

Type     Expression<Quantity>
Read Only    No
TurbulenceIntensity

Set the hydraulic intensity.

Type     Expression<Quantity>
Read Only    No
TurbulenceKineticEnergy

Set values for the turbulence kinetic energy.

Type     Expression<Quantity>
Read Only    No
TurbulenceLengthScale

Set the turbulence length scale.

Type     Expression<Quantity>
Read Only    No
TurbulenceModifiedViscosity

Set the turbulence viscosity.

Type     Expression<Quantity>
Read Only    No
TurbulenceViscosityRatio

Set the turbulence viscosity ratio.

Type     Expression<Quantity>
Read Only    No
WallRoughness

Configure inputs for defining wall roughness in turbulent calculations.

Type     WallRoughness
Read Only    No

TurbulenceEnergyInteraction

Configure Energy Model for turbulence interaction.

Properties

EnergyNearWallTreatment

Incorporate near wall treatment for energy interaction model.

Type     EnergyNearWallTreatment
Read Only    No
NearWallTreatmentThermalEffects

Enable to incorporate near-wall treatment for energy interaction model.

Type     bool
Read Only    No
TurbulenceEnergyInteractionConstants

Set turbulence energy interaction constants.

Type     TurbulenceEnergyInteractionConstants
Read Only    No

TurbulenceEnergyInteractionConstants

Set turbulence energy interaction constants.

Properties

TurbulencePrandtlNumber

Set turbulence Prandtl number.

Type     Expression<double>
Read Only    No
WallPrandtlNumber

Set wall Prandtl number.

Type     Expression<double>
Read Only    No

TurbulenceHybridSettings

to be documented

Properties

No Properties.


TurbulenceModel

Configure Turbulence Model.

Properties

LowPressureBoundarySlip

Enable/disable Low Pressure Boundary slip condition; default value is False.

Type     bool
Read Only    No
Option

Allows to choose between different turbulence models.

Type    Option
Possible Values:    
DetachedEddySimulation
DirectNumericalSimulation
Laminar
LargeEddySimulation
ReynoldsAveragedNS
ScaleAdaptiveSimulation
Read Only    No
RANSModel

Configure options for specifying the viscous model.

Type     RANSModel
Read Only    No

TurbulenceSpeciesInteraction

Configure species model for turbulence interaction.

Properties

TurbulenceSpeciesInteractionConstants

Set turbulence species interaction constants.

Type     TurbulenceSpeciesInteractionConstants
Read Only    No

TurbulenceSpeciesInteractionConstants

Set turbulence species interaction constants.

Properties

TurbulenceSchmidtNumber

Set turbulence Schmidt number.

Type     Expression<Quantity>
Read Only    No

Type

Allows to choose between different statistic types.

Properties

Option

context to be documented

Type    Option
Possible Values:    
Full
ScaleResolvingSimulation
UserSpecified
Read Only    No
Types

Statistics type.

Type    Option
Possible Values:    
MAX
MEAN
MIN
RMS
VAR
Read Only    No
Variables

Statistics type.

Type    Option
Possible Values:    
ParticleVolumeFraction
Pressure
SurfaceShearStress
TurbulenceIntermittency
TurbulenceKineticEnergy
TurbulenceViscosityRatio
Velocity
Read Only    No

UserDefinedConvergence

Create user defined convergence.

Properties

Option

Allows to specify user defined convergence.

Type    Option
Possible Values:    
LogicalExpression
None
Read Only    No

Velocity

Allows to specify the velocity direction in different coordinate system.

Properties

CartesianVelocityComponents

Set the velocity component in Cartesian coordinate system.

Type     List<Expression<Quantity>>
Read Only    No
CylindricalVelocityComponents

Set the velocity component in cylindrical coordinate system.

Type     List<Expression<Quantity>>
Read Only    No
Option

Allows to choose between cartesian and cylindrical coordinate system.

Type    Option
Possible Values:    
CartesianComponents
CylindricalComponents
Read Only    No

Velocity

Configure velocity specifications for the boundary.

Properties

Components

Allows to specify the velocity component in different coordinate system.

Type     Components
Read Only    No
GaugeStaticPressure

Set the gauge static pressure value.

Type     Expression<Quantity>
Read Only    No
Magnitude

Specify velocity magnitude.

Type     Expression<Quantity>
Read Only    No
Option

Select option for velocity specification.

Type    Option
Possible Values:    
Components
MagnitudeAndDirection
Read Only    No

VelocityInjectionCondition

Configure velocity specifications for the boundary.

Properties

CartesianVelocityComponents

Set the velocity component in Cartesian coordinate system.

Type     List<Expression<Quantity>>
Read Only    No
Magnitude

Specify velocity magnitude.

Type     Expression<Quantity>
Read Only    No
Option

Select option for velocity specification.

Type    Option
Possible Values:    
Cartesian
MagnitudeAndDirection
ZeroSlip
Read Only    No

ViewFactors

Configure settings for computing the view factors.

Properties

Basis

Set how surfaces are defined for calculation of view factor.

Type    Option
Possible Values:    
ClusterToCluster
FaceToFace
Read Only    No
Method

Set method for computing view factors.

Type    Option
Possible Values:    
Hemicube
RayTracing
Read Only    No
Parameters

Configure settings related to the hemicube and ray tracing methods for computing the view factors.

Type     Parameters
Read Only    No
Surfaces

Set Surface, the geometric orientation of surface pairs with respect to each other when using hemicube method.

Type    Option
Possible Values:    
Blocking
NonBlocking
Read Only    No

ViewFactorsAndClustering

Configure parameters for surface clusters and view factors calculation.

Properties

Clustering

Configure methods and settings for creating surface clusters.

Type     Clustering
Read Only    No
FileName

Specify file name.

Type     string
Read Only    No
ViewFactors

Configure settings for computing the view factors.

Type     ViewFactors
Read Only    No

VolumePorosity

to be documented

Properties

Value

Set the volumetric porosity value.

Type     Expression<Quantity>
Read Only    No

VolumetricReactions

Configure options related to the modeling of reacting flow.

Properties

Option

Allows to choose between different volumetric reaction definitions.

Type    Option
Possible Values:    
EddyDissipation
FiniteRateEddyDissipation
LaminarFiniteRate
Off
Read Only    No

WallBoundary

Set boundary.

Properties

Acoustics

Set boundary conditions related to Acoustics.

Type     Acoustics
Read Only    No
BoundaryLocations

Set the boundary location.

Type     List<string>
Read Only    No
BoundaryReferenceFrame

Set the reference frame for boundary from (physics region or all available reference frames).

Type     BoundaryReferenceFrame
Read Only    No
BoundaryType

Set different boundary type.

Type    Option
Possible Values:    
Axis
Farfield
Inlet
Opening
Outlet
Solid
Symmetry
Wall
Read Only    No
Energy

Set boundary conditions related to Energy.

Type     Energy
Read Only    No
Flow

Configure flow specification for the boundary.

Type     Flow
Read Only    No
ParticleBoundaryConditions

to be documented

Type     ParticleBoundaryConditions
Read Only    No
Radiation

Configure radiation specifications for boundary.

Type     Radiation
Read Only    No
Regime

Configure flow regime.

Type     Regime
Read Only    No
TotalConditionFrameType

Set the reference frame for total pressure and total temperature.

Type     TotalConditionFrameType
Read Only    No
Turbulence

Set turbulence related boundary conditions in the model.

Type     Turbulence
Read Only    No
UserScalarBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No
UserVectorBoundaryConditions

to be documented

Type     IDictionary<string, Object>
Read Only    No

WallRoughness

Configure inputs for defining wall roughness in turbulent calculations.

Properties

Option

Configure inputs for defining wall roughness in turbulent calculations.

Type    Option
Possible Values:    
Rough
Smooth
Read Only    No
RoughnessConstant

Set the roughness constant.

Type     Expression<Quantity>
Read Only    No
RoughnessHeight

Set the roughness height.

Type     Expression<Quantity>
Read Only    No

WallThickness

Allows to choose between zero thickness wall or thick wall.

Properties

Option

Allows to choose different methods to specify direction.

Type    Option
Possible Values:    
ZeroThickness
Read Only    No

WallVelocity

Allows to choose between stationary or moving wall.

Properties

MovingWall

Configure moving wall in the model.

Type     MovingWall
Read Only    No
Option

Allows to choose between stationary or moving wall.

Type    Option
Possible Values:    
Moving
Stationary
Read Only    No

Customization Data Entities

UserCommands

No details are provided for this entry.

Properties

No Properties.


WizardStep

No details are provided for this entry.

Properties

No Properties.


Structural Data Entities

BoltPretension

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.

Properties

AxialDirection

Select the separation surface normal : X, Y or Z axis of the selected reference frame.

Type     SeparationSurfaceNormal
Read Only    No
AxialDirectionDefinition

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.

Type     SeparationSurfaceSpecification
Read Only    No
AxialDirectionLocation

Select a face or an edge to interpret the axial direction of the bolt.

Type     LocationSet
Read Only    No
DefineBy

Choose how the bolt is defined : Axial force or Adjustment

Type     PretensionDefineBy
Read Only    No
Location

Location of the boundary condition

Type     LocationSet
Read Only    No
Magnitude

Applied value of load

Type     Expression<Quantity>
Read Only    No
ModelAs

Choose how many bolts should be created if multiple volumes are selected : One for all selected volumes or one per selected volume.

Type     PretensionModelAs
Read Only    No
ReferenceFrame

Select the separation surface frame.

Type     ReferenceFrame
Read Only    No

BoundaryCondition

BoundaryCondition is the abstraction over load and constraints.

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No

BushingJoint

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.

Properties

No Properties.


CalculationTime

A class that holds calculation time of transient analysis.

Properties

Duration

Duration of the analysis

Type     Quantity
Read Only    No

Connection

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.

Properties

Behavior

It displays the contact behavior referenced by this connection.

Type     InterfaceBehavior
Read Only    No
CreationMode

It tells if this connection was created automatically by the program or created manually by the user

Type     CreationMode
Read Only    No
Location1

This is the first location of the connection. For contact, this normally refers to the source of the contact.

Type     LocationSet
Read Only    No
Location1Bodies

It displays the bodies of the entities referenced in Location 1 of the connection.

Type     string
Read Only    Yes
Location2

This is the second location of the connection. For contact, this normally refers to the target of the contact.

Type     LocationSet
Read Only    No
Location2Bodies

It displays the bodies of the entities referenced in Location 2 of the connection.

Type     string
Read Only    Yes

ConnectionBehavior

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

Properties

No Properties.


ConnectionStatisticalMeasures

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.

Properties

PercentageConfidenceLevel

Show the confidence level for the automatic generated connections

Type     double
Read Only    Yes

Constraint

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.

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No

Contact

This is a class that is meant to define Contact

Properties

Behavior

It displays the contact behavior referenced by this connection.

Type     InterfaceBehavior
Read Only    No
CreationMode

It tells if this connection was created automatically by the program or created manually by the user

Type     CreationMode
Read Only    No
Location1

This is the first location of the connection. For contact, this normally refers to the source of the contact.

Type     LocationSet
Read Only    No
Location1Bodies

It displays the bodies of the entities referenced in Location 1 of the connection.

Type     string
Read Only    Yes
Location2

This is the second location of the connection. For contact, this normally refers to the target of the contact.

Type     LocationSet
Read Only    No
Location2Bodies

It displays the bodies of the entities referenced in Location 2 of the connection.

Type     string
Read Only    Yes

ContactBehavior

ContactBehavior is ConnectionBehavior to model various kinds of contact behaviors available from Mechanical Solvers such as contact types and their formulations.

Properties

ContactType

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

Type     ContactType
Read Only    No

ContactDamping

This class represents the contact damping settings. It get run-time added to a non linear structural contact.

Properties

NormalStabilizationDamping

Damping scaling factor along the normal direction to reduce the risk of rigid body motion

Type     Expression<Quantity>
Read Only    No
TangentStabilizationDamping

Damping scaling factor along the tangential direction to reduce the risk of rigid body motion

Type     Expression<Quantity>
Read Only    No

ContactDetection

This is a class resposible for applying the rules of contact detection

Properties

Algorithm

Property for selecting algorithm for contact detection

Type     AlgorithmType
Read Only    No
FaceEdgeDetectionPreference

Property for setting the preference for face to edge or edge to face detection between bodies or parts

Type     FaceEdgePreference
Read Only    No
FaceFaceDetectionPreference

Property for setting the preference for face to face detection between bodies or parts

Type     FaceFacePreference
Read Only    No
Location

It is the location where it should detect contacts

Type     LocationSet
Read Only    No
Preference

Property for setting the preference for detecting contact between bodies, or between bodies of different parts

Type     PreferenceType
Read Only    No
Priority

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

Type     PriorityType
Read Only    No
Tolerance

Property for minimum gap between bodies, to register a contact detection

Type     Quantity
Read Only    No

ContactDetectionDirection

ContactDetectionDirection is a class to change the normals on shell bodies for contact connections as available from MAPDL solver

Properties

DetectionDirectionMethod

Set the ditection direction method

Type     SearchDirectionMethod
Read Only    No
ReverseDirectionLoaction1

Switch to turn on to reverse the contact search direction for location 1

Type     bool
Read Only    No
ReverseDirectionLoaction2

Switch to turn on to reverse the contact search direction for location 2

Type     bool
Read Only    No

ContactElasticSlipTolerance

This is a class resposible for setting elastic slip tolerance at the contact interface.

Properties

DefineBy

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

Type     ValueDefineBy
Read Only    No
Value

Enter the factor or value

Type     Expression<Quantity>
Read Only    No

ContactHeatGeneration

This class represents the heat generation due to friction or current

Properties

FrictionHeatFactor

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).

Type     Expression<Quantity>
Read Only    No
HeatDistributionFactor

It represents the weight factor for the distribution of heat between the contact and target surfaces.

Type     Expression<Quantity>
Read Only    No

ContactInterfaceGapAdjustment

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

Properties

InitialInterfaceTreatment

Defines how the contact interface of a contact pair is treated.

Type     InitialInterfaceTreatmentType
Read Only    No
Offset

Defines the contact offset value. A positive value moves the contact closer together and a negative value moves the contact further apart.

Type     Expression<Quantity>
Read Only    No

ContactPenetrationTolerance

This is a class resposible for setting penetration tolerance at the contact interface.

Properties

DefineBy

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

Type     ValueDefineBy
Read Only    No
Value

Enter the factor or value

Type     Expression<Quantity>
Read Only    No

ContactPinball

This is a class resposible for setting pinball value for contact detection.

Properties

DefineBy

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

Type     ValueDefineBy
Read Only    No
Value

Enter the factor or value

Type     Expression<Quantity>
Read Only    No

ContactProperties

This class defines contact properties that can change per contact pair such as Symmetry Behavior etc. as exposed by Mechanical solvers.

Properties

ApplySymmetry

Switch to turn on symmetric contact - Additional contact pair will be generated by swapping Location 1 and Location 2

Type     bool
Read Only    No

ContactStiffness

This class represents the various behavior of contact stiffness

Properties

UpdateStiffnessControl

Option to set the frequency of updating stifness

Type     UpdateStiffnessControlType
Read Only    No

ContactSubObject

This is the base class for pinball, penetration tolerance and the slip tolerance.

Properties

DefineBy

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

Type     ValueDefineBy
Read Only    No
Value

Enter the factor or value

Type     Expression<Quantity>
Read Only    No

Convection

Convection is a Scalar Load to precribe a given value of heat flux at a given location in a model in thermal solutions.

Properties

AmbientTemperature

Value of Ambient Temperature of Radiation.

Type     Expression<Quantity>
Read Only    No
Location

Location of the boundary condition

Type     LocationSet
Read Only    No
Magnitude

Applied value of load

Type     Expression<Quantity>
Read Only    No
ReferenceFrame

Field variables of the spatial variation expression are defined with respect to this reference frame.

Type     ReferenceFrame
Read Only    No

Current

Current is a Scalar Load to precribe a given value of current at a given location in a model in electric solutions.

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No
Magnitude

Applied value of load

Type     Expression<Quantity>
Read Only    No
ReferenceFrame

Field variables of the spatial variation expression are defined with respect to this reference frame.

Type     ReferenceFrame
Read Only    No

CylindricalJoint

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.

Properties

No Properties.


Displacement

Displacement is a Vector Constraint used to prescribe a given value of displacement at a given location in the model

Properties

AppliedRemotely

This property sets the type of displacement whether it is applied directly or remotely via an originating point

Type     bool
Read Only    No
Location

Location of the boundary condition

Type     LocationSet
Read Only    No
Specify

This property sets the type of displacement whether it is translation only or a combo of translation and rotation.

Type     DisplacementType
Read Only    No

DisplacementByVector

No details are provided for this entry.

Properties

DefineBy

This property sets the type of vector specification which could be by Components or MagnitudeAndDirection or NormalToSurface.

Type     VectorDefineBy
Read Only    No
RelativeTo

Vector components or direction has been specified with respect to this reference frame.

Type     ReferenceFrame
Read Only    No

ElectricConductance

This class represents the eletric conductance at the contact interface. It gets added when selected physics includes electric and formulation is not MPC.

Properties

Conductance

Contact conductance value

Type     Expression<Quantity>
Read Only    No
ConductanceControl

Switch to use program controlled conductance value or enter value.

Type     ConductanceControlType
Read Only    No

Equipotential

This is a class that creates an equal voltage on the selection applied.

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No

FatigueSettings

This is a class that contains the various settings pertaining to Fatigue analysis

Properties

AccumulateDamage

Specify whether you want to accumulate damage or not

Type     bool
Read Only    No
AnalysisType

Select the type of approach used for fatigue analysis i.e. Stress life or Strain life

Type     AnalysisType
Read Only    No
BlocksPerCycle

Specify the Blocks per cycle

Type     double
Read Only    No
DefineBy

Specify the S-N curve data source

Type     DefineBy
Read Only    No
DesignLife

Specify design life for damage and safety factor calculations

Type     double
Read Only    No
DesignLifeUnit

Displays the life units chosen

Type     string
Read Only    Yes
ENMeanStressTheory

Specify how mean stress effects are handled for Strain life fatigue

Type     ENMeanStressTheory
Read Only    No
InfiniteLife

Specify the maximum life for strain life to avoid skewed contour plots showing very high lives

Type     double
Read Only    No
LoadingType

Select the type of applied constant amplitude loading based on the loading ratio

Type     LoadingType
Read Only    No
MeanStressTheory

Specify how mean stress effects are handled for Stress life fatigue

Type     MeanStressTheory
Read Only    No
MultiAxisType

Specify the stress component type

Type     MultiAxisType
Read Only    No
Ratio

Specify the loading ratio

Type     double
Read Only    No
ScaleFactor

Specify the Scale factor to scale the load magnitude.

Type     double
Read Only    No
TimePerCycle

Specify the Time per cycle

Type     double
Read Only    No
UltimateStrength

Specify the Ultimate Strength for all materials in the model

Type     Expression<Quantity>
Read Only    No
UnitType

Specify the life units used to display fatigue life results

Type     FatigueUnitType
Read Only    No
YieldStrength

Specify the Yield Strength for all materials in the model

Type     Expression<Quantity>
Read Only    No

FatigueUnitsExtension

/// Displays the units chosen for Fatigue life and design life.

Properties

UnitName

/// The units chosen for Fatigue life and design life.

Type     string
Read Only    Yes

FixedJoint

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.

Properties

No Properties.


Force

Force is a Vector Load to prescribe external force to a given model at a given location.

Properties

AppliedRemotely

Property to control if the force is applied remotely via an originating point or directly.

Type     bool
Read Only    No
Location

Location of the boundary condition

Type     LocationSet
Read Only    No
Specification

Property to specify if the applied force value is total force or the force per unit area of the selected surface location.

Type     ApplicationMethod
Read Only    No

GeneralJoint

This class represents only general joint specific settings. It get run-time added to Joint as the joint type is general

Properties

No Properties.


GeneralJointDOFs

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.

Properties

Rotation

It controls the behavior of rotational DOFs of a general joint

Type     RotationalDOFBehavior
Read Only    No
TranslationX

Switch to set Tranlation X as a free DOF

Type     TranslationalDOFBehavior
Read Only    No
TranslationY

Switch to set Tranlation Y as a free DOF

Type     TranslationalDOFBehavior
Read Only    No
TranslationZ

Switch to set Tranlation Z as a free DOF

Type     TranslationalDOFBehavior
Read Only    No

GroundLocation

This is a class that is meant to define ground location

Properties

Location

The selected location: evaluates to a set of reference ids. See LocationSet for more detail.

Type     LocationSet
Read Only    Yes

HeatFlow

Heat Flow is a Scalar Load to precribe a given value of heat flow at a given location in a model in thermal solutions.

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No
Magnitude

Applied value of load

Type     Expression<Quantity>
Read Only    No
ReferenceFrame

Field variables of the spatial variation expression are defined with respect to this reference frame.

Type     ReferenceFrame
Read Only    No

HeatFlux

Heat Flux is a Scalar Load to precribe a given value of heat flux at a given location in a model in thermal solutions.

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No
Magnitude

Applied value of load

Type     Expression<Quantity>
Read Only    No
ReferenceFrame

Field variables of the spatial variation expression are defined with respect to this reference frame.

Type     ReferenceFrame
Read Only    No

HeatGeneration

Heat Generation is a Scalar Load to prescribe a uniform generation rate internal to a body.

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No
Magnitude

Applied value of load

Type     Expression<Quantity>
Read Only    No
ReferenceFrame

Field variables of the spatial variation expression are defined with respect to this reference frame.

Type     ReferenceFrame
Read Only    No

HingeJoint

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.

Properties

No Properties.


InertiaLoad

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.

Properties

LoadType

Load Type of Inertia Load such as Acceleration, Angular Velocity or Angular Acceleration.

Type     VectorType
Read Only    No
Location

Location of the boundary condition

Type     LocationSet
Read Only    No

InitialCondition

Initial conditions is the abstraction over all kinds of initial conditions.

Properties

Location

Location for InitialCondition

Type     LocationSet
Read Only    No

InitialReferenceFrames

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.

Properties

Base

Reference frame for Location 1 of connection

Type     ReferenceFrame
Read Only    No
Mobile

Reference frame for Location 2 of connection

Type     ReferenceFrame
Read Only    No

InitialTemperature

This class specifes the initial values of the temperature

Properties

Location

Location for InitialCondition

Type     LocationSet
Read Only    No
Magnitude

Value of scalar initial condition

Type     Expression<Quantity>
Read Only    No

InterfaceGenerator

InterfaceGenerator is class to define various settings for detection of Interface Conditions such a contacts.

Properties

BehaviorCreation

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

Type     InterfaceBehaviorCreation
Read Only    No
DetectionTypes

Set the detection types for generating the interfaces

Type     InterfaceDetectionTypes
Read Only    No
GenerateFixedJoints

Switch to activate generation of fixed joints

Type     bool
Read Only    No
GenerateHingeJoints

Switch to activate generation of hinge joints

Type     bool
Read Only    No
InterfaceToleranceSpecification

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

Type     InterfaceToleranceSpecification
Read Only    No
InterfaceType

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

Type     InterfaceType
Read Only    No
Location

Location considered to search for interfaces.

Type     LocationSet
Read Only    No
Tolerance

Tolerance value used to search for interfaces

Type     Quantity
Read Only    No

Joint

This is a class that is meant to define different kinds of Joint

Properties

Behavior

It displays the contact behavior referenced by this connection.

Type     InterfaceBehavior
Read Only    No
CreationMode

It tells if this connection was created automatically by the program or created manually by the user

Type     CreationMode
Read Only    No
Location1

This is the first location of the connection. For contact, this normally refers to the source of the contact.

Type     LocationSet
Read Only    No
Location1Bodies

It displays the bodies of the entities referenced in Location 1 of the connection.

Type     string
Read Only    Yes
Location2

This is the second location of the connection. For contact, this normally refers to the target of the contact.

Type     LocationSet
Read Only    No
Location2Bodies

It displays the bodies of the entities referenced in Location 2 of the connection.

Type     string
Read Only    Yes

JointBehavior

JointBehavior is a ConnectionBehavior that models joint connection between two locations.

Properties

JointType

Joint type such as fixed, hinge, slot, translational, cylindrical, planar, etc.

Type     JointType
Read Only    No

JointTypeBase

This is the base class for all joint types (fixed, hinge, cylindrical, general, etc.)

Properties

No Properties.


LaunchSettings

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.

Properties

ComponentDataFileName

A name for auxiliary solver input file which contains all nodal and elemental components created in MAPDL solution.

Type     string
Read Only    No
ConnectionElementsDataFileName

A name for auxiliary solver input file which contains all connection elements in MAPDL solution.

Type     string
Read Only    No
ContactPairOutput

Activate Contact Pair Output in MAPDL solution.

Type     ContactPairOutputYesNo
Read Only    No
DeleteWorkFiles

Override to keep all solver generated files in MAPDL solution.

Type     bool
Read Only    No
DistributedSolve

Turn Off or On Distributed solution for MAPDL solver.

Type     bool
Read Only    No
InputDataFileName

A name for master solver input file which assembles all other auxiliary input files (MeshDataFileName, ComponentDataFileName, etc.) for MAPDL Solver.

Type     string
Read Only    No
JobName

A name for the job file in MAPDL solution.

Type     string
Read Only    No
LoadElementsDataFileName

A name for auxiliary solver input file which contains all load elements in MAPDL solution.

Type     string
Read Only    No
MeshDataFileName

A name for auxiliary solver input file which contains all mesh information(nodes and elements) for all participating bodies in MAPDL solution.

Type     string
Read Only    No
NumberOfProcessors

Number of Processors to use for distributed solution in MAPDL solver.

Type     uint
Read Only    No
OutputListFileName

A name for output file in MAPDL solution.

Type     string
Read Only    No
SolverFilesDirectory

Solver Files Directory where solution happens for MAPDL solver.

Type     string
Read Only    Yes
SolverMode

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

Type     MAPDLSolverMode
Read Only    No

Load

Load is Boudary Condition to prescribe external load to a given location in a model. It is an abstraction over scalar and vector loads.

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No

MechanicalPhysicsOptions

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.

Properties

Location

The region participating in the solution.

Type     LocationSet
Read Only    No
UseInertialReferenceFrame

For Rigid bodies, control to model them using a single Inertial Frame or individual ones

Type     bool
Read Only    No

Moment

Moment is a vector load to prescribe an external moment load to a given location in a model.

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No

OptimizationConstraint

OptimizationConstraint is a base class for all optimization constraint classes

Properties

No Properties.


OutputControls

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.

Properties

No Properties.


PlanarJoint

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.

Properties

No Properties.


Pressure

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.

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No
Magnitude

Applied value of load

Type     Expression<Quantity>
Read Only    No
ReferenceFrame

Field variables of the pressure spatial variation expression are defined with respect to this reference frame.

Type     ReferenceFrame
Read Only    No

PretensionTolerance

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.

Properties

Tolerance

Value of pretension tolerance

Type     Expression<Quantity>
Read Only    No
ToleranceSpecification

Choose how pretension tolerance is defined : Program controlled or Manual

Type     DefineBy
Read Only    No

Radiation

Radiation is a scalar load to prescribe an external Radiation to a given location in a model.

Properties

Emissivity

Value of Emissivity of Radiation.

Type     Expression<Quantity>
Read Only    No
Location

Location of the boundary condition

Type     LocationSet
Read Only    No
Magnitude

Applied value of load

Type     Expression<Quantity>
Read Only    No
ReferenceFrame

Field variables of the spatial variation expression are defined with respect to this reference frame.

Type     ReferenceFrame
Read Only    No

RemoteLocation

This extension is added to boundary condition when it is applied remotely via an originating point.

Properties

OriginatingPoint

Originating point for the remote boundary condition.

Type     LocationSet
Read Only    No

ScalarConstraint

ScalarConstraint is abstraction over constraints that are scalar by nature such as temperature in thermal solutions or voltage in electric solutions

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No
Magnitude

Applied value of constraint

Type     Expression<Quantity>
Read Only    No

ScalarInitialCondition

This is used by scalar initial conditions.

Properties

Location

Location for InitialCondition

Type     LocationSet
Read Only    No
Magnitude

Value of scalar initial condition

Type     Expression<Quantity>
Read Only    No

ScalarLoad

ScalarLoad is abstraction over loads that are scalar by nature such as pressure Radiation etc.

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No
Magnitude

Applied value of load

Type     Expression<Quantity>
Read Only    No

SlotJoint

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.

Properties

No Properties.


SolidModelingOptions

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.

Properties

BrickIntegrationType

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

Type     IntegrationType
Read Only    No

SphericalJoint

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.

Properties

No Properties.


Support

Support is a constraint to precribe zero values to active degrees of freedom for a given model at a given location.

Properties

FixedDOFs

Collection of degrees of freedom which are fixed.

Type     String[]
Read Only    No
Location

Location of the boundary condition

Type     LocationSet
Read Only    No
RelativeTo

Degrees of freedom are defined with respect to this reference frame.

Type     ReferenceFrame
Read Only    No
SupportType

Type of support : Fixed, Free or User defined.

Type     SupportType
Read Only    No

TemperatureCondition

Temperature Condition is scalar load to prescribe temperature to a given location(bodies or elements) in a model in pure structural solutions.

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No
Magnitude

Applied value of load

Type     Expression<Quantity>
Read Only    No
ReferenceFrame

Field variables of the spatial variation expression are defined with respect to this reference frame.

Type     ReferenceFrame
Read Only    No

TemperatureConstraint

Temperature Constraint is a scalar constraint to precribe known value of temperature in solutions that suppport thermal degrees of freedom.

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No
Magnitude

Applied value of constraint

Type     Expression<Quantity>
Read Only    No

ThermalConductance

This class represents the thermal conductance at the contact interface. It gets added when selected physics includes thermal and formulation is not MPC.

Properties

Conductance

Contact conductance value

Type     Expression<Quantity>
Read Only    No
ConductanceControl

Switch to use program controlled conductance value or enter value.

Type     ConductanceControlType
Read Only    No

TranslationalJoint

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.

Properties

No Properties.


TranslationRotation

No details are provided for this entry.

Properties

RelativeTo

Degrees of freedom are defined with respect to this reference frame.

Type     ReferenceFrame
Read Only    No
RotationX

The X rotation component

Type     Expression<Quantity>
Read Only    No
RotationY

The Y rotation component

Type     Expression<Quantity>
Read Only    No
RotationZ

The Z rotation component

Type     Expression<Quantity>
Read Only    No
TranslationX

The X translation component

Type     Expression<Quantity>
Read Only    No
TranslationY

The Y translation component

Type     Expression<Quantity>
Read Only    No
TranslationZ

The Z translation component

Type     Expression<Quantity>
Read Only    No

UniversalJoint

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.

Properties

No Properties.


UnknownJoint

This class is used only for initialization purposes if joint type is unknown.

Properties

No Properties.


Vector

Vector is class used by all Boundary Conditions and Connection that support a Vector Behavior.

Properties

DefineBy

This property sets the type of vector specification which could be by Components or MagnitudeAndDirection or NormalToSurface.

Type     VectorDefineBy
Read Only    No
RelativeTo

Vector components or direction has been specified with respect to this reference frame.

Type     ReferenceFrame
Read Only    No

VectorByComponents

VectorByComponents is class to define a vector by Components.

Properties

Component1

The x component

Type     Expression<Quantity>
Read Only    No
Component2

The y component

Type     Expression<Quantity>
Read Only    No
Component3

The z component

Type     Expression<Quantity>
Read Only    No
CoordinateType

The type of coordinate system to be used which could be Cartesian or Cylindrical or Spherical.

Type     TripletType
Read Only    Yes
RelativeTo

Vector components has been specified with respect to this reference frame.

Type     ReferenceFrame
Read Only    No

VectorByGeometry

ByGeometry is class to define a vector using geometry.

Properties

Magnitude

Magnitude of the vector

Type     Expression<Quantity>
Read Only    No

VectorByMagnitudeAndDirection

VectorByMagnitudeAndDirection is class to define a vector by magnitude and direction.

Properties

Direction

User can select a geometric entity for this property which will be used to infer a direction for the vector.

Type     LocationSet
Read Only    No
Magnitude

Magnitude of the vector

Type     Expression<Quantity>
Read Only    No
ReverseDirection

This property can be used to reverse the direction which is inferred from the geometric selection.

Type     bool
Read Only    No

VectorConstraint

A Vector Constraint is constraint that has an underneath vectors like Displacement, Velocity etc

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No

VectorInitialCondition

Initial conditions is the abstraction over all kinds of vector initial conditions.

Properties

Location

Location for InitialCondition

Type     LocationSet
Read Only    No

VectorLoad

VectorLoad is an abstraction over loads that are vector by nature such as Force, Moment, Traction etc.

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No

Voltage

Voltage is a scalar constraint to precribe known value of voltage in solutions that suppport electric degrees of freedom.

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No
Magnitude

Applied value of constraint

Type     Expression<Quantity>
Read Only    No

AemCore Data Entities

AemContourFieldResultProcessor

No details are provided for this entry.

Properties

No Properties.


AemFunctionProvider

No details are provided for this entry.

Properties

DisplayText

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.

Type     string
Read Only    No

AEMLaunchControls

No details are provided for this entry.

Properties

NumOfProcessors

No details are provided for this entry.

Type     int
Read Only    No

AemSingleValueResultProcessor

No details are provided for this entry.

Properties

No Properties.


AemVectorFieldResultProcessor

No details are provided for this entry.

Properties

No Properties.


BodyTemperature

No details are provided for this entry.

Properties

Location

No details are provided for this entry.

Type     LocationSet
Read Only    No
Temperature

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No

CoreLossComputation

No details are provided for this entry.

Properties

CoreLossBodyIncluded

No details are provided for this entry.

Type     LocationSet
Read Only    No
CorelossType

No details are provided for this entry.

Type     CoreLossComputationType
Read Only    No

EddyEffectComputation

No details are provided for this entry.

Properties

DisplacementBodyIncluded

No details are provided for this entry.

Type     LocationSet
Read Only    No
DisplacementCurrentType

No details are provided for this entry.

Type     ComputationType
Read Only    No
EddyEffectBodyIncluded

No details are provided for this entry.

Type     LocationSet
Read Only    No
EddyEffectType

No details are provided for this entry.

Type     ComputationType
Read Only    No

ForceComputation

No details are provided for this entry.

Properties

ForceType

No details are provided for this entry.

Type     ForceTypes
Read Only    No
Location

No details are provided for this entry.

Type     LocationSet
Read Only    No
ReferenceFrame

No details are provided for this entry.

Type     ReferenceFrame
Read Only    No

FrequencyPPOption

No details are provided for this entry.

Properties

Magnitude

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No

FrequencyResponseSettings

No details are provided for this entry.

Properties

AdaptiveFrequency

No details are provided for this entry.

Type     Quantity
Read Only    No
AdaptiveFrequencySetupType

No details are provided for this entry.

Type     AdaptMeshingFreqType
Read Only    No
Frequencies

No details are provided for this entry.

Type     Expression<List<Quantity>>
Read Only    No
FrequenciesPerDecade

No details are provided for this entry.

Type     int
Read Only    No
FrequencySpecification

No details are provided for this entry.

Type     FreqSpecChoices
Read Only    No
SingleValueFrequency

No details are provided for this entry.

Type     Quantity
Read Only    No
StartFrequency

No details are provided for this entry.

Type     Quantity
Read Only    No
StepSize

No details are provided for this entry.

Type     Quantity
Read Only    No
StopFrequency

No details are provided for this entry.

Type     Quantity
Read Only    No
SweepType

No details are provided for this entry.

Type     SweepTypes
Read Only    No

GeneralPhysicsOptions

No details are provided for this entry.

Properties

AmbientTemperature

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
ComputeInductance

No details are provided for this entry.

Type     bool
Read Only    No
CondThreshold

No details are provided for this entry.

Type     Quantity
Read Only    No
CondThresholdType

No details are provided for this entry.

Type     ConductivityThresholdType
Read Only    No
PerfcondThreshold

No details are provided for this entry.

Type     Quantity
Read Only    No
PerfcondThresholdType

No details are provided for this entry.

Type     ConductivityThresholdType
Read Only    No

Insulating

No details are provided for this entry.

Properties

Location

No details are provided for this entry.

Type     LocationSet
Read Only    No

MagneticsSolverSettings

No details are provided for this entry.

Properties

CurvedSurfaceMeshingTuning

No details are provided for this entry.

Type     int
Read Only    No
MaxPassNumber

No details are provided for this entry.

Type     int
Read Only    No
MaxPassOption

No details are provided for this entry.

Type     MaximumPassDefinition
Read Only    No
SolutionPerformanceTuning

No details are provided for this entry.

Type     int
Read Only    No

MatrixObjectTuple

No details are provided for this entry.

Properties

SourceId

No details are provided for this entry.

Type     string
Read Only    No
SourceName

No details are provided for this entry.

Type     string
Read Only    No
SourceTurn

No details are provided for this entry.

Type     double
Read Only    No

PostMatrixObjectTuple

No details are provided for this entry.

Properties

GroupBranches

No details are provided for this entry.

Type     int
Read Only    No
GroupEntries

No details are provided for this entry.

Type     List<string>
Read Only    No
GroupId

No details are provided for this entry.

Type     string
Read Only    No
GroupName

No details are provided for this entry.

Type     string
Read Only    No

ResultSetComplex

No details are provided for this entry.

Properties

PhaseAngle

No details are provided for this entry.

Type     Quantity
Read Only    No

ResultSetFrequency

No details are provided for this entry.

Properties

Frequency

No details are provided for this entry.

Type     Quantity
Read Only    No

SkinDepthResolution

No details are provided for this entry.

Properties

Location

No details are provided for this entry.

Type     LocationSet
Read Only    No
Resolution

No details are provided for this entry.

Type     int
Read Only    No

TableResultFrequencyExtension

No details are provided for this entry.

Properties

Frequency

No details are provided for this entry.

Type     Quantity
Read Only    No

TableResultLocationExtension

No details are provided for this entry.

Properties

Location

No details are provided for this entry.

Type     LocationSet
Read Only    No

TableResultTypeExtension

No details are provided for this entry.

Properties

ForceType

No details are provided for this entry.

Type     ForceType
Read Only    No
LossType

No details are provided for this entry.

Type     LossType
Read Only    No
MatrixType

No details are provided for this entry.

Type     MatrixType
Read Only    No
Type

No details are provided for this entry.

Type     TableType
Read Only    No

Terminal

No details are provided for this entry.

Properties

Location

No details are provided for this entry.

Type     LocationSet
Read Only    No
NumberOfConductors

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
ReversePolarity

No details are provided for this entry.

Type     bool
Read Only    No
ShowConductionPath

No details are provided for this entry.

Type     bool
Read Only    No

TorqueComputation

No details are provided for this entry.

Properties

Axis

No details are provided for this entry.

Type     AxisType
Read Only    No
Location

No details are provided for this entry.

Type     LocationSet
Read Only    No
ReferenceFrame

No details are provided for this entry.

Type     ReferenceFrame
Read Only    No
TorqueDirection

No details are provided for this entry.

Type     TorqueDirections
Read Only    No
TorqueType

No details are provided for this entry.

Type     TorqueTypes
Read Only    No

Winding

No details are provided for this entry.

Properties

Current

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
IsConnectedInParallel

No details are provided for this entry.

Type     bool
Read Only    No
NumberOfBranches

No details are provided for this entry.

Type     int
Read Only    No
Phase

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
Terminals

No details are provided for this entry.

Type     List<Terminal>
Read Only    No

Mapdl Data Entities

AdditionalConvergenceControls

AdditionalConvergenceControls is a Solver Settings class that allows defining nonlinear controls such as line search, predictor etc. as exposed by MAPDL solver.

Properties

EquilibriumIterations

Choose number of equilibrium iterations for non-linear solution in MAPDL solver.

Type     int
Read Only    No
EquilibriumIterationsKey

Choose equilibrium iterations keys for non-linear solution in MAPDL solver.

Type     IterationKey
Read Only    No
LineSearch

Activate Line Search for non-linear solution in MAPDL solver.

Type     ProgramControlType
Read Only    No
PredictorCorrector

Activate Predictor for non-linear solution in MAPDL solver.

Type     PredictorKey
Read Only    No

ContactFormulation

ContactFormulation is a class to represents various contact formulations as available from MAPDL solver

Properties

ConstraintType

No details are provided for this entry.

Type     ContactConstraintType
Read Only    No
DetectAsymmetryAutomatically

A flag to notify the program if auto-asymmetry should be used in the physics solution.

Type     bool
Read Only    No
DetectionType

Specify the location of contact detection to be used in the analysis in order to obtain a good convergence.

Type     ContactDetectionPoint
Read Only    No
DynamicFrictionCoefficient

Dynamic coefficient of friction

Type     Expression<Quantity>
Read Only    No
Formulation

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

Type     FormulationType
Read Only    No
IncludeShellThickness

Switch to include shell thickness or not in the contact analysis

Type     bool
Read Only    No
PhysicsToTransfer

Method for selecting the physics type: Program controlled or Manual

Type     ContactPhysicsToTransfer
Read Only    No
TransferredPhysics

Specified physics type(s) for the contact formulation

Type     PhysicsType
Read Only    No

ConvergenceControl

ConvergenceControl is Solver Settings class that allows defining various non-linear convergence techniques as exposed by MAPDL solver such as CNVTOL command.

Properties

Convergence

An enumeration to turn on, off Convergence Controls as available from MAPDL solver.

Type     ProgramControlType
Read Only    No
MinimumReferenceValue

Convergence minimum reference value defined for a given Convergence Control as available from MAPDL solver.

Type     Quantity
Read Only    No
ReferenceValue

Convergence value defined for a given Convergence Control as available from MAPDL solver.

Type     Quantity
Read Only    No
ReferenceValueSpecification

Method for selecting the specification type: Program controlled or Manual

Type     ReferenceValueSpecification
Read Only    No
Tolerance

Convergence tolerance value defined for a given Convergence Control as available from MAPDL solver.

Type     double
Read Only    No

ConvergenceControls

ConvergenceCriterias is a Solution Progression class that allows defining convergence controls as exposed by MAPDL solver.

Properties

No Properties.


GeneralNonLinearControls

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.

Properties

LargeDeflection

A switch to activate geometric nonlinearity.

Type     ProgramControlType
Read Only    No
NRSetting

An enumeration to select various Newton Raphson Methods as available from MAPDL solver.

Type     NewtonRaphsonOption
Read Only    No

GeneralSolutionControls

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.

Properties

InertiaRelief

Inertia Relief as available from MAPDL solver.

Type     bool
Read Only    No
LimitSearchToRange

Activate search to a given range of frequencies for frequency domain solutions as available from MAPDL solver.

Type     YesOrNo
Read Only    No
MatrixSolver

Equation Solver Types as available from MAPDL solver.

Type     EquationSolverType
Read Only    No
MaxModesToFind

Maximum modes to find for modal solutions as available from MAPDL solver.

Type     int
Read Only    No
RangeMaximum

A value of maximum frequency for frequency domain solutions with a given range as available from MAPDL solver.

Type     Quantity
Read Only    No
RangeMinimum

A value of minimum frequency for frequency domain solutions with a given range as available from MAPDL solver.

Type     Quantity
Read Only    No
SolverDamping

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

Type     DampedSolverType
Read Only    No
SolverUnitSystem

Solver unit systems as available from MAPDL solver.

Type     string
Read Only    No

MapdlFixedJoint

MapdlFixedJoint is a class to represents Fixed Joint Connection Behavior as available from MAPDL solver

Properties

Formulation

JointFormulation types used by Mapdl Fixed Joint Connection Behavior

Type     JointFormulation
Read Only    No
ReductionMethod

ReductionMethod used by Mapdl Fixed Joint Connection Behavior

Type     JointReductionMethod
Read Only    No

MAPDLFunctionProvider

This is a class that implements MAPDL expressions like AllContacts(), AllJoints() etc.

Properties

DisplayText

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.

Type     string
Read Only    No

OptimizationControls

No details are provided for this entry.

Properties

ConvergenceAccuracy

No details are provided for this entry.

Type     double
Read Only    No
MaximumNumberOfIterations

No details are provided for this entry.

Type     int
Read Only    No
MaxNumberOfIntermediateFiles

No details are provided for this entry.

Type     uint
Read Only    No
MinimumNormalizedDensity

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
OptimizationSolver

No details are provided for this entry.

Type     OptimizationSolverType
Read Only    No

OutputSpecification

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.

Properties

EquallySpacedTimePoints

Time Points frequency of OutputSpecification

Type     int
Read Only    No
Frequency

Frequency of OutputSpecification, how often a given output type is written to result file

Type     CalculationFrequency
Read Only    No
Location

Location for OutputSpecification

Type     LocationSet
Read Only    No
OutputType

OutputType for OutputSpecification such as Deformation, Stress or Strain

Type     OutputType
Read Only    No
RecurrenceRate

RecurrenceRate of OutputSpecification

Type     int
Read Only    No

OutputSpecifications

OutputSpecifications is a class that is repository of individual OutputSpecification such as Deformation, Stress or Strain.

Properties

No Properties.


Stabilization

Stabilization is a class that allows defining Stablization parameters for nonlinear solutions as exposed by MAPDL solver.

Properties

DampingFactor

Value for Damping Factor.

Type     double
Read Only    No
EnergyDissipationRatio

Value for Energy Dissipation Ratio.

Type     double
Read Only    No
ForceLimit

Value of Force Limit.

Type     double
Read Only    No
StabilizationKey

Activate various Stabilization Keys in MAPDL Solution.

Type     StabilizationKey
Read Only    No
SubStepOption

Activate various substep options.

Type     SubStepOption
Read Only    No

TimeStepOptions

TimeStepOptions is a Solver Settings class that help define the time step controls available in MAPDL solver.

Properties

DefinedBy

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

Type     AutoTimeSteppingDefinedBy
Read Only    No
InitialNumberOfSubsteps

When defining auto time stepping by substeps, define Initial Substeps as available in MAPDL solver.

Type     int
Read Only    No
InitialTimeStep

When defining auto time stepping by time steps, define Initial Time Step as available in MAPDL solver.

Type     Quantity
Read Only    No
MaximumNumberOfSubsteps

When defining auto time stepping by substeps, define Maximum Substeps as available in MAPDL solver.

Type     int
Read Only    No
MaximumTimeStep

When defining auto time stepping by time steps, define Maximum Time Step as available in MAPDL solver.

Type     Quantity
Read Only    No
MinimumNumberOfSubsteps

When defining auto time stepping by substeps, define Minimum Substeps as available in MAPDL solver.

Type     int
Read Only    No
MinimumTimeStep

When defining auto time stepping by time steps, define Minimum Time Step as available in MAPDL solver.

Type     Quantity
Read Only    No
NumberOfSubsteps

When auto time stepping is off define number of substeps as available in MAPDL solver.

Type     int
Read Only    No
Substepping

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

Type     Substepping
Read Only    No
TimeIntegration

Turn on or off Time Integration for inertia effects as available in MAPDL solver.

Type     OnOffSwitch
Read Only    No
TimeStep

When auto time stepping is off define time steps as available in MAPDL solver.

Type     Quantity
Read Only    No

TrimOptimization

TrimOptimization is a class to represents various trimming options available for contact connection.

Properties

Tolerance

Tolerance to be used when trimming is on.

Type     Quantity
Read Only    No
Type

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

Type     TrimType
Read Only    No

ZeroThermalStrainTemperature

ZeroThermalStrainTemperature is a class that hold temperature at zero thermal strain.

Properties

Magnitude

Magnitude of ZeroThermalStrainTemperature

Type     Quantity
Read Only    No

PhysicsCoupling Data Entities

CouplingInterface

to be documented

Properties

MappingControl

Set controls for mapping.

Type     IDictionary<string, Object>
Read Only    No
Side

to be documented

Type     IDictionary<string, Object>
Read Only    No
Suppress

context to be documented

Type     String[]
Read Only    No
TransferToSideTwo

to be documented

Type     IDictionary<string, Object>
Read Only    No

CouplingInterface

to be documented

Properties

MappingControl

Set controls for mapping.

Type     IDictionary<string, Object>
Read Only    No
Side

to be documented

Type     IDictionary<string, Object>
Read Only    No
Suppress

context to be documented

Type     String[]
Read Only    No
TransferToSideTwo

to be documented

Type     IDictionary<string, Object>
Read Only    No

PhysicsCoupling

No details are provided for this entry.

Properties

DisplayText

No details are provided for this entry.

Type     string
Read Only    No
PhysicsRegion1

No details are provided for this entry.

Type     DataObject
Read Only    No
PhysicsRegion2

No details are provided for this entry.

Type     DataObject
Read Only    No
Side1Location

No details are provided for this entry.

Type     string
Read Only    No
Side2Locations

No details are provided for this entry.

Type     Object
Read Only    No
SourceFrequency

No details are provided for this entry.

Type     string
Read Only    No


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