feat: finalize version handling for design class (#2323)

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

Author: 4 people

doc/changelog.d/2323.added.md

@@ -0,0 +1 @@
+Finalize version handling for design class

src/ansys/geometry/core/_grpc/_services/base/beams.py

@@ -53,3 +53,13 @@ def create_descriptive_beam_segments(self, **kwargs) -> dict:
     def delete_beam(self, **kwargs) -> dict:
         """Delete a beam."""
         pass
+
+    @abstractmethod
+    def delete_beam_profile(self, **kwargs) -> dict:
+        """Remove a beam profile on the active geometry server instance."""
+        pass
+
+    @abstractmethod
+    def create_beam_circular_profile(self, **kwargs) -> dict:
+        """Add a new beam circular profile under the design for creating beams."""
+        pass

src/ansys/geometry/core/_grpc/_services/base/designs.py

@@ -103,3 +103,8 @@ def upload_file_stream(self, **kwargs) -> dict:
     def stream_design_tessellation(self, **kwargs) -> dict:
         """Stream the tessellation of a design."""
         pass
+
+    @abstractmethod
+    def download_file(self, **kwargs) -> dict:
+        """Download the design from the server."""
+        pass

src/ansys/geometry/core/_grpc/_services/v0/beams.py

@@ -21,18 +21,20 @@
 # SOFTWARE.
 """Module containing the beams service implementation for v0."""
 
+from ansys.api.geometry.v0.commands_pb2 import CreateBeamCircularProfileRequest
 import grpc
 
 from ansys.geometry.core.errors import protect_grpc
 
 from ..base.beams import GRPCBeamsService
-from ..base.conversions import to_distance
+from ..base.conversions import from_measurement_to_server_length, to_distance
 from .conversions import (
     build_grpc_id,
     from_grpc_curve_to_curve,
     from_grpc_frame_to_frame,
     from_grpc_material_to_material,
     from_grpc_point_to_point3d,
+    from_plane_to_grpc_plane,
     from_point3d_to_grpc_point,
 )
 
@@ -54,7 +56,7 @@ class GRPCBeamsServiceV0(GRPCBeamsService):
     def __init__(self, channel: grpc.Channel):  # noqa: D102
         from ansys.api.geometry.v0.commands_pb2_grpc import CommandsStub
 
-        self.stub = CommandsStub(channel)
+        self.commands_stub = CommandsStub(channel)
 
     @protect_grpc
     def create_beam_segments(self, **kwargs) -> dict:  # noqa: D102
@@ -79,7 +81,7 @@ def create_beam_segments(self, **kwargs) -> dict:  # noqa: D102
         )
 
         # Call the gRPC service
-        resp = self.stub.CreateBeamSegments(request)
+        resp = self.commands_stub.CreateBeamSegments(request)
 
         # Return the response - formatted as a dictionary
         return {
@@ -111,7 +113,7 @@ def create_descriptive_beam_segments(self, **kwargs) -> dict:  # noqa: D102
         )
 
         # Call the gRPC service
-        resp = self.stub.CreateDescriptiveBeamSegments(request)
+        resp = self.commands_stub.CreateDescriptiveBeamSegments(request)
 
         # Return the response - formatted as a dictionary
         return {
@@ -174,7 +176,34 @@ def delete_beam(self, **kwargs) -> dict:  # noqa: D102
         request = build_grpc_id(kwargs["beam_id"])
 
         # Call the gRPC service
-        _ = self.stub.DeleteBeam(request)
+        _ = self.commands_stub.DeleteBeam(request)
 
         # Return the response - formatted as a dictionary
         return {}
+
+    @protect_grpc
+    def delete_beam_profile(self, **kwargs) -> dict:  # noqa: D102
+        # Create the request - assumes all inputs are valid and of the proper type
+        request = build_grpc_id(id=kwargs["id"])
+
+        # Call the gRPC service
+        _ = self.commands_stub.DeleteBeamProfile(request)
+
+        # Return the response - formatted as a dictionary
+        return {}
+
+    @protect_grpc
+    def create_beam_circular_profile(self, **kwargs) -> dict:  # noqa: D102
+        # Create the request - assumes all inputs are valid and of the proper type
+        request = CreateBeamCircularProfileRequest(
+            origin=from_point3d_to_grpc_point(kwargs["center"]),
+            radius=from_measurement_to_server_length(kwargs["radius"]),
+            plane=from_plane_to_grpc_plane(kwargs["plane"]),
+            name=kwargs["name"],
+        )
+
+        # Call the gRPC service
+        response = self.commands_stub.CreateBeamCircularProfile(request)
+
+        # Return the response - formatted as a dictionary
+        return {"id": response.id}

src/ansys/geometry/core/_grpc/_services/v0/designs.py

@@ -21,6 +21,7 @@
 # SOFTWARE.
 """Module containing the designs service implementation for v0."""
 
+from google.protobuf.empty_pb2 import Empty
 import grpc
 
 from ansys.geometry.core.errors import protect_grpc
@@ -481,3 +482,11 @@ def stream_design_tessellation(self, **kwargs) -> dict:  # noqa: D102
         return {
             "tessellation": tess_map,
         }
+
+    @protect_grpc
+    def download_file(self, **kwargs) -> dict:  # noqa: D102
+        # Call the gRPC service
+        response = self.commands_stub.DownloadFile(Empty())
+
+        # Return the response - formatted as a dictionary
+        return {"data": response.data}

src/ansys/geometry/core/_grpc/_services/v1/beams.py

@@ -58,3 +58,11 @@ def create_descriptive_beam_segments(self, **kwargs) -> dict:  # noqa: D102
     @protect_grpc
     def delete_beam(self, **kwargs) -> dict:  # noqa: D102
         raise NotImplementedError
+
+    @protect_grpc
+    def delete_beam_profile(self, **kwargs) -> dict:  # noqa: D102
+        raise NotImplementedError
+
+    @protect_grpc
+    def create_beam_circular_profile(self, **kwargs) -> dict:  # noqa: D102
+        raise NotImplementedError

src/ansys/geometry/core/_grpc/_services/v1/designs.py

@@ -98,3 +98,7 @@ def upload_file_stream(self, **kwargs) -> dict:  # noqa: D102
     @protect_grpc
     def stream_design_tessellation(self, **kwargs) -> dict:  # noqa: D102
         raise NotImplementedError
+
+    @protect_grpc
+    def download_file(self, **kwargs) -> dict:  # noqa: D102
+        raise NotImplementedError

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

@@ -25,23 +25,12 @@
 from pathlib import Path
 from typing import Union
 
-from ansys.api.dbu.v0.dbumodels_pb2 import EntityIdentifier
-from ansys.api.geometry.v0.commands_pb2 import (
-    AssignMidSurfaceOffsetTypeRequest,
-    AssignMidSurfaceThicknessRequest,
-    CreateBeamCircularProfileRequest,
-)
 from ansys.api.geometry.v0.commands_pb2_grpc import CommandsStub
 from beartype import beartype as check_input_types
-from google.protobuf.empty_pb2 import Empty
 import numpy as np
 from pint import Quantity, UndefinedUnitError
 
 from ansys.geometry.core.connection.backend import BackendType
-from ansys.geometry.core.connection.conversions import (
-    plane_to_grpc_plane,
-    point3d_to_grpc_point,
-)
 from ansys.geometry.core.designer.beam import (
     Beam,
     BeamCircularProfile,
@@ -70,13 +59,13 @@
     ensure_design_is_active,
     min_backend_version,
 )
-from ansys.geometry.core.misc.measurements import DEFAULT_UNITS, Distance
+from ansys.geometry.core.misc.measurements import Distance
 from ansys.geometry.core.misc.options import ImportOptions, TessellationOptions
 from ansys.geometry.core.modeler import Modeler
 from ansys.geometry.core.parameters.parameter import Parameter, ParameterUpdateStatus
 from ansys.geometry.core.shapes.curves.trimmed_curve import TrimmedCurve
 from ansys.geometry.core.shapes.parameterization import Interval, ParamUV
-from ansys.geometry.core.typing import RealSequence
+from ansys.geometry.core.typing import Real, RealSequence
 
 
 @unique
@@ -330,9 +319,9 @@ def __export_and_download_legacy(self, format: DesignFileFormat) -> bytes:
         # Process response
         self._grpc_client.log.debug(f"Requesting design download in {format} format.")
         if format is DesignFileFormat.SCDOCX:
-            response = self._commands_stub.DownloadFile(Empty())
+            response = self._grpc_client.services.designs.download_file()
             received_bytes = bytes()
-            received_bytes += response.data
+            received_bytes += response.get("data")
         elif format in [
             DesignFileFormat.PARASOLID_TEXT,
             DesignFileFormat.PARASOLID_BIN,
@@ -818,17 +807,16 @@ def add_beam_circular_profile(
         if not dir_x.is_perpendicular_to(dir_y):
             raise ValueError("Direction X and direction Y must be perpendicular.")
 
-        request = CreateBeamCircularProfileRequest(
-            origin=point3d_to_grpc_point(center),
-            radius=radius.value.m_as(DEFAULT_UNITS.SERVER_LENGTH),
-            plane=plane_to_grpc_plane(Plane(center, dir_x, dir_y)),
+        self._grpc_client.log.debug(f"Creating a beam circular profile on {self.id}...")
+
+        response = self._grpc_client._services.beams.create_beam_circular_profile(
+            center=center,
+            radius=radius,
+            plane=Plane(center, dir_x, dir_y),
             name=name,
         )
 
-        self._grpc_client.log.debug(f"Creating a beam circular profile on {self.id}...")
-
-        response = self._commands_stub.CreateBeamCircularProfile(request)
-        profile = BeamCircularProfile(response.id, name, radius, center, dir_x, dir_y)
+        profile = BeamCircularProfile(response.get("id"), name, radius, center, dir_x, dir_y)
         self._beam_profiles[profile.name] = profile
 
         self._grpc_client.log.debug(
@@ -885,7 +873,9 @@ def set_parameter(self, dimension: Parameter) -> ParameterUpdateStatus:
     @protect_grpc
     @check_input_types
     @ensure_design_is_active
-    def add_midsurface_thickness(self, thickness: Quantity, bodies: list[Body]) -> None:
+    def add_midsurface_thickness(
+        self, thickness: Distance | Quantity | Real, bodies: list[Body]
+    ) -> None:
         """Add a mid-surface thickness to a list of bodies.
 
         Parameters
@@ -899,6 +889,7 @@ def add_midsurface_thickness(self, thickness: Quantity, bodies: list[Body]) -> N
         -----
         Only surface bodies will be eligible for mid-surface thickness assignment.
         """
+        thickness = thickness if isinstance(thickness, Distance) else Distance(thickness)
         # Store only assignable ids
         ids: list[str] = []
         ids_bodies: list[Body] = []
@@ -912,15 +903,11 @@ def add_midsurface_thickness(self, thickness: Quantity, bodies: list[Body]) -> N
                 )
 
         # Assign mid-surface thickness
-        self._commands_stub.AssignMidSurfaceThickness(
-            AssignMidSurfaceThicknessRequest(
-                bodies_or_faces=ids, thickness=thickness.m_as(DEFAULT_UNITS.SERVER_LENGTH)
-            )
-        )
+        self._grpc_client._services.bodies.assign_midsurface_thickness(ids=ids, thickness=thickness)
 
         # Once the assignment has gone fine, store the values
         for body in ids_bodies:
-            body._surface_thickness = thickness
+            body._surface_thickness = thickness.value
 
     @protect_grpc
     @check_input_types
@@ -952,8 +939,8 @@ def add_midsurface_offset(self, offset_type: MidSurfaceOffsetType, bodies: list[
                 )
 
         # Assign mid-surface offset type
-        self._commands_stub.AssignMidSurfaceOffsetType(
-            AssignMidSurfaceOffsetTypeRequest(bodies_or_faces=ids, offset_type=offset_type.value)
+        self._grpc_client._services.bodies.assign_midsurface_offset(
+            ids=ids, offset_type=offset_type
         )
 
         # Once the assignment has gone fine, store the values
@@ -976,7 +963,7 @@ def delete_beam_profile(self, beam_profile: BeamProfile | str) -> None:
         removal_obj = self._beam_profiles.get(removal_name, None)
 
         if removal_obj:
-            self._commands_stub.DeleteBeamProfile(EntityIdentifier(id=removal_obj.id))
+            self._grpc_client._services.beams.delete_beam_profile(id=removal_obj.id)
             self._beam_profiles.pop(removal_name)
             self._grpc_client.log.debug(f"Beam profile {removal_name} successfully deleted.")
         else:

tests/integration/test_design.py

@@ -1695,7 +1695,7 @@ def test_midsurface_properties(modeler: Modeler):
     assert "Exists               : True" in surf_repr
     assert "Parent component     : MidSurfaceProperties" in surf_repr
     assert "Surface body         : True" in surf_repr
-    assert "Surface thickness    : 10 millimeter" in surf_repr
+    assert "Surface thickness    : 10.0 millimeter" in surf_repr
     assert "Surface offset       : MidSurfaceOffsetType.TOP" in surf_repr
     assert f"Color                : {DEFAULT_COLOR}" in surf_repr
 
@@ -1726,7 +1726,7 @@ def test_midsurface_properties(modeler: Modeler):
         assert "Exists               : True" in surf_repr
         assert "Parent component     : MidSurfaceProperties" in surf_repr
         assert "Surface body         : True" in surf_repr
-        assert "Surface thickness    : 30 millimeter" in surf_repr
+        assert "Surface thickness    : 30.0 millimeter" in surf_repr
         assert "Surface offset       : MidSurfaceOffsetType.BOTTOM" in surf_repr
         assert f"Color                : {DEFAULT_COLOR}" in surf_repr
     except GeometryExitedError: