Launcher#

Provides a module for launching Fluent.

This module supports both starting Fluent locally and connecting to a remote instance with gRPC.

Classes:

`FluentVersion`(value)	An enumeration over supported Fluent versions.
`LaunchMode`(value)	An enumeration over supported launch modes.

Exceptions:

LaunchFluentError(launch_string)

Exception class representing launch errors.

Functions:

`get_ansys_version`()	Return the version string corresponding to the most recent, available ANSYS installation.
`get_fluent_exe_path`(**launch_argvals)	Get Fluent executable path.
`launch_fluent`([product_version, version, ...])	Launch Fluent locally in server mode or connect to a running Fluent server instance.
`launch_remote_fluent`(session_cls, ...[, ...])	Launch Fluent remotely using PyPIM <https://pypim.docs.pyansys.com>.
`scm_to_py`(topy)	Convert journal filenames to Python filename.

class ansys.fluent.core.launcher.launcher.FluentVersion(value)#

Bases: Enum

An enumeration over supported Fluent versions.

Attributes:

`version_22R2`
`version_23R1`
`version_23R2`

version_22R2 = '22.2.0'#

version_23R1 = '23.1.0'#

version_23R2 = '23.2.0'#

exception ansys.fluent.core.launcher.launcher.LaunchFluentError(launch_string)#

Bases: Exception

Exception class representing launch errors.

__init__(launch_string)#: __init__ method of LaunchFluentError class.

class ansys.fluent.core.launcher.launcher.LaunchMode(value)#

Bases: Enum

An enumeration over supported launch modes.

Attributes:

`MESHING_MODE`
`PURE_MESHING_MODE`
`SOLVER`
`SOLVER_ICING`

Methods:

get_mode(mode)

Returns the LaunchMode based on the provided mode string.

MESHING_MODE = ('meshing', <class 'ansys.fluent.core.session_meshing.Meshing'>, True, [])#

PURE_MESHING_MODE = ('pure-meshing', <class 'ansys.fluent.core.session_pure_meshing.PureMeshing'>, True, [])#

SOLVER = ('solver', <class 'ansys.fluent.core.session_solver.Solver'>, False, [])#

SOLVER_ICING = ('solver-icing', <class 'ansys.fluent.core.session_solver_icing.SolverIcing'>, False, [('fluent_icing', True)])#

static get_mode(mode)#: Returns the LaunchMode based on the provided mode string.

ansys.fluent.core.launcher.launcher.get_ansys_version()#

Return the version string corresponding to the most recent, available ANSYS installation. The returned value is the string component of one of the members of the FluentVersion class.

Return type:: str

ansys.fluent.core.launcher.launcher.get_fluent_exe_path(**launch_argvals)#

Get Fluent executable path. The path is searched in the following order. :rtype: Path

PYFLUENT_FLUENT_ROOT environment variable.
product_version parameter passed with launch_fluent.
The latest ANSYS version from AWP_ROOTnnn` environment variables.

Returns:

Path: Fluent executable path

ansys.fluent.core.launcher.launcher.launch_fluent(product_version=None, version=None, precision=None, processor_count=None, journal_filepath=None, start_timeout=100, additional_arguments='', env=None, start_instance=None, ip=None, port=None, cleanup_on_exit=True, start_transcript=True, show_gui=None, case_filepath=None, case_data_filepath=None, lightweight_mode=False, mode=None, server_info_filepath=None, password=None, py=None, cwd=None, topy=None, **kwargs)#

Launch Fluent locally in server mode or connect to a running Fluent server instance.

Parameters:

product_versionstr, optional: Select an installed version of ANSYS. The string must be in a format like "23.1.0" (for 2023 R1) matching the documented version format in the FluentVersion class. The default is None, in which case the newest installed version is used.
versionstr, optional: Geometric dimensionality of the Fluent simulation. The default is None, in which case "3d" is used. Options are "3d" and "2d".
precisionstr, optional: Floating point precision. The default is None, in which case "double" is used. Options are "double" and "single".
processor_countint, optional: Number of processors. The default is None, in which case 1 processor is used. In job scheduler environments the total number of allocated cores is clamped to this value.
journal_filepathstr, optional: Name of the journal file to read. The default is None.
start_timeoutint, optional: Maximum allowable time in seconds for connecting to the Fluent server. The default is 100.
additional_argumentsstr, optional: Additional arguments to send to Fluent as a string in the same format they are normally passed to Fluent on the command line. The default is``””``.
envdict[str, str], optional: Mapping to modify environment variables in Fluent. The default is None.
start_instancebool, optional: Whether to start a local Fluent instance. The default is None, which indicates True. Otherwise, connect to an existing Fluent instance at a specified IP address on a specified port, using the arguments ip and port. You can also use the environment variable PYFLUENT_START_INSTANCE=<0 or 1> to set start_instance if you do not pass it as an argument.
ipstr, optional: IP address for connecting to an existing Fluent instance. This parameter is used only when start_instance is False. Otherwise, the IP address defaults to "127.0.0.1". You can also use the environment variable PYFLUENT_FLUENT_IP=<ip> to set this parameter.
portint, optional: Port to listen on for an existing Fluent instance. This parameter is used only when start_instance is False. You can use the environment variable PYFLUENT_FLUENT_PORT=<port> to set a default value.
cleanup_on_exitbool, optional: Whether to shut down the connected Fluent session when PyFluent is exited, or the exit() method is called on the session instance, or if the session instance becomes unreferenced. The default is True.
start_transcriptbool, optional: Whether to start streaming the Fluent transcript in the client. The default is True. You can stop and start the streaming of the Fluent transcript subsequently via the method calls, start_transcript() and stop_transcript() on the session object.
show_guibool, optional: Whether to display the Fluent GUI, only when start_instance is set to True. The default is None, which does not cause the GUI to be shown. If a value of False is not explicitly provided, the GUI will also be shown if the environment variable PYFLUENT_SHOW_SERVER_GUI is set to 1.
case_filepathstr, optional: If provided, the case file at case_filepath is read into the Fluent session.
case_data_filepathstr, optional: If provided, the case and data files at case_data_filepath are read into the Fluent session.
lightweight_mode: bool, optional: Whether to run in lightweight mode. In lightweight mode, the lightweight settings are read into the current Fluent solver session. The mesh is read into a background Fluent solver session which will replace the current Fluent solver session once the mesh read is complete and the lightweight settings made by the user in the current Fluent solver session have been applied in the background Fluent solver session. This is all orchestrated by PyFluent and requires no special usage. This parameter is used only when case_filepath is provided. The default is False.
modestr, optional: Launch mode of Fluent to point to a specific session type. The default value is None. Options are "meshing", "pure-meshing" and "solver".
server_info_filepath: str: Path to server-info file written out by Fluent server. The default is None. server_info_filepath can be specified if start_instance is False, where PyFluent will use the connection information in the file to connect to a running Fluent session.
passwordstr, optional: Password to connect to existing Fluent instance.
pybool, optional: If True, Fluent will run in Python mode. Default is None.
cwd: str, Optional: Path to specify current working directory to launch fluent from the defined directory as current working directory.
topy: str or list, optional: The string path to a Fluent journal file, or a list of such paths. Fluent will execute the journal(s) and write the equivalent Python journal(s).

Returns:

Union[Meshing, PureMeshing, Solver, SolverIcing]: Session object.

Return type:

Union[Meshing, PureMeshing, Solver, SolverIcing]

Notes

In job scheduler environments such as SLURM, LSF, PBS, etc… the allocated machines and core counts are queried from the scheduler environment and passed to Fluent.

ansys.fluent.core.launcher.launcher.launch_remote_fluent(session_cls, start_transcript, start_timeout=100, product_version=None, cleanup_on_exit=True, meshing_mode=False, dimensionality=None, launcher_args=None)#

Launch Fluent remotely using PyPIM <https://pypim.docs.pyansys.com>.

When calling this method, you must ensure that you are in an environment where PyPIM is configured. You can use the :func: pypim.is_configured <ansys.platform.instancemanagement.is_configured> method to verify that PYPIM is configured.

Parameters:

session_cls: Union[type(Meshing), type(PureMeshing), type(Solver), type(SolverIcing)]: Session type.
start_transcript: bool: Whether to start streaming the Fluent transcript in the client. The default is True. You can stop and start the streaming of the Fluent transcript subsequently via method calls on the session object.
start_timeoutint, optional: Maximum allowable time in seconds for connecting to the Fluent server. The default is 100.
product_versionstr, optional: Select an installed version of ANSYS. The string must be in a format like "23.1.0" (for 2023 R1) matching the documented version format in the FluentVersion class. The default is None, in which case the newest installed version is used.
cleanup_on_exitbool, optional: Whether to clean up and exit Fluent when Python exits or when garbage is collected for the Fluent Python instance. The default is True.
meshing_modebool, optional: Whether to launch Fluent remotely in meshing mode. The default is False.
dimensionalitystr, optional: Geometric dimensionality of the Fluent simulation. The default is None, in which case "3d" is used. Options are "3d" and "2d".

Returns:

Union[Meshing, PureMeshing, Solver, SolverIcing]: Session object.

Return type:

Union[Meshing, PureMeshing, Solver, SolverIcing]

ansys.fluent.core.launcher.launcher.scm_to_py(topy)#: Convert journal filenames to Python filename.