Skip to main content

Mechanical scripting interface

CrackInitiation

Last update: 14.01.2025

class Ansys.ACT.Automation.Mechanical.CrackInitiation

Bases: object

Defines a CrackInitiation.

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.
CenterXCoordinate Gets or sets the CenterXCoordinate.
CenterYCoordinate Gets or sets the CenterYCoordinate.
CenterZCoordinate Gets or sets the CenterZCoordinate.
Children Gets the list of children.
Comments Gets the list of associated comments.
CoordinateSystem Gets or sets the CoordinateSystem.
CrackCenter Gets or sets the CrackCenter.
CrackID Gets the CrackID.
CrackOrientation Gets or sets the CrackOrientation.
CrackShape Gets or sets the CrackShape.
CrackSourceType Gets the CrackSourceType.
CriterionValue Gets or sets the CriterionValue.
DataModelObjectCategory Gets the current DataModelObject’s category.
Figures Gets the list of associated figures.
Images Gets the list of associated images.
InitiationCriterion Gets the InitiationCriterion.
InternalObject Gets the internal object. For advanced usage only.
Location Gets or sets the Location.
MajorRadius Gets or sets the MajorRadius.
MinorRadius Gets or sets the MinorRadius.
NamedSelection Gets or sets the NamedSelection.
Properties Gets the list of properties for this object.
ReadOnly Gets or sets the ReadOnly.
ScopingMethod Gets or sets the ScopingMethod.
SolutionContours Gets or sets the SolutionContours.
Suppressed Gets or sets the Suppressed.
TopFaceNodes Gets or sets the TopFaceNodes.
VisibleProperties Gets the list of properties that are visible for this object.

Property detail

property CrackInitiation.BottomFaceNodes : str | None

Gets or sets the BottomFaceNodes.

property CrackInitiation.CenterXCoordinate : Ansys.Core.Units.Quantity | None

Gets or sets the CenterXCoordinate.

property CrackInitiation.CenterYCoordinate : Ansys.Core.Units.Quantity | None

Gets or sets the CenterYCoordinate.

property CrackInitiation.CenterZCoordinate : Ansys.Core.Units.Quantity | None

Gets or sets the CenterZCoordinate.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the CoordinateSystem.

property CrackInitiation.CrackCenter : Ansys.Mechanical.DataModel.MechanicalEnums.CrackInitiation.CrackCenter | None

Gets or sets the CrackCenter.

property CrackInitiation.CrackID : int | None

Gets the CrackID.

property CrackInitiation.CrackOrientation : Ansys.Mechanical.DataModel.MechanicalEnums.CrackInitiation.CrackOrientation | None

Gets or sets the CrackOrientation.

property CrackInitiation.CrackShape : Ansys.Mechanical.DataModel.MechanicalEnums.CrackInitiation.CrackShape | None

Gets or sets the CrackShape.

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

Gets the CrackSourceType.

property CrackInitiation.CriterionValue : Ansys.Core.Units.Quantity | None

Gets or sets the CriterionValue.

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

Gets the current DataModelObject’s category.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property CrackInitiation.InitiationCriterion : Ansys.Mechanical.DataModel.MechanicalEnums.CrackInitiation.InitiationCriterion | None

Gets the InitiationCriterion.

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

Gets the internal object. For advanced usage only.

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

Gets or sets the Location.

property CrackInitiation.MajorRadius : Ansys.Core.Units.Quantity | None

Gets or sets the MajorRadius.

property CrackInitiation.MinorRadius : Ansys.Core.Units.Quantity | None

Gets or sets the MinorRadius.

property CrackInitiation.NamedSelection : Ansys.ACT.Automation.Mechanical.NamedSelection | None

Gets or sets the NamedSelection.

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

Gets the list of properties for this object.

property CrackInitiation.ReadOnly : bool | None

Gets or sets the ReadOnly.

property CrackInitiation.ScopingMethod : Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the ScopingMethod.

property CrackInitiation.SolutionContours : int | None

Gets or sets the SolutionContours.

property CrackInitiation.Suppressed : bool | None

Gets or sets the Suppressed.

property CrackInitiation.TopFaceNodes : str | None

Gets or sets the TopFaceNodes.

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

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

Method detail

CrackInitiation.Activate()

Activate the current object.

CrackInitiation.AddCommandSnippet()

Creates a new CommandSnippet

CrackInitiation.AddComment()

Creates a new child Comment.

CrackInitiation.AddFigure()

Creates a new child Figure.

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

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

Copies all visible properties from this object to another.

CrackInitiation.CreateParameter(propName: str)

Creates a new parameter for a Property.

CrackInitiation.Delete()

Run the Delete action.

CrackInitiation.Duplicate()

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

CrackInitiation.GetParameter(propName: str)

Gets the parameter corresponding to the given property.

CrackInitiation.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

CrackInitiation.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

CrackInitiation.PropertyByName(name: str)

Get a property by its unique name.

CrackInitiation.RemoveParameter(propName: str)

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