Skip to main content

Mechanical scripting interface

FractureTool

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureTool

Bases: object

Defines a FractureTool.

Overview

Methods

Name Description
Activate Activate the current object.
AddCStarIntegral Creates a new FractureCSTAR
AddComment Creates a new child Comment.
AddCrackExtensionProbe Creates a new FractureCrackExtensionProbe
AddEquivalentSIFSRange Creates a new FractureEquivalentSIFSRange
AddEquivalentSIFSRangeProbe Creates a new FractureEquivalentSIFSRangeProbe
AddFigure Creates a new child Figure.
AddImage Creates a new child Image.
AddJINT Creates a new FractureJINT
AddJINTProbe Creates a new FractureJINTProbe
AddMaterialForceX Creates a new FractureMaterialForceX
AddMaterialForceY Creates a new FractureMaterialForceY
AddMaterialForceZ Creates a new FractureMaterialForceZ
AddNumberOfCyclesProbe Creates a new FractureTotalNumberOfCyclesProbe
AddSIFSK1 Creates a new FractureSIFSK1
AddSIFSK1Probe Creates a new FractureSIFSProbe
AddSIFSK2 Creates a new FractureSIFSK2
AddSIFSK2Probe Creates a new FractureSIFSProbe
AddSIFSK3 Creates a new FractureSIFSK3
AddSIFSK3Probe Creates a new FractureSIFSProbe
AddTSTRESS Creates a new FractureTSTRESS
AddVCCTG1 Creates a new FractureVCCTG1
AddVCCTG2 Creates a new FractureVCCTG2
AddVCCTG3 Creates a new FractureVCCTG3
AddVCCTGT Creates a new FractureVCCTGT
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.
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
Children Gets the list of children.
Comments Gets the list of associated comments.
CrackFrontNumber Gets or sets the CrackFrontNumber.
CrackSelection Gets or sets the CrackSelection.
CrackSelectionMode Gets or sets the CrackSelectionMode.
DataModelObjectCategory Gets the current DataModelObject’s category.
Figures Gets the list of associated figures.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
MultipleCracksSelection Get/Set multiple cracks to Fracture tool
Properties Gets the list of properties for this object.
ScopingMethod Gets or sets the ScopingMethod.
Suppressed Gets or sets the Suppressed.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

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

Gets the list of children.

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

Gets the list of associated comments.

property FractureTool.CrackFrontNumber : int | None

Gets or sets the CrackFrontNumber.

property FractureTool.CrackSelection : Ansys.ACT.Automation.Mechanical.GenericCrack | None

Gets or sets the CrackSelection.

property FractureTool.CrackSelectionMode : Ansys.Mechanical.DataModel.Enums.CrackSelectionModeType | None

Gets or sets the CrackSelectionMode.

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

Gets the current DataModelObject’s category.

property FractureTool.Figures : Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

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

Gets the list of associated images.

property FractureTool.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSFractureToolAuto | None

Gets the internal object. For advanced usage only.

property FractureTool.MultipleCracksSelection : Iterable[Ansys.ACT.Automation.Mechanical.GenericCrack] | None

Get/Set multiple cracks to Fracture tool

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

Gets the list of properties for this object.

property FractureTool.ScopingMethod : Ansys.Mechanical.DataModel.Enums.FractureToolScopeType | None

Gets or sets the ScopingMethod.

property FractureTool.Suppressed : bool | None

Gets or sets the Suppressed.

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

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

Method detail

FractureTool.Activate()

Activate the current object.

FractureTool.AddCStarIntegral()

Creates a new FractureCSTAR

FractureTool.AddComment()

Creates a new child Comment.

FractureTool.AddCrackExtensionProbe()

Creates a new FractureCrackExtensionProbe

FractureTool.AddEquivalentSIFSRange()

Creates a new FractureEquivalentSIFSRange

FractureTool.AddEquivalentSIFSRangeProbe()

Creates a new FractureEquivalentSIFSRangeProbe

FractureTool.AddFigure()

Creates a new child Figure.

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

FractureTool.AddJINT()

Creates a new FractureJINT

FractureTool.AddJINTProbe()

Creates a new FractureJINTProbe

FractureTool.AddMaterialForceX()

Creates a new FractureMaterialForceX

FractureTool.AddMaterialForceY()

Creates a new FractureMaterialForceY

FractureTool.AddMaterialForceZ()

Creates a new FractureMaterialForceZ

FractureTool.AddNumberOfCyclesProbe()

Creates a new FractureTotalNumberOfCyclesProbe

FractureTool.AddSIFSK1()

Creates a new FractureSIFSK1

FractureTool.AddSIFSK1Probe()

Creates a new FractureSIFSProbe

FractureTool.AddSIFSK2()

Creates a new FractureSIFSK2

FractureTool.AddSIFSK2Probe()

Creates a new FractureSIFSProbe

FractureTool.AddSIFSK3()

Creates a new FractureSIFSK3

FractureTool.AddSIFSK3Probe()

Creates a new FractureSIFSProbe

FractureTool.AddTSTRESS()

Creates a new FractureTSTRESS

FractureTool.AddVCCTG1()

Creates a new FractureVCCTG1

FractureTool.AddVCCTG2()

Creates a new FractureVCCTG2

FractureTool.AddVCCTG3()

Creates a new FractureVCCTG3

FractureTool.AddVCCTGT()

Creates a new FractureVCCTGT

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

Copies all visible properties from this object to another.

FractureTool.CreateParameter(propName: str)

Creates a new parameter for a Property.

FractureTool.Delete()

Run the Delete action.

FractureTool.Duplicate()

Creates a copy of the current DataModelObject.

FractureTool.EvaluateAllResults()

Run the EvaluateAllResults action.

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

Gets the list of children, filtered by type.

FractureTool.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

FractureTool.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

FractureTool.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

FractureTool.PropertyByName(name: str)

Get a property by its unique name.

FractureTool.RemoveParameter(propName: str)

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