class Ansys.ACT.Automation.Mechanical.Model

Bases: object

Defines a Model.

Overview

Methods

Name	Description
Activate	Activate the current object.
AddAMProcess	Creates a new AMProcess
AddChart	Creates a new child Chart.
AddCoSimulationPin	Creates a new CoSimulationPin
AddComment	Creates a new child Comment.
AddCompositeFailureCriteria	Creates a new Composite Failure Criteria object.
AddCondensedGeometry	Creates a new CondensedGeometry
AddConnections	Creates a new Connections
AddConstructionGeometry	Creates a new ConstructionGeometry
AddCoupledFieldHarmonic	Run the AddCoupledFieldHarmonic action.
AddCoupledFieldModal	Run the AddCoupledFieldModal action.
AddCoupledFieldStatic	Run the AddCoupledFieldStatic action.
AddCoupledFieldTransient	Run the AddCoupledFieldTransient action.
AddCrossSections	Creates new CrossSections group.
AddDesignAssessmentAnalysis	Run the AddDesignAssessmentAnalysis action.
AddDesignLifeAnalysis	Run the AddDesignLifeAnalysis action.
AddEigenvalueBucklingAnalysis	Run the AddEigenvalueBucklingAnalysis action.
AddElectricAnalysis	Run the AddElectricAnalysis action.
AddExplicitDynamicsAnalysis	Run the AddExplicitDynamicsAnalysis action.
AddFatigueCombination	Creates a new FatigueCombination
AddFeatureDetection	Creates a new FeatureDetection
AddFigure	Creates a new child Figure.
AddForcedResponseAnalysis	Run the AddForcedResponseAnalysis action.
AddFracture	Creates a new Fracture
AddGeometryImportGroup	Get the
AddHarmonicAcousticAnalysis	Run the AddHarmonicAcousticAnalysis action.
AddHarmonicResponseAnalysis	Run the AddHarmonicResponseAnalysis action.
AddImage	Creates a new child Image.
AddImagePlane	Creates an ImagePlane and adds it as a child of this object.
AddLSDynaAnalysis	Run the AddLSDynaAnalysis action.
AddLSDynaRestartAnalysis	Run the AddLSDynaRestartAnalysis action.
AddMagnetostaticAnalysis	Run the AddMagnetostaticAnalysis action.
AddMeasures	Creates a new Measures
AddMeshEdit	Creates a new MeshEdit
AddMeshNumbering	Creates a new MeshNumbering
AddModalAcousticAnalysis	Run the AddModalAcousticAnalysis action.
AddModalAnalysis	Run the AddModalAnalysis action.
AddMotionAnalysis	Run the AddMotionAnalysis action.
AddNamedSelection	Creates a new child NamedSelection.
AddNamedSelectionFromSelectedConnections	Creates a new Named Selections (Components) for the selected connections.
AddPartTransform	Creates a new child PartTransform.
AddPythonCodeEventBased	Creates a new PythonCodeEventBased
AddPythonResult	Creates a new PythonResult
AddRandomVibrationAnalysis	Run the AddRandomVibrationAnalysis action.
AddRemotePoint	Creates a new child RemotePoint.
AddResponseSpectrumAnalysis	Run the AddResponseSpectrumAnalysis action.
AddRigidDynamicsAnalysis	Run the AddRigidDynamicsAnalysis action.
AddSolutionCombination	Creates a new SolutionCombination
AddStaticAcousticAnalysis	Run the AddStaticAcousticAnalysis action.
AddStaticStructuralAnalysis	Run the AddStaticStructuralAnalysis action.
AddSteadyStateThermalAnalysis	Run the AddSteadyStateThermalAnalysis action.
AddSubstructureGenerationAnalysis	Run the AddSubstructureGenerationAnalysis action.
AddSymmetry	Creates a new Symmetry
AddTableGroup	Get the
AddThermalElectricAnalysis	Run the AddThermalElectricAnalysis action.
AddTopologyOptimizationAnalysis	Run the AddTopologyOptimizationAnalysis action.
AddTransientStructuralAnalysis	Run the AddTransientStructuralAnalysis action.
AddTransientThermalAnalysis	Run the AddTransientThermalAnalysis action.
AddTreeGroupingFolder	Move the Data Model Objects to a new TreeGroupingFolder.
AddVirtualTopology	Creates a new VirtualTopology
AutoFilter	Enables interface filtering that only displays model-level items applicable to the
CenterOfMass	Calculates the center of mass of all unsupressed bodies and point masses.
ClearGeneratedData	Run the ClearGeneratedData action.
CopyTo	Copies all visible properties from this object to another.
CreateCylindricalBolt	Create bolt with a cylinder head based on the specified dimensions. The bolt will be
CreateCylindricalNut	Create a cylindrical nut with the specified dimensions. The nut will be created so that
CreateHexBolt	Create a bolt with a hex head based on the specified dimensions. The bolt will be
CreateHexNut	Create a hex nut with the specified dimensions. The nut will be created so that the
CreateParameter	Creates a new parameter for a Property.
CreatePartInstance	This will create an instance (not an independent copy) of the provided part. The use of
DeleteParts	Deletes the provide parts if they exist. Otherwise, nothing happens. An exception will be issued if the argument is invalid.
DisableFilter	Disables interface filtering so that model-level items are not filtered out based on
Duplicate	Creates a copy of the current DataModelObject.
EvaluateScriptDefinedResults	EvaluateScriptDefinedResults method.
FreezeMeshOnSelectedParts	Run the FreezeMeshOnSelectedParts action.
GetChildren	Gets the list of children, filtered by type.
GetFECommandsRepository	Gets the commands repository for a file from external model.
GetParameter	Gets the parameter corresponding to the given property.
GetResults	Gets the Results from the server.
GetTransformationOnPart	Get the transformation matrix of the provided part.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
LoadResultFile	Creates a results-only system and loads the result file.
PropertyByAPIName	Get a property by its API name.
PropertyByName	Get a property by its unique name.
RefreshMaterials	Run the RefresMaterials action.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
SetTransformationOnPart	Transform a part with given transformation. Only rigid body transformation is
Solve	Run the Solve action.
UnfreezeMeshOnSelectedParts	Run the UnfreezeMeshOnSelectedParts action.
UpdateGeometryFromSource	Run the UpdateGeometryFromSource action.

Properties

Name	Description
AEDTImportManager	Get the manager for manipulating import settings for AEDT files.
AMProcess	Gets the AMProcess.
Ambient	Gets or sets the Ambient Lighting factor.
Analyses	Gets the Analyses.
CellId	Gets the CellId.
Children	Gets the list of children.
Color	Gets or sets the Lighting Color. Can also be set using Hex color codes; three byte hexadecimal numbers (consisting of six digits) preceded by ‘0x’, where each byte (or pair of characters in the Hex code) represents the intensity of red, green and blue in the color respectively. For example, 0xFFFFFF.
Comments	Gets the list of associated comments.
CondensedGeometry	Gets the CondensedGeometry.
Connections	Gets the Connections.
ConstructionGeometry	Gets the ConstructionGeometry.
Control	Gets the Control.
CoordinateSystems	Gets the CoordinateSystems.
CrossSections	Gets the CrossSections.
DataModelObjectCategory	Gets the current DataModelObject’s category.
Diffuse	Gets or sets the Diffuse Lighting factor.
Environments	Gets the Analyses.
FeatureDetection	Gets the FeatureDetection.
Figures	Gets the list of associated figures.
Fracture	Gets the Fracture.
Geometry	Gets the Geometry.
GeometryImportGroup	Gets the GeometryImportGroup.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
Materials	Gets the Materials.
Measures	Gets the Measures.
Mesh	Gets the Mesh.
MeshEdit	Gets the MeshEdit.
MeshNumbering	Gets the MeshNumbering.
NamedSelections	Gets the NamedSelections.
PartTransformGroup	Gets the PartTransformGroup.
Properties	Gets the list of properties for this object.
RemotePoints	Gets the RemotePoints.
Specular	Gets or sets the Specular Lighting factor.
Symmetry	Gets the Symmetry.
SystemCaption	Gets the SystemCaption.
TableGroup	Gets the TableGroup.
VirtualTopology	Gets the VirtualTopology.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property Model.AEDTImportManager : Ansys.ACT.Automation.Mechanical.AEDTImportManager | None

Get the manager for manipulating import settings for AEDT files.

property Model.AMProcess : Ansys.ACT.Automation.Mechanical.AdditiveManufacturing.AMProcess | None

Gets the AMProcess.

property Model.Ambient : float | None

Gets or sets the Ambient Lighting factor.

property Model.Analyses : List[Ansys.ACT.Automation.Mechanical.Analysis] | None

Gets the Analyses.

property Model.CellId : str | None

Gets the CellId.

property Model.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property Model.Color : int | None

Gets or sets the Lighting Color. Can also be set using Hex color codes; three byte hexadecimal numbers (consisting of six digits) preceded by ‘0x’, where each byte (or pair of characters in the Hex code) represents the intensity of red, green and blue in the color respectively. For example, 0xFFFFFF.

property Model.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property Model.CondensedGeometry : Ansys.ACT.Automation.Mechanical.CondensedGeometry | None

Gets the CondensedGeometry.

property Model.Connections : Ansys.ACT.Automation.Mechanical.Connections.Connections | None

Gets the Connections.

property Model.ConstructionGeometry : Ansys.ACT.Automation.Mechanical.ConstructionGeometry | None

Gets the ConstructionGeometry.

property Model.Control : str | None

Gets the Control.

property Model.CoordinateSystems : Ansys.ACT.Automation.Mechanical.CoordinateSystems | None

Gets the CoordinateSystems.

property Model.CrossSections : Ansys.ACT.Automation.Mechanical.CrossSections | None

Gets the CrossSections.

property Model.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject’s category.

property Model.Diffuse : float | None

Gets or sets the Diffuse Lighting factor.

property Model.Environments : Iterable[Ansys.ACT.Automation.Mechanical.Analysis] | None

Gets the Analyses.

property Model.FeatureDetection : Ansys.ACT.Automation.Mechanical.FeatureDetection | None

Gets the FeatureDetection.

property Model.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property Model.Fracture : Ansys.ACT.Automation.Mechanical.Fracture | None

Gets the Fracture.

property Model.Geometry : Ansys.ACT.Automation.Mechanical.Geometry | None

Gets the Geometry.

property Model.GeometryImportGroup : Ansys.ACT.Automation.Mechanical.GeometryImportGroup | None

Gets the GeometryImportGroup.

property Model.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property Model.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSModelAuto | None

Gets the internal object. For advanced usage only.

property Model.Materials : Ansys.ACT.Automation.Mechanical.Materials | None

Gets the Materials.

property Model.Measures : Ansys.ACT.Automation.Mechanical.Measures | None

Gets the Measures.

property Model.Mesh : Ansys.ACT.Automation.Mechanical.MeshControls.Mesh | None

Gets the Mesh.

property Model.MeshEdit : Ansys.ACT.Automation.Mechanical.MeshEdit | None

Gets the MeshEdit.

property Model.MeshNumbering : Ansys.ACT.Automation.Mechanical.MeshNumbering | None

Gets the MeshNumbering.

property Model.NamedSelections : Ansys.ACT.Automation.Mechanical.NamedSelections | None

Gets the NamedSelections.

property Model.PartTransformGroup : Ansys.ACT.Automation.Mechanical.PartTransformGroup | None

Gets the PartTransformGroup.

property Model.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property Model.RemotePoints : Ansys.ACT.Automation.Mechanical.RemotePoints | None

Gets the RemotePoints.

property Model.Specular : float | None

Gets or sets the Specular Lighting factor.

property Model.Symmetry : Ansys.ACT.Automation.Mechanical.Symmetry | None

Gets the Symmetry.

property Model.SystemCaption : str | None

Gets the SystemCaption.

property Model.TableGroup : Ansys.ACT.Automation.Mechanical.TableGroup | None

Gets the TableGroup.

property Model.VirtualTopology : Ansys.ACT.Automation.Mechanical.VirtualTopology | None

Gets the VirtualTopology.

property Model.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties that are visible for this object.

Method detail

Model.Activate()

Activate the current object.

Model.AddAMProcess()

Creates a new AMProcess

Model.AddChart()

Creates a new child Chart.

Model.AddCoSimulationPin()

Creates a new CoSimulationPin

Model.AddComment()

Creates a new child Comment.

Model.AddCompositeFailureCriteria()

Creates a new Composite Failure Criteria object.

Model.AddCondensedGeometry()

Creates a new CondensedGeometry

Model.AddConnections()

Creates a new Connections

Model.AddConstructionGeometry()

Creates a new ConstructionGeometry

Model.AddCoupledFieldHarmonic()

Run the AddCoupledFieldHarmonic action.

Model.AddCoupledFieldModal()

Run the AddCoupledFieldModal action.

Model.AddCoupledFieldStatic()

Run the AddCoupledFieldStatic action.

Model.AddCoupledFieldTransient()

Run the AddCoupledFieldTransient action.

Model.AddCrossSections()

Creates new CrossSections group.

Model.AddDesignAssessmentAnalysis()

Run the AddDesignAssessmentAnalysis action.

Model.AddDesignLifeAnalysis()

Run the AddDesignLifeAnalysis action.

Model.AddEigenvalueBucklingAnalysis()

Run the AddEigenvalueBucklingAnalysis action.

Model.AddElectricAnalysis()

Run the AddElectricAnalysis action.

Model.AddExplicitDynamicsAnalysis()

Run the AddExplicitDynamicsAnalysis action.

Model.AddFatigueCombination()

Creates a new FatigueCombination

Model.AddFeatureDetection()

Creates a new FeatureDetection

Model.AddFigure()

Creates a new child Figure.

Model.AddForcedResponseAnalysis()

Run the AddForcedResponseAnalysis action.

Model.AddFracture()

Creates a new Fracture

Model.AddGeometryImportGroup()

Get the

Model.AddHarmonicAcousticAnalysis()

Run the AddHarmonicAcousticAnalysis action.

Model.AddHarmonicResponseAnalysis()

Run the AddHarmonicResponseAnalysis action.

Model.AddImage(filePath: str)

Creates a new child Image.
If a filePath is provided, the image will be loaded from that file,
if not, the image will be a screen capture of the Geometry window.

Model.AddImagePlane()

Creates an ImagePlane and adds it as a child of this object.

Model.AddLSDynaAnalysis()

Run the AddLSDynaAnalysis action.

Model.AddLSDynaRestartAnalysis()

Run the AddLSDynaRestartAnalysis action.

Model.AddMagnetostaticAnalysis()

Run the AddMagnetostaticAnalysis action.

Model.AddMeasures()

Creates a new Measures

Model.AddMeshEdit()

Creates a new MeshEdit

Model.AddMeshNumbering()

Creates a new MeshNumbering

Model.AddModalAcousticAnalysis()

Run the AddModalAcousticAnalysis action.

Model.AddModalAnalysis()

Run the AddModalAnalysis action.

Model.AddMotionAnalysis()

Run the AddMotionAnalysis action.

Model.AddNamedSelection()

Creates a new child NamedSelection.

Model.AddNamedSelectionFromSelectedConnections()

Creates a new Named Selections (Components) for the selected connections.

Model.AddPartTransform()

Creates a new child PartTransform.

Model.AddPythonCodeEventBased()

Creates a new PythonCodeEventBased

Model.AddPythonResult()

Creates a new PythonResult

Model.AddRandomVibrationAnalysis()

Run the AddRandomVibrationAnalysis action.

Model.AddRemotePoint()

Creates a new child RemotePoint.

Model.AddResponseSpectrumAnalysis()

Run the AddResponseSpectrumAnalysis action.

Model.AddRigidDynamicsAnalysis()

Run the AddRigidDynamicsAnalysis action.

Model.AddSolutionCombination()

Creates a new SolutionCombination

Model.AddStaticAcousticAnalysis()

Run the AddStaticAcousticAnalysis action.

Model.AddStaticStructuralAnalysis()

Run the AddStaticStructuralAnalysis action.

Model.AddSteadyStateThermalAnalysis()

Run the AddSteadyStateThermalAnalysis action.

Model.AddSubstructureGenerationAnalysis()

Run the AddSubstructureGenerationAnalysis action.

Model.AddSymmetry()

Creates a new Symmetry

Model.AddTableGroup(activate: bool)

Get the

Model.AddThermalElectricAnalysis()

Run the AddThermalElectricAnalysis action.

Model.AddTopologyOptimizationAnalysis()

Run the AddTopologyOptimizationAnalysis action.

Model.AddTransientStructuralAnalysis()

Run the AddTransientStructuralAnalysis action.

Model.AddTransientThermalAnalysis()

Run the AddTransientThermalAnalysis action.

Model.AddTreeGroupingFolder(dataModelObjects: Iterable)

Move the Data Model Objects to a new TreeGroupingFolder.

Model.AddVirtualTopology()

Creates a new VirtualTopology

Model.AutoFilter()

Enables interface filtering that only displays model-level items applicable to the
    particular analysis type environments in which you are working.

Model.CenterOfMass()

Calculates the center of mass of all unsupressed bodies and point masses.

Model.ClearGeneratedData()

Run the ClearGeneratedData action.

Model.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

Model.CreateCylindricalBolt(headHeight: Any, headRadius: Any, shankLength: Any, shankRadius: Any)

Create bolt with a cylinder head based on the specified dimensions. The bolt will be
created so that the base of the head is at the origin and aligned with the Y-Z plane.
Valid input arguments include:
  1) `double`
  2) `Quantity`
  3) A string representation of `double` or `Quantity`, i.e., "1.0" or "1.0 [cm]"

Model.CreateCylindricalNut(height: Any, innerRadius: Any, outerRadius: Any)

Create a cylindrical nut with the specified dimensions. The nut will be created so that
the base of the nut is at the origin and aligned with the Y-Z plane.
Valid input arguments include:
  1) `double`
  2) `Quantity`
  3) A string representation of `double` or `Quantity`, i.e., "1.0" or "1.0 [cm]"

Model.CreateHexBolt(headHeight: Any, wrenchWidth: Any, shankLength: Any, shankRadius: Any)

Create a bolt with a hex head based on the specified dimensions. The bolt will be
created so that the base of the head is at the origin and aligned with the Y-Z plane.
Valid input arguments include:
  1) `double`
  2) `Quantity`
  3) A string representation of `double` or `Quantity`, i.e., "1.0" or "1.0 [cm]"

Model.CreateHexNut(height: Any, innerRadius: Any, wrenchWidth: Any)

Create a hex nut with the specified dimensions. The nut will be created so that the
base of the nut is at the origin and aligned with the Y-Z plane.
Valid input arguments include:
  1) `double`
  2) `Quantity`
  3) A string representation of `double` or `Quantity`, i.e., "1.0" or "1.0 [cm]"

Model.CreateParameter(propName: str)

Creates a new parameter for a Property.

Model.CreatePartInstance(part: Ansys.ACT.Interfaces.Geometry.IGeoPart)

This will create an instance (not an independent copy) of the provided part. The use of
instanced parts for replication is highly recommended for memory and performance
reasons.

Model.DeleteParts(parts: Any)

Deletes the provide parts if they exist. Otherwise, nothing happens. An exception will be issued if the argument is invalid.

Model.DisableFilter()

Disables interface filtering so that model-level items are not filtered out based on
    the environment types in your model.

Model.Duplicate()

Creates a copy of the current DataModelObject.

Model.EvaluateScriptDefinedResults()

EvaluateScriptDefinedResults method.

Model.FreezeMeshOnSelectedParts(parts: Any)

Run the FreezeMeshOnSelectedParts action.

Model.GetChildren(recurses: bool, children: List[ChildrenType])

Gets the list of children, filtered by type.

Model.GetFECommandsRepository(source: str, fileIdentifier: str)

Gets the commands repository for a file from external model.

Model.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

Model.GetResults()

Gets the Results from the server.

Model.GetTransformationOnPart(part: Ansys.ACT.Interfaces.Geometry.IGeoPart)

Get the transformation matrix of the provided part.

Model.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

Model.GroupSimilarObjects()

Run the GroupSimilarObjects action.

Model.LoadResultFile(filePath: str)

Creates a results-only system and loads the result file.

Model.PropertyByAPIName(name: str)

Get a property by its API name.
If multiple properties have the same API Name, only the first property with that name will be returned.

Model.PropertyByName(name: str)

Get a property by its unique name.

Model.RefreshMaterials()

Run the RefresMaterials action.

Model.RemoveParameter(propName: str)

Removes the parameter from the parameter set corresponding to the given property.

Model.SetTransformationOnPart(part: Ansys.ACT.Interfaces.Geometry.IGeoPart, transformationMatrix: Ansys.Mechanical.DataModel.Utilities.RigidBodyTransformationMatrix)

Transform a part with given transformation. Only rigid body transformation is
supported, i.e., no scaling will be performed. The validity of “transformationMatrix”
will be checked against the constraints of rigid body transforms; an error will be
emitted if the matrix is ill-formed.

Model.Solve(wait: bool, config: str)

Run the Solve action.

Model.UnfreezeMeshOnSelectedParts(parts: Any)

Run the UnfreezeMeshOnSelectedParts action.

Model.UpdateGeometryFromSource()

Run the UpdateGeometryFromSource action.