MeshWorkflowStepGroup#

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

Bases: object

Object that wraps IDSEngineeringModelWorkflow.

Overview#

GetMeshWorkflowsControlPropertyList

GetMeshWorkflowsControlPropertyList method.

GetMeshWorkflowsOperationPropertyList

GetMeshWorkflowsOperationPropertyList method.

GetMeshWorkflowsOutcomePropertyList

GetMeshWorkflowsOutcomePropertyList method.

GetMeshWorkflowsPropertyList

GetMeshWorkflowsPropertyList method.

Activate

Activate the current object.

AddFigure

Creates a new child Figure.

AddImage

Creates a new child Image.

AddSettings

Add the settings of the input SettingsType to the Steps node.

AddStep

Add another operation to the sequence of steps to be executed for the mesh workflow.

CanCheckPublicStateCallbackForIM

CanCheckPublicStateCallbackForIM method.

CanConvertSizingSettings

Returns whether the active sizing settings can be converted to the input SettingsType.

CanInsertOperationByType

Returns whether an operation of the given type can be inserted at the requested position. The ignoreExecutedChecks parameter determines whether to ignore any checks for already executed operations.

CanRunNextStep

CanRunNextStep method.

CanShowPublishStateIM

CanShowPublishStateIM method.

ClearDataAndDisableCheckpoints

Clear all checkpoints data and disable checkpointing for the workflow.

ConvertSizingSettings

Convert the active sizing settings to the input SettingsType for the Steps node.

ConvertWorkflow

Converts the workflow type to Custom

CopyAttachmentPathToClipboard

Copies the current attachment path to clipboard.

CopyTo

Copies all visible properties from this object to another.

CreateObjRef

CreateObjRef method.

CreateParameter

Creates a new parameter for a Property.

Delete

Run the Delete action.

DeleteAllStepsAndClearGeneratedData

Deletes all steps and reset workflow type to undefined and also 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.

DeleteSettings

Delete the settings of the input SettingsType from the Steps node. All the Settings specific entries are removed automatically to the Steps details.

DisableAllCheckpoints

Disables checkpoints for all editable steps in the workflow.

Duplicate

Creates a copy of the current DataModelObject.

EnableAllCheckpoints

Enables checkpoints for all editable steps in the workflow.

Equals

Equals method.

ExecuteAllSteps

Executes all steps defined under the “StepGroup” object (which is the “Steps” node in the UI).

ExecuteNextStep

Executes the next step, i.e. the next operation which is ready to be executed under the parent “StepGroup” object.

ExecuteUpToStep

Executes any not yet ready steps up to and including the specified step.

ForceRevertStepAndExecuteToPrevious

Revert to the last available checkpoint; if no checkpoint is available, clear generated data, enable the checkpoint for current step and execute up to the previous operation.

GetAPIName

Property name bound to dispId.

GetAllProperties

GetAllProperties method.

GetApplicableOperationTypes

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

GetNextExecutableControlIdByType

GetNextExecutableControlIdByType method.

GetNextExecutableOrUndefinedControlIdByType

GetNextExecutableOrUndefinedControlIdByType method.

GetObjectData

GetObjectData method.

GetParameter

Gets the parameter corresponding to the given property.

GetPath

GetPath method.

GetPropertyName

GetPropertyName method.

GetPropertyValue

GetPropertyValue method.

GetPropertyWorksheetInfo

GetPropertyWorksheetInfo method.

GetType

GetType method.

GetUnpublishedList

GetUnpublishedList method.

GetVisibleProperties

GetVisibleProperties method.

GetVisiblePropertyNames

GetVisiblePropertyNames method.

GroupAllSimilarChildren

Run the GroupAllSimilarChildren action.

GroupSimilarObjects

Run the GroupSimilarObjects action.

GroupSteps

GroupSteps method.

HasUnderdefinedSettingsData

HasUnderdefinedSettingsData method.

InitializeLifetimeService

InitializeLifetimeService method.

IsPropertyEditable

IsPropertyEditable method.

IsPropertyVisible

IsPropertyVisible method.

IsSizingSettings

IsSizingSettings method.

MeshWorkflowSteps

Gets the ordered list of Steps for 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.

PropagateSettings

Propagate the settings of the input SettingsType to the attributes of the Step nodes. The meshing attributes of the Step nodes will then be automatically defined based on the physical parameters of the settings. Otherwise, the meshing attributes need to be manually specified.

PropertyByAPIName

Get a property by its API name.

PropertyById

PropertyById method.

PropertyByName

Get a property by its unique name.

PropertyTypeInfo

PropertyTypeInfo method.

PublishIMProp

PublishIMProp method.

RemoveParameter

Removes the parameter from the parameter set corresponding to the given property.

RenameBasedOnType

Renames applying the default name based on type.

RevertToLastCheckpoint

Revert to the last available checkpoint; if no checkpoint is available, then an exception will be raised.

RevertToStep

Revert to the specified step; if no checkpoint is available, then an exception will be raised.

SetPropertyValue

SetPropertyValue method.

SetPublish

SetPublish method.

SetUnpublish

SetUnpublish method.

SettingsReleaseStatusString

SettingsReleaseStatusString method.

SettingsTypeInformation

SettingsTypeInformation method.

SettingsTypeInformationJson

SettingsTypeInformationJson method.

StartCodeGeneration

Start the code generation for the Meshing operations.

StopCodeGeneration

Stop the code generation for the Meshing operations.

ToString

ToString method.

AcousticCurvatureAngle

Gets or sets the curvature angle of the mesh to be used in workflow steps for the acoustic workflow. If set to 0, the default curvature angle is used.

AcousticDefeatureMeshSize

Gets or sets the defeature element size of the mesh to be used in workflow steps for the acoustic workflow. If set to 0, the value is automatically defined based on the model size.

AcousticGrowthRate

Gets or sets the growth rate of the mesh to be used in workflow steps for the acoustic workflow. If set to 0, the default growth rate is used.

AcousticMinimumMeshSize

Gets or sets the minimum element size of the mesh to be used in workflow steps for the acoustic workflow. If set to 0, the value is automatically defined based on the model size.

ActiveSizingSettings

Gets the active sizing settings type.

AnalysisFrequency

Defines the analysis frequency of the acoustic scenario.

ApplicableSettingsTypes

ApplicableSettingsTypes property.

AttachedRefs

AttachedRefs property.

Attachment

BoundingBoxFactor

Gets or sets the bounding box factor applied to compute automatically the StackerMeshSize from the model. If set to 0, the default bouding box factor is used.

Children

Gets the list of children.

ClsId

ClsId property.

CurvatureAngle

Gets or sets the curvature angle of the mesh to be used in workflow steps. If set to 0, the default curvature angle is used.

CustomGlobalCurvatureAngle

Gets or sets the custom angle to be used for the GlobalCurvatureAngle. If this value is 0, the default GlobalCurvatureAngle is used. Defaults to 0. This property should only accessed for internal usage.

CustomGlobalGrowthRate

Gets or sets the custom growth rate to be used for the GlobalGrowthRate. If this value is 0, the default GlobalGrowthRate is used. Defaults to 0. This property should only accessed for internal usage.

CustomGlobalMeshSize

Gets or sets the custom size to be used for the GlobalMeshSize. If this value is 0, the default GlobalMeshSize is used. Defaults to 0. This property should only accessed for internal usage.

CustomGlobalMinimalMeshSize

Gets or sets the custom size to be used for the GlobalMinimalMeshSize. If this value is 0, the default GlobalMinimalMeshSize is used. Defaults to 0. This property should only accessed for internal usage.

CustomNumberOfAcousticLayers

Gets or sets the custom number of layers in the acoustic region. If this value is 0, the default NumberOfAcousticLayers is used. Defaults to 0. This property should only accessed for internal usage.

CustomNumberOfPMLs

Gets or sets the custom number of layers in the perfectly meshed layers region. If this value is 0, the default NumberOfAcousticLayers is used. Defaults to 0. This property should only accessed for internal usage.

DataModelObjectCategory

Gets the current DataModelObject's category.

Direction

Gets or sets the Stacker Direction coordinates.

DirectionX

Gets or sets the X component of stacking direction used by stacker operations , with respect to Global Coordinate System.

DirectionY

Gets or sets the Y component of stacking direction to be used in stacker steps, with respect to Global Coordinate System.

DirectionZ

Gets or sets the Z component of stacking direction to be used in stacker steps, with respect to Global Coordinate System.

Figures

Gets the list of associated figures.

GlobalBoundingBoxFactor

Gets or sets the bounding box factor applied to compute automatically the GlobalMeshSize from the model. If set to 0, the default bouding box factor is used.

GlobalCurvatureAngle

Gets or sets the curvature angle of the mesh to be used in workflow steps. If set to 0, the default curvature angle is used.

GlobalDefeatureMeshSize

Gets or sets the defeature element size of the mesh to be used in workflow steps. If set to 0, the value is automatically defined based on the model size.

GlobalGrowthRate

Gets or sets the growth rate of the mesh to be used in workflow steps. If set to 0, the default growth rate is used.

GlobalMeshSize

Gets or sets the element size of the mesh to be used in workflow steps. If set to 0, the value is automatically defined based on the model size.

GlobalMinimalMeshSize

Gets or sets the minimal element size of the mesh to be used in workflow steps. If set to 0, the value is automatically defined based on the model size.

GroupingFolder

GroupingFolder property.

GrowthRate

Gets or sets the growth rate of the mesh to be used in workflow steps. If set to 0, the default growth rate is used.

IconName

IconName property.

Images

Gets the list of associated images.

InternalObject

Gets the internal object. For advanced usage only.

LateralDefeatureSize

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

MaximumMeshSize

Gets or sets the element size of the mesh to be used in workflow steps. If set to 0, the value is automatically defined based on the model size.

MeshSize

Defines the mesh size of the acoustic scenario based on the wave velocity and the frequency.

MinimumMeshSize

Gets or sets the minimal element size of the mesh to be used in workflow steps. If set to 0, the value is automatically defined based on the model size.

Name

Name property.

NonStackableBodyMeshSize

Gets or sets the element size to be used in meshing non-stackable bodies in stacker workflow.

NumberOfAcousticLayers

Gets or sets the number of layers in the acoustic region. If set to 0, the value defaults to 1 if QuadraticElements is enabled (see ) or 2 otherwise.

NumberOfCores

Defines how many CPU cores to be used in an operation (if supported by the operation).

NumberOfPMLs

Gets or sets the number of layers in the perfectly meshed layers region. If set to 0, the value defaults to 2 if QuadraticElements is enabled (see ) or 4 otherwise.

ObjectId

ObjectId property.

ObjectState

ObjectState property.

ObjectTags

ObjectTags property.

Origin

Gets or sets the Stacker origin coordinates.

OriginX

Gets or sets the X coordinate location of base face for the volume flattening step.

OriginY

Gets or sets the Y coordinate location of base face for the volume flattening step.

OriginZ

Gets or sets the Z coordinate location of base face for the volume flattening step.

Parent

Parent property.

Properties

Gets the list of properties for this object.

QuadraticElements

Defines if the quadratic elements are used for the mesh generation.

QueryMappingInfo

QueryMappingInfo property.

QueryMappingInfoJson

QueryMappingInfoJson property.

SlicerLayerHeight

Gets or sets the spacing between newly created parallel planes used in workflow steps for the slicer workflow.

SlicerLayerStart

Gets or sets the z coordinate of the first plane used in workflow steps for the slicer workflow.

SolidAspectRatioHeightLimit

Defines the aspect ratio height limit to be used when determining if the mesh meets quality criteria. If exceeded, an element set will be created and an error will be returned.

SolidQuality

Defines if the solid mesh quality will be validated.

SolidSkewnessLimit

Defines the skewness limit to be used when determining if the mesh meets quality criteria. If exceeded, an element set will be created and an error will be returned.

SpeedOfSound

Defines the speed of sound in the acoustic scenario.

StackingDefeatureSize

Gets or sets the defeature size to be used along the stacking direction in stacker operations.

State

State property.

Suppressed

Gets or sets the Suppressed.

SurfaceAspectRatioHeightLimit

Defines the aspect ratio height limit to be used when determining if the mesh meets quality criteria. If exceeded, an element set will be created and an error will be returned.

SurfaceQuality

Defines if the surface mesh quality will be validated.

SurfaceSkewnessLimit

Defines the skewness limit to be used when determining if the mesh meets quality criteria. If exceeded, an element set will be created and an error will be returned.

VisibleProperties

Gets the list of properties that are visible for this object.

WorkflowDescription

WorkflowDescription property.

WorkflowDescriptionJson

WorkflowDescriptionJson property.

WorkflowFailureInformation

WorkflowFailureInformation property.

WorkflowFailureInformationJson

WorkflowFailureInformationJson property.

WorkflowReleaseStatusString

WorkflowReleaseStatusString property.

WorkflowString

Gets the WorkflowString.

WorkflowType

Returns the type of the operation. .

WorkflowTypeInformation

WorkflowTypeInformation property.

WorkflowTypeInformationJson

WorkflowTypeInformationJson property.

Property detail#

property MeshWorkflowStepGroup.AcousticCurvatureAngle: Ansys.Core.Units.Quantity | None#

Gets or sets the curvature angle of the mesh to be used in workflow steps for the acoustic workflow. If set to 0, the default curvature angle is used.

property MeshWorkflowStepGroup.AcousticDefeatureMeshSize: Ansys.Core.Units.Quantity | None#

Gets or sets the defeature element size of the mesh to be used in workflow steps for the acoustic workflow. If set to 0, the value is automatically defined based on the model size.

property MeshWorkflowStepGroup.AcousticGrowthRate: float | None#

Gets or sets the growth rate of the mesh to be used in workflow steps for the acoustic workflow. If set to 0, the default growth rate is used.

property MeshWorkflowStepGroup.AcousticMinimumMeshSize: Ansys.Core.Units.Quantity | None#

Gets or sets the minimum element size of the mesh to be used in workflow steps for the acoustic workflow. If set to 0, the value is automatically defined based on the model size.

property MeshWorkflowStepGroup.ActiveSizingSettings: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.SettingsType | None#

Gets the active sizing settings type.

property MeshWorkflowStepGroup.AnalysisFrequency: Ansys.Core.Units.Quantity | None#

Defines the analysis frequency of the acoustic scenario.

property MeshWorkflowStepGroup.ApplicableSettingsTypes: List[Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.SettingsType] | None#

ApplicableSettingsTypes property.

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

AttachedRefs property.

property MeshWorkflowStepGroup.Attachment: str | None#
property MeshWorkflowStepGroup.BoundingBoxFactor: float | None#

Gets or sets the bounding box factor applied to compute automatically the StackerMeshSize from the model. If set to 0, the default bouding box factor is used.

property MeshWorkflowStepGroup.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#

Gets the list of children.

property MeshWorkflowStepGroup.ClsId: int | None#

ClsId property.

property MeshWorkflowStepGroup.CurvatureAngle: Ansys.Core.Units.Quantity | None#

Gets or sets the curvature angle of the mesh to be used in workflow steps. If set to 0, the default curvature angle is used.

property MeshWorkflowStepGroup.CustomGlobalCurvatureAngle: Ansys.Core.Units.Quantity | None#

Gets or sets the custom angle to be used for the GlobalCurvatureAngle. If this value is 0, the default GlobalCurvatureAngle is used. Defaults to 0. This property should only accessed for internal usage.

property MeshWorkflowStepGroup.CustomGlobalGrowthRate: float | None#

Gets or sets the custom growth rate to be used for the GlobalGrowthRate. If this value is 0, the default GlobalGrowthRate is used. Defaults to 0. This property should only accessed for internal usage.

property MeshWorkflowStepGroup.CustomGlobalMeshSize: Ansys.Core.Units.Quantity | None#

Gets or sets the custom size to be used for the GlobalMeshSize. If this value is 0, the default GlobalMeshSize is used. Defaults to 0. This property should only accessed for internal usage.

property MeshWorkflowStepGroup.CustomGlobalMinimalMeshSize: Ansys.Core.Units.Quantity | None#

Gets or sets the custom size to be used for the GlobalMinimalMeshSize. If this value is 0, the default GlobalMinimalMeshSize is used. Defaults to 0. This property should only accessed for internal usage.

property MeshWorkflowStepGroup.CustomNumberOfAcousticLayers: int | None#

Gets or sets the custom number of layers in the acoustic region. If this value is 0, the default NumberOfAcousticLayers is used. Defaults to 0. This property should only accessed for internal usage.

property MeshWorkflowStepGroup.CustomNumberOfPMLs: int | None#

Gets or sets the custom number of layers in the perfectly meshed layers region. If this value is 0, the default NumberOfAcousticLayers is used. Defaults to 0. This property should only accessed for internal usage.

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

Gets the current DataModelObject's category.

property MeshWorkflowStepGroup.Direction: Iterable[float] | None#

Gets or sets the Stacker Direction coordinates.

property MeshWorkflowStepGroup.DirectionX: float | None#

Gets or sets the X component of stacking direction used by stacker operations , with respect to Global Coordinate System.

property MeshWorkflowStepGroup.DirectionY: float | None#

Gets or sets the Y component of stacking direction to be used in stacker steps, with respect to Global Coordinate System.

property MeshWorkflowStepGroup.DirectionZ: float | None#

Gets or sets the Z component of stacking direction to be used in stacker steps, with respect to Global Coordinate System.

property MeshWorkflowStepGroup.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#

Gets the list of associated figures.

property MeshWorkflowStepGroup.GlobalBoundingBoxFactor: float | None#

Gets or sets the bounding box factor applied to compute automatically the GlobalMeshSize from the model. If set to 0, the default bouding box factor is used.

property MeshWorkflowStepGroup.GlobalCurvatureAngle: Ansys.Core.Units.Quantity | None#

Gets or sets the curvature angle of the mesh to be used in workflow steps. If set to 0, the default curvature angle is used.

property MeshWorkflowStepGroup.GlobalDefeatureMeshSize: Ansys.Core.Units.Quantity | None#

Gets or sets the defeature element size of the mesh to be used in workflow steps. If set to 0, the value is automatically defined based on the model size.

property MeshWorkflowStepGroup.GlobalGrowthRate: float | None#

Gets or sets the growth rate of the mesh to be used in workflow steps. If set to 0, the default growth rate is used.

property MeshWorkflowStepGroup.GlobalMeshSize: Ansys.Core.Units.Quantity | None#

Gets or sets the element size of the mesh to be used in workflow steps. If set to 0, the value is automatically defined based on the model size.

property MeshWorkflowStepGroup.GlobalMinimalMeshSize: Ansys.Core.Units.Quantity | None#

Gets or sets the minimal element size of the mesh to be used in workflow steps. If set to 0, the value is automatically defined based on the model size.

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

GroupingFolder property.

property MeshWorkflowStepGroup.GrowthRate: float | None#

Gets or sets the growth rate of the mesh to be used in workflow steps. If set to 0, the default growth rate is used.

property MeshWorkflowStepGroup.IconName: str | None#

IconName property.

property MeshWorkflowStepGroup.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None#

Gets the list of associated images.

property MeshWorkflowStepGroup.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelWorkflowAuto | None#

Gets the internal object. For advanced usage only.

property MeshWorkflowStepGroup.LateralDefeatureSize: Ansys.Core.Units.Quantity | None#

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

property MeshWorkflowStepGroup.MaximumMeshSize: Ansys.Core.Units.Quantity | None#

Gets or sets the element size of the mesh to be used in workflow steps. If set to 0, the value is automatically defined based on the model size.

property MeshWorkflowStepGroup.MeshSize: Ansys.Core.Units.Quantity | None#

Defines the mesh size of the acoustic scenario based on the wave velocity and the frequency.

property MeshWorkflowStepGroup.MinimumMeshSize: Ansys.Core.Units.Quantity | None#

Gets or sets the minimal element size of the mesh to be used in workflow steps. If set to 0, the value is automatically defined based on the model size.

property MeshWorkflowStepGroup.Name: str | None#

Name property.

property MeshWorkflowStepGroup.NonStackableBodyMeshSize: Ansys.Core.Units.Quantity | None#

Gets or sets the element size to be used in meshing non-stackable bodies in stacker workflow.

property MeshWorkflowStepGroup.NumberOfAcousticLayers: int | None#

Gets or sets the number of layers in the acoustic region. If set to 0, the value defaults to 1 if QuadraticElements is enabled (see ) or 2 otherwise.

property MeshWorkflowStepGroup.NumberOfCores: int | None#

Defines how many CPU cores to be used in an operation (if supported by the operation).

property MeshWorkflowStepGroup.NumberOfPMLs: int | None#

Gets or sets the number of layers in the perfectly meshed layers region. If set to 0, the value defaults to 2 if QuadraticElements is enabled (see ) or 4 otherwise.

property MeshWorkflowStepGroup.ObjectId: int | None#

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

property MeshWorkflowStepGroup.Origin: Iterable[Ansys.Core.Units.Quantity] | None#

Gets or sets the Stacker origin coordinates.

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

Gets or sets the X coordinate location of base face for the volume flattening step.

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

Gets or sets the Y coordinate location of base face for the volume flattening step.

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

Gets or sets the Z coordinate location of base face for the volume flattening step.

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

Parent property.

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

Gets the list of properties for this object.

property MeshWorkflowStepGroup.QuadraticElements: bool | None#

Defines if the quadratic elements are used for the mesh generation.

property MeshWorkflowStepGroup.QueryMappingInfo: System.Collections.Generic.Dictionary[str, Any] | None#

QueryMappingInfo property.

property MeshWorkflowStepGroup.QueryMappingInfoJson: str | None#

QueryMappingInfoJson property.

property MeshWorkflowStepGroup.SlicerLayerHeight: Ansys.Core.Units.Quantity | None#

Gets or sets the spacing between newly created parallel planes used in workflow steps for the slicer workflow.

property MeshWorkflowStepGroup.SlicerLayerStart: Ansys.Core.Units.Quantity | None#

Gets or sets the z coordinate of the first plane used in workflow steps for the slicer workflow.

property MeshWorkflowStepGroup.SolidAspectRatioHeightLimit: float | None#

Defines the aspect ratio height limit to be used when determining if the mesh meets quality criteria. If exceeded, an element set will be created and an error will be returned.

property MeshWorkflowStepGroup.SolidQuality: bool | None#

Defines if the solid mesh quality will be validated.

property MeshWorkflowStepGroup.SolidSkewnessLimit: float | None#

Defines the skewness limit to be used when determining if the mesh meets quality criteria. If exceeded, an element set will be created and an error will be returned.

property MeshWorkflowStepGroup.SpeedOfSound: Ansys.Core.Units.Quantity | None#

Defines the speed of sound in the acoustic scenario.

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

Gets or sets the defeature size to be used along the stacking direction in stacker operations.

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

State property.

property MeshWorkflowStepGroup.Suppressed: bool | None#

Gets or sets the Suppressed.

property MeshWorkflowStepGroup.SurfaceAspectRatioHeightLimit: float | None#

Defines the aspect ratio height limit to be used when determining if the mesh meets quality criteria. If exceeded, an element set will be created and an error will be returned.

property MeshWorkflowStepGroup.SurfaceQuality: bool | None#

Defines if the surface mesh quality will be validated.

property MeshWorkflowStepGroup.SurfaceSkewnessLimit: float | None#

Defines the skewness limit to be used when determining if the mesh meets quality criteria. If exceeded, an element set will be created and an error will be returned.

property MeshWorkflowStepGroup.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#

Gets the list of properties that are visible for this object.

property MeshWorkflowStepGroup.WorkflowDescription: System.Collections.Generic.Dictionary[str, Any] | None#

WorkflowDescription property.

property MeshWorkflowStepGroup.WorkflowDescriptionJson: str | None#

WorkflowDescriptionJson property.

property MeshWorkflowStepGroup.WorkflowFailureInformation: System.Collections.Generic.Dictionary[str, str] | None#

WorkflowFailureInformation property.

property MeshWorkflowStepGroup.WorkflowFailureInformationJson: str | None#

WorkflowFailureInformationJson property.

property MeshWorkflowStepGroup.WorkflowReleaseStatusString: str | None#

WorkflowReleaseStatusString property.

property MeshWorkflowStepGroup.WorkflowString: str | None#

Gets the WorkflowString.

property MeshWorkflowStepGroup.WorkflowType: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.WorkflowType | None#

Returns the type of the operation. .

property MeshWorkflowStepGroup.WorkflowTypeInformation: System.Collections.Generic.Dictionary[str, str] | None#

WorkflowTypeInformation property.

property MeshWorkflowStepGroup.WorkflowTypeInformationJson: str | None#

WorkflowTypeInformationJson property.

Method detail#

MeshWorkflowStepGroup.Activate() None#

Activate the current object.

MeshWorkflowStepGroup.AddFigure() Ansys.ACT.Automation.Mechanical.Figure#

Creates a new child Figure.

MeshWorkflowStepGroup.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.
MeshWorkflowStepGroup.AddSettings(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.SettingsType) None#

Add the settings of the input SettingsType to the Steps node.

MeshWorkflowStepGroup.AddStep(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.OperationType) Ansys.ACT.Automation.Mechanical.MeshWorkflowStep#

Add another operation to the sequence of steps to be executed for the mesh workflow.

MeshWorkflowStepGroup.CanCheckPublicStateCallbackForIM() bool#

CanCheckPublicStateCallbackForIM method.

MeshWorkflowStepGroup.CanConvertSizingSettings(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.SettingsType) bool#

Returns whether the active sizing settings can be converted to the input SettingsType.

MeshWorkflowStepGroup.CanInsertOperationByType(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.OperationType, position: int, ignoreExecutedChecks: bool) bool#

Returns whether an operation of the given type can be inserted at the requested position. The ignoreExecutedChecks parameter determines whether to ignore any checks for already executed operations.

MeshWorkflowStepGroup.CanRunNextStep() bool#

CanRunNextStep method.

MeshWorkflowStepGroup.CanShowPublishStateIM() bool#

CanShowPublishStateIM method.

MeshWorkflowStepGroup.ClearDataAndDisableCheckpoints() None#

Clear all checkpoints data and disable checkpointing for the workflow.

MeshWorkflowStepGroup.ConvertSizingSettings(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.SettingsType) None#

Convert the active sizing settings to the input SettingsType for the Steps node.

MeshWorkflowStepGroup.ConvertWorkflow(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.WorkflowType) None#

Converts the workflow type to Custom

MeshWorkflowStepGroup.CopyAttachmentPathToClipboard() None#

Copies the current attachment path to clipboard.

MeshWorkflowStepGroup.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

MeshWorkflowStepGroup.CreateObjRef(requestedType: type) System.Runtime.Remoting.ObjRef#

CreateObjRef method.

MeshWorkflowStepGroup.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Creates a new parameter for a Property.

MeshWorkflowStepGroup.Delete() None#

Run the Delete action.

MeshWorkflowStepGroup.DeleteAllStepsAndClearGeneratedData() None#

Deletes all steps and reset workflow type to undefined and also 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.

MeshWorkflowStepGroup.DeleteSettings(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.SettingsType) None#

Delete the settings of the input SettingsType from the Steps node. All the Settings specific entries are removed automatically to the Steps details.

MeshWorkflowStepGroup.DisableAllCheckpoints() None#

Disables checkpoints for all editable steps in the workflow.

MeshWorkflowStepGroup.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

MeshWorkflowStepGroup.EnableAllCheckpoints() None#

Enables checkpoints for all editable steps in the workflow.

MeshWorkflowStepGroup.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) bool#

Equals method.

MeshWorkflowStepGroup.ExecuteAllSteps() None#

Executes all steps defined under the “StepGroup” object (which is the “Steps” node in the UI).

MeshWorkflowStepGroup.ExecuteNextStep() None#

Executes the next step, i.e. the next operation which is ready to be executed under the parent “StepGroup” object.

MeshWorkflowStepGroup.ExecuteUpToStep(arg: Any) None#

Executes any not yet ready steps up to and including the specified step.

MeshWorkflowStepGroup.ForceRevertStepAndExecuteToPrevious(arg: Any) None#

Revert to the last available checkpoint; if no checkpoint is available, clear generated data, enable the checkpoint for current step and execute up to the previous operation.

MeshWorkflowStepGroup.GetAPIName(dispId: int) str#

Property name bound to dispId.

MeshWorkflowStepGroup.GetAllProperties() List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]#

GetAllProperties method.

MeshWorkflowStepGroup.GetApplicableOperationTypes() List[Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.OperationType]#

GetApplicableOperationTypes method.

MeshWorkflowStepGroup.GetChildren(recurses: bool, children: List[ChildrenType]) List[ChildrenType]#

Gets the list of children, filtered by type.

MeshWorkflowStepGroup.GetDetailsView() Ansys.ACT.Automation.Mechanical.DetailsViewData#

GetDetailsView method.

MeshWorkflowStepGroup.GetDomainBrowserAvailableMorphFieldPatterns() List[System.Collections.Generic.Dictionary[str, Any]]#

GetDomainBrowserAvailableMorphFieldPatterns method.

MeshWorkflowStepGroup.GetDomainBrowserAvailableScopes() List[System.Collections.Generic.Dictionary[str, Any]]#

GetDomainBrowserAvailableScopes method.

MeshWorkflowStepGroup.GetDomainBrowserAvailableSizeFieldPatterns() List[System.Collections.Generic.Dictionary[str, Any]]#

GetDomainBrowserAvailableSizeFieldPatterns method.

MeshWorkflowStepGroup.GetEnumName(enumType: type, value: int, dispId: int) str#

Enum name bound to value

MeshWorkflowStepGroup.GetHashCode() int#

GetHashCode method.

MeshWorkflowStepGroup.GetIconFile() System.Byte#

GetIconFile method.

MeshWorkflowStepGroup.GetLifetimeService() Any#

GetLifetimeService method.

classmethod MeshWorkflowStepGroup.GetMeshWorkflowsControlPropertyList(control: Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelControlAuto, pathBase: str, result: List[System.Collections.Generic.Dictionary[str, Any]], filter: bool, filterUnpublishedProps: bool, filterPropertyNames: List[str]) None#

GetMeshWorkflowsControlPropertyList method.

classmethod MeshWorkflowStepGroup.GetMeshWorkflowsOperationPropertyList(operation: Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelOperationAuto, pathBase: str, result: List[System.Collections.Generic.Dictionary[str, Any]], filter: bool, filterUnpublishedProps: bool, filterPropertyNames: List[str]) None#

GetMeshWorkflowsOperationPropertyList method.

classmethod MeshWorkflowStepGroup.GetMeshWorkflowsOutcomePropertyList(outcome: Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelOutcomeAuto, pathBase: str, result: List[System.Collections.Generic.Dictionary[str, Any]], filter: bool, filterUnpublishedProps: bool, filterPropertyNames: List[str]) None#

GetMeshWorkflowsOutcomePropertyList method.

classmethod MeshWorkflowStepGroup.GetMeshWorkflowsPropertyList(workflow: Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelWorkflowAuto, result: List[System.Collections.Generic.Dictionary[str, Any]], filter: bool, filterUnpublished: bool, filterPropertyNames: List[str]) None#

GetMeshWorkflowsPropertyList method.

MeshWorkflowStepGroup.GetNextExecutableControlIdByType(controlTypeEnumValue: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ControlType) int#

GetNextExecutableControlIdByType method.

MeshWorkflowStepGroup.GetNextExecutableOrUndefinedControlIdByType(controlTypeEnumValue: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ControlType) int#

GetNextExecutableOrUndefinedControlIdByType method.

MeshWorkflowStepGroup.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) None#

GetObjectData method.

MeshWorkflowStepGroup.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

MeshWorkflowStepGroup.GetPath() str#

GetPath method.

MeshWorkflowStepGroup.GetPropertyName(dispId: int) str#

GetPropertyName method.

MeshWorkflowStepGroup.GetPropertyValue(id: int) str#

GetPropertyValue method.

MeshWorkflowStepGroup.GetPropertyWorksheetInfo() List[System.Collections.Generic.Dictionary[str, Any]]#

GetPropertyWorksheetInfo method.

MeshWorkflowStepGroup.GetType() type#

GetType method.

MeshWorkflowStepGroup.GetUnpublishedList() List[System.Collections.Generic.Dictionary[str, Any]]#

GetUnpublishedList method.

MeshWorkflowStepGroup.GetVisibleProperties() List[System.Reflection.PropertyInfo]#

GetVisibleProperties method.

MeshWorkflowStepGroup.GetVisiblePropertyNames() List[str]#

GetVisiblePropertyNames method.

MeshWorkflowStepGroup.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

MeshWorkflowStepGroup.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

MeshWorkflowStepGroup.GroupSteps(stepObjects: Iterable[Ansys.ACT.Automation.Mechanical.MeshWorkflowStep]) None#

GroupSteps method.

MeshWorkflowStepGroup.HasUnderdefinedSettingsData() bool#

HasUnderdefinedSettingsData method.

MeshWorkflowStepGroup.InitializeLifetimeService() Any#

InitializeLifetimeService method.

MeshWorkflowStepGroup.IsPropertyEditable(dispId: int) bool#

IsPropertyEditable method.

MeshWorkflowStepGroup.IsPropertyVisible(dispId: int) bool#

IsPropertyVisible method.

MeshWorkflowStepGroup.IsSizingSettings(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.SettingsType) bool#

IsSizingSettings method.

MeshWorkflowStepGroup.MeshWorkflowSteps() List[Ansys.ACT.Automation.Mechanical.MeshWorkflowStep]#

Gets the ordered list of Steps for the workflow.

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

MeshWorkflowStepGroup.PropagateSettings(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.SettingsType) None#

Propagate the settings of the input SettingsType to the attributes of the Step nodes. The meshing attributes of the Step nodes will then be automatically defined based on the physical parameters of the settings. Otherwise, the meshing attributes need to be manually specified.

MeshWorkflowStepGroup.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.
MeshWorkflowStepGroup.PropertyById(dispId: int) Ansys.ACT.Automation.Mechanical.Property#

PropertyById method.

MeshWorkflowStepGroup.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

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

PropertyTypeInfo method.

MeshWorkflowStepGroup.PublishIMProp() None#

PublishIMProp method.

MeshWorkflowStepGroup.RemoveParameter(propName: str) None#

Removes the parameter from the parameter set corresponding to the given property.

MeshWorkflowStepGroup.RenameBasedOnType() None#

Renames applying the default name based on type.

MeshWorkflowStepGroup.RevertToLastCheckpoint() None#

Revert to the last available checkpoint; if no checkpoint is available, then an exception will be raised.

MeshWorkflowStepGroup.RevertToStep(arg: Any) None#

Revert to the specified step; if no checkpoint is available, then an exception will be raised.

MeshWorkflowStepGroup.SetPropertyValue(id: int, value: str, validate: int) None#

SetPropertyValue method.

MeshWorkflowStepGroup.SetPublish(id: int) None#

SetPublish method.

MeshWorkflowStepGroup.SetUnpublish(id: int) None#

SetUnpublish method.

MeshWorkflowStepGroup.SettingsReleaseStatusString(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.SettingsType) str#

SettingsReleaseStatusString method.

MeshWorkflowStepGroup.SettingsTypeInformation(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.SettingsType) System.Collections.Generic.Dictionary[str, Any]#

SettingsTypeInformation method.

MeshWorkflowStepGroup.SettingsTypeInformationJson(type: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.SettingsType) str#

SettingsTypeInformationJson method.

MeshWorkflowStepGroup.StartCodeGeneration() None#

Start the code generation for the Meshing operations.

MeshWorkflowStepGroup.StopCodeGeneration() None#

Stop the code generation for the Meshing operations.

MeshWorkflowStepGroup.ToString() str#

ToString method.