refactor: leverage property in face

Author: SMoraisAnsys

doc/source/cheat_sheet/cheat_sheet_script.qmd

@@ -177,9 +177,9 @@ root_part.commit()
 body_1 = root_part.create_body(name='TheBodyB1')
 body_1.commit()
 body_1_face_1 = body_1.create_face(name='TheFaceF1')
-body_1_face_1.set_vertices([])
-body_1_face_1.set_facets([])
-body_1_face_1.set_normals([])
+body_1_face_1.vertices = []
+body_1_face_1.facets = []
+body_1_face_1.normals = []
 body_1_face_1.commit()
 ```
 

examples/script-part.py

@@ -61,13 +61,12 @@
 # Each triangle/facet is defined by vertices and vertice normals.
 
 # +
-face_b1_f1 = (
-    body_b1.create_face(name="TheFaceF1")
-    .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()
-)
+face_b1_f1 = body_b1.create_face(name="TheFaceF1")
+face_b1_f1.vertices = [0, 0, 0, 1, 0, 0, 0, 1, 0]
+face_b1_f1.facets = [0, 1, 2]
+face_b1_f1.normals = [0, 0, 1, 0, 0, 1, 0, 0, 1]
+face_b1_f1.commit()
+
 print(root_part)
 # -
 
@@ -86,13 +85,11 @@
 
 body_sp1_b1 = sub_part1.create_body(name="TheBodySP1_B1").commit()
 print(root_part)
-face_sp1_b1_f1 = (
-    body_sp1_b1.create_face(name="TheFaceSP1_B1_F1")
-    .set_vertices([0, 1, 0, 0, 2, 0, 1, 2, 0])
-    .set_facets([0, 1, 2])
-    .set_normals([0, 0, 1, 0, 0, 1, 0, 0, 1])
-    .commit()
-)
+face_sp1_b1_f1 = body_sp1_b1.create_face(name="TheFaceSP1_B1_F1")
+face_sp1_b1_f1.vertices = [0, 1, 0, 0, 2, 0, 1, 2, 0]
+face_sp1_b1_f1.facets = [0, 1, 2]
+face_sp1_b1_f1.normals = [0, 0, 1, 0, 0, 1, 0, 0, 1]
+face_sp1_b1_f1.commit()
 print(root_part)
 # -
 

examples/script-simulation.py

@@ -43,9 +43,11 @@
 
 # +
 root_part = p.create_root_part()
-root_part.create_body(name="Body.1").create_face(name="Face.1").set_vertices([0, 1, 2, 0, 2, 2, 1, 2, 2]).set_facets([0, 1, 2]).set_normals(
-    [0, 0, 1, 0, 0, 1, 0, 0, 1]
-)
+body = root_part.create_body(name="Body.1")
+face = body.create_face(name="Face.1")
+face.vertices = [0, 1, 2, 0, 2, 2, 1, 2, 2]
+face.facets = [0, 1, 2]
+face.normals = [0, 0, 1, 0, 0, 1, 0, 0, 1]
 root_part.commit()
 # -
 

src/ansys/speos/script/face.py

@@ -72,7 +72,13 @@ def __init__(
         # Create local Face
         self._face = core.Face(name=name, description=description, metadata=metadata)
 
-    def set_vertices(self, values: List[float]) -> Face:
+    @property
+    def vertices(self):
+        res = self.face_link.get().vertices
+        return res
+
+    @vertices.setter
+    def vertices(self, values: List[float])-> Face:
         """Set the face vertices.
 
         Parameters
@@ -88,7 +94,13 @@ def set_vertices(self, values: List[float]) -> Face:
         self._face.vertices[:] = values
         return self
 
-    def set_facets(self, values: List[int]) -> Face:
+    @property
+    def facets(self):
+        res = self.face_link.get().facets
+        return res
+
+    @facets.setter
+    def facets(self, values: List[int]) -> Face:
         """Set the facets.
 
         Parameters
@@ -104,7 +116,13 @@ def set_facets(self, values: List[int]) -> Face:
         self._face.facets[:] = values
         return self
 
-    def set_normals(self, values: List[float]) -> Face:
+    @property
+    def normals(self):
+        res = self.face_link.get().normals
+        return res
+
+    @normals.setter
+    def normals(self, values: List[float]) -> Face:
         """Set the face normals.
 
         Parameters

tests/script_tests/test_Part.py

@@ -84,31 +84,27 @@ def test_create_face(speos: Speos):
     assert len(body1.body_link.get().face_guids) == 0
 
     # Add a face
-    face1 = (
-        body1.create_face(name="Face.1")
-        .set_vertices([0, 1, 0, 0, 2, 0, 1, 2, 0])
-        .set_facets([0, 1, 2])
-        .set_normals([0, 0, 1, 0, 0, 1, 0, 0, 1])
-        .commit()
-    )
-    assert len(body1._geom_features) == 1
+    face1 = body1.create_face(name="Face.1")
+    face1.vertices = [0, 1, 0, 0, 2, 0, 1, 2, 0]
+    face1.facets = [0, 1, 2]
+    face1.normals = [0, 0, 1, 0, 0, 1, 0, 0, 1]
+    face1.commit()
 
+    assert len(body1._geom_features) == 1
     assert len(body1.body_link.get().face_guids) == 1
     assert body1.body_link.get().face_guids[0] == face1.face_link.key
     assert face1.face_link.get().vertices == [0, 1, 0, 0, 2, 0, 1, 2, 0]
     assert face1.face_link.get().facets == [0, 1, 2]
     assert face1.face_link.get().normals == [0, 0, 1, 0, 0, 1, 0, 0, 1]
 
     # Add another face + commit on root part
-    face2 = (
-        body1.create_face(name="Face.2")
-        .set_vertices([0, 0, 0, 1, 0, 0, 0, 1, 0])
-        .set_facets([0, 2, 1])
-        .set_normals([0, 0, 1, 0, 0, 1, 0, 0, 1])
-        .commit()
-    )
-    assert len(body1._geom_features) == 2
+    face2 = body1.create_face(name="Face.2")
+    face2.vertices = [0, 0, 0, 1, 0, 0, 0, 1, 0]
+    face2.facets = [0, 2, 1]
+    face2.normals = [0, 0, 1, 0, 0, 1, 0, 0, 1]
+    face2.commit()
 
+    assert len(body1._geom_features) == 2
     assert len(body1.body_link.get().face_guids) == 2
     assert body1.body_link.get().face_guids[1] == face2.face_link.key
     assert face2.face_link.get().vertices == [0, 0, 0, 1, 0, 0, 0, 1, 0]

tests/script_tests/test_Simulation.py

@@ -334,9 +334,10 @@ def test_commit(speos: Speos):
 
     # Prerequisites: a source and a sensor are needed (bug also a rootpart and optical property)
     root_part = p.create_root_part()
-    root_part.create_body(name="Body.1").create_face(name="Face.1").set_vertices([0, 1, 0, 0, 2, 0, 1, 2, 0]).set_facets(
-        [0, 1, 2]
-    ).set_normals([0, 0, 1, 0, 0, 1, 0, 0, 1])
+    face = root_part.create_body(name="Body.1").create_face(name="Face.1")
+    face.vertices = [0, 1, 0, 0, 2, 0, 1, 2, 0]
+    face.facets = [0, 1, 2]
+    face.normals = [0, 0, 1, 0, 0, 1, 0, 0, 1]
     root_part.commit()
 
     opt_prop = p.create_optical_property(name="Material.1")
@@ -388,9 +389,10 @@ def test_reset(speos: Speos):
 
     # Prerequisites: a source and a sensor are needed (bug also a rootpart and optical property)
     root_part = p.create_root_part()
-    root_part.create_body(name="Body.1").create_face(name="Face.1").set_vertices([0, 1, 0, 0, 2, 0, 1, 2, 0]).set_facets(
-        [0, 1, 2]
-    ).set_normals([0, 0, 1, 0, 0, 1, 0, 0, 1])
+    face = root_part.create_body(name="Body.1").create_face(name="Face.1")
+    face.vertices = [0, 1, 0, 0, 2, 0, 1, 2, 0]
+    face.facets = [0, 1, 2]
+    face.normals = [0, 0, 1, 0, 0, 1, 0, 0, 1]
     root_part.commit()
 
     opt_prop = p.create_optical_property(name="Material.1")
@@ -440,9 +442,10 @@ def test_direct_modify_after_reset(speos: Speos):
 
     # Prerequisites: a source and a sensor are needed (bug also a rootpart and optical property)
     root_part = p.create_root_part()
-    root_part.create_body(name="Body.1").create_face(name="Face.1").set_vertices([0, 1, 0, 0, 2, 0, 1, 2, 0]).set_facets(
-        [0, 1, 2]
-    ).set_normals([0, 0, 1, 0, 0, 1, 0, 0, 1])
+    face = root_part.create_body(name="Body.1").create_face(name="Face.1")
+    face.vertices = [0, 1, 0, 0, 2, 0, 1, 2, 0]
+    face.facets = [0, 1, 2]
+    face.normals = [0, 0, 1, 0, 0, 1, 0, 0, 1]
     root_part.commit()
 
     opt_prop = p.create_optical_property(name="Material.1")
@@ -494,9 +497,10 @@ def test_inverse_modify_after_reset(speos: Speos):
 
     # Prerequisites: a source and a sensor are needed (bug also a rootpart and optical property)
     root_part = p.create_root_part()
-    root_part.create_body(name="Body.1").create_face(name="Face.1").set_vertices([0, 1, 0, 0, 2, 0, 1, 2, 0]).set_facets(
-        [0, 1, 2]
-    ).set_normals([0, 0, 1, 0, 0, 1, 0, 0, 1])
+    face = root_part.create_body(name="Body.1").create_face(name="Face.1")
+    face.vertices = [0, 1, 0, 0, 2, 0, 1, 2, 0]
+    face.facets = [0, 1, 2]
+    face.normals = [0, 0, 1, 0, 0, 1, 0, 0, 1]
     root_part.commit()
 
     opt_prop = p.create_optical_property(name="Material.1")
@@ -548,9 +552,10 @@ def test_interactive_modify_after_reset(speos: Speos):
 
     # Prerequisites: a source and a sensor are needed (bug also a rootpart and optical property)
     root_part = p.create_root_part()
-    root_part.create_body(name="Body.1").create_face(name="Face.1").set_vertices([0, 1, 0, 0, 2, 0, 1, 2, 0]).set_facets(
-        [0, 1, 2]
-    ).set_normals([0, 0, 1, 0, 0, 1, 0, 0, 1])
+    face = root_part.create_body(name="Body.1").create_face(name="Face.1")
+    face.vertices = [0, 1, 0, 0, 2, 0, 1, 2, 0]
+    face.facets = [0, 1, 2]
+    face.normals = [0, 0, 1, 0, 0, 1, 0, 0, 1]
     root_part.commit()
 
     opt_prop = p.create_optical_property(name="Material.1")
@@ -602,9 +607,10 @@ def test_delete(speos: Speos):
 
     # Prerequisites: a source and a sensor are needed (bug also a rootpart and optical property)
     root_part = p.create_root_part()
-    root_part.create_body(name="Body.1").create_face(name="Face.1").set_vertices([0, 1, 0, 0, 2, 0, 1, 2, 0]).set_facets(
-        [0, 1, 2]
-    ).set_normals([0, 0, 1, 0, 0, 1, 0, 0, 1])
+    face = root_part.create_body(name="Body.1").create_face(name="Face.1")
+    face.vertices = [0, 1, 0, 0, 2, 0, 1, 2, 0]
+    face.facets = [0, 1, 2]
+    face.normals = [0, 0, 1, 0, 0, 1, 0, 0, 1]
     root_part.commit()
 
     opt_prop = p.create_optical_property(name="Material.1")