Skip to main content

Mechanical scripting interface 2025

`LatticeElementalDensity`

Last update: 16.07.2025

class Ansys.ACT.Automation.Mechanical.Results.LatticeElementalDensity

Bases: object

Defines a LatticeElementalDensity.

Overview

Methods

Name Description
Activate Activate the current object.
AddComment Creates a new child Comment.
AddFigure Creates a new child Figure.
AddImage Creates a new child Image.
ClearGeneratedData Clears the result.
CopyTo Copies all visible properties from this object to another.
CreateParameter Creates a new parameter for a Property.
Delete Run the Delete action.
Duplicate Creates a copy of the current DataModelObject.
EvaluateAllResults Run the EvaluateAllResults action.
ExportAnimation Run the ExportAnimation action.
GetChildren Gets the list of children, filtered by type.
GetParameter Gets the parameter corresponding to the given property.
GroupAllSimilarChildren Run the GroupAllSimilarChildren action.
GroupSimilarObjects Run the GroupSimilarObjects action.
PropertyByAPIName Get a property by its API name.
PropertyByName Get a property by its unique name.
RemoveParameter Removes the parameter from the parameter set corresponding to the given property.
RenameBasedOnDefinition Run the RenameBasedOnDefinition action.

Properties

Name Description
CalculateTimeHistory Gets or sets the CalculateTimeHistory.
Children Gets the list of children.
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the current DataModelObject’s category.
ExclusionsParticipation Gets or sets the ExclusionsParticipation.
Figures Gets the list of associated figures.
FinalMass Gets the FinalMass.
FinalVolume Gets the FinalVolume.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
IterationNumber Gets the IterationNumber.
IterationStep Gets or sets the IterationStep.
Location Gets or sets the Location.
Maximum Gets the Maximum.
Minimum Gets the Minimum.
OriginalMass Gets the OriginalMass.
OriginalVolume Gets the OriginalVolume.
PercentMassOfOriginal Gets the PercentMassOfOriginal.
PercentVolumeOfOriginal Gets the PercentVolumeOfOriginal.
Properties Gets the list of properties for this object.
ScopingMethod Gets or sets the ScopingMethod.
Selection Gets or sets the Selection.
ShowOptimizedRegion Gets or sets the ShowOptimizedRegion.
Suppressed Gets or sets the Suppressed.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

property LatticeElementalDensity.CalculateTimeHistory : bool | None

Gets or sets the CalculateTimeHistory.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject’s category.

property LatticeElementalDensity.ExclusionsParticipation : bool | None

Gets or sets the ExclusionsParticipation.

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

Gets the list of associated figures.

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

Gets the FinalMass.

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

Gets the FinalVolume.

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

Gets the list of associated images.

property LatticeElementalDensity.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSResultAuto | None

Gets the internal object. For advanced usage only.

property LatticeElementalDensity.IterationNumber : int | None

Gets the IterationNumber.

property LatticeElementalDensity.IterationStep : int | None

Gets or sets the IterationStep.

property LatticeElementalDensity.Location : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Location.

property LatticeElementalDensity.Maximum : float | None

Gets the Maximum.

property LatticeElementalDensity.Minimum : float | None

Gets the Minimum.

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

Gets the OriginalMass.

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

Gets the OriginalVolume.

property LatticeElementalDensity.PercentMassOfOriginal : float | None

Gets the PercentMassOfOriginal.

property LatticeElementalDensity.PercentVolumeOfOriginal : float | None

Gets the PercentVolumeOfOriginal.

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

Gets the list of properties for this object.

property LatticeElementalDensity.ScopingMethod : Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the ScopingMethod.

property LatticeElementalDensity.Selection : Ansys.ACT.Automation.Mechanical.OptimizationRegion | None

Gets or sets the Selection.

property LatticeElementalDensity.ShowOptimizedRegion : Ansys.Mechanical.DataModel.Enums.TopologyOptimizationResultShowType | None

Gets or sets the ShowOptimizedRegion.

property LatticeElementalDensity.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

Method detail

LatticeElementalDensity.Activate() → None

Activate the current object.

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: str) → 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.ClearGeneratedData() → None

Clears the result.

LatticeElementalDensity.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

LatticeElementalDensity.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

LatticeElementalDensity.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

LatticeElementalDensity.EvaluateAllResults() → None

Run the EvaluateAllResults action.

LatticeElementalDensity.ExportAnimation(filePath: str, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings) → None

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

LatticeElementalDensity.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

LatticeElementalDensity.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

LatticeElementalDensity.PropertyByAPIName(name: str) → 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.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

LatticeElementalDensity.RemoveParameter(propName: str) → None

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

LatticeElementalDensity.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

Connect with Ansys