Skip to main content

Mechanical scripting interface

VelocityPhaseResponse

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults.VelocityPhaseResponse

Bases: object

Defines a VelocityPhaseResponse.

Overview

Methods

Name Description
Activate Activate the current object.
AddComment Creates a new child Comment.
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.
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.

Properties

Name Description
AccelerationType Gets or sets the AccelerationType.
BoundaryCondition Gets or sets the BoundaryCondition.
ChartDimensions Gets or sets the Chart Dimensions
ChartViewingStyle Gets or sets the ChartViewingStyle.
Children Gets the list of children.
Comments Gets the list of associated comments.
ContactRegion Gets or sets the ContactRegion.
CoordinateSystem Gets or sets the CoordinateSystem.
CurvesAppearanceDisplay Gets or sets the CurvesAppearanceDisplay.
CutFrequency Gets or sets the CutFrequency.
DataModelObjectCategory Gets the current DataModelObject’s category.
DeformationType Gets or sets the DeformationType.
DpfEvaluation Gets or sets the DpfEvaluation.
Duration Gets or sets the Duration.
EnhancedTracking Gets the EnhancedTracking.
FilterMaximum Gets the FilterMaximum.
FilterMinimum Gets the FilterMinimum.
FilterType Gets or sets the FilterType.
FrequencyAtMaximumAmplitude Gets the FrequencyAtMaximumAmplitude.
GeometrySelectionString Gets or sets the GeometrySelectionString.
Images Gets the list of associated images.
ImaginaryAtMaximumAmplitude Gets the ImaginaryAtMaximumAmplitude.
InternalObject Gets the internal object. For advanced usage only.
IsSolved Gets the IsSolved.
LoadStepNumber Gets or sets the LoadStepNumber.
Location Gets or sets the Location.
Maximum Gets the Maximum.
MaximumAmplitude Gets the MaximumAmplitude.
MaximumFrequency Gets or sets the MaximumFrequency.
Minimum Gets the Minimum.
MinimumFrequency Gets or sets the MinimumFrequency.
NamedSelections Gets or sets the NamedSelections.
NormalOrientation Gets or sets the NormalOrientation.
PhaseAngle Gets the PhaseAngle.
Properties Gets the list of properties for this object.
RPMSelection Gets or sets the RPM Selection value at which the results are evaluated.
RealAtMaximumAmplitude Gets the RealAtMaximumAmplitude.
ReportedFrequency Gets the ReportedFrequency.
RequestedFrequency Gets or sets the RequestedFrequency.
ResultChartType Gets the ResultChartType.
SectorNumber Gets or sets the SectorNumber.
ShearOrientation Gets or sets the ShearOrientation.
SpatialResolution Gets or sets the SpatialResolution.
Spring Gets or sets the Spring.
StressStrainType Gets or sets the StressStrainType.
Suppressed Gets or sets the Suppressed.
TimeHistoryDisplay Gets or sets the TimeHistoryDisplay.
UseParentFrequencyRange Gets or sets the UseParentFrequencyRange.
VelocityType Gets or sets the VelocityType.
VisibleProperties Gets the list of properties that are visible for this object.
XAxisValues Gets or sets the XAxisValues.

Property detail

property VelocityPhaseResponse.AccelerationType : Ansys.Mechanical.DataModel.Enums.TotalOrDirectional | None

Gets or sets the AccelerationType.

property VelocityPhaseResponse.BoundaryCondition : Ansys.ACT.Automation.Mechanical.BoundaryConditions.GenericBoundaryCondition | None

Gets or sets the BoundaryCondition.

property VelocityPhaseResponse.ChartDimensions : Ansys.Mechanical.DataModel.Enums.ChartDimensions | None

Gets or sets the Chart Dimensions

property VelocityPhaseResponse.ChartViewingStyle : Ansys.Mechanical.DataModel.Enums.ChartAxisScaleType | None

Gets or sets the ChartViewingStyle.

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

Gets the list of children.

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

Gets the list of associated comments.

property VelocityPhaseResponse.ContactRegion : Ansys.ACT.Automation.Mechanical.Connections.ContactRegion | None

Gets or sets the ContactRegion.

property VelocityPhaseResponse.CoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the CoordinateSystem.

property VelocityPhaseResponse.CurvesAppearanceDisplay : Ansys.Mechanical.DataModel.Enums.ChartPlotStyle | None

Gets or sets the CurvesAppearanceDisplay.

property VelocityPhaseResponse.CutFrequency : float | None

Gets or sets the CutFrequency.

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

Gets the current DataModelObject’s category.

property VelocityPhaseResponse.DeformationType : Ansys.Mechanical.DataModel.Enums.TotalOrDirectional | None

Gets or sets the DeformationType.

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

Gets or sets the DpfEvaluation.

property VelocityPhaseResponse.Duration : Ansys.Core.Units.Quantity | None

Gets or sets the Duration.

property VelocityPhaseResponse.EnhancedTracking : bool | None

Gets the EnhancedTracking.

property VelocityPhaseResponse.FilterMaximum : Ansys.Core.Units.Quantity | None

Gets the FilterMaximum.

property VelocityPhaseResponse.FilterMinimum : Ansys.Core.Units.Quantity | None

Gets the FilterMinimum.

property VelocityPhaseResponse.FilterType : Ansys.Mechanical.DataModel.Enums.FilterType | None

Gets or sets the FilterType.

property VelocityPhaseResponse.FrequencyAtMaximumAmplitude : Ansys.Core.Units.Quantity | None

Gets the FrequencyAtMaximumAmplitude.

property VelocityPhaseResponse.GeometrySelectionString : str | None

Gets or sets the GeometrySelectionString.

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

Gets the list of associated images.

property VelocityPhaseResponse.ImaginaryAtMaximumAmplitude : Ansys.Core.Units.Quantity | None

Gets the ImaginaryAtMaximumAmplitude.

property VelocityPhaseResponse.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSResultChartAuto | None

Gets the internal object. For advanced usage only.

property VelocityPhaseResponse.IsSolved : bool | None

Gets the IsSolved.

property VelocityPhaseResponse.LoadStepNumber : int | None

Gets or sets the LoadStepNumber.

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

Gets or sets the Location.

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

Gets the Maximum.

property VelocityPhaseResponse.MaximumAmplitude : Ansys.Core.Units.Quantity | None

Gets the MaximumAmplitude.

property VelocityPhaseResponse.MaximumFrequency : Ansys.Core.Units.Quantity | None

Gets or sets the MaximumFrequency.

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

Gets the Minimum.

property VelocityPhaseResponse.MinimumFrequency : Ansys.Core.Units.Quantity | None

Gets or sets the MinimumFrequency.

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

Gets or sets the NamedSelections.

property VelocityPhaseResponse.NormalOrientation : Ansys.Mechanical.DataModel.Enums.NormalOrientationType | None

Gets or sets the NormalOrientation.

property VelocityPhaseResponse.PhaseAngle : Ansys.Core.Units.Quantity | None

Gets the PhaseAngle.

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

Gets the list of properties for this object.

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

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

property VelocityPhaseResponse.RealAtMaximumAmplitude : Ansys.Core.Units.Quantity | None

Gets the RealAtMaximumAmplitude.

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

Gets the ReportedFrequency.

property VelocityPhaseResponse.RequestedFrequency : Ansys.Core.Units.Quantity | None

Gets or sets the RequestedFrequency.

property VelocityPhaseResponse.ResultChartType : Ansys.Mechanical.DataModel.Enums.ChartResultType | None

Gets the ResultChartType.

property VelocityPhaseResponse.SectorNumber : int | None

Gets or sets the SectorNumber.

property VelocityPhaseResponse.ShearOrientation : Ansys.Mechanical.DataModel.Enums.ShearOrientationType | None

Gets or sets the ShearOrientation.

property VelocityPhaseResponse.SpatialResolution : Ansys.Mechanical.DataModel.Enums.MultipleNodeType | None

Gets or sets the SpatialResolution.

property VelocityPhaseResponse.Spring : Ansys.ACT.Automation.Mechanical.Connections.Spring | None

Gets or sets the Spring.

property VelocityPhaseResponse.StressStrainType : Ansys.Mechanical.DataModel.Enums.StressStrainType | None

Gets or sets the StressStrainType.

property VelocityPhaseResponse.Suppressed : bool | None

Gets or sets the Suppressed.

property VelocityPhaseResponse.TimeHistoryDisplay : Ansys.Mechanical.DataModel.Enums.TimeHistoryDisplayType | None

Gets or sets the TimeHistoryDisplay.

property VelocityPhaseResponse.UseParentFrequencyRange : bool | None

Gets or sets the UseParentFrequencyRange.

property VelocityPhaseResponse.VelocityType : Ansys.Mechanical.DataModel.Enums.TotalOrDirectional | None

Gets or sets the VelocityType.

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

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

property VelocityPhaseResponse.XAxisValues : Ansys.Mechanical.DataModel.Enums.XAxisValues | None

Gets or sets the XAxisValues.

Method detail

VelocityPhaseResponse.Activate()

Activate the current object.

VelocityPhaseResponse.AddComment()

Creates a new child Comment.

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

VelocityPhaseResponse.ClearGeneratedData()

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

VelocityPhaseResponse.CreateParameter(propName: str)

Creates a new parameter for a Property.

VelocityPhaseResponse.Delete()

Run the Delete action.

VelocityPhaseResponse.Duplicate()

Creates a copy of the current DataModelObject.

VelocityPhaseResponse.EvaluateAllResults()

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

VelocityPhaseResponse.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

VelocityPhaseResponse.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

VelocityPhaseResponse.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

VelocityPhaseResponse.PropertyByName(name: str)

Get a property by its unique name.

VelocityPhaseResponse.RemoveParameter(propName: str)

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

VelocityPhaseResponse.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.