`AcousticDiffuseSoundField`#

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

Bases: object

Defines a AcousticDiffuseSoundField.

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

`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.
`FrequencyOfNormConvergenceCheck`	Gets or sets the FrequencyOfNormConvergenceCheck.
`Images`	Gets the list of associated images.
`InternalObject`	Gets the internal object. For advanced usage only.
`Location`	Gets or sets the Location.
`MassDensity`	Gets the MassDensity.
`Material`	Gets or sets the Material.
`MaterialAssignment`	Gets or sets the Material.
`MaximumIncidentAngle`	Gets or sets the MaximumIncidentAngle.
`NormConvergenceTolerance`	Gets or sets the NormConvergenceTolerance.
`NumberOfDivisionsOnReferenceSphere`	Gets or sets the NumberOfDivisionsOnReferenceSphere.
`NumberOfRandomSampling`	Gets or sets the NumberOfRandomSampling.
`PressureExcitation`	Gets the PressureExcitation.
`Properties`	Gets the list of properties for this object.
`RadiusOfReferenceSphere`	Gets or sets the RadiusOfReferenceSphere.
`RadiusOfReferenceSphereDefineBy`	Gets or sets the RadiusOfReferenceSphereDefineBy.
`RandomSamplingType`	Gets or sets the RandomSamplingType.
`ReadOnly`	Gets or sets the ReadOnly.
`ReferencePowerSpectralDensity`	Gets or sets the ReferencePowerSpectralDensity.
`SharedRefBody`	Gets or sets the SharedRefBody.
`SpeedOfSound`	Gets the SpeedOfSound.
`Suppressed`	Gets or sets the Suppressed.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property AcousticDiffuseSoundField.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#: Gets the list of children.

property AcousticDiffuseSoundField.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None#: Gets the list of associated comments.

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

property AcousticDiffuseSoundField.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#: Gets the current DataModelObject's category.

property AcousticDiffuseSoundField.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#: Gets the list of associated figures.

property AcousticDiffuseSoundField.FrequencyOfNormConvergenceCheck: int | None#: Gets or sets the FrequencyOfNormConvergenceCheck.

property AcousticDiffuseSoundField.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None#: Gets the list of associated images.

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

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

property AcousticDiffuseSoundField.MassDensity: Ansys.Core.Units.Quantity | None#: Gets the MassDensity.

property AcousticDiffuseSoundField.Material: str | None#: Gets or sets the Material.

property AcousticDiffuseSoundField.MaterialAssignment: str | None#: Gets or sets the Material.

property AcousticDiffuseSoundField.MaximumIncidentAngle: Ansys.Core.Units.Quantity | None#: Gets or sets the MaximumIncidentAngle.

property AcousticDiffuseSoundField.NormConvergenceTolerance: float | None#: Gets or sets the NormConvergenceTolerance.

property AcousticDiffuseSoundField.NumberOfDivisionsOnReferenceSphere: int | None#: Gets or sets the NumberOfDivisionsOnReferenceSphere.

property AcousticDiffuseSoundField.NumberOfRandomSampling: int | None#: Gets or sets the NumberOfRandomSampling.

property AcousticDiffuseSoundField.PressureExcitation: bool | None#: Gets the PressureExcitation.

property AcousticDiffuseSoundField.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#: Gets the list of properties for this object.

property AcousticDiffuseSoundField.RadiusOfReferenceSphere: Ansys.Core.Units.Quantity | None#: Gets or sets the RadiusOfReferenceSphere.

property AcousticDiffuseSoundField.RadiusOfReferenceSphereDefineBy: Ansys.Mechanical.DataModel.Enums.RadiusOfReferenceSphereDefineBy | None#: Gets or sets the RadiusOfReferenceSphereDefineBy.

property AcousticDiffuseSoundField.RandomSamplingType: Ansys.Mechanical.DataModel.Enums.RandomSamplingType | None#: Gets or sets the RandomSamplingType.

property AcousticDiffuseSoundField.ReadOnly: bool | None#: Gets or sets the ReadOnly.

property AcousticDiffuseSoundField.ReferencePowerSpectralDensity: Ansys.Core.Units.Quantity | None#: Gets or sets the ReferencePowerSpectralDensity.

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

property AcousticDiffuseSoundField.SpeedOfSound: Ansys.Core.Units.Quantity | None#: Gets the SpeedOfSound.

property AcousticDiffuseSoundField.Suppressed: bool | None#: Gets or sets the Suppressed.

property AcousticDiffuseSoundField.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#: Gets the list of properties that are visible for this object.

Method detail#

AcousticDiffuseSoundField.Activate() → None#: Activate the current object.

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

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

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

AcousticDiffuseSoundField.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None#: Copies all visible properties from this object to another.

AcousticDiffuseSoundField.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter#: Creates a new parameter for a Property.

AcousticDiffuseSoundField.Delete() → None#: Run the Delete action.

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

AcousticDiffuseSoundField.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]#: Gets the list of children, filtered by type.

AcousticDiffuseSoundField.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter#: Gets the parameter corresponding to the given property.

AcousticDiffuseSoundField.GroupAllSimilarChildren() → None#: Run the GroupAllSimilarChildren action.

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

AcousticDiffuseSoundField.PromoteToNamedSelection() → Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]#: Run the PromoteToNamedSelection action.

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

AcousticDiffuseSoundField.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property#: Get a property by its unique name.

AcousticDiffuseSoundField.RemoveParameter(propName: str) → None#: Removes the parameter from the parameter set corresponding to the given property.