session_base_meshing#

Provides a module to get base Meshing session.

Classes:

BaseMeshing(session_execute_tui, ...)

Encapsulates base methods of a meshing session.

class ansys.fluent.core.session_base_meshing.BaseMeshing(session_execute_tui, fluent_connection, fluent_version, datamodel_service_tui, datamodel_service_se)#

Bases: object

Encapsulates base methods of a meshing session.

Attributes:

PMFileManagement

Datamodel root of PMFileManagement.

PartManagement

Datamodel root of PartManagement.

meshing

Meshing object.

meshing_utilities

A wrapper over the Fluent's meshing queries.

meshing_workflow

Full API to meshing and meshing_workflow.

preferences

Datamodel root of preferences.

tui

Instance of main_menu on which Fluent's SolverTUI methods can be executed.

workflow

Datamodel root of workflow.

Methods:

__init__(session_execute_tui, ...)

BaseMeshing session.

create_workflow([initialize, legacy])

Create a new blank meshing workflow for manual task configuration.

current_workflow([legacy])

Get the currently active meshing workflow.

fault_tolerant_workflow([initialize, legacy])

Create a fault-tolerant meshing workflow.

get_fluent_version()

Gets and returns the fluent version.

load_workflow([file_path, initialize, legacy])

Load a previously saved meshing workflow from file.

topology_based_meshing_workflow([...])

Create a topology-based workflow (beta).

two_dimensional_meshing_workflow([...])

Create a 2D meshing workflow.

watertight_workflow([initialize, legacy])

Create a watertight meshing workflow.

property PMFileManagement#

Datamodel root of PMFileManagement.

property PartManagement#

Datamodel root of PartManagement.

__init__(session_execute_tui, fluent_connection, fluent_version, datamodel_service_tui, datamodel_service_se)#

BaseMeshing session.

Parameters:
session_execute_tui (_type_):

Executes Fluent’s SolverTUI methods.

fluent_connection (:ref:`ref_fluent_connection`):

Encapsulates a Fluent connection.

create_workflow(initialize=True, legacy=None)#

Create a new blank meshing workflow for manual task configuration.

Provides an empty workflow to build custom task sequences from scratch.

Parameters:
initialize: bool, optional

If True (default), initializes the workflow with default settings and prepares it for immediate use. If False, creates the workflow without initialization, useful when loading a saved state or applying custom configuration before starting.

legacybool, optional

If True, creates a legacy workflow implementation. If False, creates a new workflow implementation. If None (default), uses the legacy workflow implementation for Fluent versions up to 25R2 and uses the new workflow implementation for later versions (since 26R1).

current_workflow(legacy=None)#

Get the currently active meshing workflow.

Returns the workflow instance that is currently loaded in the session.

Parameters:
legacybool, optional

If True, creates a legacy workflow implementation. If False, creates a new workflow implementation. If None (default), uses the legacy workflow implementation for Fluent versions up to 25R2 and uses the new workflow implementation for later versions (since 26R1).

Raises:
RuntimeError

If no workflow is initialized.

fault_tolerant_workflow(initialize=True, legacy=None)#

Create a fault-tolerant meshing workflow.

Parameters:
initialize: bool, optional

If True (default), initializes the workflow with default settings and prepares it for immediate use. If False, creates the workflow without initialization, useful when loading a saved state or applying custom configuration before starting.

legacybool, optional

If True, creates a legacy workflow implementation. If False, creates a new workflow implementation. If None (default), uses the legacy workflow implementation for Fluent versions up to 25R2 and uses the new workflow implementation for later versions (since 26R1).

get_fluent_version()#

Gets and returns the fluent version.

load_workflow(file_path=None, initialize=True, legacy=None)#

Load a previously saved meshing workflow from file.

Restores workflow configuration including tasks, settings, and state.

Parameters:
file_pathstr or PathType

Path to the saved workflow file (typically with .wft extension).

initialize: bool, optional

If True (default), initializes the workflow with default settings and prepares it for immediate use. If False, creates the workflow without initialization, useful when loading a saved state or applying custom configuration before starting.

legacybool, optional

If True, creates a legacy workflow implementation. If False, creates a new workflow implementation. If None (default), uses the legacy workflow implementation for Fluent versions up to 25R2 and uses the new workflow implementation for later versions (since 26R1).

property meshing#

Meshing object.

property meshing_utilities#

A wrapper over the Fluent’s meshing queries.

property meshing_workflow#

Full API to meshing and meshing_workflow.

property preferences#

Datamodel root of preferences.

topology_based_meshing_workflow(initialize=True, legacy=None)#

Create a topology-based workflow (beta).

Parameters:
initialize: bool, optional

If True (default), initializes the workflow with default settings and prepares it for immediate use. If False, creates the workflow without initialization, useful when loading a saved state or applying custom configuration before starting.

legacybool, optional

If True, creates a legacy workflow implementation. If False, creates a new workflow implementation. If None (default), uses the legacy workflow implementation for Fluent versions up to 25R2 and uses the new workflow implementation for later versions (since 26R1).

property tui#

Instance of main_menu on which Fluent’s SolverTUI methods can be executed.

two_dimensional_meshing_workflow(initialize=True, legacy=None)#

Create a 2D meshing workflow.

Parameters:
initialize: bool, optional

If True (default), initializes the workflow with default settings and prepares it for immediate use. If False, creates the workflow without initialization, useful when loading a saved state or applying custom configuration before starting.

legacybool, optional

If True, creates a legacy workflow implementation. If False, creates a new workflow implementation. If None (default), uses the legacy workflow implementation for Fluent versions up to 25R2 and uses the new workflow implementation for later versions (since 26R1).

watertight_workflow(initialize=True, legacy=None)#

Create a watertight meshing workflow.

Parameters:
initialize: bool, optional

If True (default), initializes the workflow with default settings and prepares it for immediate use. If False, creates the workflow without initialization, useful when loading a saved state or applying custom configuration before starting.

legacybool, optional

If True, creates a legacy workflow implementation. If False, creates a new workflow implementation. If None (default), uses the legacy workflow implementation for Fluent versions up to 25R2 and uses the new workflow implementation for later versions (since 26R1).

property workflow#

Datamodel root of workflow.