## On this page

  

 

 # `AcousticIncidentWaveSource`

 Last update: 09.03.2026 

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

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

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

Defines a AcousticIncidentWaveSource.

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

## Overview

### Methods

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

NameDescription[`AnglePhi`](#AcousticIncidentWaveSource.AnglePhi)Gets or sets the AnglePhi.[`AngleTheta`](#AcousticIncidentWaveSource.AngleTheta)Gets or sets the AngleTheta.[`CalculateIncidentPower`](#AcousticIncidentWaveSource.CalculateIncidentPower)Gets or sets the CalculateIncidentPower.[`Children`](#AcousticIncidentWaveSource.Children)Gets the list of children.[`Comments`](#AcousticIncidentWaveSource.Comments)Gets the list of associated comments.[`DataModelObjectCategory`](#AcousticIncidentWaveSource.DataModelObjectCategory)Gets the current DataModelObject’s category.[`DipoleLength`](#AcousticIncidentWaveSource.DipoleLength)Gets or sets the DipoleLength.[`ExcitationType`](#AcousticIncidentWaveSource.ExcitationType)Gets or sets the ExcitationType.[`Figures`](#AcousticIncidentWaveSource.Figures)Gets the list of associated figures.[`Images`](#AcousticIncidentWaveSource.Images)Gets the list of associated images.[`IncidentWaveLocation`](#AcousticIncidentWaveSource.IncidentWaveLocation)Gets or sets the IncidentWaveLocation.[`InternalObject`](#AcousticIncidentWaveSource.InternalObject)Gets the internal object. For advanced usage only.[`MassDensity`](#AcousticIncidentWaveSource.MassDensity)Gets or sets the MassDensity.[`Material`](#AcousticIncidentWaveSource.Material)Gets or sets the Material.[`MaterialAssignment`](#AcousticIncidentWaveSource.MaterialAssignment)Gets or sets the Material.[`PhaseAngle`](#AcousticIncidentWaveSource.PhaseAngle)Gets or sets the PhaseAngle.[`PortSelection`](#AcousticIncidentWaveSource.PortSelection)Gets or sets the PortSelection.[`PressureAmplitude`](#AcousticIncidentWaveSource.PressureAmplitude)Gets or sets the PressureAmplitude.[`Properties`](#AcousticIncidentWaveSource.Properties)Gets the list of properties for this object.[`RadiusOfPulsatingSphere`](#AcousticIncidentWaveSource.RadiusOfPulsatingSphere)Gets or sets the RadiusOfPulsatingSphere.[`ReadOnly`](#AcousticIncidentWaveSource.ReadOnly)Gets or sets the ReadOnly.[`SharedRefBody`](#AcousticIncidentWaveSource.SharedRefBody)Gets or sets the SharedRefBody.[`SourceOriginX`](#AcousticIncidentWaveSource.SourceOriginX)Gets or sets the SourceOriginX.[`SourceOriginY`](#AcousticIncidentWaveSource.SourceOriginY)Gets or sets the SourceOriginY.[`SourceOriginZ`](#AcousticIncidentWaveSource.SourceOriginZ)Gets or sets the SourceOriginZ.[`SpeedOfSound`](#AcousticIncidentWaveSource.SpeedOfSound)Gets or sets the SpeedOfSound.[`Suppressed`](#AcousticIncidentWaveSource.Suppressed)Gets or sets the Suppressed.[`VelocityAmplitude`](#AcousticIncidentWaveSource.VelocityAmplitude)Gets or sets the VelocityAmplitude.[`VisibleProperties`](#AcousticIncidentWaveSource.VisibleProperties)Gets the list of properties that are visible for this object.[`WaveNumber`](#AcousticIncidentWaveSource.WaveNumber)Gets the WaveNumber.[`WaveType`](#AcousticIncidentWaveSource.WaveType)Gets or sets the WaveType.[`XComponentOfUnitDipoleVector`](#AcousticIncidentWaveSource.XComponentOfUnitDipoleVector)Gets or sets the XComponentOfUnitDipoleVector.[`YComponentOfUnitDipoleVector`](#AcousticIncidentWaveSource.YComponentOfUnitDipoleVector)Gets or sets the YComponentOfUnitDipoleVector.[`ZComponentOfUnitDipoleVector`](#AcousticIncidentWaveSource.ZComponentOfUnitDipoleVector)Gets or sets the ZComponentOfUnitDipoleVector.<a id="property-detail"></a>

## Property detail

<a id="AcousticIncidentWaveSource.AnglePhi"></a>

### *property* AcousticIncidentWaveSource.AnglePhi *: [Ansys.Core.Units.Quantity](../../../../Core/Units/Quantity.md#ansys.mechanical.stubs.v252.Ansys.Core.Units.Quantity) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the AnglePhi.

<a id="AcousticIncidentWaveSource.AngleTheta"></a>

### *property* AcousticIncidentWaveSource.AngleTheta *: [Ansys.Core.Units.Quantity](../../../../Core/Units/Quantity.md#ansys.mechanical.stubs.v252.Ansys.Core.Units.Quantity) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the AngleTheta.

<a id="AcousticIncidentWaveSource.CalculateIncidentPower"></a>

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

Gets or sets the CalculateIncidentPower.

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

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

Gets the list of children.

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

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

Gets the list of associated comments.

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

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

Gets the current DataModelObject’s category.

<a id="AcousticIncidentWaveSource.DipoleLength"></a>

### *property* AcousticIncidentWaveSource.DipoleLength *: [Ansys.Core.Units.Quantity](../../../../Core/Units/Quantity.md#ansys.mechanical.stubs.v252.Ansys.Core.Units.Quantity) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the DipoleLength.

<a id="AcousticIncidentWaveSource.ExcitationType"></a>

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

Gets or sets the ExcitationType.

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

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

Gets the list of associated figures.

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

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

Gets the list of associated images.

<a id="AcousticIncidentWaveSource.IncidentWaveLocation"></a>

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

Gets or sets the IncidentWaveLocation.

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

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

### *property* AcousticIncidentWaveSource.MassDensity *: [Ansys.Core.Units.Quantity](../../../../Core/Units/Quantity.md#ansys.mechanical.stubs.v252.Ansys.Core.Units.Quantity) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the MassDensity.

<a id="AcousticIncidentWaveSource.Material"></a>

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

Gets or sets the Material.

<a id="AcousticIncidentWaveSource.MaterialAssignment"></a>

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

Gets or sets the Material.

<a id="AcousticIncidentWaveSource.PhaseAngle"></a>

### *property* AcousticIncidentWaveSource.PhaseAngle *: [Ansys.Core.Units.Quantity](../../../../Core/Units/Quantity.md#ansys.mechanical.stubs.v252.Ansys.Core.Units.Quantity) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the PhaseAngle.

<a id="AcousticIncidentWaveSource.PortSelection"></a>

### *property* AcousticIncidentWaveSource.PortSelection *: [Ansys.ACT.Automation.Mechanical.BoundaryConditions.AcousticPort](AcousticPort.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.BoundaryConditions.AcousticPort) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the PortSelection.

<a id="AcousticIncidentWaveSource.PressureAmplitude"></a>

### *property* AcousticIncidentWaveSource.PressureAmplitude *: [Ansys.Core.Units.Quantity](../../../../Core/Units/Quantity.md#ansys.mechanical.stubs.v252.Ansys.Core.Units.Quantity) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the PressureAmplitude.

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

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

### *property* AcousticIncidentWaveSource.RadiusOfPulsatingSphere *: [Ansys.Core.Units.Quantity](../../../../Core/Units/Quantity.md#ansys.mechanical.stubs.v252.Ansys.Core.Units.Quantity) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the RadiusOfPulsatingSphere.

<a id="AcousticIncidentWaveSource.ReadOnly"></a>

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

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

Gets or sets the SharedRefBody.

<a id="AcousticIncidentWaveSource.SourceOriginX"></a>

### *property* AcousticIncidentWaveSource.SourceOriginX *: [Ansys.Core.Units.Quantity](../../../../Core/Units/Quantity.md#ansys.mechanical.stubs.v252.Ansys.Core.Units.Quantity) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the SourceOriginX.

<a id="AcousticIncidentWaveSource.SourceOriginY"></a>

### *property* AcousticIncidentWaveSource.SourceOriginY *: [Ansys.Core.Units.Quantity](../../../../Core/Units/Quantity.md#ansys.mechanical.stubs.v252.Ansys.Core.Units.Quantity) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the SourceOriginY.

<a id="AcousticIncidentWaveSource.SourceOriginZ"></a>

### *property* AcousticIncidentWaveSource.SourceOriginZ *: [Ansys.Core.Units.Quantity](../../../../Core/Units/Quantity.md#ansys.mechanical.stubs.v252.Ansys.Core.Units.Quantity) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the SourceOriginZ.

<a id="AcousticIncidentWaveSource.SpeedOfSound"></a>

### *property* AcousticIncidentWaveSource.SpeedOfSound *: [Ansys.Core.Units.Quantity](../../../../Core/Units/Quantity.md#ansys.mechanical.stubs.v252.Ansys.Core.Units.Quantity) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the SpeedOfSound.

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

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

### *property* AcousticIncidentWaveSource.VelocityAmplitude *: [Ansys.Core.Units.Quantity](../../../../Core/Units/Quantity.md#ansys.mechanical.stubs.v252.Ansys.Core.Units.Quantity) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the VelocityAmplitude.

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

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

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

Gets the WaveNumber.

<a id="AcousticIncidentWaveSource.WaveType"></a>

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

Gets or sets the WaveType.

<a id="AcousticIncidentWaveSource.XComponentOfUnitDipoleVector"></a>

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

Gets or sets the XComponentOfUnitDipoleVector.

<a id="AcousticIncidentWaveSource.YComponentOfUnitDipoleVector"></a>

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

Gets or sets the YComponentOfUnitDipoleVector.

<a id="AcousticIncidentWaveSource.ZComponentOfUnitDipoleVector"></a>

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

Gets or sets the ZComponentOfUnitDipoleVector.

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

## Method detail

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

### AcousticIncidentWaveSource.Activate() → [None](https://docs.python.org/3/library/constants.html#None)

Activate the current object.

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

### AcousticIncidentWaveSource.AddComment() → [Ansys.ACT.Automation.Mechanical.Comment](../Comment.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Comment)

Creates a new child Comment.

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

### AcousticIncidentWaveSource.AddFigure() → [Ansys.ACT.Automation.Mechanical.Figure](../Figure.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Figure)

Creates a new child Figure.

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

### AcousticIncidentWaveSource.AddImage(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str)) → [Ansys.ACT.Automation.Mechanical.Image](../Image.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.Image)

```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="AcousticIncidentWaveSource.CopyTo"></a>

### AcousticIncidentWaveSource.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → [None](https://docs.python.org/3/library/constants.html#None)

Copies all visible properties from this object to another.

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

### AcousticIncidentWaveSource.CreateParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

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

### AcousticIncidentWaveSource.Delete() → [None](https://docs.python.org/3/library/constants.html#None)

Run the Delete action.

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

### AcousticIncidentWaveSource.Duplicate() → [Ansys.Mechanical.DataModel.Interfaces.IDataModelObject](../../../../Mechanical/DataModel/Interfaces/IDataModelObject.md#ansys.mechanical.stubs.v252.Ansys.Mechanical.DataModel.Interfaces.IDataModelObject)

Creates a copy of the current DataModelObject.

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

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

Gets the list of children, filtered by type.

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

### AcousticIncidentWaveSource.GetParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

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

### AcousticIncidentWaveSource.GroupAllSimilarChildren() → [None](https://docs.python.org/3/library/constants.html#None)

Run the GroupAllSimilarChildren action.

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

### AcousticIncidentWaveSource.GroupSimilarObjects() → [Ansys.ACT.Automation.Mechanical.TreeGroupingFolder](../TreeGroupingFolder.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.TreeGroupingFolder)

Run the GroupSimilarObjects action.

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

### AcousticIncidentWaveSource.PromoteToNamedSelection() → Iterable\[[Ansys.ACT.Automation.Mechanical.NamedSelection](../NamedSelection.md#ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.NamedSelection)\]

Run the PromoteToNamedSelection action.

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

### AcousticIncidentWaveSource.PropertyByAPIName(name: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Automation.Mechanical.Property

```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="AcousticIncidentWaveSource.PropertyByName"></a>

### AcousticIncidentWaveSource.PropertyByName(name: [str](https://docs.python.org/3/library/stdtypes.html#str)) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

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

### AcousticIncidentWaveSource.RemoveParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str)) → [None](https://docs.python.org/3/library/constants.html#None)

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