container_launcher#

Provides a module for launching Fluent in container mode.

Examples#

>>> from ansys.fluent.core.launcher.launcher import create_launcher
>>> from ansys.fluent.core.launcher.pyfluent_enums import LaunchMode, FluentMode

>>> container_meshing_launcher = create_launcher(LaunchMode.CONTAINER, mode=FluentMode.MESHING)
>>> container_meshing_session = container_meshing_launcher()

>>> container_solver_launcher = create_launcher(LaunchMode.CONTAINER)
>>> container_solver_session = container_solver_launcher()

Classes:

DockerLauncher([mode, ui_mode, ...])

Instantiates Fluent session in container mode.

class ansys.fluent.core.launcher.container_launcher.DockerLauncher(mode=None, ui_mode=None, graphics_driver=None, product_version=None, dimension=None, precision=None, processor_count=None, start_timeout=60, additional_arguments='', container_dict=None, dry_run=False, cleanup_on_exit=True, start_transcript=True, py=None, gpu=None, start_watchdog=None, file_transfer_service=None)#

Bases: object

Instantiates Fluent session in container mode.

Methods:

__init__([mode, ui_mode, graphics_driver, ...])

Launch Fluent session in container mode.

__init__(mode=None, ui_mode=None, graphics_driver=None, product_version=None, dimension=None, precision=None, processor_count=None, start_timeout=60, additional_arguments='', container_dict=None, dry_run=False, cleanup_on_exit=True, start_transcript=True, py=None, gpu=None, start_watchdog=None, file_transfer_service=None)#

Launch Fluent session in container mode.

Parameters:

modeFluentMode: Launch mode of Fluent to point to a specific session type.
ui_modeUIMode: Fluent user interface mode. Options are the values of the UIMode enum.
graphics_driverFluentWindowsGraphicsDriver or FluentLinuxGraphicsDriver: Graphics driver of Fluent. Options are the values of the FluentWindowsGraphicsDriver enum in Windows or the values of the FluentLinuxGraphicsDriver enum in Linux.
product_versionFluentVersion or str or float or int, optional: Version of Ansys Fluent to launch. To use Fluent version 2024 R2, pass any of FluentVersion.v242, "24.2.0", "24.2", 24.2, or 242. The default is None, in which case the newest installed version is used.
dimensionDimension or int, optional: Geometric dimensionality of the Fluent simulation. The default is None, in which case Dimension.THREE is used. Options are either the values of the Dimension enum (Dimension.TWO or Dimension.THREE) or any of 2 and 3.
precisionPrecision or str, optional: Floating point precision. The default is None, in which case Precision.DOUBLE is used. Options are either the values of the Precision enum (Precision.SINGLE or Precision.DOUBLE) or any of "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 value of processor_count.
start_timeoutint, optional: Maximum allowable time in seconds for connecting to the Fluent server. The default is 60.
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.
container_dictdict, optional: Dictionary for Fluent Docker container configuration. The configuration settings specified in this dictionary are used to launch Fluent inside a Docker container. See also fluent_container.
dry_runbool, optional: Defaults to False. If True, will not launch Fluent, and will instead print configuration information that would be used as if Fluent was being launched. If dry running a container start, launch_fluent() will return the configured container_dict.
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, transcript.start() and transcript.stop() on the session object.
pybool, optional: If True, Fluent will run in Python mode. Default is None.
gpubool, optional: If True, Fluent will start with GPU Solver.
start_watchdogbool, optional: When cleanup_on_exit is True, start_watchdog defaults to True, which means an independent watchdog process is run to ensure that any local GUI-less Fluent sessions started by PyFluent are properly closed (or killed if frozen) when the current Python process ends.
file_transfer_serviceoptional: File transfer service. Uploads/downloads files to/from the server.

Returns:

Union [Meshing, PureMeshing, Solver, SolverIcing, dict]: Session object or configuration dictionary if dry_run = True.

Raises:

UnexpectedKeywordArgument: If an unexpected keyword argument is provided.

Notes

Job scheduler environments such as SLURM, LSF, PBS, etc. allocates resources / compute nodes. The allocated machines and core counts are queried from the scheduler environment and passed to Fluent.