data_transfer

Session to session data transfer, supporting Fluent in all modes.

Exceptions:

MeshWriteError()

Raised when mesh write is unsuccessful.

Functions:

transfer_case(source_instance, solvers, ...)

Transfer case between instances.

exception ansys.fluent.core.utils.data_transfer.MeshWriteError

Bases: RuntimeError

Raised when mesh write is unsuccessful.

Methods:

__init__()

Initializes MeshWriteError.

__init__()

Initializes MeshWriteError.

ansys.fluent.core.utils.data_transfer.transfer_case(source_instance, solvers, file_type, file_name_stem, num_files_to_try, clean_up_temp_file, overwrite_previous, workdir=None, container_workdir=None)

Transfer case between instances.

Parameters:

source_instanceobject

Fluent instance (tested for meshing instance)

solversiterable

Sequence of solver instances

file_typestr

“case” or “mesh”

file_name_stemstr

Optional file name stem

num_files_to_tryint

Optional number of files to try to write, each with a different generated name. Defaults to 1

clean_up_temp_file: bool

Whether to remove the file at the end

overwrite_previous: bool

Whether to overwrite the file if it already exists

workdirstr, optional

Working directory that is accessible by the Fluent client as well as PyFluent.

container_workdirstr, optional

If using a Fluent container image, specifies the working directory that is accessible by the Fluent client inside the container, which should also be mounted to the container from the host system path specified in workdir.

Returns:

None

Raises:

MeshWriteError

If mesh cannot be written from source_instance.