ansys-fluent-core 0.28.dev0__py3-none-any.whl → 0.28.2__py3-none-any.whl

ansys/fluent/core/__init__.py

@@ -31,11 +31,7 @@ from ansys.fluent.core.parametric import LocalParametricStudy  # noqa: F401
 from ansys.fluent.core.search import search  # noqa: F401
 from ansys.fluent.core.services.batch_ops import BatchOps  # noqa: F401
 from ansys.fluent.core.session import BaseSession as Fluent  # noqa: F401
-from ansys.fluent.core.streaming_services.events_streaming import (  # noqa: F401
-    Event,
-    MeshingEvent,
-    SolverEvent,
-)
+from ansys.fluent.core.streaming_services.events_streaming import *  # noqa: F401, F403
 from ansys.fluent.core.utils import fldoc, get_examples_download_dir
 from ansys.fluent.core.utils.fluent_version import FluentVersion  # noqa: F401
 from ansys.fluent.core.utils.setup_for_fluent import setup_for_fluent  # noqa: F401
@@ -45,12 +41,7 @@ from ansys.fluent.core.warnings import (  # noqa: F401
     warning,
 )
 
-try:
-    from ansys.fluent.core.generated.solver.settings_builtin import *  # noqa: F401, F403
-except (ImportError, AttributeError, SyntaxError):
-    pass
-
-_VERSION_INFO = "Build date: November 27, 2024 17:14 UTC ShaID: 566bc31"
+_VERSION_INFO = "Build date: January 11, 2025 20:07 UTC ShaID: 17ceff6"
 """Global variable indicating the version of the PyFluent package - Empty by default"""
 
 _THIS_DIRNAME = os.path.dirname(__file__)
@@ -107,11 +98,10 @@ DATAMODEL_RETURN_STATE_CHANGES = True
 # Whether to use remote gRPC file transfer service
 USE_FILE_TRANSFER_SERVICE = False
 
-# Directory where API files are writes out during codegen
-CODEGEN_OUTDIR = (Path(__file__) / ".." / "generated").resolve()
-
-# Whether to zip settings API files during codegen
-CODEGEN_ZIP_SETTINGS = os.getenv("PYFLUENT_CODEGEN_ZIP_SETTINGS", False)
+# Directory where API files are written out during codegen
+CODEGEN_OUTDIR = os.getenv(
+    "PYFLUENT_CODEGEN_OUTDIR", (Path(__file__) / ".." / "generated").resolve()
+)
 
 # Whether to show mesh in Fluent after case read
 FLUENT_SHOW_MESH_AFTER_CASE_READ = False
@@ -141,3 +131,12 @@ LAUNCH_FLUENT_STDOUT = None
 # Set stderr of the launched Fluent process
 # Valid values are same as subprocess.Popen's stderr argument
 LAUNCH_FLUENT_STDERR = None
+
+# Set the IP address of the Fluent server while launching Fluent
+LAUNCH_FLUENT_IP = None
+
+# Set the port of the Fluent server while launching Fluent
+LAUNCH_FLUENT_PORT = None
+
+# Skip password check during rpc execution when Fluent is launched from PyFluent
+LAUNCH_FLUENT_SKIP_PASSWORD_CHECK = False

ansys/fluent/core/_version.py

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

ansys/fluent/core/codegen/allapigen.py

@@ -23,9 +23,6 @@ def generate(version: str, static_infos: dict):
     api_tree = {"<meshing_session>": {}, "<solver_session>": {}}
     _update_first_level(api_tree, tuigen.generate(version, static_infos))
     _update_first_level(api_tree, datamodelgen.generate(version, static_infos))
-    if os.getenv("PYFLUENT_USE_OLD_SETTINGSGEN") == "1":
-        global settingsgen
-        from ansys.fluent.core.codegen import settingsgen_old as settingsgen
     _update_first_level(api_tree, settingsgen.generate(version, static_infos))
     api_tree_file = get_api_tree_file_name(version)
     Path(api_tree_file).parent.mkdir(parents=True, exist_ok=True)

ansys/fluent/core/codegen/builtin_settingsgen.py

@@ -1,8 +1,5 @@
 """Generate builtin setting classes."""
 
-import os
-from zipimport import zipimporter
-
 from ansys.fluent.core import CODEGEN_OUTDIR, FluentVersion
 from ansys.fluent.core.solver.flobject import CreatableNamedObjectMixin, NamedObject
 from ansys.fluent.core.solver.settings_builtin_data import DATA
@@ -12,24 +9,12 @@ _PYI_FILE = CODEGEN_OUTDIR / "solver" / "settings_builtin.pyi"
 
 
 def _get_settings_root(version: str):
-    from ansys.fluent.core import CODEGEN_OUTDIR, CODEGEN_ZIP_SETTINGS, utils
+    from ansys.fluent.core import CODEGEN_OUTDIR, utils
 
-    if os.getenv("PYFLUENT_USE_OLD_SETTINGSGEN") != "1":
-        settings = utils.load_module(
-            f"settings_{version}",
-            CODEGEN_OUTDIR / "solver" / f"settings_{version}.py",
-        )
-    else:
-        if CODEGEN_ZIP_SETTINGS:
-            importer = zipimporter(
-                str(CODEGEN_OUTDIR / "solver" / f"settings_{version}.zip")
-            )
-            settings = importer.load_module("settings")
-        else:
-            settings = utils.load_module(
-                f"settings_{version}",
-                CODEGEN_OUTDIR / "solver" / f"settings_{version}" / "__init__.py",
-            )
+    settings = utils.load_module(
+        f"settings_{version}",
+        CODEGEN_OUTDIR / "solver" / f"settings_{version}.py",
+    )
     return settings.root
 
 

ansys/fluent/core/codegen/print_fluent_version.py

@@ -1,26 +1,21 @@
 """Module to write Fluent version information."""
 
-from ansys.fluent.core import CODEGEN_OUTDIR, launch_fluent
-from ansys.fluent.core.utils.fluent_version import get_version_for_file_name
+from ansys.fluent.core import CODEGEN_OUTDIR, FluentVersion, launch_fluent
 
 
-def print_fluent_version(version: str, scheme_eval):
+def print_fluent_version(app_utilities):
     """Write Fluent version information to file."""
+    version = FluentVersion(app_utilities.get_product_version()).number
+    build_info = app_utilities.get_build_info()
     version_file = (CODEGEN_OUTDIR / f"fluent_version_{version}.py").resolve()
     with open(version_file, "w", encoding="utf8") as f:
         f.write(f'FLUENT_VERSION = "{version}"\n')
-        f.write(f'FLUENT_BUILD_TIME = "{scheme_eval("(inquire-build-time)")}"\n')
-        f.write(f'FLUENT_BUILD_ID = "{scheme_eval("(inquire-build-id)")}"\n')
-        f.write(f'FLUENT_REVISION = "{scheme_eval("(inquire-src-vcs-id)")}"\n')
-        f.write(f'FLUENT_BRANCH = "{scheme_eval("(inquire-src-vcs-branch)")}"\n')
-
-
-def generate(version: str, scheme_eval):
-    """Write Fluent version information."""
-    print_fluent_version(version, scheme_eval)
+        f.write(f'FLUENT_BUILD_TIME = "{build_info["build_time"]}"\n')
+        f.write(f'FLUENT_BUILD_ID = "{build_info["build_id"]}"\n')
+        f.write(f'FLUENT_REVISION = "{build_info["vcs_revision"]}"\n')
+        f.write(f'FLUENT_BRANCH = "{build_info["vcs_branch"]}"\n')
 
 
 if __name__ == "__main__":
     solver = launch_fluent()
-    version = get_version_for_file_name(session=solver)
-    generate(version, solver.scheme_eval.scheme_eval)
+    print_fluent_version(solver._app_utilities)

ansys/fluent/core/codegen/walk_api.py

@@ -0,0 +1,57 @@
+"""Module containing tool for walking (generated) API class hierarchy.
+
+Example
+-------
+
+.. code-block:: python
+
+    >>> from ansys.fluent.core.codegen import walk_api
+    >>> from ansys.fluent.core.generated.solver import settings_252
+    >>> walk_api.walk_api(settings_252.root, lambda p: print(p), current_path=[])
+
+"""
+
+from typing import List
+
+
+def walk_api(api_root_cls, on_each_path, current_path: str | List[str] = ""):
+    """
+    Recursively traverse the API hierarchy, calling `on_each_path` for each item.
+
+    Parameters:
+    - api_root_cls: The root class of the API hierarchy.
+    - on_each_path: A callback function to call for each path.
+    - current_path: The current path in the hierarchy (default: empty string).
+      Paths can be either dot-separated strings or string lists. The type is
+      determined by the client.
+    """
+    # Skip the root path
+    if current_path:
+        on_each_path(current_path)
+
+    # Get child names and their respective classes
+    all_names = [
+        name
+        for attr in ("child_names", "argument_names", "command_names", "query_names")
+        for name in getattr(api_root_cls, attr, [])
+    ]
+    child_classes = getattr(api_root_cls, "_child_classes", {})
+
+    # Traverse each child
+    for child_name in all_names:
+        if child_name in child_classes:
+            child_cls = child_classes[child_name]
+            # Construct the new path
+            if isinstance(current_path, list):
+                new_path = current_path + [child_name]
+            else:
+                new_path = (
+                    f"{current_path}.{child_name}" if current_path else child_name
+                )
+            # Recursively walk the child
+            walk_api(child_cls, on_each_path, new_path)
+
+    # Delegate directly to any child_object_type (relevant for named objects)
+    child_object_type = getattr(api_root_cls, "child_object_type", None)
+    if child_object_type:
+        walk_api(child_cls, on_each_path, current_path)

ansys/fluent/core/fluent_connection.py

@@ -21,6 +21,10 @@ import grpc
 
 import ansys.fluent.core as pyfluent
 from ansys.fluent.core.services import service_creator
+from ansys.fluent.core.services.app_utilities import (
+    AppUtilitiesOld,
+    AppUtilitiesService,
+)
 from ansys.fluent.core.services.scheme_eval import SchemeEvalService
 from ansys.fluent.core.utils.execution import timeout_exec, timeout_loop
 from ansys.fluent.core.utils.file_transfer_service import RemoteFileTransferStrategy
@@ -246,15 +250,24 @@ class _ConnectionInterface:
         self.scheme_eval = service_creator("scheme_eval").create(
             self._scheme_eval_service
         )
+        if (
+            pyfluent.FluentVersion(self.scheme_eval.version)
+            < pyfluent.FluentVersion.v252
+        ):
+            self._app_utilities = AppUtilitiesOld(self.scheme_eval)
+        else:
+            self._app_utilities_service = create_grpc_service(
+                AppUtilitiesService, error_state
+            )
+            self._app_utilities = service_creator("app_utilities").create(
+                self._app_utilities_service
+            )
 
     @property
     def product_build_info(self) -> str:
         """Get Fluent build information."""
-        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}"
+        build_info = self._app_utilities.get_build_info()
+        return f'Build Time: {build_info["build_time"]}  Build Id: {build_info["build_id"]}  Revision: {build_info["vcs_revision"]}  Branch: {build_info["vcs_branch"]}'
 
     def get_cortex_connection_properties(self):
         """Get connection properties of Fluent."""
@@ -263,10 +276,12 @@ class _ConnectionInterface:
         try:
             logger.info(self.product_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)")
+            cortex_info = self._app_utilities.get_controller_process_info()
+            solver_info = self._app_utilities.get_solver_process_info()
+            fluent_host_pid = solver_info["process_id"]
+            cortex_host = cortex_info["hostname"]
+            cortex_pid = cortex_info["process_id"]
+            cortex_pwd = cortex_info["working_directory"]
             logger.debug("Cortex connection properties successfully obtained.")
         except _InactiveRpcError:
             logger.warning(
@@ -282,22 +297,11 @@ class _ConnectionInterface:
 
     def get_mode(self):
         """Get the mode of a running fluent session."""
-        from ansys.fluent.core import FluentMode
-
-        if self.scheme_eval.scheme_eval("(cx-solver-mode?)"):
-            mode_str = self.scheme_eval.scheme_eval('(getenv "PRJAPP_APP")')
-            if mode_str == "flaero_server":
-                return FluentMode.SOLVER_AERO
-            elif mode_str == "flicing":
-                return FluentMode.SOLVER_ICING
-            else:
-                return FluentMode.SOLVER
-        else:
-            return FluentMode.MESHING
+        return self._app_utilities.get_app_mode()
 
     def exit_server(self):
         """Exits the server."""
-        self.scheme_eval.exec(("(exit-server)",))
+        self._app_utilities.exit()
 
 
 def _pid_exists(pid):