Skip to main content

Mechanical scripting interface

AcousticIncidentWaveSource

Last update: 14.01.2025

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

Bases: object

Defines a AcousticIncidentWaveSource.

Overview

Methods

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

Properties

Name Description
AnglePhi Gets or sets the AnglePhi.
AngleTheta Gets or sets the AngleTheta.
CalculateIncidentPower Gets or sets the CalculateIncidentPower.
Children Gets the list of children.
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the current DataModelObject’s category.
DipoleLength Gets or sets the DipoleLength.
ExcitationType Gets or sets the ExcitationType.
Figures Gets the list of associated figures.
Images Gets the list of associated images.
IncidentWaveLocation Gets or sets the IncidentWaveLocation.
InternalObject Gets the internal object. For advanced usage only.
MassDensity Gets or sets the MassDensity.
Material Gets or sets the Material.
MaterialAssignment Gets or sets the Material.
PhaseAngle Gets or sets the PhaseAngle.
PortSelection Gets or sets the PortSelection.
PressureAmplitude Gets or sets the PressureAmplitude.
Properties Gets the list of properties for this object.
RadiusOfPulsatingSphere Gets or sets the RadiusOfPulsatingSphere.
ReadOnly Gets or sets the ReadOnly.
SharedRefBody Gets or sets the SharedRefBody.
SourceOriginX Gets or sets the SourceOriginX.
SourceOriginY Gets or sets the SourceOriginY.
SourceOriginZ Gets or sets the SourceOriginZ.
SpeedOfSound Gets or sets the SpeedOfSound.
Suppressed Gets or sets the Suppressed.
VelocityAmplitude Gets or sets the VelocityAmplitude.
VisibleProperties Gets the list of properties that are visible for this object.
WaveNumber Gets the WaveNumber.
WaveType Gets or sets the WaveType.
XComponentOfUnitDipoleVector Gets or sets the XComponentOfUnitDipoleVector.
YComponentOfUnitDipoleVector Gets or sets the YComponentOfUnitDipoleVector.
ZComponentOfUnitDipoleVector Gets or sets the ZComponentOfUnitDipoleVector.

Property detail

property AcousticIncidentWaveSource.AnglePhi : Ansys.Core.Units.Quantity | None

Gets or sets the AnglePhi.

property AcousticIncidentWaveSource.AngleTheta : Ansys.Core.Units.Quantity | None

Gets or sets the AngleTheta.

property AcousticIncidentWaveSource.CalculateIncidentPower : bool | None

Gets or sets the CalculateIncidentPower.

property AcousticIncidentWaveSource.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property AcousticIncidentWaveSource.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property AcousticIncidentWaveSource.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject’s category.

property AcousticIncidentWaveSource.DipoleLength : Ansys.Core.Units.Quantity | None

Gets or sets the DipoleLength.

property AcousticIncidentWaveSource.ExcitationType : Ansys.Mechanical.DataModel.Enums.ExcitationType | None

Gets or sets the ExcitationType.

property AcousticIncidentWaveSource.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property AcousticIncidentWaveSource.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property AcousticIncidentWaveSource.IncidentWaveLocation : Ansys.Mechanical.DataModel.Enums.IncidentWaveLocation | None

Gets or sets the IncidentWaveLocation.

property AcousticIncidentWaveSource.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None

Gets the internal object. For advanced usage only.

property AcousticIncidentWaveSource.MassDensity : Ansys.Core.Units.Quantity | None

Gets or sets the MassDensity.

property AcousticIncidentWaveSource.Material : str | None

Gets or sets the Material.

property AcousticIncidentWaveSource.MaterialAssignment : str | None

Gets or sets the Material.

property AcousticIncidentWaveSource.PhaseAngle : Ansys.Core.Units.Quantity | None

Gets or sets the PhaseAngle.

property AcousticIncidentWaveSource.PortSelection : Ansys.ACT.Automation.Mechanical.BoundaryConditions.AcousticPort | None

Gets or sets the PortSelection.

property AcousticIncidentWaveSource.PressureAmplitude : Ansys.Core.Units.Quantity | None

Gets or sets the PressureAmplitude.

property AcousticIncidentWaveSource.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property AcousticIncidentWaveSource.RadiusOfPulsatingSphere : Ansys.Core.Units.Quantity | None

Gets or sets the RadiusOfPulsatingSphere.

property AcousticIncidentWaveSource.ReadOnly : bool | None

Gets or sets the ReadOnly.

property AcousticIncidentWaveSource.SharedRefBody : Ansys.ACT.Automation.Mechanical.Body | None

Gets or sets the SharedRefBody.

property AcousticIncidentWaveSource.SourceOriginX : Ansys.Core.Units.Quantity | None

Gets or sets the SourceOriginX.

property AcousticIncidentWaveSource.SourceOriginY : Ansys.Core.Units.Quantity | None

Gets or sets the SourceOriginY.

property AcousticIncidentWaveSource.SourceOriginZ : Ansys.Core.Units.Quantity | None

Gets or sets the SourceOriginZ.

property AcousticIncidentWaveSource.SpeedOfSound : Ansys.Core.Units.Quantity | None

Gets or sets the SpeedOfSound.

property AcousticIncidentWaveSource.Suppressed : bool | None

Gets or sets the Suppressed.

property AcousticIncidentWaveSource.VelocityAmplitude : Ansys.Core.Units.Quantity | None

Gets or sets the VelocityAmplitude.

property AcousticIncidentWaveSource.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties that are visible for this object.

property AcousticIncidentWaveSource.WaveNumber : int | None

Gets the WaveNumber.

property AcousticIncidentWaveSource.WaveType : Ansys.Mechanical.DataModel.Enums.WaveType | None

Gets or sets the WaveType.

property AcousticIncidentWaveSource.XComponentOfUnitDipoleVector : float | None

Gets or sets the XComponentOfUnitDipoleVector.

property AcousticIncidentWaveSource.YComponentOfUnitDipoleVector : float | None

Gets or sets the YComponentOfUnitDipoleVector.

property AcousticIncidentWaveSource.ZComponentOfUnitDipoleVector : float | None

Gets or sets the ZComponentOfUnitDipoleVector.

Method detail

AcousticIncidentWaveSource.Activate()

Activate the current object.

AcousticIncidentWaveSource.AddComment()

Creates a new child Comment.

AcousticIncidentWaveSource.AddFigure()

Creates a new child Figure.

AcousticIncidentWaveSource.AddImage(filePath: str)

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.

AcousticIncidentWaveSource.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

AcousticIncidentWaveSource.CreateParameter(propName: str)

Creates a new parameter for a Property.

AcousticIncidentWaveSource.Delete()

Run the Delete action.

AcousticIncidentWaveSource.Duplicate()

Creates a copy of the current DataModelObject.

AcousticIncidentWaveSource.GetChildren(recurses: bool, children: List[ChildrenType])

Gets the list of children, filtered by type.

AcousticIncidentWaveSource.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

AcousticIncidentWaveSource.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

AcousticIncidentWaveSource.GroupSimilarObjects()

Run the GroupSimilarObjects action.

AcousticIncidentWaveSource.PromoteToNamedSelection()

Run the PromoteToNamedSelection action.

AcousticIncidentWaveSource.PropertyByAPIName(name: str)

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.

AcousticIncidentWaveSource.PropertyByName(name: str)

Get a property by its unique name.

AcousticIncidentWaveSource.RemoveParameter(propName: str)

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