refactor: Fluent Connection

src/ansys/fluent/core/fluent_connection.py

@@ -9,7 +9,7 @@
 import socket
 import subprocess
 import threading
-from typing import Any, Callable, Dict, List, Optional, Tuple, Union
+from typing import Callable, List, Optional, Tuple, Union
 import warnings
 import weakref
 
@@ -201,6 +201,68 @@ def list_values(self) -> dict:
         return vars(self)
 
 
+def _get_ip_and_port(
+    ip: Optional[str] = None, port: Optional[int] = None
+) -> (str, int):
+    if not ip:
+        ip = os.getenv("PYFLUENT_FLUENT_IP", "127.0.0.1")
+    if not port:
+        port = os.getenv("PYFLUENT_FLUENT_PORT")
+    if not port:
+        raise PortNotProvided()
+    return ip, port
+
+
+def _get_channel(ip: str, port: int):
+    # Same maximum message length is used in the server
+    max_message_length = _get_max_c_int_limit()
+    return grpc.insecure_channel(
+        f"{ip}:{port}",
+        options=[
+            ("grpc.max_send_message_length", max_message_length),
+            ("grpc.max_receive_message_length", max_message_length),
+        ],
+    )
+
+
+class _ConnectionProperties:
+    def __init__(self, scheme_eval):
+        self.scheme_eval = scheme_eval
+
+    @property
+    def fluent_build_info(self) -> str:
+        """Get Fluent build info."""
+        build_time = self.scheme_eval.scheme_eval("(inquire-build-time)")
+        build_id = self.scheme_eval.scheme_eval("(inquire-build-id)")
+        rev = self.scheme_eval.scheme_eval("(inquire-src-vcs-id)")
+        branch = self.scheme_eval.scheme_eval("(inquire-src-vcs-branch)")
+        return f"Build Time: {build_time}  Build Id: {build_id}  Revision: {rev}  Branch: {branch}"
+
+    def get_cortex_connection_properties(self):
+        """Get connection properties of Fluent."""
+        from grpc._channel import _InactiveRpcError
+
+        try:
+            logger.info(self.fluent_build_info)
+            logger.debug("Obtaining Cortex connection properties...")
+            fluent_host_pid = self.scheme_eval.scheme_eval("(cx-client-id)")
+            cortex_host = self.scheme_eval.scheme_eval("(cx-cortex-host)")
+            cortex_pid = self.scheme_eval.scheme_eval("(cx-cortex-id)")
+            cortex_pwd = self.scheme_eval.scheme_eval("(cortex-pwd)")
+            logger.debug("Cortex connection properties successfully obtained.")
+        except _InactiveRpcError:
+            logger.warning(
+                "Fluent Cortex properties unobtainable, force exit and other"
+                "methods are not going to work properly, proceeding..."
+            )
+            fluent_host_pid = None
+            cortex_host = None
+            cortex_pid = None
+            cortex_pwd = None
+
+        return fluent_host_pid, cortex_host, cortex_pid, cortex_pwd
+
+
 class FluentConnection:
     """Encapsulates a Fluent connection.
 
@@ -224,9 +286,8 @@ def __init__(
         password: Optional[str] = None,
         channel: Optional[grpc.Channel] = None,
         cleanup_on_exit: bool = True,
-        start_transcript: bool = True,
         remote_instance: Optional[Instance] = None,
-        launcher_args: Optional[Dict[str, Any]] = None,
+        slurm_job_id: Optional[str] = None,
         inside_container: Optional[bool] = None,
     ):
         """Initialize a Session.
@@ -252,14 +313,12 @@ def __init__(
             When True, the connected Fluent session will be shut down
             when PyFluent is exited or exit() is called on the session
             instance, by default True.
-        start_transcript : bool, optional
-            The Fluent transcript is started in the client only when
-            start_transcript is True. It can be started and stopped
-            subsequently via method calls on the Session object.
         remote_instance : ansys.platform.instancemanagement.Instance
             The corresponding remote instance when Fluent is launched through
             PyPIM. This instance will be deleted when calling
             ``Session.exit()``.
+        slurm_job_id: bool, optional
+            The job id of a Fluent session running within a Slurm environment.
         inside_container: bool, optional
             Whether the Fluent session that is being connected to
             is running inside a docker container.
@@ -277,22 +336,9 @@ def __init__(
         if channel is not None:
             self._channel = channel
         else:
-            if not ip:
-                ip = os.getenv("PYFLUENT_FLUENT_IP", "127.0.0.1")
-            if not port:
-                port = os.getenv("PYFLUENT_FLUENT_PORT")
+            ip, port = _get_ip_and_port(ip, port)
+            self._channel = _get_channel(ip, port)
             self._channel_str = f"{ip}:{port}"
-            if not port:
-                raise PortNotProvided()
-            # Same maximum message length is used in the server
-            max_message_length = _get_max_c_int_limit()
-            self._channel = grpc.insecure_channel(
-                f"{ip}:{port}",
-                options=[
-                    ("grpc.max_send_message_length", max_message_length),
-                    ("grpc.max_receive_message_length", max_message_length),
-                ],
-            )
         self._metadata: List[Tuple[str, str]] = (
             [("password", password)] if password else []
         )
@@ -304,7 +350,7 @@ def __init__(
         # throws, we should not proceed.
         self.health_check_service.check_health()
 
-        self._slurm_job_id = launcher_args and launcher_args.get("slurm_job_id")
+        self._slurm_job_id = slurm_job_id
 
         self._id = f"session-{next(FluentConnection._id_iter)}"
 
@@ -320,28 +366,11 @@ def __init__(
         self.scheme_eval = service_creator("scheme_eval").create(
             self._scheme_eval_service
         )
-
+        con_props = _ConnectionProperties(self.scheme_eval)
+        fluent_host_pid, cortex_host, cortex_pid, cortex_pwd = (
+            con_props.get_cortex_connection_properties()
+        )
         self._cleanup_on_exit = cleanup_on_exit
-        self.start_transcript = start_transcript
-        from grpc._channel import _InactiveRpcError
-
-        try:
-            logger.info(self.fluent_build_info)
-            logger.debug("Obtaining Cortex connection properties...")
-            fluent_host_pid = self.scheme_eval.scheme_eval("(cx-client-id)")
-            cortex_host = self.scheme_eval.scheme_eval("(cx-cortex-host)")
-            cortex_pid = self.scheme_eval.scheme_eval("(cx-cortex-id)")
-            cortex_pwd = self.scheme_eval.scheme_eval("(cortex-pwd)")
-            logger.debug("Cortex connection properties successfully obtained.")
-        except _InactiveRpcError:
-            logger.warning(
-                "Fluent Cortex properties unobtainable, force exit and other"
-                "methods are not going to work properly, proceeding..."
-            )
-            cortex_host = None
-            cortex_pid = None
-            cortex_pwd = None
-            fluent_host_pid = None
 
         if (
             (inside_container is None or inside_container is True)
@@ -371,7 +400,6 @@ def __init__(
         )
 
         self._remote_instance = remote_instance
-        self.launcher_args = launcher_args
 
         self._exit_event = threading.Event()
 
@@ -396,15 +424,6 @@ def __init__(
         )
         FluentConnection._monitor_thread.cbs.append(self._finalizer)
 
-    @property
-    def fluent_build_info(self) -> str:
-        """Get Fluent build info."""
-        build_time = self.scheme_eval.scheme_eval("(inquire-build-time)")
-        build_id = self.scheme_eval.scheme_eval("(inquire-build-id)")
-        rev = self.scheme_eval.scheme_eval("(inquire-src-vcs-id)")
-        branch = self.scheme_eval.scheme_eval("(inquire-src-vcs-branch)")
-        return f"Build Time: {build_time}  Build Id: {build_id}  Revision: {rev}  Branch: {branch}"
-
     def _close_slurm(self):
         subprocess.run(["scancel", f"{self._slurm_job_id}"])
 

src/ansys/fluent/core/launcher/container_launcher.py

@@ -227,11 +227,11 @@ def __call__(self):
                 port=port,
                 password=password,
                 cleanup_on_exit=self.cleanup_on_exit,
-                start_transcript=self.start_transcript,
-                launcher_args=self.argvals,
+                slurm_job_id=self.argvals and self.argvals.get("slurm_job_id"),
                 inside_container=True,
             ),
             file_transfer_service=self.file_transfer_service,
+            start_transcript=self.start_transcript,
         )
 
         if self.start_watchdog is None and self.cleanup_on_exit:

src/ansys/fluent/core/launcher/launcher.py

@@ -359,7 +359,6 @@ def connect_to_fluent(
         port=port,
         password=password,
         cleanup_on_exit=cleanup_on_exit,
-        start_transcript=start_transcript,
     )
     new_session = _get_running_session_mode(fluent_connection)
 
@@ -374,4 +373,5 @@ def connect_to_fluent(
 
     return new_session(
         fluent_connection=fluent_connection,
+        start_transcript=start_transcript,
     )

src/ansys/fluent/core/launcher/pim_launcher.py

@@ -292,8 +292,7 @@ def launch_remote_fluent(
         channel=channel,
         cleanup_on_exit=cleanup_on_exit,
         remote_instance=instance,
-        start_transcript=start_transcript,
-        launcher_args=launcher_args,
+        slurm_job_id=launcher_args and launcher_args.get("slurm_job_id"),
     )
 
     file_transfer_service = (
@@ -303,5 +302,7 @@ def launch_remote_fluent(
     )
 
     return session_cls(
-        fluent_connection=fluent_connection, file_transfer_service=file_transfer_service
+        fluent_connection=fluent_connection,
+        file_transfer_service=file_transfer_service,
+        start_transcript=start_transcript,
     )

src/ansys/fluent/core/launcher/watchdog_exec

@@ -74,8 +74,7 @@ if __name__ == "__main__":
             "ip": ip,
             "port": int(port),
             "password": password,
-            "launcher_args": None,
-            "start_transcript": False,
+            "slurm_job_id": None,
             "cleanup_on_exit": True,
         }
 

src/ansys/fluent/core/session.py

@@ -3,7 +3,7 @@
 import importlib
 import json
 import logging
-from typing import Any, Optional, Union
+from typing import Any, Dict, Optional, Union
 import warnings
 
 from ansys.fluent.core.fluent_connection import FluentConnection
@@ -93,13 +93,24 @@ def __init__(
         self,
         fluent_connection: FluentConnection,
         file_transfer_service: Optional[Any] = None,
+        start_transcript: bool = True,
+        launcher_args: Optional[Dict[str, Any]] = None,
     ):
         """BaseSession.
 
-        Args:
-            fluent_connection (:ref:`ref_fluent_connection`): Encapsulates a Fluent connection.
-            file_transfer_service: Supports file upload and download.
+        Parameters
+        ----------
+        fluent_connection (:ref:`ref_fluent_connection`):
+            Encapsulates a Fluent connection.
+        file_transfer_service:
+            Supports file upload and download.
+        start_transcript : bool, optional
+            The Fluent transcript is started in the client only when
+            start_transcript is True. It can be started and stopped
+            subsequently via method calls on the Session object.
         """
+        self._start_transcript = start_transcript
+        self._launcher_args = launcher_args
         BaseSession.build_from_fluent_connection(
             self, fluent_connection, file_transfer_service
         )
@@ -122,7 +133,7 @@ def build_from_fluent_connection(
             fluent_connection._channel, fluent_connection._metadata
         )
         self.transcript = Transcript(self._transcript_service)
-        if fluent_connection.start_transcript:
+        if self._start_transcript:
             self.transcript.start()
 
         self.datamodel_service_tui = service_creator("tui").create(
@@ -260,6 +271,8 @@ def _create_from_server_info_file(
         cls,
         server_info_file_name: str,
         file_transfer_service: Optional[Any] = None,
+        start_transcript: bool = True,
+        launcher_args: Optional[Dict[str, Any]] = None,
         **connection_kwargs,
     ):
         """Create a Session instance from server-info file.
@@ -270,9 +283,13 @@ def _create_from_server_info_file(
             Path to server-info file written out by Fluent server
         file_transfer_service : Optional
             Support file upload and download.
+        start_transcript : bool, optional
+            The Fluent transcript is started in the client only when
+            start_transcript is True. It can be started and stopped
+            subsequently via method calls on the Session object.
         **connection_kwargs : dict, optional
             Additional keyword arguments may be specified, and they will be passed to the `FluentConnection`
-            being initialized. For example, ``cleanup_on_exit = True``, or ``start_transcript = True``.
+            being initialized. For example, ``cleanup_on_exit = True``.
             See :func:`FluentConnection initialization <ansys.fluent.core.fluent_connection.FluentConnection.__init__>`
             for more details and possible arguments.
 
@@ -287,6 +304,8 @@ def _create_from_server_info_file(
                 ip=ip, port=port, password=password, **connection_kwargs
             ),
             file_transfer_service=file_transfer_service,
+            start_transcript=start_transcript,
+            launcher_args=launcher_args,
         )
         return session
 

src/ansys/fluent/core/session_meshing.py

@@ -1,6 +1,6 @@
 """Module containing class encapsulating Fluent connection."""
 
-from typing import Any, Optional
+from typing import Any, Dict, Optional
 
 from ansys.fluent.core.fluent_connection import FluentConnection
 from ansys.fluent.core.session_pure_meshing import PureMeshing
@@ -21,6 +21,8 @@ def __init__(
         self,
         fluent_connection: FluentConnection,
         file_transfer_service: Optional[Any] = None,
+        start_transcript: bool = True,
+        launcher_args: Optional[Dict[str, Any]] = None,
     ):
         """Meshing session.
 
@@ -31,6 +33,8 @@ def __init__(
         super(Meshing, self).__init__(
             fluent_connection=fluent_connection,
             file_transfer_service=file_transfer_service,
+            start_transcript=start_transcript,
+            launcher_args=launcher_args,
         )
         self.switch_to_solver = lambda: self._switch_to_solver()
         self.switched = False

src/ansys/fluent/core/session_pure_meshing.py

@@ -1,7 +1,7 @@
 """Module containing class encapsulating Fluent connection."""
 
 import functools
-from typing import Any, Optional
+from typing import Any, Dict, Optional
 
 import ansys.fluent.core as pyfluent
 from ansys.fluent.core.data_model_cache import DataModelCache, NameKey
@@ -31,6 +31,8 @@ def __init__(
         self,
         fluent_connection: FluentConnection,
         file_transfer_service: Optional[Any] = None,
+        start_transcript: bool = True,
+        launcher_args: Optional[Dict[str, Any]] = None,
     ):
         """PureMeshing session.
 
@@ -41,6 +43,8 @@ def __init__(
         super(PureMeshing, self).__init__(
             fluent_connection=fluent_connection,
             file_transfer_service=file_transfer_service,
+            start_transcript=start_transcript,
+            launcher_args=launcher_args,
         )
         self._base_meshing = BaseMeshing(
             self.execute_tui,