feat: capability to close designs (also on modeler.exit()) (#1409)

Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>

Author: RobPasMue

doc/changelog.d/1409.added.md

@@ -0,0 +1 @@
+capability to close designs (also on ``modeler.exit()``)

src/ansys/geometry/core/designer/design.py

@@ -132,6 +132,7 @@ def __init__(self, name: str, modeler: Modeler, read_existing_design: bool = Fal
         self._beam_profiles = {}
         self._design_id = ""
         self._is_active = False
+        self._is_closed = False
         self._modeler = modeler
 
         # Check whether we want to process an existing design or create a new one.
@@ -170,6 +171,28 @@ def is_active(self) -> bool:
         """Whether the design is currently active."""
         return self._is_active
 
+    @property
+    def is_closed(self) -> bool:
+        """Whether the design is closed."""
+        return self._is_closed
+
+    def close(self) -> None:
+        """Close the design."""
+        # Check if the design is already closed
+        if self._is_closed:
+            self._grpc_client.log.warning(f"Design {self.name} is already closed.")
+            return
+
+        # Attempt to close the design
+        try:
+            self._design_stub.Close(EntityIdentifier(id=self._design_id))
+        except Exception as err:
+            self._grpc_client.log.warning(f"Design {self.name} could not be closed. Error: {err}.")
+            self._grpc_client.log.warning("Ignoring response and assuming the design is closed.")
+
+        # Consider the design closed (even if the close request failed)
+        self._is_closed = True
+
     @protect_grpc
     def _activate(self, called_after_design_creation: bool = False) -> None:
         """Activate the design."""

src/ansys/geometry/core/misc/checks.py

@@ -43,6 +43,7 @@ def ensure_design_is_active(method):
 
     def wrapper(self, *args, **kwargs):
         import ansys.geometry.core as pyansys_geometry
+        from ansys.geometry.core.errors import GeometryRuntimeError
 
         if pyansys_geometry.DISABLE_MULTIPLE_DESIGN_CHECK:
             # If the user has disabled the check, then we can skip it
@@ -66,12 +67,16 @@ def get_design_ref(obj) -> "Design":
         # Get the design reference
         design = get_design_ref(self)
 
+        # Verify whether the Design has been closed on the backend
+        if design.is_closed:
+            raise GeometryRuntimeError(
+                "The design has been closed on the backend. Cannot perform any operations on it."
+            )
+
         # Activate the design if it is not active
         if not design.is_active:
             # First, check the backend allows for multiple documents
             if not design._grpc_client.multiple_designs_allowed:
-                from ansys.geometry.core.errors import GeometryRuntimeError
-
                 raise GeometryRuntimeError(
                     "The design is not active and multiple designs are "
                     "not allowed with the current backend."

src/ansys/geometry/core/modeler.py

@@ -225,19 +225,34 @@ def read_existing_design(self) -> "Design":
             )
         return self._designs[design.design_id]
 
-    def close(self) -> None:
-        """Access the client's close method."""
+    def close(self, close_designs: bool = True) -> None:
+        """Access the client's close method.
+
+        Parameters
+        ----------
+        close_designs : bool, default: True
+            Whether to close all designs before closing the client.
+        """
+        # Close all designs (if requested)
+        [design.close() for design in self._designs.values() if close_designs]
+
+        # Close the client
         self.client.close()
 
-    def exit(self) -> None:
+    def exit(self, close_designs: bool = True) -> None:
         """Access the client's close method.
 
         Notes
         -----
         This method is calling the same method as
         :func:`close() <ansys.geometry.core.modeler.Modeler.close>`.
+
+        Parameters
+        ----------
+        close_designs : bool, default: True
+            Whether to close all designs before closing the client.
         """
-        self.close()
+        self.close(close_designs=close_designs)
 
     def _upload_file(
         self,