feat: Updates for the client side dm-api. (#3748)

This PR adds support for a new client-side datamodel API called
"meshing_workflow" to complement the existing "workflow" API. The
changes enable access to meshing workflow functionality through a new
meshing_workflow property across the meshing session classes.

Introduces meshing_workflow datamodel API support for Fluent versions
>=26.1
Adds the new API to meshing session classes and type definitions
Updates code generation infrastructure to handle the new workflow type

---------

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: prmukherj

codegen/allapigen.py

@@ -17,6 +17,7 @@
     gt_222 = FluentVersion(version) > FluentVersion.v222
     ge_231 = FluentVersion(version) >= FluentVersion.v231
     ge_242 = FluentVersion(version) >= FluentVersion.v242
+    ge_261 = FluentVersion(version) >= FluentVersion.v261
 
     static_infos = {
         StaticInfoType.DATAMODEL_WORKFLOW: meshing._datamodel_service_se.get_static_info(
@@ -40,6 +41,10 @@
         static_infos[StaticInfoType.DATAMODEL_MESHING_UTILITIES] = (
             meshing._datamodel_service_se.get_static_info("MeshingUtilities")
         )
+    if ge_261:
+        static_infos[StaticInfoType.DATAMODEL_MESHING_WORKFLOW] = (
+            meshing._datamodel_service_se.get_static_info("meshing_workflow")
+        )
     meshing.exit()
 
     solver = launch_fluent(

doc/changelog.d/3748.added.md

@@ -0,0 +1 @@
+Updates for the client side dm-api.

doc/datamodel_rstgen.py

@@ -16,6 +16,7 @@ def generate_meshing_datamodels():
         "pm_file_management",
         "preferences",
         "workflow",
+        "meshing_workflow",
     ]
     for meshing_datamodel in meshing_datamodels:
         try:

src/ansys/fluent/core/codegen/__init__.py

@@ -32,6 +32,7 @@ class StaticInfoType(Enum):
     TUI_SOLVER = auto()
     TUI_MESHING = auto()
     DATAMODEL_WORKFLOW = auto()
+    DATAMODEL_MESHING_WORKFLOW = auto()
     DATAMODEL_MESHING = auto()
     DATAMODEL_PART_MANAGEMENT = auto()
     DATAMODEL_PM_FILE_MANAGEMENT = auto()

src/ansys/fluent/core/codegen/datamodelgen.py

@@ -187,6 +187,7 @@ def _build_command_query_docstring(
     "MeshingUtilities": "meshing_utilities",
     "flicing": "flicing",
     "solverworkflow": "solver_workflow",
+    "meshing_workflow": "meshing_workflow",
 }
 
 
@@ -241,6 +242,13 @@ def __init__(self, version, static_infos: dict, verbose: bool = False):
                 ),
                 self.version,
             )
+        if StaticInfoType.DATAMODEL_MESHING_WORKFLOW in static_infos:
+            self._static_info["meshing_workflow"] = DataModelStaticInfo(
+                StaticInfoType.DATAMODEL_MESHING_WORKFLOW,
+                "meshing_workflow",
+                ("meshing",),
+                self.version,
+            )
         if StaticInfoType.DATAMODEL_MESHING in static_infos:
             self._static_info["meshing"] = DataModelStaticInfo(
                 StaticInfoType.DATAMODEL_MESHING, "meshing", ("meshing",), self.version
@@ -622,6 +630,10 @@ def generate(version, static_infos: dict, verbose: bool = False):
         static_infos[StaticInfoType.DATAMODEL_MESHING_UTILITIES] = (
             meshing._datamodel_service_se.get_static_info("MeshingUtilities")
         )
+    if FluentVersion(version) >= FluentVersion.v261:
+        static_infos[StaticInfoType.DATAMODEL_MESHING_WORKFLOW] = (
+            meshing._datamodel_service_se.get_static_info("meshing_workflow")
+        )
     parser = argparse.ArgumentParser(
         description="A script to write Fluent API files with an optional verbose output."
     )

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

@@ -1098,7 +1098,10 @@ def get_attr(self, attrib: str) -> Any:
         Any
             Value of the attribute.
         """
-        if pyfluent.config.datamodel_use_attr_cache:
+        if (
+            pyfluent.config.datamodel_use_attr_cache
+            and self.rules != "meshing_workflow"
+        ):
             return self._get_cached_attr(attrib)
         return self._get_remote_attr(attrib)
 

src/ansys/fluent/core/session_base_meshing.py

@@ -72,6 +72,7 @@ def __init__(
         self._fluent_version = fluent_version
         self._meshing_utilities = None
         self._old_workflow = None
+        self._meshing_workflow = None
         self._part_management = None
         self._pm_file_management = None
         self._preferences = None
@@ -127,6 +128,13 @@ def workflow(self):
             self._old_workflow = _make_datamodel_module(self, "workflow")
         return self._old_workflow
 
+    @property
+    def meshing_workflow(self):
+        """Full API to meshing and meshing_workflow."""
+        if self._meshing_workflow is None:
+            self._meshing_workflow = _make_datamodel_module(self, "meshing_workflow")
+        return self._meshing_workflow
+
     def watertight_workflow(self, initialize: bool = True):
         """Datamodel root of workflow."""
         self._current_workflow = WorkflowMode.WATERTIGHT_MESHING_MODE.value(

src/ansys/fluent/core/session_meshing.py

@@ -127,6 +127,11 @@ def workflow(self):
         """Workflow datamodel root."""
         return super(Meshing, self).workflow
 
+    @property
+    def meshing_workflow(self):
+        """Full API to meshing and meshing_workflow."""
+        return super(Meshing, self).meshing_workflow
+
     @property
     def PartManagement(self):
         """Part management datamodel root."""

src/ansys/fluent/core/session_pure_meshing.py

@@ -50,6 +50,7 @@ class PureMeshing(BaseSession):
 
     _rules = [
         "workflow",
+        "meshing_workflow",
         "meshing",
         "MeshingUtilities",
         "PartManagement",
@@ -146,6 +147,11 @@ def workflow(self):
         """Datamodel root of workflow."""
         return self._base_meshing.workflow
 
+    @property
+    def meshing_workflow(self):
+        """Full API to meshing and meshing_workflow."""
+        return self._base_meshing.meshing_workflow
+
     def watertight(self):
         """Get a new watertight workflow."""
         return self._base_meshing.watertight_workflow()

src/ansys/fluent/core/session_pure_meshing.pyi

@@ -34,6 +34,9 @@ from ansys.fluent.core.generated.datamodel_252.preferences import (
     Root as preferences_root,
 )
 from ansys.fluent.core.generated.datamodel_252.workflow import Root as workflow_root
+from ansys.fluent.core.generated.datamodel_261.meshing_workflow import (
+    Root as meshing_workflow_root,
+)
 from ansys.fluent.core.generated.meshing.tui_252 import main_menu
 
 class PureMeshing:
@@ -45,6 +48,8 @@ class PureMeshing:
     def meshing_utilities(self) -> meshing_utilities_root: ...
     @property
     def workflow(self) -> workflow_root: ...
+    @property
+    def meshing_workflow(self) -> meshing_workflow_root: ...
     def watertight(self): ...
     def fault_tolerant(self): ...
     def two_dimensional_meshing(self): ...