## On this page

  

 

 # `AcousticSurfaceAcceleration`

 Last update: 16.07.2025 

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

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

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

Defines a AcousticSurfaceAcceleration.

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

## Overview

### Methods

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

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

## Property detail

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

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

Gets the list of children.

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

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

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

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

Gets or sets the DefineBy.

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

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

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

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

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

Gets or sets the Location.

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

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

Gets or sets the Magnitude.

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

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

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

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

Gets or sets the SharedRefBody.

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

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

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

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

Gets or sets the XComponent.

<a id="AcousticSurfaceAcceleration.YComponent"></a>

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

Gets or sets the YComponent.

<a id="AcousticSurfaceAcceleration.ZComponent"></a>

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

Gets or sets the ZComponent.

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

## Method detail

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

### AcousticSurfaceAcceleration.Activate()

Activate the current object.

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

### AcousticSurfaceAcceleration.AddComment()

Creates a new child Comment.

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

### AcousticSurfaceAcceleration.AddFigure()

Creates a new child Figure.

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

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

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

Copies all visible properties from this object to another.

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

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

Creates a new parameter for a Property.

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

### AcousticSurfaceAcceleration.Delete()

Run the Delete action.

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

### AcousticSurfaceAcceleration.Duplicate()

Creates a copy of the current DataModelObject.

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

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

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

Gets the parameter corresponding to the given property.

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

### AcousticSurfaceAcceleration.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

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

### AcousticSurfaceAcceleration.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

### AcousticSurfaceAcceleration.PromoteToNamedSelection()

Run the PromoteToNamedSelection action.

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

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

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

Get a property by its unique name.

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

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

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