Body

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Body

Bases: object

Defines a Body.

Overview

Methods

GetGeoBody	Gets the Geo Body
ClearGeneratedData	Run the ClearGeneratedData action.
AddCommandSnippet	Creates a new CommandSnippet
AddPythonCodeEventBased	Creates a new PythonCodeEventBased
GenerateMesh	Run the GenerateMesh action.
PreviewInflation	Run the PreviewInflation action.
PreviewSurfaceMesh	Run the PreviewSurfaceMesh action.
ShowBody	Run the ShowBody action.
Update	Run the Update action.
GetChildren	Gets the list of children, filtered by type.
GetChildren	Gets the list of children, filtered by type.
AddComment	Creates a new child Comment.
AddFigure	Creates a new child Figure.
AddImage	Creates a new child Image.
Activate	Activate the current object.
CopyTo	Copies all visible properties from this object to another.
Duplicate	Creates a copy of the current DataModelObject.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
PropertyByName	Get a property by its unique name.
PropertyByAPIName	Get a property by its API name.
CreateParameter	Creates a new parameter for a Property.
GetParameter	Gets the parameter corresponding to the given property.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.

Properties

Hidden	Hide or show the body.
ConfigurationId	Gets the related Result Mesh’s ConfigurationId.
ResultMeshId	Gets the related Result Mesh’s ObjectId.
ReferenceTemperature	Gets or sets the ReferenceTemperature.
ThicknessMode	Gets the ThicknessMode.
Dimension	Gets or sets the Dimension.
Assignment	Gets or sets the Assignment.
CrossSectionName	Gets CrossSectionName.
ModelType	Gets or sets the ModelType.
GeometryType	Gets the GeometryType.
SuppressedParameterized	Gets if the part suppressed property is parameterized.
Transparency	Gets or sets the Transparency. Values range from 0.0 (fully invisible) to 1.0 (fully visible).
Color	Gets or sets the Color, encoded as a BGR bitfield.
InternalObject	Gets the internal object. For advanced usage only.
Elements	Gets the Elements.
Material	Gets or sets the Material.
Nodes	Gets the Nodes.
NumberOfTurns	Gets or sets the NumberOfTurns.
MeshVersion	Gets the MeshVersion.
LengthX	Gets the LengthX.
LengthY	Gets the LengthY.
LengthZ	Gets the LengthZ.
CrossSectionArea	Gets the CrossSectionArea.
CrossSectionIYY	Gets the CrossSectionIYY.
CrossSectionIZZ	Gets the CrossSectionIZZ.
FiberAngle	Gets or sets the FiberAngle.
FiberCrossSectionArea	Gets or sets the FiberCrossSectionArea.
FiberSpacing	Gets or sets the FiberSpacing.
FluidCrossArea	Gets or sets the FluidCrossArea.
Mass	Gets the Mass.
CentroidX	Gets the CentroidX.
CentroidY	Gets the CentroidY.
CentroidZ	Gets the CentroidZ.
MomentOfInertiaIp1	Gets the MomentOfInertiaIp1.
MomentOfInertiaIp2	Gets the MomentOfInertiaIp2.
MomentOfInertiaIp3	Gets the MomentOfInertiaIp3.
Average	Gets the Average.
Maximum	Gets the Maximum.
Minimum	Gets the Minimum.
StandardDeviation	Gets the StandardDeviation.
OffsetX	Gets or sets the OffsetX.
OffsetY	Gets or sets the OffsetY.
PipeExternalDiameter	Gets the PipeExternalDiameter.
PipeInternalDiameter	Gets the PipeInternalDiameter.
PipeThickness	Gets the PipeThickness.
ReferenceTemperatureValue	Gets or sets the ReferenceTemperatureValue.
SurfaceArea	Gets the SurfaceArea.
Thickness	Gets or sets the Thickness.
Volume	Gets the Volume.
Length	Gets the Length.
OffsetMode	Gets or sets the OffsetMode.
BrickIntegrationScheme	Gets or sets the BrickIntegrationScheme.
FluidDiscretization	Gets or sets the FluidDiscretization.
LinkTrussBehavior	Gets or sets the LinkTrussBehavior.
MaterialPolarizationDirection	Gets or sets the MaterialPolarizationDirection.
MeshMetric	Gets the MeshMetric.
Behavior	Gets or sets the Behavior.
OffsetType	Gets or sets the OffsetType.
FluidSolidPhase	Gets or sets the FluidSolidPhase.
ReferenceFrame	Gets or sets the ReferenceFrame.
ReinforcingStressState	Gets or sets the ReinforcingStressState.
StiffnessOption	Gets or sets the StiffnessOption.
ShellOffsetType	Gets or sets the ShellOffsetType.
StiffnessBehavior	Gets or sets the StiffnessBehavior.
Treatment	Gets or sets the Treatment.
Visible	Gets or sets the Visible.
HomogeneousMembrane	Gets or sets the HomogeneousMembrane.
IsWindingBody	Gets the IsWindingBody.
NonlinearEffects	Gets or sets the NonlinearEffects.
Suppressed	Gets or sets the Suppressed.
ThermalStrainEffects	Gets or sets the ThermalStrainEffects.
ManualThicknessMode	Gets the ManualThicknessMode.
UseReferenceTemperatureByBody	Gets or sets the UseReferenceTemperatureByBody.
UserNameChange	Gets the UserNameChange.
BeamSection	Gets the BeamSection.
CoordinateSystem	Gets or sets the CoordinateSystem.
CrossSectionSelection	Gets or sets the CrossSectionSelection.
DataModelObjectCategory	Gets the current DataModelObject’s category.
Children	Gets the list of children.
Comments	Gets the list of associated comments.
Figures	Gets the list of associated figures.
Images	Gets the list of associated images.
ReadOnly	Gets or sets the ReadOnly.
InternalObject	Gets the internal object. For advanced usage only.
Properties	Gets the list of properties for this object.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property Body.Hidden: System.Boolean | None

Hide or show the body.

property Body.ConfigurationId: System.Int32 | None

Gets the related Result Mesh’s ConfigurationId.

property Body.ResultMeshId: System.Int32 | None

Gets the related Result Mesh’s ObjectId.

property Body.ReferenceTemperature: System.Boolean | None

Gets or sets the ReferenceTemperature.

property Body.ThicknessMode: System.Boolean | None

Gets the ThicknessMode.

property Body.Dimension: Ansys.Mechanical.DataModel.Enums.ShellBodyDimension | None

Gets or sets the Dimension.

property Body.Assignment: System.String | None

Gets or sets the Assignment.

property Body.CrossSectionName: System.String | None

Gets CrossSectionName.

property Body.ModelType: Ansys.Mechanical.DataModel.Enums.PrototypeModelType | None

Gets or sets the ModelType. Note: ModelType is applicable to line bodies and surface bodies only.

property Body.GeometryType: Ansys.Mechanical.DataModel.Enums.GeometryType | None

Gets the GeometryType.

property Body.SuppressedParameterized: System.Boolean | None

Gets if the part suppressed property is parameterized.

property Body.Transparency: System.Double | None

Gets or sets the Transparency. Values range from 0.0 (fully invisible) to 1.0 (fully visible).

property Body.Color: System.UInt32 | None

Gets or sets the Color, encoded as a BGR bitfield.

property Body.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSPrototypeAuto | None

Gets the internal object. For advanced usage only.

property Body.Elements: System.Int32 | None

Gets the Elements.

property Body.Material: System.String | None

Gets or sets the Material.

property Body.Nodes: System.Int32 | None

Gets the Nodes.

property Body.NumberOfTurns: System.UInt32 | None

Gets or sets the NumberOfTurns.

property Body.MeshVersion: System.Int32 | None

Gets the MeshVersion.

property Body.LengthX: Ansys.Core.Units.Quantity | None

Gets the LengthX.

property Body.LengthY: Ansys.Core.Units.Quantity | None

Gets the LengthY.

property Body.LengthZ: Ansys.Core.Units.Quantity | None

Gets the LengthZ.

property Body.CrossSectionArea: Ansys.Core.Units.Quantity | None

Gets the CrossSectionArea.

property Body.CrossSectionIYY: Ansys.Core.Units.Quantity | None

Gets the CrossSectionIYY.

property Body.CrossSectionIZZ: Ansys.Core.Units.Quantity | None

Gets the CrossSectionIZZ.

property Body.FiberAngle: Ansys.Core.Units.Quantity | None

Gets or sets the FiberAngle.

property Body.FiberCrossSectionArea: Ansys.Core.Units.Quantity | None

Gets or sets the FiberCrossSectionArea.

property Body.FiberSpacing: Ansys.Core.Units.Quantity | None

Gets or sets the FiberSpacing.

property Body.FluidCrossArea: Ansys.Core.Units.Quantity | None

Gets or sets the FluidCrossArea.

property Body.Mass: Ansys.Core.Units.Quantity | None

Gets the Mass.

property Body.CentroidX: Ansys.Core.Units.Quantity | None

Gets the CentroidX.

property Body.CentroidY: Ansys.Core.Units.Quantity | None

Gets the CentroidY.

property Body.CentroidZ: Ansys.Core.Units.Quantity | None

Gets the CentroidZ.

property Body.MomentOfInertiaIp1: Ansys.Core.Units.Quantity | None

Gets the MomentOfInertiaIp1.

property Body.MomentOfInertiaIp2: Ansys.Core.Units.Quantity | None

Gets the MomentOfInertiaIp2.

property Body.MomentOfInertiaIp3: Ansys.Core.Units.Quantity | None

Gets the MomentOfInertiaIp3.

property Body.Average: Ansys.Core.Units.Quantity | None

Gets the Average.

property Body.Maximum: Ansys.Core.Units.Quantity | None

Gets the Maximum.

property Body.Minimum: Ansys.Core.Units.Quantity | None

Gets the Minimum.

property Body.StandardDeviation: Ansys.Core.Units.Quantity | None

Gets the StandardDeviation.

property Body.OffsetX: Ansys.Core.Units.Quantity | None

Gets or sets the OffsetX.

property Body.OffsetY: Ansys.Core.Units.Quantity | None

Gets or sets the OffsetY.

property Body.PipeExternalDiameter: Ansys.Core.Units.Quantity | None

Gets the PipeExternalDiameter.

property Body.PipeInternalDiameter: Ansys.Core.Units.Quantity | None

Gets the PipeInternalDiameter.

property Body.PipeThickness: Ansys.Core.Units.Quantity | None

Gets the PipeThickness.

property Body.ReferenceTemperatureValue: Ansys.Core.Units.Quantity | None

Gets or sets the ReferenceTemperatureValue.

property Body.SurfaceArea: Ansys.Core.Units.Quantity | None

Gets the SurfaceArea.

property Body.Thickness: Ansys.Core.Units.Quantity | None

Gets or sets the Thickness.

property Body.Volume: Ansys.Core.Units.Quantity | None

Gets the Volume.

property Body.Length: Ansys.Core.Units.Quantity | None

Gets the Length.

property Body.OffsetMode: Ansys.Mechanical.DataModel.Enums.AutomaticOrManual | None

Gets or sets the OffsetMode.

property Body.BrickIntegrationScheme: Ansys.Mechanical.DataModel.Enums.BrickIntegrationScheme | None

Gets or sets the BrickIntegrationScheme.

property Body.FluidDiscretization: Ansys.Mechanical.DataModel.Enums.FluidDiscretizationType | None

Gets or sets the FluidDiscretization.

property Body.LinkTrussBehavior: Ansys.Mechanical.DataModel.Enums.PrototypeLinkBehavior | None

Gets or sets the LinkTrussBehavior.

property Body.MaterialPolarizationDirection: Ansys.Mechanical.DataModel.Enums.MaterialPolarizationDirection | None

Gets or sets the MaterialPolarizationDirection.

property Body.MeshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType | None

Gets the MeshMetric.

property Body.Behavior: Ansys.Mechanical.DataModel.Enums.Model2DBehavior | None

Gets or sets the Behavior.

property Body.OffsetType: Ansys.Mechanical.DataModel.Enums.BeamOffsetType | None

Gets or sets the OffsetType.

property Body.FluidSolidPhase: Ansys.Mechanical.DataModel.Enums.PhaseType | None

Gets or sets the FluidSolidPhase.

property Body.ReferenceFrame: Ansys.Mechanical.DataModel.Enums.ReferenceFrameType | None

Gets or sets the ReferenceFrame.

property Body.ReinforcingStressState: Ansys.Mechanical.DataModel.Enums.ReinforcingStressState | None

Gets or sets the ReinforcingStressState.

property Body.StiffnessOption: Ansys.Mechanical.DataModel.Enums.ShellElementStiffnessOption | None

Gets or sets the StiffnessOption.

property Body.ShellOffsetType: Ansys.Mechanical.DataModel.Enums.ShellOffsetType | None

Gets or sets the ShellOffsetType.

property Body.StiffnessBehavior: Ansys.Mechanical.DataModel.Enums.StiffnessBehavior | None

Gets or sets the StiffnessBehavior.

property Body.Treatment: Ansys.Mechanical.DataModel.Enums.BodyTreatment | None

Gets or sets the Treatment.

property Body.Visible: System.Boolean | None

Gets or sets the Visible.

property Body.HomogeneousMembrane: System.Boolean | None

Gets or sets the HomogeneousMembrane.

property Body.IsWindingBody: System.Boolean | None

Gets the IsWindingBody.

property Body.NonlinearEffects: System.Boolean | None

Gets or sets the NonlinearEffects.

property Body.Suppressed: System.Boolean | None

Gets or sets the Suppressed.

property Body.ThermalStrainEffects: System.Boolean | None

Gets or sets the ThermalStrainEffects.

property Body.ManualThicknessMode: System.Boolean | None

Gets the ManualThicknessMode.

property Body.UseReferenceTemperatureByBody: System.Boolean | None

Gets or sets the UseReferenceTemperatureByBody.

property Body.UserNameChange: System.Boolean | None

Gets the UserNameChange.

property Body.BeamSection: Ansys.ACT.Automation.Mechanical.DataModelObject | None

Gets the BeamSection.

property Body.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the CoordinateSystem.

property Body.CrossSectionSelection: Ansys.ACT.Automation.Mechanical.CrossSection | None

Gets or sets the CrossSectionSelection.

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

Gets the current DataModelObject’s category.

property Body.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property Body.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property Body.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property Body.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property Body.ReadOnly: System.Boolean | None

Gets or sets the ReadOnly.

property Body.InternalObject: System.Object | None

Gets the internal object. For advanced usage only.

property Body.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property Body.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

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

Method detail

Body.GetGeoBody() → Ansys.ACT.Interfaces.Geometry.IGeoBody

Gets the Geo Body

Body.ClearGeneratedData() → System.Void

Run the ClearGeneratedData action.

Body.AddCommandSnippet() → Ansys.ACT.Automation.Mechanical.CommandSnippet

Creates a new CommandSnippet

Body.AddPythonCodeEventBased() → Ansys.ACT.Automation.Mechanical.PythonCodeEventBased

Creates a new PythonCodeEventBased

Body.GenerateMesh() → System.Void

Run the GenerateMesh action.

Body.PreviewInflation() → System.Void

Run the PreviewInflation action.

Body.PreviewSurfaceMesh() → System.Void

Run the PreviewSurfaceMesh action.

Body.ShowBody() → System.Void

Run the ShowBody action.

Body.Update() → System.Void

Run the Update action.

Body.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]

Gets the list of children, filtered by type.

Body.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]

Gets the list of children, filtered by type.

Body.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

Body.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

Body.AddImage(filePath: System.String) → Ansys.ACT.Automation.Mechanical.Image

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.

Body.Activate() → System.Void

Activate the current object.

Body.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void

Copies all visible properties from this object to another.

Body.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

Body.GroupAllSimilarChildren() → System.Void

Run the GroupAllSimilarChildren action.

Body.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

Body.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

Body.PropertyByAPIName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property

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.

Body.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

Body.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

Body.RemoveParameter(propName: System.String) → System.Void

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