MeshWorkflow
#
- class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.MeshWorkflow#
Bases:
object
Object that wraps IDSEngineeringModelWorkflowGroup.
Overview#
|
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. |
|
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. |
|
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. |
|
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. |
|
Clears only the “Output” data, i.e., the generated Geometry part(s) and the associated mesh. |
|
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). |
|
Initializes the mesh workflow by transferring the scoped geometry parts/bodies from Mechanical into the PrimeMesh model and updates the “Input” node state accordingly. |
|
Imports the steps from a template .emx file. |
|
Exports the steps as template into a .emx file. |
|
Run the Delete action. |
|
Gets the list of children, filtered by type. |
|
Gets the list of children, filtered by type. |
|
Creates a new child Figure. |
|
Creates a new child Image. |
|
Activate the current object. |
|
Copies all visible properties from this object to another. |
|
Creates a copy of the current DataModelObject. |
|
Run the GroupAllSimilarChildren action. |
|
Run the GroupSimilarObjects action. |
|
Get a property by its unique name. |
|
Get a property by its API name. |
|
Creates a new parameter for a Property. |
|
Gets the parameter corresponding to the given property. |
|
Removes the parameter from the parameter set corresponding to the given property. |
|
Returns the workflow type which is applicable to the Input, Steps, and Output. |
|
Gets the internal object. For advanced usage only. |
|
The filename of the template.emx file that populated the workflow initially. |
|
Defines the “unit system” of a Prime Model, if not defined, the unit system is deduced from the geometry at input data transfer time. |
|
Gets the current DataModelObject’s category. |
|
Gets the list of children. |
|
Gets the list of associated figures. |
|
Gets the list of associated images. |
|
Gets the internal object. For advanced usage only. |
|
Gets the list of properties for this object. |
|
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.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.