Skip to main content

Mechanical scripting interface

ArbitraryCrack

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.ArbitraryCrack

Bases: object

Defines a ArbitraryCrack.

Overview

Methods

Name Description
Activate Activate the current object.
AddCommandSnippet Creates a new CommandSnippet
AddComment Creates a new child Comment.
AddFigure Creates a new child Figure.
AddImage Creates a new child Image.
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.
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
BottomFaceNodes Gets or sets the BottomFaceNodes.
Children Gets the list of children.
CircumferentialDivisions Gets or sets the CircumferentialDivisions.
Comments Gets the list of associated comments.
Contact1Nodes Gets or sets the Contact1Nodes named selection name.
ContactPairsNodes Gets or sets the ContactPairsNodes.
CoordinateSystem Gets or sets the CoordinateSystem.
CrackFacesNodes Gets or sets the CrackFacesNodes.
CrackFrontNodes Gets or sets the CrackFrontNodes.
CrackID Gets the CrackID.
CrackMeshMethod Gets the CrackMeshMethod.
CrackShape Gets the CrackShape.
CrackSourceType Gets the CrackSourceType.
CrackSurfaceLocation Gets or sets the CrackSurfaceLocation.
DataModelObjectCategory Gets the current DataModelObject’s category.
Figures Gets the list of associated figures.
FrontElementSize Gets or sets the FrontElementSize.
GrowthRate Gets or sets the GrowthRate.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
LargestContourRadius Gets or sets the LargestContourRadius.
Location Gets or sets the Location.
MeshContours Gets or sets the MeshContours.
Properties Gets the list of properties for this object.
ReadOnly Gets or sets the ReadOnly.
SolutionContours Gets or sets the SolutionContours.
Suppressed Gets or sets the Suppressed.
Target1Nodes Gets or sets the Target1Nodes named selection name.
TopFaceNodes Gets or sets the TopFaceNodes.
VisibleProperties Gets the list of properties that are visible for this object.
XScaleFactor Gets or sets the XScaleFactor.
YScaleFactor Gets or sets the YScaleFactor.
ZScaleFactor Gets or sets the ZScaleFactor.

Property detail

property ArbitraryCrack.BottomFaceNodes : str | None

Gets or sets the BottomFaceNodes.

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

Gets the list of children.

property ArbitraryCrack.CircumferentialDivisions : int | None

Gets or sets the CircumferentialDivisions.

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

Gets the list of associated comments.

property ArbitraryCrack.Contact1Nodes : str | None

Gets or sets the Contact1Nodes named selection name.

property ArbitraryCrack.ContactPairsNodes : bool | None

Gets or sets the ContactPairsNodes.

property ArbitraryCrack.CoordinateSystem : Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the CoordinateSystem.

property ArbitraryCrack.CrackFacesNodes : bool | None

Gets or sets the CrackFacesNodes.

property ArbitraryCrack.CrackFrontNodes : str | None

Gets or sets the CrackFrontNodes.

property ArbitraryCrack.CrackID : int | None

Gets the CrackID.

property ArbitraryCrack.CrackMeshMethod : Ansys.Mechanical.DataModel.Enums.CrackMeshMethod | None

Gets the CrackMeshMethod.

property ArbitraryCrack.CrackShape : Ansys.Mechanical.DataModel.Enums.CrackShapeType | None

Gets the CrackShape.

property ArbitraryCrack.CrackSourceType : Ansys.Mechanical.DataModel.Enums.CrackSourceType | None

Gets the CrackSourceType.

property ArbitraryCrack.CrackSurfaceLocation : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the CrackSurfaceLocation.

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

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

property ArbitraryCrack.FrontElementSize : Ansys.Core.Units.Quantity | None

Gets or sets the FrontElementSize.

property ArbitraryCrack.GrowthRate : float | None

Gets or sets the GrowthRate.

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

Gets the list of associated images.

property ArbitraryCrack.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSCrackAuto | None

Gets the internal object. For advanced usage only.

property ArbitraryCrack.LargestContourRadius : Ansys.Core.Units.Quantity | None

Gets or sets the LargestContourRadius.

property ArbitraryCrack.Location : Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Location.

property ArbitraryCrack.MeshContours : int | None

Gets or sets the MeshContours.

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

Gets the list of properties for this object.

property ArbitraryCrack.ReadOnly : bool | None

Gets or sets the ReadOnly.

property ArbitraryCrack.SolutionContours : int | None

Gets or sets the SolutionContours.

property ArbitraryCrack.Suppressed : bool | None

Gets or sets the Suppressed.

property ArbitraryCrack.Target1Nodes : str | None

Gets or sets the Target1Nodes named selection name.

property ArbitraryCrack.TopFaceNodes : str | None

Gets or sets the TopFaceNodes.

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

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

property ArbitraryCrack.XScaleFactor : float | None

Gets or sets the XScaleFactor.

property ArbitraryCrack.YScaleFactor : float | None

Gets or sets the YScaleFactor.

property ArbitraryCrack.ZScaleFactor : float | None

Gets or sets the ZScaleFactor.

Method detail

ArbitraryCrack.Activate()

Activate the current object.

ArbitraryCrack.AddCommandSnippet()

Creates a new CommandSnippet

ArbitraryCrack.AddComment()

Creates a new child Comment.

ArbitraryCrack.AddFigure()

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

ArbitraryCrack.CreateParameter(propName: str)

Creates a new parameter for a Property.

ArbitraryCrack.Delete()

Run the Delete action.

ArbitraryCrack.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

ArbitraryCrack.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ArbitraryCrack.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ArbitraryCrack.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

ArbitraryCrack.PropertyByName(name: str)

Get a property by its unique name.

ArbitraryCrack.RemoveParameter(propName: str)

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