`VelocityWaterfallDiagram`

class Ansys.ACT.Automation.Mechanical.Results.FrequencyResponseResults.VelocityWaterfallDiagram

Bases: object

Defines a VelocityWaterfallDiagram.

Overview

Methods

Name	Description
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.
BodyWhereMaximumOccurs	Gets the body that has the maximum result value.
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

Name	Description
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.
DataModelObjectCategory	Gets the current DataModelObject's category.
DisplayOption	Gets or sets the DisplayOption.
DisplayTime	Gets or sets the DisplayTime.
DpfEvaluation	Gets or sets the DpfEvaluation.
Figures	Gets the list of associated figures.
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.
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.
NamedSelections	Gets or sets the NamedSelections.
NormalOrientation	Gets or sets the NormalOrientation.
Path	Path property.
PlotData	Gets the result table.
Properties	Gets the list of properties for this object.
RPMSelection	Gets or sets the RPM Selection value at which the results are evaluated.
STFTCutoffFrequency	Gets or sets the STFTCutoffFrequency.
STFTEndTime	Gets or sets the STFTEndTime.
STFTMinFreqResolution	Gets or sets the STFTMinFreqResolution.
STFTNumberSlice	Gets or sets the STFTNumberSlice.
STFTOverlap	Gets or sets the STFTOverlap.
STFTStartTime	Gets or sets the STFTStartTime.
STFTWindowType	Gets or sets the STFTWindowType.
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.
SpatialResolution	Gets or sets the SpatialResolution.
Substep	Gets the Substep.
Suppressed	Gets or sets the Suppressed.
Surface	Surface property.
SurfaceCoating	SurfaceCoating property.
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 VelocityWaterfallDiagram.Average : Ansys.Core.Units.Quantity | None

Gets the Average.

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

Gets or sets the By.

property VelocityWaterfallDiagram.CalculateTimeHistory : bool | None

Gets or sets the CalculateTimeHistory.

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

Gets the list of children.

property VelocityWaterfallDiagram.CombinationNumber : int | None

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

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

Gets the list of associated comments.

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

Gets or sets the CrackFrontNumber.

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

Gets the current DataModelObject's category.

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

Gets or sets the DisplayOption.

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

Gets or sets the DisplayTime.

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

Gets or sets the DpfEvaluation.

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

Gets the list of associated figures.

property VelocityWaterfallDiagram.GlobalIDs : str | None

Gets or sets the GlobalIDs.

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

Gets or sets the GraphControlsXAxis.

property VelocityWaterfallDiagram.Identifier : str | None

Gets or sets the Identifier.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

property VelocityWaterfallDiagram.IsSolved : bool | None

Gets the IsSolved.

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

Gets or sets the ItemType.

property VelocityWaterfallDiagram.IterationNumber : int | None

Gets the IterationNumber.

property VelocityWaterfallDiagram.LoadStep : int | None

Gets the LoadStep.

property VelocityWaterfallDiagram.LoadStepForMaximumOfMaximumValues : int | None

Get the Load Step for the maximum of maximum values.

property VelocityWaterfallDiagram.LoadStepForMaximumOfMinimumValues : int | None

Get the Load Step for the maximum of minimum values.

property VelocityWaterfallDiagram.LoadStepForMinimumOfMaximumValues : int | None

Get the Load Step for the minimum of maximum values.

property VelocityWaterfallDiagram.LoadStepForMinimumOfMinimumValues : int | None

Get the Load Step for the minimum of minimum values.

property VelocityWaterfallDiagram.LoadStepNumber : int | None

Gets or sets the LoadStepNumber.

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

Gets or sets the Location.

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

Gets the Maximum.

property VelocityWaterfallDiagram.MaximumOccursOn : str | None

Gets the MaximumOccursOn.

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

Gets the MaximumOfMaximumOverTime.

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

Gets the MaximumOfMinimumOverTime.

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

Gets the Minimum.

property VelocityWaterfallDiagram.MinimumOccursOn : str | None

Gets the MinimumOccursOn.

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

Gets the MinimumOfMaximumOverTime.

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

Gets the MinimumOfMinimumOverTime.

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

Gets or sets the NamedSelections.

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

Gets or sets the NormalOrientation.

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

Path property.

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

Gets the result table.

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

Gets the list of properties for this object.

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

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

property VelocityWaterfallDiagram.STFTCutoffFrequency : Ansys.Core.Units.Quantity | None

Gets or sets the STFTCutoffFrequency.

property VelocityWaterfallDiagram.STFTEndTime : Ansys.Core.Units.Quantity | None

Gets or sets the STFTEndTime.

property VelocityWaterfallDiagram.STFTMinFreqResolution : Ansys.Core.Units.Quantity | None

Gets or sets the STFTMinFreqResolution.

property VelocityWaterfallDiagram.STFTNumberSlice : int | None

Gets or sets the STFTNumberSlice.

property VelocityWaterfallDiagram.STFTOverlap : float | None

Gets or sets the STFTOverlap.

property VelocityWaterfallDiagram.STFTStartTime : Ansys.Core.Units.Quantity | None

Gets or sets the STFTStartTime.

property VelocityWaterfallDiagram.STFTWindowType : Ansys.Mechanical.DataModel.Enums.WindowType | None

Gets or sets the STFTWindowType.

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

Gets or sets the ScopingMethod.

property VelocityWaterfallDiagram.SetNumber : int | None

Gets or sets the Set Number.

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

Gets or sets the SolutionCombinationDriver.

property VelocityWaterfallDiagram.SolverComponentIDs : str | None

Gets or sets the SolverComponentIDs.

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

Gets or sets the SpatialResolution.

property VelocityWaterfallDiagram.Substep : int | None

Gets the Substep.

property VelocityWaterfallDiagram.Suppressed : bool | None

Gets or sets the Suppressed.

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

Surface property.

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

SurfaceCoating property.

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

Gets the Time.

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

Get the Time for the maximum of maximum values.

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

Get the Time for the maximum of minimum values.

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

Get the Time for the minimum of maximum values.

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

Get the Time for the minimum of minimum values.

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

Gets the Total.

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

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

Method detail

VelocityWaterfallDiagram.Activate() → None

Activate the current object.

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

Creates a new Alert

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

Creates a new child Comment.

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

Creates a new Convergence

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

Creates a new child Figure.

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

VelocityWaterfallDiagram.BodyWhereMaximumOccurs() → Ansys.ACT.Automation.Mechanical.Body

Gets the body that has the maximum result value.
Throws an exception if body not found.

VelocityWaterfallDiagram.ClearGeneratedData() → None

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

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

CreateParameter method.

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

Creates results at all sets for results under a solution.

VelocityWaterfallDiagram.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Run the DuplicateWithoutResults action.

VelocityWaterfallDiagram.EvaluateAllResults() → None

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

VelocityWaterfallDiagram.ExportToTextFile(filePath: str) → None

Run the ExportToTextFile action.

VelocityWaterfallDiagram.FetchRemoteResults() → None

Run the FetchRemoteResult action.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

VelocityWaterfallDiagram.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

Run the PromoteToNamedSelection action.

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

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

Get a property by its unique name.

VelocityWaterfallDiagram.RemoveParameter(propName: str) → None

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

VelocityWaterfallDiagram.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

VelocityWaterfallDiagram.RetrieveResult() → None

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