AcousticFarFieldResult

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Results.AcousticResults.AcousticFarFieldResult

Bases: object

Defines a AcousticFarFieldResult.

Overview

Methods

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.
ExportToWAVFile	Run the ExportToWAVFile action.
ExportToXMLFile	Run the ExportToXMLFile 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

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.
Density	Gets or sets the Density.
DisplayOption	Gets or sets the DisplayOption.
DisplayTime	Gets or sets the DisplayTime.
DpfEvaluation	Gets or sets the DpfEvaluation.
EndingRadiationAnglePhi	Gets or sets the EndingRadiationAnglePhi.
EndingRadiationAngleTheta	Gets or sets the EndingRadiationAngleTheta.
FarFieldMicrophoneDefinitionMethod	Gets or sets the FarFieldMicrophoneDefinitionMethod.
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.
ModelThicknessInZDirection	Gets or sets the ModelThicknessInZDirection.
ModelType	Gets or sets the ModelType.
NamedSelections	Gets or sets the NamedSelections.
Path	Path property.
PhiAngleEnd	Gets or sets the PhiAngleEnd.
PhiAngleNoOfDivisions	Gets or sets the PhiAngleNoOfDivisions.
PhiAngleStart	Gets or sets the PhiAngleStart.
PlotData	Gets the result table.
Properties	Gets the list of properties for this object.
ReferenceRMSSoundPressure	Gets or sets the ReferenceRMSSoundPressure.
ReferenceSoundPower	Gets or sets the ReferenceSoundPower.
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.
SoundSpeed	Gets or sets the SoundSpeed.
SpatialRadiationAngle	Gets or sets the SpatialRadiationAngle.
SphereRadius	Gets or sets the SphereRadius.
Stability	Gets the Stability.
StartingRadiationAnglePhi	Gets or sets the StartingRadiationAnglePhi.
StartingRadiationAngleTheta	Gets or sets the StartingRadiationAngleTheta.
Substep	Gets the Substep.
Suppressed	Gets or sets the Suppressed.
Surface	Surface property.
SurfaceCoating	SurfaceCoating property.
ThetaAngleEnd	Gets or sets the ThetaAngleEnd.
ThetaAngleNoOfDivisions	Gets or sets the ThetaAngleNoOfDivisions.
ThetaAngleStart	Gets or sets the ThetaAngleStart.
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.
WaterfallShowTextOnMosaic	Gets or sets the Waterfall Mosaic Text Property.
Worksheet	Get the ObjectiveWorksheet action.
XCoordinate	Gets or sets the XCoordinate.
YAxisExtrusionAngle	Gets or sets the YAxisExtrusionAngle.
YCoordinate	Gets or sets the YCoordinate.
ZCoordinate	Gets or sets the ZCoordinate.

Property detail

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

Gets the Average.

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

Gets or sets the By.

property AcousticFarFieldResult.CalculateTimeHistory: bool | None

Gets or sets the CalculateTimeHistory.

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

Gets the list of children.

property AcousticFarFieldResult.CombinationNumber: int | None

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

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

Gets the list of associated comments.

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

Gets or sets the CrackFrontNumber.

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

Gets the DampedFrequency.

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

Gets the current DataModelObject's category.

property AcousticFarFieldResult.Density: Ansys.Core.Units.Quantity | None

Gets or sets the Density.

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

Gets or sets the DisplayOption.

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

Gets or sets the DisplayTime.

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

Gets or sets the DpfEvaluation.

property AcousticFarFieldResult.EndingRadiationAnglePhi: Ansys.Core.Units.Quantity | None

Gets or sets the EndingRadiationAnglePhi.

property AcousticFarFieldResult.EndingRadiationAngleTheta: Ansys.Core.Units.Quantity | None

Gets or sets the EndingRadiationAngleTheta.

property AcousticFarFieldResult.FarFieldMicrophoneDefinitionMethod: Ansys.Mechanical.DataModel.Enums.FarFieldMicrophoneDefinitionMethodType | None

Gets or sets the FarFieldMicrophoneDefinitionMethod.

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

Gets the list of associated figures.

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

Gets or sets the Frequency.

property AcousticFarFieldResult.GlobalIDs: str | None

Gets or sets the GlobalIDs.

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

Gets or sets the GraphControlsXAxis.

property AcousticFarFieldResult.Identifier: str | None

Gets or sets the Identifier.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

property AcousticFarFieldResult.IsSolved: bool | None

Gets the IsSolved.

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

Gets or sets the ItemType.

property AcousticFarFieldResult.IterationNumber: int | None

Gets the IterationNumber.

property AcousticFarFieldResult.LoadStep: int | None

Gets the LoadStep.

property AcousticFarFieldResult.LoadStepForMaximumOfMaximumValues: int | None

Get the Load Step for the maximum of maximum values.

property AcousticFarFieldResult.LoadStepForMaximumOfMinimumValues: int | None

Get the Load Step for the maximum of minimum values.

property AcousticFarFieldResult.LoadStepForMinimumOfMaximumValues: int | None

Get the Load Step for the minimum of maximum values.

property AcousticFarFieldResult.LoadStepForMinimumOfMinimumValues: int | None

Get the Load Step for the minimum of minimum values.

property AcousticFarFieldResult.LoadStepNumber: int | None

Gets or sets the LoadStepNumber.

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

Gets or sets the Location.

property AcousticFarFieldResult.LogarithmicDecrement: float | None

Gets the LogarithmicDecrement.

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

Gets the Maximum.

property AcousticFarFieldResult.MaximumOccursOn: str | None

Gets the MaximumOccursOn.

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

Gets the MaximumOfMaximumOverTime.

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

Gets the MaximumOfMinimumOverTime.

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

Gets the Minimum.

property AcousticFarFieldResult.MinimumOccursOn: str | None

Gets the MinimumOccursOn.

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

Gets the MinimumOfMaximumOverTime.

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

Gets the MinimumOfMinimumOverTime.

property AcousticFarFieldResult.ModalDampingRatio: float | None

Gets the ModalDampingRatio.

property AcousticFarFieldResult.ModelThicknessInZDirection: Ansys.Core.Units.Quantity | None

Gets or sets the ModelThicknessInZDirection.

property AcousticFarFieldResult.ModelType: Ansys.Mechanical.DataModel.Enums.ModelType | None

Gets or sets the ModelType.

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

Gets or sets the NamedSelections.

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

Path property.

property AcousticFarFieldResult.PhiAngleEnd: Ansys.Core.Units.Quantity | None

Gets or sets the PhiAngleEnd.

property AcousticFarFieldResult.PhiAngleNoOfDivisions: int | None

Gets or sets the PhiAngleNoOfDivisions.

property AcousticFarFieldResult.PhiAngleStart: Ansys.Core.Units.Quantity | None

Gets or sets the PhiAngleStart.

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

Gets the result table.

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

Gets the list of properties for this object.

property AcousticFarFieldResult.ReferenceRMSSoundPressure: Ansys.Core.Units.Quantity | None

Gets or sets the ReferenceRMSSoundPressure.

property AcousticFarFieldResult.ReferenceSoundPower: Ansys.Core.Units.Quantity | None

Gets or sets the ReferenceSoundPower.

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

Gets the ReportedFrequency.

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

Gets or sets the ScopingMethod.

property AcousticFarFieldResult.SetNumber: int | None

Gets or sets the Set Number.

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

Gets or sets the SolutionCombinationDriver.

property AcousticFarFieldResult.SolverComponentIDs: str | None

Gets or sets the SolverComponentIDs.

property AcousticFarFieldResult.SoundSpeed: Ansys.Core.Units.Quantity | None

Gets or sets the SoundSpeed.

property AcousticFarFieldResult.SpatialRadiationAngle: Ansys.Mechanical.DataModel.Enums.SpatialRadiationType | None

Gets or sets the SpatialRadiationAngle.

property AcousticFarFieldResult.SphereRadius: Ansys.Core.Units.Quantity | None

Gets or sets the SphereRadius.

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

Gets the Stability.

property AcousticFarFieldResult.StartingRadiationAnglePhi: Ansys.Core.Units.Quantity | None

Gets or sets the StartingRadiationAnglePhi.

property AcousticFarFieldResult.StartingRadiationAngleTheta: Ansys.Core.Units.Quantity | None

Gets or sets the StartingRadiationAngleTheta.

property AcousticFarFieldResult.Substep: int | None

Gets the Substep.

property AcousticFarFieldResult.Suppressed: bool | None

Gets or sets the Suppressed.

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

Surface property.

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

SurfaceCoating property.

property AcousticFarFieldResult.ThetaAngleEnd: Ansys.Core.Units.Quantity | None

Gets or sets the ThetaAngleEnd.

property AcousticFarFieldResult.ThetaAngleNoOfDivisions: int | None

Gets or sets the ThetaAngleNoOfDivisions.

property AcousticFarFieldResult.ThetaAngleStart: Ansys.Core.Units.Quantity | None

Gets or sets the ThetaAngleStart.

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

Gets the Time.

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

Get the Time for the maximum of maximum values.

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

Get the Time for the maximum of minimum values.

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

Get the Time for the minimum of maximum values.

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

Get the Time for the minimum of minimum values.

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

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

property AcousticFarFieldResult.WaterfallShowTextOnMosaic: bool | None

Gets or sets the Waterfall Mosaic Text Property.

property AcousticFarFieldResult.Worksheet: Ansys.ACT.Automation.Mechanical.AcousticsFarFieldResultWorksheet | None

Get the ObjectiveWorksheet action.

property AcousticFarFieldResult.XCoordinate: Ansys.Core.Units.Quantity | None

Gets or sets the XCoordinate.

property AcousticFarFieldResult.YAxisExtrusionAngle: Ansys.Core.Units.Quantity | None

Gets or sets the YAxisExtrusionAngle.

property AcousticFarFieldResult.YCoordinate: Ansys.Core.Units.Quantity | None

Gets or sets the YCoordinate.

property AcousticFarFieldResult.ZCoordinate: Ansys.Core.Units.Quantity | None

Gets or sets the ZCoordinate.

Method detail

AcousticFarFieldResult.Activate() → None

Activate the current object.

AcousticFarFieldResult.AddAlert() → Ansys.ACT.Automation.Mechanical.Results.Alert

Creates a new Alert

AcousticFarFieldResult.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

AcousticFarFieldResult.AddConvergence() → Ansys.ACT.Automation.Mechanical.Results.Convergence

Creates a new Convergence

AcousticFarFieldResult.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

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

AcousticFarFieldResult.ClearGeneratedData() → None

Run the ClearGeneratedData action.

AcousticFarFieldResult.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

AcousticFarFieldResult.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

CreateParameter method.

AcousticFarFieldResult.CreateResultsAtAllSets() → List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]

Creates results at all sets for results under a solution.

AcousticFarFieldResult.Delete() → None

Run the Delete action.

AcousticFarFieldResult.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

AcousticFarFieldResult.DuplicateWithoutResults() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Run the DuplicateWithoutResults action.

AcousticFarFieldResult.EvaluateAllResults() → None

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

AcousticFarFieldResult.ExportToTextFile(filePath: str) → None

Run the ExportToTextFile action.

AcousticFarFieldResult.ExportToWAVFile(filePath: str) → None

Run the ExportToWAVFile action.

AcousticFarFieldResult.ExportToXMLFile(filePath: str) → None

Run the ExportToXMLFile action.

AcousticFarFieldResult.FetchRemoteResults() → None

Run the FetchRemoteResult action.

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

Gets the list of children, filtered by type.

AcousticFarFieldResult.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

AcousticFarFieldResult.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

AcousticFarFieldResult.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

AcousticFarFieldResult.PromoteToNamedSelection() → Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]

Run the PromoteToNamedSelection action.

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

AcousticFarFieldResult.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

AcousticFarFieldResult.RemoveParameter(propName: str) → None

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

AcousticFarFieldResult.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.