ansys-fluent-core 0.20.dev8__py3-none-any.whl → 0.20.dev9__py3-none-any.whl

ansys/fluent/core/__init__.py

@@ -23,8 +23,8 @@ from ansys.fluent.core.launcher.launcher import (  # noqa: F401
 from ansys.fluent.core.launcher.pyfluent_enums import (  # noqa: F401
     FluentLinuxGraphicsDriver,
     FluentMode,
-    FluentUI,
     FluentWindowsGraphicsDriver,
+    UIMode,
 )
 from ansys.fluent.core.services.batch_ops import BatchOps  # noqa: F401
 from ansys.fluent.core.session import BaseSession as Fluent  # noqa: F401
@@ -34,7 +34,7 @@ from ansys.fluent.core.utils.search import search  # noqa: F401
 from ansys.fluent.core.utils.setup_for_fluent import setup_for_fluent  # noqa: F401
 from ansys.fluent.core.warnings import PyFluentDeprecationWarning  # noqa: F401
 
-_VERSION_INFO = "Build date: March 11, 2024 13:48 UTC ShaID: 5bf57a7"
+_VERSION_INFO = "Build date: March 15, 2024 12:17 UTC ShaID: 011aa16"
 """Global variable indicating the version of the PyFluent package - Empty by default"""
 
 _THIS_DIRNAME = os.path.dirname(__file__)
@@ -85,5 +85,6 @@ DATAMODEL_USE_NOCOMMANDS_DIFF_STATE = True
 
 
 def wrap_api_call(f, *args, **kwargs):
+    """Wrap API call."""
     # overwritten in PyConsole
     return f(*args, **kwargs)

ansys/fluent/core/_stand_alone_datamodel_client/_datamodel_client.py

@@ -13,6 +13,7 @@ from tests.run_stateengine_server import kill_server, run_server
 
 
 def run_datamodel_server(batch_file_name: Union[str, Path], rules):
+    """Run the datamodel server."""
     run_command = str(batch_file_name) + " " + rules
     run_server(run_command)
     _channel = grpc.insecure_channel("localhost:50055")
@@ -22,6 +23,7 @@ def run_datamodel_server(batch_file_name: Union[str, Path], rules):
 
 
 def close_server():
+    """Close the server."""
     grpc.insecure_channel("localhost:50055").close()
     try:
         kill_server()

ansys/fluent/core/_version.py

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

ansys/fluent/core/data_model_cache.py

@@ -22,6 +22,8 @@ StateType = Union[
 
 
 class NameKey(Enum):
+    """Name key."""
+
     INTERNAL = "__iname__"
     DISPLAY = "_name_"
 
@@ -36,6 +38,7 @@ class _CacheImpl:
 
     @staticmethod
     def add_missing_name_keys(k: str, v: dict[str, Any]):
+        """Add missing name keys in dict."""
         if ":" in k:
             name_in_key = k.split(":")[1]
             if NameKey.DISPLAY.value in v and v[NameKey.DISPLAY.value] != name_in_key:
@@ -44,6 +47,7 @@ class _CacheImpl:
                 v[NameKey.DISPLAY.value] = name_in_key
 
     def find(self, d: dict[str, Any], key: str, default: Any) -> tuple[str, Any]:
+        """Find in dict."""
         if key in d:
             return key, d[key]
         if ":" in key:
@@ -60,6 +64,7 @@ class _CacheImpl:
         return key, default
 
     def transform(self, d_in: dict[str, Any], add_missing_name_keys=False):
+        """Transform dict."""
         d_out = {}
         for k_in, v_in in d_in.items():
             if isinstance(v_in, abc.Mapping):
@@ -77,6 +82,7 @@ class _CacheImpl:
         return d_out
 
     def update(self, d: dict[str, Any], d1: dict[str, Any]):
+        """Update dict."""
         for k1, v1 in d1.items():
             k, v = self.find(d, k1, None)
             if isinstance(v, abc.Mapping) and isinstance(v1, abc.Mapping):

ansys/fluent/core/datamodel_242/meshing.py

@@ -34,6 +34,9 @@ class Root(PyMenu):
         self.AddThinVolumeMeshControls = self.__class__.AddThinVolumeMeshControls(service, rules, "AddThinVolumeMeshControls", path)
         self.AddVirtualTopology = self.__class__.AddVirtualTopology(service, rules, "AddVirtualTopology", path)
         self.Capping = self.__class__.Capping(service, rules, "Capping", path)
+        self.CheckMesh = self.__class__.CheckMesh(service, rules, "CheckMesh", path)
+        self.CheckSurfaceQuality = self.__class__.CheckSurfaceQuality(service, rules, "CheckSurfaceQuality", path)
+        self.CheckVolumeQuality = self.__class__.CheckVolumeQuality(service, rules, "CheckVolumeQuality", path)
         self.ChooseMeshControlOptions = self.__class__.ChooseMeshControlOptions(service, rules, "ChooseMeshControlOptions", path)
         self.ChoosePartReplacementOptions = self.__class__.ChoosePartReplacementOptions(service, rules, "ChoosePartReplacementOptions", path)
         self.CloseLeakage = self.__class__.CloseLeakage(service, rules, "CloseLeakage", path)
@@ -766,6 +769,39 @@ class Root(PyMenu):
         """
         pass
 
+    class CheckMesh(PyCommand):
+        """
+        Command CheckMesh.
+
+
+        Returns
+        -------
+        None
+        """
+        pass
+
+    class CheckSurfaceQuality(PyCommand):
+        """
+        Command CheckSurfaceQuality.
+
+
+        Returns
+        -------
+        None
+        """
+        pass
+
+    class CheckVolumeQuality(PyCommand):
+        """
+        Command CheckVolumeQuality.
+
+
+        Returns
+        -------
+        None
+        """
+        pass
+
     class ChooseMeshControlOptions(PyCommand):
         """
         Command ChooseMeshControlOptions.
@@ -869,6 +905,8 @@ class Root(PyMenu):
         BoundingBoxObject : Dict[str, Any]
         OffsetObject : Dict[str, Any]
         CylinderObject : Dict[str, Any]
+        Axis : Dict[str, Any]
+        VolumeFill : str
 
         Returns
         -------
@@ -897,6 +935,7 @@ class Root(PyMenu):
         BoundingBoxObject : Dict[str, Any]
         OffsetObject : Dict[str, Any]
         CylinderObject : Dict[str, Any]
+        Axis : Dict[str, Any]
         VolumeFill : str
 
         Returns
@@ -926,6 +965,7 @@ class Root(PyMenu):
         BoundingBoxObject : Dict[str, Any]
         OffsetObject : Dict[str, Any]
         CylinderObject : Dict[str, Any]
+        Axis : Dict[str, Any]
         VolumeFill : str
 
         Returns
@@ -1035,6 +1075,7 @@ class Root(PyMenu):
         BoundingBoxObject : Dict[str, Any]
         OffsetObject : Dict[str, Any]
         CylinderObject : Dict[str, Any]
+        Axis : Dict[str, Any]
         VolumeFill : str
 
         Returns
@@ -2187,6 +2228,7 @@ class Root(PyMenu):
         RegionInternalTypes : List[str]
         RegionCurrentList : List[str]
         RegionCurrentTypeList : List[str]
+        NumberOfListedRegions : int
 
         Returns
         -------

ansys/fluent/core/examples/__init__.py

@@ -1 +1,3 @@
+"""Provides a module to download a file."""
+
 from .downloads import download_file, path  # noqa: F401

ansys/fluent/core/examples/downloads.py

@@ -156,6 +156,23 @@ def download_file(
 
 
 def path(file_name: str):
+    """Return path of given file name.
+
+    Parameters
+    ----------
+    file_name : str
+        Name of the file.
+
+    Raises
+    ------
+    FileNotFoundError
+        If file does not exist.
+
+    Returns
+    -------
+    file_path: str
+        File path.
+    """
     if os.path.isabs(file_name):
         return file_name
     file_path = Path(pyfluent.EXAMPLES_PATH) / file_name

ansys/fluent/core/file_session.py

@@ -1,3 +1,5 @@
+"""Provides a module for file session."""
+
 from typing import List, Optional
 
 import numpy as np
@@ -297,6 +299,8 @@ class Transaction:
 
 
 class FileFieldData:
+    """File field data."""
+
     def __init__(self, file_session, field_info):
         self._file_session = file_session
         self._field_info = field_info
@@ -585,6 +589,8 @@ class FileFieldData:
 
 
 class FileFieldInfo:
+    """File field info."""
+
     def __init__(self, file_session):
         self._file_session = file_session
 
@@ -707,6 +713,8 @@ class FileFieldInfo:
 
 
 class FileSession:
+    """File session to read case and data file."""
+
     def __init__(self):
         """__init__ method of FileSession class."""
         self._case_file = None

ansys/fluent/core/filereader/casereader.py

@@ -1,2 +1,4 @@
+"""Provides a module for Case Reader."""
+
 # Compatibility aliases
 from .case_file import CaseFile as CaseReader  # noqa: F401

ansys/fluent/core/filereader/lispy.py

@@ -1,3 +1,5 @@
+"""Provides a module for Scheme Interpreter in Python."""
+
 ################ Scheme Interpreter in Python
 
 ## (c) Peter Norvig, 2010; See http://norvig.com/lispy2.html
@@ -15,6 +17,8 @@ import sys
 
 
 class Symbol(str):
+    """Symbol."""
+
     pass
 
 
@@ -65,6 +69,7 @@ eof_object = Symbol("#<eof-object>")  # Note: uninterned; can't be read
 
 
 def count_unescaped_quotes(line):
+    """Get count of unescaped quotes."""
     count = 0
     escaped = False
     for c in line:
@@ -258,9 +263,14 @@ class Env(dict):
                 )
             self.update(zip(params, args))
 
-    # pylint: disable=missing-raises-doc
     def find(self, var):
-        """Find the innermost Env where var appears."""
+        """Find the innermost Env where var appears.
+
+        Raises
+        ------
+        LookupError
+            If a key or index used on a mapping or sequence is invalid.
+        """
         if var in self:
             return self
         elif self.outer is None:
@@ -270,16 +280,23 @@ class Env(dict):
 
 
 def is_pair(x):
+    """Check whether given value type is pair or not."""
     return x != [] and isa(x, list)
 
 
 def cons(x, y):
+    """Form a pair."""
     return [x] + y
 
 
-# pylint: disable=missing-raises-doc
 def callcc(proc):
-    """Call proc with current continuation; escape only."""
+    """Call proc with current continuation; escape only.
+
+    Raises
+    ------
+    RuntimeWarning
+        If continuation can't be continued.
+    """
     ball = RuntimeWarning("Sorry, can't continue this continuation any longer.")
 
     def throw(retval):
@@ -464,9 +481,14 @@ def expand(x, toplevel=False):
         return list(map(expand, x))  # (f arg...) => expand each
 
 
-# pylint: disable=missing-raises-doc
 def require(x, predicate, msg="wrong length"):
-    """Signal a syntax error if predicate is false."""
+    """Signal a syntax error if predicate is false.
+
+    Raises
+    ------
+    SyntaxError
+        If syntax is invalid.
+    """
     if not predicate:
         raise SyntaxError(to_string(x) + ": " + msg)
 
@@ -490,6 +512,7 @@ def expand_quasiquote(x):
 
 
 def let(*args):
+    """Get variable values."""
     args = list(args)
     x = cons(_let, args)
     require(x, len(args) > 1)

ansys/fluent/core/fluent_connection.py

@@ -1,3 +1,5 @@
+"""Provides a module for Fluent connection functionality."""
+
 from ctypes import c_int, sizeof
 from dataclasses import dataclass
 import itertools
@@ -118,22 +120,24 @@ class ErrorState:
     --------
     >>> import ansys.fluent.core as pyfluent
     >>> session = pyfluent.launch_fluent()
-    >>> session.fluent_connection.error_state.set("test", "test details")
-    >>> session.fluent_connection.error_state.name
+    >>> session.fluent_connection._error_state.set("test", "test details")
+    >>> session.fluent_connection._error_state.name
     'test'
-    >>> session.fluent_connection.error_state.details
+    >>> session.fluent_connection._error_state.details
     'test details'
-    >>> session.fluent_connection.error_state.clear()
-    >>> session.fluent_connection.error_state.name
+    >>> session.fluent_connection._error_state.clear()
+    >>> session.fluent_connection._error_state.name
     ''
     """
 
     @property
     def name(self):
+        """Get name."""
         return self._name
 
     @property
     def details(self):
+        """Get details."""
         return self._details
 
     def __init__(self, name: str = "", details: str = ""):
@@ -265,7 +269,7 @@ class FluentConnection:
         PortNotProvided
             If port is not provided.
         """
-        self.error_state = ErrorState()
+        self._error_state = ErrorState()
         self._data_valid = False
         self._channel_str = None
         self._slurm_job_id = None
@@ -294,7 +298,7 @@ class FluentConnection:
         )
 
         self.health_check_service = service_creator("health_check").create(
-            self._channel, self._metadata, self.error_state
+            self._channel, self._metadata, self._error_state
         )
         # At this point, the server must be running. If the following check_health()
         # throws, we should not proceed.
@@ -311,7 +315,7 @@ class FluentConnection:
         # Move this service later.
         # Currently, required by launcher to connect to a running session.
         self._scheme_eval_service = self.create_grpc_service(
-            SchemeEvalService, self.error_state
+            SchemeEvalService, self._error_state
         )
         self.scheme_eval = service_creator("scheme_eval").create(
             self._scheme_eval_service
@@ -394,6 +398,7 @@ class FluentConnection:
 
     @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)")
@@ -417,76 +422,54 @@ class FluentConnection:
         >>> session.force_exit()
         """
         if self.connection_properties.inside_container:
-            logger.error(
-                "Cannot execute cleanup script, Fluent running inside container. "
-                "Use force_exit_container() instead."
-            )
-            return
-        if self._remote_instance is not None:
+            self._force_exit_container()
+        elif self._remote_instance is not None:
             logger.error("Cannot execute cleanup script, Fluent running remotely.")
             return
-
-        pwd = self.connection_properties.cortex_pwd
-        pid = self.connection_properties.fluent_host_pid
-        host = self.connection_properties.cortex_host
-        if host != socket.gethostname():
-            logger.error(
-                "Fluent host is not the current host, cancelling forced exit..."
-            )
-            return
-        if os.name == "nt":
-            cleanup_file_ext = "bat"
-            cmd_list = []
-        elif os.name == "posix":
-            cleanup_file_ext = "sh"
-            cmd_list = ["bash"]
-        else:
-            logger.error(
-                "Unrecognized or unsupported operating system, cancelling Fluent cleanup script execution."
-            )
-            return
-        cleanup_file_name = f"cleanup-fluent-{host}-{pid}.{cleanup_file_ext}"
-        logger.debug(f"Looking for {cleanup_file_name}...")
-        cleanup_file_name = Path(pwd, cleanup_file_name)
-        if cleanup_file_name.is_file():
-            logger.info(
-                f"Executing Fluent cleanup script, file path: {cleanup_file_name}"
-            )
-            cmd_list.append(cleanup_file_name)
-            logger.debug(f"Cleanup command list = {cmd_list}")
-            subprocess.Popen(
-                cmd_list,
-                stdout=subprocess.DEVNULL,
-                stderr=subprocess.DEVNULL,
-            )
-        elif self._slurm_job_id:
-            logger.debug("Fluent running inside Slurm, closing Slurm session...")
-            self._close_slurm()
         else:
-            logger.error("Could not find cleanup file.")
+            pwd = self.connection_properties.cortex_pwd
+            pid = self.connection_properties.fluent_host_pid
+            host = self.connection_properties.cortex_host
+            if host != socket.gethostname():
+                logger.error(
+                    "Fluent host is not the current host, cancelling forced exit..."
+                )
+                return
+            if os.name == "nt":
+                cleanup_file_ext = "bat"
+                cmd_list = []
+            elif os.name == "posix":
+                cleanup_file_ext = "sh"
+                cmd_list = ["bash"]
+            else:
+                logger.error(
+                    "Unrecognized or unsupported operating system, cancelling Fluent cleanup script execution."
+                )
+                return
+            cleanup_file_name = f"cleanup-fluent-{host}-{pid}.{cleanup_file_ext}"
+            logger.debug(f"Looking for {cleanup_file_name}...")
+            cleanup_file_name = Path(pwd, cleanup_file_name)
+            if cleanup_file_name.is_file():
+                logger.info(
+                    f"Executing Fluent cleanup script, file path: {cleanup_file_name}"
+                )
+                cmd_list.append(cleanup_file_name)
+                logger.debug(f"Cleanup command list = {cmd_list}")
+                subprocess.Popen(
+                    cmd_list,
+                    stdout=subprocess.DEVNULL,
+                    stderr=subprocess.DEVNULL,
+                )
+            elif self._slurm_job_id:
+                logger.debug("Fluent running inside Slurm, closing Slurm session...")
+                self._close_slurm()
+            else:
+                logger.error("Could not find cleanup file.")
 
-    def force_exit_container(self):
+    def _force_exit_container(self):
         """Immediately terminates the Fluent client running inside a container, losing
-        unsaved progress and data.
-
-        Notes
-        -----
-        By default, Fluent does not run in a container,
-        in that case use :func:`force_exit()`.
-        If the Fluent session is responsive, prefer using :func:`exit()` instead.
-        """
-        if self._remote_instance is not None:
-            logger.error(
-                "Fluent is running remotely, cannot terminate Fluent container."
-            )
-            return
+        unsaved progress and data."""
         container = self.connection_properties.inside_container
-        if not container:
-            logger.error(
-                "Session is not inside a container, cannot terminate Fluent container. "
-                "Try force_exit() instead."
-            )
-            return
         container_id = self.connection_properties.cortex_host
         pid = self.connection_properties.fluent_host_pid
         cleanup_file_name = f"cleanup-fluent-{container_id}-{pid}.sh"
@@ -668,7 +651,7 @@ class FluentConnection:
                     logger.debug(
                         "Fluent running inside container, cleaning up Fluent inside container..."
                     )
-                    self.force_exit_container()
+                    self.force_exit()
                 else:
                     logger.debug(
                         "Fluent running locally, cleaning up Fluent processes..."

ansys/fluent/core/fluent_version_242.py

@@ -1,5 +1,5 @@
 FLUENT_VERSION = "24.2.0"
-FLUENT_BUILD_TIME = "Mar 04 2024 12:13:04 EST"
-FLUENT_BUILD_ID = "125"
-FLUENT_REVISION = "e931d109c0"
+FLUENT_BUILD_TIME = "Mar 12 2024 12:14:22 EDT"
+FLUENT_BUILD_ID = "133"
+FLUENT_REVISION = "1d163982f1"
 FLUENT_BRANCH = "develop"

ansys/fluent/core/get_build_details.py

@@ -7,6 +7,7 @@ from ansys.fluent.core._version import __version__
 
 
 def get_build_version():
+    """Get build version."""
     build_details = OrderedDict()
     try:
         last_commit_time = (
@@ -36,4 +37,5 @@ def get_build_version():
 
 
 def get_build_version_string():
+    """Get build version string."""
     return "  ".join([f"{k}: {v}" for k, v in get_build_version().items()])

ansys/fluent/core/launcher/container_launcher.py

@@ -29,8 +29,8 @@ from ansys.fluent.core.launcher.process_launch_string import (
 from ansys.fluent.core.launcher.pyfluent_enums import (
     FluentLinuxGraphicsDriver,
     FluentMode,
-    FluentUI,
     FluentWindowsGraphicsDriver,
+    UIMode,
 )
 import ansys.fluent.core.launcher.watchdog as watchdog
 from ansys.fluent.core.utils.file_transfer_service import PimFileTransferService
@@ -46,7 +46,7 @@ class DockerLauncher:
     def __init__(
         self,
         mode: FluentMode,
-        ui: FluentUI,
+        ui_mode: UIMode,
         graphics_driver: Union[FluentWindowsGraphicsDriver, FluentLinuxGraphicsDriver],
         product_version: Optional[str] = None,
         version: Optional[str] = None,
@@ -78,8 +78,8 @@ class DockerLauncher:
         ----------
         mode : FluentMode
             Launch mode of Fluent to point to a specific session type.
-        ui : FluentUI
-            Fluent user interface mode. Options are the values of the ``FluentUI`` enum.
+        ui_mode : UIMode
+            Fluent user interface mode. Options are the values of the ``UIMode`` enum.
         graphics_driver : FluentWindowsGraphicsDriver or FluentLinuxGraphicsDriver
             Graphics driver of Fluent. Options are the values of the
             ``FluentWindowsGraphicsDriver`` enum in Windows or the values of the

ansys/fluent/core/launcher/error_handler.py

@@ -1,6 +1,8 @@
+"""Provides a module for customized error handling."""
+
 from ansys.fluent.core.exceptions import InvalidArgument
 from ansys.fluent.core.launcher import launcher_utils
-from ansys.fluent.core.launcher.pyfluent_enums import FluentUI, LaunchMode
+from ansys.fluent.core.launcher.pyfluent_enums import LaunchMode, UIMode
 from ansys.fluent.core.utils.fluent_version import FluentVersion
 
 
@@ -38,7 +40,6 @@ class DockerContainerLaunchNotSupported(SystemError):
         super().__init__("Python Docker SDK is unsupported on this system.")
 
 
-# pylint: disable=missing-raises-doc
 class LaunchFluentError(Exception):
     """Exception class representing launch errors."""
 
@@ -49,17 +50,17 @@ class LaunchFluentError(Exception):
 
 
 def _raise_non_gui_exception_in_windows(
-    ui: FluentUI, product_version: FluentVersion
+    ui_mode: UIMode, product_version: FluentVersion
 ) -> None:
-    """Fluent user interface mode lower than ``FluentUI.HIDDEN_GUI`` is not supported in
+    """Fluent user interface mode lower than ``UIMode.HIDDEN_GUI`` is not supported in
     Windows in Fluent versions earlier than 2024 R1."""
     if (
         launcher_utils.is_windows()
-        and ui < FluentUI.HIDDEN_GUI
+        and ui_mode < UIMode.HIDDEN_GUI
         and product_version < FluentVersion.v241
     ):
         raise InvalidArgument(
-            f"'{ui}' supported in Windows only for Fluent version 24.1 or later."
+            f"'{ui_mode}' supported in Windows only for Fluent version 24.1 or later."
         )