DirectionalVelocityRS

class ansys.mechanical.stubs.Ansys.ACT.Automation.Mechanical.Results.DeformationResults.DirectionalVelocityRS

Bases: object

Defines a DirectionalVelocityRS.

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.
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.
RetrieveResult	Evaluates the individual result without evaluating all the results in the same solution.

Properties

AccelerationInG	Gets or sets the AccelerationInG.
AllowPhaseSweep	Gets or sets the AllowPhaseSweep.
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.
CyclicMode	Gets or sets the CyclicMode.
CyclicPhase	Gets or sets the CyclicPhase.
DampedFrequency	Gets the DampedFrequency.
DataModelObjectCategory	Gets the current DataModelObject's category.
DeformationType	Gets or sets the DeformationType.
DisplayOption	Gets or sets the DisplayOption.
DisplayTime	Gets or sets the DisplayTime.
DpfEvaluation	Gets or sets the DpfEvaluation.
EnvironmentSelection	Gets or sets the EnvironmentSelection.
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.
HarmonicIndex	Gets or sets the HarmonicIndex.
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.
IterationStep	Gets or sets the IterationStep.
LoadMultiplier	Gets the LoadMultiplier.
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.
NormalOrientation	Gets or sets the NormalOrientation.
Path	Path property.
PhaseIncrement	Gets or sets the PhaseIncrement.
PlotData	Gets the result table.
Probability	Gets the Probability.
Properties	Gets the list of properties for this object.
RPMSelection	Gets or sets the RPM Selection value at which the results are evaluated.
Reference	Gets the Reference.
ReportedFrequency	Gets the ReportedFrequency.
ScaleFactor	Gets or sets the ScaleFactor.
ScaleFactorValue	Gets or sets the ScaleFactorValue.
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 DirectionalVelocityRS.AccelerationInG: bool | None

Gets or sets the AccelerationInG.

property DirectionalVelocityRS.AllowPhaseSweep: bool | None

Gets or sets the AllowPhaseSweep.

property DirectionalVelocityRS.Amplitude: bool | None

Gets or sets the Amplitude.

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

Gets the Average.

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

Gets or sets the By.

property DirectionalVelocityRS.CalculateTimeHistory: bool | None

Gets or sets the CalculateTimeHistory.

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

Gets the list of children.

property DirectionalVelocityRS.CombinationNumber: int | None

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

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

Gets the list of associated comments.

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

Gets or sets the CrackFrontNumber.

property DirectionalVelocityRS.CyclicMode: int | None

Gets or sets the CyclicMode.

property DirectionalVelocityRS.CyclicPhase: Ansys.Core.Units.Quantity | None

Gets or sets the CyclicPhase.

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

Gets the DampedFrequency.

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

Gets the current DataModelObject's category.

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

Gets or sets the DeformationType.

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

Gets or sets the DisplayOption.

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

Gets or sets the DisplayTime.

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

Gets or sets the DpfEvaluation.

property DirectionalVelocityRS.EnvironmentSelection: Ansys.ACT.Automation.Mechanical.Analysis | None

Gets or sets the EnvironmentSelection.

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

Gets the list of associated figures.

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

Gets or sets the Frequency.

property DirectionalVelocityRS.GlobalIDs: str | None

Gets or sets the GlobalIDs.

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

Gets or sets the GraphControlsXAxis.

property DirectionalVelocityRS.HarmonicIndex: int | None

Gets or sets the HarmonicIndex.

property DirectionalVelocityRS.Identifier: str | None

Gets or sets the Identifier.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

property DirectionalVelocityRS.IsSolved: bool | None

Gets the IsSolved.

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

Gets or sets the ItemType.

property DirectionalVelocityRS.IterationNumber: int | None

Gets the IterationNumber.

property DirectionalVelocityRS.IterationStep: int | None

Gets or sets the IterationStep.

property DirectionalVelocityRS.LoadMultiplier: float | None

Gets the LoadMultiplier.

property DirectionalVelocityRS.LoadStep: int | None

Gets the LoadStep.

property DirectionalVelocityRS.LoadStepForMaximumOfMaximumValues: int | None

Get the Load Step for the maximum of maximum values.

property DirectionalVelocityRS.LoadStepForMaximumOfMinimumValues: int | None

Get the Load Step for the maximum of minimum values.

property DirectionalVelocityRS.LoadStepForMinimumOfMaximumValues: int | None

Get the Load Step for the minimum of maximum values.

property DirectionalVelocityRS.LoadStepForMinimumOfMinimumValues: int | None

Get the Load Step for the minimum of minimum values.

property DirectionalVelocityRS.LoadStepNumber: int | None

Gets or sets the LoadStepNumber.

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

Gets or sets the Location.

property DirectionalVelocityRS.LogarithmicDecrement: float | None

Gets the LogarithmicDecrement.

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

Gets the Maximum.

property DirectionalVelocityRS.MaximumOccursOn: str | None

Gets the MaximumOccursOn.

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

Gets the MaximumOfMaximumOverTime.

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

Gets the MaximumOfMinimumOverTime.

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

Gets the Minimum.

property DirectionalVelocityRS.MinimumOccursOn: str | None

Gets the MinimumOccursOn.

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

Gets the MinimumOfMaximumOverTime.

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

Gets the MinimumOfMinimumOverTime.

property DirectionalVelocityRS.ModalDampingRatio: float | None

Gets the ModalDampingRatio.

property DirectionalVelocityRS.Mode: int | None

Gets or sets the Mode.

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

Gets or sets the NamedSelections.

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

Gets or sets the NormalOrientation.

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

Path property.

property DirectionalVelocityRS.PhaseIncrement: Ansys.Core.Units.Quantity | None

Gets or sets the PhaseIncrement.

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

Gets the result table.

property DirectionalVelocityRS.Probability: float | None

Gets the Probability.

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

Gets the list of properties for this object.

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

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

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

Gets the Reference.

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

Gets the ReportedFrequency.

property DirectionalVelocityRS.ScaleFactor: Ansys.Mechanical.DataModel.Enums.ScaleFactorType | None

Gets or sets the ScaleFactor.

property DirectionalVelocityRS.ScaleFactorValue: float | None

Gets or sets the ScaleFactorValue.

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

Gets or sets the ScopingMethod.

property DirectionalVelocityRS.SetNumber: int | None

Gets or sets the Set Number.

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

Gets or sets the SolutionCombinationDriver.

property DirectionalVelocityRS.SolverComponentIDs: str | None

Gets or sets the SolverComponentIDs.

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

Gets the Stability.

property DirectionalVelocityRS.Substep: int | None

Gets the Substep.

property DirectionalVelocityRS.Suppressed: bool | None

Gets or sets the Suppressed.

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

Surface property.

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

SurfaceCoating property.

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

Gets or sets the SweepingPhase.

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

Gets the Time.

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

Get the Time for the maximum of maximum values.

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

Get the Time for the maximum of minimum values.

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

Get the Time for the minimum of maximum values.

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

Get the Time for the minimum of minimum values.

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

Gets the Total.

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

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

Method detail

DirectionalVelocityRS.Activate() → None

Activate the current object.

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

Creates a new Alert

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

Creates a new child Comment.

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

Creates a new Convergence

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

Creates a new child Figure.

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

DirectionalVelocityRS.ClearGeneratedData() → None

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

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

CreateParameter method.

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

Creates results at all sets for results under a solution.

DirectionalVelocityRS.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Run the DuplicateWithoutResults action.

DirectionalVelocityRS.EvaluateAllResults() → None

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

DirectionalVelocityRS.ExportToTextFile(filePath: str) → None

Run the ExportToTextFile action.

DirectionalVelocityRS.FetchRemoteResults() → None

Run the FetchRemoteResult action.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

DirectionalVelocityRS.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

Run the PromoteToNamedSelection action.

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

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

Get a property by its unique name.

DirectionalVelocityRS.RemoveParameter(propName: str) → None

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

DirectionalVelocityRS.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

DirectionalVelocityRS.RetrieveResult() → None

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