.. vale off :class:`Part` ============= .. py:class:: ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Part Bases: :py:obj:`object` Defines a Part. .. !! processed by numpydoc !! .. py:currentmodule:: Part Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~ClearGeneratedData` - Run the ClearGeneratedData action. * - :py:attr:`~CreateParameter` - Creates a new parameter for a Property. * - :py:attr:`~RemoveParameter` - Removes the parameter from the parameter set corresponding to the given property. * - :py:attr:`~GenerateMesh` - Run the GenerateMesh action. * - :py:attr:`~PreviewInflation` - Run the PreviewInflation action. * - :py:attr:`~PreviewSurfaceMesh` - Run the PreviewSurfaceMesh action. * - :py:attr:`~Update` - Run the Update 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:`~GetParameter` - Gets the parameter corresponding to the given property. .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~MaterialName` - Gets or sets the MaterialName. * - :py:attr:`~Hidden` - Hide or show the body. * - :py:attr:`~ConfigurationId` - Gets the related Result Mesh's ConfigurationId. * - :py:attr:`~ResultMeshId` - Gets the related Result Mesh's ObjectId. * - :py:attr:`~Assignment` - Gets or sets the Assignment. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~Elements` - Gets the Elements. * - :py:attr:`~Material` - Gets or sets the Material. * - :py:attr:`~Average` - Gets the Average. * - :py:attr:`~Maximum` - Gets the Maximum. * - :py:attr:`~Minimum` - Gets the Minimum. * - :py:attr:`~StandardDeviation` - Gets the StandardDeviation. * - :py:attr:`~Nodes` - Gets the Nodes. * - :py:attr:`~ApproximateSurfaceArea` - Gets the ApproximateSurfaceArea. * - :py:attr:`~LengthX` - Gets the LengthX. * - :py:attr:`~LengthY` - Gets the LengthY. * - :py:attr:`~LengthZ` - Gets the LengthZ. * - :py:attr:`~Mass` - Gets the Mass. * - :py:attr:`~CentroidX` - Gets the CentroidX. * - :py:attr:`~CentroidY` - Gets the CentroidY. * - :py:attr:`~CentroidZ` - Gets the CentroidZ. * - :py:attr:`~MomentOfInertiaIp1` - Gets the MomentOfInertiaIp1. * - :py:attr:`~MomentOfInertiaIp2` - Gets the MomentOfInertiaIp2. * - :py:attr:`~MomentOfInertiaIp3` - Gets the MomentOfInertiaIp3. * - :py:attr:`~Volume` - Gets the Volume. * - :py:attr:`~MeshMetric` - Gets the MeshMetric. * - :py:attr:`~Visible` - Gets or sets the Visible. * - :py:attr:`~Suppressed` - Gets or sets the Suppressed. * - :py:attr:`~CoordinateSystem` - Gets or sets the CoordinateSystem. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :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:: MaterialName :no-index: :type: Optional[System.String] Gets or sets the MaterialName. .. !! processed by numpydoc !! .. py:property:: Hidden :no-index: :type: Optional[System.Boolean] Hide or show the body. .. !! processed by numpydoc !! .. py:property:: ConfigurationId :no-index: :type: Optional[System.Int32] Gets the related Result Mesh's ConfigurationId. .. !! processed by numpydoc !! .. py:property:: ResultMeshId :no-index: :type: Optional[System.Int32] Gets the related Result Mesh's ObjectId. .. !! processed by numpydoc !! .. py:property:: Assignment :no-index: :type: Optional[System.String] Gets or sets the Assignment. .. !! processed by numpydoc !! .. py:property:: InternalObject :no-index: :type: Optional[Ansys.Common.Interop.DSObjectsAuto.IDSBodyGroupAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: Elements :no-index: :type: Optional[System.Int32] Gets the Elements. .. !! processed by numpydoc !! .. py:property:: Material :no-index: :type: Optional[System.String] Gets or sets the Material. .. !! processed by numpydoc !! .. py:property:: Average :no-index: :type: Optional[System.Double] Gets the Average. .. !! processed by numpydoc !! .. py:property:: Maximum :no-index: :type: Optional[System.Double] Gets the Maximum. .. !! processed by numpydoc !! .. py:property:: Minimum :no-index: :type: Optional[System.Double] Gets the Minimum. .. !! processed by numpydoc !! .. py:property:: StandardDeviation :no-index: :type: Optional[System.Double] Gets the StandardDeviation. .. !! processed by numpydoc !! .. py:property:: Nodes :no-index: :type: Optional[System.Int32] Gets the Nodes. .. !! processed by numpydoc !! .. py:property:: ApproximateSurfaceArea :no-index: :type: Optional[System.Double] Gets the ApproximateSurfaceArea. .. !! processed by numpydoc !! .. py:property:: LengthX :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets the LengthX. .. !! processed by numpydoc !! .. py:property:: LengthY :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets the LengthY. .. !! processed by numpydoc !! .. py:property:: LengthZ :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets the LengthZ. .. !! processed by numpydoc !! .. py:property:: Mass :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets the Mass. .. !! processed by numpydoc !! .. py:property:: CentroidX :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets the CentroidX. .. !! processed by numpydoc !! .. py:property:: CentroidY :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets the CentroidY. .. !! processed by numpydoc !! .. py:property:: CentroidZ :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets the CentroidZ. .. !! processed by numpydoc !! .. py:property:: MomentOfInertiaIp1 :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets the MomentOfInertiaIp1. .. !! processed by numpydoc !! .. py:property:: MomentOfInertiaIp2 :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets the MomentOfInertiaIp2. .. !! processed by numpydoc !! .. py:property:: MomentOfInertiaIp3 :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets the MomentOfInertiaIp3. .. !! processed by numpydoc !! .. py:property:: Volume :no-index: :type: Optional[Ansys.Core.Units.Quantity] Gets the Volume. .. !! processed by numpydoc !! .. py:property:: MeshMetric :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.MeshMetricType] Gets the MeshMetric. .. !! processed by numpydoc !! .. py:property:: Visible :no-index: :type: Optional[System.Boolean] Gets or sets the Visible. .. !! processed by numpydoc !! .. py:property:: Suppressed :no-index: :type: Optional[System.Boolean] Gets or sets the Suppressed. .. !! 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:: DataModelObjectCategory :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory] Gets the current DataModelObject's category. .. !! 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:: ClearGeneratedData() -> System.Void :no-index: Run the ClearGeneratedData action. .. !! processed by numpydoc !! .. py:method:: CreateParameter(paramPath: System.String) -> Ansys.ACT.Interfaces.Mechanical.IParameter :no-index: Creates a new parameter for a Property. .. !! processed by numpydoc !! .. py:method:: RemoveParameter(paramPath: System.String) -> System.Void :no-index: Removes the parameter from the parameter set corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: GenerateMesh() -> System.Void :no-index: Run the GenerateMesh action. .. !! processed by numpydoc !! .. py:method:: PreviewInflation() -> System.Void :no-index: Run the PreviewInflation action. .. !! processed by numpydoc !! .. py:method:: PreviewSurfaceMesh() -> System.Void :no-index: Run the PreviewSurfaceMesh action. .. !! processed by numpydoc !! .. py:method:: Update() -> System.Void :no-index: Run the Update 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:: GetParameter(propName: System.String) -> Ansys.ACT.Interfaces.Mechanical.IParameter :no-index: Gets the parameter corresponding to the given property. .. !! processed by numpydoc !! .. vale on