.. vale off :class:`MeshWorkflow` ===================== .. py:class:: ansys.mechanical.stubs.Ansys.ACT.Automation.Mechanical.MeshWorkflow Bases: :py:obj:`object` Object that wraps IDSEngineeringModelWorkflowGroup. .. !! processed by numpydoc !! .. py:currentmodule:: MeshWorkflow Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~Activate` - Activate the current object. * - :py:attr:`~AddFigure` - Creates a new child Figure. * - :py:attr:`~AddImage` - Creates a new child Image. * - :py:attr:`~AddInput` - Adds an “Input” node as child object under the “Mesh Workflow” and returns the new MeshWorkflowInput object if not existent, otherwise it returns the already available MeshWorkflowInput object. * - :py:attr:`~AddOutput` - Adds an “Output” node as child object under the “Mesh Workflow” and returns the new MeshWorkflowOutput object if not existent, otherwise it returns the already available MeshWorkflowOutput object. * - :py:attr:`~ClearGeneratedData` - Clears all the generated data, i.e., It resets all inactive geometry parts/bodies to active again, clears the output data, and resets the state of the child objects (“Input”, “Steps”, “Output”) to the initial state. However, any user-defined settings such as the “Input” node scoping are retained. * - :py:attr:`~ClearOutputData` - Clears only the "Output" data, i.e., the generated Geometry part(s) and the associated mesh. * - :py:attr:`~CopyTo` - Copies all visible properties from this object to another. * - :py:attr:`~CreateParameter` - Creates a new parameter for a Property. * - :py:attr:`~Delete` - Run the Delete action. * - :py:attr:`~Duplicate` - Creates a copy of the current DataModelObject. * - :py:attr:`~ExportWorkflow` - Exports the steps as template into a .emx file. * - :py:attr:`~FinalizeWorkflow` - Once all steps in a mesh workflow are completed successfully, the workflow can be completed which will transfer the generated data back into new Mechanical geometry part(s) together with the corresponding part mesh(es). * - :py:attr:`~Generate` - Generates the desired data by executing the whole workflow, i.e., transferring the input data, executing all steps, and completing the workflow by transferring the output data back into Geometry and Mesh data. * - :py:attr:`~GetAllLabelNames` - Gets all the PrimeMesh model labels names currently defined for the workflow. * - :py:attr:`~GetAllPartNames` - Gets all the PrimeMesh model parts names currently defined for the workflow. * - :py:attr:`~GetAllSizeFieldNames` - Gets all the PrimeMesh model volumetric size field names currently defined for the workflow. * - :py:attr:`~GetAllZoneNames` - Gets all the PrimeMesh model zones names currently defined for the workflow. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~GetParameter` - Gets the parameter corresponding to the given property. * - :py:attr:`~GetSolidSurfaceMeshQualityWarningLimit` - Get Mesh Quality Warning Limit * - :py:attr:`~GroupAllSimilarChildren` - Run the GroupAllSimilarChildren action. * - :py:attr:`~GroupSimilarObjects` - Run the GroupSimilarObjects action. * - :py:attr:`~ImportWorkflow` - Imports the steps from a template .emx file. * - :py:attr:`~InitializeWorkflow` - Initializes the mesh workflow by transferring the scoped geometry parts/bodies from Mechanical into the PrimeMesh model and updates the “Input” node state accordingly. * - :py:attr:`~PropertyByAPIName` - Get a property by its API name. * - :py:attr:`~PropertyByName` - Get a property by its unique name. * - :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:`~Children` - Gets the list of children. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :py:attr:`~Figures` - Gets the list of associated figures. * - :py:attr:`~Images` - Gets the list of associated images. * - :py:attr:`~ImportedWorkflowFilename` - The filename of the template.emx file that populated the workflow initially. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~Properties` - Gets the list of properties for this object. * - :py:attr:`~UnitSystem` - Defines the “unit system” of a Prime Model, if not defined, the unit system is deduced from the geometry at input data transfer time. * - :py:attr:`~VisibleProperties` - Gets the list of properties that are visible for this object. * - :py:attr:`~WorkflowType` - Returns the workflow type which is applicable to the Input, Steps, and Output. Property detail --------------- .. py:property:: Children :type: Optional[List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]] Gets the list of children. .. !! processed by numpydoc !! .. py:property:: DataModelObjectCategory :type: Optional[Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory] Gets the current DataModelObject's category. .. !! processed by numpydoc !! .. py:property:: Figures :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Figure]] Gets the list of associated figures. .. !! processed by numpydoc !! .. py:property:: Images :type: Optional[Iterable[Ansys.ACT.Automation.Mechanical.Image]] Gets the list of associated images. .. !! processed by numpydoc !! .. py:property:: ImportedWorkflowFilename :type: Optional[str] The filename of the template.emx file that populated the workflow initially. .. !! processed by numpydoc !! .. py:property:: InternalObject :type: Optional[Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelWorkflowGroupAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: Properties :type: Optional[tuple[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties for this object. .. !! processed by numpydoc !! .. py:property:: UnitSystem :type: Optional[Ansys.Mechanical.DataModel.Enums.WBUnitSystemType] Defines the “unit system” of a Prime Model, if not defined, the unit system is deduced from the geometry at input data transfer time. .. !! processed by numpydoc !! .. py:property:: VisibleProperties :type: Optional[tuple[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties that are visible for this object. .. !! processed by numpydoc !! .. py:property:: WorkflowType :type: Optional[Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.WorkflowType] Returns the workflow type which is applicable to the Input, Steps, and Output. .. !! processed by numpydoc !! Method detail ------------- .. py:method:: Activate() -> None Activate the current object. .. !! processed by numpydoc !! .. py:method:: AddFigure() -> Ansys.ACT.Automation.Mechanical.Figure Creates a new child Figure. .. !! processed by numpydoc !! .. py:method:: AddImage(filePath: str) -> Ansys.ACT.Automation.Mechanical.Image .. 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:: AddInput() -> Ansys.ACT.Automation.Mechanical.MeshWorkflowInput Adds an “Input” node as child object under the “Mesh Workflow” and returns the new MeshWorkflowInput object if not existent, otherwise it returns the already available MeshWorkflowInput object. .. !! processed by numpydoc !! .. py:method:: AddOutput() -> Ansys.ACT.Automation.Mechanical.MeshWorkflowOutput Adds an “Output” node as child object under the “Mesh Workflow” and returns the new MeshWorkflowOutput object if not existent, otherwise it returns the already available MeshWorkflowOutput object. .. !! processed by numpydoc !! .. py:method:: ClearGeneratedData() -> None Clears all the generated data, i.e., It resets all inactive geometry parts/bodies to active again, clears the output data, and resets the state of the child objects (“Input”, “Steps”, “Output”) to the initial state. However, any user-defined settings such as the “Input” node scoping are retained. .. !! processed by numpydoc !! .. py:method:: ClearOutputData() -> None Clears only the "Output" data, i.e., the generated Geometry part(s) and the associated mesh. .. !! processed by numpydoc !! .. py:method:: CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) -> None Copies all visible properties from this object to another. .. !! processed by numpydoc !! .. py:method:: CreateParameter(propName: str) -> Ansys.ACT.Interfaces.Mechanical.IParameter Creates a new parameter for a Property. .. !! processed by numpydoc !! .. py:method:: Delete() -> None Run the Delete action. .. !! processed by numpydoc !! .. py:method:: Duplicate() -> Ansys.Mechanical.DataModel.Interfaces.IDataModelObject Creates a copy of the current DataModelObject. .. !! processed by numpydoc !! .. py:method:: ExportWorkflow(fileName: str) -> None Exports the steps as template into a .emx file. .. !! processed by numpydoc !! .. py:method:: FinalizeWorkflow() -> None Once all steps in a mesh workflow are completed successfully, the workflow can be completed which will transfer the generated data back into new Mechanical geometry part(s) together with the corresponding part mesh(es). .. !! processed by numpydoc !! .. py:method:: Generate() -> None Generates the desired data by executing the whole workflow, i.e., transferring the input data, executing all steps, and completing the workflow by transferring the output data back into Geometry and Mesh data. .. !! processed by numpydoc !! .. py:method:: GetAllLabelNames() -> List[str] Gets all the PrimeMesh model labels names currently defined for the workflow. .. !! processed by numpydoc !! .. py:method:: GetAllPartNames() -> List[str] Gets all the PrimeMesh model parts names currently defined for the workflow. .. !! processed by numpydoc !! .. py:method:: GetAllSizeFieldNames() -> List[str] Gets all the PrimeMesh model volumetric size field names currently defined for the workflow. .. !! processed by numpydoc !! .. py:method:: GetAllZoneNames() -> List[str] Gets all the PrimeMesh model zones names currently defined for the workflow. .. !! processed by numpydoc !! .. py:method:: GetChildren(recurses: bool, children: List[ChildrenType]) -> List[ChildrenType] Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: GetParameter(propName: str) -> Ansys.ACT.Interfaces.Mechanical.IParameter Gets the parameter corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: GetSolidSurfaceMeshQualityWarningLimit(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) -> Ansys.Core.Units.Quantity Get Mesh Quality Warning Limit .. !! processed by numpydoc !! .. py:method:: GroupAllSimilarChildren() -> None Run the GroupAllSimilarChildren action. .. !! processed by numpydoc !! .. py:method:: GroupSimilarObjects() -> Ansys.ACT.Automation.Mechanical.TreeGroupingFolder Run the GroupSimilarObjects action. .. !! processed by numpydoc !! .. py:method:: ImportWorkflow(fileName: str) -> None Imports the steps from a template .emx file. .. !! processed by numpydoc !! .. py:method:: InitializeWorkflow() -> None Initializes the mesh workflow by transferring the scoped geometry parts/bodies from Mechanical into the PrimeMesh model and updates the “Input” node state accordingly. .. !! processed by numpydoc !! .. py:method:: PropertyByAPIName(name: str) -> Ansys.ACT.Automation.Mechanical.Property .. 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:: PropertyByName(name: str) -> Ansys.ACT.Automation.Mechanical.Property Get a property by its unique name. .. !! processed by numpydoc !! .. py:method:: RemoveParameter(propName: str) -> None Removes the parameter from the parameter set corresponding to the given property. .. !! processed by numpydoc !! .. vale on