## On this page

  

 

 # `AcousticSurfaceVelocity`

 Last update: 16.07.2025 

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

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

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

Defines a AcousticSurfaceVelocity.

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

## Overview

### Methods

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

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

## Property detail

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

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

Gets the list of children.

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

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

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

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

Gets or sets the DefineBy.

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

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

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

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

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

Gets or sets the Location.

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

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

### *property* AcousticSurfaceVelocity.PhaseAngle *: [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 PhaseAngle.

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

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

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

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

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

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

### *property* AcousticSurfaceVelocity.XComponent *: [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 XComponent.

<a id="AcousticSurfaceVelocity.XPhaseAngle"></a>

### *property* AcousticSurfaceVelocity.XPhaseAngle *: [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 XPhaseAngle.

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

### *property* AcousticSurfaceVelocity.YComponent *: [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 YComponent.

<a id="AcousticSurfaceVelocity.YPhaseAngle"></a>

### *property* AcousticSurfaceVelocity.YPhaseAngle *: [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 YPhaseAngle.

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

### *property* AcousticSurfaceVelocity.ZComponent *: [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 ZComponent.

<a id="AcousticSurfaceVelocity.ZPhaseAngle"></a>

### *property* AcousticSurfaceVelocity.ZPhaseAngle *: [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 ZPhaseAngle.

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

## Method detail

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

### AcousticSurfaceVelocity.Activate()

Activate the current object.

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

### AcousticSurfaceVelocity.AddComment()

Creates a new child Comment.

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

### AcousticSurfaceVelocity.AddFigure()

Creates a new child Figure.

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

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

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

Copies all visible properties from this object to another.

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

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

Creates a new parameter for a Property.

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

### AcousticSurfaceVelocity.Delete()

Run the Delete action.

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

### AcousticSurfaceVelocity.Duplicate()

Creates a copy of the current DataModelObject.

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

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

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

Gets the parameter corresponding to the given property.

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

### AcousticSurfaceVelocity.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

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

### AcousticSurfaceVelocity.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

### AcousticSurfaceVelocity.PromoteToNamedSelection()

Run the PromoteToNamedSelection action.

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

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

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

Get a property by its unique name.

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

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

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