Adaptive templates delete region API call (#191)

* Initial commit * Review changes * Update src/ansys/motorcad/core/methods/adaptive_geometry.py --------- Co-authored-by: JackDavies <[email protected]> Co-authored-by: jgsdavies <[email protected]>
ansys · Oct 9, 2023 · d25c7a0 · d25c7a0
1 parent cf6ab8d
commit d25c7a0
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/src/ansys/motorcad/core/methods/adaptive_geometry.py b/src/ansys/motorcad/core/methods/adaptive_geometry.py
@@ -173,3 +173,22 @@ def unite_regions(self, region, regions):
         region._from_json(united_raw)
 
         return region
+
+    def delete_region(self, region, remove_children=False):
+        """Delete region from Motor-CAD geometry engine.
+
+        Parameters
+        ----------
+        region : ansys.motorcad.core.geometry.Region
+            Motor-CAD region object
+
+        remove_children : boolean
+            Whether to remove regions children
+        """
+        self.connection.ensure_version_at_least("2024.0")
+
+        raw_region = region._to_json()
+
+        method = "DeleteRegion"
+        params = [raw_region, remove_children]
+        self.connection.send_and_receive(method, params)
diff --git a/tests/test_geometry.py b/tests/test_geometry.py
@@ -804,3 +804,14 @@ def test_check_collisions_3():
     collisions = mc.check_collisions(square, [triangle])
     assert len(collisions) == 1
     assert collisions[0] == triangle
+
+
+def test_delete_region():
+    stator = mc.get_region("Stator")
+
+    mc.delete_region(stator)
+
+    with pytest.raises(Exception) as e_info:
+        mc.get_region("Stator")
+
+    assert "Failed to find region with name" in str(e_info.value)