Unit testing iges/stl methods

Pretty format

Author: mahgadalla

README.md

@@ -43,11 +43,12 @@ See the [**Examples**](#examples) section below and the [**Tutorials**](tutorial
 **BladeX** requires `numpy`, `scipy`, `matplotlib`, `sphinx` (for the documentation), and `nose` (for the local test). They can be easily installed using `pip`. 
 **BladeX** is compatible with Python 2.7 and Python 3.6. Moreover, some of the modules require `OCC` to be installed for the `.iges` or `.stl` CAD generation. Please see the table below for instructions on how to satisfy the `OCC` requirements. You can also refer to `pythonocc.org` or `github.com/tpaviot/pythonocc-core` for further instructions.
 
-| Package | Version     | How to install (precompiled binaries via conda)                                                          |
-|---------|-------------|----------------------------------------------------------------------------------------------------------|
-| OCC     | ==0.18.1    | Python2.7 `conda install -c conda-forge -c dlr-sc -c pythonocc -c oce pythonocc-core==0.18.1 python=2.7` |
-| OCC     | ==0.18.1    | Python3.6 `conda install -c conda-forge -c dlr-sc -c pythonocc -c oce pythonocc-core==0.18.1 python=3.6` |
+| Package | Version     | How to install (precompiled binaries via conda)                                                                      |
+|---------|-------------|----------------------------------------------------------------------------------------------------------------------|
+| OCC     | ==0.18.1    | Python2.7 `conda install -c conda-forge -c dlr-sc -c pythonocc -c oce pythonocc-core==0.18.1 smesh=6.7.6 python=2.7` |
+| OCC     | ==0.18.1    | Python3.6 `conda install -c conda-forge -c dlr-sc -c pythonocc -c oce pythonocc-core==0.18.1 smesh=6.7.6 python=3.6` |
 
+conda install -c pythonocc -c dlr-sc -c oce smesh=6.7.6
 
 ### Installing from source
 The official distribution is on GitHub, and you can clone the repository using

bladex/blade.py

@@ -662,19 +662,18 @@ def _write_blade_errors(self, upper_face, lower_face, errors):
                         vertex = BRepBuilderAPI_MakeVertex(
                             gp_Pnt(
                                 1000 * self.blade_coordinates_up[i][0][j],
-                                1000 * self.blade_coordinates_up[i][1][j],
-                                1000 * self.blade_coordinates_up[i][2][
-                                    j])).Vertex()
+                                1000 * self.blade_coordinates_up[i][1][j], 1000
+                                * self.blade_coordinates_up[i][2][j])).Vertex()
                         projection = BRepExtrema_DistShapeShape(
                             self.generated_upper_face, vertex)
                         projection.Perform()
                         output_string += str(
                             i) + '\t\t\t' + str(j) + '\t\t\t' + str(
-                                1000 * self.blade_coordinates_up[i][0]
-                                [j]) + '\t\t\t'
+                                1000 *
+                                self.blade_coordinates_up[i][0][j]) + '\t\t\t'
                         output_string += str(
-                            1000 * self.blade_coordinates_up[i]
-                            [1][j]) + '\t\t\t' + str(
+                            1000 * self.blade_coordinates_up[i][1]
+                            [j]) + '\t\t\t' + str(
                                 1000 * self.blade_coordinates_up[i][2]
                                 [j]) + '\t\t\t' + str(projection.Value())
                         output_string += '\n'
@@ -691,24 +690,23 @@ def _write_blade_errors(self, upper_face, lower_face, errors):
                             gp_Pnt(
                                 1000 * self.blade_coordinates_down[i][0][j],
                                 1000 * self.blade_coordinates_down[i][1][j],
-                                1000 * self.blade_coordinates_down[i][2][
-                                    j])).Vertex()
+                                1000 *
+                                self.blade_coordinates_down[i][2][j])).Vertex()
                         projection = BRepExtrema_DistShapeShape(
                             self.generated_lower_face, vertex)
                         projection.Perform()
                         output_string += str(
                             i) + '\t\t\t' + str(j) + '\t\t\t' + str(
-                                1000 * self.blade_coordinates_down[i][0]
-                                [j]) + '\t\t\t'
+                                1000 *
+                                self.blade_coordinates_down[i][0][j]) + '\t\t\t'
                         output_string += str(
-                            1000 * self.blade_coordinates_down[i]
-                            [1][j]) + '\t\t\t' + str(
+                            1000 * self.blade_coordinates_down[i][1]
+                            [j]) + '\t\t\t' + str(
                                 1000 * self.blade_coordinates_down[i][2]
                                 [j]) + '\t\t\t' + str(projection.Value())
                         output_string += '\n'
             f.write(output_string)
 
-
     def generate_iges(self,
                       upper_face=None,
                       lower_face=None,
@@ -781,7 +779,8 @@ def generate_iges(self,
             self._check_string(filename=errors)
             self._check_errors(upper_face=upper_face, lower_face=lower_face)
 
-            self. _write_blade_errors(upper_face=upper_face, lower_face=lower_face, errors=errors)
+            self._write_blade_errors(
+                upper_face=upper_face, lower_face=lower_face, errors=errors)
 
         if display:
             display, start_display, add_menu, add_function_to_menu = init_display(
@@ -805,7 +804,7 @@ def generate_stl(self, min_length=None, max_length=None, outfile_stl=None):
         and http://docs.salome-platform.org/7/gui/SMESH/index.html for
         further details.
 
-        This method requires PythonOCC and SMESH to be installed. 
+        This method requires PythonOCC and SMESH to be installed.
 
         :param double min_length: smallest distance between two nodes. Default
             value is None
@@ -825,24 +824,32 @@ def generate_stl(self, min_length=None, max_length=None, outfile_stl=None):
         manual mesh healing is recommended by the user (e.g. see
         "Repair > Sewing" in SALOME GUI) for a proper mesh closure.
         """
-        from OCC.SMESH import SMESH_Gen, SMESH_MeshVSLink
-        from OCC.StdMeshers import (StdMeshers_Arithmetic1D, StdMeshers_TrianglePreference,
-                                    StdMeshers_Regular_1D, StdMeshers_Quadrangle_2D,
-                                    StdMeshers_MEFISTO_2D)
+        from OCC.SMESH import SMESH_Gen
+        from OCC.StdMeshers import (
+            StdMeshers_Arithmetic1D, StdMeshers_TrianglePreference,
+            StdMeshers_Regular_1D, StdMeshers_MEFISTO_2D)
         from OCC.BRep import BRep_Builder
         from OCC.TopoDS import TopoDS_Shape, TopoDS_Compound
 
+        if min_length <= 0 or max_length <= 0:
+            raise ValueError('min_length and max_length must be positive.')
+        if min_length >= max_length:
+            raise ValueError('min_length can not be greater than max_length')
+
         # First we check that blade shapes are generated, otherwise we generate
         # them. After that we combine the generated_upper_face,
         # generated_lower_face, and generated_tip into a topological compound
         # that we use to compute the surface mesh
-        if (self.generated_upper_face is None) or not isinstance(self.generated_upper_face, TopoDS_Shape):
+        if (self.generated_upper_face is None) or not isinstance(
+                self.generated_upper_face, TopoDS_Shape):
             # Upper face is generated with a maximal U degree = 1
             self._generate_upper_face(maxDeg=1)
-        if (self.generated_lower_face is None) or not isinstance(self.generated_lower_face, TopoDS_Shape):
+        if (self.generated_lower_face is None) or not isinstance(
+                self.generated_lower_face, TopoDS_Shape):
             # Upper face is generated with a maximal U degree = 1
             self._generate_lower_face(maxDeg=1)
-        if (self.generated_tip is None) or not isinstance(self.generated_tip, TopoDS_Shape):
+        if (self.generated_tip is None) or not isinstance(
+                self.generated_tip, TopoDS_Shape):
             # Upper face is generated with a maximal U degree = 1
             self._generate_tip(maxDeg=1)
 
@@ -851,9 +858,9 @@ def generate_stl(self, min_length=None, max_length=None, outfile_stl=None):
         aBuilder = BRep_Builder()
         aBuilder.MakeCompound(aCompound)
         # Add shapes
-        aBuilder.Add(aCompound,self.generated_upper_face)
-        aBuilder.Add(aCompound,self.generated_lower_face)
-        aBuilder.Add(aCompound,self.generated_tip)
+        aBuilder.Add(aCompound, self.generated_upper_face)
+        aBuilder.Add(aCompound, self.generated_lower_face)
+        aBuilder.Add(aCompound, self.generated_tip)
 
         # In the following we build the surface mesh according to the given
         # hypotheses
@@ -887,12 +894,14 @@ def generate_stl(self, min_length=None, max_length=None, outfile_stl=None):
         aMesh.AddHypothesis(aCompound, 2)
         aMesh.AddHypothesis(aCompound, 3)
 
-        #Compute the data
-        aMeshGen.Compute(aMesh, aMesh.GetShapeToMesh())
-
         if outfile_stl is not None:
-            assert isinstance(outfile_stl, str), "outfile_stl must be a valid string."
-            aMesh.ExportSTL(outfile_stl+'.stl', False)
+            if not isinstance(outfile_stl, str):
+                raise ValueError('outfile_stl must be a valid string.')
+
+            #Compute the data
+            aMeshGen.Compute(aMesh, aMesh.GetShapeToMesh())
+            # Export STL
+            aMesh.ExportSTL(outfile_stl + '.stl', False)
 
     @staticmethod
     def _check_string(filename):

tests/test_blade.py

@@ -5,6 +5,7 @@
 import os
 import matplotlib.pyplot as plt
 from mpl_toolkits.mplot3d import Axes3D
+from OCC.TopoDS import TopoDS_Shape
 
 
 def create_sample_blade_NACA():
@@ -265,6 +266,18 @@ def test_blade_coordinates_down_init(self):
         blade = create_sample_blade_NACA()
         assert len(blade.blade_coordinates_down) == 0
 
+    def test_blade_generated_upper_face_init(self):
+        blade = create_sample_blade_NACA()
+        assert blade.generated_upper_face == None
+
+    def test_blade_generated_lower_face_init(self):
+        blade = create_sample_blade_NACA()
+        assert blade.generated_lower_face == None
+
+    def test_blade_generated_tip_init(self):
+        blade = create_sample_blade_NACA()
+        assert blade.generated_tip == None
+
     def test_planar_to_cylindrical_blade_up(self):
         blade = create_sample_blade_NACA()
         blade._planar_to_cylindrical()
@@ -550,6 +563,48 @@ def test_iges_generate_errors_lower(self):
         self.assertTrue(os.path.isfile('tests/test_datasets/errors.txt'))
         self.addCleanup(os.remove, 'tests/test_datasets/errors.txt')
 
+    def test_stl_exception_1(self):
+        blade = create_sample_blade_NACA()
+        blade.apply_transformations()
+        with self.assertRaises(ValueError):
+            blade.generate_stl(min_length=-1, max_length=1, outfile_stl=None)
+
+    def test_stl_exception_2(self):
+        blade = create_sample_blade_NACA()
+        blade.apply_transformations()
+        with self.assertRaises(ValueError):
+            blade.generate_stl(min_length=2, max_length=1, outfile_stl=None)
+
+    def test_stl_generated_upper(self):
+        # Requires OCC to be installed
+        blade = create_sample_blade_NACA()
+        blade.apply_transformations()
+        blade.generated_upper_face = 5
+        blade.generate_stl(min_length=1, max_length=10, outfile_stl=None)
+        self.assertIsInstance(blade.generated_upper_face, TopoDS_Shape)
+
+    def test_stl_generated_lower(self):
+        # Requires OCC to be installed
+        blade = create_sample_blade_NACA()
+        blade.apply_transformations()
+        blade.generated_lower_face = None
+        blade.generate_stl(min_length=1, max_length=10, outfile_stl=None)
+        self.assertIsInstance(blade.generated_lower_face, TopoDS_Shape)
+
+    def test_stl_generated_tip(self):
+        # Requires OCC to be installed
+        blade = create_sample_blade_NACA()
+        blade.apply_transformations()
+        blade.generated_tip = 0
+        blade.generate_stl(min_length=1, max_length=10, outfile_stl=None)
+        self.assertIsInstance(blade.generated_tip, TopoDS_Shape)
+
+    def test_stl_export_exception(self):
+        blade = create_sample_blade_NACA()
+        blade.apply_transformations()
+        with self.assertRaises(ValueError):
+            blade.generate_stl(min_length=1, max_length=10, outfile_stl=55)
+
     def test_abs_to_norm_radii(self):
         blade = create_sample_blade_NACA()
         blade.radii[0] = 1.