MeshWorkflowControl#

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

Bases: object

Object that wraps IDSEngineeringModelControl.

Overview#

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.

AppendData

Gets or sets 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

Gets or sets whether to define programmatically the external scoping method and pattern for the external enclosure. The default value is false.

BaseFaceLabel

Gets or sets the label to be used for the base face.

BaseFaceScopeDefinition

Gets or sets the type of scope definition for the base face scoping. Default: Value

BaseFaceScopeMethod

Gets or sets the scoping method for the base face scoping. Default: Label.

BaseFaceScopeOutcome

Gets or sets the scope outcome from a previous operation. Applicable only if BaseFaceScopeOutcome is set to Outcome.

BaseFaceScopePattern

Gets or sets the part, zone or label name pattern that defines the scope. Applicable only if BaseFaceScopeOutcome is set to Value.

CenterPlaneNormalOffset

It defines the desired offset of the plane of the hemisphere from the model.

CenterPosition

It is defined by “Centered”, “Minimal”, and “User Defined”.

Children

Gets the list of children.

ConformalMeshOnContactSurfaces

Gets or sets whether to decide creation of conformal mesh at contact surfaces.

ConstantHeight

Height of a single layer of mesh elements.

ControlDataDefinition

This property is used to define if the control data is defined by value or by settings.

ControlType

Returns the type of the control.

CoordinateSystem

Gets or sets the Coordinate System object used to define the material point location.

CreateFaceZone

Gets or sets whether to create a new face zone.

CreateQuadraticElements

Gets or sets whether to create quadratic elements. The default value is false.

DataModelObjectCategory

Gets the current DataModelObject's category.

DecompositionType

Gets or sets the decomposition type used by the MultiZone mesher. Defaults to “Program Controlled”.

DefaultOffsetSize

Gets or sets the size of the offset layers to be used during the stack base operation.

DefeatureTolerance

Gets or sets the defeature tolerance applied during meshing. Applicable only if DefeatureToleranceDefineBy is “UserDefined”.

DefeatureToleranceDefineBy

Gets or sets how the Defeature Tolerance is defined for the MultiZone mesher. Defaults to “Program Controlled”.

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

Gets or sets whether to delete of input scope after wrapping. The default value is false.

DihedralAngle

The dihedral angle is the angle between the normal vectors of two element faces.

DirectionX

Gets or sets the X component of the direction vector, with respect to the Global Coordinate System.

DirectionY

Gets or sets the Y component of the direction vector, with respect to the Global Coordinate System.

DirectionZ

Gets or sets the Z component of the direction vector, with respect to the Global Coordinate System.

EdgeLabelName

This property is used to rename the default edge label name generated during execution of step.

ElementSize

Define element size to achieve desired mesh results. User can achieve coarse, medium, or fine mesh by varying this value.

ElementsPerGap

Gets or sets the minimum number of element layers to be generated per gap for the Proximity Sizing control. The default values is 3.

EnableCheckpoint

Flag whether to enable a checkpoint or not. The default value is false.

ExcludeEnclosure

Gets or sets whether to exclude the enclosure from the wrapper scope . The default value is false.

ExcludeScopeDefinition

Gets or sets the type of scope definition for the Hole Patching exclusion scoping. Default: Value

ExcludeScopeMethod

Gets or sets the scoping method for the Hole Patching exclusion scoping. Default: Label.

ExcludeScopeOutcome

Gets or sets the scope outcome from a previous operation for the Hole Patching exclusion scoping. Applicable only if scope is defined by outcome.

ExcludeScopePattern

Gets or sets the part, zone or label name pattern for the Hole Patching exclusion scoping. Applicable only if scope is defined by value.

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.

FaceZoneByPart

Gets or sets whether to define an independent face zone for each input part.

FaceZoneName

This property is used to define the name of the default face zone name generated during execution of step.

FieldName

Gets or sets the label name to be applied.

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.

FreeFaceMeshType

Gets or sets the type of elements for the MultiZone mesher free face mesh. Defaults to “All Quads”.

FreeVolumeMeshType

Gets or sets how free mesh blocks should be treated by the MultiZone meshing algorithm. Defaults to “NotAllowed”.

GrowthRate

Gradient of element size as each layer grows.

HemisphereCenterModality

This property is used to define the rule for the computation of the center of the hemispherical enclosure.

HemisphereOrientationModality

This property is used to define the rule for the computation of the orientation of the hemispherical enclosure.

IgnoreOrientation

Gets or sets whether to ignore the face normal orientation while calculating the proximity for the Proximity Sizing control. The default value is False.

IgnoreSelfProximity

Gets or sets whether to ignore the proximity between two faces from the same face zone while calculating the proximity for the Proximity Sizing control. The default value is True.

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.

InputMeshScopeDefinition

Gets or sets the type of scope definition for the Input Mesh scoping. Default: Value.

InputMeshScopeMethod

Gets or sets the scoping method for the Input Mesh scoping. Default: Label.

InputMeshScopeOutcome

Gets or sets the scope outcome for Input Mesh scoping from a previous operation. Applicable only if InputMeshScopeDefinition is set to Outcome.

InputMeshScopePattern

Gets or sets the zone or label name pattern that defines the Input Mesh scoping. Applicable only if InputMeshScopeDefinition is set to Value.

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.

LateralDefeatureSize

Gets or sets the defeature size to be used along the lateral direction of stacking.

Material

Gets or sets the Material.

MaterialName

Gets or sets the Material Name.

MaterialPointDefinition

Gets or sets the material point definition type.

MaterialPointType

It defines the type of material point, it can be “Include” or “Exclude”.

MaxHoleSize

Gets or sets the maximum size of holes to be considered for Wrapper Leak Prevention and Hole Patching.

MaxSize

Gets or sets the maximum size to be used for the volumetric size field sizing computation in the Proximity Sizing and Curvature Sizing controls. This is a length value.

MergeNodesTolerance

Gets or sets the tolerance within which nodes are to be merged.

MergeNodesToleranceType

Gets or sets the merge nodes tolerance type to be used when executing Merge Nodes operation. The default value is Absolute.

MeshFlowControl

This property gives control over the flow of mesh during surface mesh generation. The supported modes are None, and Global Cartesian.

MeshedVolumeLabelSuffix

Gets or sets the suffix to be used when defining labels scoped to volumes meshed by the MultiZone mesher. Defaults to “MultiZoneMesh”.

MinSize

Gets or sets the minimum size to be used for the volumetric size field sizing computation in the Proximity Sizing and Curvature Sizing controls. This is a length value.

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.

MorphRecordingName

This property is used to define the name for matching the morphing recording to apply to the meshing operation.

NormalAngle

Gets or sets the maximum allowed normal angle between neighboring elements when computing curvature for the Curvature Sizing control. This value must be between 0 and 180 degrees (0 to π) and defaults to 18 degrees.

NumberOfAttempts

Number of attempts for mesh convergence.

NumberOfDivisions

Gets or sets the number of divisions for the scoped edges.

NumberOfLayers

Number of layers of mesh elements.

OffsetFileName

Gets or sets the full file path to the .csv file containing the offset coordinates for replication.

OriginX

Gets or sets the X coordinate of origin (location of base face) in the volume flattening step.

OriginY

Gets or sets the Y coordinate of origin (location of base face) in the volume flattening step.

OriginZ

Gets or sets the Z coordinate of origin (location of base face) in the volume flattening step.

PartName

Gets or sets the part name to be used when generating.

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.

ProjectSideFaces

Gets or sets whether to project the side faces after the extrusion.

Properties

Gets the list of properties for this object.

ProtectOnlyBoundaries

Gets or sets whether the topology protection flag is applied only to the exterior boundary of the scoped boundaries or not. Defaults to False.

QuadBoundaryLayerFaceScopeDefinition

Gets or sets the type of scope definition for the quad boundary layer face scoping. Default: Value

QuadBoundaryLayerFaceScopeMethod

Gets or sets the scoping method for the quad boundary layer face scoping. Default: Label.

QuadBoundaryLayerFaceScopeOutcome

Gets or sets the scope outcome from a previous operation. Applicable only if 'QuadBoundaryLayerFaceScopeDefinition' is set to Outcome.

QuadBoundaryLayerFaceScopePattern

Gets or sets the part, zone or label name pattern that defines the scope. Applicable only if 'QuadBoundaryLayerFaceScopeDefinition' is set to Value.

QuadBoundaryLayerFirstLayerHeight

Gets or sets the height of the first quad layer.

QuadBoundaryLayerGrowthRate

Gets or sets the ratio of heights between subsequent quad layers.

QuadBoundaryLayerNumberOfDivisions

Gets or sets the number of annular divisions on the washer boundary from where the quad layers are grown.

QuadBoundaryLayerNumberOfLayers

Gets or sets the number of quad layers on the washer boundary.

RecomputeClosedVolumes

Gets or sets whether to recompute closed volumes after the operation.

RegionType

It is defined by Material Point or External.

RelativeMergeTolerancePercentage

Gets or sets the percentage of the connected edge lengths to be used as tolerance for merging nodes.

Remesh

Gets or sets whether to allow the remesh of already meshed volumes. The default value is false.

RepairModel

Gets or sets whether to repair the PrimeMesh model after the reading operation is executed. The default value is false.

RestrictBoundaryNodes

Gets or sets whether to restrict the boundary nodes displacement. The default value is true.

RetainMeshedVolumes

Gets or sets whether existing mesh on the scoped volumes is to be retained or remeshed.

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.

SeedFaceScopeDefinition

Gets or sets the type of scope definition for the seed face scoping. Default: Value

SeedFaceScopeMethod

Gets or sets the scoping method for the seed face scoping. Default: Label.

SeedFaceScopeOutcome

Gets or sets the scope outcome from a previous operation. Applicable only if SeedFaceScopeDefinition is set to Outcome.

SeedFaceScopePattern

Gets or sets the part, zone or label name pattern that defines the scope. Applicable only if SeedFaceScopeDefinition is set to Value.

SharedTopologyLabelName

Gets or sets the name used as label to scope the shared topology faces which are automatically added as input mesh for MultiZone. Defaults to “MultiZoneMesh/SharedTopologyInputMesh”.

SizeFieldDefinition

Gets or sets how the control's size field pattern should be defined, either by “Value” or by “Outcome”. The default value is “Value”.

SizeFieldOutcome

Gets or sets the outcome to be used to define the size field pattern when SizeFieldDefinition is set to “Outcome”.

SizeFieldPattern

This property is used to define the name pattern for matching the size fields to apply to the meshing operation.

SmoothingIterations

Allows user to input number of iterations needed to achieve good mesh results.

SmoothingPreserveVolume

Gets or sets whether 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.

SourceTargetScopeDefinition

Gets or sets the type of scope definition for the Source/Target scoping. Default: Value.

SourceTargetScopeMethod

Gets or sets the scoping method for the Source/Target scoping. Default: Label.

SourceTargetScopeOutcome

Gets or sets the scope outcome for the Source/Target scoping from a previous operation. Applicable only if SourceTargetScopeDefinition is set to Outcome.

SourceTargetScopePattern

Gets or sets the zone or label name pattern that defines the Source/Target scoping. Applicable only if SourceTargetScopeDefinition is set to Value.

SphereCenterModality

This property is used to define the rule for the computation of the center of the spherical enclosure.

StackingDefeatureSize

Defines defeature size to be used along the stacking direction.

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.

SweepingSize

Gets or sets the constant size along the sweeping direction.

TargetSkewness

Set Limit to the skewness of an element. Higher the skewness value, expecting a better mesh result.

Thickness

Gets or sets the Thickness to be assigned to the scoped zone.

TopologyConformalConnection

Gets or sets whether to preserve the topology connection for the newly created faces. The default value is false.

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.

WrapByParts

Gets or sets whether to wrap each part separately. The default value is false.

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#

Gets or sets 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#

Gets or sets whether to define programmatically the external scoping method and pattern for the external enclosure. The default value is false.

property MeshWorkflowControl.BaseFaceLabel: str | None#

Gets or sets the label to be used for the base face.

property MeshWorkflowControl.BaseFaceScopeDefinition: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeDefinedByType | None#

Gets or sets the type of scope definition for the base face scoping. Default: Value

property MeshWorkflowControl.BaseFaceScopeMethod: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeType | None#

Gets or sets the scoping method for the base face scoping. Default: Label.

property MeshWorkflowControl.BaseFaceScopeOutcome: int | None#

Gets or sets the scope outcome from a previous operation. Applicable only if BaseFaceScopeOutcome is set to Outcome.

property MeshWorkflowControl.BaseFaceScopePattern: str | None#

Gets or sets the part, zone or label name pattern that defines the scope. Applicable only if BaseFaceScopeOutcome is set to Value.

property MeshWorkflowControl.CenterPlaneNormalOffset: Ansys.Core.Units.Quantity | None#

It defines the desired offset of the plane of the hemisphere from the model.

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.ConformalMeshOnContactSurfaces: bool | None#

Gets or sets whether to decide creation of conformal mesh at contact surfaces.

property MeshWorkflowControl.ConstantHeight: Ansys.Core.Units.Quantity | None#

Height of a single layer of mesh elements.

property MeshWorkflowControl.ControlDataDefinition: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ControlDataDefinedByType | None#

This property is used to define if the control data is defined by value or by settings.

property MeshWorkflowControl.ControlType: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ControlType | None#

Returns the type of the control.

property MeshWorkflowControl.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

Gets or sets the Coordinate System object used to define the material point location.

property MeshWorkflowControl.CreateFaceZone: bool | None#

Gets or sets whether to create a new face zone.

property MeshWorkflowControl.CreateQuadraticElements: bool | None#

Gets or sets whether to create quadratic elements. The default value is false.

property MeshWorkflowControl.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#

Gets the current DataModelObject's category.

property MeshWorkflowControl.DecompositionType: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.DecompositionType | None#

Gets or sets the decomposition type used by the MultiZone mesher. Defaults to “Program Controlled”.

property MeshWorkflowControl.DefaultOffsetSize: Ansys.Core.Units.Quantity | None#

Gets or sets the size of the offset layers to be used during the stack base operation.

property MeshWorkflowControl.DefeatureTolerance: Ansys.Core.Units.Quantity | None#

Gets or sets the defeature tolerance applied during meshing. Applicable only if DefeatureToleranceDefineBy is “UserDefined”.

property MeshWorkflowControl.DefeatureToleranceDefineBy: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.DefeatureToleranceDefineBy | None#

Gets or sets how the Defeature Tolerance is defined for the MultiZone mesher. Defaults to “Program Controlled”.

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#

Gets or sets whether to delete of input scope after wrapping. 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.DirectionX: float | None#

Gets or sets the X component of the direction vector, with respect to the Global Coordinate System.

property MeshWorkflowControl.DirectionY: float | None#

Gets or sets the Y component of the direction vector, with respect to the Global Coordinate System.

property MeshWorkflowControl.DirectionZ: float | None#

Gets or sets the Z component of the direction vector, with respect to the Global Coordinate System.

property MeshWorkflowControl.EdgeLabelName: str | None#

This property is used to rename the default edge label name generated during execution of step.

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.ElementsPerGap: int | None#

Gets or sets the minimum number of element layers to be generated per gap for the Proximity Sizing control. The default values is 3.

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#

Gets or sets whether to exclude the enclosure from the wrapper scope . The default value is false.

property MeshWorkflowControl.ExcludeScopeDefinition: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeDefinedByType | None#

Gets or sets the type of scope definition for the Hole Patching exclusion scoping. Default: Value

property MeshWorkflowControl.ExcludeScopeMethod: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeType | None#

Gets or sets the scoping method for the Hole Patching exclusion scoping. Default: Label.

property MeshWorkflowControl.ExcludeScopeOutcome: Ansys.ACT.Automation.Mechanical.MeshWorkflowOutcome | None#

Gets or sets the scope outcome from a previous operation for the Hole Patching exclusion scoping. Applicable only if scope is defined by outcome.

property MeshWorkflowControl.ExcludeScopePattern: str | None#

Gets or sets the part, zone or label name pattern for the Hole Patching exclusion scoping. Applicable only if scope is defined by value.

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.FaceZoneByPart: bool | None#

Gets or sets whether to define an independent face zone for each input part.

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.FieldName: str | None#

Gets or sets the label name to be applied.

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.FreeFaceMeshType: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.FreeFaceMeshType | None#

Gets or sets the type of elements for the MultiZone mesher free face mesh. Defaults to “All Quads”.

property MeshWorkflowControl.FreeVolumeMeshType: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.FreeVolumeMeshType | None#

Gets or sets how free mesh blocks should be treated by the MultiZone meshing algorithm. Defaults to “NotAllowed”.

property MeshWorkflowControl.GrowthRate: float | None#

Gradient of element size as each layer grows.

property MeshWorkflowControl.HemisphereCenterModality: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.HemisphereCenterDefinitionType | None#

This property is used to define the rule for the computation of the center of the hemispherical enclosure.

property MeshWorkflowControl.HemisphereOrientationModality: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.HemisphereOrientationDefinitionType | None#

This property is used to define the rule for the computation of the orientation of the hemispherical enclosure.

property MeshWorkflowControl.IgnoreOrientation: bool | None#

Gets or sets whether to ignore the face normal orientation while calculating the proximity for the Proximity Sizing control. The default value is False.

property MeshWorkflowControl.IgnoreSelfProximity: bool | None#

Gets or sets whether to ignore the proximity between two faces from the same face zone while calculating the proximity for the Proximity Sizing control. The default value is True.

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.InputMeshScopeDefinition: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeDefinedByType | None#

Gets or sets the type of scope definition for the Input Mesh scoping. Default: Value.

property MeshWorkflowControl.InputMeshScopeMethod: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeType | None#

Gets or sets the scoping method for the Input Mesh scoping. Default: Label.

property MeshWorkflowControl.InputMeshScopeOutcome: Ansys.ACT.Automation.Mechanical.MeshWorkflowOutcome | None#

Gets or sets the scope outcome for Input Mesh scoping from a previous operation. Applicable only if InputMeshScopeDefinition is set to Outcome.

property MeshWorkflowControl.InputMeshScopePattern: str | None#

Gets or sets the zone or label name pattern that defines the Input Mesh scoping. Applicable only if InputMeshScopeDefinition is set to Value.

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.LateralDefeatureSize: Ansys.Core.Units.Quantity | None#

Gets or sets the defeature size to be used along the lateral direction of stacking.

property MeshWorkflowControl.Material: str | None#

Gets or sets the Material.

property MeshWorkflowControl.MaterialName: str | None#

Gets or sets the Material Name.

property MeshWorkflowControl.MaterialPointDefinition: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.MaterialPointDefineByType | None#

Gets or sets the material point definition type.

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.MaxHoleSize: Ansys.Core.Units.Quantity | None#

Gets or sets the maximum size of holes to be considered for Wrapper Leak Prevention and Hole Patching.

property MeshWorkflowControl.MaxSize: Ansys.Core.Units.Quantity | None#

Gets or sets the maximum size to be used for the volumetric size field sizing computation in the Proximity Sizing and Curvature Sizing controls. This is a length value.

property MeshWorkflowControl.MergeNodesTolerance: Ansys.Core.Units.Quantity | None#

Gets or sets the tolerance within which nodes are to be merged.

property MeshWorkflowControl.MergeNodesToleranceType: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.MergeNodesToleranceType | None#

Gets or sets the merge nodes tolerance type to be used when executing Merge Nodes operation. The default value is Absolute.

property MeshWorkflowControl.MeshFlowControl: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.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.MeshedVolumeLabelSuffix: str | None#

Gets or sets the suffix to be used when defining labels scoped to volumes meshed by the MultiZone mesher. Defaults to “MultiZoneMesh”.

property MeshWorkflowControl.MinSize: Ansys.Core.Units.Quantity | None#

Gets or sets the minimum size to be used for the volumetric size field sizing computation in the Proximity Sizing and Curvature Sizing controls. This is a length value.

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.MorphRecordingName: str | None#

This property is used to define the name for matching the morphing recording to apply to the meshing operation.

property MeshWorkflowControl.NormalAngle: Ansys.Core.Units.Quantity | None#

Gets or sets the maximum allowed normal angle between neighboring elements when computing curvature for the Curvature Sizing control. This value must be between 0 and 180 degrees (0 to π) and defaults to 18 degrees.

property MeshWorkflowControl.NumberOfAttempts: int | None#

Number of attempts for mesh convergence.

property MeshWorkflowControl.NumberOfDivisions: int | None#

Gets or sets the number of divisions for the scoped edges.

property MeshWorkflowControl.NumberOfLayers: int | None#

Number of layers of mesh elements.

property MeshWorkflowControl.OffsetFileName: str | None#

Gets or sets the full file path to the .csv file containing the offset coordinates for replication.

property MeshWorkflowControl.OriginX: Ansys.Core.Units.Quantity | None#

Gets or sets the X coordinate of origin (location of base face) in the volume flattening step.

property MeshWorkflowControl.OriginY: Ansys.Core.Units.Quantity | None#

Gets or sets the Y coordinate of origin (location of base face) in the volume flattening step.

property MeshWorkflowControl.OriginZ: Ansys.Core.Units.Quantity | None#

Gets or sets the Z coordinate of origin (location of base face) in the volume flattening step.

property MeshWorkflowControl.PartName: str | None#

Gets or sets the part name to be used when generating.

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.ProjectSideFaces: bool | None#

Gets or sets whether to project the side faces after the extrusion.

property MeshWorkflowControl.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#

Gets the list of properties for this object.

property MeshWorkflowControl.ProtectOnlyBoundaries: bool | None#

Gets or sets whether the topology protection flag is applied only to the exterior boundary of the scoped boundaries or not. Defaults to False.

property MeshWorkflowControl.QuadBoundaryLayerFaceScopeDefinition: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeDefinedByType | None#

Gets or sets the type of scope definition for the quad boundary layer face scoping. Default: Value

property MeshWorkflowControl.QuadBoundaryLayerFaceScopeMethod: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeType | None#

Gets or sets the scoping method for the quad boundary layer face scoping. Default: Label.

property MeshWorkflowControl.QuadBoundaryLayerFaceScopeOutcome: Ansys.ACT.Automation.Mechanical.MeshWorkflowOutcome | None#

Gets or sets the scope outcome from a previous operation. Applicable only if 'QuadBoundaryLayerFaceScopeDefinition' is set to Outcome.

property MeshWorkflowControl.QuadBoundaryLayerFaceScopePattern: str | None#

Gets or sets the part, zone or label name pattern that defines the scope. Applicable only if 'QuadBoundaryLayerFaceScopeDefinition' is set to Value.

property MeshWorkflowControl.QuadBoundaryLayerFirstLayerHeight: Ansys.Core.Units.Quantity | None#

Gets or sets the height of the first quad layer.

property MeshWorkflowControl.QuadBoundaryLayerGrowthRate: float | None#

Gets or sets the ratio of heights between subsequent quad layers.

property MeshWorkflowControl.QuadBoundaryLayerNumberOfDivisions: int | None#

Gets or sets the number of annular divisions on the washer boundary from where the quad layers are grown.

property MeshWorkflowControl.QuadBoundaryLayerNumberOfLayers: int | None#

Gets or sets the number of quad layers on the washer boundary.

property MeshWorkflowControl.RecomputeClosedVolumes: bool | None#

Gets or sets whether to recompute closed volumes after the operation.

property MeshWorkflowControl.RegionType: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.WrapperRegionType | None#

It is defined by Material Point or External.

property MeshWorkflowControl.RelativeMergeTolerancePercentage: float | None#

Gets or sets the percentage of the connected edge lengths to be used as tolerance for merging nodes.

property MeshWorkflowControl.Remesh: bool | None#

Gets or sets whether to allow the remesh of already meshed volumes. The default value is false.

property MeshWorkflowControl.RepairModel: bool | None#

Gets or sets whether to repair the PrimeMesh model after the reading operation is executed. The default value is false.

property MeshWorkflowControl.RestrictBoundaryNodes: bool | None#

Gets or sets whether to restrict the boundary nodes displacement. The default value is true.

property MeshWorkflowControl.RetainMeshedVolumes: bool | None#

Gets or sets whether existing mesh on the scoped volumes is to be retained or remeshed.

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.SeedFaceScopeDefinition: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeDefinedByType | None#

Gets or sets the type of scope definition for the seed face scoping. Default: Value

property MeshWorkflowControl.SeedFaceScopeMethod: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeType | None#

Gets or sets the scoping method for the seed face scoping. Default: Label.

property MeshWorkflowControl.SeedFaceScopeOutcome: int | None#

Gets or sets the scope outcome from a previous operation. Applicable only if SeedFaceScopeDefinition is set to Outcome.

property MeshWorkflowControl.SeedFaceScopePattern: str | None#

Gets or sets the part, zone or label name pattern that defines the scope. Applicable only if SeedFaceScopeDefinition is set to Value.

property MeshWorkflowControl.SharedTopologyLabelName: str | None#

Gets or sets the name used as label to scope the shared topology faces which are automatically added as input mesh for MultiZone. Defaults to “MultiZoneMesh/SharedTopologyInputMesh”.

property MeshWorkflowControl.SizeFieldDefinition: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeDefinedByType | None#

Gets or sets how the control's size field pattern should be defined, either by “Value” or by “Outcome”. The default value is “Value”.

property MeshWorkflowControl.SizeFieldOutcome: Ansys.ACT.Automation.Mechanical.MeshWorkflowOutcome | None#

Gets or sets the outcome to be used to define the size field pattern when SizeFieldDefinition is set to “Outcome”.

property MeshWorkflowControl.SizeFieldPattern: str | None#

This property is used to define the name pattern for matching the size fields to apply to the meshing operation.

property MeshWorkflowControl.SmoothingIterations: int | None#

Allows user to input number of iterations needed to achieve good mesh results.

property MeshWorkflowControl.SmoothingPreserveVolume: bool | None#

Gets or sets whether 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.SourceTargetScopeDefinition: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeDefinedByType | None#

Gets or sets the type of scope definition for the Source/Target scoping. Default: Value.

property MeshWorkflowControl.SourceTargetScopeMethod: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeType | None#

Gets or sets the scoping method for the Source/Target scoping. Default: Label.

property MeshWorkflowControl.SourceTargetScopeOutcome: Ansys.ACT.Automation.Mechanical.MeshWorkflowOutcome | None#

Gets or sets the scope outcome for the Source/Target scoping from a previous operation. Applicable only if SourceTargetScopeDefinition is set to Outcome.

property MeshWorkflowControl.SourceTargetScopePattern: str | None#

Gets or sets the zone or label name pattern that defines the Source/Target scoping. Applicable only if SourceTargetScopeDefinition is set to Value.

property MeshWorkflowControl.SphereCenterModality: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.SphereCenterDefinitionType | None#

This property is used to define the rule for the computation of the center of the spherical enclosure.

property MeshWorkflowControl.StackingDefeatureSize: Ansys.Core.Units.Quantity | None#

Defines defeature size to be used along the stacking direction.

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.SweepingSize: Ansys.Core.Units.Quantity | None#

Gets or sets the constant size along the sweeping direction.

property MeshWorkflowControl.TargetSkewness: float | None#

Set Limit to the skewness of an element. Higher the skewness value, expecting a better mesh result.

property MeshWorkflowControl.Thickness: float | None#

Gets or sets the Thickness to be assigned to the scoped zone.

property MeshWorkflowControl.TopologyConformalConnection: bool | None#

Gets or sets whether to preserve the topology connection for the newly created faces. The default value is false.

property MeshWorkflowControl.TriangleCountReductionMode: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.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.WrapByParts: bool | None#

Gets or sets whether to wrap each part separately. The default value is false.

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.