SchemeEval doc

.pre-commit-config.yaml

@@ -24,8 +24,10 @@ repos:
       --profile, black,
       --skip-glob, src/ansys/fluent/core/meshing/tui*,
       --skip-glob, src/ansys/fluent/core/solver/tui*,
-      --skip-glob, src/ansys/fluent/core/datamodel/*,
-      --skip-glob, src/ansys/fluent/core/solver/settings/*,
+      --skip-glob, src/ansys/fluent/core/datamodel_222/*,
+      --skip-glob, src/ansys/fluent/core/datamodel_231/*,
+      --skip-glob, src/ansys/fluent/core/solver/settings_222/*,
+      --skip-glob, src/ansys/fluent/core/solver/settings_231/*,
       --force-sort-within-sections,
       --line-length, "88",
       --section-default, THIRDPARTY, 
@@ -42,7 +44,7 @@ repos:
       'flake8-annotations==2.9.0'
     ]
     args: [
-      --exclude, src/ansys/fluent/core/meshing/tui* src/ansys/fluent/core/solver/tui* src/ansys/fluent/core/datamodel/* src/ansys/fluent/core/solver/settings/*,
+      --exclude, src/ansys/fluent/core/meshing/tui* src/ansys/fluent/core/solver/tui* src/ansys/fluent/core/datamodel_222/* src/ansys/fluent/core/datamodel_231/* src/ansys/fluent/core/solver/settings_222/* src/ansys/fluent/core/solver/settings_231/*,
       --select, W191 W291 W293 W391 E115 E117 E122 E124 E125 E225 E231 E301 E303 F401 F403 N801 N802 N803 N804 N805 N806,
       #--select, W191 W291 W293 W391 E115 E117 E122 E124 E125 E225 E231 E301 E303 F401 F403 N801 N802 N803 N804 N805 N806 ANN001 ANN201 ANN205 ANN206,
       --count,
@@ -58,7 +60,7 @@ repos:
   hooks:
   - id: codespell
     args: [
-      --skip, "src/ansys/fluent/core/meshing/tui*,src/ansys/fluent/core/solver/tui*,src/ansys/fluent/core/datamodel/*,codegen/data/fluent_gui_help.xml,src/ansys/fluent/core/solver/settings/*",
+      --skip, "src/ansys/fluent/core/meshing/tui*,src/ansys/fluent/core/solver/tui*,src/ansys/fluent/core/datamodel_222/*,src/ansys/fluent/core/datamodel_231/*,codegen/data/fluent_gui_help.xml,src/ansys/fluent/core/solver/settings_222/*,src/ansys/fluent/core/solver/settings_231/*",
     ]
 
 - repo: https://github.com/myint/docformatter

doc/settings_rstgen.py

@@ -219,7 +219,7 @@ def _populate_rst_from_settings(rst_dir, cls, version):
     if not os.path.exists(rst_dir):
         os.makedirs(rst_dir)
 
-    image_tag = os.getenv("FLUENT_IMAGE_TAG", "v22.2.0")
+    image_tag = os.getenv("FLUENT_IMAGE_TAG", "v23.1.0")
     version = get_version_for_filepath(image_tag.lstrip("v"))
     settings = importlib.import_module(f"ansys.fluent.core.solver.settings_{version}")
     _populate_parents_list(settings.root)

doc/source/api/core/solver/index.rst

@@ -19,6 +19,7 @@ events, monitoring, and field data (surface, scalar, and vector).
    settings
    tuicommands
    datamodel/index
+   schemeeval
    fielddata
    events
    monitors

doc/source/api/core/solver/schemeeval.rst

@@ -0,0 +1,38 @@
+.. _ref_schemeeval:
+
+Scheme code evaluation
+======================
+
+Each session provides an instance of ``SchemeEval`` on which Fluent's
+scheme code can be executed.
+
+.. currentmodule:: ansys.fluent.core.services.scheme_eval
+
+.. autosummary::
+   :toctree: _autosummary
+
+.. autoclass:: ansys.fluent.core.services.scheme_eval.Symbol
+   :members:
+.. autoclass:: ansys.fluent.core.services.scheme_eval.SchemeEval
+   :members:
+
+Examples
+--------
+
+.. code-block:: python
+
+   >>> from ansys.fluent.core.services.scheme_eval import Symbol as S
+   >>> session.scheme_eval.eval([S('+'), 2, 3])
+   5
+   >>> session.scheme_eval.eval([S('rpgetvar'), [S('string->symbol'), "mom/relax"]])
+   0.7
+   >>> session.scheme_eval.exec(('(ti-menu-load-string "/report/system/proc-stats")',))
+   >>> # Returns TUI output string
+   >>> session.scheme_eval.string_eval("(+ 2 3)")
+   '5'
+   >>> session.scheme_eval.string_eval("(rpgetvar 'mom/relax)")
+   '0.7'
+   >>> session.scheme_eval.scheme_eval("(+ 2 3)")
+   5
+   >>> session.scheme_eval.scheme_eval("(rpgetvar 'mom/relax)")
+   0.7

src/ansys/fluent/core/services/scheme_eval.py

@@ -2,13 +2,13 @@
 
 Example
 -------
->>> from ansys.fluent.services.scheme_eval import Symbol as S
+>>> from ansys.fluent.core.services.scheme_eval import Symbol as S
 >>> session.scheme_eval.eval([S('+'), 2, 3])
 5
 >>> session.scheme_eval.eval([S('rpgetvar'), [S('string->symbol'), "mom/relax"]])  # noqa: E501
 0.7
 >>> session.scheme_eval.exec(('(ti-menu-load-string "/report/system/proc-stats")',))  # noqa: E501
->>> # prints Fluent TUI output
+>>> # Returns TUI output string
 >>> session.scheme_eval.string_eval("(+ 2 3)")
 '5'
 >>> session.scheme_eval.string_eval("(rpgetvar 'mom/relax)")
@@ -53,16 +53,16 @@ def string_eval(
 
 
 class Symbol:
-    """Class representing the symbol datatype in the scheme.
+    """Class representing the symbol datatype in Fluent.
 
     Attributes
     ----------
     str : str
         Underlying string representation
     """
 
-    def __init__(self, str_: str):
-        self.str = str_
+    def __init__(self, str: str):
+        self.str = str
 
 
 def _convert_pair_to_scheme_pointer(val: Tuple[Any, Any], p: SchemePointer):
@@ -169,9 +169,9 @@ class SchemeEval:
     exec(commands, wait, silent)
         Executes a sequence of scheme commands, returns TUI output
         string
-    string_eval(input_)
+    string_eval(input)
         Evaluates a scheme expression in string format, returns string
-    scheme_eval(input_)
+    scheme_eval(input)
         Evaluates a scheme expression in string format, returns Python
         value
     """
@@ -224,7 +224,7 @@ def exec(
         response = self.service.exec(request)
         return response.output
 
-    def string_eval(self, input_: str) -> str:
+    def string_eval(self, input: str) -> str:
         """Evaluates a scheme expression in string format.
 
         Parameters
@@ -238,11 +238,11 @@ def string_eval(self, input_: str) -> str:
             Output scheme value in string format
         """
         request = SchemeEvalProtoModule.StringEvalRequest()
-        request.input = input_
+        request.input = input
         response = self.service.string_eval(request)
         return response.output
 
-    def scheme_eval(self, input_: str) -> Any:
+    def scheme_eval(self, input: str) -> Any:
         """Evaluates a scheme expression in string format.
 
         Parameters
@@ -259,7 +259,7 @@ def scheme_eval(self, input_: str) -> Any:
         S = Symbol  # noqa N806
         val = (
             S("eval"),
-            (S("with-input-from-string"), input_, S("read")),
+            (S("with-input-from-string"), input, S("read")),
             S("user-initial-environment"),
         )
         _convert_py_value_to_scheme_pointer(val, request)