feat: revolve faces and revolve faces by helix options (#1842)

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

Author: 4 people

doc/changelog.d/1842.added.md

@@ -0,0 +1 @@
+revolve faces and revolve faces by helix options

pyproject.toml

@@ -24,7 +24,7 @@ classifiers = [
 ]
 
 dependencies = [
-    "ansys-api-geometry==0.4.49",
+    "ansys-api-geometry==0.4.50",
     "ansys-tools-path>=0.3,<1",
     "attrs!=24.3.0",
     "beartype>=0.11.0,<0.20",

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

@@ -922,6 +922,7 @@ def revolve_faces(
         selection: Union["Face", list["Face"]],
         axis: Line,
         angle: Real,
+        extrude_type: ExtrudeType = ExtrudeType.ADD,
     ) -> list["Body"]:
         """Revolve face around an axis.
 
@@ -933,6 +934,8 @@ def revolve_faces(
             Axis of revolution.
         angle : Real
             Angular distance to revolve.
+        extrude_type : ExtrudeType, default: ExtrudeType.ADD
+            Type of extrusion to be performed.
 
         Returns
         -------
@@ -952,6 +955,7 @@ def revolve_faces(
                 selection=[object._grpc_id for object in selection],
                 axis=line_to_grpc_line(axis),
                 angle=angle,
+                extrude_type=extrude_type.value,
             )
         )
 
@@ -1035,6 +1039,7 @@ def revolve_faces_by_helix(
         taper_angle: Real,
         right_handed: bool,
         both_sides: bool,
+        extrude_type: ExtrudeType = ExtrudeType.ADD,
     ) -> list["Body"]:
         """Revolve face around an axis in a helix shape.
 
@@ -1056,6 +1061,8 @@ def revolve_faces_by_helix(
             Right-handed helix if ``True``, left-handed if ``False``.
         both_sides : bool,
             Create on both sides if ``True``, one side if ``False``.
+        extrude_type : ExtrudeType, default: ExtrudeType.ADD
+            Type of extrusion to be performed.
 
         Returns
         -------
@@ -1080,6 +1087,7 @@ def revolve_faces_by_helix(
                 taper_angle=taper_angle,
                 right_handed=right_handed,
                 both_sides=both_sides,
+                extrude_type=extrude_type.value,
             )
         )
 

tests/integration/test_geometry_commands.py

@@ -31,7 +31,7 @@
     OffsetMode,
 )
 from ansys.geometry.core.math import Plane, Point2D, Point3D, UnitVector3D
-from ansys.geometry.core.math.constants import UNITVECTOR3D_Z
+from ansys.geometry.core.math.constants import UNITVECTOR3D_Y, UNITVECTOR3D_Z
 from ansys.geometry.core.misc import UNITS
 from ansys.geometry.core.misc.measurements import Angle, Distance
 from ansys.geometry.core.modeler import Modeler
@@ -569,6 +569,59 @@ def test_revolve_faces(modeler: Modeler):
     assert len(base.faces) == 5
 
 
+def test_revolve_faces_with_options(modeler: Modeler):
+    # Parameters
+    pitch = 0.7
+    inner_diameter = 4
+    width = 7
+    height = 3.2
+
+    # Cylinder Creation
+    design = modeler.create_design("SquareNut")
+    sketch = Sketch()
+    sketch.circle(Point2D([0, 0], UNITS.mm), Quantity(inner_diameter / 2, UNITS.mm))
+    cylinder0 = design.extrude_sketch("SquareNut", sketch, Quantity(height, UNITS.mm))
+
+    # Create HexNut
+    sketch1 = Sketch()
+    sketch1.polygon(Point2D([0, 0]), Distance(width / 2, UNITS.mm), 4, Angle(45))
+    hex_nut = design.extrude_sketch("HexNut", sketch1, Quantity(height, UNITS.mm), "+", False)
+
+    copy1 = cylinder0.copy(design, "SquareNut")
+    copy2 = hex_nut.copy(design, "SquareNut")
+    copy2.subtract(copy1, False)
+    design.delete_body(design.bodies[0].id)
+    design.delete_body(design.bodies[0].id)
+
+    plane2 = Plane(
+        Point3D([0, (width) / 2, height], UNITS.mm),
+        direction_x=UnitVector3D([0, 1, 0]),
+        direction_y=UnitVector3D([0, 0, 1]),
+    )
+    sketch2 = Sketch(plane2)
+    sketch2.segment(Point2D([-2 * pitch, pitch], UNITS.mm), Point2D([3 * pitch, 0], UNITS.mm))
+    sketch2.segment(Point2D([3 * pitch, 0], UNITS.mm), Point2D([3 * pitch, -3 * pitch], UNITS.mm))
+    sketch2.segment(
+        Point2D([3 * pitch, -3 * pitch], UNITS.mm), Point2D([-2 * pitch, pitch], UNITS.mm)
+    )
+    cut_surface = design.create_surface("Cut", sketch2)
+
+    assert design.bodies[0].volume.m == pytest.approx(
+        Quantity(1.16587614e-7, UNITS.m**3).m, rel=1e-6, abs=1e-8
+    )
+
+    modeler.geometry_commands.revolve_faces(
+        cut_surface.faces,
+        Line(Point3D([0, 0, 0], UNITS.mm), UNITVECTOR3D_Z),
+        np.pi * 2,
+        ExtrudeType.CUT,
+    )
+
+    assert design.bodies[0].volume.m == pytest.approx(
+        Quantity(1.06173048542e-07, UNITS.m**3).m, rel=1e-6, abs=1e-8
+    )
+
+
 def test_revolve_faces_up_to(modeler: Modeler):
     """Test revolve faces up to."""
     design = modeler.create_design("revolve_faces_up_to")
@@ -614,6 +667,108 @@ def test_revolve_faces_by_helix(modeler: Modeler):
     assert len(base.faces) == 6
 
 
+def test_revolve_faces_by_helix_with_options(modeler: Modeler):
+    # Parameters
+    pitch = 0.7
+    inner_diameter = 4
+    width = 7
+    height = 3.2
+
+    thread_length = height - pitch / 2
+
+    # Cylinder Creation
+    design = modeler.create_design("SquareNut")
+    sketch = Sketch()
+    sketch.circle(Point2D([0, 0], UNITS.mm), Quantity(inner_diameter / 2, UNITS.mm))
+    cylinder0 = design.extrude_sketch("SquareNut", sketch, Quantity(height, UNITS.mm))
+
+    # Create HexNut
+    sketch1 = Sketch()
+    sketch1.polygon(Point2D([0, 0]), Distance(width / 2, UNITS.mm), 4, Angle(45))
+    hex_nut = design.extrude_sketch("HexNut", sketch1, Quantity(height, UNITS.mm), "+", False)
+
+    copy1 = cylinder0.copy(design, "SquareNut")
+    copy2 = hex_nut.copy(design, "SquareNut")
+    copy2.subtract(copy1, False)
+    design.delete_body(design.bodies[0].id)
+    design.delete_body(design.bodies[0].id)
+
+    plane2 = Plane(
+        Point3D([0, (width) / 2, height], UNITS.mm),
+        direction_x=UnitVector3D([0, 1, 0]),
+        direction_y=UnitVector3D([0, 0, 1]),
+    )
+    sketch2 = Sketch(plane2)
+    sketch2.segment(Point2D([-2 * pitch, pitch], UNITS.mm), Point2D([3 * pitch, 0], UNITS.mm))
+    sketch2.segment(Point2D([3 * pitch, 0], UNITS.mm), Point2D([3 * pitch, -3 * pitch], UNITS.mm))
+    sketch2.segment(
+        Point2D([3 * pitch, -3 * pitch], UNITS.mm), Point2D([-2 * pitch, pitch], UNITS.mm)
+    )
+    cut_surface = design.create_surface("Cut", sketch2)
+
+    assert design.bodies[0].volume.m == pytest.approx(
+        Quantity(1.16587614e-7, UNITS.m**3).m, rel=1e-6, abs=1e-8
+    )
+
+    modeler.geometry_commands.revolve_faces(
+        cut_surface.faces,
+        Line(Point3D([0, 0, 0], UNITS.mm), UNITVECTOR3D_Z),
+        np.pi * 2,
+        ExtrudeType.CUT,
+    )
+    assert design.bodies[0].volume.m == pytest.approx(
+        Quantity(1.06173048542e-07, UNITS.m**3).m, rel=1e-6, abs=1e-8
+    )
+
+    starting_face_count = len(design.bodies[0].faces)
+    current_face_count = len(design.bodies[0].faces)
+    x = 0
+    while starting_face_count == current_face_count:
+        if x > 1000:
+            break
+        modeler.geometry_commands.extrude_faces(design.bodies[0].faces[-1], (0.05) / 1000)
+        current_face_count = len(design.bodies[0].faces)
+        x += 1
+
+    thread_height = pitch * (3**0.5 / 2)
+    thread_plane = Plane(
+        Point3D([0, (inner_diameter) / 2, 0], UNITS.mm),
+        direction_x=UNITVECTOR3D_Y,
+        direction_y=UNITVECTOR3D_Z,
+    )
+    thread_sketch = Sketch(thread_plane)
+    thread_sketch.segment(Point2D([0, 0], UNITS.mm), Point2D([0, pitch / 2], UNITS.mm))
+    thread_sketch.segment(
+        Point2D([0, pitch / 2], UNITS.mm),
+        Point2D([thread_height * (3 / 8), (pitch / 2 - pitch / 8)], UNITS.mm),
+    )
+    thread_sketch.segment(
+        Point2D([thread_height * (3 / 8), (pitch / 2 - pitch / 8)], UNITS.mm),
+        Point2D([thread_height * (3 / 8), ((pitch / 4) / 2)], UNITS.mm),
+    )
+    thread_sketch.segment(
+        Point2D([0, 0], UNITS.mm), Point2D([thread_height * (3 / 8), ((pitch / 4) / 2)], UNITS.mm)
+    )
+    thread_surface = design.create_surface("Thread", thread_sketch)
+    dir = UNITVECTOR3D_Z
+    axs = UNITVECTOR3D_Z
+    modeler.geometry_commands.revolve_faces_by_helix(
+        thread_surface.faces[0],
+        Line(Point3D([0, 0, 0], UNITS.mm), axs),
+        dir,
+        2 * thread_length / 1000,
+        pitch / 1000,
+        0,
+        True,
+        True,
+        ExtrudeType.CUT,
+    )
+
+    assert design.bodies[0].volume.m == pytest.approx(
+        Quantity(1.06173048542e-07, UNITS.m**3).m, rel=1e-6, abs=1e-8
+    )
+
+
 def test_replace_face(modeler: Modeler):
     """Test replacing a face with another face."""
     design = modeler.create_design("replace_face")