Merge pull request #355 from EOMYS-Public/HoleMag

[NF] getter for ParamExplorer and get_desc for preview

Author: BonneelP

Tests/Classes/test_classes.py

@@ -317,14 +317,19 @@ def test_class_type_float(class_dict):
     prop_list = get_mother_attr(gen_dict, class_dict, "properties")[0]
     for prop in prop_list:
         value = find_test_value(prop, "float")
+        msg = "Error for class " + class_dict["name"] + " with " + prop["name"]
         # Check the doc to know if it should raise an error or not
         if prop["type"] in ["float", "complex", "", None]:
             # No error expected
             test_obj.__setattr__(prop["name"], value)
-            assert test_obj.__getattribute__(prop["name"]) == value
+
+            assert test_obj.__getattribute__(prop["name"]) == value, msg
         else:
             # CheckTypeError expected
-            with pytest.raises(CheckTypeError):
+            with pytest.raises(
+                CheckTypeError,
+            ):
+                # print(msg)
                 test_obj.__setattr__(prop["name"], value)
 
 

Tests/GUI/DMachineSetup/test_SMachineDimension.py

@@ -68,7 +68,7 @@ def test_init(self, setup):
         assert setup["widget"].lf_Lfra.value() == 0.25
         assert setup["widget"].g_frame.isChecked() == True
         assert setup["widget"].g_shaft.isChecked() == True
-        assert setup["widget"].out_Drsh.text() == "Drsh = 2*Rotor.Rint = 220.0 mm"
+        assert setup["widget"].out_Drsh.text() == "Drsh = 2*Rotor.Rint = 0.22 [m]"
 
     def test_init_no_shaft(self, setup):
         """Check that the Widget spinbox initialise to the lamination value"""

Tests/Validation/Simulation/Magnetics/test_meshsolution_plots.py

@@ -1,22 +1,20 @@
-from pyleecan.Functions.load import load
-from pyleecan.definitions import DATA_DIR
-
-from pyleecan.Classes.Simu1 import Simu1
-from pyleecan.Classes.InputCurrent import InputCurrent
-from pyleecan.Classes.ImportGenVectLin import ImportGenVectLin
-from pyleecan.Classes.ImportMatrixVal import ImportMatrixVal
-from pyleecan.Classes.MagFEMM import MagFEMM
-from pyleecan.Classes.Output import Output
-
-from Tests import save_plot_path
-from Tests import save_load_path
+import json
+from multiprocessing import cpu_count
 from os.path import join
-from numpy import zeros, ones, pi, array
 
 import matplotlib.pyplot as plt
-import json
 import numpy as np
 import pytest
+from numpy import array, ones, pi, zeros
+from pyleecan.Classes.ImportGenVectLin import ImportGenVectLin
+from pyleecan.Classes.ImportMatrixVal import ImportMatrixVal
+from pyleecan.Classes.InputCurrent import InputCurrent
+from pyleecan.Classes.MagFEMM import MagFEMM
+from pyleecan.Classes.Output import Output
+from pyleecan.Classes.Simu1 import Simu1
+from pyleecan.definitions import DATA_DIR
+from pyleecan.Functions.load import load
+from Tests import save_load_path, save_plot_path
 
 
 @pytest.mark.long
@@ -81,37 +79,41 @@ def test_SIPMSM_003():
     simu_sym.run()
 
     out.mag.meshsolution.plot_mesh(
-        save_path=join(save_path, simu.name + "_mesh.png"), is_show_fig=False
+        save_path=join(save_plot_path, simu.name + "_mesh.png"), is_show_fig=False
     )
 
     out.mag.meshsolution.plot_mesh(
         group_names="stator core",
-        save_path=join(save_path, simu.name + "_mesh_stator.png"),
+        save_path=join(save_plot_path, simu.name + "_mesh_stator.png"),
         is_show_fig=False,
     )
 
     out.mag.meshsolution.plot_mesh(
         group_names=["stator core", "/", "airgap", "stator winding"],
-        save_path=join(save_path, simu.name + "_mesh_stator_interface.png"),
+        save_path=join(save_plot_path, simu.name + "_mesh_stator_interface.png"),
         is_show_fig=False,
     )
 
     out.mag.meshsolution.plot_contour(
         label="\mu",
-        save_path=join(save_path, simu.name + "_mu.png"),
+        save_path=join(save_plot_path, simu.name + "_mu.png"),
         is_show_fig=False,
     )
     out.mag.meshsolution.plot_contour(
-        label="B", save_path=join(save_path, simu.name + "_B.png"), is_show_fig=False
+        label="B",
+        save_path=join(save_plot_path, simu.name + "_B.png"),
+        is_show_fig=False,
     )
     out.mag.meshsolution.plot_contour(
-        label="H", save_path=join(save_path, simu.name + "_H.png"), is_show_fig=False
+        label="H",
+        save_path=join(save_plot_path, simu.name + "_H.png"),
+        is_show_fig=False,
     )
 
     out.mag.meshsolution.plot_contour(
         label="H",
         group_names="stator core",
-        save_path=join(save_path, simu.name + "_H_stator.png"),
+        save_path=join(save_plot_path, simu.name + "_H_stator.png"),
         is_show_fig=False,
     )
 

Tests/Validation/Simulation/Multisimulation/test_multi_multi.py

@@ -196,12 +196,16 @@ def test_multi_multi():
             symbol="W0s",
             unit="m",
             setter="simu.machine.stator.slot.W0",
+            getter="simu.machine.stator.slot.W0",
             min_value=0.1 * IPMSM_A.stator.slot.W0,
             max_value=IPMSM_A.stator.slot.W0,
             N=N1,
         )
     ]
-
+    assert (
+        paramexplorer_list[0].get_desc(simu)
+        == "W0s: " + str(N1) + " values from 0.000193 to 0.00193 (ref=0.00193) [m]"
+    )
     multisim.paramexplorer_list = paramexplorer_list
     multisim.is_keep_all_output = True
 

pyleecan/Classes/Class_Dict.json

@@ -787,7 +787,8 @@
         "desc": "Class for defining data to keep on a multi-simulation",
         "is_internal": false,
         "methods": [
-            "as_dict"
+            "as_dict",
+            "_set_result"
         ],
         "mother": "",
         "name": "DataKeeper",
@@ -7735,7 +7736,9 @@
         "desc": "Abstract class for the multi-simulation",
         "is_internal": false,
         "methods": [
-            "_set_setter"
+            "_set_setter",
+            "_set_getter",
+            "get_desc"
         ],
         "mother": "",
         "name": "ParamExplorer",
@@ -7777,6 +7780,15 @@
                 "type": "function",
                 "unit": "-",
                 "value": null
+            },
+            {
+                "desc": "Function to return the reference value (simulation as argument)",
+                "max": "",
+                "min": "",
+                "name": "getter",
+                "type": "function",
+                "unit": "-",
+                "value": null
             }
         ]
     },
@@ -7830,7 +7842,7 @@
             },
             {
                 "desc": "How to generate the value list. 0: linspace, 1: random (Not available yet)",
-                "max": "0",
+                "max": "1",
                 "min": "0",
                 "name": "type_value_gen",
                 "type": "int",

pyleecan/Classes/DataKeeper.py

@@ -22,6 +22,11 @@
 except ImportError as error:
     as_dict = error
 
+try:
+    from ..Methods.Simulation.DataKeeper._set_result import _set_result
+except ImportError as error:
+    _set_result = error
+
 
 from ntpath import basename
 from os.path import isfile
@@ -36,6 +41,7 @@ class DataKeeper(FrozenClass):
 
     VERSION = 1
 
+    # Check ImportError to remove unnecessary dependencies in unused method
     # cf Methods.Simulation.DataKeeper.as_dict
     if isinstance(as_dict, ImportError):
         as_dict = property(
@@ -45,6 +51,17 @@ class DataKeeper(FrozenClass):
         )
     else:
         as_dict = as_dict
+    # cf Methods.Simulation.DataKeeper._set_result
+    if isinstance(_set_result, ImportError):
+        _set_result = property(
+            fget=lambda x: raise_(
+                ImportError(
+                    "Can't use DataKeeper method _set_result: " + str(_set_result)
+                )
+            )
+        )
+    else:
+        _set_result = _set_result
     # save and copy methods are available in all object
     save = save
     copy = copy
@@ -355,13 +372,6 @@ def _get_result(self):
         """getter of result"""
         return self._result
 
-    def _set_result(self, value):
-        """setter of result"""
-        if type(value) is int and value == -1:
-            value = list()
-        check_var("result", value, "list")
-        self._result = value
-
     result = property(
         fget=_get_result,
         fset=_set_result,

pyleecan/Classes/OptiDesignVar.py

@@ -43,6 +43,7 @@ def __init__(
         symbol="",
         unit="",
         setter=None,
+        getter=None,
         init_dict=None,
         init_str=None,
     ):
@@ -75,13 +76,15 @@ def __init__(
                 unit = init_dict["unit"]
             if "setter" in list(init_dict.keys()):
                 setter = init_dict["setter"]
+            if "getter" in list(init_dict.keys()):
+                getter = init_dict["getter"]
         # Set the properties (value check and convertion are done in setter)
         self.type_var = type_var
         self.space = space
         self.get_value = get_value
         # Call ParamExplorer init
         super(OptiDesignVar, self).__init__(
-            name=name, symbol=symbol, unit=unit, setter=setter
+            name=name, symbol=symbol, unit=unit, setter=setter, getter=getter
         )
         # The class is frozen (in ParamExplorer init), for now it's impossible to
         # add new properties