`MeshWorkflow`#

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.MeshWorkflow(internalObject: Any)#

Bases: object

Object that wraps IDSEngineeringModelWorkflowGroup.

Overview#

Methods

`Activate`	Activate the current object.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`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.
`AddMeshMetrics`	AddMeshMetrics method.
`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.
`AddScopeToSelection`	AddScopeToSelection method.
`CanClearOutputData`	Returns whether the workflow output data can be cleared.
`CanFinalize`	Returns whether the workflow can be finalized.
`CanInitialize`	Returns whether the workflow can be initialized.
`CanPreviewNextStep`	Returns whether the next available step in the workflow is ready for preview. The preview is used to generate an outcome with the information required for the validation of the user inputs.
`CanRevertToLastCheckpoint`	Returns whether the workflow can be reverted to the last available checkpoint data.
`CanRunNextStep`	Returns whether the next step is ready for execution.
`ClearDataAndDisableCheckpoints`	Clear all checkpoints data and disable checkpointing for the workflow.
`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.
`ComputeMeshQualityMetrics`	ComputeMeshQualityMetrics method.
`CopyTo`	Copies all visible properties from this object to another.
`CreateLabelFromScope`	CreateLabelFromScope method.
`CreateLabelFromSelection`	CreateLabelFromSelection method.
`CreateObjRef`	CreateObjRef method.
`CreateParameter`	Creates a new parameter for a Property.
`Delete`	Run the Delete action.
`Duplicate`	Creates a copy of the current DataModelObject.
`Equals`	Equals method.
`ExportFullWorkflow`	Exports the steps into a .emx file.
`ExportWorkflow`	Exports the steps as template into a .emx file.
`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).
`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.
`GetAPIName`	Property name bound to dispId.
`GetAllElementSetNames`	Gets all the PrimeMesh model elementSets names currently defined for the workflow.
`GetAllElementSets`	Gets all the PrimeMesh model elementSets currently defined for the workflow.
`GetAllLabelNames`	Gets all the PrimeMesh model labels names currently defined for the workflow.
`GetAllLabels`	Gets all the PrimeMesh model labels currently defined for the workflow.
`GetAllMorphFieldNames`	Gets all the PrimeMesh model morph field names currently defined for the workflow.
`GetAllMorphFields`	Gets all the PrimeMesh model moprh fields info currently defined for the workflow.
`GetAllPartNames`	Gets all the PrimeMesh model parts names currently defined for the workflow.
`GetAllParts`	Gets all the PrimeMesh model parts currently defined for the workflow.
`GetAllProperties`	GetAllProperties method.
`GetAllSizeFieldNames`	Gets all the PrimeMesh model volumetric size field names currently defined for the workflow.
`GetAllSizeFields`	Gets all the PrimeMesh model volumetric size field currently defined for the workflow.
`GetAllZoneNames`	Gets all the PrimeMesh model zones names currently defined for the workflow.
`GetAllZones`	Gets all the PrimeMesh model zones currently defined for the workflow.
`GetApplicableMeshMetrics`	GetApplicableMeshMetrics method.
`GetChildren`	Gets the list of children, filtered by type.
`GetDetailsView`	GetDetailsView method.
`GetDomainBrowserAvailableMorphFieldPatterns`	GetDomainBrowserAvailableMorphFieldPatterns method.
`GetDomainBrowserAvailableScopes`	GetDomainBrowserAvailableScopes method.
`GetDomainBrowserAvailableSizeFieldPatterns`	GetDomainBrowserAvailableSizeFieldPatterns method.
`GetEnumName`	Enum name bound to value
`GetHashCode`	GetHashCode method.
`GetIconFile`	GetIconFile method.
`GetLifetimeService`	GetLifetimeService method.
`GetMeshMetrics`	GetMeshMetrics method.
`GetMeshQualityTabIndex`	GetMeshQualityTabIndex method.
`GetMetricName`	GetMetricName method.
`GetObjectData`	GetObjectData method.
`GetParameter`	Gets the parameter corresponding to the given property.
`GetPath`	GetPath method.
`GetPrimeMeshModelId`	GetPrimeMeshModelId method.
`GetPrimeMeshModelIndex`	GetPrimeMeshModelIndex method.
`GetPropertyName`	GetPropertyName method.
`GetPropertyValue`	GetPropertyValue method.
`GetPropertyWorksheetInfo`	GetPropertyWorksheetInfo method.
`GetScopePatternOfMetrics`	GetScopePatternOfMetrics method.
`GetScopeTypeOfMetrics`	GetScopeTypeOfMetrics method.
`GetSheetQuantityTypeString`	Get quantity type of sheet metric from mesh metric type
`GetSolidMeshMetrics`	GetSolidMeshMetrics method.
`GetSolidMeshQualityState`	Get the state of solid mesh quality worksheet tab
`GetSolidSurfaceMeshMetrics`	GetSolidSurfaceMeshMetrics method.
`GetSolidSurfaceMeshQualityErrorLimit`	Get Mesh Quality Error Limit
`GetSolidSurfaceMeshQualityErrorLimitIsDefault`	Get SolidSurface Mesh Quality Worksheet Error Limit is Default
`GetSolidSurfaceMeshQualityName`	Get Mesh Quality Name
`GetSolidSurfaceMeshQualityState`	Get the state of solid surface mesh quality worksheet tab
`GetSolidSurfaceMeshQualityWarningLimit`	Get Mesh Quality Warning Limit
`GetSolidSurfaceMeshQualityWarningLimitIsDefault`	Get SolidSurface Mesh Quality Worksheet Warning Limit is Default
`GetSolidSurfaceMeshQualityWorstMetricBackgroundColor`	Get Mesh Quality Worst Metric BackgroundColor
`GetSolidSurfaceMeshQualityWorstMetricTooltip`	Get Mesh Quality Worst Metric Tooltip
`GetSolidSurfaceMeshQualityWorstMetricValue`	Get Mesh Quality Worst Metric Value
`GetSolidSurfaceQuantityTypeString`	Get Quantity type from SolidSurface mesh metric type
`GetSurfaceMeshMetrics`	GetSurfaceMeshMetrics method.
`GetSurfaceMeshQualityErrorLimit`	Get User Mesh Quality Error Limit
`GetSurfaceMeshQualityErrorLimitIsDefault`	Get Mesh Quality Error Limit is default
`GetSurfaceMeshQualityName`	GetSurfaceMeshQualityName method.
`GetSurfaceMeshQualityState`	Get the state of surface mesh quality worksheet tab
`GetSurfaceMeshQualityWarningLimit`	Get User Mesh Quality Warning Limit
`GetSurfaceMeshQualityWarningLimitIsDefault`	Get Mesh Quality Warning Limit is default
`GetSurfaceMeshQualityWorstMetricBackgroundColor`	Get Mesh Quality Worst Metric Background Colour
`GetSurfaceMeshQualityWorstMetricTooltip`	Get Mesh Quality Worst Metric Tooltip
`GetSurfaceMeshQualityWorstMetricValue`	Get Mesh Quality Worst Metric Value
`GetType`	GetType method.
`GetUnpublishedList`	GetUnpublishedList method.
`GetVisibleProperties`	GetVisibleProperties method.
`GetVisiblePropertyNames`	GetVisiblePropertyNames method.
`GetVolumeMeshQualityErrorLimit`	Get Mesh Quality Error Limit
`GetVolumeMeshQualityErrorLimitIsDefault`	Get Volume Mesh Quality Worksheet Error Limit is Default
`GetVolumeMeshQualityName`	Get Mesh Quality Name
`GetVolumeMeshQualityWarningLimit`	Get Mesh Quality Warning Limit
`GetVolumeMeshQualityWarningLimitIsDefault`	Get Volume Mesh Quality Worksheet Warning Limit is Default
`GetVolumeMeshQualityWorstMetricBackgroundColor`	Get Mesh Quality Worst Metric BackgroundColor
`GetVolumeMeshQualityWorstMetricTooltip`	Get Mesh Quality Worst Metric Tooltip
`GetVolumeMeshQualityWorstMetricValue`	Get Mesh Quality Worst Metric Value
`GetVolumeQuantityTypeString`	Get Quantity type from solid mesh metric type
`GetWorkflowStepsGroup`	Updates incremental meshing workflow group object -> generates all need generated steps.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`ImportWorkflow`	Imports the steps from a template .emx file.
`InitializeLifetimeService`	InitializeLifetimeService method.
`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.
`IsPropertyEditable`	IsPropertyEditable method.
`IsPropertyVisible`	IsPropertyVisible method.
`IsWBInReadOnlyLicMode`	Executes the next available step in the workflow.
`PreviewNextStep`	Previews the next available step in the workflow. After the preview, the step will contain a preview outcome with the information required for the validation of the user inputs. The preview outcome can be returned using the MeshWorkflowOutcomes method of the step.
`PropertyByAPIName`	Get a property by its API name.
`PropertyById`	PropertyById method.
`PropertyByName`	Get a property by its unique name.
`PropertyTypeInfo`	PropertyTypeInfo method.
`RemoveMeshMetrics`	RemoveMeshMetrics method.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.
`RenameBasedOnType`	Renames applying the default name based on type.
`ResetMeshQualityMetrics`	ResetMeshQualityMetrics method.
`RevertToLastCheckpoint`	Reverts to the last available checkpoint data.
`RunNextStep`	Executes the next available step in the workflow.
`SetMeshQualityTabIndex`	SetMeshQualityTabIndex method.
`SetScopeOfMetrics`	SetScopeOfMetrics method.
`SetSolidSurfaceMeshQualityErrorLimit`	Set Mesh Quality Error Limit
`SetSolidSurfaceMeshQualityWarningLimit`	Set Mesh Quality Warning Limit
`SetSurfaceMeshQualityErrorLimit`	Set Mesh Quality Error Level
`SetSurfaceMeshQualityWarningLimit`	Set Mesh Quality Warning Limit
`SetVolumeMeshQualityErrorLimit`	Set Mesh Quality Error Limit
`SetVolumeMeshQualityWarningLimit`	Set Mesh Quality Warning Limit
`ShowGroupedTreeView`	Sets whether to Show Grouped Tree View.
`ToString`	ToString method.
`UpdateWorkflow`	Updates incremental meshing workflow group object -> generates all need generated steps.

Properties

`AttachedRefs`	AttachedRefs property.
`Children`	Gets the list of children.
`ClsId`	ClsId property.
`DataModelObjectCategory`	Gets the current DataModelObject's category.
`Figures`	Gets the list of associated figures.
`GroupingFolder`	GroupingFolder property.
`IconName`	IconName property.
`Images`	Gets the list of associated images.
`ImportedWorkflowFilename`	The filename of the template.emx file that populated the workflow initially.
`InternalObject`	Gets the internal object. For advanced usage only.
`IsInitialized`	Gets whether the workflow has been initialized or not.
`MeshWorkflowDescription`	MeshWorkflowDescription property.
`MeshWorkflowDescriptionJson`	MeshWorkflowDescriptionJson property.
`MeshWorkflowInput`	Gets the MeshWorkflowInput object.
`MeshWorkflowOutput`	Gets the MeshWorkflowOutput object.
`MeshWorkflowTypeInformation`	MeshWorkflowTypeInformation property.
`MeshWorkflowTypeInformationJson`	MeshWorkflowTypeInformationJson property.
`ModelContextString`	Gets the ModelContextString.
`Name`	Name property.
`NumberOfShellMeshQualityMetrics`	NumberOfShellMeshQualityMetrics property.
`NumberOfSolidMeshQualityMetrics`	NumberOfSolidMeshQualityMetrics property.
`NumberOfSolidSurfaceMeshQualityMetrics`	NumberOfSolidSurfaceMeshQualityMetrics property.
`ObjectId`	ObjectId property.
`ObjectState`	ObjectState property.
`ObjectTags`	ObjectTags property.
`Parent`	Parent property.
`Properties`	Gets the list of properties for this object.
`Separator`	Gets or sets the separator string for grouped tree view.
`State`	State property.
`Suppressed`	Gets or sets the Suppressed.
`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.
`VisibleProperties`	Gets the list of properties that are visible for this object.
`WorkflowType`	Returns the workflow type which is applicable to the Input, Steps, and Output.

Property detail#

property MeshWorkflow.AttachedRefs: List[int] | None#: AttachedRefs property.

property MeshWorkflow.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#: Gets the list of children.

property MeshWorkflow.ClsId: int | None#: ClsId property.

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

property MeshWorkflow.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#: Gets the list of associated figures.

property MeshWorkflow.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#: GroupingFolder property.

property MeshWorkflow.IconName: str | None#: IconName property.

property MeshWorkflow.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None#: Gets the list of associated images.

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

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

property MeshWorkflow.IsInitialized: bool | None#: Gets whether the workflow has been initialized or not.

property MeshWorkflow.MeshWorkflowDescription: System.Collections.Generic.Dictionary[str, Any] | None#: MeshWorkflowDescription property.

property MeshWorkflow.MeshWorkflowDescriptionJson: str | None#: MeshWorkflowDescriptionJson property.

property MeshWorkflow.MeshWorkflowInput: Ansys.ACT.Automation.Mechanical.MeshWorkflowInput | None#: Gets the MeshWorkflowInput object.

property MeshWorkflow.MeshWorkflowOutput: Ansys.ACT.Automation.Mechanical.MeshWorkflowOutput | None#: Gets the MeshWorkflowOutput object.

property MeshWorkflow.MeshWorkflowTypeInformation: System.Collections.Generic.Dictionary[str, str] | None#: MeshWorkflowTypeInformation property.

property MeshWorkflow.MeshWorkflowTypeInformationJson: str | None#: MeshWorkflowTypeInformationJson property.

property MeshWorkflow.ModelContextString: str | None#: Gets the ModelContextString.

property MeshWorkflow.Name: str | None#: Name property.

property MeshWorkflow.NumberOfShellMeshQualityMetrics: int | None#: NumberOfShellMeshQualityMetrics property.

property MeshWorkflow.NumberOfSolidMeshQualityMetrics: int | None#: NumberOfSolidMeshQualityMetrics property.

property MeshWorkflow.NumberOfSolidSurfaceMeshQualityMetrics: int | None#: NumberOfSolidSurfaceMeshQualityMetrics property.

property MeshWorkflow.ObjectId: int | None#: ObjectId property.

property MeshWorkflow.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None#: ObjectState property.

property MeshWorkflow.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None#: ObjectTags property.

property MeshWorkflow.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None#: Parent property.

property MeshWorkflow.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#: Gets the list of properties for this object.

property MeshWorkflow.Separator: str | None#: Gets or sets the separator string for grouped tree view.

property MeshWorkflow.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None#: State property.

property MeshWorkflow.Suppressed: bool | None#: Gets or sets the Suppressed.

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.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#: Gets the list of properties that are visible for this object.

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

Method detail#

MeshWorkflow.Activate() → None#: Activate the current object.

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

MeshWorkflow.AddImage(filePath: str) → 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.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.AddMeshMetrics(tab: Ansys.Common.Interop.DSObjectTypes.DSWorksheetTab, metricType: Ansys.Common.Interop.DSObjectTypes.DSMeshMetric) → None#: AddMeshMetrics method.

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.AddScopeToSelection(scopeType: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeType, scopeExpression: str) → None#: AddScopeToSelection method.

MeshWorkflow.CanClearOutputData() → bool#: Returns whether the workflow output data can be cleared.

MeshWorkflow.CanFinalize() → bool#: Returns whether the workflow can be finalized.

MeshWorkflow.CanInitialize() → bool#: Returns whether the workflow can be initialized.

MeshWorkflow.CanPreviewNextStep() → bool#: Returns whether the next available step in the workflow is ready for preview. The preview is used to generate an outcome with the information required for the validation of the user inputs.

MeshWorkflow.CanRevertToLastCheckpoint() → bool#: Returns whether the workflow can be reverted to the last available checkpoint data.

MeshWorkflow.CanRunNextStep() → bool#: Returns whether the next step is ready for execution.

MeshWorkflow.ClearDataAndDisableCheckpoints() → None#: Clear all checkpoints data and disable checkpointing for the workflow.

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

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

MeshWorkflow.ComputeMeshQualityMetrics() → None#: ComputeMeshQualityMetrics method.

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

MeshWorkflow.CreateLabelFromScope(labelName: str, scopeType: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeType, scopeExpression: str, entityFilter: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.LabelCreationFilter) → None#: CreateLabelFromScope method.

MeshWorkflow.CreateLabelFromSelection(labelName: str, entityFilter: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.LabelCreationFilter) → None#: CreateLabelFromSelection method.

MeshWorkflow.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef#: CreateObjRef method.

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

MeshWorkflow.Delete() → None#: Run the Delete action.

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

MeshWorkflow.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool#: Equals method.

MeshWorkflow.ExportFullWorkflow(fileName: str) → None#: Exports the steps into a .emx file.

MeshWorkflow.ExportWorkflow(fileName: str) → None#: Exports the steps as template into a .emx file.

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

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

MeshWorkflow.GetAPIName(dispId: int) → str#: Property name bound to dispId.

MeshWorkflow.GetAllElementSetNames() → List[str]#: Gets all the PrimeMesh model elementSets names currently defined for the workflow.

MeshWorkflow.GetAllElementSets() → List[Ansys.Common.Interop.WBPrimeMesh.IElementSet]#: Gets all the PrimeMesh model elementSets currently defined for the workflow.

MeshWorkflow.GetAllLabelNames() → List[str]#: Gets all the PrimeMesh model labels names currently defined for the workflow.

MeshWorkflow.GetAllLabels() → List[Ansys.Common.Interop.WBPrimeMesh.ILabel]#: Gets all the PrimeMesh model labels currently defined for the workflow.

MeshWorkflow.GetAllMorphFieldNames() → List[str]#: Gets all the PrimeMesh model morph field names currently defined for the workflow.

MeshWorkflow.GetAllMorphFields() → List[Ansys.Common.Interop.WBPrimeMesh.IMorphField]#: Gets all the PrimeMesh model moprh fields info currently defined for the workflow.

MeshWorkflow.GetAllPartNames() → List[str]#: Gets all the PrimeMesh model parts names currently defined for the workflow.

MeshWorkflow.GetAllParts() → List[Ansys.Common.Interop.WBPrimeMesh.IPart]#: Gets all the PrimeMesh model parts currently defined for the workflow.

MeshWorkflow.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]#: GetAllProperties method.

MeshWorkflow.GetAllSizeFieldNames() → List[str]#: Gets all the PrimeMesh model volumetric size field names currently defined for the workflow.

MeshWorkflow.GetAllSizeFields() → List[Ansys.Common.Interop.WBPrimeMesh.ISizeField]#: Gets all the PrimeMesh model volumetric size field currently defined for the workflow.

MeshWorkflow.GetAllZoneNames() → List[str]#: Gets all the PrimeMesh model zones names currently defined for the workflow.

MeshWorkflow.GetAllZones() → List[Ansys.Common.Interop.WBPrimeMesh.IZone]#: Gets all the PrimeMesh model zones currently defined for the workflow.

MeshWorkflow.GetApplicableMeshMetrics(tab: Ansys.Common.Interop.DSObjectTypes.DSWorksheetTab) → Ansys.Common.Interop.AnsCoreObjects.IAnsIntColl#: GetApplicableMeshMetrics method.

MeshWorkflow.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]#: Gets the list of children, filtered by type.

MeshWorkflow.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData#: GetDetailsView method.

MeshWorkflow.GetDomainBrowserAvailableMorphFieldPatterns() → List[System.Collections.Generic.Dictionary[str, Any]]#: GetDomainBrowserAvailableMorphFieldPatterns method.

MeshWorkflow.GetDomainBrowserAvailableScopes() → List[System.Collections.Generic.Dictionary[str, Any]]#: GetDomainBrowserAvailableScopes method.

MeshWorkflow.GetDomainBrowserAvailableSizeFieldPatterns() → List[System.Collections.Generic.Dictionary[str, Any]]#: GetDomainBrowserAvailableSizeFieldPatterns method.

MeshWorkflow.GetEnumName(enumType: type, value: int, dispId: int) → str#: Enum name bound to value

MeshWorkflow.GetHashCode() → int#: GetHashCode method.

MeshWorkflow.GetIconFile() → System.Byte#: GetIconFile method.

MeshWorkflow.GetLifetimeService() → Any#: GetLifetimeService method.

MeshWorkflow.GetMeshMetrics(tab: Ansys.Common.Interop.DSObjectTypes.DSWorksheetTab) → Ansys.Common.Interop.AnsCoreObjects.IAnsIntColl#: GetMeshMetrics method.

MeshWorkflow.GetMeshQualityTabIndex() → int#: GetMeshQualityTabIndex method.

MeshWorkflow.GetMetricName(tab: Ansys.Common.Interop.DSObjectTypes.DSWorksheetTab, meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → str#: GetMetricName method.

MeshWorkflow.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None#: GetObjectData method.

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

MeshWorkflow.GetPath() → str#: GetPath method.

MeshWorkflow.GetPrimeMeshModelId() → System.Int64#: GetPrimeMeshModelId method.

MeshWorkflow.GetPrimeMeshModelIndex() → System.Int64#: GetPrimeMeshModelIndex method.

MeshWorkflow.GetPropertyName(dispId: int) → str#: GetPropertyName method.

MeshWorkflow.GetPropertyValue(name: str) → Any#: GetPropertyValue method.

MeshWorkflow.GetPropertyWorksheetInfo() → List[System.Collections.Generic.Dictionary[str, Any]]#: GetPropertyWorksheetInfo method.

MeshWorkflow.GetScopePatternOfMetrics() → str#: GetScopePatternOfMetrics method.

MeshWorkflow.GetScopeTypeOfMetrics() → Ansys.Common.Interop.DSObjectTypes.EngineeringModelScopeType#: GetScopeTypeOfMetrics method.

MeshWorkflow.GetSheetQuantityTypeString(metric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → str#: Get quantity type of sheet metric from mesh metric type

MeshWorkflow.GetSolidMeshMetrics() → Ansys.Common.Interop.AnsCoreObjects.IAnsIntColl#: GetSolidMeshMetrics method.

MeshWorkflow.GetSolidMeshQualityState() → Ansys.Common.Interop.DSObjectTypes.DSWorksheetTabState#: Get the state of solid mesh quality worksheet tab

MeshWorkflow.GetSolidSurfaceMeshMetrics() → Ansys.Common.Interop.AnsCoreObjects.IAnsIntColl#: GetSolidSurfaceMeshMetrics method.

MeshWorkflow.GetSolidSurfaceMeshQualityErrorLimit(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → Ansys.Core.Units.Quantity#: Get Mesh Quality Error Limit

MeshWorkflow.GetSolidSurfaceMeshQualityErrorLimitIsDefault(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → bool#: Get SolidSurface Mesh Quality Worksheet Error Limit is Default

MeshWorkflow.GetSolidSurfaceMeshQualityName(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → str#: Get Mesh Quality Name

MeshWorkflow.GetSolidSurfaceMeshQualityState() → Ansys.Common.Interop.DSObjectTypes.DSWorksheetTabState#: Get the state of solid surface mesh quality worksheet tab

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

MeshWorkflow.GetSolidSurfaceMeshQualityWarningLimitIsDefault(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → bool#: Get SolidSurface Mesh Quality Worksheet Warning Limit is Default

MeshWorkflow.GetSolidSurfaceMeshQualityWorstMetricBackgroundColor(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → str#: Get Mesh Quality Worst Metric BackgroundColor

MeshWorkflow.GetSolidSurfaceMeshQualityWorstMetricTooltip(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → str#: Get Mesh Quality Worst Metric Tooltip

MeshWorkflow.GetSolidSurfaceMeshQualityWorstMetricValue(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → Ansys.Core.Units.Quantity#: Get Mesh Quality Worst Metric Value

MeshWorkflow.GetSolidSurfaceQuantityTypeString(metric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → str#: Get Quantity type from SolidSurface mesh metric type

MeshWorkflow.GetSurfaceMeshMetrics() → Ansys.Common.Interop.AnsCoreObjects.IAnsIntColl#: GetSurfaceMeshMetrics method.

MeshWorkflow.GetSurfaceMeshQualityErrorLimit(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → Ansys.Core.Units.Quantity#: Get User Mesh Quality Error Limit

MeshWorkflow.GetSurfaceMeshQualityErrorLimitIsDefault(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → bool#: Get Mesh Quality Error Limit is default

MeshWorkflow.GetSurfaceMeshQualityName(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → str#: GetSurfaceMeshQualityName method.

MeshWorkflow.GetSurfaceMeshQualityState() → Ansys.Common.Interop.DSObjectTypes.DSWorksheetTabState#: Get the state of surface mesh quality worksheet tab

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

MeshWorkflow.GetSurfaceMeshQualityWarningLimitIsDefault(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → bool#: Get Mesh Quality Warning Limit is default

MeshWorkflow.GetSurfaceMeshQualityWorstMetricBackgroundColor(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → str#: Get Mesh Quality Worst Metric Background Colour

MeshWorkflow.GetSurfaceMeshQualityWorstMetricTooltip(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → str#: Get Mesh Quality Worst Metric Tooltip

MeshWorkflow.GetSurfaceMeshQualityWorstMetricValue(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → Ansys.Core.Units.Quantity#: Get Mesh Quality Worst Metric Value

MeshWorkflow.GetType() → type#: GetType method.

MeshWorkflow.GetUnpublishedList() → List[System.Collections.Generic.Dictionary[str, Any]]#: GetUnpublishedList method.

MeshWorkflow.GetVisibleProperties() → List[System.Reflection.PropertyInfo]#: GetVisibleProperties method.

MeshWorkflow.GetVisiblePropertyNames() → List[str]#: GetVisiblePropertyNames method.

MeshWorkflow.GetVolumeMeshQualityErrorLimit(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → Ansys.Core.Units.Quantity#: Get Mesh Quality Error Limit

MeshWorkflow.GetVolumeMeshQualityErrorLimitIsDefault(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → bool#: Get Volume Mesh Quality Worksheet Error Limit is Default

MeshWorkflow.GetVolumeMeshQualityName(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → str#: Get Mesh Quality Name

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

MeshWorkflow.GetVolumeMeshQualityWarningLimitIsDefault(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → bool#: Get Volume Mesh Quality Worksheet Warning Limit is Default

MeshWorkflow.GetVolumeMeshQualityWorstMetricBackgroundColor(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → str#: Get Mesh Quality Worst Metric BackgroundColor

MeshWorkflow.GetVolumeMeshQualityWorstMetricTooltip(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → str#: Get Mesh Quality Worst Metric Tooltip

MeshWorkflow.GetVolumeMeshQualityWorstMetricValue(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → Ansys.Core.Units.Quantity#: Get Mesh Quality Worst Metric Value

MeshWorkflow.GetVolumeQuantityTypeString(metric: Ansys.Mechanical.DataModel.Enums.MeshMetricType) → str#: Get Quantity type from solid mesh metric type

MeshWorkflow.GetWorkflowStepsGroup() → Ansys.ACT.Automation.Mechanical.MeshWorkflowStepGroup#: Updates incremental meshing workflow group object -> generates all need generated steps.

MeshWorkflow.GroupAllSimilarChildren() → None#: Run the GroupAllSimilarChildren action.

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

MeshWorkflow.ImportWorkflow(fileName: str) → None#: Imports the steps from a template .emx file.

MeshWorkflow.InitializeLifetimeService() → Any#: InitializeLifetimeService method.

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

MeshWorkflow.IsPropertyEditable(dispId: int) → bool#: IsPropertyEditable method.

MeshWorkflow.IsPropertyVisible(dispId: int) → bool#: IsPropertyVisible method.

MeshWorkflow.IsWBInReadOnlyLicMode() → bool#: Executes the next available step in the workflow.

MeshWorkflow.PreviewNextStep() → None#: Previews the next available step in the workflow. After the preview, the step will contain a preview outcome with the information required for the validation of the user inputs. The preview outcome can be returned using the MeshWorkflowOutcomes method of the step.

MeshWorkflow.PropertyByAPIName(name: str) → 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.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property#: PropertyById method.

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

MeshWorkflow.PropertyTypeInfo(property: Ansys.ACT.Automation.Mechanical.Property) → System.Collections.Generic.Dictionary[str, Any]#: PropertyTypeInfo method.

MeshWorkflow.RemoveMeshMetrics(tab: Ansys.Common.Interop.DSObjectTypes.DSWorksheetTab, metricType: Ansys.Common.Interop.DSObjectTypes.DSMeshMetric) → None#: RemoveMeshMetrics method.

MeshWorkflow.RemoveParameter(propName: str) → None#: Removes the parameter from the parameter set corresponding to the given property.

MeshWorkflow.RenameBasedOnType() → None#: Renames applying the default name based on type.

MeshWorkflow.ResetMeshQualityMetrics() → None#: ResetMeshQualityMetrics method.

MeshWorkflow.RevertToLastCheckpoint() → None#: Reverts to the last available checkpoint data.

MeshWorkflow.RunNextStep() → None#: Executes the next available step in the workflow.

MeshWorkflow.SetMeshQualityTabIndex(tabIndex: int) → None#: SetMeshQualityTabIndex method.

MeshWorkflow.SetScopeOfMetrics(scopeType: Ansys.Common.Interop.DSObjectTypes.EngineeringModelScopeType, scopePattern: str) → None#: SetScopeOfMetrics method.

MeshWorkflow.SetSolidSurfaceMeshQualityErrorLimit(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType, errorLevel: float) → None#: Set Mesh Quality Error Limit

MeshWorkflow.SetSolidSurfaceMeshQualityWarningLimit(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType, warningLevel: float) → None#: Set Mesh Quality Warning Limit

MeshWorkflow.SetSurfaceMeshQualityErrorLimit(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType, errorLevel: float) → None#: Set Mesh Quality Error Level

MeshWorkflow.SetSurfaceMeshQualityWarningLimit(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType, warningLevel: float) → None#: Set Mesh Quality Warning Limit

MeshWorkflow.SetVolumeMeshQualityErrorLimit(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType, errorLevel: float) → None#: Set Mesh Quality Error Limit

MeshWorkflow.SetVolumeMeshQualityWarningLimit(meshMetric: Ansys.Mechanical.DataModel.Enums.MeshMetricType, warningLevel: float) → None#: Set Mesh Quality Warning Limit

MeshWorkflow.ShowGroupedTreeView(newvalue: bool | None) → None#: Sets whether to Show Grouped Tree View.

MeshWorkflow.ToString() → str#: ToString method.

MeshWorkflow.UpdateWorkflow() → None#: Updates incremental meshing workflow group object -> generates all need generated steps.

MeshWorkflow#

Overview#

Property detail#

Method detail#

`MeshWorkflow`#