Skip to main content

Mechanical scripting interface

AcousticPotentialEnergy

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.Results.AcousticResults.AcousticPotentialEnergy

Bases: object

Defines a AcousticPotentialEnergy.

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 AcousticPotentialEnergy.Amplitude : bool | None

Gets or sets the Amplitude.

property AcousticPotentialEnergy.Average : Ansys.Core.Units.Quantity | None

Gets the Average.

property AcousticPotentialEnergy.By : Ansys.Mechanical.DataModel.Enums.SetDriverStyle | None

Gets or sets the By.

property AcousticPotentialEnergy.CalculateTimeHistory : bool | None

Gets or sets the CalculateTimeHistory.

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

Gets the list of children.

property AcousticPotentialEnergy.CombinationNumber : int | None

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

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

Gets the list of associated comments.

property AcousticPotentialEnergy.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 AcousticPotentialEnergy.CrackFrontNumber : int | None

Gets or sets the CrackFrontNumber.

property AcousticPotentialEnergy.DampedFrequency : Ansys.Core.Units.Quantity | None

Gets the DampedFrequency.

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

Gets the current DataModelObject’s category.

property AcousticPotentialEnergy.DisplayOption : Ansys.Mechanical.DataModel.Enums.ResultAveragingType | None

Gets or sets the DisplayOption.

property AcousticPotentialEnergy.DisplayTime : Ansys.Core.Units.Quantity | None

Gets or sets the DisplayTime.

property AcousticPotentialEnergy.DpfEvaluation : Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None

Gets or sets the DpfEvaluation.

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

Gets the list of associated figures.

property AcousticPotentialEnergy.Frequency : Ansys.Core.Units.Quantity | None

Gets or sets the Frequency.

property AcousticPotentialEnergy.GlobalIDs : str | None

Gets or sets the GlobalIDs.

property AcousticPotentialEnergy.GraphControlsXAxis : Ansys.Mechanical.DataModel.Enums.GraphControlsXAxis | None

Gets or sets the GraphControlsXAxis.

property AcousticPotentialEnergy.Identifier : str | None

Gets or sets the Identifier.

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

Gets the list of associated images.

property AcousticPotentialEnergy.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSResultAuto | None

Gets the internal object. For advanced usage only.

property AcousticPotentialEnergy.IsSolved : bool | None

Gets the IsSolved.

property AcousticPotentialEnergy.ItemType : Ansys.Mechanical.DataModel.Enums.ResultFileItemType | None

Gets or sets the ItemType.

property AcousticPotentialEnergy.IterationNumber : int | None

Gets the IterationNumber.

property AcousticPotentialEnergy.LoadStep : int | None

Gets the LoadStep.

property AcousticPotentialEnergy.LoadStepForMaximumOfMaximumValues : int | None

Get the Load Step for the maximum of maximum values.

property AcousticPotentialEnergy.LoadStepForMaximumOfMinimumValues : int | None

Get the Load Step for the maximum of minimum values.

property AcousticPotentialEnergy.LoadStepForMinimumOfMaximumValues : int | None

Get the Load Step for the minimum of maximum values.

property AcousticPotentialEnergy.LoadStepForMinimumOfMinimumValues : int | None

Get the Load Step for the minimum of minimum values.

property AcousticPotentialEnergy.LoadStepNumber : int | None

Gets or sets the LoadStepNumber.

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

Gets or sets the Location.

property AcousticPotentialEnergy.LogarithmicDecrement : float | None

Gets the LogarithmicDecrement.

property AcousticPotentialEnergy.Maximum : Ansys.Core.Units.Quantity | None

Gets the Maximum.

property AcousticPotentialEnergy.MaximumOccursOn : str | None

Gets the MaximumOccursOn.

property AcousticPotentialEnergy.MaximumOfMaximumOverTime : Ansys.Core.Units.Quantity | None

Gets the MaximumOfMaximumOverTime.

property AcousticPotentialEnergy.MaximumOfMinimumOverTime : Ansys.Core.Units.Quantity | None

Gets the MaximumOfMinimumOverTime.

property AcousticPotentialEnergy.Minimum : Ansys.Core.Units.Quantity | None

Gets the Minimum.

property AcousticPotentialEnergy.MinimumOccursOn : str | None

Gets the MinimumOccursOn.

property AcousticPotentialEnergy.MinimumOfMaximumOverTime : Ansys.Core.Units.Quantity | None

Gets the MinimumOfMaximumOverTime.

property AcousticPotentialEnergy.MinimumOfMinimumOverTime : Ansys.Core.Units.Quantity | None

Gets the MinimumOfMinimumOverTime.

property AcousticPotentialEnergy.ModalDampingRatio : float | None

Gets the ModalDampingRatio.

property AcousticPotentialEnergy.Mode : int | None

Gets or sets the Mode.

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

Gets or sets the NamedSelections.

property AcousticPotentialEnergy.Path : Ansys.ACT.Automation.Mechanical.Path | None

Path property.

property AcousticPotentialEnergy.PlotData : Ansys.Mechanical.DataModel.Results.ResultDataTable | None

Gets the result table.

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

Gets the list of properties for this object.

property AcousticPotentialEnergy.RPMSelection : Ansys.Core.Units.Quantity | None

Gets or sets the RPM Selection value at which the results are evaluated.

property AcousticPotentialEnergy.ReportedFrequency : Ansys.Core.Units.Quantity | None

Gets the ReportedFrequency.

property AcousticPotentialEnergy.ScopingMethod : Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the ScopingMethod.

property AcousticPotentialEnergy.SetNumber : int | None

Gets or sets the Set Number.

property AcousticPotentialEnergy.SolutionCombinationDriver : Ansys.Mechanical.DataModel.Enums.SolutionCombinationDriverStyle | None

Gets or sets the SolutionCombinationDriver.

property AcousticPotentialEnergy.SolverComponentIDs : str | None

Gets or sets the SolverComponentIDs.

property AcousticPotentialEnergy.Stability : Ansys.Core.Units.Quantity | None

Gets the Stability.

property AcousticPotentialEnergy.Substep : int | None

Gets the Substep.

property AcousticPotentialEnergy.Suppressed : bool | None

Gets or sets the Suppressed.

property AcousticPotentialEnergy.Surface : Ansys.ACT.Automation.Mechanical.Surface | None

Surface property.

property AcousticPotentialEnergy.SurfaceCoating : Ansys.ACT.Automation.Mechanical.SurfaceCoating | None

SurfaceCoating property.

property AcousticPotentialEnergy.SweepingPhase : Ansys.Core.Units.Quantity | None

Gets or sets the SweepingPhase.

property AcousticPotentialEnergy.Time : Ansys.Core.Units.Quantity | None

Gets the Time.

property AcousticPotentialEnergy.TimeForMaximumOfMaximumValues : Ansys.Core.Units.Quantity | None

Get the Time for the maximum of maximum values.

property AcousticPotentialEnergy.TimeForMaximumOfMinimumValues : Ansys.Core.Units.Quantity | None

Get the Time for the maximum of minimum values.

property AcousticPotentialEnergy.TimeForMinimumOfMaximumValues : Ansys.Core.Units.Quantity | None

Get the Time for the minimum of maximum values.

property AcousticPotentialEnergy.TimeForMinimumOfMinimumValues : Ansys.Core.Units.Quantity | None

Get the Time for the minimum of minimum values.

property AcousticPotentialEnergy.Total : Ansys.Core.Units.Quantity | None

Gets the Total.

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

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

Method detail

AcousticPotentialEnergy.Activate()

Activate the current object.

AcousticPotentialEnergy.AddAlert()

Creates a new Alert

AcousticPotentialEnergy.AddComment()

Creates a new child Comment.

AcousticPotentialEnergy.AddConvergence()

Creates a new Convergence

AcousticPotentialEnergy.AddFigure()

Creates a new child Figure.

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

AcousticPotentialEnergy.ClearGeneratedData()

Run the ClearGeneratedData action.

AcousticPotentialEnergy.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

AcousticPotentialEnergy.CreateParameter(propName: str)

CreateParameter method.

AcousticPotentialEnergy.CreateResultsAtAllSets()

Creates results at all sets for results under a solution.

AcousticPotentialEnergy.Delete()

Run the Delete action.

AcousticPotentialEnergy.Duplicate()

Creates a copy of the current DataModelObject.

AcousticPotentialEnergy.DuplicateWithoutResults()

Run the DuplicateWithoutResults action.

AcousticPotentialEnergy.EvaluateAllResults()

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

AcousticPotentialEnergy.ExportToTextFile(filePath: str)

Run the ExportToTextFile action.

AcousticPotentialEnergy.FetchRemoteResults()

Run the FetchRemoteResult action.

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

Gets the list of children, filtered by type.

AcousticPotentialEnergy.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

AcousticPotentialEnergy.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

AcousticPotentialEnergy.GroupSimilarObjects()

Run the GroupSimilarObjects action.

AcousticPotentialEnergy.PromoteToNamedSelection()

Run the PromoteToNamedSelection action.

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

AcousticPotentialEnergy.PropertyByName(name: str)

Get a property by its unique name.

AcousticPotentialEnergy.RemoveParameter(propName: str)

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

AcousticPotentialEnergy.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.