Add design points and modify named selection (#219)

Co-authored-by: Roberto Pastor Muela <roberto.pastormuela@ansys.com>
Co-authored-by: Maxime Rey <87315832+MaxJPRey@users.noreply.github.com>
Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>

Author: 3 people

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

@@ -3,6 +3,7 @@
 from ansys.geometry.core.designer.body import Body, MidSurfaceOffsetType, TemplateBody
 from ansys.geometry.core.designer.component import Component, SharedTopologyType
 from ansys.geometry.core.designer.design import Design, DesignFileFormat
+from ansys.geometry.core.designer.designpoint import DesignPoint
 from ansys.geometry.core.designer.edge import CurveType, Edge
 from ansys.geometry.core.designer.face import Face, SurfaceType
 from ansys.geometry.core.designer.part import Part, TransformedPart

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

@@ -12,7 +12,7 @@
     TranslateRequest,
 )
 from ansys.api.geometry.v0.bodies_pb2_grpc import BodiesStub
-from ansys.api.geometry.v0.commands_pb2 import CreateBeamSegmentsRequest
+from ansys.api.geometry.v0.commands_pb2 import CreateBeamSegmentsRequest, CreateDesignPointsRequest
 from ansys.api.geometry.v0.commands_pb2_grpc import CommandsStub
 from ansys.api.geometry.v0.components_pb2 import (
     CreateRequest,
@@ -37,6 +37,7 @@
 from ansys.geometry.core.designer.beam import Beam, BeamProfile
 from ansys.geometry.core.designer.body import Body, TemplateBody
 from ansys.geometry.core.designer.coordinate_system import CoordinateSystem
+from ansys.geometry.core.designer.designpoint import DesignPoint
 from ansys.geometry.core.designer.face import Face
 from ansys.geometry.core.designer.part import Part, TransformedPart
 from ansys.geometry.core.errors import protect_grpc
@@ -96,6 +97,7 @@ class Component:
     _components: List["Component"]
     _beams: List[Beam]
     _coordinate_systems: List[CoordinateSystem]
+    _design_points: List[DesignPoint]
 
     @protect_grpc
     @check_input_types
@@ -132,6 +134,7 @@ def __init__(
         self._components = []
         self._beams = []
         self._coordinate_systems = []
+        self._design_points = []
         self._parent_component = parent_component
         self._is_alive = True
         self._shared_topology = None
@@ -192,6 +195,11 @@ def beams(self) -> List[Beam]:
         """``Beam`` objects inside of the component."""
         return self._beams
 
+    @property
+    def design_points(self) -> List[DesignPoint]:
+        """``DesignPoint`` objects inside of the component."""
+        return self._design_points
+
     @property
     def coordinate_systems(self) -> List[CoordinateSystem]:
         """``CoordinateSystem`` objects inside of the component."""
@@ -730,6 +738,57 @@ def delete_body(self, body: Union[Body, str]) -> None:
             )
             pass
 
+    def add_design_point(
+        self,
+        name: str,
+        point: Point3D,
+    ) -> DesignPoint:
+        """Creates a single design point.
+
+        Parameters
+        ----------
+        name : str
+            User-defined label for the design points.
+        points : Point3D
+            3D point constituting the design point.
+        """
+        return self.add_design_points(name, [point])[0]
+
+    @protect_grpc
+    @check_input_types
+    def add_design_points(
+        self,
+        name: str,
+        points: List[Point3D],
+    ) -> List[DesignPoint]:
+        """Creates a list of design points.
+
+        Parameters
+        ----------
+        name : str
+            User-defined label for the design points.
+        points : List[Point3D]
+            List of 3D points constituting the design points.
+        """
+        # Create DesignPoint objects server-side
+        self._grpc_client.log.debug(f"Creating design points on {self.id}...")
+        response = self._commands_stub.CreateDesignPoints(
+            CreateDesignPointsRequest(
+                points=[point3d_to_grpc_point(point) for point in points], parent=self.id
+            )
+        )
+        self._grpc_client.log.debug("Design points successfully created.")
+
+        # Once created on the server, create them client side
+        new_design_points = []
+        n_design_points = len(response.ids)
+        for index in range(n_design_points):
+            new_design_points.append((DesignPoint(response.ids[index], name, points[index], self)))
+        self._design_points.extend(new_design_points)
+
+        # Finally return the list of created DesignPoint objects
+        return self._design_points[-n_design_points:]
+
     @protect_grpc
     @check_input_types
     def delete_beam(self, beam: Union[Beam, str]) -> None:
@@ -1048,5 +1107,6 @@ def __repr__(self) -> str:
         lines.append(f"  N Bodies             : {sum(alive_bodies)}")
         lines.append(f"  N Beams              : {sum(alive_beams)}")
         lines.append(f"  N Coordinate Systems : {sum(alive_coords)}")
+        lines.append(f"  N Design Points      : {len(self.design_points)}")
         lines.append(f"  N Components         : {sum(alive_comps)}")
         return "\n".join(lines)

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

@@ -24,9 +24,10 @@
 from pint import Quantity
 
 from ansys.geometry.core.connection import GrpcClient, plane_to_grpc_plane, point3d_to_grpc_point
-from ansys.geometry.core.designer.beam import BeamCircularProfile, BeamProfile
+from ansys.geometry.core.designer.beam import Beam, BeamCircularProfile, BeamProfile
 from ansys.geometry.core.designer.body import Body, MidSurfaceOffsetType
 from ansys.geometry.core.designer.component import Component, SharedTopologyType
+from ansys.geometry.core.designer.designpoint import DesignPoint
 from ansys.geometry.core.designer.edge import Edge
 from ansys.geometry.core.designer.face import Face
 from ansys.geometry.core.designer.selection import NamedSelection
@@ -213,6 +214,8 @@ def create_named_selection(
         bodies: Optional[List[Body]] = None,
         faces: Optional[List[Face]] = None,
         edges: Optional[List[Edge]] = None,
+        beams: Optional[List[Beam]] = None,
+        design_points: Optional[List[DesignPoint]] = None,
     ) -> NamedSelection:
         """Create a named selection on the active Geometry server instance.
 
@@ -226,14 +229,24 @@ def create_named_selection(
             All faces to include in the named selection.
         edges : List[Edge], default: None
             All edges to include in the named selection.
+        beams : List[Beam], default: None
+            All beams to include in the named selection.
+        design_points : List[DesignPoints], default: None
+            All design points to include in the named selection.
 
         Returns
         -------
         NamedSelection
             Newly created named selection maintaining references to all target entities.
         """
         named_selection = NamedSelection(
-            name, self._grpc_client, bodies=bodies, faces=faces, edges=edges
+            name,
+            self._grpc_client,
+            bodies=bodies,
+            faces=faces,
+            edges=edges,
+            beams=beams,
+            design_points=design_points,
         )
         self._named_selections[named_selection.name] = named_selection
 
@@ -479,4 +492,5 @@ def __repr__(self):
         lines.append(f"  N Named Selections   : {len(self.named_selections)}")
         lines.append(f"  N Materials          : {len(self.materials)}")
         lines.append(f"  N Beam Profiles      : {len(self.beam_profiles)}")
+        lines.append(f"  N Design Points      : {len(self.design_points)}")
         return "\n".join(lines)

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

@@ -0,0 +1,67 @@
+"""``DesignPoint`` class module."""
+
+from beartype.typing import TYPE_CHECKING, Union
+
+from ansys.geometry.core.math import Point3D
+from ansys.geometry.core.misc import check_type
+
+if TYPE_CHECKING:  # pragma: no cover
+    from ansys.geometry.core.designer.component import Component
+
+
+class DesignPoint:
+    """
+    Provides the ``DesignPoint`` class for creating design points in components.
+
+    Parameters
+    ----------
+    id : str
+        Server-defined ID for the design points.
+    name : str
+        User-defined label for the design points.
+    points : Point3D
+        3D point constituting the design points.
+    parent_component : Component
+        Parent component to nest the new design point under within the design assembly.
+    """
+
+    def __init__(self, id: str, name: str, point: Point3D, parent_component: "Component"):
+        """Constructor method for the ``DesignPoints`` class."""
+        from ansys.geometry.core.designer.component import Component
+
+        check_type(id, str)
+        check_type(name, str)
+        check_type(point, Point3D)
+        check_type(parent_component, Component)
+
+        self._id = id
+        self._name = name
+        self._value = point
+        self._parent_component = parent_component
+
+    @property
+    def id(self) -> str:
+        """ID of the design point."""
+        return self._id
+
+    @property
+    def name(self) -> str:
+        """Name of the design point."""
+        return self._name
+
+    @property
+    def value(self) -> Point3D:
+        """Design point value."""
+        return self._value
+
+    @property
+    def parent_component(self) -> Union["Component", None]:
+        """Component node that the design point is under."""
+        return self._parent_component
+
+    def __repr__(self) -> str:
+        """String representation of the design points."""
+        lines = [f"ansys.geometry.core.designer.DesignPoints {hex(id(self))}"]
+        lines.append(f"  Name                 : {self.name}")
+        lines.append(f"  Design Point         : {self.value}")
+        return "\n".join(lines)

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

@@ -6,7 +6,9 @@
 from beartype.typing import List, Optional
 
 from ansys.geometry.core.connection import GrpcClient
+from ansys.geometry.core.designer.beam import Beam
 from ansys.geometry.core.designer.body import Body
+from ansys.geometry.core.designer.designpoint import DesignPoint
 from ansys.geometry.core.designer.edge import Edge
 from ansys.geometry.core.designer.face import Face
 from ansys.geometry.core.errors import protect_grpc
@@ -33,6 +35,10 @@ class NamedSelection:
         All faces to include in the named selection.
     edges : List[Edge], default: None
         All edges to include in the named selection.
+    beams : List[Beam], default: None
+        All beams to include in the named selection.
+    design_points : List[DesignPoints], default: None
+        All design_points to include in the named selection.
     """
 
     @protect_grpc
@@ -44,6 +50,8 @@ def __init__(
         bodies: Optional[List[Body]] = None,
         faces: Optional[List[Face]] = None,
         edges: Optional[List[Edge]] = None,
+        beams: Optional[List[Beam]] = None,
+        design_points: Optional[List[DesignPoint]] = None,
     ):
         """Constructor method for the ``NamedSelection`` class."""
 
@@ -53,6 +61,10 @@ def __init__(
             faces = []
         if edges is None:
             edges = []
+        if beams is None:
+            beams = []
+        if design_points is None:
+            design_points = []
 
         self._grpc_client = grpc_client
         self._named_selections_stub = NamedSelectionsStub(grpc_client.channel)
@@ -64,6 +76,8 @@ def __init__(
         [ids.add(body.id) for body in bodies]
         [ids.add(face.id) for face in faces]
         [ids.add(edge.id) for edge in edges]
+        [ids.add(beam.id) for beam in beams]
+        [ids.add(dp.id) for dp in design_points]
 
         named_selection_request = CreateRequest(name=name, members=ids)
         self._grpc_client.log.debug("Requesting creation of named selection.")

tests/integration/test_design.py

@@ -656,6 +656,7 @@ def test_delete_body_component(modeler: Modeler):
     assert "N Named Selections   : 0" in design_str
     assert "N Materials          : 0" in design_str
     assert "N Beam Profiles      : 0" in design_str
+    assert "N Design Points      : 0" in design_str
 
     comp_1_str = str(comp_1)
     assert "ansys.geometry.core.designer.Component" in comp_1_str
@@ -665,6 +666,7 @@ def test_delete_body_component(modeler: Modeler):
     assert "N Bodies             : 0" in comp_1_str
     assert "N Beams              : 0" in comp_1_str
     assert "N Components         : 0" in comp_1_str
+    assert "N Design Points      : 0" in comp_1_str
     assert "N Coordinate Systems : 0" in comp_1_str
 
     body_1_str = str(body_1)
@@ -1178,6 +1180,89 @@ def test_midsurface_properties(modeler: Modeler):
     assert "Surface offset       : MidSurfaceOffsetType.BOTTOM" in surf_repr
 
 
+def test_design_points(modeler: Modeler):
+    """Test for verifying the ``DesignPoints``"""
+
+    # Create your design on the server side
+    design = modeler.create_design("DesignPoints")
+    point = Point3D([6, 66, 666], UNITS.mm)
+    design_points_1 = design.add_design_point("FirstPointSet", point)
+
+    # Check the design points
+    assert len(design.design_points) == 1
+    assert design_points_1.id is not None
+    assert design_points_1.name == "FirstPointSet"
+    assert design_points_1.value == point
+
+    # Create another set of design points
+    point_set_2 = [Point3D([10, 10, 10], UNITS.m), Point3D([20, 20, 20], UNITS.m)]
+    design_points_2 = design.add_design_points("SecondPointSet", point_set_2)
+
+    assert len(design.design_points) == 3
+
+    nested_component = design.add_component("NestedComponent")
+    design_point_3 = nested_component.add_design_point("Nested", Point3D([7, 77, 777], UNITS.mm))
+
+    assert design_point_3.id is not None
+    assert design_point_3.value == Point3D([7, 77, 777], UNITS.mm)
+    assert design_point_3.parent_component.id == nested_component.id
+    assert len(nested_component.design_points) == 1
+    assert nested_component.design_points[0] == design_point_3
+
+    design_point_1_str = str(design_points_1)
+    assert "ansys.geometry.core.designer.DesignPoint" in design_point_1_str
+    assert "  Name                 : FirstPointSet" in design_point_1_str
+    assert "  Design Point         : [0.006 0.066 0.666]" in design_point_1_str
+
+    design_point_2_str = str(design_points_2)
+    assert "ansys.geometry.core.designer.DesignPoint" in design_point_2_str
+    assert "  Name                 : SecondPointSet" in design_point_2_str
+    assert "  Design Point         : [10. 10. 10.]" in design_point_2_str
+    assert "ansys.geometry.core.designer.DesignPoint" in design_point_2_str
+    assert "  Name                 : SecondPointSet" in design_point_2_str
+    assert "  Design Point         : [20. 20. 20.]" in design_point_2_str
+
+
+def test_named_selections_beams(modeler: Modeler, skip_not_on_linux_service):
+    """Test for verifying the correct creation of ``NamedSelection`` with beams."""
+
+    # Create your design on the server side
+    design = modeler.create_design("NamedSelectionBeams_Test")
+
+    # Test creating a named selection out of beams
+    circle_profile_1 = design.add_beam_circular_profile(
+        "CircleProfile1", Quantity(10, UNITS.mm), Point3D([0, 0, 0]), UNITVECTOR3D_X, UNITVECTOR3D_Y
+    )
+    beam_1 = design.create_beam(
+        Point3D([9, 99, 999], UNITS.mm), Point3D([8, 88, 888], UNITS.mm), circle_profile_1
+    )
+    ns_beams = design.create_named_selection("CircleProfile", beams=[beam_1])
+    assert len(design.named_selections) == 1
+    assert design.named_selections[0].name == "CircleProfile"
+
+    # Try deleting this named selection
+    design.delete_named_selection(ns_beams)
+    assert len(design.named_selections) == 0
+
+
+def test_named_selections_design_points(modeler: Modeler):
+    """Test for verifying the correct creation of ``NamedSelection`` with design points."""
+
+    # Create your design on the server side
+    design = modeler.create_design("NamedSelectionBeams_Test")
+
+    # Test creating a named selection out of design_points
+    point_set_1 = Point3D([10, 10, 0], UNITS.m)
+    design_points_1 = design.add_design_point("FirstPointSet", point_set_1)
+    ns_despoint = design.create_named_selection("FirstPointSet", design_points=[design_points_1])
+    assert len(design.named_selections) == 1
+    assert design.named_selections[0].name == "FirstPointSet"
+
+    # Try deleting this named selection
+    design.delete_named_selection(ns_despoint)
+    assert len(design.named_selections) == 0
+
+
 def test_component_instances(modeler: Modeler, skip_not_on_linux_service):
     """Test creation of ``Component`` instances and the effects this has."""