feat: Add misc. repair and prepare tool methods (#1293)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: Kathy Pippert <[email protected]>
Co-authored-by: Roberto Pastor Muela <[email protected]>
Co-authored-by: Umut Soysal <[email protected]>

Author: 6 people

doc/changelog.d/1293.added.md

@@ -0,0 +1 @@
+feat: Add misc. repair and prepare tool methods

src/ansys/geometry/core/tools/prepare_tools.py

@@ -22,13 +22,16 @@
 """Provides tools for preparing geometry for use with simulation."""
 
 from ansys.api.dbu.v0.dbumodels_pb2 import EntityIdentifier
+from ansys.api.geometry.v0.models_pb2 import Body as GRPCBody
 from ansys.api.geometry.v0.preparetools_pb2 import (
     ExtractVolumeFromEdgeLoopsRequest,
     ExtractVolumeFromFacesRequest,
+    ShareTopologyRequest,
 )
 from ansys.api.geometry.v0.preparetools_pb2_grpc import PrepareToolsStub
 from beartype import beartype as check_input_types
 from beartype.typing import TYPE_CHECKING, List
+from google.protobuf.wrappers_pb2 import BoolValue, DoubleValue
 
 from ansys.geometry.core.connection import GrpcClient
 from ansys.geometry.core.errors import protect_grpc
@@ -38,6 +41,7 @@
     get_design_from_face,
 )
 from ansys.geometry.core.misc.checks import min_backend_version
+from ansys.geometry.core.typing import Real
 
 if TYPE_CHECKING:  # pragma: no cover
     from ansys.geometry.core.designer.body import Body
@@ -148,3 +152,37 @@ def extract_volume_from_edge_loops(
         else:
             self._grpc_client.log.info("Failed to extract volume from edge loops...")
             return []
+
+    @protect_grpc
+    @check_input_types
+    @min_backend_version(25, 1, 0)
+    def share_topology(
+        self, bodies: List["Body"], tol: Real = 0.0, preserve_instances: bool = False
+    ) -> bool:
+        """Share topology between the chosen bodies.
+
+        Parameters
+        ----------
+        bodies : List[Body]
+            List of bodies to share topology between.
+        tol : Real
+            Maximum distance between bodies.
+        preserve_instances : bool
+            Whether instances are preserved.
+
+        Returns
+        -------
+        bool
+            ``True`` if successful, ``False`` if failed.
+        """
+        if not bodies:
+            return False
+
+        share_topo_response = self._prepare_stub.ShareTopology(
+            ShareTopologyRequest(
+                selection=[GRPCBody(id=body.id) for body in bodies],
+                tolerance=DoubleValue(value=tol),
+                preserve_instances=BoolValue(value=preserve_instances),
+            )
+        )
+        return share_topo_response.result

src/ansys/geometry/core/tools/problem_areas.py

@@ -25,8 +25,10 @@
 
 from ansys.api.geometry.v0.repairtools_pb2 import (
     FixDuplicateFacesRequest,
+    FixExtraEdgesRequest,
     FixInexactEdgesRequest,
     FixMissingFacesRequest,
+    FixShortEdgesRequest,
     FixSmallFacesRequest,
     FixSplitEdgesRequest,
     FixStitchFacesRequest,
@@ -269,9 +271,86 @@ def edges(self) -> List["Edge"]:
         """The list of the ids of the edges connected to this problem area."""
         return self._edges
 
+    def fix(self) -> RepairToolMessage:
+        """Fix the problem area.
+
+        Returns
+        -------
+        message: RepairToolMessage
+            Message containing created and/or modified bodies.
+        """
+        if not self.edges:
+            return RepairToolMessage(False, [], [])
+
+        parent_design = get_design_from_edge(self.edges[0])
+        request = FixExtraEdgesRequest(extra_edge_problem_area_id=self._id_grpc)
+        response = self._repair_stub.FixExtraEdges(request)
+        parent_design._update_design_inplace()
+        message = RepairToolMessage(
+            response.result.success,
+            response.result.created_bodies_monikers,
+            response.result.modified_bodies_monikers,
+        )
+
+        return message
+
+
+class ShortEdgeProblemAreas(ProblemArea):
+    """Represents a short edge problem area with a unique identifier and associated edges.
+
+    Parameters
+    ----------
+    id : str
+        Server-defined ID for the body.
+    grpc_client : GrpcClient
+        Active supporting geometry service instance for design modeling.
+    edges : List[Edge]
+        List of edges associated with the design.
+    """
+
+    def __init__(self, id: str, grpc_client: GrpcClient, edges: List["Edge"]):
+        """Initialize a new instance of the ``ShortEdgeProblemAreas`` class."""
+        super().__init__(id, grpc_client)
+
+        from ansys.geometry.core.designer.edge import Edge
+
+        # Verify that all elements in the list are edges
+        check_type_all_elements_in_iterable(edges, Edge)
+
+        self._edges = edges
+
+    @property
+    def edges(self) -> List["Edge"]:
+        """The list of the ids of the edges connected to this problem area."""
+        return self._edges
+
+    def fix(self) -> RepairToolMessage:
+        """Fix the problem area.
+
+        Returns
+        -------
+        message: RepairToolMessage
+            Message containing created and/or modified bodies.
+        """
+        if not self.edges:
+            return RepairToolMessage(False, [], [])
+
+        parent_design = get_design_from_edge(self.edges[0])
+        response = self._repair_stub.FixShortEdges(
+            FixShortEdgesRequest(short_edge_problem_area_id=self._id_grpc)
+        )
+        parent_design._update_design_inplace()
+        message = RepairToolMessage(
+            response.result.success,
+            response.result.created_bodies_monikers,
+            response.result.modified_bodies_monikers,
+        )
+
+        return message
+
 
 class SmallFaceProblemAreas(ProblemArea):
-    """Represents a small face problem area with unique identifier and associated faces.
+    """Represents a small face problem area with a unique identifier and associated faces.
 
     Parameters
     ----------

src/ansys/geometry/core/tools/repair_tools.py

@@ -21,11 +21,13 @@
 # SOFTWARE.
 """Provides tools for repairing bodies."""
 
+from ansys.api.geometry.v0.bodies_pb2_grpc import BodiesStub
 from ansys.api.geometry.v0.repairtools_pb2 import (
     FindDuplicateFacesRequest,
     FindExtraEdgesRequest,
     FindInexactEdgesRequest,
     FindMissingFacesRequest,
+    FindShortEdgesRequest,
     FindSmallFacesRequest,
     FindSplitEdgesRequest,
     FindStitchFacesRequest,
@@ -46,6 +48,7 @@
     ExtraEdgeProblemAreas,
     InexactEdgeProblemAreas,
     MissingFaceProblemAreas,
+    ShortEdgeProblemAreas,
     SmallFaceProblemAreas,
     SplitEdgeProblemAreas,
     StitchFaceProblemAreas,
@@ -60,9 +63,10 @@ class RepairTools:
     """Repair tools for PyAnsys Geometry."""
 
     def __init__(self, grpc_client: GrpcClient):
-        """Initialize Repair Tools class."""
+        """Initialize a new instance of the ``RepairTools`` class."""
         self._grpc_client = grpc_client
         self._repair_stub = RepairToolsStub(self._grpc_client.channel)
+        self._bodies_stub = BodiesStub(self._grpc_client.channel)
 
     def find_split_edges(
         self, bodies: List["Body"], angle: Real = 0.0, length: Real = 0.0
@@ -101,7 +105,7 @@ def find_split_edges(
         parent_design = get_design_from_body(bodies[0])
         return [
             SplitEdgeProblemAreas(
-                str(res.id),
+                f"{res.id}",
                 self._grpc_client,
                 get_edges_from_ids(parent_design, res.edge_monikers),
             )
@@ -135,7 +139,7 @@ def find_extra_edges(self, bodies: List["Body"]) -> List[ExtraEdgeProblemAreas]:
 
         return [
             ExtraEdgeProblemAreas(
-                str(res.id),
+                f"{res.id}",
                 self._grpc_client,
                 get_edges_from_ids(parent_design, res.edge_monikers),
             )
@@ -170,7 +174,45 @@ def find_inexact_edges(self, bodies: List["Body"]) -> List[InexactEdgeProblemAre
 
         return [
             InexactEdgeProblemAreas(
-                str(res.id),
+                f"{res.id}",
+                self._grpc_client,
+                get_edges_from_ids(parent_design, res.edge_monikers),
+            )
+            for res in problem_areas_response.result
+        ]
+
+    def find_short_edges(
+        self, bodies: List["Body"], length: Real = 0.0
+    ) -> List[ShortEdgeProblemAreas]:
+        """Find the short edge problem areas.
+
+        This method finds the short edge problem areas and returns a list of
+        these objects.
+
+        Parameters
+        ----------
+        bodies : List[Body]
+            List of bodies that short edges are investigated on.
+
+        Returns
+        -------
+        List[ShortEdgeProblemAreas]
+            List of objects representing short edge problem areas.
+        """
+        if not bodies:
+            return []
+
+        problem_areas_response = self._repair_stub.FindShortEdges(
+            FindShortEdgesRequest(
+                selection=[body.id for body in bodies],
+                max_edge_length=DoubleValue(value=length),
+            )
+        )
+
+        parent_design = get_design_from_body(bodies[0])
+        return [
+            ShortEdgeProblemAreas(
+                f"{res.id}",
                 self._grpc_client,
                 get_edges_from_ids(parent_design, res.edge_monikers),
             )
@@ -204,7 +246,7 @@ def find_duplicate_faces(self, bodies: List["Body"]) -> List[DuplicateFaceProble
         parent_design = get_design_from_body(bodies[0])
         return [
             DuplicateFaceProblemAreas(
-                str(res.id),
+                f"{res.id}",
                 self._grpc_client,
                 get_faces_from_ids(parent_design, res.face_monikers),
             )
@@ -237,7 +279,7 @@ def find_missing_faces(self, bodies: List["Body"]) -> List[MissingFaceProblemAre
 
         return [
             MissingFaceProblemAreas(
-                str(res.id),
+                f"{res.id}",
                 self._grpc_client,
                 get_edges_from_ids(parent_design, res.edge_monikers),
             )
@@ -271,7 +313,7 @@ def find_small_faces(self, bodies: List["Body"]) -> List[SmallFaceProblemAreas]:
 
         return [
             SmallFaceProblemAreas(
-                str(res.id),
+                f"{res.id}",
                 self._grpc_client,
                 get_faces_from_ids(parent_design, res.face_monikers),
             )
@@ -301,7 +343,7 @@ def find_stitch_faces(self, bodies: List["Body"]) -> List[StitchFaceProblemAreas
         parent_design = get_design_from_body(bodies[0])
         return [
             StitchFaceProblemAreas(
-                str(res.id),
+                f"{res.id}",
                 self._grpc_client,
                 get_bodies_from_ids(parent_design, res.body_monikers),
             )

tests/integration/files/ShortEdgesBefore.scdocx

@@ -57,3 +57,11 @@ def test_volume_extract_from_edge_loops(modeler: Modeler):
     )
 
     assert len(created_bodies) == 1
+
+
+def test_share_topology(modeler: Modeler):
+    """Test share topology operation is between two bodies."""
+    skip_if_linux(modeler, test_share_topology.__name__, "prepare_tools")  # Skip test on Linux
+    design = modeler.open_file(FILES_DIR / "MixingTank.scdocx")
+
+    assert modeler.prepare_tools.share_topology(design.bodies)

tests/integration/test_prepare_tools.py

@@ -21,6 +21,8 @@
 # SOFTWARE.
 """ "Testing of repair tools."""
 
+import pytest
+
 from ansys.geometry.core.modeler import Modeler
 
 from .conftest import FILES_DIR, skip_if_linux
@@ -89,6 +91,15 @@ def test_find_extra_edge_edges(modeler: Modeler):
     assert len(problem_areas[0].edges) > 0
 
 
+@pytest.mark.skip(reason="This test is failing on the Geometry Service - issue 1335")
+def test_fix_extra_edge(modeler: Modeler):
+    """Test to find and fix extra edge problem areas."""
+    skip_if_linux(modeler, test_fix_extra_edge.__name__, "repair_tools")  # Skip test on Linux
+    design = modeler.open_file(FILES_DIR / "ExtraEdgesDesignBefore.scdocx")
+    problem_areas = modeler.repair_tools.find_extra_edges(design.bodies)
+    assert problem_areas[0].fix().success is True
+
+
 def test_find_inexact_edges(modeler: Modeler):
     """Test to read geometry and find it's inexact edge problem areas."""
     skip_if_linux(modeler, test_find_inexact_edges.__name__, "repair_tools")  # Skip test on Linux
@@ -276,3 +287,19 @@ def test_fix_stitch_face(modeler: Modeler):
     assert message.success is True
     assert len(message.created_bodies) == 0
     assert len(message.modified_bodies) > 0
+
+
+def test_find_short_edges(modeler: Modeler):
+    """Test to read geometry and find it's short edge problem areas."""
+    skip_if_linux(modeler, test_find_short_edges.__name__, "repair_tools")  # Skip test on Linux
+    design = modeler.open_file(FILES_DIR / "ShortEdgesBefore.scdocx")
+    problem_areas = modeler.repair_tools.find_short_edges(design.bodies, 10)
+    assert len(problem_areas) == 12
+
+
+def test_fix_short_edges(modeler: Modeler):
+    """Test to read geometry and find and fix it's short edge problem areas."""
+    skip_if_linux(modeler, test_fix_short_edges.__name__, "repair_tools")  # Skip test on Linux
+    design = modeler.open_file(FILES_DIR / "ShortEdgesBefore.scdocx")
+    problem_areas = modeler.repair_tools.find_short_edges(design.bodies, 10)
+    assert problem_areas[0].fix().success is True