`AcousticPortInDuct`#

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

Bases: object

Defines a AcousticPortInDuct.

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

`ModeIndexForPressureVariationAlongTheWidth`	Gets or sets the ModeIndexForPressureVariationAlongTheWidth.
`ModeIndexForPressureVariationAlongTheAzimuth`	Gets or sets the ModeIndexForPressureVariationAlongTheAzimuth.
`ModeIndexForPressureVariationAlongTheHeight`	Gets or sets the ModeIndexForPressureVariationAlongTheHeight.
`ModeIndexForPressureVariationAlongTheRadii`	Gets or sets the ModeIndexForPressureVariationAlongTheRadii.
`InternalObject`	Gets the internal object. For advanced usage only.
`AnglePhi`	Gets or sets the AnglePhi.
`AngleTheta`	Gets or sets the AngleTheta.
`Height`	Gets or sets the Height.
`PressureAmplitude`	Gets or sets the PressureAmplitude.
`PhaseAngle`	Gets or sets the PhaseAngle.
`Radius`	Gets or sets the Radius.
`Width`	Gets or sets the Width.
`PortAttribution`	Gets or sets the PortAttribution.
`WaveType`	Gets or sets the WaveType.
`PortSelection`	Gets or sets the PortSelection.
`CoordinateSystem`	Gets or sets the CoordinateSystem.
`Location`	Gets or sets the Location.
`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 AcousticPortInDuct.ModeIndexForPressureVariationAlongTheWidth: System.UInt32 | None: Gets or sets the ModeIndexForPressureVariationAlongTheWidth.

property AcousticPortInDuct.ModeIndexForPressureVariationAlongTheAzimuth: System.UInt32 | None: Gets or sets the ModeIndexForPressureVariationAlongTheAzimuth.

property AcousticPortInDuct.ModeIndexForPressureVariationAlongTheHeight: System.UInt32 | None: Gets or sets the ModeIndexForPressureVariationAlongTheHeight.

property AcousticPortInDuct.ModeIndexForPressureVariationAlongTheRadii: System.UInt32 | None: Gets or sets the ModeIndexForPressureVariationAlongTheRadii.

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

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

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

property AcousticPortInDuct.PhaseAngle: Ansys.Core.Units.Quantity | None: Gets or sets the PhaseAngle.

property AcousticPortInDuct.Radius: Ansys.Core.Units.Quantity | None: Gets or sets the Radius.

property AcousticPortInDuct.Width: Ansys.Core.Units.Quantity | None: Gets or sets the Width.

property AcousticPortInDuct.PortAttribution: Ansys.Mechanical.DataModel.Enums.PortAttribution | None: Gets or sets the PortAttribution.

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

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

property AcousticPortInDuct.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None: Gets or sets the CoordinateSystem.

property AcousticPortInDuct.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None: Gets or sets the Location.

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

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

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

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

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

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

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

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

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

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

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

Method detail#

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

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

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

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

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

AcousticPortInDuct.Activate() → System.Void: Activate the current object.

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

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

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

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

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

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

AcousticPortInDuct.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

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

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