`AcousticIncidentWaveSource`#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.BoundaryConditions.AcousticIncidentWaveSource#

Bases: object

Defines a AcousticIncidentWaveSource.

Overview#

Methods

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

Properties

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

Property detail#

property AcousticIncidentWaveSource.PressureAmplitude: Ansys.Core.Units.Quantity | None: Gets or sets the PressureAmplitude.

property AcousticIncidentWaveSource.VelocityAmplitude: Ansys.Core.Units.Quantity | None: Gets or sets the VelocityAmplitude.

property AcousticIncidentWaveSource.MaterialAssignment: System.String | None: Gets or sets the Material.

property AcousticIncidentWaveSource.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSLoadAuto | None: Gets the internal object. For advanced usage only.

property AcousticIncidentWaveSource.Material: System.String | None: Gets or sets the Material.

property AcousticIncidentWaveSource.WaveNumber: System.UInt32 | None: Gets the WaveNumber.

property AcousticIncidentWaveSource.XComponentOfUnitDipoleVector: System.Double | None: Gets or sets the XComponentOfUnitDipoleVector.

property AcousticIncidentWaveSource.YComponentOfUnitDipoleVector: System.Double | None: Gets or sets the YComponentOfUnitDipoleVector.

property AcousticIncidentWaveSource.ZComponentOfUnitDipoleVector: System.Double | None: Gets or sets the ZComponentOfUnitDipoleVector.

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.DipoleLength: Ansys.Core.Units.Quantity | None: Gets or sets the DipoleLength.

property AcousticIncidentWaveSource.MassDensity: Ansys.Core.Units.Quantity | None: Gets or sets the MassDensity.

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.PhaseAngle: Ansys.Core.Units.Quantity | None: Gets or sets the PhaseAngle.

property AcousticIncidentWaveSource.RadiusOfPulsatingSphere: Ansys.Core.Units.Quantity | None: Gets or sets the RadiusOfPulsatingSphere.

property AcousticIncidentWaveSource.SpeedOfSound: Ansys.Core.Units.Quantity | None: Gets or sets the SpeedOfSound.

property AcousticIncidentWaveSource.IncidentWaveLocation: Ansys.Mechanical.DataModel.Enums.IncidentWaveLocation | None: Gets or sets the IncidentWaveLocation.

property AcousticIncidentWaveSource.ExcitationType: Ansys.Mechanical.DataModel.Enums.ExcitationType | None: Gets or sets the ExcitationType.

property AcousticIncidentWaveSource.WaveType: Ansys.Mechanical.DataModel.Enums.WaveType | None: Gets or sets the WaveType.

property AcousticIncidentWaveSource.CalculateIncidentPower: System.Boolean | None: Gets or sets the CalculateIncidentPower.

property AcousticIncidentWaveSource.PortSelection: Ansys.ACT.Automation.Mechanical.BoundaryConditions.AcousticPort | None: Gets or sets the PortSelection.

property AcousticIncidentWaveSource.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property AcousticIncidentWaveSource.Suppressed: System.Boolean | None: Gets or sets the Suppressed.

property AcousticIncidentWaveSource.SharedRefBody: Ansys.ACT.Automation.Mechanical.Body | None: Gets or sets the SharedRefBody.

property AcousticIncidentWaveSource.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property AcousticIncidentWaveSource.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property AcousticIncidentWaveSource.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property AcousticIncidentWaveSource.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property AcousticIncidentWaveSource.ReadOnly: System.Boolean | None: Gets or sets the ReadOnly.

property AcousticIncidentWaveSource.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property AcousticIncidentWaveSource.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property AcousticIncidentWaveSource.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

AcousticIncidentWaveSource.PromoteToNamedSelection() → System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.NamedSelection]: Run the PromoteToNamedSelection action.

AcousticIncidentWaveSource.Delete() → System.Void: Run the Delete action.

AcousticIncidentWaveSource.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

AcousticIncidentWaveSource.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

AcousticIncidentWaveSource.AddComment() → Ansys.ACT.Automation.Mechanical.Comment: Creates a new child Comment.

AcousticIncidentWaveSource.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure: Creates a new child Figure.

AcousticIncidentWaveSource.AddImage(filePath: System.String) → Ansys.ACT.Automation.Mechanical.Image

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.Activate() → System.Void: Activate the current object.

AcousticIncidentWaveSource.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

AcousticIncidentWaveSource.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

AcousticIncidentWaveSource.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

AcousticIncidentWaveSource.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

AcousticIncidentWaveSource.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

AcousticIncidentWaveSource.PropertyByAPIName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property

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.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

AcousticIncidentWaveSource.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

AcousticIncidentWaveSource.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.