AcousticTransmissionLoss#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Results.AcousticResults.AcousticTransmissionLoss#

Bases: object

Defines a AcousticTransmissionLoss.

Overview#

Activate

Activate the current object.

AddAlert

Creates a new Alert

AddComment

Creates a new child Comment.

AddConvergence

Creates a new Convergence

AddFigure

Creates a new child Figure.

AddImage

Creates a new child Image.

ClearGeneratedData

Run the ClearGeneratedData action.

CopyTo

Copies all visible properties from this object to another.

CreateParameter

CreateParameter method.

CreateResultsAtAllSets

Creates results at all sets for results under a solution.

Delete

Run the Delete action.

Duplicate

Creates a copy of the current DataModelObject.

DuplicateWithoutResults

Run the DuplicateWithoutResults action.

EvaluateAllResults

Run the EvaluateAllResults action.

ExportAnimation

Run the ExportAnimation action.

ExportToTextFile

Run the ExportToTextFile action.

FetchRemoteResults

Run the FetchRemoteResult action.

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.

RenameBasedOnDefinition

Run the RenameBasedOnDefinition action.

Amplitude

Gets or sets the Amplitude.

Average

Gets the Average.

By

Gets or sets the By.

CalculateTimeHistory

Gets or sets the CalculateTimeHistory.

Children

Gets the list of children.

CombinationNumber

Gets or sets the Combination Number for a Solution Combination result.

Comments

Gets the list of associated comments.

CoordinateSystem

Gets or sets the Coordinate System.

CrackFrontNumber

Gets or sets the CrackFrontNumber.

DampedFrequency

Gets the DampedFrequency.

DataModelObjectCategory

Gets the current DataModelObject's category.

DisplayOption

Gets or sets the DisplayOption.

DisplayTime

Gets or sets the DisplayTime.

DpfEvaluation

Gets or sets the DpfEvaluation.

Figures

Gets the list of associated figures.

Frequency

Gets or sets the Frequency.

FrequencyRange

Gets or sets the FrequencyRange.

GlobalIDs

Gets or sets the GlobalIDs.

GraphControlsXAxis

Gets or sets the GraphControlsXAxis.

Identifier

Gets or sets the Identifier.

Images

Gets the list of associated images.

InputPort

Gets or sets the InputPort.

InternalObject

Gets the internal object. For advanced usage only.

IsSolved

Gets the IsSolved.

ItemType

Gets or sets the ItemType.

IterationNumber

Gets the IterationNumber.

LoadStep

Gets the LoadStep.

LoadStepForMaximumOfMaximumValues

Get the Load Step for the maximum of maximum values.

LoadStepForMaximumOfMinimumValues

Get the Load Step for the maximum of minimum values.

LoadStepForMinimumOfMaximumValues

Get the Load Step for the minimum of maximum values.

LoadStepForMinimumOfMinimumValues

Get the Load Step for the minimum of minimum values.

LoadStepNumber

Gets or sets the LoadStepNumber.

Location

Gets or sets the Location.

LogarithmicDecrement

Gets the LogarithmicDecrement.

Maximum

Gets the Maximum.

MaximumFrequency

Gets or sets the MaximumFrequency.

MaximumOccursOn

Gets the MaximumOccursOn.

MaximumOfMaximumOverTime

Gets the MaximumOfMaximumOverTime.

MaximumOfMinimumOverTime

Gets the MaximumOfMinimumOverTime.

Minimum

Gets the Minimum.

MinimumFrequency

Gets or sets the MinimumFrequency.

MinimumOccursOn

Gets the MinimumOccursOn.

MinimumOfMaximumOverTime

Gets the MinimumOfMaximumOverTime.

MinimumOfMinimumOverTime

Gets the MinimumOfMinimumOverTime.

ModalDampingRatio

Gets the ModalDampingRatio.

Mode

Gets or sets the Mode.

NamedSelections

Gets or sets the NamedSelections.

OutputPort

Gets or sets the OutputPort.

Path

Path property.

PlotData

Gets the result table.

Properties

Gets the list of properties for this object.

ReportedFrequency

Gets the ReportedFrequency.

ScopingMethod

Gets or sets the ScopingMethod.

SetNumber

Gets or sets the Set Number.

SolutionCombinationDriver

Gets or sets the SolutionCombinationDriver.

SolverComponentIDs

Gets or sets the SolverComponentIDs.

Stability

Gets the Stability.

Substep

Gets the Substep.

Suppressed

Gets or sets the Suppressed.

Surface

Surface property.

SweepingPhase

Gets or sets the SweepingPhase.

Time

Gets the Time.

TimeForMaximumOfMaximumValues

Get the Time for the maximum of maximum values.

TimeForMaximumOfMinimumValues

Get the Time for the maximum of minimum values.

TimeForMinimumOfMaximumValues

Get the Time for the minimum of maximum values.

TimeForMinimumOfMinimumValues

Get the Time for the minimum of minimum values.

VisibleProperties

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

WaterfallPanelShowTextOnMosaic

Gets or sets the Waterfall Panel Mosaic Text Property.

Property detail#

property AcousticTransmissionLoss.Amplitude: bool | None#

Gets or sets the Amplitude.

property AcousticTransmissionLoss.Average: Ansys.Core.Units.Quantity | None#

Gets the Average.

property AcousticTransmissionLoss.By: Ansys.Mechanical.DataModel.Enums.SetDriverStyle | None#

Gets or sets the By.

property AcousticTransmissionLoss.CalculateTimeHistory: bool | None#

Gets or sets the CalculateTimeHistory.

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

Gets the list of children.

property AcousticTransmissionLoss.CombinationNumber: int | None#

Gets or sets the Combination Number for a Solution Combination result.

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

Gets the list of associated comments.

property AcousticTransmissionLoss.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

Gets or sets the Coordinate System. Accepts/Returns None for Solution Coordinate System in the general case (if applicable). Accepts/Returns None for Fiber Coordinate System for a result that is sub scoped by ply.

property AcousticTransmissionLoss.CrackFrontNumber: int | None#

Gets or sets the CrackFrontNumber.

property AcousticTransmissionLoss.DampedFrequency: Ansys.Core.Units.Quantity | None#

Gets the DampedFrequency.

property AcousticTransmissionLoss.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#

Gets the current DataModelObject's category.

property AcousticTransmissionLoss.DisplayOption: Ansys.Mechanical.DataModel.Enums.ResultAveragingType | None#

Gets or sets the DisplayOption.

property AcousticTransmissionLoss.DisplayTime: Ansys.Core.Units.Quantity | None#

Gets or sets the DisplayTime.

property AcousticTransmissionLoss.DpfEvaluation: Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None#

Gets or sets the DpfEvaluation.

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

Gets the list of associated figures.

property AcousticTransmissionLoss.Frequency: Ansys.Core.Units.Quantity | None#

Gets or sets the Frequency.

property AcousticTransmissionLoss.FrequencyRange: bool | None#

Gets or sets the FrequencyRange.

property AcousticTransmissionLoss.GlobalIDs: str | None#

Gets or sets the GlobalIDs.

property AcousticTransmissionLoss.GraphControlsXAxis: Ansys.Mechanical.DataModel.Enums.GraphControlsXAxis | None#

Gets or sets the GraphControlsXAxis.

property AcousticTransmissionLoss.Identifier: str | None#

Gets or sets the Identifier.

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

Gets the list of associated images.

property AcousticTransmissionLoss.InputPort: Ansys.ACT.Automation.Mechanical.BoundaryConditions.AcousticPort | None#

Gets or sets the InputPort.

property AcousticTransmissionLoss.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSResultAuto | None#

Gets the internal object. For advanced usage only.

property AcousticTransmissionLoss.IsSolved: bool | None#

Gets the IsSolved.

property AcousticTransmissionLoss.ItemType: Ansys.Mechanical.DataModel.Enums.ResultFileItemType | None#

Gets or sets the ItemType.

property AcousticTransmissionLoss.IterationNumber: int | None#

Gets the IterationNumber.

property AcousticTransmissionLoss.LoadStep: int | None#

Gets the LoadStep.

property AcousticTransmissionLoss.LoadStepForMaximumOfMaximumValues: int | None#

Get the Load Step for the maximum of maximum values.

property AcousticTransmissionLoss.LoadStepForMaximumOfMinimumValues: int | None#

Get the Load Step for the maximum of minimum values.

property AcousticTransmissionLoss.LoadStepForMinimumOfMaximumValues: int | None#

Get the Load Step for the minimum of maximum values.

property AcousticTransmissionLoss.LoadStepForMinimumOfMinimumValues: int | None#

Get the Load Step for the minimum of minimum values.

property AcousticTransmissionLoss.LoadStepNumber: int | None#

Gets or sets the LoadStepNumber.

property AcousticTransmissionLoss.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the Location.

property AcousticTransmissionLoss.LogarithmicDecrement: float | None#

Gets the LogarithmicDecrement.

property AcousticTransmissionLoss.Maximum: Ansys.Core.Units.Quantity | None#

Gets the Maximum.

property AcousticTransmissionLoss.MaximumFrequency: Ansys.Core.Units.Quantity | None#

Gets or sets the MaximumFrequency.

property AcousticTransmissionLoss.MaximumOccursOn: str | None#

Gets the MaximumOccursOn.

property AcousticTransmissionLoss.MaximumOfMaximumOverTime: Ansys.Core.Units.Quantity | None#

Gets the MaximumOfMaximumOverTime.

property AcousticTransmissionLoss.MaximumOfMinimumOverTime: Ansys.Core.Units.Quantity | None#

Gets the MaximumOfMinimumOverTime.

property AcousticTransmissionLoss.Minimum: Ansys.Core.Units.Quantity | None#

Gets the Minimum.

property AcousticTransmissionLoss.MinimumFrequency: Ansys.Core.Units.Quantity | None#

Gets or sets the MinimumFrequency.

property AcousticTransmissionLoss.MinimumOccursOn: str | None#

Gets the MinimumOccursOn.

property AcousticTransmissionLoss.MinimumOfMaximumOverTime: Ansys.Core.Units.Quantity | None#

Gets the MinimumOfMaximumOverTime.

property AcousticTransmissionLoss.MinimumOfMinimumOverTime: Ansys.Core.Units.Quantity | None#

Gets the MinimumOfMinimumOverTime.

property AcousticTransmissionLoss.ModalDampingRatio: float | None#

Gets the ModalDampingRatio.

property AcousticTransmissionLoss.Mode: int | None#

Gets or sets the Mode.

property AcousticTransmissionLoss.NamedSelections: Iterable[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#

Gets or sets the NamedSelections.

property AcousticTransmissionLoss.OutputPort: Ansys.ACT.Automation.Mechanical.BoundaryConditions.AcousticPort | None#

Gets or sets the OutputPort.

property AcousticTransmissionLoss.Path: Ansys.ACT.Automation.Mechanical.Path | None#

Path property.

property AcousticTransmissionLoss.PlotData: Ansys.Mechanical.DataModel.Results.ResultDataTable | None#

Gets the result table.

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

Gets the list of properties for this object.

property AcousticTransmissionLoss.ReportedFrequency: Ansys.Core.Units.Quantity | None#

Gets the ReportedFrequency.

property AcousticTransmissionLoss.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None#

Gets or sets the ScopingMethod.

property AcousticTransmissionLoss.SetNumber: int | None#

Gets or sets the Set Number.

property AcousticTransmissionLoss.SolutionCombinationDriver: Ansys.Mechanical.DataModel.Enums.SolutionCombinationDriverStyle | None#

Gets or sets the SolutionCombinationDriver.

property AcousticTransmissionLoss.SolverComponentIDs: str | None#

Gets or sets the SolverComponentIDs.

property AcousticTransmissionLoss.Stability: Ansys.Core.Units.Quantity | None#

Gets the Stability.

property AcousticTransmissionLoss.Substep: int | None#

Gets the Substep.

property AcousticTransmissionLoss.Suppressed: bool | None#

Gets or sets the Suppressed.

property AcousticTransmissionLoss.Surface: Ansys.ACT.Automation.Mechanical.Surface | None#

Surface property.

property AcousticTransmissionLoss.SweepingPhase: Ansys.Core.Units.Quantity | None#

Gets or sets the SweepingPhase.

property AcousticTransmissionLoss.Time: Ansys.Core.Units.Quantity | None#

Gets the Time.

property AcousticTransmissionLoss.TimeForMaximumOfMaximumValues: Ansys.Core.Units.Quantity | None#

Get the Time for the maximum of maximum values.

property AcousticTransmissionLoss.TimeForMaximumOfMinimumValues: Ansys.Core.Units.Quantity | None#

Get the Time for the maximum of minimum values.

property AcousticTransmissionLoss.TimeForMinimumOfMaximumValues: Ansys.Core.Units.Quantity | None#

Get the Time for the minimum of maximum values.

property AcousticTransmissionLoss.TimeForMinimumOfMinimumValues: Ansys.Core.Units.Quantity | None#

Get the Time for the minimum of minimum values.

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

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

property AcousticTransmissionLoss.WaterfallPanelShowTextOnMosaic: bool | None#

Gets or sets the Waterfall Panel Mosaic Text Property.

Method detail#

AcousticTransmissionLoss.Activate() None#

Activate the current object.

AcousticTransmissionLoss.AddAlert() Ansys.ACT.Automation.Mechanical.Results.Alert#

Creates a new Alert

AcousticTransmissionLoss.AddComment() Ansys.ACT.Automation.Mechanical.Comment#

Creates a new child Comment.

AcousticTransmissionLoss.AddConvergence() Ansys.ACT.Automation.Mechanical.Results.Convergence#

Creates a new Convergence

AcousticTransmissionLoss.AddFigure() Ansys.ACT.Automation.Mechanical.Figure#

Creates a new child Figure.

AcousticTransmissionLoss.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.
AcousticTransmissionLoss.ClearGeneratedData() None#

Run the ClearGeneratedData action.

AcousticTransmissionLoss.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

AcousticTransmissionLoss.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

CreateParameter method.

AcousticTransmissionLoss.CreateResultsAtAllSets() List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]#

Creates results at all sets for results under a solution.

AcousticTransmissionLoss.Delete() None#

Run the Delete action.

AcousticTransmissionLoss.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

AcousticTransmissionLoss.DuplicateWithoutResults() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Run the DuplicateWithoutResults action.

AcousticTransmissionLoss.EvaluateAllResults() None#

Run the EvaluateAllResults action.

AcousticTransmissionLoss.ExportAnimation(filePath: str, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings) None#

Run the ExportAnimation action.

AcousticTransmissionLoss.ExportToTextFile(filePath: str) None#

Run the ExportToTextFile action.

AcousticTransmissionLoss.FetchRemoteResults() None#

Run the FetchRemoteResult action.

AcousticTransmissionLoss.GetChildren(recurses: bool, children: List[ChildrenType]) List[ChildrenType]#

Gets the list of children, filtered by type.

AcousticTransmissionLoss.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

AcousticTransmissionLoss.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

AcousticTransmissionLoss.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

AcousticTransmissionLoss.PromoteToNamedSelection() Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]#

Run the PromoteToNamedSelection action.

AcousticTransmissionLoss.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.
AcousticTransmissionLoss.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

AcousticTransmissionLoss.RemoveParameter(propName: str) None#

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

AcousticTransmissionLoss.RenameBasedOnDefinition() None#

Run the RenameBasedOnDefinition action.