AcousticPortInDuct

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.BoundaryConditions.AcousticPortInDuct

Bases: object

Defines a AcousticPortInDuct.

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.
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

AnglePhi	Gets or sets the AnglePhi.
AngleTheta	Gets or sets the AngleTheta.
Children	Gets the list of children.
Comments	Gets the list of associated comments.
CoordinateSystem	Gets or sets the CoordinateSystem.
DataModelObjectCategory	Gets the current DataModelObject's category.
Figures	Gets the list of associated figures.
Height	Gets or sets the Height.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
Location	Gets or sets the Location.
ModeIndexForPressureVariationAlongTheAzimuth	Gets or sets the ModeIndexForPressureVariationAlongTheAzimuth.
ModeIndexForPressureVariationAlongTheHeight	Gets or sets the ModeIndexForPressureVariationAlongTheHeight.
ModeIndexForPressureVariationAlongTheRadii	Gets or sets the ModeIndexForPressureVariationAlongTheRadii.
ModeIndexForPressureVariationAlongTheWidth	Gets or sets the ModeIndexForPressureVariationAlongTheWidth.
PhaseAngle	Gets or sets the PhaseAngle.
PortAttribution	Gets or sets the PortAttribution.
PortSelection	Gets or sets the PortSelection.
PressureAmplitude	Gets or sets the PressureAmplitude.
Properties	Gets the list of properties for this object.
Radius	Gets or sets the Radius.
ReadOnly	Gets or sets the ReadOnly.
SharedRefBody	Gets or sets the SharedRefBody.
Suppressed	Gets or sets the Suppressed.
VisibleProperties	Gets the list of properties that are visible for this object.
WaveType	Gets or sets the WaveType.
Width	Gets or sets the Width.

Property detail

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

Gets or sets the AnglePhi.

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

Gets or sets the AngleTheta.

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

Gets the list of children.

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

Gets the list of associated comments.

property AcousticPortInDuct.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the CoordinateSystem.

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

Gets the current DataModelObject's category.

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

Gets the list of associated figures.

property AcousticPortInDuct.Height: Ansys.Core.Units.Quantity | None

Gets or sets the Height.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

property AcousticPortInDuct.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Location.

property AcousticPortInDuct.ModeIndexForPressureVariationAlongTheAzimuth: int | None

Gets or sets the ModeIndexForPressureVariationAlongTheAzimuth.

property AcousticPortInDuct.ModeIndexForPressureVariationAlongTheHeight: int | None

Gets or sets the ModeIndexForPressureVariationAlongTheHeight.

property AcousticPortInDuct.ModeIndexForPressureVariationAlongTheRadii: int | None

Gets or sets the ModeIndexForPressureVariationAlongTheRadii.

property AcousticPortInDuct.ModeIndexForPressureVariationAlongTheWidth: int | None

Gets or sets the ModeIndexForPressureVariationAlongTheWidth.

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

Gets or sets the PhaseAngle.

property AcousticPortInDuct.PortAttribution: Ansys.Mechanical.DataModel.Enums.PortAttribution | None

Gets or sets the PortAttribution.

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

Gets or sets the PortSelection.

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

Gets or sets the PressureAmplitude.

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

Gets the list of properties for this object.

property AcousticPortInDuct.Radius: Ansys.Core.Units.Quantity | None

Gets or sets the Radius.

property AcousticPortInDuct.ReadOnly: bool | None

Gets or sets the ReadOnly.

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

Gets or sets the SharedRefBody.

property AcousticPortInDuct.Suppressed: bool | None

Gets or sets the Suppressed.

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

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

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

Gets or sets the WaveType.

property AcousticPortInDuct.Width: Ansys.Core.Units.Quantity | None

Gets or sets the Width.

Method detail

AcousticPortInDuct.Activate() → None

Activate the current object.

AcousticPortInDuct.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

AcousticPortInDuct.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

AcousticPortInDuct.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.

AcousticPortInDuct.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

AcousticPortInDuct.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

AcousticPortInDuct.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

Run the PromoteToNamedSelection action.

AcousticPortInDuct.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.

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

Get a property by its unique name.

AcousticPortInDuct.RemoveParameter(propName: str) → None

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