## On this page

  

 

 # `DistributedMass`

 Last update: 16.07.2025 

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

#### *class* Ansys.ACT.Automation.Mechanical.DistributedMass

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

Defines a DistributedMass.

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

## Overview

### Methods

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

NameDescription[`Children`](#DistributedMass.Children)Gets the list of children.[`Comments`](#DistributedMass.Comments)Gets the list of associated comments.[`DataModelObjectCategory`](#DistributedMass.DataModelObjectCategory)Gets the current DataModelObject’s category.[`ElementAPDLName`](#DistributedMass.ElementAPDLName)Gets or sets the ElementAPDLName.[`Figures`](#DistributedMass.Figures)Gets the list of associated figures.[`Images`](#DistributedMass.Images)Gets the list of associated images.[`InternalObject`](#DistributedMass.InternalObject)Gets the internal object. For advanced usage only.[`IsDistributedMass`](#DistributedMass.IsDistributedMass)Gets the IsDistributedMass.[`Location`](#DistributedMass.Location)Gets or sets the Geometry.[`MassPerUnitArea`](#DistributedMass.MassPerUnitArea)Gets or sets the MassPerUnitArea.[`MassType`](#DistributedMass.MassType)Gets or sets the MassType.[`Properties`](#DistributedMass.Properties)Gets the list of properties for this object.[`ReadOnly`](#DistributedMass.ReadOnly)Gets or sets the ReadOnly.[`RemotePoint`](#DistributedMass.RemotePoint)Gets the remote point associated to the point mass.[`Suppressed`](#DistributedMass.Suppressed)Gets or sets the Suppressed.[`TotalMass`](#DistributedMass.TotalMass)Gets or sets the TotalMass.[`VisibleProperties`](#DistributedMass.VisibleProperties)Gets the list of properties that are visible for this object.<a id="property-detail"></a>

## Property detail

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

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

Gets the list of children.

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

### *property* DistributedMass.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="DistributedMass.DataModelObjectCategory"></a>

### *property* DistributedMass.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="DistributedMass.ElementAPDLName"></a>

### *property* DistributedMass.ElementAPDLName *: [str](https://docs.python.org/3/library/stdtypes.html#str) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ElementAPDLName.

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

### *property* DistributedMass.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="DistributedMass.Images"></a>

### *property* DistributedMass.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="DistributedMass.InternalObject"></a>

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

Gets the internal object. For advanced usage only.

<a id="DistributedMass.IsDistributedMass"></a>

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

Gets the IsDistributedMass.

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

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

Gets or sets the Geometry.

<a id="DistributedMass.MassPerUnitArea"></a>

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

Gets or sets the MassPerUnitArea.

<a id="DistributedMass.MassType"></a>

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

Gets or sets the MassType.

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

### *property* DistributedMass.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="DistributedMass.ReadOnly"></a>

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

Gets or sets the ReadOnly.

<a id="DistributedMass.RemotePoint"></a>

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

Gets the remote point associated to the point mass.

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

### *property* DistributedMass.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="DistributedMass.TotalMass"></a>

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

Gets or sets the TotalMass.

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

### *property* DistributedMass.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="DistributedMass.Activate"></a>

### DistributedMass.Activate()

Activate the current object.

<a id="DistributedMass.AddCommandSnippet"></a>

### DistributedMass.AddCommandSnippet()

Creates a new CommandSnippet

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

### DistributedMass.AddComment()

Creates a new child Comment.

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

### DistributedMass.AddFigure()

Creates a new child Figure.

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

### DistributedMass.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="DistributedMass.CopyTo"></a>

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

Copies all visible properties from this object to another.

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

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

Creates a new parameter for a Property.

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

### DistributedMass.Delete()

Run the Delete action.

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

### DistributedMass.Duplicate()

Creates a copy of the current DataModelObject.

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

### DistributedMass.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="DistributedMass.GetParameter"></a>

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

Gets the parameter corresponding to the given property.

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

### DistributedMass.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

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

### DistributedMass.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

### DistributedMass.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="DistributedMass.PropertyByName"></a>

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

Get a property by its unique name.

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

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

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