Skip to main content

Mechanical scripting interface

LatticeDensity

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.Results.LatticeDensity

Bases: object

Defines a LatticeDensity.

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 LatticeDensity.CalculateTimeHistory : bool | None

Gets or sets the CalculateTimeHistory.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets the current DataModelObject’s category.

property LatticeDensity.ExclusionsParticipation : bool | None

Gets or sets the ExclusionsParticipation.

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

Gets the list of associated figures.

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

Gets the FinalMass.

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

Gets the FinalVolume.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

property LatticeDensity.IterationNumber : int | None

Gets the IterationNumber.

property LatticeDensity.IterationStep : int | None

Gets or sets the IterationStep.

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

Gets or sets the Location.

property LatticeDensity.Maximum : float | None

Gets the Maximum.

property LatticeDensity.Minimum : float | None

Gets the Minimum.

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

Gets the OriginalMass.

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

Gets the OriginalVolume.

property LatticeDensity.PercentMassOfOriginal : float | None

Gets the PercentMassOfOriginal.

property LatticeDensity.PercentVolumeOfOriginal : float | None

Gets the PercentVolumeOfOriginal.

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

Gets the list of properties for this object.

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

Gets or sets the ScopingMethod.

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

Gets or sets the Selection.

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

Gets or sets the ShowOptimizedRegion.

property LatticeDensity.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

Method detail

LatticeDensity.Activate()

Activate the current object.

LatticeDensity.AddComment()

Creates a new child Comment.

LatticeDensity.AddFigure()

Creates a new child Figure.

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

LatticeDensity.ClearGeneratedData()

Clears the result.

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

Copies all visible properties from this object to another.

LatticeDensity.CreateParameter(propName: str)

Creates a new parameter for a Property.

LatticeDensity.Delete()

Run the Delete action.

LatticeDensity.Duplicate()

Creates a copy of the current DataModelObject.

LatticeDensity.EvaluateAllResults()

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

LatticeDensity.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

LatticeDensity.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

LatticeDensity.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

LatticeDensity.PropertyByName(name: str)

Get a property by its unique name.

LatticeDensity.RemoveParameter(propName: str)

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

LatticeDensity.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.