ansys-fluent-core 0.14.dev1__py3-none-any.whl → 0.14.dev2__py3-none-any.whl

ansys/fluent/core/__init__.py

@@ -18,7 +18,7 @@ from ansys.fluent.core.session import BaseSession as Fluent  # noqa: F401
 from ansys.fluent.core.utils import fldoc
 from ansys.fluent.core.utils.setup_for_fluent import setup_for_fluent  # noqa: F401
 
-_VERSION_INFO = "Build date: April 26, 2023 14:30 UTC ShaID: a5928c90c"
+_VERSION_INFO = "Build date: May 19, 2023 17:23 UTC ShaID: 162e819"
 """Global variable indicating the version of the PyFluent package - Empty by default"""
 
 _THIS_DIRNAME = os.path.dirname(__file__)
@@ -56,17 +56,8 @@ with open(yaml_path, "rt") as f:
 logging.config.dictConfig(config)
 
 # Setup data directory
-try:
-    USER_DATA_PATH = appdirs.user_data_dir("ansys_fluent_core")
-    if not os.path.exists(USER_DATA_PATH):
-        os.makedirs(USER_DATA_PATH)
-
-    EXAMPLES_PATH = os.path.join(USER_DATA_PATH, "examples")
-    if not os.path.exists(EXAMPLES_PATH):
-        os.makedirs(EXAMPLES_PATH)
-
-except Exception:
-    pass
+USER_DATA_PATH = appdirs.user_data_dir(appname="ansys_fluent_core", appauthor="Ansys")
+EXAMPLES_PATH = os.path.join(USER_DATA_PATH, "examples")
 
 BUILDING_GALLERY = False
 
@@ -77,3 +68,12 @@ INFER_REMOTING_IP = True
 INFER_REMOTING_IP_TIMEOUT_PER_IP = 2
 
 pydoc.text.docother = fldoc.docother.__get__(pydoc.text, pydoc.TextDoc)
+
+# Whether to use datamodel state caching
+DATAMODEL_USE_STATE_CACHE = True
+
+# Whether to use datamodel attribute caching
+DATAMODEL_USE_ATTR_CACHE = True
+
+# Whether stream and cache commands state
+DATAMODEL_USE_NOCOMMANDS_DIFF_STATE = True

ansys/fluent/core/_version.py

@@ -6,7 +6,7 @@ version_info = 0, 1, 'dev0'
 """
 
 # major, minor, patch
-version_info = 0, 14, "dev1"
+version_info = 0, 14, "dev2"
 
 # Nice string for the version
 __version__ = ".".join(map(str, version_info))

ansys/fluent/core/docs/README.rst

@@ -10,12 +10,12 @@ PyFluent
    :target: https://pypi.org/project/ansys-fluent-core
    :alt: PyPI
 
-.. |GH-CI| image:: https://github.com/pyansys/pyfluent/actions/workflows/ci.yml/badge.svg
-   :target: https://github.com/pyansys/pyfluent/actions/workflows/ci.yml
+.. |GH-CI| image:: https://github.com/ansys/pyfluent/actions/workflows/ci.yml/badge.svg
+   :target: https://github.com/ansys/pyfluent/actions/workflows/ci.yml
    :alt: GH-CI
 
-.. |codecov| image:: https://codecov.io/gh/pyansys/pyfluent/branch/main/graph/badge.svg
-   :target: https://codecov.io/gh/pyansys/pyfluent
+.. |codecov| image:: https://codecov.io/gh/ansys/pyfluent/branch/main/graph/badge.svg
+   :target: https://codecov.io/gh/ansys/pyfluent
 
 .. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
    :target: https://opensource.org/licenses/MIT
@@ -25,8 +25,8 @@ PyFluent
    :target: https://github.com/psf/black
    :alt: Black
 
-.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/pyansys/pyfluent/main.svg
-   :target: https://results.pre-commit.ci/latest/github/pyansys/pyfluent/main
+.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/ansys/pyfluent/main.svg
+   :target: https://results.pre-commit.ci/latest/github/ansys/pyfluent/main
    :alt: pre-commit.ci status
 
 Overview
@@ -44,14 +44,14 @@ Documentation and issues
 For comprehensive information on PyFluent, see the latest release
 `documentation <https://fluent.docs.pyansys.com>`_.
 
-On the `PyFluent Issues <https://github.com/pyansys/pyfluent/issues>`_ page, you can create
+On the `PyFluent Issues <https://github.com/ansys/pyfluent/issues>`_ page, you can create
 issues to submit questions, report bugs, and request new features. To reach
 the project support team, email `pyansys.core@ansys.com <pyansys.core@ansys.com>`_.
 
 Installation
 ------------
-The ``ansys-fluent-core`` package supports Python 3.7 through Python
-3.10 on Windows and Linux.
+The ``ansys-fluent-core`` package supports Python 3.8 through Python
+3.11 on Windows and Linux.
 
 Install the latest release from `PyPI
 <https://pypi.org/project/ansys-fluent-core/>`_ with:
@@ -65,7 +65,7 @@ the latest release with:
 
 .. code:: console
 
-   git clone https://github.com/pyansys/pyfluent.git
+   git clone https://github.com/ansys/pyfluent.git
    cd pyfluent
    pip install pip -U
    pip install -e .
@@ -74,7 +74,22 @@ the latest release with:
 Dependencies
 ------------
 You must have a licensed copy of Ansys Fluent installed locally. PyFluent
-supports Fluent 2022 R2 and later.
+supports Fluent 2022 R2 and later. The Windows installation of Ansys Fluent automatically
+sets the required environment variables so that PyFluent can find the Ansys Fluent
+installation. Using Fluent 2023 R1 (or 23.1) installed in the default directory as an
+example, the installer automatically sets the ``AWP_ROOT231`` environment variable to point
+to ``C:\Program Files\ANSYS Inc\v231``.
+
+On Linux, the required environment variable is not set automatically, and can be set for the
+current user in the current shell session, using Fluent 2023 R1 in the default installation
+directory as an example, before running PyFluent, with:
+
+.. code:: console
+
+    export AWP_ROOT231=/usr/ansys_inc/v231
+
+For this setting to persist between different shell sessions for the current user, the same
+export command can instead be added to the user's ``~/.profile`` file.
 
 Getting started
 ---------------
@@ -89,21 +104,6 @@ To launch Fluent from Python, use the ``launch_fluent`` method:
   solver_session = pyfluent.launch_fluent(mode="solver")
   solver_session.health_check_service.is_serving
 
-On Windows systems the environment variable ``AWP_ROOT<ver>`` is configured
-when Fluent is installed, where ``<ver>`` is the Fluent release number such as
-``231`` for release 2023 R1. PyFluent automatically uses this environment
-variable to locate the latest Fluent installation. On Linux systems configure
-``AWP_ROOT<ver>`` to point to the absolute path of an Ansys installation such as
-``/apps/ansys_inc/v231``.
-
-To use a non-default installation location set ``AWP_ROOT<ver>`` or set the
-``PYFLUENT_FLUENT_ROOT`` environment variable to the ``<install location>/<version>/fluent`` directory,
-where ``<version>`` is the Fluent release that you would like to use.
-For example, ``v231`` uses release 2023 R1.
-
-For information on other ways of specifying the Fluent location for PyFluent,
-see `Frequently asked questions <https://fluent.docs.pyansys.com/release/0.12/getting_started/faqs.html>`_.
-
 Basic usage
 ~~~~~~~~~~~
 You can use the ``solver_session.tui`` interface to run all Fluent TUI commands:

ansys/fluent/core/examples/downloads.py

@@ -8,7 +8,9 @@ Examples
 >>> filename
 '/home/user/.local/share/ansys_fluent_core/examples/bracket.iges'
 """
+import logging
 import os
+import re
 import shutil
 from typing import Optional
 import urllib.request
@@ -17,12 +19,6 @@ import zipfile
 import ansys.fluent.core as pyfluent
 
 
-def get_ext(filename: str) -> str:
-    """Extract the extension of a file."""
-    ext = os.path.splitext(filename)[1].lower()
-    return ext
-
-
 def delete_downloads() -> bool:
     """Delete all downloaded examples to free space or update the files."""
     shutil.rmtree(pyfluent.EXAMPLES_PATH)
@@ -45,25 +41,41 @@ def _get_file_url(filename: str, directory: Optional[str] = None) -> str:
     return f"https://github.com/pyansys/example-data/raw/master/{filename}"
 
 
-def _retrieve_file(url: str, filename: str):
+def _retrieve_file(url: str, filename: str, save_path: Optional[str] = None) -> str:
+    if save_path is None:
+        save_path = pyfluent.EXAMPLES_PATH
+    else:
+        save_path = os.path.abspath(save_path)
+    local_path = os.path.join(save_path, os.path.basename(filename))
+    local_path_no_zip = re.sub(".zip$", "", local_path)
     # First check if file has already been downloaded
-    local_path = os.path.join(pyfluent.EXAMPLES_PATH, os.path.basename(filename))
-    local_path_no_zip = local_path.replace(".zip", "")
     if os.path.isfile(local_path_no_zip) or os.path.isdir(local_path_no_zip):
-        return local_path_no_zip, None
+        logging.info("File already exists.")
+        logging.info(f"File path: {local_path_no_zip}")
+        return local_path_no_zip
+
+    logging.info("Downloading specified file...")
+
+    # Check if save path exists
+    if not os.path.exists(save_path):
+        os.makedirs(save_path)
 
     # grab the correct url retriever
     urlretrieve = urllib.request.urlretrieve
 
     # Perform download
-    saved_file, resp = urlretrieve(url)
+    saved_file, _ = urlretrieve(url)
     shutil.move(saved_file, local_path)
-    if get_ext(local_path) in [".zip"]:
+    if local_path.endswith(".zip"):
         _decompress(local_path)
-        local_path = local_path[:-4]
-    return local_path, resp
+        local_path = local_path_no_zip
+    logging.info("Download successful.")
+    logging.info(f"File path: {local_path}")
+    return local_path
 
 
-def download_file(filename: str, directory: Optional[str] = None):
+def download_file(
+    filename: str, directory: Optional[str] = None, save_path: Optional[str] = None
+):
     url = _get_file_url(filename, directory)
-    return _retrieve_file(url, filename)[0]
+    return _retrieve_file(url, filename, save_path)

ansys/fluent/core/filereader/case_file.py

@@ -49,6 +49,12 @@ class InputParameter:
                 self.name = v.strip('"')
             elif k == "definition":
                 self.value = v.strip('"')
+                if "[" in self.value:
+                    sep_index = self.value.index("[")
+                    if not self.value[sep_index - 1] == " ":
+                        self.value = "".join(
+                            (self.value[:sep_index], " ", self.value[sep_index:])
+                        )
 
     @property
     def units(self) -> str:
@@ -183,32 +189,35 @@ class CaseFile:
                 raise FileNotFoundError(
                     "Please provide a valid fluent project file path"
                 )
+
         try:
-            if "".join(Path(case_filepath).suffixes) == ".cas.h5":
+            if Path(case_filepath).match("*.cas.h5"):
                 file = h5py.File(case_filepath)
                 settings = file["settings"]
                 rpvars = settings["Rampant Variables"][0]
                 rp_vars_str = rpvars.decode()
-            elif Path(case_filepath).suffix == ".cas":
+            elif Path(case_filepath).match("*.cas"):
                 with open(case_filepath, "rb") as file:
                     rp_vars_str = file.read()
                 rp_vars_str = _get_processed_string(rp_vars_str)
-            elif "".join(Path(case_filepath).suffixes) == ".cas.gz":
+            elif Path(case_filepath).match("*.cas.gz"):
                 with gzip.open(case_filepath, "rb") as file:
                     rp_vars_str = file.read()
                 rp_vars_str = _get_processed_string(rp_vars_str)
             else:
-                raise RuntimeError()
+                error_message = (
+                    "Could not read case file. "
+                    "Only valid Case files (.h5, .cas, .cas.gz) can be read. "
+                )
+                raise RuntimeError(error_message)
 
         except FileNotFoundError as e:
-            raise RuntimeError(f"The case file {case_filepath} cannot be found.") from e
+            raise FileNotFoundError(
+                f"The case file {case_filepath} cannot be found."
+            ) from e
 
-        except OSError:
-            error_message = (
-                "Could not read case file. "
-                "Only valid Case files (.h5, .cas, .cas.gz) can be read. "
-            )
-            raise RuntimeError(error_message)
+        except OSError as e:
+            raise OSError(f"Error while reading case file {case_filepath}") from e
 
         except BaseException as e:
             raise RuntimeError(f"Could not read case file {case_filepath}") from e

ansys/fluent/core/launcher/fluent_container.py

@@ -55,7 +55,7 @@ def start_fluent_container(mounted_from: str, mounted_to: str, args: List[str])
                 f"REMOTING_PORTS={port}/portspan=2",
                 "-l",
                 f"test_name={test_name}",
-                f"ghcr.io/pyansys/pyfluent:{image_tag}",
+                f"ghcr.io/ansys/pyfluent:{image_tag}",
                 "-gu",
                 f"-sifile={container_sifile}",
             ]

ansys/fluent/core/launcher/fluent_launcher_options.json

@@ -40,5 +40,15 @@
             "false": ""
         },
         "fluent_format": "{}"
+    },
+    "gpu": {
+        "type": "bool",
+        "default": "null",
+        "fluent_required": false,
+        "fluent_map": {
+            "true": " -gpu",
+            "false": ""
+        },
+        "fluent_format": "{}"
     }
 }

ansys/fluent/core/launcher/launcher.py

@@ -39,6 +39,7 @@ def _is_windows():
 class FluentVersion(Enum):
     """An enumeration over supported Fluent versions."""
 
+    version_24R1 = "24.1.0"
     version_23R2 = "23.2.0"
     version_23R1 = "23.1.0"
     version_22R2 = "22.2.0"
@@ -52,9 +53,9 @@ class FluentVersion(Enum):
                     return FluentVersion(version)
             else:
                 raise RuntimeError(
-                    f"The passed version '{version[:-2]}' does not exist."
-                    f" Available version strings are: "
-                    f"{[ver.value for ver in FluentVersion]} "
+                    f"The specified version '{version[:-2]}' is not supported."
+                    + f" Supported versions are: "
+                    + ", ".join([ver.value for ver in FluentVersion][::-1])
                 )
 
     def __str__(self):
@@ -76,9 +77,8 @@ def get_ansys_version() -> str:
 def get_fluent_exe_path(**launch_argvals) -> Path:
     """Get Fluent executable path. The path is searched in the following order.
 
-    1. ``PYFLUENT_FLUENT_ROOT`` environment variable.
-    2. ``product_version`` parameter passed with ``launch_fluent``.
-    3. The latest ANSYS version from ``AWP_ROOTnnn``` environment variables.
+    1. ``product_version`` parameter passed with ``launch_fluent``.
+    2. The latest ANSYS version from ``AWP_ROOTnnn``` environment variables.
 
     Returns
     -------
@@ -96,18 +96,18 @@ def get_fluent_exe_path(**launch_argvals) -> Path:
         else:
             return fluent_root / "bin" / "fluent"
 
-    # Look for Fluent exe path in the following order:
-    # 1. "PYFLUENT_FLUENT_ROOT" environment variable
+    # (DEV) "PYFLUENT_FLUENT_ROOT" environment variable
     fluent_root = os.getenv("PYFLUENT_FLUENT_ROOT")
     if fluent_root:
         return get_exe_path(Path(fluent_root))
 
-    # 2. product_version parameter passed with launch_fluent
+    # Look for Fluent exe path in the following order:
+    # 1. product_version parameter passed with launch_fluent
     product_version = launch_argvals.get("product_version")
     if product_version:
         return get_exe_path(get_fluent_root(FluentVersion(product_version)))
 
-    # 3. the latest ANSYS version from AWP_ROOT environment variables
+    # 2. the latest ANSYS version from AWP_ROOT environment variables
     ansys_version = get_ansys_version()
     return get_exe_path(get_fluent_root(FluentVersion(ansys_version)))
 
@@ -304,8 +304,9 @@ def _get_session_info(argvals, mode: Union[LaunchMode, str, None] = None):
 
 def _raise_exception_g_gu_in_windows_os(additional_arguments: str) -> None:
     """If -g or -gu is passed in Windows OS, the exception should be raised."""
+    additional_arg_list = additional_arguments.split()
     if _is_windows() and (
-        ("-g" in additional_arguments) or ("-gu" in additional_arguments)
+        ("-g" in additional_arg_list) or ("-gu" in additional_arg_list)
     ):
         raise ValueError("'-g' and '-gu' is not supported on windows platform.")
 
@@ -459,6 +460,7 @@ def launch_fluent(
     server_info_filepath: str = None,
     password: str = None,
     py: bool = None,
+    gpu: bool = None,
     cwd: str = None,
     topy: Union[str, list] = None,
     **kwargs,
@@ -550,6 +552,8 @@ def launch_fluent(
         Password to connect to existing Fluent instance.
     py : bool, optional
         If True, Fluent will run in Python mode. Default is None.
+    gpu : bool, optional
+        If True, Fluent will start with GPU Solver.
     cwd: str, Optional
         Path to specify current working directory to launch fluent from the defined directory as
         current working directory.
@@ -645,11 +649,17 @@ def launch_fluent(
             logger.info(
                 "Starting Fluent remotely. The startup configuration will be ignored."
             )
+
+            if product_version:
+                fluent_product_version = "".join(product_version.split("."))[:-1]
+            else:
+                fluent_product_version = "latest"
+
             return launch_remote_fluent(
                 session_cls=new_session,
                 start_timeout=start_timeout,
                 start_transcript=start_transcript,
-                product_version="".join(get_ansys_version().split("."))[:-1],
+                product_version=fluent_product_version,
                 cleanup_on_exit=cleanup_on_exit,
                 meshing_mode=meshing_mode,
                 dimensionality=version,
@@ -661,12 +671,16 @@ def launch_fluent(
             args = _build_fluent_launch_args_string(**argvals).split()
             if meshing_mode:
                 args.append(" -meshing")
+
+            save_path = pyfluent.EXAMPLES_PATH
+            # Check if save path exists
+            if not os.path.exists(save_path):
+                os.makedirs(save_path)
+
             # Assumes the container OS will be able to create the
             # EXAMPLES_PATH of host OS. With the Fluent docker
             # container, the following currently works only in linux.
-            port, password = start_fluent_container(
-                pyfluent.EXAMPLES_PATH, pyfluent.EXAMPLES_PATH, args
-            )
+            port, password = start_fluent_container(save_path, save_path, args)
             return new_session(
                 fluent_connection=FluentConnection(
                     start_timeout=start_timeout,