`ResponsePSD`

class Ansys.ACT.Automation.Mechanical.Results.ProbeResults.ResponsePSD

Bases: object

Defines a ResponsePSD.

Overview

Methods

Name	Description
Activate	Activate the current object.
AddComment	Creates a new child Comment.
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	Creates a new parameter for a Property.
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.
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.
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.
RetrieveResult	Evaluates the individual probe result without evaluating all the results in the same solution.
SnapToMeshNodes	Snap the coordinates of probe result to the mesh nodes.

Properties

Name	Description
AccelerationInG	Gets or sets the AccelerationInG.
BeamSelection	Gets or sets the BeamSelection.
BoundaryConditionSelection	Gets or sets the BoundaryConditionSelection. In order to select the option ‘WeakSprings’, please use the property ‘LocationMethod = LocationDefinitionMethod.WeakSprings’.
Children	Gets the list of children.
Comments	Gets the list of associated comments.
ContactRegionSelection	Gets or sets the ContactRegionSelection.
CoordinateSystemSelection	Gets or sets the CoordinateSystemSelection.
DataModelObjectCategory	Gets the current DataModelObject’s category.
DisplayTime	Gets or sets the DisplayTime.
DpfEvaluation	Gets or sets the DpfEvaluation.
ExpectedFrequency	Gets the ExpectedFrequency.
Figures	Gets the list of associated figures.
GeometryLocation	Gets or sets the GeometryLocation.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
IsSolved	Gets the IsSolved.
IterationNumber	Gets the IterationNumber.
LoadStep	Gets the LoadStep.
LoadStepNumber	Gets or sets the LoadStepNumber.
LocationMethod	Gets or sets the LocationMethod.
MaximumTotal	Gets the MaximumTotal.
MaximumXAxis	Gets the MaximumXAxis.
MaximumYAxis	Gets the MaximumYAxis.
MaximumZAxis	Gets the MaximumZAxis.
MeshConnectionSelection	Gets or sets the MeshConnectionSelection.
MinimumTotal	Gets the MinimumTotal.
MinimumXAxis	Gets the MinimumXAxis.
MinimumYAxis	Gets the MinimumYAxis.
MinimumZAxis	Gets the MinimumZAxis.
Orientation	Gets or sets the Orientation. Accepts/Returns None if it is the Solution Coordinate System.
Probability	Gets the Probability.
Properties	Gets the list of properties for this object.
RMSPercentage	Gets the RMSPercentage.
RMSValue	Gets the RMSValue.
RPMSelection	Gets or sets the RPM Selection value at which the results are evaluated.
RangeMaximum	Gets or sets the RangeMaximum.
RangeMinimum	Gets or sets the RangeMinimum.
Reference	Gets or sets the Reference.
RemotePointSelection	Gets or sets the RemotePointSelection.
ResultSelection	Gets or sets the ResultSelection.
ResultType	Gets or sets the ResultType.
SelectedFrequencyRange	Gets or sets the SelectedFrequencyRange.
SpatialResolution	Gets or sets the SpatialResolution.
SpringSelection	Gets or sets the SpringSelection.
Substep	Gets the Substep.
Summation	Gets or sets the Summation.
Suppressed	Gets or sets the Suppressed.
SurfaceSelection	Gets or sets the MeshConnectionSelection.
Time	Gets the Time.
Total	Gets the Total.
Type	Gets the Type.
VisibleProperties	Gets the list of properties that are visible for this object.
XAxis	Gets the XAxis.
YAxis	Gets the YAxis.
ZAxis	Gets the ZAxis.

Property detail

property ResponsePSD.AccelerationInG : bool | None

Gets or sets the AccelerationInG.

property ResponsePSD.BeamSelection : Ansys.ACT.Automation.Mechanical.Connections.Beam | None

Gets or sets the BeamSelection.

property ResponsePSD.BoundaryConditionSelection : Ansys.ACT.Automation.Mechanical.DataModelObject | None

Gets or sets the BoundaryConditionSelection. In order to select the option ‘WeakSprings’, please use the property ‘LocationMethod = LocationDefinitionMethod.WeakSprings’.

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

Gets the list of children.

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

Gets the list of associated comments.

property ResponsePSD.ContactRegionSelection : Ansys.ACT.Automation.Mechanical.Connections.ContactRegion | None

Gets or sets the ContactRegionSelection.

property ResponsePSD.CoordinateSystemSelection : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the CoordinateSystemSelection.

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

Gets the current DataModelObject’s category.

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

Gets or sets the DisplayTime.

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

Gets or sets the DpfEvaluation.

property ResponsePSD.ExpectedFrequency : Ansys.Core.Units.Quantity | None

Gets the ExpectedFrequency.

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

Gets the list of associated figures.

property ResponsePSD.GeometryLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the GeometryLocation.

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

Gets the list of associated images.

property ResponsePSD.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSProbeResultAuto | None

Gets the internal object. For advanced usage only.

property ResponsePSD.IsSolved : bool | None

Gets the IsSolved.

property ResponsePSD.IterationNumber : int | None

Gets the IterationNumber.

property ResponsePSD.LoadStep : int | None

Gets the LoadStep.

property ResponsePSD.LoadStepNumber : int | None

Gets or sets the LoadStepNumber.

property ResponsePSD.LocationMethod : Ansys.Mechanical.DataModel.Enums.LocationDefinitionMethod | None

Gets or sets the LocationMethod.

property ResponsePSD.MaximumTotal : Ansys.Core.Units.Quantity | None

Gets the MaximumTotal.

property ResponsePSD.MaximumXAxis : Ansys.Core.Units.Quantity | None

Gets the MaximumXAxis.

property ResponsePSD.MaximumYAxis : Ansys.Core.Units.Quantity | None

Gets the MaximumYAxis.

property ResponsePSD.MaximumZAxis : Ansys.Core.Units.Quantity | None

Gets the MaximumZAxis.

property ResponsePSD.MeshConnectionSelection : Ansys.ACT.Automation.Mechanical.MeshConnection | None

Gets or sets the MeshConnectionSelection.

property ResponsePSD.MinimumTotal : Ansys.Core.Units.Quantity | None

Gets the MinimumTotal.

property ResponsePSD.MinimumXAxis : Ansys.Core.Units.Quantity | None

Gets the MinimumXAxis.

property ResponsePSD.MinimumYAxis : Ansys.Core.Units.Quantity | None

Gets the MinimumYAxis.

property ResponsePSD.MinimumZAxis : Ansys.Core.Units.Quantity | None

Gets the MinimumZAxis.

property ResponsePSD.Orientation : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the Orientation. Accepts/Returns None if it is the Solution Coordinate System.

property ResponsePSD.Probability : float | None

Gets the Probability.

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

Gets the list of properties for this object.

property ResponsePSD.RMSPercentage : float | None

Gets the RMSPercentage.

property ResponsePSD.RMSValue : Ansys.Core.Units.Quantity | None

Gets the RMSValue.

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

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

property ResponsePSD.RangeMaximum : Ansys.Core.Units.Quantity | None

Gets or sets the RangeMaximum.

property ResponsePSD.RangeMinimum : Ansys.Core.Units.Quantity | None

Gets or sets the RangeMinimum.

property ResponsePSD.Reference : Ansys.Mechanical.DataModel.Enums.ResultRelativityType | None

Gets or sets the Reference.

property ResponsePSD.RemotePointSelection : Ansys.ACT.Automation.Mechanical.RemotePoint | None

Gets or sets the RemotePointSelection.

property ResponsePSD.ResultSelection : Ansys.Mechanical.DataModel.Enums.ProbeDisplayFilter | None

Gets or sets the ResultSelection.

property ResponsePSD.ResultType : Ansys.Mechanical.DataModel.Enums.ProbeResultType | None

Gets or sets the ResultType.

property ResponsePSD.SelectedFrequencyRange : Ansys.Mechanical.DataModel.Enums.FrequencyRangeType | None

Gets or sets the SelectedFrequencyRange.

property ResponsePSD.SpatialResolution : Ansys.Mechanical.DataModel.Enums.MinimumOrMaximum | None

Gets or sets the SpatialResolution.

property ResponsePSD.SpringSelection : Ansys.ACT.Automation.Mechanical.Connections.Spring | None

Gets or sets the SpringSelection.

property ResponsePSD.Substep : int | None

Gets the Substep.

property ResponsePSD.Summation : Ansys.Mechanical.DataModel.Enums.MomentsAtSummationPointType | None

Gets or sets the Summation.

property ResponsePSD.Suppressed : bool | None

Gets or sets the Suppressed.

property ResponsePSD.SurfaceSelection : Ansys.ACT.Automation.Mechanical.Surface | None

Gets or sets the MeshConnectionSelection.

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

Gets the Time.

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

Gets the Total.

property ResponsePSD.Type : Ansys.Mechanical.DataModel.Enums.ProbeResultType | None

Gets the Type.

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

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

property ResponsePSD.XAxis : Ansys.Core.Units.Quantity | None

Gets the XAxis.

property ResponsePSD.YAxis : Ansys.Core.Units.Quantity | None

Gets the YAxis.

property ResponsePSD.ZAxis : Ansys.Core.Units.Quantity | None

Gets the ZAxis.

Method detail

ResponsePSD.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

ResponsePSD.ClearGeneratedData() → None

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

ResponsePSD.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

ResponsePSD.DuplicateWithoutResults() → Ansys.ACT.Automation.Mechanical.DataModelObject

Run the DuplicateWithoutResults action.

ResponsePSD.EvaluateAllResults() → None

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

ResponsePSD.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

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

Get a property by its unique name.

ResponsePSD.RemoveParameter(propName: str) → None

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

ResponsePSD.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

ResponsePSD.RetrieveResult() → None

Evaluates the individual probe result without evaluating all the results in the same solution.

ResponsePSD.SnapToMeshNodes() → None

Snap the coordinates of probe result to the mesh nodes.