FatigueTool
Last update: 14.01.2025
FatigueTool
class Ansys.ACT.Automation.Mechanical.FatigueTool
Bases: object
Defines a FatigueTool.
Overview
Methods
Name | Description |
---|---|
Activate |
Activate the current object. |
AddBiaxialityIndication |
Creates a new FatigueBiaxialityIndication |
AddComment |
Creates a new child Comment. |
AddDamage |
Creates a new FatigueDamage |
AddDamageMatrix |
Creates a new FatigueDamageMatrix |
AddEquivalentAlternativeStress |
Creates a new FatigueEquivalentAlternativeStress |
AddFatigueSensitivity |
Creates a new FatigueSensitivity |
AddHysteresis |
Creates a new FatigueHysteresis |
AddImage |
Creates a new child Image. |
AddLife |
Creates a new FatigueLife |
AddRainflowMatrix |
Creates a new FatigueRainflowMatrix |
AddSafetyFactor |
Creates a new FatigueSafetyFactor |
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. |
DuplicateWithoutResults |
Run the DuplicateWithoutResults action. |
EvaluateAllResults |
Run the EvaluateAllResults 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. |
Properties
Name | Description |
---|---|
AnalysisType |
Gets or sets the AnalysisType. |
BinSize |
Gets or sets the BinSize. |
Children |
Gets the list of children. |
Comments |
Gets the list of associated comments. |
CustomUnitsName |
Gets or sets the Custom Units Name. |
DataModelObjectCategory |
Gets the current DataModelObject’s category. |
DisplayTime |
Gets or sets the DisplayTime. |
ExposureDuration |
Gets or sets the ExposureDuration. |
FatigueStrengthFactor |
Gets or sets the FatigueStrengthFactor. |
Frequency |
Gets or sets the Frequency. |
FrequencySelection |
Gets or sets the FrequencySelection. |
HistoryDataLocation |
Gets or sets the HistoryDataLocation. |
Images |
Gets the list of associated images. |
InfiniteLife |
Gets or sets the InfiniteLife. |
InternalObject |
Gets the internal object. For advanced usage only. |
LoadingRatio |
Gets or sets the LoadingRatio. |
LoadingType |
Gets or sets the LoadingType. |
MaximumDataPointsToPlot |
Gets or sets the MaximumDataPointsToPlot. |
MeanStressTheory |
Gets or sets the MeanStressTheory. |
MethodSelection |
Gets or sets the MethodSelection. |
OneCycleIsEqualTo |
Gets or sets the OneCycleIsEqualTo. |
Properties |
Gets the list of properties for this object. |
ResultsInput |
Gets or sets the ResultsInput. |
ScaleFactor |
Gets or sets the ScaleFactor. |
StressComponent |
Gets or sets the StressComponent. |
UnitsName |
Gets or sets the UnitsName. |
UseQuickRainflowCounting |
Gets or sets the UseQuickRainflowCounting. |
VisibleProperties |
Gets the list of properties that are visible for this object. |
Property detail
property FatigueTool.AnalysisType : Ansys.Mechanical.DataModel.Enums.FatigueToolAnalysisType | None
Gets or sets the AnalysisType.
property FatigueTool.BinSize : int | None
Gets or sets the BinSize.
property FatigueTool.Children : List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
property FatigueTool.Comments : Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
property FatigueTool.CustomUnitsName : str | None
Gets or sets the Custom Units Name.
property FatigueTool.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
property FatigueTool.DisplayTime : Ansys.Core.Units.Quantity | None
Gets or sets the DisplayTime.
property FatigueTool.ExposureDuration : Ansys.Core.Units.Quantity | None
Gets or sets the ExposureDuration.
property FatigueTool.FatigueStrengthFactor : float | None
Gets or sets the FatigueStrengthFactor.
property FatigueTool.Frequency : Ansys.Core.Units.Quantity | None
Gets or sets the Frequency.
property FatigueTool.FrequencySelection : Ansys.Mechanical.DataModel.Enums.FatigueFrequencySelection | None
Gets or sets the FrequencySelection.
property FatigueTool.HistoryDataLocation : str | None
Gets or sets the HistoryDataLocation.
property FatigueTool.Images : Iterable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
property FatigueTool.InfiniteLife : float | None
Gets or sets the InfiniteLife.
property FatigueTool.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSFatigueToolAuto | None
Gets the internal object. For advanced usage only.
property FatigueTool.LoadingRatio : float | None
Gets or sets the LoadingRatio.
property FatigueTool.LoadingType : Ansys.Mechanical.DataModel.Enums.FatigueLoadType | None
Gets or sets the LoadingType.
property FatigueTool.MaximumDataPointsToPlot : float | None
Gets or sets the MaximumDataPointsToPlot.
property FatigueTool.MeanStressTheory : Ansys.Mechanical.DataModel.Enums.MeanStressTheoryType | None
Gets or sets the MeanStressTheory.
property FatigueTool.MethodSelection : Ansys.Mechanical.DataModel.Enums.FatigueToolMethod | None
Gets or sets the MethodSelection.
property FatigueTool.OneCycleIsEqualTo : Ansys.Core.Units.Quantity | None
Gets or sets the OneCycleIsEqualTo.
property FatigueTool.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
property FatigueTool.ResultsInput : Ansys.Mechanical.DataModel.Enums.FatigueToolResultsInputType | None
Gets or sets the ResultsInput.
property FatigueTool.ScaleFactor : float | None
Gets or sets the ScaleFactor.
property FatigueTool.StressComponent : Ansys.Mechanical.DataModel.Enums.FatigueStressComponentType | None
Gets or sets the StressComponent.
property FatigueTool.UnitsName : Ansys.Mechanical.DataModel.Enums.LifeUnitsType | None
Gets or sets the UnitsName.
property FatigueTool.UseQuickRainflowCounting : bool | None
Gets or sets the UseQuickRainflowCounting.
property FatigueTool.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
Method detail
FatigueTool.Activate()
Activate the current object.
FatigueTool.AddBiaxialityIndication()
Creates a new FatigueBiaxialityIndication
FatigueTool.AddComment()
Creates a new child Comment.
FatigueTool.AddDamage()
Creates a new FatigueDamage
FatigueTool.AddDamageMatrix()
Creates a new FatigueDamageMatrix
FatigueTool.AddEquivalentAlternativeStress()
Creates a new FatigueEquivalentAlternativeStress
FatigueTool.AddFatigueSensitivity()
Creates a new FatigueSensitivity
FatigueTool.AddHysteresis()
Creates a new FatigueHysteresis
FatigueTool.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.
FatigueTool.AddLife()
Creates a new FatigueLife
FatigueTool.AddRainflowMatrix()
Creates a new FatigueRainflowMatrix
FatigueTool.AddSafetyFactor()
Creates a new FatigueSafetyFactor
FatigueTool.ClearGeneratedData()
Run the ClearGeneratedData action.
FatigueTool.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)
Copies all visible properties from this object to another.
FatigueTool.CreateParameter(propName: str)
Creates a new parameter for a Property.
FatigueTool.Delete()
Run the Delete action.
FatigueTool.Duplicate()
Creates a copy of the current DataModelObject.
FatigueTool.DuplicateWithoutResults()
Run the DuplicateWithoutResults action.
FatigueTool.EvaluateAllResults()
Run the EvaluateAllResults action.
FatigueTool.GetChildren(recurses: bool, children: List[ChildrenType])
Gets the list of children, filtered by type.
FatigueTool.GetParameter(propName: str)
Gets the parameter corresponding to the given property.
FatigueTool.GroupAllSimilarChildren()
Run the GroupAllSimilarChildren action.
FatigueTool.GroupSimilarObjects()
Run the GroupSimilarObjects action.
FatigueTool.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.
FatigueTool.PropertyByName(name: str)
Get a property by its unique name.
FatigueTool.RemoveParameter(propName: str)
Removes the parameter from the parameter set corresponding to the given property.