MeshWorkflowOutcome#

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

Bases: object

Object that wraps IDSEngineeringModelOutcome.

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.

BoundingBoxDimensions

Gets the bounding box extents of the input aligned along the direction of stacking.

Children

Gets the list of children.

DataModelObjectCategory

Gets the current DataModelObject's category.

FailureMessage

Gets the failure message.

Figures

Gets the list of associated figures.

Images

Gets the list of associated images.

InternalObject

Gets the internal object. For advanced usage only.

MultiZoneDefeaturedEdges

Gets the number of edges for which MultiZone Meshing output no mesh elements.

MultiZoneDefeaturedEdgesScopeMethod

Gets the scope method for the MultiZone Defeatured Edges scope outcome.

MultiZoneDefeaturedEdgesScopePattern

Gets the scope pattern for the MultiZone Defeatured Edges scope outcome.

MultiZoneDefeaturedFaces

Gets the number of faces for which MultiZone Meshing output no mesh elements.

MultiZoneDefeaturedFacesScopeMethod

Gets the scope method for the MultiZone Defeatured Faces scope outcome.

MultiZoneDefeaturedFacesScopePattern

Gets the scope pattern for the MultiZone Defeatured Faces scope outcome.

MultiZoneFailedBlocking

Gets the number of entities (Volumes for 3D, Faces for 2D) for which the MultiZone Blocking failed.

MultiZoneFailedBlockingScopeMethod

Gets the scope method for the MultiZone Failed Blocking scope outcome.

MultiZoneFailedBlockingScopePattern

Gets the scope pattern for the MultiZone Failed Blocking scope outcome.

MultiZoneFailedInflation

Gets the number of entities (Volumes for 3D, Faces for 2D) for which the MultiZone Inflation failed.

MultiZoneFailedInflationScopeMethod

Gets the scope method for the MultiZone Failed Inflation scope outcome.

MultiZoneFailedInflationScopePattern

Gets the scope pattern for the MultiZone Failed Inflation scope outcome.

MultiZoneFailedInputMesh

Gets the number of entities (Volumes for 3D, Faces for 2D) for which the MultiZone Meshing failed to conformally connect to the input mesh.

MultiZoneFailedInputScopeMethod

Gets the scope method for the MultiZone Failed Input Mesh Connection scope outcome.

MultiZoneFailedInputScopePattern

Gets the scope pattern for the MultiZone Failed Input Mesh Connection scope outcome.

MultiZoneFailedMesh

Gets the number of entities (Volumes for 3D, Faces for 2D) for which the MultiZone Meshing failed to create a mesh.

MultiZoneFailedMeshCheck

Gets the number of entities (Volumes for 3D, Faces for 2D) for which the MultiZone Meshing created inverted or invalid elements.

MultiZoneFailedMeshCheckScopeMethod

Gets the scope method for the MultiZone Failed Mesh Check scope outcome.

MultiZoneFailedMeshCheckScopePattern

Gets the scope pattern for the MultiZone Failed Mesh Check scope outcome.

MultiZoneFailedMeshScopeMethod

Gets the scope method for the MultiZone Failed Mesh scope outcome.

MultiZoneFailedMeshScopePattern

Gets the scope pattern for the MultiZone Failed Mesh scope outcome.

MultiZoneFreeMesh

Gets the number of entities (Volumes for 3D, Faces for 2D) for which the MultiZone Blocking failed to create a swept or mapped block.

MultiZoneFreeMeshScopeMethod

Gets the scope method for the MultiZone Free Mesh scope outcome.

MultiZoneFreeMeshScopePattern

Gets the scope pattern for the MultiZone Free Mesh scope outcome.

OutcomeType

Returns the type of the control.

Properties

Gets the list of properties for this object.

ScopeDefinition

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

ScopeMethod

Gets or sets the scoping method for the control scoping.

ScopeOutcome

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

ScopePattern

Gets or sets the pattern that defines the scope of the control. Applicable only if scope is defined by value.

SizeFieldName

SmallestLateralEdgeLength

Gets the smallest edge length along the lateral direction of stacking.

SmallestStackingEdgeLength

Gets the smallest edge length along the stacking direction.

VisibleProperties

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

WarningMessage

Gets the warning message.

Property detail#

property MeshWorkflowOutcome.BoundingBoxDimensions: Ansys.Mechanical.Graphics.Point | None#

Gets the bounding box extents of the input aligned along the direction of stacking.

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

Gets the list of children.

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

Gets the current DataModelObject's category.

property MeshWorkflowOutcome.FailureMessage: str | None#

Gets the failure message.

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

Gets the list of associated figures.

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

Gets the list of associated images.

property MeshWorkflowOutcome.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSEngineeringModelOutcomeAuto | None#

Gets the internal object. For advanced usage only.

property MeshWorkflowOutcome.MultiZoneDefeaturedEdges: int | None#

Gets the number of edges for which MultiZone Meshing output no mesh elements.

property MeshWorkflowOutcome.MultiZoneDefeaturedEdgesScopeMethod: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeType | None#

Gets the scope method for the MultiZone Defeatured Edges scope outcome.

property MeshWorkflowOutcome.MultiZoneDefeaturedEdgesScopePattern: str | None#

Gets the scope pattern for the MultiZone Defeatured Edges scope outcome.

property MeshWorkflowOutcome.MultiZoneDefeaturedFaces: int | None#

Gets the number of faces for which MultiZone Meshing output no mesh elements.

property MeshWorkflowOutcome.MultiZoneDefeaturedFacesScopeMethod: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeType | None#

Gets the scope method for the MultiZone Defeatured Faces scope outcome.

property MeshWorkflowOutcome.MultiZoneDefeaturedFacesScopePattern: str | None#

Gets the scope pattern for the MultiZone Defeatured Faces scope outcome.

property MeshWorkflowOutcome.MultiZoneFailedBlocking: int | None#

Gets the number of entities (Volumes for 3D, Faces for 2D) for which the MultiZone Blocking failed.

property MeshWorkflowOutcome.MultiZoneFailedBlockingScopeMethod: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeType | None#

Gets the scope method for the MultiZone Failed Blocking scope outcome.

property MeshWorkflowOutcome.MultiZoneFailedBlockingScopePattern: str | None#

Gets the scope pattern for the MultiZone Failed Blocking scope outcome.

property MeshWorkflowOutcome.MultiZoneFailedInflation: int | None#

Gets the number of entities (Volumes for 3D, Faces for 2D) for which the MultiZone Inflation failed.

property MeshWorkflowOutcome.MultiZoneFailedInflationScopeMethod: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeType | None#

Gets the scope method for the MultiZone Failed Inflation scope outcome.

property MeshWorkflowOutcome.MultiZoneFailedInflationScopePattern: str | None#

Gets the scope pattern for the MultiZone Failed Inflation scope outcome.

property MeshWorkflowOutcome.MultiZoneFailedInputMesh: int | None#

Gets the number of entities (Volumes for 3D, Faces for 2D) for which the MultiZone Meshing failed to conformally connect to the input mesh.

property MeshWorkflowOutcome.MultiZoneFailedInputScopeMethod: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeType | None#

Gets the scope method for the MultiZone Failed Input Mesh Connection scope outcome.

property MeshWorkflowOutcome.MultiZoneFailedInputScopePattern: str | None#

Gets the scope pattern for the MultiZone Failed Input Mesh Connection scope outcome.

property MeshWorkflowOutcome.MultiZoneFailedMesh: int | None#

Gets the number of entities (Volumes for 3D, Faces for 2D) for which the MultiZone Meshing failed to create a mesh.

property MeshWorkflowOutcome.MultiZoneFailedMeshCheck: int | None#

Gets the number of entities (Volumes for 3D, Faces for 2D) for which the MultiZone Meshing created inverted or invalid elements.

property MeshWorkflowOutcome.MultiZoneFailedMeshCheckScopeMethod: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeType | None#

Gets the scope method for the MultiZone Failed Mesh Check scope outcome.

property MeshWorkflowOutcome.MultiZoneFailedMeshCheckScopePattern: str | None#

Gets the scope pattern for the MultiZone Failed Mesh Check scope outcome.

property MeshWorkflowOutcome.MultiZoneFailedMeshScopeMethod: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeType | None#

Gets the scope method for the MultiZone Failed Mesh scope outcome.

property MeshWorkflowOutcome.MultiZoneFailedMeshScopePattern: str | None#

Gets the scope pattern for the MultiZone Failed Mesh scope outcome.

property MeshWorkflowOutcome.MultiZoneFreeMesh: int | None#

Gets the number of entities (Volumes for 3D, Faces for 2D) for which the MultiZone Blocking failed to create a swept or mapped block.

property MeshWorkflowOutcome.MultiZoneFreeMeshScopeMethod: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeType | None#

Gets the scope method for the MultiZone Free Mesh scope outcome.

property MeshWorkflowOutcome.MultiZoneFreeMeshScopePattern: str | None#

Gets the scope pattern for the MultiZone Free Mesh scope outcome.

property MeshWorkflowOutcome.OutcomeType: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.OutcomeType | None#

Returns the type of the control.

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

Gets the list of properties for this object.

property MeshWorkflowOutcome.ScopeDefinition: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeDefinedByType | None#

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

property MeshWorkflowOutcome.ScopeMethod: Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow.ScopeType | None#

Gets or sets the scoping method for the control scoping.

property MeshWorkflowOutcome.ScopeOutcome: Ansys.ACT.Automation.Mechanical.MeshWorkflowOutcome | None#

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

property MeshWorkflowOutcome.ScopePattern: str | None#

Gets or sets the pattern that defines the scope of the control. Applicable only if scope is defined by value.

property MeshWorkflowOutcome.SizeFieldName: str | None#
property MeshWorkflowOutcome.SmallestLateralEdgeLength: Ansys.Core.Units.Quantity | None#

Gets the smallest edge length along the lateral direction of stacking.

property MeshWorkflowOutcome.SmallestStackingEdgeLength: Ansys.Core.Units.Quantity | None#

Gets the smallest edge length along the stacking direction.

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

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

property MeshWorkflowOutcome.WarningMessage: str | None#

Gets the warning message.

Method detail#

MeshWorkflowOutcome.Activate() None#

Activate the current object.

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

Creates a new child Figure.

MeshWorkflowOutcome.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.
MeshWorkflowOutcome.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) None#

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

MeshWorkflowOutcome.Delete() None#

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

MeshWorkflowOutcome.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

MeshWorkflowOutcome.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.
MeshWorkflowOutcome.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

MeshWorkflowOutcome.RemoveParameter(propName: str) None#

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