## On this page

  

 

 # `SurfaceChargeDensity`

 Last update: 16.07.2025 

<a id="ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.BoundaryConditions.SurfaceChargeDensity"></a>

#### *class* Ansys.ACT.Automation.Mechanical.BoundaryConditions.SurfaceChargeDensity

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

Defines a SurfaceChargeDensity.

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

## Overview

### Methods

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

NameDescription[`Children`](#SurfaceChargeDensity.Children)Gets the list of children.[`Comments`](#SurfaceChargeDensity.Comments)Gets the list of associated comments.[`DataModelObjectCategory`](#SurfaceChargeDensity.DataModelObjectCategory)Gets the current DataModelObject’s category.[`Figures`](#SurfaceChargeDensity.Figures)Gets the list of associated figures.[`Images`](#SurfaceChargeDensity.Images)Gets the list of associated images.[`InternalObject`](#SurfaceChargeDensity.InternalObject)Gets the internal object. For advanced usage only.[`Location`](#SurfaceChargeDensity.Location)Gets or sets the Location.[`Magnitude`](#SurfaceChargeDensity.Magnitude)Gets or sets the Magnitude.[`Properties`](#SurfaceChargeDensity.Properties)Gets the list of properties for this object.[`ReadOnly`](#SurfaceChargeDensity.ReadOnly)Gets or sets the ReadOnly.[`SharedRefBody`](#SurfaceChargeDensity.SharedRefBody)Gets or sets the SharedRefBody.[`Suppressed`](#SurfaceChargeDensity.Suppressed)Gets or sets the Suppressed.[`VisibleProperties`](#SurfaceChargeDensity.VisibleProperties)Gets the list of properties that are visible for this object.<a id="property-detail"></a>

## Property detail

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

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

Gets the list of children.

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

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

Gets the list of associated comments.

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

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

Gets the current DataModelObject’s category.

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

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

Gets the list of associated figures.

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

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

Gets the list of associated images.

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

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

Gets the internal object. For advanced usage only.

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

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

Gets or sets the Location.

<a id="SurfaceChargeDensity.Magnitude"></a>

### *property* SurfaceChargeDensity.Magnitude *: [Ansys.ACT.Mechanical.Fields.Field](../../../Mechanical/Fields/Field.md#ansys.mechanical.stubs.v242.Ansys.ACT.Mechanical.Fields.Field) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Magnitude.

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

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

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

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

Gets or sets the SharedRefBody.

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

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

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

### SurfaceChargeDensity.Activate()

Activate the current object.

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

### SurfaceChargeDensity.AddComment()

Creates a new child Comment.

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

### SurfaceChargeDensity.AddFigure()

Creates a new child Figure.

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

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

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

Copies all visible properties from this object to another.

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

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

Creates a new parameter for a Property.

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

### SurfaceChargeDensity.Delete()

Run the Delete action.

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

### SurfaceChargeDensity.Duplicate()

Creates a copy of the current DataModelObject.

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

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

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

Gets the parameter corresponding to the given property.

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

### SurfaceChargeDensity.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

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

### SurfaceChargeDensity.GroupSimilarObjects()

Run the GroupSimilarObjects action.

<a id="SurfaceChargeDensity.PromoteToNamedSelection"></a>

### SurfaceChargeDensity.PromoteToNamedSelection()

Run the PromoteToNamedSelection action.

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

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

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

Get a property by its unique name.

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

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

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