Merge pull request #230 from EOMYS-Public/FEMM

[CO] Move store method from Magnetic models to OutMag object

Author: BonneelP

Tests/GUI/DMachineSetup/test_SMHoleMag.py

@@ -421,11 +421,11 @@ def test_s_plot(self, setup):
         setup["widget"] = SMHoleMag(
             machine=setup["test_obj"], matlib=setup["matlib"], is_stator=False
         )
-        setup["widget"].s_plot()
+        setup["widget"].s_plot(is_show_fig=False)
 
         assert setup["widget"].machine.rotor.hole[0].Zh == 8
 
         setup["widget"].machine.rotor.hole[0].W1 = 0.300
-        setup["widget"].s_plot()
+        setup["widget"].s_plot(is_show_fig=False)
 
         assert setup["widget"].out_hole_pitch.text() == "Slot pitch = 360 / 2p = 45 °"

Tests/GUI/DMatLib/test_Workflow_Matlib.py

@@ -67,6 +67,10 @@ def setup(self):
 
         self.app.quit()
 
+        topLevelWidgets = QtWidgets.QApplication.topLevelWidgets()
+        for widget in topLevelWidgets:
+            widget.close()
+
         if is_clean_result:
             rmtree(work_path)
 
@@ -174,6 +178,8 @@ def test_init(self, setup):
             self.widget.tab_hole.widget(0).w_hole.w_mat_1.mat_win.mat_win.mat.elec.rho
             == 1234.56789
         )
+
+        self.app.exit()
         # Close the Edit GUI and check Matlib modification
 
         # Doesn't Work

pyleecan/Classes/Class_Dict.json

@@ -4255,8 +4255,7 @@
             "get_meshsolution",
             "get_path_save_fea",
             "get_path_save",
-            "comp_axes",
-            "store_output"
+            "comp_axes"
         ],
         "mother": "Magnetics",
         "name": "MagElmer",
@@ -4381,9 +4380,7 @@
             "get_meshsolution",
             "get_path_save_fem",
             "build_meshsolution",
-            "solve_FEMM_parallel",
-            "comp_axes",
-            "store_output"
+            "solve_FEMM_parallel"
         ],
         "mother": "Magnetics",
         "name": "MagFEMM",
@@ -4430,7 +4427,7 @@
                 "desc": "To enforce user-defined values for FEMM main parameters ",
                 "max": "",
                 "min": "",
-                "name": "FEMM_dict",
+                "name": "FEMM_dict_enforced",
                 "type": "dict",
                 "unit": "",
                 "value": ""
@@ -4894,8 +4891,7 @@
         "is_internal": false,
         "methods": [
             "run",
-            "comp_axes",
-            "store_output"
+            "comp_axes"
         ],
         "mother": "",
         "name": "Magnetics",
@@ -6655,7 +6651,8 @@
         "desc": "Gather the magnetic module outputs",
         "is_internal": false,
         "methods": [
-            "comp_emf"
+            "comp_emf",
+            "store"
         ],
         "mother": "",
         "name": "OutMag",

pyleecan/Classes/MagElmer.py

@@ -46,11 +46,6 @@
 except ImportError as error:
     comp_axes = error
 
-try:
-    from ..Methods.Simulation.MagElmer.store_output import store_output
-except ImportError as error:
-    store_output = error
-
 
 from ._check import InitUnKnowClassError
 from .DXFImport import DXFImport
@@ -127,17 +122,6 @@ class MagElmer(Magnetics):
         )
     else:
         comp_axes = comp_axes
-    # cf Methods.Simulation.MagElmer.store_output
-    if isinstance(store_output, ImportError):
-        store_output = property(
-            fget=lambda x: raise_(
-                ImportError(
-                    "Can't use MagElmer method store_output: " + str(store_output)
-                )
-            )
-        )
-    else:
-        store_output = store_output
     # save and copy methods are available in all object
     save = save
     copy = copy

pyleecan/Classes/MagFEMM.py

@@ -51,16 +51,6 @@
 except ImportError as error:
     solve_FEMM_parallel = error
 
-try:
-    from ..Methods.Simulation.MagFEMM.comp_axes import comp_axes
-except ImportError as error:
-    comp_axes = error
-
-try:
-    from ..Methods.Simulation.MagFEMM.store_output import store_output
-except ImportError as error:
-    store_output = error
-
 
 from ._check import InitUnKnowClassError
 from .DXFImport import DXFImport
@@ -152,26 +142,6 @@ class MagFEMM(Magnetics):
         )
     else:
         solve_FEMM_parallel = solve_FEMM_parallel
-    # cf Methods.Simulation.MagFEMM.comp_axes
-    if isinstance(comp_axes, ImportError):
-        comp_axes = property(
-            fget=lambda x: raise_(
-                ImportError("Can't use MagFEMM method comp_axes: " + str(comp_axes))
-            )
-        )
-    else:
-        comp_axes = comp_axes
-    # cf Methods.Simulation.MagFEMM.store_output
-    if isinstance(store_output, ImportError):
-        store_output = property(
-            fget=lambda x: raise_(
-                ImportError(
-                    "Can't use MagFEMM method store_output: " + str(store_output)
-                )
-            )
-        )
-    else:
-        store_output = store_output
     # save and copy methods are available in all object
     save = save
     copy = copy
@@ -184,7 +154,7 @@ def __init__(
         Kgeo_fineness=1,
         type_calc_leakage=0,
         file_name="",
-        FEMM_dict=-1,
+        FEMM_dict_enforced=-1,
         is_get_mesh=False,
         is_save_FEA=False,
         is_sliding_band=True,
@@ -231,8 +201,8 @@ def __init__(
                 type_calc_leakage = init_dict["type_calc_leakage"]
             if "file_name" in list(init_dict.keys()):
                 file_name = init_dict["file_name"]
-            if "FEMM_dict" in list(init_dict.keys()):
-                FEMM_dict = init_dict["FEMM_dict"]
+            if "FEMM_dict_enforced" in list(init_dict.keys()):
+                FEMM_dict_enforced = init_dict["FEMM_dict_enforced"]
             if "is_get_mesh" in list(init_dict.keys()):
                 is_get_mesh = init_dict["is_get_mesh"]
             if "is_save_FEA" in list(init_dict.keys()):
@@ -278,7 +248,7 @@ def __init__(
         self.Kgeo_fineness = Kgeo_fineness
         self.type_calc_leakage = type_calc_leakage
         self.file_name = file_name
-        self.FEMM_dict = FEMM_dict
+        self.FEMM_dict_enforced = FEMM_dict_enforced
         self.is_get_mesh = is_get_mesh
         self.is_save_FEA = is_save_FEA
         self.is_sliding_band = is_sliding_band
@@ -315,7 +285,7 @@ def __str__(self):
         MagFEMM_str += "Kgeo_fineness = " + str(self.Kgeo_fineness) + linesep
         MagFEMM_str += "type_calc_leakage = " + str(self.type_calc_leakage) + linesep
         MagFEMM_str += 'file_name = "' + str(self.file_name) + '"' + linesep
-        MagFEMM_str += "FEMM_dict = " + str(self.FEMM_dict) + linesep
+        MagFEMM_str += "FEMM_dict_enforced = " + str(self.FEMM_dict_enforced) + linesep
         MagFEMM_str += "is_get_mesh = " + str(self.is_get_mesh) + linesep
         MagFEMM_str += "is_save_FEA = " + str(self.is_save_FEA) + linesep
         MagFEMM_str += "is_sliding_band = " + str(self.is_sliding_band) + linesep
@@ -359,7 +329,7 @@ def __eq__(self, other):
             return False
         if other.file_name != self.file_name:
             return False
-        if other.FEMM_dict != self.FEMM_dict:
+        if other.FEMM_dict_enforced != self.FEMM_dict_enforced:
             return False
         if other.is_get_mesh != self.is_get_mesh:
             return False
@@ -390,8 +360,10 @@ def as_dict(self):
         MagFEMM_dict["Kgeo_fineness"] = self.Kgeo_fineness
         MagFEMM_dict["type_calc_leakage"] = self.type_calc_leakage
         MagFEMM_dict["file_name"] = self.file_name
-        MagFEMM_dict["FEMM_dict"] = (
-            self.FEMM_dict.copy() if self.FEMM_dict is not None else None
+        MagFEMM_dict["FEMM_dict_enforced"] = (
+            self.FEMM_dict_enforced.copy()
+            if self.FEMM_dict_enforced is not None
+            else None
         )
         MagFEMM_dict["is_get_mesh"] = self.is_get_mesh
         MagFEMM_dict["is_save_FEA"] = self.is_save_FEA
@@ -422,7 +394,7 @@ def _set_None(self):
         self.Kgeo_fineness = None
         self.type_calc_leakage = None
         self.file_name = None
-        self.FEMM_dict = None
+        self.FEMM_dict_enforced = None
         self.is_get_mesh = None
         self.is_save_FEA = None
         self.is_sliding_band = None
@@ -511,20 +483,20 @@ def _set_file_name(self, value):
         """,
     )
 
-    def _get_FEMM_dict(self):
-        """getter of FEMM_dict"""
-        return self._FEMM_dict
+    def _get_FEMM_dict_enforced(self):
+        """getter of FEMM_dict_enforced"""
+        return self._FEMM_dict_enforced
 
-    def _set_FEMM_dict(self, value):
-        """setter of FEMM_dict"""
+    def _set_FEMM_dict_enforced(self, value):
+        """setter of FEMM_dict_enforced"""
         if type(value) is int and value == -1:
             value = dict()
-        check_var("FEMM_dict", value, "dict")
-        self._FEMM_dict = value
+        check_var("FEMM_dict_enforced", value, "dict")
+        self._FEMM_dict_enforced = value
 
-    FEMM_dict = property(
-        fget=_get_FEMM_dict,
-        fset=_set_FEMM_dict,
+    FEMM_dict_enforced = property(
+        fget=_get_FEMM_dict_enforced,
+        fset=_set_FEMM_dict_enforced,
         doc=u"""To enforce user-defined values for FEMM main parameters 
 
         :Type: dict

pyleecan/Classes/Magnetics.py

@@ -26,11 +26,6 @@
 except ImportError as error:
     comp_axes = error
 
-try:
-    from ..Methods.Simulation.Magnetics.store_output import store_output
-except ImportError as error:
-    store_output = error
-
 
 from ._check import InitUnKnowClassError
 
@@ -59,17 +54,6 @@ class Magnetics(FrozenClass):
         )
     else:
         comp_axes = comp_axes
-    # cf Methods.Simulation.Magnetics.store_output
-    if isinstance(store_output, ImportError):
-        store_output = property(
-            fget=lambda x: raise_(
-                ImportError(
-                    "Can't use Magnetics method store_output: " + str(store_output)
-                )
-            )
-        )
-    else:
-        store_output = store_output
     # save and copy methods are available in all object
     save = save
     copy = copy

pyleecan/Classes/OutMag.py

@@ -21,6 +21,11 @@
 except ImportError as error:
     comp_emf = error
 
+try:
+    from ..Methods.Output.OutMag.store import store
+except ImportError as error:
+    store = error
+
 
 from ._check import InitUnKnowClassError
 from .MeshSolution import MeshSolution
@@ -31,6 +36,7 @@ class OutMag(FrozenClass):
 
     VERSION = 1
 
+    # Check ImportError to remove unnecessary dependencies in unused method
     # cf Methods.Output.OutMag.comp_emf
     if isinstance(comp_emf, ImportError):
         comp_emf = property(
@@ -40,6 +46,15 @@ class OutMag(FrozenClass):
         )
     else:
         comp_emf = comp_emf
+    # cf Methods.Output.OutMag.store
+    if isinstance(store, ImportError):
+        store = property(
+            fget=lambda x: raise_(
+                ImportError("Can't use OutMag method store: " + str(store))
+            )
+        )
+    else:
+        store = store
     # save and copy methods are available in all object
     save = save
     copy = copy

pyleecan/GUI/Dialog/DMachineSetup/SMHoleMag/SMHoleMag.py

@@ -141,7 +141,7 @@ def s_remove(self):
             self.tab_hole.removeTab(len(self.obj.hole) - 1)
             self.obj.hole.pop(-1)
 
-    def s_plot(self):
+    def s_plot(self, is_show_fig=True):
         """Try to plot the lamination
 
         Parameters
@@ -160,7 +160,7 @@ def s_plot(self):
         if error:  # Error => Display it
             QMessageBox().critical(self, self.tr("Error"), error)
         else:  # No error => Plot the hole (No winding for LamSquirrelCage)
-            self.machine.plot()
+            self.machine.plot(is_show_fig=is_show_fig)
 
     @staticmethod
     def check(lamination):

pyleecan/Generator/ClassesRef/Output/OutMag.csv

@@ -1,6 +1,6 @@
 Variable name,Unit,Description (EN),Size,Type,Default value,Minimum value,Maximum value,,Package,Inherit,Methods,Constant Name,Constant Value,Class description
 Time,s,Magnetic time Data object,Nt_tot,SciDataTool.Classes.DataND.Data,None,,,,Output,,comp_emf,VERSION,1,Gather the magnetic module outputs
-Angle,rad,Magnetic position Data object,Na_tot,SciDataTool.Classes.DataND.Data,None,,,,,,,,,
+Angle,rad,Magnetic position Data object,Na_tot,SciDataTool.Classes.DataND.Data,None,,,,,,store,,,
 B,H,Airgap flux density VectorField object,"(Nt_tot,Na_tot)",SciDataTool.Classes.VectorField.VectorField,None,,,,,,,,,
 Tem,N.m,Electromagnetic torque DataTime object,Nt_tot,SciDataTool.Classes.DataND.DataND,None,,,,,,,,,
 Tem_av,N.m,Average Electromagnetic torque,,float,None,,,,,,,,,

pyleecan/Generator/ClassesRef/Simulation/MagElmer.csv

@@ -5,7 +5,7 @@ file_name,,Name of the file to save the Elmer model,0,str,,,,,,,get_meshsolution
 FEA_dict,,To enforce user-defined values for Elmer main parameters ,0,dict,,,,,,,get_path_save_fea,,,,
 is_get_mesh,,To save FEA mesh for latter post-procesing ,0,bool,0,,,,,,get_path_save,,,,
 is_save_FEA,,To save FEA mesh and solution in a file,0,bool,0,,,,,,comp_axes,,,,
-transform_list,,"List of dictionnary to apply transformation on the machine surfaces. Key: label (to select the surface), type (rotate or translate), value (alpha or delta)",0,list,[],,,,,,store_output,,,,
+transform_list,,"List of dictionnary to apply transformation on the machine surfaces. Key: label (to select the surface), type (rotate or translate), value (alpha or delta)",0,list,[],,,,,,,,,,
 rotor_dxf,,To use a dxf version of the rotor instead of build_geometry,,DXFImport,None,,,,,,,,,,
 stator_dxf,,To use a dxf version of the rotor instead of build_geometry,,DXFImport,None,,,,,,,,,,
 import_file,,To import an existing simulation file,0,str,,,,,,,,,,,