FractureTool

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureTool(internalObject: Any)

Bases: object

Defines a FractureTool.

Overview

Methods

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.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
EvaluateAllResults	Run the EvaluateAllResults action.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetType	GetType method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
PropertyByName	Get a property by its unique name.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
Children	Gets the list of children.
ClsId	ClsId property.
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.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
MultipleCracksSelection	Get/Set multiple cracks to Fracture tool
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
Properties	Gets the list of properties for this object.
ScopingMethod	Gets or sets the ScopingMethod.
State	State property.
Suppressed	Gets or sets the Suppressed.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property FractureTool.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets the list of children.

property FractureTool.ClsId: int | None

ClsId property.

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.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property FractureTool.IconName: str | None

IconName property.

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.Name: str | None

Name property.

property FractureTool.ObjectId: int | None

ObjectId property.

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

ObjectState property.

property FractureTool.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

property FractureTool.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

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.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

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() → None

Activate the current object.

FractureTool.AddCStarIntegral() → Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureToolResult

Creates a new FractureCSTAR

FractureTool.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

FractureTool.AddCrackExtensionProbe() → Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureCrackExtensionProbe

Creates a new FractureCrackExtensionProbe

FractureTool.AddEquivalentSIFSRange() → Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureToolResult

Creates a new FractureEquivalentSIFSRange

FractureTool.AddEquivalentSIFSRangeProbe() → Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureEquivalentSIFSRangeProbe

Creates a new FractureEquivalentSIFSRangeProbe

FractureTool.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

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

FractureTool.AddJINT() → Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureToolResult

Creates a new FractureJINT

FractureTool.AddJINTProbe() → Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureJINTProbe

Creates a new FractureJINTProbe

FractureTool.AddMaterialForceX() → Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureToolResult

Creates a new FractureMaterialForceX

FractureTool.AddMaterialForceY() → Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureToolResult

Creates a new FractureMaterialForceY

FractureTool.AddMaterialForceZ() → Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureToolResult

Creates a new FractureMaterialForceZ

FractureTool.AddNumberOfCyclesProbe() → Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureTotalNumberOfCyclesProbe

Creates a new FractureTotalNumberOfCyclesProbe

FractureTool.AddSIFSK1() → Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureToolResult

Creates a new FractureSIFSK1

FractureTool.AddSIFSK1Probe() → Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureSIFSProbe

Creates a new FractureSIFSProbe

FractureTool.AddSIFSK2() → Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureToolResult

Creates a new FractureSIFSK2

FractureTool.AddSIFSK2Probe() → Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureSIFSProbe

Creates a new FractureSIFSProbe

FractureTool.AddSIFSK3() → Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureToolResult

Creates a new FractureSIFSK3

FractureTool.AddSIFSK3Probe() → Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureSIFSProbe

Creates a new FractureSIFSProbe

FractureTool.AddTSTRESS() → Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureToolResult

Creates a new FractureTSTRESS

FractureTool.AddVCCTG1() → Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureToolResult

Creates a new FractureVCCTG1

FractureTool.AddVCCTG2() → Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureToolResult

Creates a new FractureVCCTG2

FractureTool.AddVCCTG3() → Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureToolResult

Creates a new FractureVCCTG3

FractureTool.AddVCCTGT() → Ansys.ACT.Automation.Mechanical.Results.FractureToolResults.FractureToolResult

Creates a new FractureVCCTGT

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

Copies all visible properties from this object to another.

FractureTool.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

FractureTool.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

FractureTool.Delete() → None

Run the Delete action.

FractureTool.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

FractureTool.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

FractureTool.EvaluateAllResults() → None

Run the EvaluateAllResults action.

FractureTool.GetAPIName(dispId: int) → str

Property name bound to dispId.

FractureTool.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

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

Gets the list of children, filtered by type.

FractureTool.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

FractureTool.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

FractureTool.GetHashCode() → int

GetHashCode method.

FractureTool.GetIconFile() → System.Byte

GetIconFile method.

FractureTool.GetLifetimeService() → Any

GetLifetimeService method.

FractureTool.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

FractureTool.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

FractureTool.GetPath() → str

GetPath method.

FractureTool.GetPropertyName(dispId: int) → str

GetPropertyName method.

FractureTool.GetPropertyValue(name: str) → Any

GetPropertyValue method.

FractureTool.GetType() → type

GetType method.

FractureTool.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

FractureTool.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

FractureTool.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

FractureTool.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

FractureTool.InitializeLifetimeService() → Any

InitializeLifetimeService method.

FractureTool.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

FractureTool.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

FractureTool.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

FractureTool.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

FractureTool.RemoveParameter(propName: str) → None

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

FractureTool.ToString() → str

ToString method.