meshing_workflow#

Meshing workflow specialization of the Workflow module that wraps and extends the core functionality.

Classes:

CreateWorkflow(workflow, meshing, fluent_version)

Provides a specialization of the workflow wrapper for a newly created workflow.

FaultTolerantMeshingWorkflow(workflow, ...)

Provides fault-tolerant meshing specialization of the workflow wrapper.

LoadWorkflow(workflow, meshing, fluent_version)

Provides a specialization of the workflow wrapper for a loaded workflow.

MeshingWorkflow(workflow, meshing, name, ...)

Provides meshing specialization of the workflow wrapper that extends the core functionality in an object-oriented manner.

TopologyBasedMeshingWorkflow(workflow, ...)

Provides topology-based meshing specialization of the workflow wrapper.

TwoDimensionalMeshingWorkflow(workflow, ...)

Provides 2D meshing specialization of the workflow wrapper.

WatertightMeshingWorkflow(workflow, meshing, ...)

Provides watertight meshing specialization of the workflow wrapper.

WorkflowMode(value[, names, module, ...])

Provides an enum of supported Fluent meshing workflow modes.

Functions:

get_current_workflow(workflow_root, ...)

Get the currently active workflow in new mode.

class ansys.fluent.core.meshing.meshing_workflow_new.CreateWorkflow(workflow, meshing, fluent_version, initialize=True)#

Bases: Workflow

Provides a specialization of the workflow wrapper for a newly created workflow.

Methods:

__init__(workflow, meshing, fluent_version)

Initialize a CreateWorkflow instance.

__init__(workflow, meshing, fluent_version, initialize=True)#

Initialize a CreateWorkflow instance.

Parameters:
workflowPyMenuGeneric

Underlying workflow object.

meshingPyMenuGeneric

Meshing object.

fluent_version: FluentVersion

Version of Fluent in this session.

initialize: bool

Flag to initialize the workflow, defaults to True.

class ansys.fluent.core.meshing.meshing_workflow_new.FaultTolerantMeshingWorkflow(workflow, meshing, part_management, pm_file_management, fluent_version, initialize=True)#

Bases: MeshingWorkflow

Provides fault-tolerant meshing specialization of the workflow wrapper.

Methods:

__init__(workflow, meshing, part_management, ...)

Initialize FaultTolerantMeshingWorkflow.

Attributes:

part_management

Access part-management in fault-tolerant mode.

parts

Access part-management in fault-tolerant mode.

parts_files

Access the part-management file-management object in fault-tolerant mode.

pm_file_management

Access the part-management file-management object in fault-tolerant mode.

__init__(workflow, meshing, part_management, pm_file_management, fluent_version, initialize=True)#

Initialize FaultTolerantMeshingWorkflow.

Parameters:
workflowPyMenuGeneric

Underlying workflow object.

meshingPyMenuGeneric

Meshing object.

part_managementPyMenuGeneric

Part management object.

pm_file_managementPyMenuGeneric

File management object in the part management object.

fluent_version: FluentVersion

Version of Fluent in this session.

initialize: bool

Flag to initialize the workflow, defaults to True.

property part_management: PyMenuGeneric | None#

Access part-management in fault-tolerant mode.

Returns:
PyMenuGeneric | None

Part-management.

property parts: PyMenuGeneric | None#

Access part-management in fault-tolerant mode.

Returns:
PyMenuGeneric | None

Part-management.

property parts_files#

Access the part-management file-management object in fault-tolerant mode.

Returns:
PyMenuGeneric | None

File management object in the part management object.

property pm_file_management#

Access the part-management file-management object in fault-tolerant mode.

Returns:
PyMenuGeneric | None

File management object in the part management object.

class ansys.fluent.core.meshing.meshing_workflow_new.LoadWorkflow(workflow, meshing, fluent_version, file_path=None, initialize=True)#

Bases: Workflow

Provides a specialization of the workflow wrapper for a loaded workflow.

Methods:

__init__(workflow, meshing, fluent_version)

Initialize a LoadWorkflow instance.

__init__(workflow, meshing, fluent_version, file_path=None, initialize=True)#

Initialize a LoadWorkflow instance.

Parameters:
workflowPyMenuGeneric

Underlying workflow object.

meshingPyMenuGeneric

Meshing object.

file_path: os.PathLike[str | bytes] | str | bytes

Path to the saved workflow file.

fluent_version: FluentVersion

Version of Fluent in this session.

initialize: bool

Flag to initialize the workflow, defaults to True.

class ansys.fluent.core.meshing.meshing_workflow_new.MeshingWorkflow(workflow, meshing, name, fluent_version, initialize=True)#

Bases: Workflow

Provides meshing specialization of the workflow wrapper that extends the core functionality in an object-oriented manner.

Methods:

__init__(workflow, meshing, name, fluent_version)

Initialize MeshingWorkflow.

__init__(workflow, meshing, name, fluent_version, initialize=True)#

Initialize MeshingWorkflow.

Parameters:
workflowPyMenuGeneric

Underlying workflow object.

meshingPyMenuGeneric

Meshing object.

name: str

Workflow name to initialize it.

fluent_version: FluentVersion

Version of Fluent in this session.

initialize: bool

Flag to initialize the workflow, defaults to True.

class ansys.fluent.core.meshing.meshing_workflow_new.TopologyBasedMeshingWorkflow(workflow, meshing, fluent_version, initialize=True)#

Bases: MeshingWorkflow

Provides topology-based meshing specialization of the workflow wrapper.

Methods:

__init__(workflow, meshing, fluent_version)

Initialize TopologyBasedMeshingWorkflow.

__init__(workflow, meshing, fluent_version, initialize=True)#

Initialize TopologyBasedMeshingWorkflow.

Parameters:
workflowPyMenuGeneric

Underlying workflow object.

meshingPyMenuGeneric

Meshing object.

fluent_version: FluentVersion

Version of Fluent in this session.

initialize: bool

Flag to initialize the workflow, defaults to True.

class ansys.fluent.core.meshing.meshing_workflow_new.TwoDimensionalMeshingWorkflow(workflow, meshing, fluent_version, initialize=True)#

Bases: MeshingWorkflow

Provides 2D meshing specialization of the workflow wrapper.

Methods:

__init__(workflow, meshing, fluent_version)

Initialize TwoDimensionalMeshingWorkflow.

__init__(workflow, meshing, fluent_version, initialize=True)#

Initialize TwoDimensionalMeshingWorkflow.

Parameters:
workflowPyMenuGeneric

Underlying workflow object.

meshingPyMenuGeneric

Meshing object.

fluent_version: FluentVersion

Version of Fluent in this session.

initialize: bool

Flag to initialize the workflow, defaults to True.

class ansys.fluent.core.meshing.meshing_workflow_new.WatertightMeshingWorkflow(workflow, meshing, fluent_version, initialize=True)#

Bases: MeshingWorkflow

Provides watertight meshing specialization of the workflow wrapper.

Methods:

__init__(workflow, meshing, fluent_version)

Initialize WatertightMeshingWorkflow.

__init__(workflow, meshing, fluent_version, initialize=True)#

Initialize WatertightMeshingWorkflow.

Parameters:
workflowPyMenuGeneric

Underlying workflow object.

meshingPyMenuGeneric

Meshing object.

fluent_version: FluentVersion

Version of Fluent in this session.

initialize: bool

Flag to initialize the workflow, defaults to True.

class ansys.fluent.core.meshing.meshing_workflow_new.WorkflowMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)#

Bases: Enum

Provides an enum of supported Fluent meshing workflow modes.

Attributes:

FAULT_TOLERANT_MESHING_MODE(workflow, ...[, ...])

TOPOLOGY_BASED_MESHING_MODE(workflow, ...[, ...])

TWO_DIMENSIONAL_MESHING_MODE(workflow, ...)

WATERTIGHT_MESHING_MODE(workflow, meshing, ...)

FAULT_TOLERANT_MESHING_MODE(workflow, meshing, part_management, pm_file_management, fluent_version, initialize=True) = <class 'ansys.fluent.core.meshing.meshing_workflow_new.FaultTolerantMeshingWorkflow'>#
TOPOLOGY_BASED_MESHING_MODE(workflow, meshing, fluent_version, initialize=True) = <class 'ansys.fluent.core.meshing.meshing_workflow_new.TopologyBasedMeshingWorkflow'>#
TWO_DIMENSIONAL_MESHING_MODE(workflow, meshing, fluent_version, initialize=True) = <class 'ansys.fluent.core.meshing.meshing_workflow_new.TwoDimensionalMeshingWorkflow'>#
WATERTIGHT_MESHING_MODE(workflow, meshing, fluent_version, initialize=True) = <class 'ansys.fluent.core.meshing.meshing_workflow_new.WatertightMeshingWorkflow'>#
ansys.fluent.core.meshing.meshing_workflow_new.get_current_workflow(workflow_root, current_workflow, workflow_factories, load_workflow_handle)#

Get the currently active workflow in new mode.

Parameters:
workflow_rootPyMenuGeneric

Root workflow datamodel object.

current_workflowWorkflow or None

Currently cached workflow instance.

workflow_factoriesdict

Mapping of workflow type names to factory functions.

load_workflow_handlecallable()

Function to load a workflow from file.

Returns:
Workflow

The currently active workflow instance.

Raises:
RuntimeError

If no workflow is initialized.