## On this page

  

 

 # `FatigueTool`

 Last update: 09.03.2026 

<a id="ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.FatigueTool"></a>

#### *class* Ansys.ACT.Automation.Mechanical.FatigueTool

Bases: [`object`](https://docs.python.org/3/library/functions.html#object)

Defines a FatigueTool.

<a id="overview"></a>

## Overview

### Methods

NameDescription[`Activate`](#FatigueTool.Activate)Activate the current object.[`AddBiaxialityIndication`](#FatigueTool.AddBiaxialityIndication)Creates a new FatigueBiaxialityIndication[`AddComment`](#FatigueTool.AddComment)Creates a new child Comment.[`AddDamage`](#FatigueTool.AddDamage)Creates a new FatigueDamage[`AddDamageMatrix`](#FatigueTool.AddDamageMatrix)Creates a new FatigueDamageMatrix[`AddEquivalentAlternativeStress`](#FatigueTool.AddEquivalentAlternativeStress)Creates a new FatigueEquivalentAlternativeStress[`AddFatigueSensitivity`](#FatigueTool.AddFatigueSensitivity)Creates a new FatigueSensitivity[`AddHysteresis`](#FatigueTool.AddHysteresis)Creates a new FatigueHysteresis[`AddImage`](#FatigueTool.AddImage)Creates a new child Image.[`AddLife`](#FatigueTool.AddLife)Creates a new FatigueLife[`AddRainflowMatrix`](#FatigueTool.AddRainflowMatrix)Creates a new FatigueRainflowMatrix[`AddSafetyFactor`](#FatigueTool.AddSafetyFactor)Creates a new FatigueSafetyFactor[`ClearGeneratedData`](#FatigueTool.ClearGeneratedData)Run the ClearGeneratedData action.[`CopyTo`](#FatigueTool.CopyTo)Copies all visible properties from this object to another.[`CreateParameter`](#FatigueTool.CreateParameter)Creates a new parameter for a Property.[`Delete`](#FatigueTool.Delete)Run the Delete action.[`Duplicate`](#FatigueTool.Duplicate)Creates a copy of the current DataModelObject.[`DuplicateWithoutResults`](#FatigueTool.DuplicateWithoutResults)Run the DuplicateWithoutResults action.[`EvaluateAllResults`](#FatigueTool.EvaluateAllResults)Run the EvaluateAllResults action.[`GetChildren`](#FatigueTool.GetChildren)Gets the list of children, filtered by type.[`GetParameter`](#FatigueTool.GetParameter)Gets the parameter corresponding to the given property.[`GroupAllSimilarChildren`](#FatigueTool.GroupAllSimilarChildren)Run the GroupAllSimilarChildren action.[`GroupSimilarObjects`](#FatigueTool.GroupSimilarObjects)Run the GroupSimilarObjects action.[`PropertyByAPIName`](#FatigueTool.PropertyByAPIName)Get a property by its API name.[`PropertyByName`](#FatigueTool.PropertyByName)Get a property by its unique name.[`RemoveParameter`](#FatigueTool.RemoveParameter)Removes the parameter from the parameter set corresponding to the given property.### Properties

NameDescription[`AnalysisType`](#FatigueTool.AnalysisType)Gets or sets the AnalysisType.[`BinSize`](#FatigueTool.BinSize)Gets or sets the BinSize.[`Children`](#FatigueTool.Children)Gets the list of children.[`Comments`](#FatigueTool.Comments)Gets the list of associated comments.[`CustomUnitsName`](#FatigueTool.CustomUnitsName)Gets or sets the Custom Units Name.[`DataModelObjectCategory`](#FatigueTool.DataModelObjectCategory)Gets the current DataModelObject’s category.[`DisplayTime`](#FatigueTool.DisplayTime)Gets or sets the DisplayTime.[`ExposureDuration`](#FatigueTool.ExposureDuration)Gets or sets the ExposureDuration.[`FatigueStrengthFactor`](#FatigueTool.FatigueStrengthFactor)Gets or sets the FatigueStrengthFactor.[`Frequency`](#FatigueTool.Frequency)Gets or sets the Frequency.[`FrequencySelection`](#FatigueTool.FrequencySelection)Gets or sets the FrequencySelection.[`HistoryDataLocation`](#FatigueTool.HistoryDataLocation)Gets or sets the HistoryDataLocation.[`Images`](#FatigueTool.Images)Gets the list of associated images.[`InfiniteLife`](#FatigueTool.InfiniteLife)Gets or sets the InfiniteLife.[`InternalObject`](#FatigueTool.InternalObject)Gets the internal object. For advanced usage only.[`LoadingRatio`](#FatigueTool.LoadingRatio)Gets or sets the LoadingRatio.[`LoadingType`](#FatigueTool.LoadingType)Gets or sets the LoadingType.[`MaximumDataPointsToPlot`](#FatigueTool.MaximumDataPointsToPlot)Gets or sets the MaximumDataPointsToPlot.[`MeanStressTheory`](#FatigueTool.MeanStressTheory)Gets or sets the MeanStressTheory.[`MethodSelection`](#FatigueTool.MethodSelection)Gets or sets the MethodSelection.[`OneCycleIsEqualTo`](#FatigueTool.OneCycleIsEqualTo)Gets or sets the OneCycleIsEqualTo.[`Properties`](#FatigueTool.Properties)Gets the list of properties for this object.[`ResultsInput`](#FatigueTool.ResultsInput)Gets or sets the ResultsInput.[`ScaleFactor`](#FatigueTool.ScaleFactor)Gets or sets the ScaleFactor.[`StressComponent`](#FatigueTool.StressComponent)Gets or sets the StressComponent.[`UnitsName`](#FatigueTool.UnitsName)Gets or sets the UnitsName.[`UseQuickRainflowCounting`](#FatigueTool.UseQuickRainflowCounting)Gets or sets the UseQuickRainflowCounting.[`VisibleProperties`](#FatigueTool.VisibleProperties)Gets the list of properties that are visible for this object.<a id="property-detail"></a>

## Property detail

<a id="FatigueTool.AnalysisType"></a>

### *property* FatigueTool.AnalysisType *: [Ansys.Mechanical.DataModel.Enums.FatigueToolAnalysisType](../../../Mechanical/DataModel/Enums/FatigueToolAnalysisType.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.FatigueToolAnalysisType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the AnalysisType.

<a id="FatigueTool.BinSize"></a>

### *property* FatigueTool.BinSize *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the BinSize.

<a id="FatigueTool.Children"></a>

### *property* FatigueTool.Children *: List\[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of children.

<a id="FatigueTool.Comments"></a>

### *property* FatigueTool.Comments *: Iterable\[[Ansys.ACT.Automation.Mechanical.Comment](Comment.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.Comment)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated comments.

<a id="FatigueTool.CustomUnitsName"></a>

### *property* FatigueTool.CustomUnitsName *: [str](https://docs.python.org/3/library/stdtypes.html#str) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Custom Units Name.

<a id="FatigueTool.DataModelObjectCategory"></a>

### *property* FatigueTool.DataModelObjectCategory *: [Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory](../../../Mechanical/DataModel/Enums/DataModelObjectCategory.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the current DataModelObject’s category.

<a id="FatigueTool.DisplayTime"></a>

### *property* FatigueTool.DisplayTime *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the DisplayTime.

<a id="FatigueTool.ExposureDuration"></a>

### *property* FatigueTool.ExposureDuration *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ExposureDuration.

<a id="FatigueTool.FatigueStrengthFactor"></a>

### *property* FatigueTool.FatigueStrengthFactor *: [float](https://docs.python.org/3/library/functions.html#float) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the FatigueStrengthFactor.

<a id="FatigueTool.Frequency"></a>

### *property* FatigueTool.Frequency *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Frequency.

<a id="FatigueTool.FrequencySelection"></a>

### *property* FatigueTool.FrequencySelection *: [Ansys.Mechanical.DataModel.Enums.FatigueFrequencySelection](../../../Mechanical/DataModel/Enums/FatigueFrequencySelection.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.FatigueFrequencySelection) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the FrequencySelection.

<a id="FatigueTool.HistoryDataLocation"></a>

### *property* FatigueTool.HistoryDataLocation *: [str](https://docs.python.org/3/library/stdtypes.html#str) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the HistoryDataLocation.

<a id="FatigueTool.Images"></a>

### *property* FatigueTool.Images *: Iterable\[[Ansys.ACT.Automation.Mechanical.Image](Image.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.Image)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated images.

<a id="FatigueTool.InfiniteLife"></a>

### *property* FatigueTool.InfiniteLife *: [float](https://docs.python.org/3/library/functions.html#float) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the InfiniteLife.

<a id="FatigueTool.InternalObject"></a>

### *property* FatigueTool.InternalObject *: Ansys.Common.Interop.DSObjectsAuto.IDSFatigueToolAuto | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the internal object. For advanced usage only.

<a id="FatigueTool.LoadingRatio"></a>

### *property* FatigueTool.LoadingRatio *: [float](https://docs.python.org/3/library/functions.html#float) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the LoadingRatio.

<a id="FatigueTool.LoadingType"></a>

### *property* FatigueTool.LoadingType *: [Ansys.Mechanical.DataModel.Enums.FatigueLoadType](../../../Mechanical/DataModel/Enums/FatigueLoadType.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.FatigueLoadType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the LoadingType.

<a id="FatigueTool.MaximumDataPointsToPlot"></a>

### *property* FatigueTool.MaximumDataPointsToPlot *: [float](https://docs.python.org/3/library/functions.html#float) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the MaximumDataPointsToPlot.

<a id="FatigueTool.MeanStressTheory"></a>

### *property* FatigueTool.MeanStressTheory *: [Ansys.Mechanical.DataModel.Enums.MeanStressTheoryType](../../../Mechanical/DataModel/Enums/MeanStressTheoryType.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.MeanStressTheoryType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the MeanStressTheory.

<a id="FatigueTool.MethodSelection"></a>

### *property* FatigueTool.MethodSelection *: [Ansys.Mechanical.DataModel.Enums.FatigueToolMethod](../../../Mechanical/DataModel/Enums/FatigueToolMethod.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.FatigueToolMethod) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the MethodSelection.

<a id="FatigueTool.OneCycleIsEqualTo"></a>

### *property* FatigueTool.OneCycleIsEqualTo *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the OneCycleIsEqualTo.

<a id="FatigueTool.Properties"></a>

### *property* FatigueTool.Properties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties for this object.

<a id="FatigueTool.ResultsInput"></a>

### *property* FatigueTool.ResultsInput *: [Ansys.Mechanical.DataModel.Enums.FatigueToolResultsInputType](../../../Mechanical/DataModel/Enums/FatigueToolResultsInputType.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.FatigueToolResultsInputType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ResultsInput.

<a id="FatigueTool.ScaleFactor"></a>

### *property* FatigueTool.ScaleFactor *: [float](https://docs.python.org/3/library/functions.html#float) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ScaleFactor.

<a id="FatigueTool.StressComponent"></a>

### *property* FatigueTool.StressComponent *: [Ansys.Mechanical.DataModel.Enums.FatigueStressComponentType](../../../Mechanical/DataModel/Enums/FatigueStressComponentType.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.FatigueStressComponentType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the StressComponent.

<a id="FatigueTool.UnitsName"></a>

### *property* FatigueTool.UnitsName *: [Ansys.Mechanical.DataModel.Enums.LifeUnitsType](../../../Mechanical/DataModel/Enums/LifeUnitsType.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.LifeUnitsType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the UnitsName.

<a id="FatigueTool.UseQuickRainflowCounting"></a>

### *property* FatigueTool.UseQuickRainflowCounting *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the UseQuickRainflowCounting.

<a id="FatigueTool.VisibleProperties"></a>

### *property* FatigueTool.VisibleProperties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

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

<a id="method-detail"></a>

## Method detail

<a id="FatigueTool.Activate"></a>

### FatigueTool.Activate()

Activate the current object.

<a id="FatigueTool.AddBiaxialityIndication"></a>

### FatigueTool.AddBiaxialityIndication()

Creates a new FatigueBiaxialityIndication

<a id="FatigueTool.AddComment"></a>

### FatigueTool.AddComment()

Creates a new child Comment.

<a id="FatigueTool.AddDamage"></a>

### FatigueTool.AddDamage()

Creates a new FatigueDamage

<a id="FatigueTool.AddDamageMatrix"></a>

### FatigueTool.AddDamageMatrix()

Creates a new FatigueDamageMatrix

<a id="FatigueTool.AddEquivalentAlternativeStress"></a>

### FatigueTool.AddEquivalentAlternativeStress()

Creates a new FatigueEquivalentAlternativeStress

<a id="FatigueTool.AddFatigueSensitivity"></a>

### FatigueTool.AddFatigueSensitivity()

Creates a new FatigueSensitivity

<a id="FatigueTool.AddHysteresis"></a>

### FatigueTool.AddHysteresis()

Creates a new FatigueHysteresis

<a id="FatigueTool.AddImage"></a>

### FatigueTool.AddImage(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str))

```text
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.

```

<a id="FatigueTool.AddLife"></a>

### FatigueTool.AddLife()

Creates a new FatigueLife

<a id="FatigueTool.AddRainflowMatrix"></a>

### FatigueTool.AddRainflowMatrix()

Creates a new FatigueRainflowMatrix

<a id="FatigueTool.AddSafetyFactor"></a>

### FatigueTool.AddSafetyFactor()

Creates a new FatigueSafetyFactor

<a id="FatigueTool.ClearGeneratedData"></a>

### FatigueTool.ClearGeneratedData()

Run the ClearGeneratedData action.

<a id="FatigueTool.CopyTo"></a>

### FatigueTool.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

<a id="FatigueTool.CreateParameter"></a>

### FatigueTool.CreateParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Creates a new parameter for a Property.

<a id="FatigueTool.Delete"></a>

### FatigueTool.Delete()

Run the Delete action.

<a id="FatigueTool.Duplicate"></a>

### FatigueTool.Duplicate()

Creates a copy of the current DataModelObject.

<a id="FatigueTool.DuplicateWithoutResults"></a>

### FatigueTool.DuplicateWithoutResults()

Run the DuplicateWithoutResults action.

<a id="FatigueTool.EvaluateAllResults"></a>

### FatigueTool.EvaluateAllResults()

Run the EvaluateAllResults action.

<a id="FatigueTool.GetChildren"></a>

### FatigueTool.GetChildren(recurses: [bool](https://docs.python.org/3/library/functions.html#bool), children: List\[ChildrenType\])

Gets the list of children, filtered by type.

<a id="FatigueTool.GetParameter"></a>

### FatigueTool.GetParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Gets the parameter corresponding to the given property.

<a id="FatigueTool.GroupAllSimilarChildren"></a>

### FatigueTool.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

<a id="FatigueTool.GroupSimilarObjects"></a>

### FatigueTool.GroupSimilarObjects()

Run the GroupSimilarObjects action.

<a id="FatigueTool.PropertyByAPIName"></a>

### FatigueTool.PropertyByAPIName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

```text
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.

```

<a id="FatigueTool.PropertyByName"></a>

### FatigueTool.PropertyByName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

Get a property by its unique name.

<a id="FatigueTool.RemoveParameter"></a>

### FatigueTool.RemoveParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

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