AcousticIncidentWaveSource

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.BoundaryConditions.AcousticIncidentWaveSource(internalObject: Any)

Bases: object

Defines a AcousticIncidentWaveSource.

Overview

Methods

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.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetType	GetType method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PromoteToNamedSelection	Run the PromoteToNamedSelection action.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
PropertyByName	Get a property by its unique name.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
ToString	ToString method.

Properties

AnglePhi	Gets or sets the AnglePhi.
AngleTheta	Gets or sets the AngleTheta.
AttachedRefs	AttachedRefs property.
CalculateIncidentPower	Gets or sets the CalculateIncidentPower.
Children	Gets the list of children.
ClsId	ClsId property.
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.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
ImportableObjectSourceId	ImportableObjectSourceId property.
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.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
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.
State	State property.
Suppressed	Gets or sets the Suppressed.
TransferableObjectId	TransferableObjectId property.
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.AttachedRefs: List[int] | None

AttachedRefs property.

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.ClsId: int | None

ClsId property.

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.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property AcousticIncidentWaveSource.IconName: str | None

IconName property.

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

Gets the list of associated images.

property AcousticIncidentWaveSource.ImportableObjectSourceId: str | None

ImportableObjectSourceId property.

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.Name: str | None

Name property.

property AcousticIncidentWaveSource.ObjectId: int | None

ObjectId property.

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

ObjectState property.

property AcousticIncidentWaveSource.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

property AcousticIncidentWaveSource.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

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.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

property AcousticIncidentWaveSource.Suppressed: bool | None

Gets or sets the Suppressed.

property AcousticIncidentWaveSource.TransferableObjectId: str | None

TransferableObjectId property.

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() → None

Activate the current object.

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: str) → 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.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

AcousticIncidentWaveSource.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

AcousticIncidentWaveSource.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

AcousticIncidentWaveSource.Delete() → None

Run the Delete action.

AcousticIncidentWaveSource.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

AcousticIncidentWaveSource.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

AcousticIncidentWaveSource.GetAPIName(dispId: int) → str

Property name bound to dispId.

AcousticIncidentWaveSource.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

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

Gets the list of children, filtered by type.

AcousticIncidentWaveSource.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

AcousticIncidentWaveSource.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

AcousticIncidentWaveSource.GetHashCode() → int

GetHashCode method.

AcousticIncidentWaveSource.GetIconFile() → System.Byte

GetIconFile method.

AcousticIncidentWaveSource.GetLifetimeService() → Any

GetLifetimeService method.

AcousticIncidentWaveSource.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

AcousticIncidentWaveSource.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

AcousticIncidentWaveSource.GetPath() → str

GetPath method.

AcousticIncidentWaveSource.GetPropertyName(dispId: int) → str

GetPropertyName method.

AcousticIncidentWaveSource.GetPropertyValue(name: str) → Any

GetPropertyValue method.

AcousticIncidentWaveSource.GetType() → type

GetType method.

AcousticIncidentWaveSource.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

AcousticIncidentWaveSource.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

AcousticIncidentWaveSource.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

AcousticIncidentWaveSource.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

AcousticIncidentWaveSource.InitializeLifetimeService() → Any

InitializeLifetimeService method.

AcousticIncidentWaveSource.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

AcousticIncidentWaveSource.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

AcousticIncidentWaveSource.PromoteToNamedSelection() → Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]

Run the PromoteToNamedSelection action.

AcousticIncidentWaveSource.PropertyByAPIName(name: str) → 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.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

AcousticIncidentWaveSource.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

AcousticIncidentWaveSource.RemoveParameter(propName: str) → None

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

AcousticIncidentWaveSource.ToString() → str

ToString method.