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

GetAllTaskGroupsInProject

Returns all tasks in the project.

Return     The task groups in the project.
    Type     DataReferenceSet

GetBeamEndRelease

Obtains a BeamEndRelease instance by name from the supplied container.

Return     The BeamEndRelease instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    Type     string

GetBeamSection

Obtains a BeamSection instance by name from the supplied container.

Return     The BeamSection instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    Type     string

GetBearingLoad

Obtains a BearingLoad instance by name from the supplied container.

Return     The BearingLoad instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetBoundaryLayerRefinement

Obtains a BoundaryLayerRefinement instance by name from the supplied container.

Return     The BoundaryLayerRefinement instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetCharge

Obtains a Charge instance by name from the supplied container.

Return     The Charge instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetCyclicSymmetryConstraint

Obtains a CyclicSymmetryConstraint instance by name from the supplied container.

Return     The CyclicSymmetryConstraint instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetDistributedMass

Obtains a DistributedMass instance by name from the supplied container.

Return     The DistributedMass instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetFidelityRefinement

Obtains a FidelityRefinement instance by name from the supplied container.

Return     The FidelityRefinement instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetLine

Obtains a Line instance by name from the supplied container.

Return     The Line instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    Type     string

GetLinearizedStressChart

Obtains a LinearizedStressChart instance by name from the supplied container.

Return     The LinearizedStressChart instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    Type     string

GetLineChart

Obtains a LineChart instance by name from the supplied container.

Return     The LineChart instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetMemberSizeConstraint

Obtains a MemberSizeConstraint instance by name from the supplied container.

Return     The MemberSizeConstraint instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetOptimizationOptions

Obtains a OptimizationOptions instance by name from the supplied container.

Return     The OptimizationOptions instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetParticleInjectionCnd

Obtains a ParticleInjectionCnd instance by name from the supplied container.

Return     The ParticleInjectionCnd instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    Type     string

GetParticleTrack

Obtains a ParticleTrack instance by name from the supplied container.

Return     The ParticleTrack instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    Type     string

GetPerimeterWeld

Obtains a PerimeterWeld instance by name from the supplied container.

Return     The PerimeterWeld instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetPolyflowContact

Obtains a PolyflowContact instance by name from the supplied container.

Return     The PolyflowContact instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    Type     string

GetPolyflowContactBehavior

Obtains a PolyflowContactBehavior instance by name from the supplied container.

Return     The PolyflowContactBehavior instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetPolyflowFixedMold

Obtains a PolyflowFixedMold instance by name from the supplied container.

Return     The PolyflowFixedMold instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetPolyflowForceDrivenMold

Obtains a PolyflowForceDrivenMold instance by name from the supplied container.

Return     The PolyflowForceDrivenMold instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetPolyflowInitialLayerThickness

Obtains a PolyflowInitialLayerThickness instance by name from the supplied container.

Return     The PolyflowInitialLayerThickness instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetPolyflowMold

Obtains a PolyflowMold instance by name from the supplied container.

Return     The PolyflowMold instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetPolyflowPressure

Obtains a PolyflowPressure instance by name from the supplied container.

Return     The PolyflowPressure instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetPolyflowRestrictor

Obtains a PolyflowRestrictor instance by name from the supplied container.

Return     The PolyflowRestrictor instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetPolyflowSupport

Obtains a PolyflowSupport instance by name from the supplied container.

Return     The PolyflowSupport instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetPolyflowVelocityDrivenMold

Obtains a PolyflowVelocityDrivenMold instance by name from the supplied container.

Return     The PolyflowVelocityDrivenMold instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetPressureDrop

Obtains a PressureDrop instance by name from the supplied container.

Return     The PressureDrop instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    Type     string

GetPrimitiveBox

Obtains a PrimitiveBox instance by name from the supplied container.

Return     The PrimitiveBox instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    Type     string

GetPsdAcceleration

Obtains a PsdAcceleration instance by name from the supplied container.

Return     The PsdAcceleration instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    Type     string

GetPsdDisplacement

Obtains a PsdDisplacement instance by name from the supplied container.

Return     The PsdDisplacement instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    Type     string

GetPsdGAcceleration

Obtains a PsdGAcceleration instance by name from the supplied container.

Return     The PsdGAcceleration instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    Type     string

GetPsdLoad

Obtains a PsdLoad instance by name from the supplied container.

Return     The PsdLoad instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    Type     string

GetPsdVelocity

Obtains a PsdVelocity instance by name from the supplied container.

Return     The PsdVelocity instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    Type     string

GetPullOutDirection

Obtains a PullOutDirection instance by name from the supplied container.

Return     The PullOutDirection instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetResponsePsdResult

Obtains a ResponsePsdResult instance by name from the supplied container.

Return     The ResponsePsdResult instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetShearMomentDiagram

Obtains a ShearMomentDiagram instance by name from the supplied container.

Return     The ShearMomentDiagram instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetSpotWeld

Obtains a SpotWeld instance by name from the supplied container.

Return     The SpotWeld instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    Type     string

GetSpring

Obtains a Spring instance by name from the supplied container.

Return     The Spring instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    Type     string

GetSpringBehavior

Obtains a SpringBehavior instance by name from the supplied container.

Return     The SpringBehavior instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetStressConstraint

Obtains a StressConstraint instance by name from the supplied container.

Return     The StressConstraint instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    Type     string

GetStructuralMass

Obtains a StructuralMass instance by name from the supplied container.

Return     The StructuralMass instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetSymmetryConstraint

Obtains a SymmetryConstraint instance by name from the supplied container.

Return     The SymmetryConstraint instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    Type     string

GetThermalMass

Obtains a ThermalMass instance by name from the supplied container.

Return     The ThermalMass instance.
    Type     DataReference

Required Arguments

Name    The entity name for which to search. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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. Include the @ prefix if searching by display text
    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)

TryGetBeamEndRelease

Obtains a BeamEndRelease instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The BeamEndRelease instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetBeamSection

Obtains a BeamSection instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The BeamSection instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetBearingLoad

Obtains a BearingLoad instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The BearingLoad instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetBoundaryLayerRefinement

Obtains a BoundaryLayerRefinement instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The BoundaryLayerRefinement instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetCharge

Obtains a Charge instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The Charge instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetCyclicSymmetryConstraint

Obtains a CyclicSymmetryConstraint instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The CyclicSymmetryConstraint instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetDistributedMass

Obtains a DistributedMass instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The DistributedMass instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetFidelityRefinement

Obtains a FidelityRefinement instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The FidelityRefinement instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetLine

Obtains a Line instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The Line instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetLinearizedStressChart

Obtains a LinearizedStressChart instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The LinearizedStressChart instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetLineChart

Obtains a LineChart instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The LineChart instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetMemberSizeConstraint

Obtains a MemberSizeConstraint instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The MemberSizeConstraint instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetOptimizationOptions

Obtains a OptimizationOptions instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The OptimizationOptions instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetParticleInjectionCnd

Obtains a ParticleInjectionCnd instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The ParticleInjectionCnd instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetParticleTrack

Obtains a ParticleTrack instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The ParticleTrack instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetPerimeterWeld

Obtains a PerimeterWeld instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The PerimeterWeld instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetPolyflowContact

Obtains a PolyflowContact instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The PolyflowContact instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetPolyflowContactBehavior

Obtains a PolyflowContactBehavior instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The PolyflowContactBehavior instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetPolyflowFixedMold

Obtains a PolyflowFixedMold instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The PolyflowFixedMold instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetPolyflowForceDrivenMold

Obtains a PolyflowForceDrivenMold instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The PolyflowForceDrivenMold instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetPolyflowInitialLayerThickness

Obtains a PolyflowInitialLayerThickness instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The PolyflowInitialLayerThickness instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetPolyflowMold

Obtains a PolyflowMold instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The PolyflowMold instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetPolyflowPressure

Obtains a PolyflowPressure instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The PolyflowPressure instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetPolyflowRestrictor

Obtains a PolyflowRestrictor instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The PolyflowRestrictor instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetPolyflowSupport

Obtains a PolyflowSupport instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The PolyflowSupport instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetPolyflowVelocityDrivenMold

Obtains a PolyflowVelocityDrivenMold instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The PolyflowVelocityDrivenMold instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetPressureDrop

Obtains a PressureDrop instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The PressureDrop instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetPrimitiveBox

Obtains a PrimitiveBox instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The PrimitiveBox instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetPsdAcceleration

Obtains a PsdAcceleration instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The PsdAcceleration instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetPsdDisplacement

Obtains a PsdDisplacement instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The PsdDisplacement instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetPsdGAcceleration

Obtains a PsdGAcceleration instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The PsdGAcceleration instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetPsdLoad

Obtains a PsdLoad instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The PsdLoad instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetPsdVelocity

Obtains a PsdVelocity instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The PsdVelocity instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetPullOutDirection

Obtains a PullOutDirection instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The PullOutDirection instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetResponsePsdResult

Obtains a ResponsePsdResult instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The ResponsePsdResult instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetShearMomentDiagram

Obtains a ShearMomentDiagram instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The ShearMomentDiagram instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetSpotWeld

Obtains a SpotWeld instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The SpotWeld instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetSpring

Obtains a Spring instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The Spring instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetSpringBehavior

Obtains a SpringBehavior instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The SpringBehavior instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetStressConstraint

Obtains a StressConstraint instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The StressConstraint instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetStructuralMass

Obtains a StructuralMass instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The StructuralMass instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetSymmetryConstraint

Obtains a SymmetryConstraint instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The SymmetryConstraint instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

TryGetThermalMass

Obtains a ThermalMass instance by name from the supplied container, falling back to an alternate name if the first is not found.

Return     The ThermalMass instance.
    Type     DataReference

Required Arguments

AlternateName    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    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. Include the @ prefix if searching by display text.
    Type     string
Name    The entity name for which to search. Include the @ prefix if searching by display text.
    Type     string

Common Data Entities

AlternatingStress

The Alternating Stress material model.

Properties

Interpolation

The Interpolation for the AlternatingStress charting can be chosen between: Linear, Semi-Log and Log-Log.

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

ArbitrarySection

This class represents arbitrary beam cross section with following properties

Properties

Area

Area of the section

Type     Quantity
Read Only    No
AreaMomentOfInertiaAboutYAxis

Moment of inertia about the y axis

Type     Quantity
Read Only    No
AreaMomentOfInertiaAboutZAxis

Moment of inertia about the z axis

Type     Quantity
Read Only    No
CentroidAbscissa

y coordinate of the centroid

Type     Quantity
Read Only    No
CentroidOrdinate

z coordinate of the centroid

Type     Quantity
Read Only    No
ProductOfInertiaAboutYZAxes

Product of inertia

Type     Quantity
Read Only    No
ShearCenterAbscissa

y coordinate of the shear center

Type     Quantity
Read Only    No
ShearCenterOrdinate

z coordinate of the shear center

Type     Quantity
Read Only    No
Torsion

Torsion constant

Type     Quantity
Read Only    No
Warping

Warping constant

Type     Quantity
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

BeamSection

BeamSection is a class that holds beam section type, offset type and cross section properties.

Properties

Location

Defined locations for the object.

Type     LocationSet
Read Only    No
OffsetType

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

Type     BeamSectionOffsetType
Read Only    No
SectionType

Shape of the beam section

Type     BeamSectionType
Read Only    No
XOffset

X offset of the beam cross section

Type     Expression<Quantity>
Read Only    No
YOffset

Y offset of the beam cross section

Type     Expression<Quantity>
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

BilinearIsotropicHardeningDependents

The Bilinear Isotropic Hardening dependents.

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
TangentModulus

Gets or sets the tangent modulus.

Type     Expression<Quantity>
Read Only    No
YieldStrength

Gets or sets the yield strength.

Type     Expression<Quantity>
Read Only    No

BilinearKinematicHardeningDependents

The Bilinear Kinematic Hardening dependents.

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
TangentModulus

Gets or sets the tangent modulus.

Type     Expression<Quantity>
Read Only    No
YieldStrength

Gets or sets the yield strength.

Type     Expression<Quantity>
Read Only    No

BoundaryLayerRefinement

No details are provided for this entry.

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:

SmoothTransitionCreates constant boundary layers using values of First Layer Height, Maximum Layers and Growth Rate.
Mesher ensures smooth rate of volume change using local tetrahedral element size.FirstAspectRatio
TotalThicknessCreates boundary layers using values of First Aspect Ratio, Maximum Layers and Growth Rate.
Creates constant boundary layers using the values of Number of Layers and Growth Rate.LastAspectRatio
FirstLayerThicknessCreates 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

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

For non-scalar Calculated Value Monitors, defines the component

Type     string
Read Only    No
Expression

For Calculated Value Monitors, defines the expression

Type     string
Read Only    No
Function

For Calcualted Value Monitors, defines the function

Type     string
Read Only    No
Location

For scoped Calculated Value Monitors, defines the location

Type     LocationSet
Read Only    No
Method

The method by which the value is calculated.

Type     TrackerMethod
Read Only    No
MonitorTypeName

Gives a type of Calculated Value Monitor

Type     string
Read Only    No
SubCategory

Gives the name of a set of fields

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

ChannelSection

This class represents channel beam cross section

Properties

LowerFlangeThickness

Lower Flange Thickness

Type     Quantity
Read Only    No
LowerFlangeWidth

Lower Flange Width

Type     Quantity
Read Only    No
OverallHeight

Overall Height

Type     Quantity
Read Only    No
StemThickness

Stem Thickness

Type     Quantity
Read Only    No
UpperFlangeThickness

Upper Flange Thickness

Type     Quantity
Read Only    No
UpperFlangeWidth

Upper Flange Width

Type     Quantity
Read Only    No

CircularSolidSection

This class represents circular solid beam cross section

Properties

Radius

Radius

Type     Quantity
Read Only    No

CircularTubeSection

This class represents circular tube beam cross section

Properties

InnerRadius

Inner radius of the tube

Type     Quantity
Read Only    No
OuterRadius

Outer radius of the tube

Type     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 controlMove/rotate control
Allows the suppression selected part components.Allows the transformation selected part components.

Properties

No Properties.

Methods

InsertPrimitiveBox

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

The last automatically-generated DisplayText assigned to this Result Object

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

Name of the Result.

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

FidelityRefinement

No details are provided for this entry.

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
Detail

No details are provided for this entry.

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
NumberOfCells

Specifies value to override global Number of cells across gap on local entities

Type     int
Read Only    No
ProximityMinimumSize

Specifies value to override global Proximity Min size on local entities

Type     Quantity
Read Only    No
ProximitySizeFunctionSource

Specifies value to override global Number of cells across gap on local entities

Type     ProximitySizeFunctionSources
Read Only    No
SizeFunctionMethod

Specifies which size function to use.

Available options:

Program controlled
Adaptive
Curvature and proximity
Curvature
Proximity
Fixed

Type    UseAdvancedLocalSizeFunction
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
LineModelTypes

No details are provided for this entry.

Type     LineModelType
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
SharedEdgesAmongBeams

No details are provided for this entry.

Type     bool
Read Only    No
SourceSelectionMode

Controls how the source selection if defined.

Selection Types:

BrowseSourceActiveCADAttach
Source is specified using the file browser dialog.Source 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

CleanGeometryOnImport

No details are provided for this entry.

Type     bool
Read Only    No
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:

NoneSheet
Nothing is imported.Only sheet surfaces are imported.
SolidSolidSheet
Only solids are imported.Only 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
StitchSurfacesOnImport

No details are provided for this entry.

Type     ImportStitchType
Read Only    No
StitchTolerance

No details are provided for this entry.

Type     double
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:

ShapeCheckingSpecifies the tolerance value for sheet loop removal.
Determines the shape checking algorithm to be used by the mesher.MeshBasedDefeaturing
TriangleSurfaceMesherSpecifies automatic defeaturing of dirty geometries.
Determines surface meshing algorithm to be used by patch conforming mesher.DefeaturingTolerance
ElementMidsideNodesSpecifies the defeaturing tolerance value.
Determines whether elements are with or without midside nodes.UseAllProcessors
StraightSidedElementsSpecifies if all available processors are used for parallel part-based meshing.
Specifies meshing to straight edge elements.ProcessorLimit
LoopRemovalToleranceSpecifies 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:

UseEngineeringIntentElements without midside nodes.
Determine whether midside nodes are kept or dropped based on the Engineering Intent.Kept
DroppedElements 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 user defined defeaturing tolerance value on dirty geometry.
Automatically removes features smaller than or equal to the calculated default tolerance value on dirty geometry.Off
UserDefinedNo defeaturing done on dirty geometry.

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:

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

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

NoYes
Manually specify the limit to the number of processors that can be utilized for parallel part-based meshing.Automatically 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 height of boundary layer for given initial height and height ratio.
Determines strategy to avoid collision between inflated surface meshes.MaxAngle
FixFirstLayerSpecifies the maximum prism layer growth angle.
Determines whether the heights or ratios of the first boundary layer will be modified to avoid collision.FilletRatio
GapFactorSpecifies whether fillets proportional to the prism height will be created in corner zones of tetrahedral mesh.
Specifies gap between intersecting prisms.UsePostSmoothing
MaxHeightOverBaseSpecifies whether post boundary layer smoothing will be performed.
Specifies maximum allowable prism aspect ratio.SmoothIterations
GrowthRateTypeSpecifies the number of post boundary layer smoothing iterations.

Properties

CollisionAvoidance

Determines strategy to avoid collision between inflated surface meshes.

Available options:

NoneBoundary layers are compressed in collision areas.
No check for layer collisions.StairStepping
LayerCompressionPrism layers are stair stepped to avoid collision and maintain the gap defined by gap factor.

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 linearly.
Height of boundary layer determined geometrically.Exponential
LinearHeight 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:

InheritanceWrapProximitySizeFunctionSources
Specifies whether the sizing function for sew is inherited from the predecessor wrap task or not.Specifies the source type to be used for size function calculation when Advanced Size Function is Proximity or Curvature and proximity.
UseAdvancedSizeFunctionGrowthRate
Specifies options for advanced size function.Specifies the increase in edge length with each succeeding layer of elements.
MinSizeCurvatureNormalAngle
Specifies the minimum size returned to the mesher.Specifies maximum allowable angle that one element is allowed to span when Advanced Size Function is Proximity and Curvature or Curvature.
ProximityMinSizeNumberOfCellsAcrossGap
Specifies global minimum size when Advanced Size Function is Proximity and Curvature or Proximity.Specifies minimum number of elements to be generated in gaps when Advanced Size Function is Proximity and Curvature or Proximity.
MaxFaceSizeSmoothing
Specifies maximum size returned to the surface mesher.Specifies the number of smoothing iterations.
MaxSizeAdaptiveResolution
Specifies the maximum size returned to the mesher.The 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

GlobalPAMAdvanceAttributes

No details are provided for this entry.

Properties

MidSideNodes

Mid side nodes info to determine the element order either linear or quadratic.

Type     APAMMidsideNodeOrder
Read Only    No

GlobalPAMSizingAttributes

No details are provided for this entry.

Properties

AdvancedSizeFunction

No details are provided for this entry.

Type     APAMAdvancedSizeFunction
Read Only    No
CurvatureNormalAngle

No details are provided for this entry.

Type     Quantity
Read Only    Yes
DisableAutomaticControls

Disables automatic (proxy) controls allowing only mesh controls and

to control the mesh

Type    bool
Read Only    No
GrowthRate

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

Type     double
Read Only    Yes
MaxFaceSize

No details are provided for this entry.

Type     Quantity
Read Only    Yes
MaxSize

No details are provided for this entry.

Type     Quantity
Read Only    Yes
MinSize

No details are provided for this entry.

Type     Quantity
Read Only    Yes
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    Yes
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    APAMProximitySizeFunctionSources
Read Only    Yes
UsePredefinedSettings

Automatically calculates the global sizing values based on the resolution value and the choice of size function.

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:

TessellationRefinementZoning
Specifies value to be used for tessellation refinement.Specifies options for zoning.
RefinementToleranceTargetMetric
Specifies the user-defined tolerance for tessellation refinement.Specifies the measure for mesh quality.
EdgeExtractionAngleMetricValue
Determines which CAD features are captured.Specifies the value at which wrapper surface will be improved.
CreateIntersectingEdgesForOverlappingBodiesAggressive
Create intersecting edges for overlapping bodies.Specifies 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 user defined value.
Sets tessellation refinement to 10% of the value of Min Size/Proximity Min Size.Off
UserDefinedTessellation 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

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

Properties

RelativeToName

Relative to

Type     string
Read Only    Yes
XComponent

Component in the x-axis direction

Type     Quantity
Read Only    No
YComponent

Component in the y-axis direction

Type     Quantity
Read Only    No
ZComponent

Component in the z-axis direction

Type     Quantity
Read Only    No

HatSection

This class represents HAT beam cross section

Properties

LeftBrimThickness

Left Brim Thickness

Type     Quantity
Read Only    No
LeftBrimWidth

Left Brim Width

Type     Quantity
Read Only    No
LeftStemThickness

Left Stem Thickness

Type     Quantity
Read Only    No
OverallHeight

Overall Height

Type     Quantity
Read Only    No
RightBrimThickness

Right Brim Thickness

Type     Quantity
Read Only    No
RightBrimWidth

Right Brim Width

Type     Quantity
Read Only    No
RightStemThickness

Right Stem Thickness

Type     Quantity
Read Only    No
TopHatThickness

Top Hat Thickness

Type     Quantity
Read Only    No
TopHatWidth

Top Hat Width

Type     Quantity
Read Only    No

HollowRectangularSection

This class represents hollow rectangular beam cross section

Properties

LowerThickness

Lower Thickness

Type     Quantity
Read Only    No
OuterHeightOfTheBox

Outer Height of the Box

Type     Quantity
Read Only    No
OuterWidthOfTheBox

Outer Width of the Box

Type     Quantity
Read Only    No
UpperThickness

Upper Thickness

Type     Quantity
Read Only    No
VerticalLeftThickness

Vertical Left Thickness

Type     Quantity
Read Only    No
VerticalRightThickness

Vertical Right Thickness

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>

ISection

This class represents I beam cross section

Properties

LowerFlangeThickness

Lower Flange Thickness

Type     Quantity
Read Only    No
LowerFlangeWidth

Lower Flange Width

Type     Quantity
Read Only    No
OverallHeight

Overall height

Type     Quantity
Read Only    No
StemThickness

Stem Thickness

Type     Quantity
Read Only    No
UpperFlangeThickness

Upper Flange Thickness

Type     Quantity
Read Only    No
UpperFlangeWidth

Upper Flange Width

Type     Quantity
Read Only    No

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

The last automatically-generated DisplayText assigned to this Result Object

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

Result name

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:

YoungsModulusPoissonsRatioYoungsModulusShearModulus
Young's Modulus and Poisson's RatioYoung's Modulus and Shear Modulus
ShearModulusPoissonsRatioYoungsModulusBulkModulus
Shear Modulus and Poisson's RatioYoung's Modulus and Bulk Modulus
BulkModulusPoissonsRatioBulkModulusShearModulus
Bulk Modulus and Poisson's RatioBulk 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

Line

Line represented by 2 end points

Properties

Point1

Line start point

Type     Point
Read Only    No
Point2

Line end point

Type     Point
Read Only    No

LineChart

Displays the quantity of a variable on a line

Properties

EvaluateFullRange

Whether or not to evaluate all time points in the evaluation

Type     bool
Read Only    No
Location

The Location over which the Result is to be evaluated.

Type     LocationSet
Read Only    No
NormalizeData

Normalize data so they are displayed as percentages

Type     bool
Read Only    No
ReverseDirection

Reverse the direction of the data when it's sent to the graph

Type     bool
Read Only    No
SimulationStep

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

Type     SolutionStep
Read Only    No
Variable

Data Model support for variable selector.

Type     Expression<Quantity>
Read Only    No
Variables

List of variables to be plotted

Type     List<Expression<Quantity>>
Read Only    No

LSection

This class represents L beam cross section

Properties

HorizontalLegLength

Horizontal Leg Length

Type     Quantity
Read Only    No
HorizontalLegThickness

Horizontal Leg Thickness

Type     Quantity
Read Only    No
VerticalLegLength

Vertical Leg Length

Type     Quantity
Read Only    No
VerticalLegThickness

Vertical Leg Thickness

Type     Quantity
Read Only    No

MagneticCoercivity

Magnetic Coercivity material model.

Properties

MagnetizationDirectionType

Magnetization direction type with dropdown.

Type     DirectionType
Read Only    No
Magnitude

Magnetic coercivity magnitude

Type     Expression<Quantity>
Read Only    No
Primary

First component

Type     Expression<Quantity>
Read Only    No
Secondary

Second component

Type     Expression<Quantity>
Read Only    No
Tertiary

Third component

Type     Expression<Quantity>
Read Only    No

Material

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

Properties

DefaultStateOfMatter

A material can have data for the states; solid, liquid and gas. The default specifies that when this material is assigned to the model it will by default use this state.

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

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

When applicable, for example orthotropic data is present, the reference frame is used to determine the material's x, y, and z coordinates.

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

MaterialOrientation

No details are provided for this entry.

Properties

DefineBy

No details are provided for this entry.

Type     OrientationDefineBy
Read Only    No
EdgeGuide

No details are provided for this entry.

Type     LocationSet
Read Only    No
MaximumNumberOfDisplayPoints

No details are provided for this entry.

Type     int
Read Only    No
RelativeTo

No details are provided for this entry.

Type     ReferenceFrame
Read Only    No
SurfaceGuide

No details are provided for this entry.

Type     LocationSet
Read Only    No

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
NumberOfCells

Specifies value to override global Number of cells across gap on local entities

Type     int
Read Only    No
ProximityMinimumSize

Specifies value to override global Proximity Min size on local entities

Type     Quantity
Read Only    No
ProximitySizeFunctionSource

Specifies value to override global Number of cells across gap on local entities

Type     ProximitySizeFunctionSources
Read Only    No
SizeFunctionMethod

Specifies which size function to use.

Available options:

Program controlled
Adaptive
Curvature and proximity
Curvature
Proximity
Fixed

Type    UseAdvancedLocalSizeFunction
Read Only    No

MeshControlEdgeSizing

Specifies attributes for edge sizing.

Available options:

EdgeSizingMethodSpecifies bias option which is always smooth transition.
Specifies the edge sizing method.BiasType
EdgeDivisionsSpecifies option for bias type.
Specifies the number of divisions on each edge.BiasGrowthRate
BiasMethodSpecifies 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
NumberOfCells

Specifies value to override global Number of cells across gap on local entities

Type    int
Read Only    No
ProximityMinimumSize

Specifies value to override global Proximity Min size on local entities

Type    Quantity
Read Only    No
ProximitySizeFunctionSource

Specifies value to override global Number of cells across gap on local entities

Type    ProximitySizeFunctionSources
Read Only    No
SizeFunctionMethod

Specifies which size function to use.

Available options:

Program controlled
Adaptive
Curvature and proximity
Curvature
Proximity
Fixed

Type    UseAdvancedLocalSizeFunction
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

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
NumberOfCells

Specifies value to override global Number of cells across gap on local entities

Type     int
Read Only    No
ProximityMinimumSize

Specifies value to override global Proximity Min size on local entities

Type     Quantity
Read Only    No
ProximitySizeFunctionSource

Specifies value to override global Number of cells across gap on local entities

Type     ProximitySizeFunctionSources
Read Only    No
SizeFunctionMethod

Specifies which size function to use.

Available options:

Program controlled
Adaptive
Curvature and proximity
Curvature
Proximity
Fixed

Type    UseAdvancedLocalSizeFunction
Read Only    No

MeshControlLocalBoundaryLayer

Specifies local boundary layer attributes.

Available options:

BoundaryLayerOptionMaximumLayers
Specifies the way heights of the boundary layers are determined.Specifies the maximum number of boundary layers to be created.
FirstLayerHeightGrowthRate
Specifies the height of the first boundary layer.Specifies the value for Growth Rate.
FirstAspectRatioAspectRatio
Specifies the aspect ratio of the boundaries that are extruded from the boundary base.Specifies relative thickness of adjacent boundary layers.
TransitionRatioMaximumThickness
Specifies the rate at which adjacent elements grow.Specifies the desired maximum thickness of the boundary layer.
NumberOfLayersBoundaryLayerAlgorithm
Specifies the number of boundary layers.Specifies 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:

SmoothTransitionCreates constant boundary layers using values of First Layer Height, Maximum Layers and Growth Rate.
Mesher ensures smooth rate of volume change using local tetrahedral element size.FirstAspectRatio
TotalThicknessCreates boundary layers using values of First Aspect Ratio, Maximum Layers and Growth Rate.
Creates constant boundary layers using the values of Number of Layers and Growth Rate.LastAspectRatio
FirstLayerThicknessCreates 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

MeshCrossSection

No details are provided for this entry.

Properties

Area

Area of the section

Type     Quantity
Read Only    No
AreaMomentOfInertiaAboutYAxis

Moment of inertia about the y axis

Type     Quantity
Read Only    No
AreaMomentOfInertiaAboutZAxis

Moment of inertia about the z axis

Type     Quantity
Read Only    No
CentroidAbscissa

y coordinate of the centroid

Type     Quantity
Read Only    No
CentroidOrdinate

z coordinate of the centroid

Type     Quantity
Read Only    No
ProductOfInertiaAboutYZAxes

Product of inertia

Type     Quantity
Read Only    No
SectionIntegrationOptions

No details are provided for this entry.

Type     IntegrationOptions
Read Only    No
ShearCenterAbscissa

y coordinate of the shear center

Type     Quantity
Read Only    No
ShearCenterOrdinate

z coordinate of the shear center

Type     Quantity
Read Only    No
Torsion

Torsion constant

Type     Quantity
Read Only    No
Warping

Warping constant

Type     Quantity
Read Only    No

MeshDiagnostics

MeshDiagnostics specifies the settings used to evaluate mesh quality.

Available options:

GeometryLocationMinMetric
Specifies the selected topology set or the entire model for which mesh diagnostics are evaluated during part-based Meshing.Specifies the minimum value for chosen metric type.
MeshMetricMaxMetric
Specifies the metric type based on which mesh quality is evaluated.Specifies the maximum value for chosen metric type.
NumNodesAverageMetric
Specifies number of nodes in the mesh.Specifies the average value for chosen metric type.
NumElementsStandardDeviation
Specifies number of elements in the mesh.Specifies 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:

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

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:

StateTranslucency value with which the mesh element faces should be drawn by graphics.
Meshing state for entity. [ 0 = Unmeshed, 1 = Meshed, 2 = OutOfDate, 3 = Failed, 4 = Suppressed, 5 = Connected, 6 = NeedsConnected ]ShowMesh
MeshColorFlag to tell graphics whether to overlay the mesh on the entity or not.
Color with which the mesh element edges should be drawn by graphics.ReferenceIds
TranslucencyA 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:

StateTranslucency value with which the mesh element faces should be drawn by graphics.
Meshing state for entity. [ 0 = Unmeshed, 1 = Meshed, 2 = OutOfDate, 3 = Failed, 4 = Suppressed, 5 = Connected, 6 = NeedsConnected ]ShowMesh
MeshColorFlag to tell graphics whether to overlay the mesh on the entity or not.
Color with which the mesh element edges should be drawn by graphics.ReferenceNames
TranslucencyA 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:

StructuralOrThermalFluidFlow
Intent of this process is a structural and/or thermal simulation.Intent 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
ThinStructures

Specifies to use defaults for models with shells

Type    bool
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 transfer

Type     bool
Read Only    No

MeshSectionCell

No details are provided for this entry.

Properties

No Properties.

MeshSectionNode

No details are provided for this entry.

Properties

No Properties.

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
LineModelTypes

No details are provided for this entry.

Type     LineModelType
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
SharedEdgesAmongBeams

No details are provided for this entry.

Type     bool
Read Only    No
SourceSelectionMode

Controls how the source selection if defined.

Selection Types:

BrowseSourceActiveCADAttach
Source is specified using the file browser dialog.Source is specified by an active CAD attach source.

Type    SourceSelectionType
Read Only    No
SourceType

Import source type.

Type     string
Read Only    Yes

ModelsElasticity

Elasticity of the active model.

Properties

ModelType

Elasticity options displayed in UI

Type     ElasticityType
Read Only    No

ModelsPlasticity

Plasticity of the active model.

Properties

As

Plasticity options displayed in UI

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

Class that edits multiple tables.

Properties

ReferenceValue

A dictionary of reference values.

Type     Dictionary<string, Object>
Read Only    No
Table

A Table Expression.

Type     Expression<Quantity>
Read Only    No

NeoHookeanHyperElasticity

The Neo-Hookean Hyperelasticity model.

Can be applied to Structural analyses

Properties

Magnitude

The Magnitude.

Type    Expression<NeoHookeanHyperElasticityDependents>
Read Only    No

OriginAndOrientationDefinitionMethod

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

Properties

No Properties.

OrthotropicElasticity

The Orthotropic Elasticity model.

Can be applied to Structural analyses

Properties

Magnitude

The Magnitude.

Type    Expression<OrthotropicElasticityDependents>
Read Only    No

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

The source frequency for the Physics Coupling Interface.

Type     string
Read Only    No

PhysicsDefinition

Represents a physics solution.

Properties

CalculationType

The calculation type for the solution.

Type     CalculationType
Read Only    No
PhysicsFidelity

Defines the resolution for automatically calculated solver inputs. Selecting a higher fidelity gives better accuracy.

Type     int
Read Only    No
PreStressedModal

Switch to include pre-stressed effect in a modal analysis.

Type     bool
Read Only    No
RandomVibration

Switch to include random vibration in an analysis.

Type     bool
Read Only    No

Methods

EvaluateVolumeResult

Generates voxel result data for the given variable(s).

Optional Arguments

VolumeDataInputs    The variables to be evaluated.
    Type     List<VolumeDataInput>
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

Optional Arguments

SelectedLocationSet    A list of Locations to filter the boundary conditions on.
    Type     LocationSet
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

Optional Arguments

ExcludeSurfaceBodies    Should exclude surface bodies
    Type     bool
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
WriteSolverInputFile

No details are provided for this entry.

Return     Flag whether query is successful.
    Type     string

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

Optional Arguments

SelectedLocationSet    A list of Locations to filter the boundary conditions on.
    Type     LocationSet
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

PrimitiveBox

This class represents a primitive box component

Properties

CreateSelectionSets

Flag to enable/disable selection set creation

Type     bool
Read Only    No

PrimitiveBoxConstraint

This class extends the PrimitiveBox 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

QuadrilateralSection

This class represents quadrilateral beam cross section. It consists of four coordinates for the corners(i,j,k,l), each having an abscissa and ordinate.

Properties

Abscissa1

Abscissa 1

Type     Quantity
Read Only    No
Abscissa2

Abscissa 2

Type     Quantity
Read Only    No
Abscissa3

Abscissa 3

Type     Quantity
Read Only    No
Abscissa4

Abscissa 4

Type     Quantity
Read Only    No
Ordinate1

Ordinate 1

Type     Quantity
Read Only    No
Ordinate2

Ordinate 2

Type     Quantity
Read Only    No
Ordinate3

Ordinate 3

Type     Quantity
Read Only    No
Ordinate4

Ordinate 4

Type     Quantity
Read Only    No

RectangularSection

This class represents retangular beam cross section

Properties

Height

Overall height

Type     Quantity
Read Only    No
Width

Overall width

Type     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

The last automatically-generated DisplayText assigned to this Result Object

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

Name of the Result.

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

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

DensityThreshold

The density threshold for the shape.

Type     double
Read Only    No
ResultName

The name of the result.

Type     string
Read Only    No
ShapeAdjustment

The level of shape adjustment set on a range.

Type     Expression<Quantity>
Read Only    No
SmoothShape

A flag to turn on/off optimized topological smoothing of a shape.

Type     bool
Read Only    No

Methods

ExportNewModel

Exports a Model updated with changes made by STL scripts.

ShapeTaskStatistics

Class to optimize Shape statistics.

Properties

MassReduction

The mass removed from the shape after reduction.

Type     Quantity
Read Only    Yes
OriginalMass

The shape's original mass.

Type     Quantity
Read Only    Yes
OriginalVolume

The shape's original volume.

Type     Quantity
Read Only    Yes
ReducedMass

The shape's mass after reduction.

Type     Quantity
Read Only    Yes
ReducedVolume

The shape's volume after reduction.

Type     Quantity
Read Only    Yes
VolumeReduction

The volume removed from the shape after reduction.

Type     Quantity
Read Only    Yes

ShellThickness

ShellThickness is a class that holds thickness and offset information of surface bodies.

Properties

IsImportedThickness

Flag if the thickness and offset information are imported data from a modeler as opposed to user input data.

Type     bool
Read Only    No
Location

Defined locations for the object.

Type     LocationSet
Read Only    No
Offset

Input user offset value when the Thickness distribution is set to User defined offset.

Type     Quantity
Read Only    No
ReverseOffsetDirection

Switch to reverse the offset direction.

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. Depends on the Reference Manager ,Configuration Manager and ETRM

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

The last automatically-generated DisplayText assigned to this Result Object

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

Name of the Result.

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

MaxNumberDesignIterations

Sets the maximum number of design iteration in optimization process

Type     int
Read Only    No

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

Solution Step

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

The last automatically-generated DisplayText assigned to this Result Object

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

Result name

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

Table object that displays result data.

Properties

Data

Data to populate results table.

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

The last automatically-generated DisplayText assigned to this Result Object.

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

TSection

This class represents T beam cross section

Properties

FlangeThickness

Flange Thickness

Type     Quantity
Read Only    No
FlangeWidth

Flange Width

Type     Quantity
Read Only    No
OverallHeight

Overall height

Type     Quantity
Read Only    No
StemThickness

Stem Thickness

Type     Quantity
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

The last automatically-generated DisplayText assigned to this Result Object

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

Name of the Result.

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

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 number of extra refinement levels.
Specifies the surounding bodies around the volume to be extracted.ImprintIterations
PointSpecifies number of imprinting iterations for feature capturing.
Specifies a reference point where the volume is located to extact.AggressiveImprintIterations
ExtraRefineLevelSpecifies 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:

WrapPassThroughToSew
Simplifies unclean geometry before sewing.Bypasses simplification of unclean geometry before sewing.

Type    RegionBehavior
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 number of extra refinement levels.
Specifies the bodies and parts to be wrapped.ImprintIterations
GroupingOptionSpecifies number of imprinting iterations for feature capturing.
Specifies grouping option for the bodies being wrapped.AggressiveImprintIterations
ExtraRefineLevelSpecifies 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:

WrapPassThroughToSew
Simplifies unclean geometry before sewing.Bypasses simplification of unclean geometry before sewing.

Type    RegionBehavior
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

ZSection

This class represents Z beam cross section

Properties

LowerFlangeThickness

Lower Flange Thickness

Type     Quantity
Read Only    No
LowerFlangeWidth

Lower Flange Width

Type     Quantity
Read Only    No
OverallHeight

Overall Height

Type     Quantity
Read Only    No
StemThickness

Stem Thickness

Type     Quantity
Read Only    No
UpperFlangeThickness

Upper Flange Thickness

Type     Quantity
Read Only    No
UpperFlangeWidth

Upper Flange Width

Type     Quantity
Read Only    No

Fluids Data Entities

ContourResultOptions

No details are provided for this entry.

Properties

UseNodeValues

No details are provided for this entry.

Type     bool
Read Only    No

Duration

No details are provided for this entry.

Properties

EndTime

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
NumberOfTimeSteps

No details are provided for this entry.

Type     int
Read Only    No
Option

No details are provided for this entry.

Type     string
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

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

MaterialDistribution

No details are provided for this entry.

Properties

Distribution

No details are provided for this entry.

Type     string
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

MomentumSrc

No details are provided for this entry.

Properties

Location

No details are provided for this entry.

Type     LocationSet
Read Only    No

ParticleInjectionCnd

No details are provided for this entry.

Properties

Location

No details are provided for this entry.

Type     LocationSet
Read Only    No

ParticleTrack

No details are provided for this entry.

Properties

EndTime

No details are provided for this entry.

Type     Quantity
Read Only    No
EndTimeFactor

No details are provided for this entry.

Type     float
Read Only    No
EvaluateFullRange

Whether or not to evaluate all time points in the evaluation

Type     bool
Read Only    No
FadeLineSegments

No details are provided for this entry.

Type     bool
Read Only    No
LastAutomaticDisplayText

The last automatically-generated DisplayText assigned to this Result Object

Type     string
Read Only    No
Location

The Location over which the Result is to be evaluated.

Type     LocationSet
Read Only    No
ParticlesMaterialAssignmentName

No details are provided for this entry.

Type     string
Read Only    No
ParticleTrackColorOption

No details are provided for this entry.

Type     ParticleTrackColorOption
Read Only    No
ParticleTrackDisplayStyle

No details are provided for this entry.

Type     ParticleTrackDisplayStyle
Read Only    No
ParticleTrackShape

No details are provided for this entry.

Type     ParticleTrackShapeDef
Read Only    No
ParticleTrackStyle

No details are provided for this entry.

Type     ParticleTrackStyle
Read Only    No
ResultName

Result name

Type     string
Read Only    No
SegmentRatio

No details are provided for this entry.

Type     float
Read Only    No
SymbolScaleFactor

No details are provided for this entry.

Type     double
Read Only    No
SymbolSegmentDensity

No details are provided for this entry.

Type     int
Read Only    No
SymbolShape

No details are provided for this entry.

Type     SymbolShape
Read Only    No
TubeDiameter

No details are provided for this entry.

Type     double
Read Only    No
WireThickness

No details are provided for this entry.

Type     double
Read Only    No

PersistablePosition

No details are provided for this entry.

Properties

coordX

No details are provided for this entry.

Type     double
Read Only    No
coordY

No details are provided for this entry.

Type     double
Read Only    No
coordZ

No details are provided for this entry.

Type     double
Read Only    No
unit

No details are provided for this entry.

Type     string
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

PersistableSupplierItem

No details are provided for this entry.

Properties

No Properties.

PersistableVariableMinMaxPositions

No details are provided for this entry.

Properties

maxPositions

No details are provided for this entry.

Type     List<PersistablePosition>
Read Only    No
minPositions

No details are provided for this entry.

Type     List<PersistablePosition>
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

PressureDrop

No details are provided for this entry.

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

The last automatically-generated DisplayText assigned to this Result Object

Type     string
Read Only    No
Location

The Location over which the Result is to be evaluated.

Type     LocationSet
Read Only    No
Location2

No details are provided for this entry.

Type     LocationSet
Read Only    No
RelativeTo

The Reference Frame which the result is relative to

Type     ReferenceFrame
Read Only    No
ResultName

Name of the Result.

Type     string
Read Only    No
SimulationStep

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

Type     SolutionStep
Read Only    No
Value

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
Variable

The solution variable to be displayed

Type     Expression<Quantity>
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

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

Customization Data Entities

UserCommands

UserCommands is a way to send user commands directly to the solver.

Properties

No Properties.

Structural Data Entities

BeamEndRelease

This is a class that is meant to define a beam end release.

Properties

EdgesLocation

Location for the edges selection.

Type     LocationSet
Read Only    No
IndependentEdges

Switch to set the edges to be independent or not.

Type     bool
Read Only    No
ReferenceFrame

Select a reference frame for the end release.

Type     ReferenceFrame
Read Only    No
RotationX

Switch to set Rotation X as a free or fixed DOF.

Type     DOFBehavior
Read Only    No
RotationY

Switch to set Rotation Y as a free or fixed DOF.

Type     DOFBehavior
Read Only    No
RotationZ

Switch to set Rotation Z as a free or fixed DOF.

Type     DOFBehavior
Read Only    No
TranslationX

Switch to set Tranlation X as a free or fixed DOF.

Type     DOFBehavior
Read Only    No
TranslationY

Switch to set Tranlation Y as a free or fixed DOF

Type     DOFBehavior
Read Only    No
TranslationZ

Switch to set Tranlation Z as a free or fixed DOF.

Type     DOFBehavior
Read Only    No
VertexLocation

Location for the vertex selection.

Type     LocationSet
Read Only    No

BearingLoad

No details are provided for this entry.

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No

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
BoltDiameter

No details are provided for this entry.

Type     Quantity
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
TorqueCoefficient

No details are provided for this entry.

Type     double
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

Charge

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

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

AllowSelfContact

No details are provided for this entry.

Type     bool
Read Only    No
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 detection 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 initial 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

ContactRadius

This is a class resposible for radii settings for an edge-edge contact.

Properties

DefineBy

Switch to choose between program controlled radii values or use manually entered values.

Type     RadiusDefineBy
Read Only    No
SourceRadius

Radius of source beam

Type     Quantity
Read Only    No
TargetRadius

Radius of target beam

Type     Quantity
Read Only    No

ContactStiffness

This class represents the various behavior of contact stiffness

Properties

UpdateStiffnessControl

Option to set the frequency of updating the 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
Specification

No details are provided for this entry.

Type     CurrentSpecificationMethod
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

Extension object for prescribing displacement by translation only or rotation only.

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

DistributedMass

No details are provided for this entry.

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No
Mass

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
MassType

No details are provided for this entry.

Type     DistributedMassType
Read Only    No

EdgeEdgeContactSettings

This is a class resposible for edge-edge contact settings.

Properties

Treatment

Option to select if only parallel contact pair or both parallel and perpendicular contact pairs are created for an edge-edge contact.

Type     EdgeEdgeTreatment
Read Only    No

EigenvalueBucklingExtension

No details are provided for this entry.

Properties

LoadMultiplier

No details are provided for this entry.

Type     double
Read Only    Yes

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

DefineBy

Property to specify if the applied heat generation value is total heat generated or the heat generated per unit volume.

Type     ApplicationMethod
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

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
TrimOptimization

JointFormulation types used by Mapdl Fixed Joint Connection Behavior

Type     JointTrimOptimization
Read Only    No

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

LinearizedResults

Extension object that presents linearized stress parameters

Properties

BendingStressBeginning

The bending stress component at the beginning of the line path.

Type     Quantity
Read Only    Yes
BendingStressEnd

The bending stress component at the end of the line path.

Type     Quantity
Read Only    Yes
MembranePlusBendingStressBeginning

The membrane + bending stress at the beginning of the line path.

Type     Quantity
Read Only    Yes
MembranePlusBendingStressEnd

The membrane + bending stress at the end of the line path.

Type     Quantity
Read Only    Yes
MembranePlusBendingStressMidLength

The membrane + bending stress at the mid-length of the line path.

Type     Quantity
Read Only    Yes
MembraneStress

The membrane stress component.

Type     Quantity
Read Only    Yes
PeakStressBeginning

The peak stress component at the beginning of the line path.

Type     Quantity
Read Only    Yes
PeakStressEnd

The peak stress component at the end of the line path.

Type     Quantity
Read Only    Yes
PeakStressMidLength

The peak stress component at the mid-length of the line path.

Type     Quantity
Read Only    Yes
TotalStressBeginning

The total stress component at the beginning of the line path.

Type     Quantity
Read Only    Yes
TotalStressEnd

The total stress component at the end of the line path.

Type     Quantity
Read Only    Yes
TotalStressMidLength

The total stress component at the mid-length of the line path.

Type     Quantity
Read Only    Yes

LinearizedStressChart

No details are provided for this entry.

Properties

EvaluateFullRange

Whether or not to evaluate all time points in the evaluation

Type     bool
Read Only    No
LastAutomaticDisplayText

The last automatically-generated DisplayText assigned to this Result Object

Type     string
Read Only    No
Location

The Location over which the Result is to be evaluated.

Type     LocationSet
Read Only    No
NormalizeData

Normalize data so they are displayed as percentages

Type     bool
Read Only    No
ReverseDirection

Reverse the direction of the data when it's sent to the graph

Type     bool
Read Only    No
SimulationStep

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

Type     SolutionStep
Read Only    No
Variable

Data Model support for variable selector.

Type     Expression<Quantity>
Read Only    No
Variables

List of variables to be plotted

Type     List<Expression<Quantity>>
Read Only    No

LinearizeOption

Extension object that provides the option to linearize stress results

Properties

Linearize

The option to linearize stress results

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

OptimizationOptions

OptimizationOptions is an extension object for MechanicalPhysicsOptions to offer the objective options for the optimization process of a given location

Properties

ConstrainModeNumber

Sets the mode number which frequency to be constrained.

Type     int
Read Only    No
ConstrainNaturalFrequency

Switch to constrain the natural frequency.

Type     bool
Read Only    No
DesignTypes

Sets the design goal for the optimization analysis.

Type     DesignTypes
Read Only    No
Location

The region participating in the optimization process.

Type     LocationSet
Read Only    No
MaximumFrequency

upper bound of the frequency constraint range.

Type     Quantity
Read Only    No
MaxModesToFind

Maximum modes to find for modal solutions as available from MAPDL solver.

Type     int
Read Only    No
MinimumFrequency

Lower bound of the frequency constraint range.

Type     Quantity
Read Only    No
ModeNumber

Sets the mode number needed for natural frequency optimal design.

Type     int
Read Only    No
PreserveBondedContacts

Switch to preserve the contact regions during optimization analysis.

Type     bool
Read Only    No
ReductionType

Sets the material removal to be based on for a model with multiple materials.

Type     ReductionType
Read Only    No
SpecifyTargetReduction

Switch to limit the material removal.

Type     bool
Read Only    No
TargetReduction

Sets a target for maximum material removal.

Type     Expression<Quantity>
Read Only    No

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.

PerimeterWeld

This class represents a perimeter weld connection between two locations.

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

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

PsdAcceleration

PsdAcceleration is a PSD acceleration random vibration excitation applied to supports in global X, Y or Z direction.

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No
ReferenceFrame

Select a reference frame for the excitation direction.

Type     ReferenceFrame
Read Only    No

PsdDisplacement

PsdDisplacement is a PSD displacement random vibration excitation applied to supports in global X, Y or Z direction.

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No
ReferenceFrame

Select a reference frame for the excitation direction.

Type     ReferenceFrame
Read Only    No

PsdGAcceleration

PsdGAcceleration is a G acceleration random vibration excitation applied to supports in global X, Y or Z direction.

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No
ReferenceFrame

Select a reference frame for the excitation direction.

Type     ReferenceFrame
Read Only    No

PsdLoad

PsdLoad is a base class for all PSD loads in a random vibration analysis.

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No
ReferenceFrame

Select a reference frame for the excitation direction.

Type     ReferenceFrame
Read Only    No

PsdUserDefinedTypeExtension

No details are provided for this entry.

Properties

ResultType

No details are provided for this entry.

Type     ResultType
Read Only    No

PsdVelocity

PsdVelocity is a PSD velocidy random vibration excitation applied to supports in global X, Y or Z direction.

Properties

Location

Location of the boundary condition

Type     LocationSet
Read Only    No
ReferenceFrame

Select a reference frame for the excitation direction.

Type     ReferenceFrame
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

ReadOnlyShape

Read only shape is created to display intermediate shape to the user while solving an optimization analysis.

Properties

No Properties.

ReferenceTemperature

No details are provided for this entry.

Properties

Value

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No

RemoteLocation

This extension is added to boundary condition when it is applied remotely via an originating point.

Properties

Formulation

Formulation for the internally created remote point connection.

Type     ConnectionEndBehavior
Read Only    No
OriginatingPoint

Originating point for the remote boundary condition.

Type     LocationSet
Read Only    No

ResponsePsdResult

No details are provided for this entry.

Properties

ExpectedFrequency

The current value of the result.

Type     Quantity
Read Only    No
LastAutomaticDisplayText

The last automatically-generated DisplayText assigned to this Result Object

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    Yes
RmsValue

The current value of the result.

Type     Quantity
Read Only    No
Variable

The result variable to be evaluated.

Type     Expression<Quantity>
Read Only    No

ResultReferenceExtension

No details are provided for this entry.

Properties

ResultReference

No details are provided for this entry.

Type     ResultReference
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

ScaleFactorExtension

No details are provided for this entry.

Properties

Probability

No details are provided for this entry.

Type     string
Read Only    Yes
ScaleFactor

No details are provided for this entry.

Type     ScaleFactor
Read Only    No
ScaleFactorValue

No details are provided for this entry.

Type     double
Read Only    No

ShearMomentDiagram

No details are provided for this entry.

Properties

Location

The Location over which the Result is to be evaluated.

Type     LocationSet
Read Only    No
NormalizeData

Normalize data so they are displayed as percentages

Type     bool
Read Only    No
RelativeTo

The Reference Frame which the result is relative to

Type     ReferenceFrame
Read Only    Yes
ReverseDirection

Reverse the direction of the data when it's sent to the graph

Type     bool
Read Only    No
SimulationStep

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

Type     SolutionStep
Read Only    No
Variable

Data Model support for variable selector.

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.

SmdOutputExtension

No details are provided for this entry.

Properties

Maximum

No details are provided for this entry.

Type     Quantity
Read Only    Yes
Minimum

No details are provided for this entry.

Type     Quantity
Read Only    Yes

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.

SpotWeld

This class represents a spot weld connection between two locations.

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

Spring

This is a class for spring connection

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
GroundedLocation

Sets a location to be grounded

Type     GroundedLocation
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
RelativeTo

No details are provided for this entry.

Type     ReferenceFrame
Read Only    No
SpringLength

The length of the spring

Type     Quantity
Read Only    Yes

SpringBehavior

SpringBehavior is a ConnectionBehavior that models linear and nolinear spring connection between two locations.

Properties

BehaviorType

No details are provided for this entry.

Type     SpringBehaviorType
Read Only    No
Damping

Damping value for the spring

Type     Expression<Quantity>
Read Only    No
DampingX

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
DampingY

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
DampingZ

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
FixedTranslations

No details are provided for this entry.

Type     DoF
Read Only    No
FreeRotations

No details are provided for this entry.

Type     DoF
Read Only    No
SpringType

Spring type such as Longitudinal or Torsional

Type     SpringType
Read Only    No
Stiffness

Stiffness coefficient value for the spring

Type     Expression<Quantity>
Read Only    No
StiffnessX

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
StiffnessY

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
StiffnessZ

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No

SpringPreloadSettings

This class represents preload settings for a spring connection between two locations.

Properties

InitialCondition

Enter preload value

Type     Quantity
Read Only    No
PreloadType

Set the preload type to None, Load, Length, Torque or Rotation load and Length are available for longitudical springs only. Torque and Rotation are available for torsional springs only.

Type     SpringPreloadType
Read Only    No

StructuralMass

Structural mass to model one or more selected bodies as one rigid body with known mass and mass moments of inertia.

Properties

ConnectingLocation

This is the location by which point mass is connected to the rest of the model

Type     LocationSet
Read Only    No
Formulation

Formulation for the internally created remote point connection.

Type     ConnectionEndBehavior
Read Only    No
Location

This is the location where point mass is located.

Type     LocationSet
Read Only    No
Mass

Mass value of the point mass

Type     Expression<Quantity>
Read Only    No
MassMomentOfInertiaX

Mass moment of interia of point mass about X axis

Type     Expression<Quantity>
Read Only    No
MassMomentOfInertiaY

Mass moment of interia of point mass about Y axis

Type     Expression<Quantity>
Read Only    No
MassMomentOfInertiaZ

Mass moment of interia of point mass about Z axis

Type     Expression<Quantity>
Read Only    No

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

ThermalMass

Thermal mass to model one or more selected bodies with known thermal capacitance

Properties

Capacitance

Thermal capacitance of the point mass

Type     Expression<Quantity>
Read Only    No
ConnectingLocation

This is the location by which thermal mass is connected to the rest of the model

Type     LocationSet
Read Only    No
Formulation

Formulation for the internally created remote point connection.

Type     EndBehavior
Read Only    No
Location

This is the location where thermal mass is located.

Type     LocationSet
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

Extension object for prescribing displacement by both translation and rotation components.

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

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

BucklingControls

No details are provided for this entry.

Properties

IncludeNegativeLoadMultiplier

No details are provided for this entry.

Type     NegativeBucklingLoadMultiplier
Read Only    No

ContactFormulation

ContactFormulation is a class which represents various contact formulations as available from MAPDL solver.

Properties

ConstraintType

Specify the constraint type for contacts.

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
SmallSliding

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

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

CyclicSymmetryConstraint

CyclicSymmetryConstraint is a manufacturing constraint to apply a cyclic symmetry constraint in an optimization analysis.

Properties

AxialDirection

Select an axis direction of the selected reference frame for the cyclic symmetry.

Type     AxisType
Read Only    No
AxialDirectionDefinition

Select a method for defining the axial direction: based on a geometry selection or a reference frame.

Type     AxialDirectionDefinedBy
Read Only    No
AxialDirectionLocation

Select a face and use its normal as the axial direction for the cyclic symmetry.

Type     LocationSet
Read Only    No
NumberOfSectors

Specified number of sectors for cyclic symmetry.

Type     int
Read Only    No
ReferenceFrame

Select a reference frame for the axial direction.

Type     ReferenceFrame
Read Only    No

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
InitialContactTreatment

Set the initial contact treatment option.

Type     InitialContactTreatment
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

MemberSizeConstraint

MemberSizeConstraint is a manufacturing constraint to apply the minimum and maximum constraints on the memeber size in an optimization analysis

Properties

MaximumConstraintType

Maximum constraint type of the member size constraint: Program Controlled or Manual

Type     ConstraintType
Read Only    No
MaximumSize

Maximum size of the member size constraint

Type     Expression<Quantity>
Read Only    No
MinimumConstraintType

Minimum constraint type of the member size constraint: Program Controlled or Manual

Type     ConstraintType
Read Only    No
MinimumSize

Minimum size of the member size constraint

Type     Expression<Quantity>
Read Only    No

OptimizationControls

This is an extension object to SolverSettings for optimization controls

Properties

ConvergenceAccuracy

Sets a percentage of convergence accuracy for the optimization process

Type     Expression<Quantity>
Read Only    No
MaximumNumberOfIterations

Sets the maximum number of iteration for the optimization process

Type     int
Read Only    No
MaxNumberOfIntermediateFiles

Sets the maximum number of intermediate files for the optimization process

Type     uint
Read Only    No
MinimumNormalizedDensity

Sets the minimum normalized density for the optimization process

Type     Expression<Quantity>
Read Only    No
OptimizationSolver

Sets a solver type for the optimization process

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.

PullOutDirection

PullOutDirection is a manufacturing constraint used in optimization analysis

Properties

Axis

Axis used as a reference for the pull out direction

Type     AxisType
Read Only    No
Direction

Direction indicates the direction of the pull out

Type     DirectionType
Read Only    No
ReferenceFrame

Field variables of the spatial variation expression are defined with respect to this reference frame.

Type     ReferenceFrame
Read Only    No

RandomVibrationControls

RandomVibrationControls, an extension object to Solver Settings class, allows to define various analysis settings for random vibration as exposed by MAPDL solver.

Properties

ConstantDampingFactor

A value for constant damping factor used in a random vibration analysis.

Type     double
Read Only    No
ExcludeInsignificantModes

Switch to exclude the insignificant modes from a random vibration analysis.

Type     bool
Read Only    No
ModeSignificanceLevel

A value for mode significance level to exclude insignificant modes in a random vibration analysis.

Type     double
Read Only    No

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

StressConstraint

StressConstraint is a stress constraint used in an optimization analysis

Properties

Location

Location of the stress constraint

Type     LocationSet
Read Only    No
MaximumStress

Maximum value of the stress constraint

Type     Expression<Quantity>
Read Only    No
Type

Type displays the type of the stress constraint

Type     StressType
Read Only    Yes

SymmetryConstraint

SymmetryConstraint is a manufacturing constraint to apply a symmetry constraint in an optimization analysis.

Properties

PlaneOfSymmetry

Plane selection for the plane of symmetry.

Type     Plane
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

Fluent Data Entities

BoundaryMonitor

No details are provided for this entry.

Properties

AllowSubsetLocation

No details are provided for this entry.

Type     bool
Read Only    No
Boundary

No details are provided for this entry.

Type     FluentBoundary
Read Only    No
Location

No details are provided for this entry.

Type     LocationSet
Read Only    No
MonitoredOperation

No details are provided for this entry.

Type     SurfaceMonitorOperation
Read Only    No
MonitoredVariable

No details are provided for this entry.

Type     SurfaceMonitorVariable
Read Only    No
SurfaceMonitorConvergenceCriteria

No details are provided for this entry.

Type     double
Read Only    No

Flow

No details are provided for this entry.

Properties

AngularSpeed

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
AxialSpeed

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
FanPressureRise

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
FlowDirection

No details are provided for this entry.

Type     FlowSpecification
Read Only    No
IncludeFan

No details are provided for this entry.

Type     bool
Read Only    No
InletSpec

No details are provided for this entry.

Type     InletType
Read Only    No
Location

No details are provided for this entry.

Type     LocationSet
Read Only    No
MassFlowRate

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
MassFractionComponent1

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
NormalSpeed

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
OutletSpec

No details are provided for this entry.

Type     OutletType
Read Only    No
ReferenceFrame

No details are provided for this entry.

Type     ReferenceFrame
Read Only    No
SolvedSpecie

No details are provided for this entry.

Type     MaterialAssignment
Read Only    No
StaticPressure

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
TotalPressure

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No

FlowTemperature

No details are provided for this entry.

Properties

Boundary

No details are provided for this entry.

Type     FluentBoundary
Read Only    No
Temperature

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No

FluentBoundary

No details are provided for this entry.

Properties

Location

No details are provided for this entry.

Type     LocationSet
Read Only    No

FluentLaunchControls

No details are provided for this entry.

Properties

MpiType

No details are provided for this entry.

Type     MpiTypeValue
Read Only    No
NumberOfProcesses

No details are provided for this entry.

Type     int
Read Only    No
ProcessDistribution

No details are provided for this entry.

Type     ProcessDistributionOption
Read Only    No

FluentLocationInfo

No details are provided for this entry.

Properties

No Properties.

FluentPhysicsOptions

No details are provided for this entry.

Properties

Gravity

No details are provided for this entry.

Type     GravityDefinition
Read Only    No
IncludeBuoyancy

No details are provided for this entry.

Type     bool
Read Only    No
IncludeGravity

No details are provided for this entry.

Type     bool
Read Only    No
OperatingPressure

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
OperatingTemperature

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
RadiationModel

No details are provided for this entry.

Type     RadiationSpecification
Read Only    No
TurbulenceModel

No details are provided for this entry.

Type     TurbulenceSpecification
Read Only    No

FluentSolveError

No details are provided for this entry.

Properties

No Properties.

FluentSource

No details are provided for this entry.

Properties

Location

No details are provided for this entry.

Type     LocationSet
Read Only    No

FluidEnergySource

No details are provided for this entry.

Properties

EnergySource

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
Location

No details are provided for this entry.

Type     LocationSet
Read Only    No

HeatTransfer

No details are provided for this entry.

Properties

ConvectionTemperature

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
Emissivity

No details are provided for this entry.

Type     Expression<double>
Read Only    No
HeatFlow

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
HeatFlux

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
HeatTransferCoefficient

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
Location

No details are provided for this entry.

Type     LocationSet
Read Only    No
RadiativeTemperature

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
Temperature

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
ThermalSpec

No details are provided for this entry.

Type     ThermalWallSpecification
Read Only    No

InterfaceModel

No details are provided for this entry.

Properties

FilmMaterial

No details are provided for this entry.

Type     Material
Read Only    No
FilmThickness

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
HeatGenerationRate

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
Interface

No details are provided for this entry.

Type     RegionInterface2
Read Only    No
InterfaceModelSpec

No details are provided for this entry.

Type     InterfaceModelSpecification
Read Only    No

InterfaceMonitor

No details are provided for this entry.

Properties

AllowSubsetLocation

No details are provided for this entry.

Type     bool
Read Only    No
Boundary

No details are provided for this entry.

Type     FluentBoundary
Read Only    No
Location

No details are provided for this entry.

Type     LocationSet
Read Only    No
MonitoredOperation

No details are provided for this entry.

Type     SurfaceMonitorOperation
Read Only    No
MonitoredVariable

No details are provided for this entry.

Type     SurfaceMonitorVariable
Read Only    No
RegionInterface

No details are provided for this entry.

Type     RegionInterface2
Read Only    No
SideSelection

No details are provided for this entry.

Type     InterfaceSideSelection
Read Only    No
SurfaceMonitorConvergenceCriteria

No details are provided for this entry.

Type     double
Read Only    No

LocationInfo

No details are provided for this entry.

Properties

No Properties.

MeshSurfaceZone

No details are provided for this entry.

Properties

No Properties.

MeshVolumeZone

No details are provided for this entry.

Properties

No Properties.

MomentumSource

No details are provided for this entry.

Properties

Location

No details are provided for this entry.

Type     LocationSet
Read Only    No
MomentumXSource

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
MomentumYSource

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
MomentumZSource

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No

PhysicsRegionLocationInfo

No details are provided for this entry.

Properties

No Properties.

PointMonitor

No details are provided for this entry.

Properties

AllowSubsetLocation

No details are provided for this entry.

Type     bool
Read Only    No
Boundary

No details are provided for this entry.

Type     FluentBoundary
Read Only    No
Location

No details are provided for this entry.

Type     LocationSet
Read Only    No
MonitoredOperation

No details are provided for this entry.

Type     SurfaceMonitorOperation
Read Only    No
MonitoredVariable

No details are provided for this entry.

Type     SurfaceMonitorVariable
Read Only    No
PointX

No details are provided for this entry.

Type     double
Read Only    No
PointY

No details are provided for this entry.

Type     double
Read Only    No
PointZ

No details are provided for this entry.

Type     double
Read Only    No
SurfaceMonitorConvergenceCriteria

No details are provided for this entry.

Type     double
Read Only    No

PorositySource

No details are provided for this entry.

Properties

ConeHalfAngle

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
Direction1X

No details are provided for this entry.

Type     Expression<double>
Read Only    No
Direction1Y

No details are provided for this entry.

Type     Expression<double>
Read Only    No
Direction1Z

No details are provided for this entry.

Type     Expression<double>
Read Only    No
Direction2X

No details are provided for this entry.

Type     Expression<double>
Read Only    No
Direction2Y

No details are provided for this entry.

Type     Expression<double>
Read Only    No
Direction2Z

No details are provided for this entry.

Type     Expression<double>
Read Only    No
InertialResistance

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
InertialResistanceX

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
InertialResistanceY

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
InertialResistanceZ

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
IsConical

No details are provided for this entry.

Type     bool
Read Only    No
Location

No details are provided for this entry.

Type     LocationSet
Read Only    No
Permeability

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
PermeabilityX

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
PermeabilityY

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
PermeabilityZ

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
PointOnConeAxisX

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
PointOnConeAxisY

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
PointOnConeAxisZ

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
Porosity

No details are provided for this entry.

Type     Expression<double>
Read Only    No
PorosityMediaMaterial

No details are provided for this entry.

Type     PorosityMediaMaterial
Read Only    No
PorosityType

No details are provided for this entry.

Type     PorosityType
Read Only    No
PorousMedia

No details are provided for this entry.

Type     MaterialAssignment
Read Only    No

ReferenceBoundary

No details are provided for this entry.

Properties

Boundary

No details are provided for this entry.

Type     FluentBoundary
Read Only    No

RegionInterface2

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

RegionInterfaceGenerator2

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

SolidEnergySource

No details are provided for this entry.

Properties

EnergySource

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
Location

No details are provided for this entry.

Type     LocationSet
Read Only    No

SolutionControls

No details are provided for this entry.

Properties

AdaptiveTimestepping

No details are provided for this entry.

Type     bool
Read Only    No
ComputeLocalScale

No details are provided for this entry.

Type     bool
Read Only    No
ConvergenceCriteria

No details are provided for this entry.

Type     double
Read Only    No
ConvergenceOption

No details are provided for this entry.

Type     ConvergenceOption
Read Only    No
ConvertToPoly

No details are provided for this entry.

Type     bool
Read Only    No
EnergyConvergenceCriteria

No details are provided for this entry.

Type     double
Read Only    No
ImproveMeshIfRequired

No details are provided for this entry.

Type     bool
Read Only    No
IncludePeriodicity

No details are provided for this entry.

Type     bool
Read Only    No
NumberOfIterations

No details are provided for this entry.

Type     int
Read Only    No
NumberOfTimeSteps

No details are provided for this entry.

Type     int
Read Only    No
PhysicalTimeStep

No details are provided for this entry.

Type     Quantity
Read Only    No
SurfaceMonitorChainingOperation

No details are provided for this entry.

Type     SurfaceMonitorChainingOperation
Read Only    No
TransientConvergenceCriteria

No details are provided for this entry.

Type     double
Read Only    No
TurnAllBodiesIntoZones

No details are provided for this entry.

Type     bool
Read Only    No

SurfaceLocationInfo

No details are provided for this entry.

Properties

No Properties.

Symmetry

No details are provided for this entry.

Properties

Location

No details are provided for this entry.

Type     LocationSet
Read Only    No

ThermalApplication

No details are provided for this entry.

Properties

Boundary

No details are provided for this entry.

Type     FluentBoundary
Read Only    No

VolumeMonitor

No details are provided for this entry.

Properties

AllowSubsetLocation

No details are provided for this entry.

Type     bool
Read Only    No
Boundary

No details are provided for this entry.

Type     FluentBoundary
Read Only    No
Location

No details are provided for this entry.

Type     LocationSet
Read Only    No
MonitoredOperation

No details are provided for this entry.

Type     SurfaceMonitorOperation
Read Only    No
MonitoredVariable

No details are provided for this entry.

Type     SurfaceMonitorVariable
Read Only    No
SurfaceMonitorConvergenceCriteria

No details are provided for this entry.

Type     double
Read Only    No
Volume

No details are provided for this entry.

Type     UserObject
Read Only    No

Wall

No details are provided for this entry.

Properties

AngularSpeed

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
Location

No details are provided for this entry.

Type     LocationSet
Read Only    No
MotionSpec

No details are provided for this entry.

Type     WallMotionSpecification
Read Only    No
ReferenceFrame

No details are provided for this entry.

Type     ReferenceFrame
Read Only    No
SlipSpec

No details are provided for this entry.

Type     SlipSpecification
Read Only    No

WallHeatTransfer

No details are provided for this entry.

Properties

Boundary

No details are provided for this entry.

Type     FluentBoundary
Read Only    No
ConvectionTemperature

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
Emissivity

No details are provided for this entry.

Type     Expression<double>
Read Only    No
HeatFlow

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
HeatFlux

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
HeatTransferCoefficient

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
RadiativeTemperature

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
Temperature

No details are provided for this entry.

Type     Expression<Quantity>
Read Only    No
ThermalSpec

No details are provided for this entry.

Type     ThermalWallSpecification
Read Only    No

WallRadiation

No details are provided for this entry.

Properties

Boundary

No details are provided for this entry.

Type     FluentBoundary
Read Only    No
DiffuseFraction

No details are provided for this entry.

Type     Expression<double>
Read Only    No
Emissivity

No details are provided for this entry.

Type     Expression<double>
Read Only    No

PhysicsCoupling Data Entities

CouplingInterface

Configure a coupling interface.

Properties

MappingControl

Configure controls for mapping.

Type     IDictionary<string, Object>
Read Only    No
Side

Configure one side of a coupling interface.

Type     IDictionary<string, Object>
Read Only    No
Suppress

context to be documented

Type     String[]
Read Only    No
TransferToSideTwo

Configure transfers to side two of a coupling interface.

Type     IDictionary<string, Object>
Read Only    No

CouplingInterface

Configure a coupling interface.

Properties

MappingControl

Configure controls for mapping.

Type     IDictionary<string, Object>
Read Only    No
Side

Configure one side of a coupling interface.

Type     IDictionary<string, Object>
Read Only    No
Suppress

context to be documented

Type     String[]
Read Only    No
TransferToSideTwo

Configure transfers to side two of a coupling interface.

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