`LatticeElementalDensity`#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Results.LatticeElementalDensity#

Bases: object

Defines a LatticeElementalDensity.

Overview#

Methods

`ClearGeneratedData`	Clears the result.
`EvaluateAllResults`	Run the EvaluateAllResults action.
`ExportAnimation`	Run the ExportAnimation action.
`RenameBasedOnDefinition`	Run the RenameBasedOnDefinition action.
`Delete`	Run the Delete 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

`InternalObject`	Gets the internal object. For advanced usage only.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Location`	Gets or sets the Location.
`IterationNumber`	Gets the IterationNumber.
`IterationStep`	Gets or sets the IterationStep.
`Maximum`	Gets the Maximum.
`Minimum`	Gets the Minimum.
`PercentMassOfOriginal`	Gets the PercentMassOfOriginal.
`PercentVolumeOfOriginal`	Gets the PercentVolumeOfOriginal.
`FinalMass`	Gets the FinalMass.
`FinalVolume`	Gets the FinalVolume.
`OriginalMass`	Gets the OriginalMass.
`OriginalVolume`	Gets the OriginalVolume.
`ScopingMethod`	Gets or sets the ScopingMethod.
`ShowOptimizedRegion`	Gets or sets the ShowOptimizedRegion.
`CalculateTimeHistory`	Gets or sets the CalculateTimeHistory.
`ExclusionsParticipation`	Gets or sets the ExclusionsParticipation.
`Suppressed`	Gets or sets the Suppressed.
`Selection`	Gets or sets the Selection.
`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.
`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 LatticeElementalDensity.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSResultAuto | None: Gets the internal object. For advanced usage only.

property LatticeElementalDensity.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property LatticeElementalDensity.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the Location.

property LatticeElementalDensity.IterationNumber: System.Int32 | None: Gets the IterationNumber.

property LatticeElementalDensity.IterationStep: System.Int32 | None: Gets or sets the IterationStep.

property LatticeElementalDensity.Maximum: System.Double | None: Gets the Maximum.

property LatticeElementalDensity.Minimum: System.Double | None: Gets the Minimum.

property LatticeElementalDensity.PercentMassOfOriginal: System.Double | None: Gets the PercentMassOfOriginal.

property LatticeElementalDensity.PercentVolumeOfOriginal: System.Double | None: Gets the PercentVolumeOfOriginal.

property LatticeElementalDensity.FinalMass: Ansys.Core.Units.Quantity | None: Gets the FinalMass.

property LatticeElementalDensity.FinalVolume: Ansys.Core.Units.Quantity | None: Gets the FinalVolume.

property LatticeElementalDensity.OriginalMass: Ansys.Core.Units.Quantity | None: Gets the OriginalMass.

property LatticeElementalDensity.OriginalVolume: Ansys.Core.Units.Quantity | None: Gets the OriginalVolume.

property LatticeElementalDensity.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None: Gets or sets the ScopingMethod.

property LatticeElementalDensity.ShowOptimizedRegion: Ansys.Mechanical.DataModel.Enums.TopologyOptimizationResultShowType | None: Gets or sets the ShowOptimizedRegion.

property LatticeElementalDensity.CalculateTimeHistory: System.Boolean | None: Gets or sets the CalculateTimeHistory.

property LatticeElementalDensity.ExclusionsParticipation: System.Boolean | None: Gets or sets the ExclusionsParticipation.

property LatticeElementalDensity.Suppressed: System.Boolean | None: Gets or sets the Suppressed.

property LatticeElementalDensity.Selection: Ansys.ACT.Automation.Mechanical.OptimizationRegion | None: Gets or sets the Selection.

property LatticeElementalDensity.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property LatticeElementalDensity.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property LatticeElementalDensity.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property LatticeElementalDensity.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property LatticeElementalDensity.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property LatticeElementalDensity.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property LatticeElementalDensity.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

LatticeElementalDensity.ClearGeneratedData() → System.Void: Clears the result.

LatticeElementalDensity.EvaluateAllResults() → System.Void: Run the EvaluateAllResults action.

LatticeElementalDensity.ExportAnimation(filePath: System.String, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings) → System.Void: Run the ExportAnimation action.

LatticeElementalDensity.RenameBasedOnDefinition() → System.Void: Run the RenameBasedOnDefinition action.

LatticeElementalDensity.Delete() → System.Void: Run the Delete action.

LatticeElementalDensity.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

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

LatticeElementalDensity.AddComment() → Ansys.ACT.Automation.Mechanical.Comment: Creates a new child Comment.

LatticeElementalDensity.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure: Creates a new child Figure.

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

LatticeElementalDensity.Activate() → System.Void: Activate the current object.

LatticeElementalDensity.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

LatticeElementalDensity.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

LatticeElementalDensity.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

LatticeElementalDensity.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

LatticeElementalDensity.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

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

LatticeElementalDensity.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

LatticeElementalDensity.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

LatticeElementalDensity.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.