Callable PIM launcher

Provides a module for launching Fluent in pim mode.

Examples

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

>>> pim_meshing_launcher = create_launcher(LaunchMode.PIM, mode="meshing")
>>> pim_meshing_session = pim_meshing_launcher()

>>> pim_solver_launcher = create_launcher(LaunchMode.PIM)
>>> pim_solver_session = pim_solver_launcher()

Classes:

PIMLauncher(mode, ui_mode, graphics_driver)

Instantiates Fluent session in PIM mode.

Functions:

launch_remote_fluent(session_cls, ...[, ...])

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

class ansys.fluent.core.launcher.pim_launcher.PIMLauncher(mode, ui_mode, graphics_driver, product_version=None, version=None, precision=None, processor_count=None, journal_file_names=None, start_timeout=60, additional_arguments='', env=None, start_container=None, container_dict=None, dry_run=False, cleanup_on_exit=True, start_transcript=True, case_file_name=None, case_data_file_name=None, lightweight_mode=None, py=None, gpu=None, cwd=None, topy=None, start_watchdog=None, scheduler_options=None, file_transfer_service=None)

Bases: object

Instantiates Fluent session in PIM mode.

ansys.fluent.core.launcher.pim_launcher.launch_remote_fluent(session_cls, start_transcript, product_version=None, cleanup_on_exit=True, mode=FluentMode.SOLVER, dimensionality=None, launcher_args=None, file_transfer_service=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.

product_versionstr, optional

Ansys version to use. The string must be in a format like "23.2.0" (for 2023 R2), 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.

modeFluentMode, optional

Whether to launch Fluent remotely in meshing mode. The default is FluentMode.SOLVER.

dimensionalitystr, optional

Geometric dimensionality of the Fluent simulation. The default is None, in which case "3d" is used. Options are "3d" and "2d".

file_transfer_serviceoptional

File transfer service for uploading or downloading files to or from the server.

launcher_argsAny

Launcher arguments.

Returns:

Union [Meshing, PureMeshing, Solver, SolverIcing]

Session object.