`MeshWorkflowControl`#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.MeshWorkflowControl#

Bases: object

Object that wraps IDSEngineeringModelControl.

Overview#

Methods

`Activate`	Activate the current object.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`CopyTo`	Copies all visible properties from this object to another.
`CreateParameter`	Creates a new parameter for a Property.
`Delete`	Run the Delete action.
`Duplicate`	Creates a copy of the current DataModelObject.
`GetChildren`	Gets the list of children, filtered by type.
`GetParameter`	Gets the parameter corresponding to the given property.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`PropertyByAPIName`	Get a property by its API name.
`PropertyByName`	Get a property by its unique name.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.

Properties

`AppendData`	This property lets the user choose whether to append the mesh data being read to the current PrimeMesh model or to clear the model content before the mesh data is being read. The default value is false.
`AutomaticExternalScope`	The external scoping method and pattern of the current step is decided programmatically. The default value is false.
`CenterPosition`	It is defined by “Centered”, “Minimal”, and “User Defined”.
`Children`	Gets the list of children.
`ConstantHeight`	Height of a single layer of mesh elements.
`ControlType`	Returns the type of the control.
`CreateQuads`
`DataModelObjectCategory`	Gets the current DataModelObject's category.
`DeleteEmptyVolumes`	This property is used to enable or disable the automatic deletion of empty topo volumes during mesh to topology conversion. The default value is false.
`DeleteInputScope`	Deletion of input scope. The default value is false.
`DihedralAngle`	The dihedral angle is the angle between the normal vectors of two element faces.
`ElementSize`	Define element size to achieve desired mesh results. User can achieve coarse, medium, or fine mesh by varying this value.
`EnableCheckpoint`	Flag whether to enable a checkpoint or not. The default value is false.
`ExcludeEnclosure`	Excluding Enclosure . The default value is false.
`ExternalLabelName`	This property is used to rename the default external label name generated during execution of step.
`ExternalScopeDefinition`	It is defined by value or outcome depending on if the External scope is defined manual by the user or defined based on a previous outcome.
`ExternalScopeMethod`	The method can be label/zone/part and it is applied to external region of enclosure.
`ExternalScopeOutcome`	If the InnerScopeDefinition is set to Outcome, then this property is visible. It defines the previous step outcome. This way we input the results of a previous step to the current step. The input applies to inner region of enclosure.
`ExternalScopePattern`	The value can be a name of a region or a predefined patterns to select multiple region names.
`FaceZoneName`	This property is used to define the name of the default face zone name generated during execution of step.
`Figures`	Gets the list of associated figures.
`Filename`	Assign full path to the filename would like to Import/Export.
`Filenames`	Assign paths with '\|' seperator to this property to read multiple files, pass without seperator if single file.
`GrowthRate`	Gradient of element size as each layer grows.
`Images`	Gets the list of associated images.
`InnerScopeDefinition`	It is defined by value or outcome depending on if the Inner scope is defined manually by the user or defined based on a previous outcome.
`InnerScopeMethod`	The method can be label/zone/part and it is applied to inner region of enclosure.
`InnerScopeOutcome`	If the InnerScopeDefinition is set to Outcome, then this property is visible. It defines the previous step outcome. This way we input the results of a previous step to the current step. The input applies to inner region of enclosure.
`InnerScopePattern`	The value can be a name of a region or a predefined patterns to select multiple region names.
`InternalLabelName`	This property is used to rename the default Internal label name generated during execution of step.
`InternalObject`	Gets the internal object. For advanced usage only.
`LabelName`	This property is used to rename the default label name generated during execution of step.
`Material`	Gets or sets the Material.
`MaterialName`	Gets or sets the Material Name.
`MaterialPointType`	It defines the type of material point, it can be “Include” or “Exclude”.
`MeshFlowControl`	This property gives control over the flow of mesh during surface mesh generation. The supported modes are None, and Global Cartesian.
`MinimalNumberOfVolumetricLayers`	It determines the minimal number of layers of volume elements to be created around the scoped body.
`MinimalRadius`	It defines the desired minimal radius of the spherical enclosure.
`NumberOfAttempts`	Number of attempts for mesh convergence.
`NumberOfLayers`	Number of layers of mesh elements.
`PartName`	This property allows user to rename the default part name generated during wrap operation.
`PercentageIncrement`	The number of volumetric Layers determines the number of layers. This property decides whether all the layers are an equal size (default 0.0) or they should gradually increase the size of volume element than previous element.
`Properties`	Gets the list of properties for this object.
`RegionType`	It is defined by Material Point or External.
`Remesh`	Remesh if volume mesh fails. The default value is false.
`RestrictBoundaryNodes`	Restrict the boundary nodes. The default value is true.
`ReverseSurfaceOrientation`	Reverse Surface Orientation. The default value is false.
`ScaleFactor`	Scale Factor is used to scale shapes in different dimensions.
`ScopeDefinition`	It is defined by value or outcome.
`ScopeMethod`	The method can be label/zone/part.
`ScopeOutcome`	If the InnerScopeDefinition is set to Outcome, then this property is visible. It defines the previous step outcome. This way we input the results of a previous step to the current step. The input applies to inner region of enclosure.
`ScopePattern`	The value can be a name of a region or a predefined patterns to select multiple region names.
`SmoothingIterations`	Allows user to input number of iterations needed to achieve good mesh results.
`SmoothingPreserveVolume`	The option to enable and disable the volume preserving smoothing. If enabled, the smoothing will preserve the initial volume of the input. The default value is false.
`SurfaceMeshType`	This property gives control over what type of elements need to be generated in the mesh. The supported surface mesh types are Triangles and Quadrilaterals.
`TargetSkewness`	Set Limit to the skewness of an element. Higher the skewness value, expecting a better mesh result.
`TriangleCountReductionMode`	This property gives control over the mode/degree of triangle count reduction during surface mesh generation. The supported modes are None, Conservative and Aggressive.
`VisibleProperties`	Gets the list of properties that are visible for this object.
`VolumeMeshType`	Type of Volume elements such as Tetrahedrons and Hex.
`VolumeZoneName`	This property is used to rename the default volume zone name generated during execution of step.
`XCoordinate`	It defines the X Coordinate.
`YCoordinate`	It defines the Y Coordinate.
`ZCoordinate`	It defines the Z Coordinate.

Property detail#

property MeshWorkflowControl.AppendData: bool | None#: This property lets the user choose whether to append the mesh data being read to the current PrimeMesh model or to clear the model content before the mesh data is being read. The default value is false.

property MeshWorkflowControl.AutomaticExternalScope: bool | None#: The external scoping method and pattern of the current step is decided programmatically. The default value is false.

property MeshWorkflowControl.CenterPosition: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.SphereCenterDefinitionType | None#: It is defined by “Centered”, “Minimal”, and “User Defined”.

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

property MeshWorkflowControl.ConstantHeight: Ansys.Core.Units.Quantity | None#: Height of a single layer of mesh elements.

property MeshWorkflowControl.ControlType: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ControlType | None#: Returns the type of the control.

property MeshWorkflowControl.CreateQuads: bool | None#

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

property MeshWorkflowControl.DeleteEmptyVolumes: bool | None#: This property is used to enable or disable the automatic deletion of empty topo volumes during mesh to topology conversion. The default value is false.

property MeshWorkflowControl.DeleteInputScope: bool | None#: Deletion of input scope. The default value is false.

property MeshWorkflowControl.DihedralAngle: Ansys.Core.Units.Quantity | None#: The dihedral angle is the angle between the normal vectors of two element faces.

property MeshWorkflowControl.ElementSize: Ansys.Core.Units.Quantity | None#: Define element size to achieve desired mesh results. User can achieve coarse, medium, or fine mesh by varying this value.

property MeshWorkflowControl.EnableCheckpoint: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.CheckpointDefinitionType | None#: Flag whether to enable a checkpoint or not. The default value is false.

property MeshWorkflowControl.ExcludeEnclosure: bool | None#: Excluding Enclosure . The default value is false.

property MeshWorkflowControl.ExternalLabelName: str | None#: This property is used to rename the default external label name generated during execution of step.

property MeshWorkflowControl.ExternalScopeDefinition: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeDefinedByType | None#: It is defined by value or outcome depending on if the External scope is defined manual by the user or defined based on a previous outcome.

property MeshWorkflowControl.ExternalScopeMethod: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeType | None#: The method can be label/zone/part and it is applied to external region of enclosure.

property MeshWorkflowControl.ExternalScopeOutcome: Ansys.ACT.Automation.Mechanical.MeshWorkflowOutcome | None#: If the InnerScopeDefinition is set to Outcome, then this property is visible. It defines the previous step outcome. This way we input the results of a previous step to the current step. The input applies to inner region of enclosure.

property MeshWorkflowControl.ExternalScopePattern: str | None#: The value can be a name of a region or a predefined patterns to select multiple region names.

property MeshWorkflowControl.FaceZoneName: str | None#: This property is used to define the name of the default face zone name generated during execution of step.

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

property MeshWorkflowControl.Filename: str | None#: Assign full path to the filename would like to Import/Export.

property MeshWorkflowControl.Filenames: str | None#: Assign paths with '|' seperator to this property to read multiple files, pass without seperator if single file.

property MeshWorkflowControl.GrowthRate: float | None#: Gradient of element size as each layer grows.

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

property MeshWorkflowControl.InnerScopeDefinition: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeDefinedByType | None#: It is defined by value or outcome depending on if the Inner scope is defined manually by the user or defined based on a previous outcome.

property MeshWorkflowControl.InnerScopeMethod: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeType | None#: The method can be label/zone/part and it is applied to inner region of enclosure.

property MeshWorkflowControl.InnerScopeOutcome: Ansys.ACT.Automation.Mechanical.MeshWorkflowOutcome | None#: If the InnerScopeDefinition is set to Outcome, then this property is visible. It defines the previous step outcome. This way we input the results of a previous step to the current step. The input applies to inner region of enclosure.

property MeshWorkflowControl.InnerScopePattern: str | None#: The value can be a name of a region or a predefined patterns to select multiple region names.

property MeshWorkflowControl.InternalLabelName: str | None#: This property is used to rename the default Internal label name generated during execution of step.

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

property MeshWorkflowControl.LabelName: str | None#: This property is used to rename the default label name generated during execution of step.

property MeshWorkflowControl.Material: str | None#: Gets or sets the Material.

property MeshWorkflowControl.MaterialName: str | None#: Gets or sets the Material Name.

property MeshWorkflowControl.MaterialPointType: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.MaterialPointType | None#: It defines the type of material point, it can be “Include” or “Exclude”.

property MeshWorkflowControl.MeshFlowControl: Ansys.Mechanical.DataModel.Enums.MeshFlowControl | None#: This property gives control over the flow of mesh during surface mesh generation. The supported modes are None, and Global Cartesian.

property MeshWorkflowControl.MinimalNumberOfVolumetricLayers: int | None#: It determines the minimal number of layers of volume elements to be created around the scoped body.

property MeshWorkflowControl.MinimalRadius: Ansys.Core.Units.Quantity | None#: It defines the desired minimal radius of the spherical enclosure.

property MeshWorkflowControl.NumberOfAttempts: float | None#: Number of attempts for mesh convergence.

property MeshWorkflowControl.NumberOfLayers: int | None#: Number of layers of mesh elements.

property MeshWorkflowControl.PartName: str | None#: This property allows user to rename the default part name generated during wrap operation.

property MeshWorkflowControl.PercentageIncrement: float | None#: The number of volumetric Layers determines the number of layers. This property decides whether all the layers are an equal size (default 0.0) or they should gradually increase the size of volume element than previous element.

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

property MeshWorkflowControl.RegionType: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.WrapperRegionType | None#: It is defined by Material Point or External.

property MeshWorkflowControl.Remesh: bool | None#: Remesh if volume mesh fails. The default value is false.

property MeshWorkflowControl.RestrictBoundaryNodes: bool | None#: Restrict the boundary nodes. The default value is true.

property MeshWorkflowControl.ReverseSurfaceOrientation: bool | None#: Reverse Surface Orientation. The default value is false.

property MeshWorkflowControl.ScaleFactor: float | None#: Scale Factor is used to scale shapes in different dimensions.

property MeshWorkflowControl.ScopeDefinition: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeDefinedByType | None#: It is defined by value or outcome.

property MeshWorkflowControl.ScopeMethod: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeType | None#: The method can be label/zone/part.

property MeshWorkflowControl.ScopeOutcome: Ansys.ACT.Automation.Mechanical.MeshWorkflowOutcome | None#: If the InnerScopeDefinition is set to Outcome, then this property is visible. It defines the previous step outcome. This way we input the results of a previous step to the current step. The input applies to inner region of enclosure.

property MeshWorkflowControl.ScopePattern: str | None#: The value can be a name of a region or a predefined patterns to select multiple region names.

property MeshWorkflowControl.SmoothingIterations: int | None#: Allows user to input number of iterations needed to achieve good mesh results.

property MeshWorkflowControl.SmoothingPreserveVolume: bool | None#: The option to enable and disable the volume preserving smoothing. If enabled, the smoothing will preserve the initial volume of the input. The default value is false.

property MeshWorkflowControl.SurfaceMeshType: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.SurfaceMeshType | None#: This property gives control over what type of elements need to be generated in the mesh. The supported surface mesh types are Triangles and Quadrilaterals.

property MeshWorkflowControl.TargetSkewness: float | None#: Set Limit to the skewness of an element. Higher the skewness value, expecting a better mesh result.

property MeshWorkflowControl.TriangleCountReductionMode: Ansys.Mechanical.DataModel.Enums.TriangleCountReductionMode | None#: This property gives control over the mode/degree of triangle count reduction during surface mesh generation. The supported modes are None, Conservative and Aggressive.

property MeshWorkflowControl.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#: Gets the list of properties that are visible for this object.

property MeshWorkflowControl.VolumeMeshType: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.VolumeMeshType | None#: Type of Volume elements such as Tetrahedrons and Hex.

property MeshWorkflowControl.VolumeZoneName: str | None#: This property is used to rename the default volume zone name generated during execution of step.

property MeshWorkflowControl.XCoordinate: Ansys.Core.Units.Quantity | None#: It defines the X Coordinate.

property MeshWorkflowControl.YCoordinate: Ansys.Core.Units.Quantity | None#: It defines the Y Coordinate.

property MeshWorkflowControl.ZCoordinate: Ansys.Core.Units.Quantity | None#: It defines the Z Coordinate.

Method detail#

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

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

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

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

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

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

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

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

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

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

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

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

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

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