`MeshWorkflow`#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.MeshWorkflow#

Bases: object

Object that wraps IDSEngineeringModelWorkflowGroup.

Overview#

Methods

`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.
`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.
`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.
`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.
`ClearOutputData`	Clears only the “Output” data, i.e., the generated Geometry part(s) and the associated mesh.
`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).
`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.
`ImportWorkflow`	Imports the steps from a template .emx file.
`ExportWorkflow`	Exports the steps as template into a .emx file.
`GetSolidSurfaceMeshQualityWarningLimit`	Get Mesh Quality Warning Limit
`GetAllLabelNames`	Gets all the PrimeMesh model labels names currently defined for the workflow.
`GetAllZoneNames`	Gets all the PrimeMesh model zones names currently defined for the workflow.
`GetAllPartNames`	Gets all the PrimeMesh model parts names currently defined for the workflow.
`Delete`	Run the Delete action.
`GetChildren`	Gets the list of children, filtered by type.
`GetChildren`	Gets the list of children, filtered by type.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`Activate`	Activate the current object.
`CopyTo`	Copies all visible properties from this object to another.
`Duplicate`	Creates a copy of the current DataModelObject.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`PropertyByName`	Get a property by its unique name.
`PropertyByAPIName`	Get a property by its API name.
`CreateParameter`	Creates a new parameter for a Property.
`GetParameter`	Gets the parameter corresponding to the given property.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.

Properties

`WorkflowType`	Returns the workflow type which is applicable to the Input, Steps, and Output.
`InternalObject`	Gets the internal object. For advanced usage only.
`ImportedWorkflowFilename`	The filename of the template.emx file that populated the workflow initially.
`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.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Children`	Gets the list of children.
`Figures`	Gets the list of associated figures.
`Images`	Gets the list of associated images.
`InternalObject`	Gets the internal object. For advanced usage only.
`Properties`	Gets the list of properties for this object.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property MeshWorkflow.WorkflowType: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.WorkflowType | None: Returns the workflow type which is applicable to the Input, Steps, and Output.

property MeshWorkflow.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelWorkflowGroupAuto | None: Gets the internal object. For advanced usage only.

property MeshWorkflow.ImportedWorkflowFilename: System.String | None: The filename of the template.emx file that populated the workflow initially.

property MeshWorkflow.UnitSystem: Ansys.Mechanical.DataModel.Enums.WBUnitSystemType | None: Defines the “unit system” of a Prime Model, if not defined, the unit system is deduced from the geometry at input data transfer time.

property MeshWorkflow.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property MeshWorkflow.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property MeshWorkflow.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property MeshWorkflow.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property MeshWorkflow.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property MeshWorkflow.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property MeshWorkflow.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

MeshWorkflow.Generate() → System.Void: 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.

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

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

MeshWorkflow.ClearGeneratedData() → System.Void: 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.

MeshWorkflow.ClearOutputData() → System.Void: Clears only the “Output” data, i.e., the generated Geometry part(s) and the associated mesh.

MeshWorkflow.FinalizeWorkflow() → System.Void: 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).

MeshWorkflow.InitializeWorkflow() → System.Void: Initializes the mesh workflow by transferring the scoped geometry parts/bodies from Mechanical into the PrimeMesh model and updates the “Input” node state accordingly.

MeshWorkflow.ImportWorkflow(fileName: System.String) → System.Void: Imports the steps from a template .emx file.

MeshWorkflow.ExportWorkflow(fileName: System.String) → System.Void: Exports the steps as template into a .emx file.

MeshWorkflow.GetSolidSurfaceMeshQualityWarningLimit(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → Ansys.Core.Units.Quantity: Get Mesh Quality Warning Limit

MeshWorkflow.GetAllLabelNames() → System.Collections.Generic.List[System.String]: Gets all the PrimeMesh model labels names currently defined for the workflow.

MeshWorkflow.GetAllZoneNames() → System.Collections.Generic.List[System.String]: Gets all the PrimeMesh model zones names currently defined for the workflow.

MeshWorkflow.GetAllPartNames() → System.Collections.Generic.List[System.String]: Gets all the PrimeMesh model parts names currently defined for the workflow.

MeshWorkflow.Delete() → System.Void: Run the Delete action.

MeshWorkflow.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

MeshWorkflow.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]: Gets the list of children, filtered by type.

MeshWorkflow.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure: Creates a new child Figure.

MeshWorkflow.AddImage(filePath: System.String) → Ansys.ACT.Automation.Mechanical.Image

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.

MeshWorkflow.Activate() → System.Void: Activate the current object.

MeshWorkflow.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

MeshWorkflow.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject: Creates a copy of the current DataModelObject.

MeshWorkflow.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

MeshWorkflow.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder: Run the GroupSimilarObjects action.

MeshWorkflow.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

MeshWorkflow.PropertyByAPIName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property

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.

MeshWorkflow.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

MeshWorkflow.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

MeshWorkflow.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.