Skip to main content

Mechanical scripting interface

ThroughCrack

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.ThroughCrack

Bases: object

Defines a ThroughCrack.

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.
ContactPairsNodes Gets or sets the ContactPairsNodes.
CoordinateSystem Gets or sets the CoordinateSystem.
CrackFacesNodes Gets or sets the CrackFacesNodes.
CrackFrontDivisions Gets or sets the CrackFrontDivisions.
CrackFrontNodes Gets or sets the CrackFrontNodes.
CrackID Gets the CrackID.
CrackMeshMethod Gets or sets the CrackMeshMethod.
CrackShape Gets the CrackShape.
CrackSourceType Gets the CrackSourceType.
DataModelObjectCategory Gets the current DataModelObject’s category.
Depth Gets or sets the Depth.
EndWidth Gets or sets the EndWidth.
Figures Gets the list of associated figures.
FractureAffectedZone Gets or sets the FractureAffectedZone.
FractureAffectedZoneHeight Gets or sets the FractureAffectedZoneHeight.
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.
MidWidth Gets or sets the MidWidth.
Properties Gets the list of properties for this object.
ReadOnly Gets or sets the ReadOnly.
SolutionContours Gets or sets the SolutionContours.
StartWidth Gets or sets the StartWidth.
Suppressed Gets or sets the Suppressed.
Target1Nodes Gets or sets the Target1Nodes.
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 ThroughCrack.BottomFaceNodes : str | None

Gets or sets the BottomFaceNodes.

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

Gets the list of children.

property ThroughCrack.CircumferentialDivisions : int | None

Gets or sets the CircumferentialDivisions.

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

Gets the list of associated comments.

property ThroughCrack.Contact1Nodes : str | None

Gets or sets the Contact1Nodes.

property ThroughCrack.ContactPairsNodes : bool | None

Gets or sets the ContactPairsNodes.

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

Gets or sets the CoordinateSystem.

property ThroughCrack.CrackFacesNodes : bool | None

Gets or sets the CrackFacesNodes.

property ThroughCrack.CrackFrontDivisions : int | None

Gets or sets the CrackFrontDivisions.

property ThroughCrack.CrackFrontNodes : str | None

Gets or sets the CrackFrontNodes.

property ThroughCrack.CrackID : int | None

Gets the CrackID.

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

Gets or sets the CrackMeshMethod.

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

Gets the CrackShape.

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

Gets the CrackSourceType.

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

Gets the current DataModelObject’s category.

property ThroughCrack.Depth : Ansys.Core.Units.Quantity | None

Gets or sets the Depth.

property ThroughCrack.EndWidth : Ansys.Core.Units.Quantity | None

Gets or sets the EndWidth.

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

Gets the list of associated figures.

property ThroughCrack.FractureAffectedZone : Ansys.Mechanical.DataModel.Enums.FractureAffectedZone | None

Gets or sets the FractureAffectedZone.

property ThroughCrack.FractureAffectedZoneHeight : Ansys.Core.Units.Quantity | None

Gets or sets the FractureAffectedZoneHeight.

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

Gets or sets the FrontElementSize.

property ThroughCrack.GrowthRate : float | None

Gets or sets the GrowthRate.

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

Gets the list of associated images.

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

Gets the internal object. For advanced usage only.

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

Gets or sets the LargestContourRadius.

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

Gets or sets the Location.

property ThroughCrack.MeshContours : int | None

Gets or sets the MeshContours.

property ThroughCrack.MidWidth : Ansys.Core.Units.Quantity | None

Gets or sets the MidWidth.

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

Gets the list of properties for this object.

property ThroughCrack.ReadOnly : bool | None

Gets or sets the ReadOnly.

property ThroughCrack.SolutionContours : int | None

Gets or sets the SolutionContours.

property ThroughCrack.StartWidth : Ansys.Core.Units.Quantity | None

Gets or sets the StartWidth.

property ThroughCrack.Suppressed : bool | None

Gets or sets the Suppressed.

property ThroughCrack.Target1Nodes : str | None

Gets or sets the Target1Nodes.

property ThroughCrack.TopFaceNodes : str | None

Gets or sets the TopFaceNodes.

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

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

property ThroughCrack.XScaleFactor : float | None

Gets or sets the XScaleFactor.

property ThroughCrack.YScaleFactor : float | None

Gets or sets the YScaleFactor.

property ThroughCrack.ZScaleFactor : float | None

Gets or sets the ZScaleFactor.

Method detail

ThroughCrack.Activate()

Activate the current object.

ThroughCrack.AddCommandSnippet()

Creates a new CommandSnippet

ThroughCrack.AddComment()

Creates a new child Comment.

ThroughCrack.AddFigure()

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

ThroughCrack.CreateParameter(propName: str)

Creates a new parameter for a Property.

ThroughCrack.Delete()

Run the Delete action.

ThroughCrack.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

ThroughCrack.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

ThroughCrack.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

ThroughCrack.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

ThroughCrack.PropertyByName(name: str)

Get a property by its unique name.

ThroughCrack.RemoveParameter(propName: str)

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