`FatigueTool`#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.FatigueTool#

Bases: object

Defines a FatigueTool.

Overview#

Methods

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

Properties

`OneCycleIsEqualTo`	Gets or sets the OneCycleIsEqualTo.
`CustomUnitsName`	Gets or sets the Custom Units Name.
`InternalObject`	Gets the internal object. For advanced usage only.
`FatigueStrengthFactor`	Gets or sets the FatigueStrengthFactor.
`HistoryDataLocation`	Gets or sets the HistoryDataLocation.
`InfiniteLife`	Gets or sets the InfiniteLife.
`LoadingRatio`	Gets or sets the LoadingRatio.
`MaximumDataPointsToPlot`	Gets or sets the MaximumDataPointsToPlot.
`BinSize`	Gets or sets the BinSize.
`ScaleFactor`	Gets or sets the ScaleFactor.
`ExposureDuration`	Gets or sets the ExposureDuration.
`Frequency`	Gets or sets the Frequency.
`DisplayTime`	Gets or sets the DisplayTime.
`MeanStressTheory`	Gets or sets the MeanStressTheory.
`FrequencySelection`	Gets or sets the FrequencySelection.
`LoadingType`	Gets or sets the LoadingType.
`MethodSelection`	Gets or sets the MethodSelection.
`ResultsInput`	Gets or sets the ResultsInput.
`StressComponent`	Gets or sets the StressComponent.
`AnalysisType`	Gets or sets the AnalysisType.
`UnitsName`	Gets or sets the UnitsName.
`UseQuickRainflowCounting`	Gets or sets the UseQuickRainflowCounting.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`Images`	Gets the list of associated images.
`InternalObject`	Gets the internal object. For advanced usage only.
`Properties`	Gets the list of properties for this object.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property FatigueTool.OneCycleIsEqualTo: Ansys.Core.Units.Quantity | None: Gets or sets the OneCycleIsEqualTo.

property FatigueTool.CustomUnitsName: System.String | None: Gets or sets the Custom Units Name.

property FatigueTool.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSFatigueToolAuto | None: Gets the internal object. For advanced usage only.

property FatigueTool.FatigueStrengthFactor: System.Double | None: Gets or sets the FatigueStrengthFactor.

property FatigueTool.HistoryDataLocation: System.String | None: Gets or sets the HistoryDataLocation.

property FatigueTool.InfiniteLife: System.Double | None: Gets or sets the InfiniteLife.

property FatigueTool.LoadingRatio: System.Double | None: Gets or sets the LoadingRatio.

property FatigueTool.MaximumDataPointsToPlot: System.Double | None: Gets or sets the MaximumDataPointsToPlot.

property FatigueTool.BinSize: System.Int32 | None: Gets or sets the BinSize.

property FatigueTool.ScaleFactor: System.Double | None: Gets or sets the ScaleFactor.

property FatigueTool.ExposureDuration: Ansys.Core.Units.Quantity | None: Gets or sets the ExposureDuration.

property FatigueTool.Frequency: Ansys.Core.Units.Quantity | None: Gets or sets the Frequency.

property FatigueTool.DisplayTime: Ansys.Core.Units.Quantity | None: Gets or sets the DisplayTime.

property FatigueTool.MeanStressTheory: Ansys.Mechanical.DataModel.Enums.MeanStressTheoryType | None: Gets or sets the MeanStressTheory.

property FatigueTool.FrequencySelection: Ansys.Mechanical.DataModel.Enums.FatigueFrequencySelection | None: Gets or sets the FrequencySelection.

property FatigueTool.LoadingType: Ansys.Mechanical.DataModel.Enums.FatigueLoadType | None: Gets or sets the LoadingType.

property FatigueTool.MethodSelection: Ansys.Mechanical.DataModel.Enums.FatigueToolMethod | None: Gets or sets the MethodSelection.

property FatigueTool.ResultsInput: Ansys.Mechanical.DataModel.Enums.FatigueToolResultsInputType | None: Gets or sets the ResultsInput.

property FatigueTool.StressComponent: Ansys.Mechanical.DataModel.Enums.FatigueStressComponentType | None: Gets or sets the StressComponent.

property FatigueTool.AnalysisType: Ansys.Mechanical.DataModel.Enums.FatigueToolAnalysisType | None: Gets or sets the AnalysisType.

property FatigueTool.UnitsName: Ansys.Mechanical.DataModel.Enums.LifeUnitsType | None: Gets or sets the UnitsName.

property FatigueTool.UseQuickRainflowCounting: System.Boolean | None: Gets or sets the UseQuickRainflowCounting.

property FatigueTool.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property FatigueTool.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property FatigueTool.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property FatigueTool.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property FatigueTool.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property FatigueTool.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property FatigueTool.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

FatigueTool.EvaluateAllResults() → System.Void: Run the EvaluateAllResults action.

FatigueTool.ClearGeneratedData() → System.Void: Run the ClearGeneratedData action.

FatigueTool.DuplicateWithoutResults() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Run the DuplicateWithoutResults action.

FatigueTool.AddBiaxialityIndication() → Ansys.ACT.Automation.Mechanical.Results.FatigueToolResults.FatigueBiaxialityIndication: Creates a new FatigueBiaxialityIndication

FatigueTool.AddDamage() → Ansys.ACT.Automation.Mechanical.Results.FatigueToolResults.FatigueDamage: Creates a new FatigueDamage

FatigueTool.AddDamageMatrix() → Ansys.ACT.Automation.Mechanical.Results.FatigueToolResults.FatigueDamageMatrix: Creates a new FatigueDamageMatrix

FatigueTool.AddEquivalentAlternativeStress() → Ansys.ACT.Automation.Mechanical.Results.FatigueToolResults.FatigueEquivalentAlternativeStress: Creates a new FatigueEquivalentAlternativeStress

FatigueTool.AddHysteresis() → Ansys.ACT.Automation.Mechanical.Results.FatigueToolResults.FatigueHysteresis: Creates a new FatigueHysteresis

FatigueTool.AddLife() → Ansys.ACT.Automation.Mechanical.Results.FatigueToolResults.FatigueLife: Creates a new FatigueLife

FatigueTool.AddRainflowMatrix() → Ansys.ACT.Automation.Mechanical.Results.FatigueToolResults.FatigueRainflowMatrix: Creates a new FatigueRainflowMatrix

FatigueTool.AddSafetyFactor() → Ansys.ACT.Automation.Mechanical.Results.FatigueToolResults.FatigueSafetyFactor: Creates a new FatigueSafetyFactor

FatigueTool.AddFatigueSensitivity() → Ansys.ACT.Automation.Mechanical.Results.FatigueToolResults.FatigueSensitivity: Creates a new FatigueSensitivity

FatigueTool.Delete() → System.Void: Run the Delete action.

FatigueTool.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

FatigueTool.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Gets the list of children, filtered by type.

FatigueTool.AddComment() → Ansys.ACT.Automation.Mechanical.Comment: Creates a new child Comment.

FatigueTool.AddImage(filePath: System.String) → 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.

FatigueTool.Activate() → System.Void: Activate the current object.

FatigueTool.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

FatigueTool.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

FatigueTool.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

FatigueTool.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

FatigueTool.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

FatigueTool.PropertyByAPIName(name: System.String) → 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.

FatigueTool.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

FatigueTool.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

FatigueTool.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.