feat: geopath property

doc/changelog.d/551.added.md

@@ -0,0 +1 @@
+geopath property

examples/core/opt-prop.py

@@ -34,21 +34,24 @@ def create_helper_geometries(project: Project):
     """Create bodies and faces."""
 
     def create_face(body):
-        (
+        face = (
             body.create_face(name="TheFaceF")
             .set_vertices([0, 0, 0, 1, 0, 0, 0, 1, 0])
             .set_facets([0, 1, 2])
             .set_normals([0, 0, 1, 0, 0, 1, 0, 0, 1])
             .commit()
         )
+        return face
 
+    data = {"bodies": [], "faces": []}
     root_part = project.create_root_part().commit()
-    body_b1 = root_part.create_body(name="TheBodyB").commit()
-    body_b2 = root_part.create_body(name="TheBodyC").commit()
-    body_b3 = root_part.create_body(name="TheBodyD").commit()
-    body_b4 = root_part.create_body(name="TheBodyE").commit()
-    for b in [body_b1, body_b2, body_b3, body_b4]:
-        create_face(b)
+    data["bodies"].append(root_part.create_body(name="TheBodyB").commit())
+    data["bodies"].append(root_part.create_body(name="TheBodyC").commit())
+    data["bodies"].append(root_part.create_body(name="TheBodyD").commit())
+    data["bodies"].append(root_part.create_body(name="TheBodyE").commit())
+    for b in data["bodies"]:
+        data["faces"].append(create_face(b))
+    return data
 
 
 # ## Model Setup
@@ -80,7 +83,9 @@ def create_face(body):
 
 p = Project(speos=speos)
 print(p)
-create_helper_geometries(p)
+data = create_helper_geometries(p)
+bodies = data["bodies"]
+faces = data["faces"]
 
 # ## Create VOP (volume optical property)
 #
@@ -93,8 +98,8 @@ def create_face(body):
 # This optical property will be applied to two bodies named : "TheBodyB" and "TheBodyC".
 op1.set_geometries(
     geometries=[
-        GeoRef.from_native_link(geopath="TheBodyB"),
-        GeoRef.from_native_link(geopath="TheBodyC"),
+        GeoRef.from_native_link(geopath=bodies[0].geo_path),
+        GeoRef.from_native_link(geopath=bodies[1].geo_path),
     ]
 )
 print(op1)
@@ -120,8 +125,8 @@ def create_face(body):
 # This optical property will be applied to two bodies named : "TheBodyD" and "TheBodyE".
 op2.set_geometries(
     geometries=[
-        GeoRef.from_native_link(geopath="TheBodyD"),
-        GeoRef.from_native_link(geopath="TheBodyE"),
+        GeoRef.from_native_link(geopath=bodies[2].geo_path),
+        GeoRef.from_native_link(geopath=bodies[3].geo_path),
     ]
 )
 op2.commit()
@@ -138,7 +143,7 @@ def create_face(body):
 op3 = p.create_optical_property(name="Material.FOP")
 op3.set_surface_mirror(reflectance=90)  # SOP : mirror
 # This optical property will be applied a face from TheBodyD named : "TheFaceF".
-op3.set_geometries(geometries=[GeoRef.from_native_link(geopath="TheBodyD/TheFaceF")])
+op3.set_geometries(geometries=[GeoRef.from_native_link(geopath=faces[2].geo_path)])
 op3.commit()
 print(op3)
 

src/ansys/speos/core/body.py

@@ -81,6 +81,14 @@ def __init__(
 
         self._geom_features = []
 
+    @property
+    def geo_path(self):
+        """Geometry path to be used within other speos objects."""
+        geo_paths = [self._name]
+        if isinstance(self._parent_part, part.Part.SubPart):
+            geo_paths.insert(0, self._parent_part.geo_path)
+        return "/".join(geo_paths)
+
     def create_face(
         self,
         name: str,

src/ansys/speos/core/face.py

@@ -76,6 +76,15 @@ def __init__(
         # Create local Face
         self._face = ProtoFace(name=name, description=description, metadata=metadata)
 
+    @property
+    def geo_path(self):
+        """Geometry path to be used within other speos objects."""
+        geo_paths = [self._name]
+        parent = self._parent_body
+        if isinstance(parent, body.Body):
+            geo_paths.insert(0, parent.geo_path)
+        return "/".join(geo_paths)
+
     def set_vertices(self, values: List[float]) -> Face:
         """Set the face vertices.
 

src/ansys/speos/core/part.py

@@ -100,6 +100,14 @@ def __init__(
 
             self._geom_features = []
 
+        @property
+        def geo_path(self):
+            """Geometry path to be used within other speos objects."""
+            geo_paths = [self._name]
+            if isinstance(self._parent_part, Part.SubPart):
+                geo_paths.insert(0, self._parent_part.geo_path)
+            return "/".join(geo_paths)
+
         def create_body(
             self,
             name: str,

tests/core/test_opt_prop.py

@@ -148,16 +148,19 @@ def test_reset_optical_property(speos: Speos):
 
     root_part = p.create_root_part()
     body_b = root_part.create_body(name="TheBodyB")
-    body_b.create_face(name="TheFaceF").set_vertices([0, 0, 0, 1, 0, 0, 0, 1, 0]).set_facets(
-        [0, 1, 2]
-    ).set_normals([0, 0, 1, 0, 0, 1, 0, 0, 1])
+    (
+        body_b.create_face(name="TheFaceF")
+        .set_vertices([0, 0, 0, 1, 0, 0, 0, 1, 0])
+        .set_facets([0, 1, 2])
+        .set_normals([0, 0, 1, 0, 0, 1, 0, 0, 1])
+    )
     root_part.commit()
 
     # Create + commit
     op1 = (
         p.create_optical_property(name="Material.1")
         .set_volume_opaque()
-        .set_geometries(geometries=[GeoRef.from_native_link("TheBodyB")])
+        .set_geometries(geometries=[GeoRef.from_native_link(body_b.geo_path)])
         .commit()
     )
     assert op1.vop_template_link is not None
@@ -233,9 +236,12 @@ def test_get_optical_property(speos: Speos, capsys):
 
     root_part = p.create_root_part()
     body_a = root_part.create_body(name="TheBodyA")
-    body_a.create_face(name="TheFaceF").set_vertices([0, 0, 0, 1, 0, 0, 0, 1, 0]).set_facets(
-        [0, 1, 2]
-    ).set_normals([0, 0, 1, 0, 0, 1, 0, 0, 1])
+    face = (
+        body_a.create_face(name="TheFaceF")
+        .set_vertices([0, 0, 0, 1, 0, 0, 0, 1, 0])
+        .set_facets([0, 1, 2])
+        .set_normals([0, 0, 1, 0, 0, 1, 0, 0, 1])
+    )
     body_b = root_part.create_body(name="TheBodyB")
     body_b.create_face(name="TheFaceF").set_vertices([0, 0, 0, 1, 0, 0, 0, 1, 0]).set_facets(
         [0, 1, 2]
@@ -245,7 +251,7 @@ def test_get_optical_property(speos: Speos, capsys):
     op1 = (
         p.create_optical_property(name="Material.1")
         .set_volume_opaque()
-        .set_geometries(geometries=[GeoRef.from_native_link("TheBodyA")])
+        .set_geometries(geometries=[GeoRef.from_native_link(body_a.geo_path)])
         .commit()
     )
 
@@ -269,7 +275,7 @@ def test_get_optical_property(speos: Speos, capsys):
         p.create_optical_property(name="OpticalProperty2")
         .set_volume_optic(index=1.7, absorption=0.01, constringence=55)
         .set_surface_opticalpolished()
-        .set_geometries(geometries=[GeoRef.from_native_link("TheBodyB")])
+        .set_geometries(geometries=[GeoRef.from_native_link(body_b.geo_path)])
         .commit()
     )
 
@@ -292,6 +298,7 @@ def test_get_optical_property(speos: Speos, capsys):
         p.create_optical_property(name="OpticalProperty3")
         .set_volume_none()
         .set_surface_library(path=str(Path(test_path) / "R_test.anisotropicbsdf"))
+        .set_geometries(geometries=[GeoRef.from_native_link(face.geo_path)])
         .commit()
     )
 

tests/core/test_part.py

@@ -51,15 +51,15 @@ def test_create_body(speos: Speos):
     # Add empty body
     body1 = root_part.create_body(name="Body.1").commit()
     assert len(root_part._geom_features) == 1
-
+    assert body1.geo_path == "Body.1"
     assert len(root_part.part_link.get().body_guids) == 1
     assert root_part.part_link.get().body_guids[0] == body1.body_link.key
 
     # Add another body + commit on root part
     body2 = root_part.create_body(name="Body.2")
     root_part.commit()
     assert len(root_part._geom_features) == 2
-
+    assert body2.geo_path == "Body.2"
     assert len(root_part.part_link.get().body_guids) == 2
     assert root_part.part_link.get().body_guids[1] == body2.body_link.key
 
@@ -84,7 +84,7 @@ def test_create_face(speos: Speos):
     root_part.commit()
     assert len(body1._geom_features) == 1
     assert len(body1.body_link.get().face_guids) == 1
-
+    assert face0.geo_path == "Body.1/TheFaceF"
     # Add a face
     face1 = (
         body1.create_face(name="Face.1")
@@ -94,7 +94,7 @@ def test_create_face(speos: Speos):
         .commit()
     )
     assert len(body1._geom_features) == 2
-
+    assert face1.geo_path == "Body.1/Face.1"
     assert len(body1.body_link.get().face_guids) == 2
     assert body1.body_link.get().face_guids[1] == face1.face_link.key
     assert face1.face_link.get().vertices == [0, 1, 0, 0, 2, 0, 1, 2, 0]
@@ -110,7 +110,7 @@ def test_create_face(speos: Speos):
         .commit()
     )
     assert len(body1._geom_features) == 3
-
+    assert face2.geo_path == "Body.1/Face.2"
     assert len(body1.body_link.get().face_guids) == 3
     assert body1.body_link.get().face_guids[2] == face2.face_link.key
     assert face2.face_link.get().vertices == [0, 0, 0, 1, 0, 0, 0, 1, 0]
@@ -140,6 +140,7 @@ def test_create_subpart(speos: Speos):
     )
     assert len(root_part._geom_features) == 1
     assert len(root_part.part_link.get().parts) == 1
+    assert sp1.geo_path == "SubPart.1"
     assert root_part.part_link.get().parts[0] == sp1._part_instance
     assert sp1._part_instance.axis_system == [
         5,
@@ -168,6 +169,7 @@ def test_create_subpart(speos: Speos):
     root_part.commit()
     assert len(root_part._geom_features) == 2
     assert len(root_part.part_link.get().parts) == 2
+    assert sp2.geo_path == "SubPart.2"
     assert root_part.part_link.get().parts[1] == sp2._part_instance
     assert sp2._part_instance.axis_system == [
         15,
@@ -211,15 +213,15 @@ def test_create_subpart_body(speos: Speos):
     # Add empty body
     body1 = sp1.create_body(name="Body.1").commit()
     assert len(sp1._geom_features) == 1
-
+    assert body1.geo_path == "SubPart.1/Body.1"
     assert len(sp1.part_link.get().body_guids) == 1
     assert sp1.part_link.get().body_guids[0] == body1.body_link.key
 
     # Add another body + commit on root part
     body2 = sp1.create_body(name="Body.2")
     root_part.commit()
     assert len(sp1._geom_features) == 2
-
+    assert body2.geo_path == "SubPart.1/Body.2"
     assert len(sp1.part_link.get().body_guids) == 2
     assert sp1.part_link.get().body_guids[1] == body2.body_link.key
 
@@ -266,6 +268,7 @@ def test_create_subpart_subpart(speos: Speos):
         1,
     ]
     assert sp11._part_instance.part_guid == sp11.part_link.key
+    assert sp11.geo_path == "SubPart.1/SubPart.11"
     assert (
         sp11.part_link.get().name == "SubPart.11"
     )  # part contained in a sub part gets same name as the sub part
@@ -294,6 +297,7 @@ def test_create_subpart_subpart(speos: Speos):
         1,
     ]
     assert sp12._part_instance.part_guid == sp12.part_link.key
+    assert sp12.geo_path == "SubPart.1/SubPart.12"
     assert (
         sp12.part_link.get().name == "SubPart.12"
     )  # part contained in a sub part gets same name as the sub part