feat: revolve_sketch rotation definition enhancement (#1336)

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

Author: RobPasMue

doc/changelog.d/1336.added.md

@@ -0,0 +1 @@
+feat: ``revolve_sketch`` rotation definition enhancement

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

@@ -592,12 +592,6 @@ def revolve_sketch(
     ) -> Body:
         """Create a solid body by revolving a sketch profile around an axis.
 
-        Notes
-        -----
-        It is important that the sketch plane origin is not coincident with the rotation
-        origin. If the sketch plane origin is coincident with the rotation origin, the
-        distance between the two points is zero, and the revolve operation fails.
-
         Parameters
         ----------
         name : str
@@ -616,26 +610,16 @@ def revolve_sketch(
         Body
             Revolved body from the given sketch.
         """
-        # Check that the sketch plane origin is not coincident with the rotation origin
-        if sketch.plane.origin == rotation_origin:
-            raise ValueError(
-                "The sketch plane origin is coincident with the rotation origin. "
-                + "The distance between the points is zero, and the revolve operation will fail."
-            )
-
-        # Compute the distance between the rotation origin and the sketch plane
-        rotation_origin_to_sketch = sketch.plane.origin - rotation_origin
-        rotation_origin_to_sketch_as_vector = Vector3D(rotation_origin_to_sketch)
-        distance = Distance(
-            rotation_origin_to_sketch_as_vector.norm,
-            unit=rotation_origin_to_sketch.base_unit,
-        )
+        # Based on the reference axis and the sketch plane's normal, retrieve the orthogonal
+        # vector (i.e. this is the reference vector for the Circle object). Assuming a distance of 1
+        # we revolve around the axis the angle given.
+        rotation_vector = sketch._plane.normal.cross(axis)
 
         # Define the revolve path
         circle = Circle(
             rotation_origin,
-            radius=distance,
-            reference=rotation_origin_to_sketch_as_vector,
+            radius=Distance(1),
+            reference=rotation_vector,
             axis=axis,
         )
         angle = angle if isinstance(angle, Angle) else Angle(angle)

tests/integration/test_design.py

@@ -2390,10 +2390,43 @@ def test_revolve_sketch(modeler: Modeler):
     assert np.isclose(body.volume.m, np.pi**2 * 2 * 5, rtol=1e-3)  # quarter of a torus volume
 
 
-def test_revolve_sketch_fail(modeler: Modeler):
-    """Test demonstrating the failure of revolving a sketch when it is located
-    in the same origin.
+def test_revolve_sketch_coincident_origins(modeler: Modeler):
+    """Test demonstrating revolving a sketch when it is located
+    in the same origin does not fail.
     """
+    # Initialize a sphere sketch design given a semicircle profile
+    design = modeler.create_design("revolve-coincident-origins")
+
+    # Create an XZ plane centered at (0, 0, 0)
+    plane_profile = Plane(
+        origin=Point3D([0, 0, 0]), direction_x=UNITVECTOR3D_X, direction_y=UNITVECTOR3D_Z
+    )
+    profile = Sketch(plane=plane_profile)
+    (
+        profile.segment_to_point(Point2D([1, 0]))
+        .arc_to_point(Point2D([-1, 0]), Point2D([0, 0]))
+        .segment_to_point(Point2D([0, 0]))
+    )
+
+    # Try revolving the profile... coincident origins is not a problem anymore
+    body = design.revolve_sketch(
+        "cross-section-sphere",
+        sketch=profile,
+        axis=UNITVECTOR3D_X,
+        angle=Angle(90, unit=UNITS.degrees),
+        rotation_origin=Point3D([0, 0, 0]),
+    )
+
+    assert body.is_surface is False
+    assert body.name == "cross-section-sphere"
+    assert np.isclose(
+        body.volume.m, np.pi / 3, rtol=1e-3
+    )  # quarter of a sphere volume (4/3 * pi * r^3) / 4
+    # 1/3 * pi * r^3 --> r = 1 --> 1/3 * pi
+
+
+def test_revolve_sketch_fail_invalid_path(modeler: Modeler):
+    """Test demonstrating the failure of revolving a sketch when an invalid path is provided."""
     # Initialize the donut sketch design
     design = modeler.create_design("revolve-fail")
 
@@ -2402,13 +2435,14 @@ def test_revolve_sketch_fail(modeler: Modeler):
         origin=Point3D([0, 0, 0]), direction_x=UNITVECTOR3D_X, direction_y=UNITVECTOR3D_Z
     )
     profile = Sketch(plane=plane_profile)
+    profile.circle(Point2D([0, 0]), 1)
 
     # Try revolving the profile...
     with pytest.raises(
-        ValueError, match="The sketch plane origin is coincident with the rotation origin."
+        GeometryExitedError, match="The path is invalid, or it is unsuitable for the profile."
     ):
         design.revolve_sketch(
-            "donut-body",
+            "cross-section-sphere",
             sketch=profile,
             axis=UNITVECTOR3D_Z,
             angle=Angle(90, unit=UNITS.degrees),

tests/integration/test_issues.py

@@ -25,8 +25,15 @@
 
 import numpy as np
 
-from ansys.geometry.core.math import UNITVECTOR3D_X, UNITVECTOR3D_Y, Plane, Point2D, Point3D
-from ansys.geometry.core.misc import DEFAULT_UNITS, UNITS, Distance
+from ansys.geometry.core.math import (
+    UNITVECTOR3D_X,
+    UNITVECTOR3D_Y,
+    UNITVECTOR3D_Z,
+    Plane,
+    Point2D,
+    Point3D,
+)
+from ansys.geometry.core.misc import DEFAULT_UNITS, UNITS, Angle, Distance
 from ansys.geometry.core.modeler import Modeler
 from ansys.geometry.core.sketch import Sketch
 
@@ -130,3 +137,45 @@ def test_issue_1304_arc_sketch_creation():
     finally:
         # Reverse the default units to meter
         DEFAULT_UNITS.LENGTH = UNITS.meter
+
+
+def test_issue_1309_revolve_operation_with_coincident_origins(modeler: Modeler):
+    """Test that revolving a sketch with coincident origins (sketch and rotation origin)
+    does not crash the program.
+
+    For more info see
+    https://github.com/ansys/pyansys-geometry/issues/1309
+    """
+    # Sketch Plane
+    sketch_plane = Plane(
+        origin=Point3D([0, 0, 5]), direction_x=UNITVECTOR3D_X, direction_y=UNITVECTOR3D_Z
+    )
+
+    # Create Base
+    sketch = Sketch(sketch_plane)
+
+    (
+        sketch.arc(
+            start=Point2D([0, 0]),
+            end=Point2D([4.7, 4.7]),
+            center=Point2D([0, 4.7]),
+            clockwise=False,
+        )
+        .segment_to_point(Point2D([4.7, 12]))
+        .segment_to_point(Point2D([-25.3, 12]))
+        .segment_to_point(Point2D([-25.3, 0]))
+        .segment_to_point(Point2D([0, 0]))
+    )
+
+    # Create Component (Revolve sketch)
+    design = modeler.create_design("cylinder")
+    component = design.add_component("cylinder_toroid")
+    revolved_body = component.revolve_sketch(
+        "toroid",
+        sketch=sketch,
+        axis=UNITVECTOR3D_X,
+        angle=Angle(360, UNITS.degrees),
+        rotation_origin=Point3D([-10.3, 0, 0]),
+    )
+
+    assert revolved_body.name == "toroid"