`AcousticFarFieldResult`#

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

Bases: object

Defines a AcousticFarFieldResult.

Overview#

Methods

`ExportToXMLFile`	Run the ExportToXMLFile action.
`ExportToWAVFile`	Run the ExportToWAVFile action.
`ClearGeneratedData`	Run the ClearGeneratedData action.
`EvaluateAllResults`	Run the EvaluateAllResults action.
`FetchRemoteResults`	Run the FetchRemoteResult action.
`ExportToTextFile`	Run the ExportToTextFile action.
`ExportAnimation`	Run the ExportAnimation action.
`DuplicateWithoutResults`	Run the DuplicateWithoutResults action.
`CreateResultsAtAllSets`	Creates results at all sets for results under a solution.
`PromoteToNamedSelection`	Run the PromoteToNamedSelection action.
`CreateParameter`	CreateParameter method.
`AddAlert`	Creates a new Alert
`AddConvergence`	Creates a new Convergence
`RenameBasedOnDefinition`	Run the RenameBasedOnDefinition action.
`Delete`	Run the Delete action.
`GetChildren`	Gets the list of children, filtered by type.
`GetChildren`	Gets the list of children, filtered by type.
`AddComment`	Creates a new child Comment.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`Activate`	Activate the current object.
`CopyTo`	Copies all visible properties from this object to another.
`Duplicate`	Creates a copy of the current DataModelObject.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`PropertyByName`	Get a property by its unique name.
`PropertyByAPIName`	Get a property by its API name.
`GetParameter`	Gets the parameter corresponding to the given property.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.

Properties

`FarFieldMicrophoneDefinitionMethod`	Gets or sets the FarFieldMicrophoneDefinitionMethod.
`Worksheet`	Get the ObjectiveWorksheet action.
`ReportedFrequency`	Gets the ReportedFrequency.
`DampedFrequency`	Gets the DampedFrequency.
`InternalObject`	Gets the internal object. For advanced usage only.
`LogarithmicDecrement`	Gets the LogarithmicDecrement.
`ModalDampingRatio`	Gets the ModalDampingRatio.
`PhiAngleNoOfDivisions`	Gets or sets the PhiAngleNoOfDivisions.
`ThetaAngleNoOfDivisions`	Gets or sets the ThetaAngleNoOfDivisions.
`Stability`	Gets the Stability.
`Density`	Gets or sets the Density.
`XCoordinate`	Gets or sets the XCoordinate.
`YCoordinate`	Gets or sets the YCoordinate.
`ZCoordinate`	Gets or sets the ZCoordinate.
`ModelThicknessInZDirection`	Gets or sets the ModelThicknessInZDirection.
`ReferenceRMSSoundPressure`	Gets or sets the ReferenceRMSSoundPressure.
`ReferenceSoundPower`	Gets or sets the ReferenceSoundPower.
`Frequency`	Gets or sets the Frequency.
`SoundSpeed`	Gets or sets the SoundSpeed.
`EndingRadiationAnglePhi`	Gets or sets the EndingRadiationAnglePhi.
`EndingRadiationAngleTheta`	Gets or sets the EndingRadiationAngleTheta.
`StartingRadiationAnglePhi`	Gets or sets the StartingRadiationAnglePhi.
`StartingRadiationAngleTheta`	Gets or sets the StartingRadiationAngleTheta.
`PhiAngleEnd`	Gets or sets the PhiAngleEnd.
`ThetaAngleEnd`	Gets or sets the ThetaAngleEnd.
`SphereRadius`	Gets or sets the SphereRadius.
`PhiAngleStart`	Gets or sets the PhiAngleStart.
`ThetaAngleStart`	Gets or sets the ThetaAngleStart.
`YAxisExtrusionAngle`	Gets or sets the YAxisExtrusionAngle.
`ModelType`	Gets or sets the ModelType.
`SpatialRadiationAngle`	Gets or sets the SpatialRadiationAngle.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`PlotData`	Gets the result table.
`Location`	Gets or sets the Location.
`TimeForMinimumOfMinimumValues`	Get the Time for the minimum of minimum values.
`TimeForMinimumOfMaximumValues`	Get the Time for the minimum of maximum values.
`LoadStepForMinimumOfMinimumValues`	Get the Load Step for the minimum of minimum values.
`LoadStepForMinimumOfMaximumValues`	Get the Load Step for the minimum of maximum values.
`TimeForMaximumOfMinimumValues`	Get the Time for the maximum of minimum values.
`TimeForMaximumOfMaximumValues`	Get the Time for the maximum of maximum values.
`LoadStepForMaximumOfMinimumValues`	Get the Load Step for the maximum of minimum values.
`LoadStepForMaximumOfMaximumValues`	Get the Load Step for the maximum of maximum values.
`IsSolved`	Gets the IsSolved.
`CoordinateSystem`	Gets or sets the Coordinate System.
`ScopingMethod`	Gets or sets the ScopingMethod.
`SetNumber`	Gets or sets the Set Number.
`CombinationNumber`	Gets or sets the Combination Number for a Solution Combination result.
`SolutionCombinationDriver`	Gets or sets the SolutionCombinationDriver.
`Path`	Path property.
`Surface`	Surface property.
`NamedSelections`	Gets or sets the NamedSelections.
`WaterfallPanelShowTextOnMosaic`	Gets or sets the Waterfall Panel Mosaic Text Property.
`CrackFrontNumber`	Gets or sets the CrackFrontNumber.
`GlobalIDs`	Gets or sets the GlobalIDs.
`Identifier`	Gets or sets the Identifier.
`IterationNumber`	Gets the IterationNumber.
`LoadStep`	Gets the LoadStep.
`MaximumOccursOn`	Gets the MaximumOccursOn.
`MinimumOccursOn`	Gets the MinimumOccursOn.
`LoadStepNumber`	Gets or sets the LoadStepNumber.
`SolverComponentIDs`	Gets or sets the SolverComponentIDs.
`Substep`	Gets the Substep.
`Average`	Gets the Average.
`Maximum`	Gets the Maximum.
`MaximumOfMaximumOverTime`	Gets the MaximumOfMaximumOverTime.
`MaximumOfMinimumOverTime`	Gets the MaximumOfMinimumOverTime.
`Minimum`	Gets the Minimum.
`MinimumOfMaximumOverTime`	Gets the MinimumOfMaximumOverTime.
`MinimumOfMinimumOverTime`	Gets the MinimumOfMinimumOverTime.
`Time`	Gets the Time.
`DisplayTime`	Gets or sets the DisplayTime.
`GraphControlsXAxis`	Gets or sets the GraphControlsXAxis.
`DisplayOption`	Gets or sets the DisplayOption.
`DpfEvaluation`	Gets or sets the DpfEvaluation.
`By`	Gets or sets the By.
`ItemType`	Gets or sets the ItemType.
`CalculateTimeHistory`	Gets or sets the CalculateTimeHistory.
`Suppressed`	Gets or sets the Suppressed.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`Figures`	Gets the list of associated figures.
`Images`	Gets the list of associated images.
`InternalObject`	Gets the internal object. For advanced usage only.
`Properties`	Gets the list of properties for this object.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property AcousticFarFieldResult.FarFieldMicrophoneDefinitionMethod: Ansys.Mechanical.DataModel.Enums.FarFieldMicrophoneDefinitionMethodType | None: Gets or sets the FarFieldMicrophoneDefinitionMethod.

property AcousticFarFieldResult.Worksheet: Ansys.ACT.Automation.Mechanical.AcousticsFarFieldResultWorksheet | None: Get the ObjectiveWorksheet action.

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

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

property AcousticFarFieldResult.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSResultAuto | None: Gets the internal object. For advanced usage only.

property AcousticFarFieldResult.LogarithmicDecrement: System.Double | None: Gets the LogarithmicDecrement.

property AcousticFarFieldResult.ModalDampingRatio: System.Double | None: Gets the ModalDampingRatio.

property AcousticFarFieldResult.PhiAngleNoOfDivisions: System.UInt32 | None: Gets or sets the PhiAngleNoOfDivisions.

property AcousticFarFieldResult.ThetaAngleNoOfDivisions: System.UInt32 | None: Gets or sets the ThetaAngleNoOfDivisions.

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

property AcousticFarFieldResult.Density: Ansys.Core.Units.Quantity | None: Gets or sets the Density.

property AcousticFarFieldResult.XCoordinate: Ansys.Core.Units.Quantity | None: Gets or sets the XCoordinate.

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.

property AcousticFarFieldResult.ModelThicknessInZDirection: Ansys.Core.Units.Quantity | None: Gets or sets the ModelThicknessInZDirection.

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.Frequency: Ansys.Core.Units.Quantity | None: Gets or sets the Frequency.

property AcousticFarFieldResult.SoundSpeed: Ansys.Core.Units.Quantity | None: Gets or sets the SoundSpeed.

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.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.PhiAngleEnd: Ansys.Core.Units.Quantity | None: Gets or sets the PhiAngleEnd.

property AcousticFarFieldResult.ThetaAngleEnd: Ansys.Core.Units.Quantity | None: Gets or sets the ThetaAngleEnd.

property AcousticFarFieldResult.SphereRadius: Ansys.Core.Units.Quantity | None: Gets or sets the SphereRadius.

property AcousticFarFieldResult.PhiAngleStart: Ansys.Core.Units.Quantity | None: Gets or sets the PhiAngleStart.

property AcousticFarFieldResult.ThetaAngleStart: Ansys.Core.Units.Quantity | None: Gets or sets the ThetaAngleStart.

property AcousticFarFieldResult.YAxisExtrusionAngle: Ansys.Core.Units.Quantity | None: Gets or sets the YAxisExtrusionAngle.

property AcousticFarFieldResult.ModelType: Ansys.Mechanical.DataModel.Enums.ModelType | None: Gets or sets the ModelType.

property AcousticFarFieldResult.SpatialRadiationAngle: Ansys.Mechanical.DataModel.Enums.SpatialRadiationType | None: Gets or sets the SpatialRadiationAngle.

property AcousticFarFieldResult.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property AcousticFarFieldResult.PlotData: Ansys.Mechanical.DataModel.Results.ResultDataTable | None: Gets the result table.

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

property AcousticFarFieldResult.TimeForMinimumOfMinimumValues: Ansys.Core.Units.Quantity | None: Get the Time for the minimum of minimum values.

property AcousticFarFieldResult.TimeForMinimumOfMaximumValues: Ansys.Core.Units.Quantity | None: Get the Time for the minimum of maximum values.

property AcousticFarFieldResult.LoadStepForMinimumOfMinimumValues: System.UInt32 | None: Get the Load Step for the minimum of minimum values.

property AcousticFarFieldResult.LoadStepForMinimumOfMaximumValues: System.UInt32 | None: Get the Load Step for the minimum of maximum values.

property AcousticFarFieldResult.TimeForMaximumOfMinimumValues: Ansys.Core.Units.Quantity | None: Get the Time for the maximum of minimum values.

property AcousticFarFieldResult.TimeForMaximumOfMaximumValues: Ansys.Core.Units.Quantity | None: Get the Time for the maximum of maximum values.

property AcousticFarFieldResult.LoadStepForMaximumOfMinimumValues: System.UInt32 | None: Get the Load Step for the maximum of minimum values.

property AcousticFarFieldResult.LoadStepForMaximumOfMaximumValues: System.UInt32 | None: Get the Load Step for the maximum of maximum values.

property AcousticFarFieldResult.IsSolved: System.Boolean | None: Gets the IsSolved.

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.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None: Gets or sets the ScopingMethod.

property AcousticFarFieldResult.SetNumber: System.UInt32 | None: Gets or sets the Set Number.

property AcousticFarFieldResult.CombinationNumber: System.UInt32 | None: Gets or sets the Combination Number for a Solution Combination result.

property AcousticFarFieldResult.SolutionCombinationDriver: Ansys.Mechanical.DataModel.Enums.SolutionCombinationDriverStyle | None: Gets or sets the SolutionCombinationDriver.

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

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

property AcousticFarFieldResult.NamedSelections: System.Collections.Generic.IEnumerable[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets or sets the NamedSelections.

property AcousticFarFieldResult.WaterfallPanelShowTextOnMosaic: System.Boolean | None: Gets or sets the Waterfall Panel Mosaic Text Property.

property AcousticFarFieldResult.CrackFrontNumber: System.Int32 | None: Gets or sets the CrackFrontNumber.

property AcousticFarFieldResult.GlobalIDs: System.String | None: Gets or sets the GlobalIDs.

property AcousticFarFieldResult.Identifier: System.String | None: Gets or sets the Identifier.

property AcousticFarFieldResult.IterationNumber: System.Int32 | None: Gets the IterationNumber.

property AcousticFarFieldResult.LoadStep: System.Int32 | None: Gets the LoadStep.

property AcousticFarFieldResult.MaximumOccursOn: System.String | None: Gets the MaximumOccursOn.

property AcousticFarFieldResult.MinimumOccursOn: System.String | None: Gets the MinimumOccursOn.

property AcousticFarFieldResult.LoadStepNumber: System.UInt32 | None: Gets or sets the LoadStepNumber.

property AcousticFarFieldResult.SolverComponentIDs: System.String | None: Gets or sets the SolverComponentIDs.

property AcousticFarFieldResult.Substep: System.Int32 | None: Gets the Substep.

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

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

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.MinimumOfMaximumOverTime: Ansys.Core.Units.Quantity | None: Gets the MinimumOfMaximumOverTime.

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

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

property AcousticFarFieldResult.DisplayTime: Ansys.Core.Units.Quantity | None: Gets or sets the DisplayTime.

property AcousticFarFieldResult.GraphControlsXAxis: Ansys.Mechanical.DataModel.Enums.GraphControlsXAxis | None: Gets or sets the GraphControlsXAxis.

property AcousticFarFieldResult.DisplayOption: Ansys.Mechanical.DataModel.Enums.ResultAveragingType | None: Gets or sets the DisplayOption.

property AcousticFarFieldResult.DpfEvaluation: Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None: Gets or sets the DpfEvaluation.

property AcousticFarFieldResult.By: Ansys.Mechanical.DataModel.Enums.SetDriverStyle | None: Gets or sets the By.

property AcousticFarFieldResult.ItemType: Ansys.Mechanical.DataModel.Enums.ResultFileItemType | None: Gets or sets the ItemType.

property AcousticFarFieldResult.CalculateTimeHistory: System.Boolean | None: Gets or sets the CalculateTimeHistory.

property AcousticFarFieldResult.Suppressed: System.Boolean | None: Gets or sets the Suppressed.

property AcousticFarFieldResult.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property AcousticFarFieldResult.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property AcousticFarFieldResult.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property AcousticFarFieldResult.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property AcousticFarFieldResult.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property AcousticFarFieldResult.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property AcousticFarFieldResult.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

AcousticFarFieldResult.ExportToXMLFile(filePath: System.String) → System.Void: Run the ExportToXMLFile action.

AcousticFarFieldResult.ExportToWAVFile(filePath: System.String) → System.Void: Run the ExportToWAVFile action.

AcousticFarFieldResult.ClearGeneratedData() → System.Void: Run the ClearGeneratedData action.

AcousticFarFieldResult.EvaluateAllResults() → System.Void: Run the EvaluateAllResults action.

AcousticFarFieldResult.FetchRemoteResults() → System.Void: Run the FetchRemoteResult action.

AcousticFarFieldResult.ExportToTextFile(filePath: System.String) → System.Void: Run the ExportToTextFile action.

AcousticFarFieldResult.ExportAnimation(filePath: System.String, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings) → System.Void: Run the ExportAnimation action.

AcousticFarFieldResult.DuplicateWithoutResults() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Run the DuplicateWithoutResults action.

AcousticFarFieldResult.CreateResultsAtAllSets() → System.Collections.Generic.List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Creates results at all sets for results under a solution.

AcousticFarFieldResult.PromoteToNamedSelection() → System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.NamedSelection]: Run the PromoteToNamedSelection action.

AcousticFarFieldResult.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: CreateParameter method.

AcousticFarFieldResult.AddAlert() → Ansys.ACT.Automation.Mechanical.Results.Alert: Creates a new Alert

AcousticFarFieldResult.AddConvergence() → Ansys.ACT.Automation.Mechanical.Results.Convergence: Creates a new Convergence

AcousticFarFieldResult.RenameBasedOnDefinition() → System.Void: Run the RenameBasedOnDefinition action.

AcousticFarFieldResult.Delete() → System.Void: Run the Delete action.

AcousticFarFieldResult.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

AcousticFarFieldResult.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

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

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

AcousticFarFieldResult.AddImage(filePath: System.String) → 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.Activate() → System.Void: Activate the current object.

AcousticFarFieldResult.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

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

AcousticFarFieldResult.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

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

AcousticFarFieldResult.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

AcousticFarFieldResult.PropertyByAPIName(name: System.String) → 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.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

AcousticFarFieldResult.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.