`FractureTotalNumberOfCyclesProbe`#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureTotalNumberOfCyclesProbe#

Bases: object

Defines a FractureTotalNumberOfCyclesProbe.

Overview#

Methods

`Activate`	Activate the current object.
`AddComment`	Creates a new child Comment.
`AddFigure`	Creates a new child Figure.
`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.
`DuplicateWithoutResults`	Run the DuplicateWithoutResults action.
`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.
`SnapToMeshNodes`	Snap the coordinates of probe result to the mesh nodes.

Properties

`ActiveContour`	Gets or sets the ActiveContour.
`BeamSelection`	Gets or sets the BeamSelection.
`BoundaryConditionSelection`	Gets or sets the BoundaryConditionSelection. In order to select the option 'WeakSprings', please use the property 'LocationMethod = LocationDefinitionMethod.WeakSprings'.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`ContactRegionSelection`	Gets or sets the ContactRegionSelection.
`CoordinateSystemSelection`	Gets or sets the CoordinateSystemSelection.
`CrackLengthPercentage`	Gets or sets the CrackLengthPercentage.
`DataModelObjectCategory`	Gets the current DataModelObject's category.
`DisplayTime`	Gets or sets the DisplayTime.
`DpfEvaluation`	Gets or sets the DpfEvaluation.
`Figures`	Gets the list of associated figures.
`GeometryLocation`	Gets or sets the GeometryLocation.
`Images`	Gets the list of associated images.
`InternalObject`	Gets the internal object. For advanced usage only.
`IsSolved`	Gets the IsSolved.
`IterationNumber`	Gets the IterationNumber.
`LoadStep`	Gets the LoadStep.
`LoadStepNumber`	Gets or sets the LoadStepNumber.
`LocationMethod`	Gets or sets the LocationMethod.
`MaximumTotal`	Gets the MaximumTotal.
`MaximumValueOverTime`	Gets the MaximumValueOverTime.
`MaximumXAxis`	Gets the MaximumXAxis.
`MaximumYAxis`	Gets the MaximumYAxis.
`MaximumZAxis`	Gets the MaximumZAxis.
`MeshConnectionSelection`	Gets or sets the MeshConnectionSelection.
`MinimumTotal`	Gets the MinimumTotal.
`MinimumValueOverTime`	Gets the MinimumValueOverTime.
`MinimumXAxis`	Gets the MinimumXAxis.
`MinimumYAxis`	Gets the MinimumYAxis.
`MinimumZAxis`	Gets the MinimumZAxis.
`Orientation`	Gets or sets the Orientation. Accepts/Returns None if it is the Solution Coordinate System.
`Properties`	Gets the list of properties for this object.
`RemotePointSelection`	Gets or sets the RemotePointSelection.
`ResultProbeValue`	Gets the ResultProbeValue.
`ResultSelection`	Gets or sets the ResultSelection.
`SolverID`	Gets or sets the SolverID.
`SpatialResolution`	Gets or sets the SpatialResolution.
`SpringSelection`	Gets or sets the SpringSelection.
`Substep`	Gets the Substep.
`Summation`	Gets or sets the Summation.
`Suppressed`	Gets or sets the Suppressed.
`SurfaceSelection`	Gets or sets the MeshConnectionSelection.
`Time`	Gets the Time.
`Total`	Gets the Total.
`Type`	Gets the Type.
`VisibleProperties`	Gets the list of properties that are visible for this object.
`XAxis`	Gets the XAxis.
`YAxis`	Gets the YAxis.
`ZAxis`	Gets the ZAxis.

Property detail#

property FractureTotalNumberOfCyclesProbe.ActiveContour: int | None#: Gets or sets the ActiveContour.

property FractureTotalNumberOfCyclesProbe.BeamSelection: Ansys.ACT.Automation.Mechanical.Connections.Beam | None#: Gets or sets the BeamSelection.

property FractureTotalNumberOfCyclesProbe.BoundaryConditionSelection: Ansys.ACT.Automation.Mechanical.DataModelObject | None#: Gets or sets the BoundaryConditionSelection. In order to select the option 'WeakSprings', please use the property 'LocationMethod = LocationDefinitionMethod.WeakSprings'.

property FractureTotalNumberOfCyclesProbe.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#: Gets the list of children.

property FractureTotalNumberOfCyclesProbe.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None#: Gets the list of associated comments.

property FractureTotalNumberOfCyclesProbe.ContactRegionSelection: Ansys.ACT.Automation.Mechanical.Connections.ContactRegion | None#: Gets or sets the ContactRegionSelection.

property FractureTotalNumberOfCyclesProbe.CoordinateSystemSelection: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#: Gets or sets the CoordinateSystemSelection.

property FractureTotalNumberOfCyclesProbe.CrackLengthPercentage: int | None#: Gets or sets the CrackLengthPercentage.

property FractureTotalNumberOfCyclesProbe.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#: Gets the current DataModelObject's category.

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

property FractureTotalNumberOfCyclesProbe.DpfEvaluation: Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None#: Gets or sets the DpfEvaluation.

property FractureTotalNumberOfCyclesProbe.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#: Gets the list of associated figures.

property FractureTotalNumberOfCyclesProbe.GeometryLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#: Gets or sets the GeometryLocation.

property FractureTotalNumberOfCyclesProbe.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None#: Gets the list of associated images.

property FractureTotalNumberOfCyclesProbe.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSProbeResultAuto | None#: Gets the internal object. For advanced usage only.

property FractureTotalNumberOfCyclesProbe.IsSolved: bool | None#: Gets the IsSolved.

property FractureTotalNumberOfCyclesProbe.IterationNumber: int | None#: Gets the IterationNumber.

property FractureTotalNumberOfCyclesProbe.LoadStep: int | None#: Gets the LoadStep.

property FractureTotalNumberOfCyclesProbe.LoadStepNumber: int | None#: Gets or sets the LoadStepNumber.

property FractureTotalNumberOfCyclesProbe.LocationMethod: Ansys.Mechanical.DataModel.Enums.LocationDefinitionMethod | None#: Gets or sets the LocationMethod.

property FractureTotalNumberOfCyclesProbe.MaximumTotal: Ansys.Core.Units.Quantity | None#: Gets the MaximumTotal.

property FractureTotalNumberOfCyclesProbe.MaximumValueOverTime: int | None#: Gets the MaximumValueOverTime.

property FractureTotalNumberOfCyclesProbe.MaximumXAxis: Ansys.Core.Units.Quantity | None#: Gets the MaximumXAxis.

property FractureTotalNumberOfCyclesProbe.MaximumYAxis: Ansys.Core.Units.Quantity | None#: Gets the MaximumYAxis.

property FractureTotalNumberOfCyclesProbe.MaximumZAxis: Ansys.Core.Units.Quantity | None#: Gets the MaximumZAxis.

property FractureTotalNumberOfCyclesProbe.MeshConnectionSelection: Ansys.ACT.Automation.Mechanical.MeshConnection | None#: Gets or sets the MeshConnectionSelection.

property FractureTotalNumberOfCyclesProbe.MinimumTotal: Ansys.Core.Units.Quantity | None#: Gets the MinimumTotal.

property FractureTotalNumberOfCyclesProbe.MinimumValueOverTime: int | None#: Gets the MinimumValueOverTime.

property FractureTotalNumberOfCyclesProbe.MinimumXAxis: Ansys.Core.Units.Quantity | None#: Gets the MinimumXAxis.

property FractureTotalNumberOfCyclesProbe.MinimumYAxis: Ansys.Core.Units.Quantity | None#: Gets the MinimumYAxis.

property FractureTotalNumberOfCyclesProbe.MinimumZAxis: Ansys.Core.Units.Quantity | None#: Gets the MinimumZAxis.

property FractureTotalNumberOfCyclesProbe.Orientation: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#: Gets or sets the Orientation. Accepts/Returns None if it is the Solution Coordinate System.

property FractureTotalNumberOfCyclesProbe.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#: Gets the list of properties for this object.

property FractureTotalNumberOfCyclesProbe.RemotePointSelection: Ansys.ACT.Automation.Mechanical.RemotePoint | None#: Gets or sets the RemotePointSelection.

property FractureTotalNumberOfCyclesProbe.ResultProbeValue: int | None#: Gets the ResultProbeValue.

property FractureTotalNumberOfCyclesProbe.ResultSelection: Ansys.Mechanical.DataModel.Enums.ProbeDisplayFilter | None#: Gets or sets the ResultSelection.

property FractureTotalNumberOfCyclesProbe.SolverID: int | None#: Gets or sets the SolverID.

property FractureTotalNumberOfCyclesProbe.SpatialResolution: Ansys.Mechanical.DataModel.Enums.MinimumOrMaximum | None#: Gets or sets the SpatialResolution.

property FractureTotalNumberOfCyclesProbe.SpringSelection: Ansys.ACT.Automation.Mechanical.Connections.Spring | None#: Gets or sets the SpringSelection.

property FractureTotalNumberOfCyclesProbe.Substep: int | None#: Gets the Substep.

property FractureTotalNumberOfCyclesProbe.Summation: Ansys.Mechanical.DataModel.Enums.MomentsAtSummationPointType | None#: Gets or sets the Summation.

property FractureTotalNumberOfCyclesProbe.Suppressed: bool | None#: Gets or sets the Suppressed.

property FractureTotalNumberOfCyclesProbe.SurfaceSelection: Ansys.ACT.Automation.Mechanical.Surface | None#: Gets or sets the MeshConnectionSelection.

property FractureTotalNumberOfCyclesProbe.Time: Ansys.Core.Units.Quantity | None#: Gets the Time.

property FractureTotalNumberOfCyclesProbe.Total: Ansys.Core.Units.Quantity | None#: Gets the Total.

property FractureTotalNumberOfCyclesProbe.Type: Ansys.Mechanical.DataModel.Enums.ProbeResultType | None#: Gets the Type.

property FractureTotalNumberOfCyclesProbe.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#: Gets the list of properties that are visible for this object.

property FractureTotalNumberOfCyclesProbe.XAxis: Ansys.Core.Units.Quantity | None#: Gets the XAxis.

property FractureTotalNumberOfCyclesProbe.YAxis: Ansys.Core.Units.Quantity | None#: Gets the YAxis.

property FractureTotalNumberOfCyclesProbe.ZAxis: Ansys.Core.Units.Quantity | None#: Gets the ZAxis.

Method detail#

FractureTotalNumberOfCyclesProbe.Activate() → None#: Activate the current object.

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

FractureTotalNumberOfCyclesProbe.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure#: Creates a new child Figure.

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

FractureTotalNumberOfCyclesProbe.ClearGeneratedData() → None#: Run the ClearGeneratedData action.

FractureTotalNumberOfCyclesProbe.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None#: Copies all visible properties from this object to another.

FractureTotalNumberOfCyclesProbe.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter#: Creates a new parameter for a Property.

FractureTotalNumberOfCyclesProbe.Delete() → None#: Run the Delete action.

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

FractureTotalNumberOfCyclesProbe.DuplicateWithoutResults() → Ansys.ACT.Automation.Mechanical.DataModelObject#: Run the DuplicateWithoutResults action.

FractureTotalNumberOfCyclesProbe.EvaluateAllResults() → None#: Run the EvaluateAllResults action.

FractureTotalNumberOfCyclesProbe.ExportAnimation(filePath: str, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings) → None#: Run the ExportAnimation action.

FractureTotalNumberOfCyclesProbe.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]#: Gets the list of children, filtered by type.

FractureTotalNumberOfCyclesProbe.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter#: Gets the parameter corresponding to the given property.

FractureTotalNumberOfCyclesProbe.GroupAllSimilarChildren() → None#: Run the GroupAllSimilarChildren action.

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

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

FractureTotalNumberOfCyclesProbe.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property#: Get a property by its unique name.

FractureTotalNumberOfCyclesProbe.RemoveParameter(propName: str) → None#: Removes the parameter from the parameter set corresponding to the given property.

FractureTotalNumberOfCyclesProbe.RenameBasedOnDefinition() → None#: Run the RenameBasedOnDefinition action.

FractureTotalNumberOfCyclesProbe.SnapToMeshNodes() → None#: Snap the coordinates of probe result to the mesh nodes.