Skip to main content

Mechanical scripting interface

FatigueRainflowMatrix

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.Results.FatigueToolResults.FatigueRainflowMatrix

Bases: object

Defines a FatigueRainflowMatrix.

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.
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.
MaximumMean Gets the MaximumMean.
MaximumRange Gets the MaximumRange.
Minimum Gets the Minimum.
MinimumFrequency Gets or sets the MinimumFrequency.
MinimumMean Gets the MinimumMean.
MinimumRange Gets the MinimumRange.
NamedSelections Gets or sets the NamedSelections.
NormalOrientation Gets or sets the NormalOrientation.
OutputUnit Gets or sets the OutputUnit.
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 FatigueRainflowMatrix.AccelerationType : Ansys.Mechanical.DataModel.Enums.TotalOrDirectional | None

Gets or sets the AccelerationType.

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

Gets or sets the BoundaryCondition.

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

Gets or sets the Chart Dimensions

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

Gets or sets the ChartViewingStyle.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the CoordinateSystem.

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

Gets or sets the CurvesAppearanceDisplay.

property FatigueRainflowMatrix.CutFrequency : float | None

Gets or sets the CutFrequency.

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

Gets the current DataModelObject’s category.

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

Gets or sets the DeformationType.

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

Gets or sets the DpfEvaluation.

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

Gets or sets the Duration.

property FatigueRainflowMatrix.EnhancedTracking : bool | None

Gets the EnhancedTracking.

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

Gets the FilterMaximum.

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

Gets the FilterMinimum.

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

Gets or sets the FilterType.

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

Gets the FrequencyAtMaximumAmplitude.

property FatigueRainflowMatrix.GeometrySelectionString : str | None

Gets or sets the GeometrySelectionString.

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

Gets the list of associated images.

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

Gets the ImaginaryAtMaximumAmplitude.

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

Gets the internal object. For advanced usage only.

property FatigueRainflowMatrix.IsSolved : bool | None

Gets the IsSolved.

property FatigueRainflowMatrix.LoadStepNumber : int | None

Gets or sets the LoadStepNumber.

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

Gets or sets the Location.

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

Gets the Maximum.

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

Gets the MaximumAmplitude.

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

Gets or sets the MaximumFrequency.

property FatigueRainflowMatrix.MaximumMean : Ansys.Core.Units.Quantity | None

Gets the MaximumMean.

property FatigueRainflowMatrix.MaximumRange : Ansys.Core.Units.Quantity | None

Gets the MaximumRange.

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

Gets the Minimum.

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

Gets or sets the MinimumFrequency.

property FatigueRainflowMatrix.MinimumMean : Ansys.Core.Units.Quantity | None

Gets the MinimumMean.

property FatigueRainflowMatrix.MinimumRange : Ansys.Core.Units.Quantity | None

Gets the MinimumRange.

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

Gets or sets the NamedSelections.

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

Gets or sets the NormalOrientation.

property FatigueRainflowMatrix.OutputUnit : Ansys.Mechanical.DataModel.Enums.UnitCategoryType | None

Gets or sets the OutputUnit.

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

Gets the PhaseAngle.

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

Gets the list of properties for this object.

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

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

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

Gets the RealAtMaximumAmplitude.

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

Gets the ReportedFrequency.

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

Gets or sets the RequestedFrequency.

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

Gets the ResultChartType.

property FatigueRainflowMatrix.SectorNumber : int | None

Gets or sets the SectorNumber.

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

Gets or sets the ShearOrientation.

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

Gets or sets the SpatialResolution.

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

Gets or sets the Spring.

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

Gets or sets the StressStrainType.

property FatigueRainflowMatrix.Suppressed : bool | None

Gets or sets the Suppressed.

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

Gets or sets the TimeHistoryDisplay.

property FatigueRainflowMatrix.UseParentFrequencyRange : bool | None

Gets or sets the UseParentFrequencyRange.

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

Gets or sets the VelocityType.

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

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

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

Gets or sets the XAxisValues.

Method detail

FatigueRainflowMatrix.Activate()

Activate the current object.

FatigueRainflowMatrix.AddComment()

Creates a new child Comment.

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

FatigueRainflowMatrix.ClearGeneratedData()

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

FatigueRainflowMatrix.CreateParameter(propName: str)

Creates a new parameter for a Property.

FatigueRainflowMatrix.Delete()

Run the Delete action.

FatigueRainflowMatrix.Duplicate()

Creates a copy of the current DataModelObject.

FatigueRainflowMatrix.EvaluateAllResults()

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

FatigueRainflowMatrix.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

FatigueRainflowMatrix.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

FatigueRainflowMatrix.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

FatigueRainflowMatrix.PropertyByName(name: str)

Get a property by its unique name.

FatigueRainflowMatrix.RemoveParameter(propName: str)

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

FatigueRainflowMatrix.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.