Merge pull request #142 from EOMYS-Public/Solution

Solution

Author: EOMYS ENGINEERING

MANIFEST.in

@@ -1,4 +1,6 @@
+include LICENSE README.md
 prune Tests
 prune Tutorials
 graft pyleecan
+prune pyleecan/Results
 global-exclude *.py[cod]

README.md

@@ -4,7 +4,7 @@
 <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
 
 ## Presentation
-PYLEECAN™ objective is to provide a **user-friendly, unified, flexible simulation framework for the multiphysic design and optimization of electrical machines and drives** based on fully open-source software.
+PYLEECAN objective is to provide a **user-friendly, unified, flexible simulation framework for the multiphysic design and optimization of electrical machines and drives** based on fully open-source software.
 
 It is meant to be used by researchers, R&D engineers and teachers in electrical engineering, both on standard topologies of electrical machines and on novel topologies (e.g. during a PhD work). 
 An objective of PYLEECAN is that **every PhD student should start with PYLEECAN instead of implementing his own scripts (e.g. coupling Scilab or Matlab with Femm)**.

Tests/Methods/Mesh/test_interface.py

@@ -8,25 +8,24 @@
 import numpy as np
 
 
-@pytest.mark.skip
 @pytest.mark.MeshSol
 class unittest_interface(TestCase):
-    """unittest for elements and nodes getter methods"""
+    """unittest for interface method"""
 
     @classmethod
     def setUp(self):
         self.mesh = MeshMat()
         self.mesh.cell["triangle"] = CellMat(nb_pt_per_cell=3)
-        self.mesh.cell["segment"] = CellMat(nb_pt_per_cell=2)
+        self.mesh.cell["line"] = CellMat(nb_pt_per_cell=2)
         self.mesh.point = PointMat()
 
         self.other_mesh = MeshMat()
         self.other_mesh.cell["triangle"] = CellMat(nb_pt_per_cell=3)
-        self.other_mesh.cell["segment"] = CellMat(nb_pt_per_cell=2)
+        self.other_mesh.cell["line"] = CellMat(nb_pt_per_cell=2)
         self.other_mesh.point = self.mesh.point
 
     def test_MeshMat_flat(self):
-        """unittest with ElementDict and PointMat objects"""
+        """unittest with a flat interface"""
 
         self.mesh.add_cell([0, 1, 2], "triangle")
         self.mesh.add_cell([2, 3, 4], "triangle")
@@ -43,8 +42,8 @@ def test_MeshMat_flat(self):
         self.other_mesh.add_cell([4, 6, 2], "triangle")
 
         new_seg_mesh = self.mesh.interface(self.other_mesh)
-        solution = np.array([[0, 2], [2, 4]])
-        resultat = new_seg_mesh.cell["segment"].connectivity
+        solution = np.array([[0, 2], [4, 2]])
+        resultat = new_seg_mesh.cell["line"].connectivity
         testA = np.sum(abs(resultat - solution))
         msg = (
             "Wrong projection: returned "
@@ -56,7 +55,7 @@ def test_MeshMat_flat(self):
         self.assertAlmostEqual(testA, 0, msg=msg, delta=DELTA)
 
     def test_CellMat_PointMat_corner_ext(self):
-        """unittest with CellMat and PointMat objects, extract interface from the external mesh point of view"""
+        """unittest with an external corner interface"""
         self.mesh.add_cell([0, 1, 2], "triangle")
         self.mesh.add_cell([1, 2, 3], "triangle")
         self.mesh.add_cell([1, 5, 4], "triangle")
@@ -67,22 +66,24 @@ def test_CellMat_PointMat_corner_ext(self):
         self.mesh.point.add_point([4, 0])
         self.mesh.point.add_point([3.5, 1])
         self.mesh.point.add_point([3, -1])
+        self.mesh.point.add_point([10, 10])
 
         self.other_mesh.add_cell([0, 1, 5], "triangle")
+        self.other_mesh.add_cell([0, 5, 6], "triangle")
 
         # Method test 1
         new_seg_mesh = self.mesh.interface(self.other_mesh)
 
         # Check result
         solution = np.array([[0, 1], [1, 5]])
-        result = new_seg_mesh.cell["segment"].connectivity
+        result = new_seg_mesh.cell["line"].connectivity
         testA = np.sum(abs(result - solution))
         msg = "Wrong result: returned " + str(result) + ", expected: " + str(solution)
         DELTA = 1e-10
         self.assertAlmostEqual(testA, 0, msg=msg, delta=DELTA)
 
     def test_CellMat_PointMat_corner_int(self):
-        """unittest with CellMat and PointMat objects, extract interface from the internal mesh point of view"""
+        """unittest with an internal corner interface"""
         self.mesh.add_cell([0, 1, 2], "triangle")
         self.mesh.add_cell([1, 2, 3], "triangle")
         self.mesh.add_cell([1, 5, 4], "triangle")
@@ -93,39 +94,38 @@ def test_CellMat_PointMat_corner_int(self):
         self.mesh.point.add_point([4, 0])
         self.mesh.point.add_point([3.5, 1])
         self.mesh.point.add_point([3, -1])
+        self.mesh.point.add_point([10, 10])
 
         self.other_mesh.add_cell([0, 1, 5], "triangle")
+        self.other_mesh.add_cell([0, 5, 6], "triangle")
 
         # Method test 1
         new_seg_mesh = self.other_mesh.interface(self.mesh)
 
         # Check result
         solution = np.array([[0, 1], [1, 5]])
-        result = new_seg_mesh.cell["segment"].connectivity
+        result = new_seg_mesh.cell["line"].connectivity
         testA = np.sum(abs(result - solution))
         msg = "Wrong result: returned " + str(result) + ", expected: " + str(solution)
         DELTA = 1e-10
         self.assertAlmostEqual(testA, 0, msg=msg, delta=DELTA)
 
     def test_CellMat_PointMat_self(self):
-        """unittest with CellMat and PointMat objects, extract interface on itself"""
+        """unittest with interface of a mesh on itself"""
         self.mesh.add_cell([0, 1, 2], "triangle")
         self.mesh.add_cell([0, 2, 3], "triangle")
-        self.mesh.add_cell([0, 3, 4], "triangle")
-        self.mesh.add_cell([0, 4, 1], "triangle")
 
         self.mesh.point.add_point([0, 0])
         self.mesh.point.add_point([0, 1])
         self.mesh.point.add_point([1, 0])
         self.mesh.point.add_point([-1, 0])
-        self.mesh.point.add_point([0, -1])
 
         # Method test 1
         new_seg_mesh = self.mesh.interface(self.mesh)
 
         # Check result
-        solution = np.array([])
-        result = new_seg_mesh.cell["segment"].connectivity
+        solution = np.array([[0, 1], [0, 2], [0, 3], [1, 2], [2, 3]])
+        result = new_seg_mesh.cell["line"].connectivity
         testA = np.sum(abs(result - solution))
         msg = "Wrong result: returned " + str(result) + ", expected: " + str(solution)
         DELTA = 1e-10

Tests/Methods/Output/__init__.py

@@ -525,7 +525,7 @@ def test_Optimization_problem():
     # This simulation will the base of every simulation during the optimization process
 
     # Load the machine
-    SPMSM_001 = load("pyleecan/Tests/Validation/Machine/SPMSM_001.json")
+    SPMSM_001 = load(join(DATA_DIR, "Machine", "SPMSM_001.json"))
 
     # Definition of the enforced output of the electrical module
     Na = 1024  # Angular steps
@@ -612,41 +612,32 @@ def test_Optimization_problem():
     fig.savefig(
         join(save_path, "fig_21_Machine_topology_before_optimization.svg"), format="svg"
     )
-
+    plt.close("all")
     # -------------------- #
     # OPTIMIZATION PROBLEM #
     # -------------------- #
 
     # Objective functions
-
-    def harm1(output):
+    def tem_av(output):
         """Return the average torque opposite (opposite to be maximized)"""
-        N = output.simu.input.time.num
-        x = output.mag.Tem.values[:, 0]
-        sp = np.fft.rfft(x)
-        sp = 2 / N * np.abs(sp)
-        return -sp[0] / 2
-
-    def harm2(output):
-        """Return the first torque harmonic """
-        N = output.simu.input.time.num
-        x = output.mag.Tem.values[:, 0]
-        sp = np.fft.rfft(x)
-        sp = 2 / N * np.abs(sp)
-        return sp[1]
-
-    objs = [
+        return -abs(output.mag.Tem_av)
+
+    def Tem_rip_pp(output):
+        """Return the torque ripple """
+        return abs(output.mag.Tem_rip_pp)
+
+    my_objs = [
         DataKeeper(
             name="Maximization of the average torque",
             symbol="Tem_av",
             unit="N.m",
-            keeper=harm1,
+            keeper=tem_av,
         ),
         DataKeeper(
-            name="Minimization of the first torque harmonic",
-            symbol="Tem_h1",
+            name="Minimization of the torque ripple",
+            symbol="Tem_rip_pp",
             unit="N.m",
-            keeper=harm2,
+            keeper=Tem_rip_pp,
         ),
     ]
 
@@ -679,7 +670,7 @@ def harm2(output):
     ]
 
     # Problem creation
-    my_prob = OptiProblem(output=output, design_var=my_vars, obj_func=objs)
+    my_prob = OptiProblem(output=output, design_var=my_vars, obj_func=my_objs)
 
     # Solve problem with NSGA-II
     solver = OptiGenAlgNsga2Deap(problem=my_prob, size_pop=12, nb_gen=40, p_mutate=0.5)
@@ -689,14 +680,14 @@ def harm2(output):
     # PLOTS RESULTS #
     # ------------- #
 
-    res.plot_generation(x_symbol="Tem_av", y_symbol="Tem_h1")
+    res.plot_generation(x_symbol="Tem_av", y_symbol="Tem_rip_pp")
     fig = plt.gcf()
     fig.savefig(join(save_path, "fig_20_Individuals_in_fitness_space.png"))
     fig.savefig(
         join(save_path, "fig_20_Individuals_in_fitness_space.svg"), format="svg"
     )
 
-    res.plot_pareto(x_symbol="Tem_av", y_symbol="Tem_h1")
+    res.plot_pareto(x_symbol="Tem_av", y_symbol="Tem_rip_pp")
     fig = plt.gcf()
     fig.savefig(join(save_path, "Pareto_front_in_fitness_space.png"))
     fig.savefig(join(save_path, "Pareto_front_in_fitness_space.svg"), format="svg")
@@ -709,12 +700,15 @@ def harm2(output):
     idx_1 = pareto_index[0]  # First objective
     idx_2 = pareto_index[0]  # Second objective
 
+    Tem_av = res["Tem_av"].result
+    Tem_rip_pp = res["Tem_rip_pp"].result
+
     for i in pareto_index:
         # First objective
-        if res["Tem_av"][i] < res["Tem_av"][idx_1]:
+        if Tem_av[i] < Tem_av[idx_1]:
             idx_1 = i
         # Second objective
-        if res["Tem_h1"][i] < res["Tem_h1"][idx_2]:
+        if Tem_rip_pp[i] < Tem_rip_pp[idx_2]:
             idx_2 = i
 
     # Get corresponding simulations
@@ -723,11 +717,11 @@ def harm2(output):
 
     # Rename machine to modify the title
     name1 = "Machine that maximizes the average torque ({:.3f} Nm)".format(
-        abs(res["Tem_av"][idx_1])
+        abs(Tem_av[idx_1])
     )
     simu1.machine.name = name1
-    name2 = "Machine that minimizes the first torque harmonic ({:.4f}Nm)".format(
-        abs(res["Tem_h1"][idx_2])
+    name2 = "Machine that minimizes the torque ripple ({:.4f}Nm)".format(
+        abs(Tem_rip_pp[idx_2])
     )
     simu2.machine.name = name2
 
@@ -744,10 +738,8 @@ def harm2(output):
     simu2.machine.plot()
     fig = plt.gcf()
     fig.savefig(
-        join(save_path, "fig_21_Topology_to_minimize_first_torque_harmonic.png"),
-        format="png",
+        join(save_path, "fig_21_Topology_to_minimize_torque_ripple.png"), format="png",
     )
     fig.savefig(
-        join(save_path, "fig_21_Topology_to_minimize_first_torque_harmonic.svg"),
-        format="svg",
+        join(save_path, "fig_21_Topology_to_minimize_torque_ripple.svg"), format="svg",
     )

Tests/Methods/Output/test_plot_mesh_field.py

@@ -2,7 +2,7 @@
 from unittest import TestCase
 from os.path import join
 import matplotlib.pyplot as plt
-from Tests import save_validation_path as save_path
+from Tests import save_plot_path as save_path
 import pytest
 
 from pyleecan.Classes.Simu1 import Simu1

Tests/Plot/test_ICEM_2020.py

@@ -4,7 +4,7 @@
 from Tests import TEST_DIR
 from os.path import join, abspath, isfile
 
-TUTO_DIR = join(join(TEST_DIR, ".."), "Tutorials")
+TUTO_DIR = abspath(join(TEST_DIR, "..", "Tutorials"))
 
 
 @pytest.mark.tutorial
@@ -17,7 +17,7 @@ def test_short_tutorial(tuto_name):
 
     # Execute it
     ep = ExecutePreprocessor(timeout=-1, kernel_name="python3")
-    ep.preprocess(nb, {"metadata": {"path": TUTO_DIR}})
+    ep.preprocess(nb, {"metadata": {"path": abspath(join(TEST_DIR, ".."))}})
 
 
 @pytest.mark.tutorial
@@ -31,4 +31,4 @@ def test_long_tutorial(tuto_name):
 
     # Execute it
     ep = ExecutePreprocessor(timeout=-1, kernel_name="python3")
-    ep.preprocess(nb, {"metadata": {"path": TUTO_DIR}})
+    ep.preprocess(nb, {"metadata": {"path": abspath(join(TEST_DIR, ".."))}})

Tests/Plot/test_plots.py

@@ -86,7 +86,13 @@ def test_Magnetic_FEMM_sym():
     )
 
     out.mag.meshsolution.plot_mesh(
-        group_names=["stator", "/", "airgap", "stator_windings"]
+        group_names="stator",
+        save_path=join(save_path, "EM_SPMSM_FL_002_mesh_stator.png"),
+    )
+
+    out.mag.meshsolution.plot_mesh(
+        group_names=["stator", "/", "airgap", "stator_windings"],
+        save_path=join(save_path, "EM_SPMSM_FL_002_mesh_stator_interface.png"),
     )
 
     out.mag.meshsolution.plot_contour(