`MeshWorkflowStepGroup`#

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

Bases: object

Object that wraps IDSEngineeringModelWorkflow.

Overview#

Methods

`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.
`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.
`CopyTo`	Copies all visible properties from this object to another.
`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.
`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.
`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.
`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.
`PropertyByName`	Get a property by its unique name.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.
`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.

Properties

`AnalysisFrequency`	Defines the analysis frequency of the acoustic scenario.
`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.
`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.
`DataModelObjectCategory`	Gets the current DataModelObject's category.
`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.
`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.
`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.
`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.
`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 P:Ansys.ACT.Automation.Mechanical.MeshWorkflowStepGroup.QuadraticElements) 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 P:Ansys.ACT.Automation.Mechanical.MeshWorkflowStepGroup.QuadraticElements) or 4 otherwise.
`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.
`Properties`	Gets the list of properties for this object.
`QuadraticElements`	Defines if the quadratic elements are used for the mesh generation.
`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.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

property MeshWorkflowStepGroup.AnalysisFrequency: Ansys.Core.Units.Quantity | None#: Defines the analysis frequency of the acoustic scenario.

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.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.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#: Gets the current DataModelObject's category.

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.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.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.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.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 P:Ansys.ACT.Automation.Mechanical.MeshWorkflowStepGroup.QuadraticElements) 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 P:Ansys.ACT.Automation.Mechanical.MeshWorkflowStepGroup.QuadraticElements) or 4 otherwise.

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

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.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.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None#: Copies all visible properties from this object to another.

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.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.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]#: Gets the list of children, filtered by type.

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

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

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

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.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property#: Get a property by its unique name.

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

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.