.. vale off :class:`CrackInitiation` ======================== .. py:class:: ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.CrackInitiation Bases: :py:obj:`object` Defines a CrackInitiation. .. !! processed by numpydoc !! .. py:currentmodule:: CrackInitiation Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~AddCommandSnippet` - Creates a new CommandSnippet * - :py:attr:`~Delete` - Run the Delete action. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~AddComment` - Creates a new child Comment. * - :py:attr:`~AddFigure` - Creates a new child Figure. * - :py:attr:`~AddImage` - Creates a new child Image. * - :py:attr:`~Activate` - Activate the current object. * - :py:attr:`~CopyTo` - Copies all visible properties from this object to another. * - :py:attr:`~Duplicate` - Creates a copy of the current DataModelObject. * - :py:attr:`~GroupAllSimilarChildren` - Run the GroupAllSimilarChildren action. * - :py:attr:`~GroupSimilarObjects` - Run the GroupSimilarObjects action. * - :py:attr:`~PropertyByName` - Get a property by its unique name. * - :py:attr:`~PropertyByAPIName` - Get a property by its API name. * - :py:attr:`~CreateParameter` - Creates a new parameter for a Property. * - :py:attr:`~GetParameter` - Gets the parameter corresponding to the given property. * - :py:attr:`~RemoveParameter` - Removes the parameter from the parameter set corresponding to the given property. .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~SolutionContours` - Gets or sets the SolutionContours. * - :py:attr:`~BottomFaceNodes` - Gets or sets the BottomFaceNodes. * - :py:attr:`~TopFaceNodes` - Gets or sets the TopFaceNodes. * - :py:attr:`~CenterXCoordinate` - Gets or sets the CenterXCoordinate. * - :py:attr:`~CenterYCoordinate` - Gets or sets the CenterYCoordinate. * - :py:attr:`~CenterZCoordinate` - Gets or sets the CenterZCoordinate. * - :py:attr:`~MajorRadius` - Gets or sets the MajorRadius. * - :py:attr:`~MinorRadius` - Gets or sets the MinorRadius. * - :py:attr:`~CriterionValue` - Gets or sets the CriterionValue. * - :py:attr:`~CrackShape` - Gets or sets the CrackShape. * - :py:attr:`~CrackOrientation` - Gets or sets the CrackOrientation. * - :py:attr:`~CrackSourceType` - Gets the CrackSourceType. * - :py:attr:`~ScopingMethod` - Gets or sets the ScopingMethod. * - :py:attr:`~CrackCenter` - Gets or sets the CrackCenter. * - :py:attr:`~InitiationCriterion` - Gets the InitiationCriterion. * - :py:attr:`~Suppressed` - Gets or sets the Suppressed. * - :py:attr:`~NamedSelection` - Gets or sets the NamedSelection. * - :py:attr:`~CoordinateSystem` - Gets or sets the CoordinateSystem. * - :py:attr:`~Location` - Gets or sets the Location. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :py:attr:`~CrackID` - Gets the CrackID. * - :py:attr:`~Children` - Gets the list of children. * - :py:attr:`~Comments` - Gets the list of associated comments. * - :py:attr:`~Figures` - Gets the list of associated figures. * - :py:attr:`~Images` - Gets the list of associated images. * - :py:attr:`~ReadOnly` - Gets or sets the ReadOnly. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~Properties` - Gets the list of properties for this object. * - :py:attr:`~VisibleProperties` - Gets the list of properties that are visible for this object. Property detail --------------- .. py:property:: InternalObject :no-index: :type: Optional[Ansys.Common.Interop.DSObjectsAuto.IDSCrackAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: SolutionContours :no-index: :type: Optional[System.Int32] Gets or sets the SolutionContours. .. !! processed by numpydoc !! .. py:property:: BottomFaceNodes :no-index: :type: Optional[System.String] Gets or sets the BottomFaceNodes. .. !! processed by numpydoc !! .. py:property:: TopFaceNodes :no-index: :type: Optional[System.String] Gets or sets the TopFaceNodes. .. !! processed by numpydoc !! .. py:property:: CenterXCoordinate :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the CenterXCoordinate. .. !! processed by numpydoc !! .. py:property:: CenterYCoordinate :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the CenterYCoordinate. .. !! processed by numpydoc !! .. py:property:: CenterZCoordinate :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the CenterZCoordinate. .. !! processed by numpydoc !! .. py:property:: MajorRadius :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the MajorRadius. .. !! processed by numpydoc !! .. py:property:: MinorRadius :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the MinorRadius. .. !! processed by numpydoc !! .. py:property:: CriterionValue :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets or sets the CriterionValue. .. !! processed by numpydoc !! .. py:property:: CrackShape :no-index: :type: Optional[Ansys.Mechanical.DataModel.MechanicalEnums.CrackInitiation.CrackShape] Gets or sets the CrackShape. .. !! processed by numpydoc !! .. py:property:: CrackOrientation :no-index: :type: Optional[Ansys.Mechanical.DataModel.MechanicalEnums.CrackInitiation.CrackOrientation] Gets or sets the CrackOrientation. .. !! processed by numpydoc !! .. py:property:: CrackSourceType :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.CrackSourceType] Gets the CrackSourceType. .. !! processed by numpydoc !! .. py:property:: ScopingMethod :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.GeometryDefineByType] Gets or sets the ScopingMethod. .. !! processed by numpydoc !! .. py:property:: CrackCenter :no-index: :type: Optional[Ansys.Mechanical.DataModel.MechanicalEnums.CrackInitiation.CrackCenter] Gets or sets the CrackCenter. .. !! processed by numpydoc !! .. py:property:: InitiationCriterion :no-index: :type: Optional[Ansys.Mechanical.DataModel.MechanicalEnums.CrackInitiation.InitiationCriterion] Gets the InitiationCriterion. .. !! processed by numpydoc !! .. py:property:: Suppressed :no-index: :type: Optional[System.Boolean] Gets or sets the Suppressed. .. !! processed by numpydoc !! .. py:property:: NamedSelection :no-index: :type: Optional[Ansys.ACT.Automation.Mechanical.NamedSelection] Gets or sets the NamedSelection. .. !! processed by numpydoc !! .. py:property:: CoordinateSystem :no-index: :type: Optional[Ansys.ACT.Automation.Mechanical.CoordinateSystem] Gets or sets the CoordinateSystem. .. !! processed by numpydoc !! .. py:property:: Location :no-index: :type: Optional[Ansys.ACT.Interfaces.Common.ISelectionInfo] Gets or sets the Location. .. !! processed by numpydoc !! .. py:property:: DataModelObjectCategory :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory] Gets the current DataModelObject's category. .. !! processed by numpydoc !! .. py:property:: CrackID :no-index: :type: Optional[System.Int32] Gets the CrackID. .. !! processed by numpydoc !! .. py:property:: Children :no-index: :type: Optional[System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]] Gets the list of children. .. !! processed by numpydoc !! .. py:property:: Comments :no-index: :type: Optional[System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment]] Gets the list of associated comments. .. !! processed by numpydoc !! .. py:property:: Figures :no-index: :type: Optional[System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure]] Gets the list of associated figures. .. !! processed by numpydoc !! .. py:property:: Images :no-index: :type: Optional[System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image]] Gets the list of associated images. .. !! processed by numpydoc !! .. py:property:: ReadOnly :no-index: :type: Optional[System.Boolean] Gets or sets the ReadOnly. .. !! processed by numpydoc !! .. py:property:: InternalObject :no-index: :type: Optional[System.Object] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: Properties :no-index: :type: Optional[System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties for this object. .. !! processed by numpydoc !! .. py:property:: VisibleProperties :no-index: :type: Optional[System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties that are visible for this object. .. !! processed by numpydoc !! Method detail ------------- .. py:method:: AddCommandSnippet() -> Ansys.ACT.Automation.Mechanical.CommandSnippet :no-index: Creates a new CommandSnippet .. !! processed by numpydoc !! .. py:method:: Delete() -> System.Void :no-index: Run the Delete action. .. !! processed by numpydoc !! .. py:method:: GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) -> System.Collections.Generic.IList[ChildrenType] :no-index: Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) -> System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] :no-index: Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: AddComment() -> Ansys.ACT.Automation.Mechanical.Comment :no-index: Creates a new child Comment. .. !! processed by numpydoc !! .. py:method:: AddFigure() -> Ansys.ACT.Automation.Mechanical.Figure :no-index: Creates a new child Figure. .. !! processed by numpydoc !! .. py:method:: AddImage(filePath: System.String) -> Ansys.ACT.Automation.Mechanical.Image :no-index: .. code-block:: text 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. .. !! processed by numpydoc !! .. py:method:: Activate() -> System.Void :no-index: Activate the current object. .. !! processed by numpydoc !! .. py:method:: CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) -> System.Void :no-index: Copies all visible properties from this object to another. .. !! processed by numpydoc !! .. py:method:: Duplicate() -> Ansys.Mechanical.DataModel.Interfaces.IDataModelObject :no-index: Creates a copy of the current DataModelObject. .. !! processed by numpydoc !! .. py:method:: GroupAllSimilarChildren() -> System.Void :no-index: Run the GroupAllSimilarChildren action. .. !! processed by numpydoc !! .. py:method:: GroupSimilarObjects() -> Ansys.ACT.Automation.Mechanical.TreeGroupingFolder :no-index: Run the GroupSimilarObjects action. .. !! processed by numpydoc !! .. py:method:: PropertyByName(name: System.String) -> Ansys.ACT.Automation.Mechanical.Property :no-index: Get a property by its unique name. .. !! processed by numpydoc !! .. py:method:: PropertyByAPIName(name: System.String) -> Ansys.ACT.Automation.Mechanical.Property :no-index: .. code-block:: text 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. .. !! processed by numpydoc !! .. py:method:: CreateParameter(propName: System.String) -> Ansys.ACT.Interfaces.Mechanical.IParameter :no-index: Creates a new parameter for a Property. .. !! processed by numpydoc !! .. py:method:: GetParameter(propName: System.String) -> Ansys.ACT.Interfaces.Mechanical.IParameter :no-index: Gets the parameter corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: RemoveParameter(propName: System.String) -> System.Void :no-index: Removes the parameter from the parameter set corresponding to the given property. .. !! processed by numpydoc !! .. vale on