ansys-fluent-core 0.28.1__py3-none-any.whl → 0.29.0__py3-none-any.whl

ansys/fluent/core/launcher/pim_launcher.py

@@ -1,3 +1,25 @@
+# Copyright (C) 2021 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
 """Provides a module for launching Fluent in pim mode.
 
 Examples
@@ -24,7 +46,6 @@ from ansys.fluent.core.launcher.pyfluent_enums import (
     FluentMode,
     FluentWindowsGraphicsDriver,
     Precision,
-    UIMode,
     _get_argvals_and_session,
 )
 from ansys.fluent.core.session_meshing import Meshing
@@ -46,7 +67,6 @@ class PIMLauncher:
     def __init__(
         self,
         mode: FluentMode | str | None = None,
-        ui_mode: UIMode | str | None = None,
         graphics_driver: (
             FluentWindowsGraphicsDriver | FluentLinuxGraphicsDriver | str | None
         ) = None,
@@ -55,76 +75,60 @@ class PIMLauncher:
         precision: Precision | str | None = None,
         processor_count: int | None = None,
         start_timeout: int = 60,
-        additional_arguments: str | None = "",
+        additional_arguments: str = "",
         cleanup_on_exit: bool = True,
         start_transcript: bool = True,
-        py: bool | None = None,
         gpu: bool | None = None,
         start_watchdog: bool | None = None,
         file_transfer_service: Any | None = None,
     ):
-        """Launch Fluent session in `PIM <https://pypim.docs.pyansys.com/version/stable/>`_ mode.
+        """
+        Launch a Fluent session in `PIM <https://pypim.docs.pyansys.com/version/stable/>`_ mode.
 
         Parameters
         ----------
         mode : FluentMode
-            Launch mode of Fluent to point to a specific session type.
-        ui_mode : UIMode
-            Fluent user interface mode. Options are the values of the ``UIMode`` enum.
+            Specifies the launch mode of Fluent for targeting a specific session type.
         graphics_driver : FluentWindowsGraphicsDriver 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.
+            Specifies the graphics driver for Fluent. Options are from the ``FluentWindowsGraphicsDriver`` enum
+            (for Windows) or the ``FluentLinuxGraphicsDriver`` enum (for Linux).
         product_version : FluentVersion or str or float or int, optional
-            Version of Ansys Fluent to launch. To use Fluent version 2024 R2, pass
-           ``FluentVersion.v242``, ``"24.2.0"``, ``"24.2"``, ``24.2``, or ``242``.
-            The default is ``None``, in which case the newest installed version is used.
+            Indicates the version of Ansys Fluent to launch. For example, to use version 2025 R1, pass
+            any of ``FluentVersion.v251``, ``"25.1.0"``, ``"25.1"``, ``25.1``, or ``251``. Defaults to ``None``,
+            which uses the newest installed version.
         dimension : Dimension 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``.
+            Specifies the geometric dimensionality of the Fluent simulation. Defaults to ``None``,
+            which corresponds to ``Dimension.THREE``. Acceptable values include ``Dimension.TWO``,
+            ``Dimension.THREE``, or integers ``2`` and ``3``.
         precision : Precision 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"``.
+            Defines the floating point precision. Defaults to ``None``, which corresponds to
+            ``Precision.DOUBLE``. Acceptable values include ``Precision.SINGLE``,
+            ``Precision.DOUBLE``, or strings ``"single"`` and ``"double"``.
         processor_count : int, 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``.
+            Specifies the number of processors to use. Defaults to ``None``, which uses 1 processor.
+            In job scheduler environments, this value limits the total number of allocated cores.
         start_timeout : int, optional
-            Maximum allowable time in seconds for connecting to the Fluent
-            server. The default is ``60``.
+            Maximum allowable time in seconds for connecting to the Fluent server. Defaults to 60 seconds.
         additional_arguments : str, optional
-            Additional arguments to send to Fluent as a string in the same
-            format they are normally passed to Fluent on the command line.
-        cleanup_on_exit : bool, 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_transcript : bool, 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.
-        py : bool, optional
-            If True, Fluent will run in Python mode. Default is None.
+            Additional command-line arguments for Fluent, formatted as they would be on the command line.
+        cleanup_on_exit : bool
+            Determines whether to shut down the connected Fluent session upon exit or when calling
+            the session's `exit()` method. Defaults to True.
+        start_transcript : bool
+            Indicates whether to start streaming the Fluent transcript in the client. Defaults to True;
+            streaming can be controlled via `transcript.start()` and `transcript.stop()` methods on the session object.
         gpu : bool, optional
-            If True, Fluent will start with GPU Solver.
+            If True, starts Fluent with GPU Solver enabled.
         start_watchdog : bool, 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_service : optional
-            File transfer service. Uploads/downloads files to/from the server.
+            If True and `cleanup_on_exit` is True, an independent watchdog process is run to ensure that any local
+            GUI-less Fluent sessions started by PyFluent are properly closed when the current Python process ends.
+        file_transfer_service : Any, optional
+            Service for uploading/downloading files to/from the server.
 
         Returns
         -------
-        :obj:`~typing.Union` [:class:`Meshing<ansys.fluent.core.session_meshing.Meshing>`, \
-        :class:`~ansys.fluent.core.session_pure_meshing.PureMeshing`, \
-        :class:`~ansys.fluent.core.session_solver.Solver`, \
-        :class:`~ansys.fluent.core.session_solver_icing.SolverIcing`, dict]
-            Session object or configuration dictionary if ``dry_run = True``.
+        Union[Meshing, PureMeshing, Solver, SolverIcing, dict]
+            Session object or configuration dictionary if ``dry_run`` is True.
 
         Raises
         ------
@@ -133,10 +137,10 @@ class PIMLauncher:
 
         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.
+        In job scheduler environments (e.g., SLURM, LSF, PBS), resources and compute nodes are allocated,
+        and core counts are queried from these environments before being passed to Fluent.
         """
+
         if additional_arguments:
             logger.warning(
                 "'additional_arguments' option for 'launch_fluent()' method is not supported "
@@ -186,9 +190,8 @@ def launch_remote_fluent(
 ) -> Meshing | PureMeshing | Solver | SolverIcing:
     """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>`
+    Ensure that you are in an environment where PyPIM is configured.
+    Use the :func:`pypim.is_configured <ansys.platform.instancemanagement.is_configured>`
     method to verify that PyPIM is configured.
 
     Parameters
@@ -196,58 +199,48 @@ def launch_remote_fluent(
     session_cls: 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.
+        Whether to start streaming the Fluent transcript in the client.
     product_version : str, optional
-        Version of Ansys Fluent to launch. Use ``"242"`` for 2024 R2.
-        The default is ``None``, in which case the newest installed version is used.
+        Version of Ansys Fluent to launch. Default is ``None`` for the newest version.
     cleanup_on_exit : bool, 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``.
+        Whether to clean up and exit Fluent when Python exits. Default is ``True``.
     mode : FluentMode, optional
-        Whether to launch Fluent remotely in meshing mode. The default is
-        ``FluentMode.SOLVER``.
+        Launch Fluent in meshing mode. Default is ``FluentMode.SOLVER``.
     dimensionality : str, optional
-        Geometric dimensionality of the Fluent simulation. The default is ``None``,
-        in which case ``"3d"`` is used. Options are ``"3d"`` and ``"2d"``.
+        Geometric dimensionality of the Fluent simulation. Default is ``None`` (3D).
     file_transfer_service : optional
-        File transfer service for uploading or downloading files to or from the server.
+        Service for uploading/downloading files to/from the server.
     launcher_args : Any
         Launcher arguments.
 
     Returns
     -------
-    :obj:`~typing.Union` [:class:`Meshing<ansys.fluent.core.session_meshing.Meshing>`, \
-    :class:`~ansys.fluent.core.session_pure_meshing.PureMeshing`, \
-    :class:`~ansys.fluent.core.session_solver.Solver`, \
-    :class:`~ansys.fluent.core.session_solver_icing.SolverIcing`]
+    Meshing | PureMeshing | Solver | SolverIcing
         Session object.
     """
+
     pim = pypim.connect()
-    instance = pim.create_instance(
-        product_name=(
-            "fluent-meshing"
-            if FluentMode.is_meshing(mode)
-            else "fluent-2ddp" if dimensionality == "2d" else "fluent-3ddp"
-        ),
+
+    instance = create_fluent_instance(
+        pim=pim,
+        mode=mode,
+        dimensionality=dimensionality,
         product_version=product_version,
     )
+
     instance.wait_for_ready()
-    # nb pymapdl sets max msg len here:
+
     channel = instance.build_grpc_channel()
 
-    fluent_connection = FluentConnection(
+    fluent_connection = create_fluent_connection(
         channel=channel,
         cleanup_on_exit=cleanup_on_exit,
-        remote_instance=instance,
-        slurm_job_id=launcher_args and launcher_args.get("slurm_job_id"),
+        instance=instance,
+        launcher_args=launcher_args,
     )
 
-    file_transfer_service = (
-        file_transfer_service
-        if file_transfer_service
-        else PimFileTransferService(pim_instance=fluent_connection._remote_instance)
+    file_transfer_service = get_file_transfer_service(
+        file_transfer_service, fluent_connection
     )
 
     return session_cls(
@@ -256,3 +249,44 @@ def launch_remote_fluent(
         file_transfer_service=file_transfer_service,
         start_transcript=start_transcript,
     )
+
+
+def create_fluent_instance(
+    pim, mode: FluentMode, dimensionality: str | None, product_version: str | None
+):
+    """Create a Fluent instance based on mode and dimensionality."""
+
+    product_name = (
+        "fluent-meshing"
+        if FluentMode.is_meshing(mode)
+        else "fluent-2ddp" if dimensionality == Dimension.TWO else "fluent-3ddp"
+    )
+
+    return pim.create_instance(
+        product_name=product_name, product_version=product_version
+    )
+
+
+def create_fluent_connection(
+    channel, cleanup_on_exit: bool, instance, launcher_args: Dict[str, Any] | None
+):
+    """Create a Fluent connection."""
+
+    return FluentConnection(
+        channel=channel,
+        cleanup_on_exit=cleanup_on_exit,
+        remote_instance=instance,
+        slurm_job_id=launcher_args.get("slurm_job_id") if launcher_args else None,
+    )
+
+
+def get_file_transfer_service(
+    file_transfer_service: Any | None, fluent_connection
+) -> Any:
+    """Get the file transfer service."""
+
+    return (
+        file_transfer_service
+        if file_transfer_service
+        else PimFileTransferService(pim_instance=fluent_connection._remote_instance)
+    )

ansys/fluent/core/launcher/process_launch_string.py

@@ -1,3 +1,25 @@
+# Copyright (C) 2021 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
 """Provides a module to process launch string."""
 
 import json

ansys/fluent/core/launcher/pyfluent_enums.py

@@ -1,3 +1,25 @@
+# Copyright (C) 2021 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
 """Provides a module for enums used in the PyFluent."""
 
 from enum import Enum

ansys/fluent/core/launcher/server_info.py

@@ -1,3 +1,25 @@
+# Copyright (C) 2021 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
 """Provides a module for server information."""
 
 import os
@@ -6,7 +28,7 @@ import tempfile
 
 from ansys.fluent.core.fluent_connection import PortNotProvided
 from ansys.fluent.core.launcher import launcher_utils
-from ansys.fluent.core.launcher.error_handler import IpPortNotProvided
+from ansys.fluent.core.launcher.error_handler import InvalidIpPort, IpPortNotProvided
 from ansys.fluent.core.session import _parse_server_info_file
 
 
@@ -45,6 +67,27 @@ def _get_server_info_file_names(use_tmpdir=True) -> tuple[str, str]:
         return file_name, file_name
 
 
+def _check_ip_port(ip: str, port: int):
+    """Check if a port is open on a given IP address."""
+
+    if not (ip and port):
+        raise IpPortNotProvided()
+
+    if not port:
+        raise PortNotProvided()
+
+    import socket
+
+    sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+    sock.settimeout(2)
+    try:
+        result = sock.connect_ex((ip, port))
+        if result != 0:
+            raise InvalidIpPort()
+    finally:
+        sock.close()
+
+
 def _get_server_info(
     server_info_file_name: str,
     ip: str | None = None,
@@ -65,7 +108,6 @@ def _get_server_info(
         ip = ip or os.getenv("PYFLUENT_FLUENT_IP", "127.0.0.1")
         port = port or os.getenv("PYFLUENT_FLUENT_PORT")
 
-    if not port:
-        raise PortNotProvided()
+    _check_ip_port(ip=ip, port=port)
 
     return ip, port, password

ansys/fluent/core/launcher/slurm_launcher.py

@@ -1,3 +1,25 @@
+# Copyright (C) 2021 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
 """Provides a module for launching Fluent within a Slurm environment.
 
 Examples
@@ -272,7 +294,7 @@ class SlurmLauncher:
         processor_count: int | None = None,
         journal_file_names: None | str | list[str] = None,
         start_timeout: int = -1,
-        additional_arguments: str | None = "",
+        additional_arguments: str = "",
         env: Dict[str, Any] | None = None,
         cleanup_on_exit: bool = True,
         start_transcript: bool = True,
@@ -301,8 +323,8 @@ class SlurmLauncher:
             ``FluentWindowsGraphicsDriver`` enum in Windows or the values of the
             ``FluentLinuxGraphicsDriver`` enum in Linux.
         product_version : FluentVersion or str or float or int, optional
-            Version of Ansys Fluent to launch. To use Fluent version 2024 R2, pass
-            ``FluentVersion.v242``, ``"24.2.0"``, ``"24.2"``, ``24.2``, or ``242``.
+            Version of Ansys Fluent to launch. To use Fluent version 2025 R1, pass
+            ``FluentVersion.v251``, ``"25.1.0"``, ``"25.1"``, ``25.1``, or ``251``.
             The default is ``None``, in which case the newest installed version is used.
         dimension : Dimension or int, optional
             Geometric dimensionality of the Fluent simulation. The default is ``None``,