AcousticResult
Last update: 14.01.2025
AcousticResult
class Ansys.ACT.Automation.Mechanical.Results.AcousticResults.AcousticResult
Bases: object
Defines a AcousticResult.
Overview
Methods
Name | Description |
---|---|
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. |
Properties
Name | Description |
---|---|
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. |
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. |
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. |
MaximumOccursOn |
Gets the MaximumOccursOn. |
MaximumOfMaximumOverTime |
Gets the MaximumOfMaximumOverTime. |
MaximumOfMinimumOverTime |
Gets the MaximumOfMinimumOverTime. |
Minimum |
Gets the Minimum. |
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. |
Path |
Path property. |
PlotData |
Gets the result table. |
Properties |
Gets the list of properties for this object. |
RPMSelection |
Gets or sets the RPM Selection value at which the results are evaluated. |
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. |
SurfaceCoating |
SurfaceCoating 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. |
Total |
Gets the Total. |
VisibleProperties |
Gets the list of properties that are visible for this object. |
Property detail
property AcousticResult.Amplitude : bool | None
Gets or sets the Amplitude.
property AcousticResult.Average : Ansys.Core.Units.Quantity | None
Gets the Average.
property AcousticResult.By : Ansys.Mechanical.DataModel.Enums.SetDriverStyle | None
Gets or sets the By.
property AcousticResult.CalculateTimeHistory : bool | None
Gets or sets the CalculateTimeHistory.
property AcousticResult.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
property AcousticResult.CombinationNumber : int | None
Gets or sets the Combination Number for a Solution Combination result.
property AcousticResult.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
property AcousticResult.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 AcousticResult.CrackFrontNumber : int | None
Gets or sets the CrackFrontNumber.
property AcousticResult.DampedFrequency : Ansys.Core.Units.Quantity | None
Gets the DampedFrequency.
property AcousticResult.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
property AcousticResult.DisplayOption : Ansys.Mechanical.DataModel.Enums.ResultAveragingType | None
Gets or sets the DisplayOption.
property AcousticResult.DisplayTime : Ansys.Core.Units.Quantity | None
Gets or sets the DisplayTime.
property AcousticResult.DpfEvaluation : Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None
Gets or sets the DpfEvaluation.
property AcousticResult.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None
Gets the list of associated figures.
property AcousticResult.Frequency : Ansys.Core.Units.Quantity | None
Gets or sets the Frequency.
property AcousticResult.GlobalIDs : str | None
Gets or sets the GlobalIDs.
property AcousticResult.GraphControlsXAxis : Ansys.Mechanical.DataModel.Enums.GraphControlsXAxis | None
Gets or sets the GraphControlsXAxis.
property AcousticResult.Identifier : str | None
Gets or sets the Identifier.
property AcousticResult.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
property AcousticResult.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSResultAuto | None
Gets the internal object. For advanced usage only.
property AcousticResult.IsSolved : bool | None
Gets the IsSolved.
property AcousticResult.ItemType : Ansys.Mechanical.DataModel.Enums.ResultFileItemType | None
Gets or sets the ItemType.
property AcousticResult.IterationNumber : int | None
Gets the IterationNumber.
property AcousticResult.LoadStep : int | None
Gets the LoadStep.
property AcousticResult.LoadStepForMaximumOfMaximumValues : int | None
Get the Load Step for the maximum of maximum values.
property AcousticResult.LoadStepForMaximumOfMinimumValues : int | None
Get the Load Step for the maximum of minimum values.
property AcousticResult.LoadStepForMinimumOfMaximumValues : int | None
Get the Load Step for the minimum of maximum values.
property AcousticResult.LoadStepForMinimumOfMinimumValues : int | None
Get the Load Step for the minimum of minimum values.
property AcousticResult.LoadStepNumber : int | None
Gets or sets the LoadStepNumber.
property AcousticResult.Location : Ansys.ACT.Interfaces.Common.ISelectionInfo | None
Gets or sets the Location.
property AcousticResult.LogarithmicDecrement : float | None
Gets the LogarithmicDecrement.
property AcousticResult.Maximum : Ansys.Core.Units.Quantity | None
Gets the Maximum.
property AcousticResult.MaximumOccursOn : str | None
Gets the MaximumOccursOn.
property AcousticResult.MaximumOfMaximumOverTime : Ansys.Core.Units.Quantity | None
Gets the MaximumOfMaximumOverTime.
property AcousticResult.MaximumOfMinimumOverTime : Ansys.Core.Units.Quantity | None
Gets the MaximumOfMinimumOverTime.
property AcousticResult.Minimum : Ansys.Core.Units.Quantity | None
Gets the Minimum.
property AcousticResult.MinimumOccursOn : str | None
Gets the MinimumOccursOn.
property AcousticResult.MinimumOfMaximumOverTime : Ansys.Core.Units.Quantity | None
Gets the MinimumOfMaximumOverTime.
property AcousticResult.MinimumOfMinimumOverTime : Ansys.Core.Units.Quantity | None
Gets the MinimumOfMinimumOverTime.
property AcousticResult.ModalDampingRatio : float | None
Gets the ModalDampingRatio.
property AcousticResult.Mode : int | None
Gets or sets the Mode.
property AcousticResult.NamedSelections : Iterable[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets or sets the NamedSelections.
property AcousticResult.Path : Ansys.ACT.Automation.Mechanical.Path | None
Path property.
property AcousticResult.PlotData : Ansys.Mechanical.DataModel.Results.ResultDataTable | None
Gets the result table.
property AcousticResult.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
property AcousticResult.RPMSelection : Ansys.Core.Units.Quantity | None
Gets or sets the RPM Selection value at which the results are evaluated.
property AcousticResult.ReportedFrequency : Ansys.Core.Units.Quantity | None
Gets the ReportedFrequency.
property AcousticResult.ScopingMethod : Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None
Gets or sets the ScopingMethod.
property AcousticResult.SetNumber : int | None
Gets or sets the Set Number.
property AcousticResult.SolutionCombinationDriver : Ansys.Mechanical.DataModel.Enums.SolutionCombinationDriverStyle | None
Gets or sets the SolutionCombinationDriver.
property AcousticResult.SolverComponentIDs : str | None
Gets or sets the SolverComponentIDs.
property AcousticResult.Stability : Ansys.Core.Units.Quantity | None
Gets the Stability.
property AcousticResult.Substep : int | None
Gets the Substep.
property AcousticResult.Suppressed : bool | None
Gets or sets the Suppressed.
property AcousticResult.Surface : Ansys.ACT.Automation.Mechanical.Surface | None
Surface property.
property AcousticResult.SurfaceCoating : Ansys.ACT.Automation.Mechanical.SurfaceCoating | None
SurfaceCoating property.
property AcousticResult.SweepingPhase : Ansys.Core.Units.Quantity | None
Gets or sets the SweepingPhase.
property AcousticResult.Time : Ansys.Core.Units.Quantity | None
Gets the Time.
property AcousticResult.TimeForMaximumOfMaximumValues : Ansys.Core.Units.Quantity | None
Get the Time for the maximum of maximum values.
property AcousticResult.TimeForMaximumOfMinimumValues : Ansys.Core.Units.Quantity | None
Get the Time for the maximum of minimum values.
property AcousticResult.TimeForMinimumOfMaximumValues : Ansys.Core.Units.Quantity | None
Get the Time for the minimum of maximum values.
property AcousticResult.TimeForMinimumOfMinimumValues : Ansys.Core.Units.Quantity | None
Get the Time for the minimum of minimum values.
property AcousticResult.Total : Ansys.Core.Units.Quantity | None
Gets the Total.
property AcousticResult.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
Method detail
AcousticResult.Activate()
Activate the current object.
AcousticResult.AddAlert()
Creates a new Alert
AcousticResult.AddComment()
Creates a new child Comment.
AcousticResult.AddConvergence()
Creates a new Convergence
AcousticResult.AddFigure()
Creates a new child Figure.
AcousticResult.AddImage(filePath: str)
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.
AcousticResult.ClearGeneratedData()
Run the ClearGeneratedData action.
AcousticResult.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)
Copies all visible properties from this object to another.
AcousticResult.CreateParameter(propName: str)
CreateParameter method.
AcousticResult.CreateResultsAtAllSets()
Creates results at all sets for results under a solution.
AcousticResult.Delete()
Run the Delete action.
AcousticResult.Duplicate()
Creates a copy of the current DataModelObject.
AcousticResult.DuplicateWithoutResults()
Run the DuplicateWithoutResults action.
AcousticResult.EvaluateAllResults()
Run the EvaluateAllResults action.
AcousticResult.ExportAnimation(filePath: str, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings)
Run the ExportAnimation action.
AcousticResult.ExportToTextFile(filePath: str)
Run the ExportToTextFile action.
AcousticResult.FetchRemoteResults()
Run the FetchRemoteResult action.
AcousticResult.GetChildren(recurses: bool, children: List[ChildrenType])
Gets the list of children, filtered by type.
AcousticResult.GetParameter(propName: str)
Gets the parameter corresponding to the given property.
AcousticResult.GroupAllSimilarChildren()
Run the GroupAllSimilarChildren action.
AcousticResult.GroupSimilarObjects()
Run the GroupSimilarObjects action.
AcousticResult.PromoteToNamedSelection()
Run the PromoteToNamedSelection action.
AcousticResult.PropertyByAPIName(name: str)
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.
AcousticResult.PropertyByName(name: str)
Get a property by its unique name.
AcousticResult.RemoveParameter(propName: str)
Removes the parameter from the parameter set corresponding to the given property.
AcousticResult.RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.