## On this page

  

 

 # `TopologyDensity`

 Last update: 16.07.2025 

<a id="ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Results.TopologyDensity"></a>

#### *class* Ansys.ACT.Automation.Mechanical.Results.TopologyDensity

Bases: [`object`](https://docs.python.org/3/library/functions.html#object)

Defines a TopologyDensity.

<a id="overview"></a>

## Overview

### Methods

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

NameDescription[`CalculateTimeHistory`](#TopologyDensity.CalculateTimeHistory)Gets or sets the CalculateTimeHistory.[`Children`](#TopologyDensity.Children)Gets the list of children.[`Comments`](#TopologyDensity.Comments)Gets the list of associated comments.[`DataModelObjectCategory`](#TopologyDensity.DataModelObjectCategory)Gets the current DataModelObject’s category.[`ExclusionsParticipation`](#TopologyDensity.ExclusionsParticipation)Gets or sets the ExclusionsParticipation.[`Figures`](#TopologyDensity.Figures)Gets the list of associated figures.[`FinalMass`](#TopologyDensity.FinalMass)Gets the FinalMass.[`FinalVolume`](#TopologyDensity.FinalVolume)Gets the FinalVolume.[`Images`](#TopologyDensity.Images)Gets the list of associated images.[`InternalObject`](#TopologyDensity.InternalObject)Gets the internal object. For advanced usage only.[`IterationNumber`](#TopologyDensity.IterationNumber)Gets the IterationNumber.[`IterationStep`](#TopologyDensity.IterationStep)Gets or sets the IterationStep.[`Location`](#TopologyDensity.Location)Gets or sets the Location.[`Maximum`](#TopologyDensity.Maximum)Gets the Maximum.[`Minimum`](#TopologyDensity.Minimum)Gets the Minimum.[`OriginalMass`](#TopologyDensity.OriginalMass)Gets the OriginalMass.[`OriginalVolume`](#TopologyDensity.OriginalVolume)Gets the OriginalVolume.[`PercentMassOfOriginal`](#TopologyDensity.PercentMassOfOriginal)Gets the PercentMassOfOriginal.[`PercentVolumeOfOriginal`](#TopologyDensity.PercentVolumeOfOriginal)Gets the PercentVolumeOfOriginal.[`Properties`](#TopologyDensity.Properties)Gets the list of properties for this object.[`RetainedThreshold`](#TopologyDensity.RetainedThreshold)Gets or sets the RetainedThreshold.[`ScopingMethod`](#TopologyDensity.ScopingMethod)Gets or sets the ScopingMethod.[`Selection`](#TopologyDensity.Selection)Gets or sets the Selection.[`ShowOptimizedRegion`](#TopologyDensity.ShowOptimizedRegion)Gets or sets the ShowOptimizedRegion.[`Suppressed`](#TopologyDensity.Suppressed)Gets or sets the Suppressed.[`VisibleProperties`](#TopologyDensity.VisibleProperties)Gets the list of properties that are visible for this object.<a id="property-detail"></a>

## Property detail

<a id="TopologyDensity.CalculateTimeHistory"></a>

### *property* TopologyDensity.CalculateTimeHistory *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the CalculateTimeHistory.

<a id="TopologyDensity.Children"></a>

### *property* TopologyDensity.Children *: List\[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of children.

<a id="TopologyDensity.Comments"></a>

### *property* TopologyDensity.Comments *: Iterable\[[Ansys.ACT.Automation.Mechanical.Comment](../Comment.md#ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Comment)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated comments.

<a id="TopologyDensity.DataModelObjectCategory"></a>

### *property* TopologyDensity.DataModelObjectCategory *: [Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory](../../../../Mechanical/DataModel/Enums/DataModelObjectCategory.md#ansys.mechanical.stubs.v241.Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the current DataModelObject’s category.

<a id="TopologyDensity.ExclusionsParticipation"></a>

### *property* TopologyDensity.ExclusionsParticipation *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ExclusionsParticipation.

<a id="TopologyDensity.Figures"></a>

### *property* TopologyDensity.Figures *: Iterable\[[Ansys.ACT.Automation.Mechanical.Figure](../Figure.md#ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Figure)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated figures.

<a id="TopologyDensity.FinalMass"></a>

### *property* TopologyDensity.FinalMass *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the FinalMass.

<a id="TopologyDensity.FinalVolume"></a>

### *property* TopologyDensity.FinalVolume *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the FinalVolume.

<a id="TopologyDensity.Images"></a>

### *property* TopologyDensity.Images *: Iterable\[[Ansys.ACT.Automation.Mechanical.Image](../Image.md#ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Image)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated images.

<a id="TopologyDensity.InternalObject"></a>

### *property* TopologyDensity.InternalObject *: Ansys.Common.Interop.DSObjectsAuto.IDSResultAuto | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the internal object. For advanced usage only.

<a id="TopologyDensity.IterationNumber"></a>

### *property* TopologyDensity.IterationNumber *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the IterationNumber.

<a id="TopologyDensity.IterationStep"></a>

### *property* TopologyDensity.IterationStep *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the IterationStep.

<a id="TopologyDensity.Location"></a>

### *property* TopologyDensity.Location *: Ansys.ACT.Interfaces.Common.ISelectionInfo | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Location.

<a id="TopologyDensity.Maximum"></a>

### *property* TopologyDensity.Maximum *: [float](https://docs.python.org/3/library/functions.html#float) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the Maximum.

<a id="TopologyDensity.Minimum"></a>

### *property* TopologyDensity.Minimum *: [float](https://docs.python.org/3/library/functions.html#float) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the Minimum.

<a id="TopologyDensity.OriginalMass"></a>

### *property* TopologyDensity.OriginalMass *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the OriginalMass.

<a id="TopologyDensity.OriginalVolume"></a>

### *property* TopologyDensity.OriginalVolume *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the OriginalVolume.

<a id="TopologyDensity.PercentMassOfOriginal"></a>

### *property* TopologyDensity.PercentMassOfOriginal *: [float](https://docs.python.org/3/library/functions.html#float) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the PercentMassOfOriginal.

<a id="TopologyDensity.PercentVolumeOfOriginal"></a>

### *property* TopologyDensity.PercentVolumeOfOriginal *: [float](https://docs.python.org/3/library/functions.html#float) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the PercentVolumeOfOriginal.

<a id="TopologyDensity.Properties"></a>

### *property* TopologyDensity.Properties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties for this object.

<a id="TopologyDensity.RetainedThreshold"></a>

### *property* TopologyDensity.RetainedThreshold *: [float](https://docs.python.org/3/library/functions.html#float) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the RetainedThreshold.

<a id="TopologyDensity.ScopingMethod"></a>

### *property* TopologyDensity.ScopingMethod *: [Ansys.Mechanical.DataModel.Enums.GeometryDefineByType](../../../../Mechanical/DataModel/Enums/GeometryDefineByType.md#ansys.mechanical.stubs.v241.Ansys.Mechanical.DataModel.Enums.GeometryDefineByType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ScopingMethod.

<a id="TopologyDensity.Selection"></a>

### *property* TopologyDensity.Selection *: [Ansys.ACT.Automation.Mechanical.OptimizationRegion](../OptimizationRegion.md#ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.OptimizationRegion) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Selection.

<a id="TopologyDensity.ShowOptimizedRegion"></a>

### *property* TopologyDensity.ShowOptimizedRegion *: [Ansys.Mechanical.DataModel.Enums.TopologyOptimizationResultShowType](../../../../Mechanical/DataModel/Enums/TopologyOptimizationResultShowType.md#ansys.mechanical.stubs.v241.Ansys.Mechanical.DataModel.Enums.TopologyOptimizationResultShowType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ShowOptimizedRegion.

<a id="TopologyDensity.Suppressed"></a>

### *property* TopologyDensity.Suppressed *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Suppressed.

<a id="TopologyDensity.VisibleProperties"></a>

### *property* TopologyDensity.VisibleProperties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

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

<a id="method-detail"></a>

## Method detail

<a id="TopologyDensity.Activate"></a>

### TopologyDensity.Activate()

Activate the current object.

<a id="TopologyDensity.AddComment"></a>

### TopologyDensity.AddComment()

Creates a new child Comment.

<a id="TopologyDensity.AddFigure"></a>

### TopologyDensity.AddFigure()

Creates a new child Figure.

<a id="TopologyDensity.AddImage"></a>

### TopologyDensity.AddImage(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str))

```text
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.

```

<a id="TopologyDensity.AddSmoothing"></a>

### TopologyDensity.AddSmoothing()

Creates a new Smoothing

<a id="TopologyDensity.ClearGeneratedData"></a>

### TopologyDensity.ClearGeneratedData()

Clears the result.

<a id="TopologyDensity.CopyTo"></a>

### TopologyDensity.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

<a id="TopologyDensity.CreateParameter"></a>

### TopologyDensity.CreateParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Creates a new parameter for a Property.

<a id="TopologyDensity.Delete"></a>

### TopologyDensity.Delete()

Run the Delete action.

<a id="TopologyDensity.Duplicate"></a>

### TopologyDensity.Duplicate()

Creates a copy of the current DataModelObject.

<a id="TopologyDensity.EvaluateAllResults"></a>

### TopologyDensity.EvaluateAllResults()

Run the EvaluateAllResults action.

<a id="TopologyDensity.ExportAnimation"></a>

### TopologyDensity.ExportAnimation(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str), format: [Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat](../../../../Mechanical/DataModel/Enums/GraphicsAnimationExportFormat.md#ansys.mechanical.stubs.v241.Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat), settings: [Ansys.Mechanical.Graphics.AnimationExportSettings](../../../../Mechanical/Graphics/AnimationExportSettings.md#ansys.mechanical.stubs.v241.Ansys.Mechanical.Graphics.AnimationExportSettings))

Run the ExportAnimation action.

<a id="TopologyDensity.GetChildren"></a>

### TopologyDensity.GetChildren(recurses: [bool](https://docs.python.org/3/library/functions.html#bool), children: List\[ChildrenType\])

Gets the list of children, filtered by type.

<a id="TopologyDensity.GetParameter"></a>

### TopologyDensity.GetParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Gets the parameter corresponding to the given property.

<a id="TopologyDensity.GroupAllSimilarChildren"></a>

### TopologyDensity.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

<a id="TopologyDensity.GroupSimilarObjects"></a>

### TopologyDensity.GroupSimilarObjects()

Run the GroupSimilarObjects action.

<a id="TopologyDensity.InsertSmoothing"></a>

### TopologyDensity.InsertSmoothing()

Run the InsertSmoothing action.

<a id="TopologyDensity.PropertyByAPIName"></a>

### TopologyDensity.PropertyByAPIName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

```text
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.

```

<a id="TopologyDensity.PropertyByName"></a>

### TopologyDensity.PropertyByName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

Get a property by its unique name.

<a id="TopologyDensity.RemoveParameter"></a>

### TopologyDensity.RemoveParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

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

<a id="TopologyDensity.RenameBasedOnDefinition"></a>

### TopologyDensity.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.