meshing_workflow#

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

Classes:

`CreatedWorkflow`(session[, initialize])	Provides a specialization of the workflow wrapper for a newly created workflow.
`FaultTolerantMeshingWorkflow`(session[, ...])	Provides fault-tolerant meshing specialization of the workflow wrapper.
`LoadedWorkflow`(session[, file_path, initialize])	Provides a specialization of the workflow wrapper for a loaded workflow.
`MeshingWorkflow`(session, workflow_type[, ...])	Provides meshing specialization of the workflow wrapper that extends the core functionality in an object-oriented manner.
`TopologyBasedMeshingWorkflow`(session[, ...])	Provides topology-based meshing specialization of the workflow wrapper.
`TwoDimensionalMeshingWorkflow`(session[, ...])	Provides 2D meshing specialization of the workflow wrapper.
`WatertightMeshingWorkflow`(session[, initialize])	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 the PyFluent-native interface.

class ansys.fluent.core.meshing.meshing_workflow.CreatedWorkflow(session, initialize=True)#

Bases: Workflow

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

Methods:

__init__(session[, initialize])

Initialize a CreatedWorkflow instance.

__init__(session, initialize=True)#

Initialize a CreatedWorkflow instance.

Parameters:

sessionPureMeshing | Meshing: Meshing session object.
initialize: bool: Flag to initialize the workflow, defaults to True. Set this to False if you are connecting to an existing meshing session which has been initialized and want to avoid re-initializing the workflow.

class ansys.fluent.core.meshing.meshing_workflow.FaultTolerantMeshingWorkflow(session, initialize=True)#

Bases: MeshingWorkflow, object

Provides fault-tolerant meshing specialization of the workflow wrapper.

Methods:

__init__(session[, initialize])

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__(session, initialize=True)#

Initialize FaultTolerantMeshingWorkflow.

Parameters:

sessionPureMeshing | Meshing: The meshing session.
initialize: bool: Flag to initialize the workflow, defaults to True. Set this to False if you are connecting to an existing meshing session which has been initialized and want to avoid re-initializing the workflow.

property part_management: PyMenu | None#

Access part-management in fault-tolerant mode.

Returns:

PyMenu | None: Part-management.

property parts: PyMenu | None#

Access part-management in fault-tolerant mode.

Returns:

PyMenu | None: Part-management.

property parts_files#

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

Returns:

PyMenu | None: File management object in the part management object.

property pm_file_management: PyMenu | None#

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

Returns:

PyMenu | None: File management object in the part management object.

class ansys.fluent.core.meshing.meshing_workflow.LoadedWorkflow(session, file_path=None, initialize=True)#

Bases: Workflow

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

Methods:

__init__(session[, file_path, initialize])

Initialize a LoadedWorkflow instance.

__init__(session, file_path=None, initialize=True)#

Initialize a LoadedWorkflow instance.

Parameters:

sessionPureMeshing | Meshing: Meshing session object.
file_path: os.PathLike[str | bytes] | str | bytes: Path to the saved workflow file.
initialize: bool: Flag to initialize the workflow, defaults to True. Set this to False if you are connecting to an existing meshing session which has been initialized and want to avoid re-initializing the workflow.

class ansys.fluent.core.meshing.meshing_workflow.MeshingWorkflow(session, workflow_type, initialize=True)#

Bases: Workflow

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

See the workflow API for details of the underlying workflow object.

Methods:

__init__(session, workflow_type[, initialize])

Initialize MeshingWorkflow.

__init__(session, workflow_type, initialize=True)#

Initialize MeshingWorkflow.

Parameters:

sessionPureMeshing | Meshing: The meshing session.
workflow_type: str: Workflow type to initialize it.
initialize: bool: Flag to initialize the workflow, defaults to True.

class ansys.fluent.core.meshing.meshing_workflow.TopologyBasedMeshingWorkflow(session, initialize=True)#

Bases: MeshingWorkflow, object

Provides topology-based meshing specialization of the workflow wrapper.

Methods:

__init__(session[, initialize])

Initialize TopologyBasedMeshingWorkflow.

__init__(session, initialize=True)#

Initialize TopologyBasedMeshingWorkflow.

Parameters:

sessionPureMeshing | Meshing: Meshing session object.
initialize: bool: Flag to initialize the workflow, defaults to True. Set this to False if you are connecting to an existing meshing session which has been initialized and want to avoid re-initializing the workflow.

class ansys.fluent.core.meshing.meshing_workflow.TwoDimensionalMeshingWorkflow(session, initialize=True)#

Bases: MeshingWorkflow, object

Provides 2D meshing specialization of the workflow wrapper.

Methods:

__init__(session[, initialize])

Initialize TwoDimensionalMeshingWorkflow.

__init__(session, initialize=True)#

Initialize TwoDimensionalMeshingWorkflow.

Parameters:

sessionPureMeshing | Meshing: Meshing session object.
initialize: bool: Flag to initialize the workflow, defaults to True. Set this to False if you are connecting to an existing meshing session which has been initialized and want to avoid re-initializing the workflow.

class ansys.fluent.core.meshing.meshing_workflow.WatertightMeshingWorkflow(session, initialize=True)#

Bases: MeshingWorkflow, object

Provides watertight meshing specialization of the workflow wrapper.

Methods:

__init__(session[, initialize])

Initialize WatertightMeshingWorkflow.

__init__(session, initialize=True)#

Initialize WatertightMeshingWorkflow.

Parameters:

sessionPureMeshing | Meshing: The meshing session.
initialize: bool: Flag to initialize the workflow, defaults to True. Set this to False if you are connecting to an existing meshing session which has been initialized and want to avoid re-initializing the workflow.

class ansys.fluent.core.meshing.meshing_workflow.WorkflowMode(value, names=<not given>, *values, 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`(session[, ...])
`TOPOLOGY_BASED_MESHING_MODE`(session[, ...])
`TWO_DIMENSIONAL_MESHING_MODE`(session[, ...])
`WATERTIGHT_MESHING_MODE`(session[, initialize])

FAULT_TOLERANT_MESHING_MODE(session, initialize=True) = <class 'ansys.fluent.core.meshing.meshing_workflow.FaultTolerantMeshingWorkflow'>#

TOPOLOGY_BASED_MESHING_MODE(session, initialize=True) = <class 'ansys.fluent.core.meshing.meshing_workflow.TopologyBasedMeshingWorkflow'>#

TWO_DIMENSIONAL_MESHING_MODE(session, initialize=True) = <class 'ansys.fluent.core.meshing.meshing_workflow.TwoDimensionalMeshingWorkflow'>#

WATERTIGHT_MESHING_MODE(session, initialize=True) = <class 'ansys.fluent.core.meshing.meshing_workflow.WatertightMeshingWorkflow'>#

ansys.fluent.core.meshing.meshing_workflow.get_current_workflow(workflow_root, current_workflow, workflow_factories, load_workflow_handle)#

Get the currently active workflow in the PyFluent-native interface.

Parameters:

workflow_rootPyMenu: 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.