Merge pull request #160 from upb-lea/new_mdb

use common classes for the optimization routines

Author: gituser789

README.rst

@@ -150,21 +150,6 @@ the corresponding FEM simulation on the right. |FEMMT_Screenshot|
 
 To run a minimal example please have a look at the `examples <https://github.com/upb-lea/FEM_Magnetics_Toolbox/tree/main/femmt/examples>`__.
 
-GUI (Experimental)
--------------------
-
-There is a first preview for a GUI. Installing this is a bit cumbersome
-at first, but will be simplified in the future:
-
-* Download the complete repository via ``Code`` -> ``Download ZIP`` and unpack it.
-* Or clone the repository
-* Install the development version of femmt using ``pip install -e .``
-* Run python ``.../path-to_femmt/femmt/gui/femmt_gui.py``
-
-Please note, the GUI is experimental.
-
-|femmt_gui_definition|
-
 Troubleshooting
 -------------------
 If the working directory is within OneDrive, there are problems writing .dat files, which are basic for FEMMT. The following error messages appear:
@@ -213,5 +198,4 @@ programming language python is used.
 
 .. |geometry_translated| image:: docs/images/geometry_translated.png
 .. |FEMMT_Screenshot| image:: docs/images/FEMMT_Screenshot.png
-.. |femmt_gui_definition| image:: docs/images/femmt_gui_definition.png
 .. |counting_arrow_system| image:: docs/images/counting_arrow_system.png

femmt/optimization/io_dtos.py

@@ -6,18 +6,8 @@
 from magnethub.loss import LossModel
 
 # own libraries
-from materialdatabase.meta.data_enums import DataSource
-from femmt.enumerations import *
 from femmt.optimization.ito_dtos import WorkingDirectories
-
-@dataclasses.dataclass
-class InductorMaterialDataSources:
-    """Data sources for the FEM simulation."""
-
-    permeability_datasource: DataSource
-    permeability_datatype: MeasurementDataType
-    permittivity_datasource: DataSource
-    permittivity_datatype: MeasurementDataType
+from femmt.optimization.optimization_dtos import MaterialDataSources
 
 @dataclasses.dataclass
 class InductorInsulationDTO:
@@ -54,7 +44,7 @@ class InductorOptimizationDTO:
     litz_wire_name_list: list[str]
 
     # FEM simulation
-    material_data_sources: InductorMaterialDataSources
+    material_data_sources: MaterialDataSources
 
 @dataclasses.dataclass
 class InductorOptimizationTargetAndFixedParameters:
@@ -96,7 +86,7 @@ class FemInput:
     insulations: InductorInsulationDTO
 
     # data sources
-    material_data_sources: InductorMaterialDataSources
+    material_data_sources: MaterialDataSources
 
     # operating point conditions
     temperature: float

femmt/optimization/ito_dtos.py

@@ -4,10 +4,10 @@
 
 # 3rd party libraries
 import numpy as np
-from materialdatabase.meta.data_enums import DataSource
-from materialdatabase.meta.setup_enums import MeasurementDataType
 from magnethub.loss import LossModel
-from femmt.enumerations import *
+
+# own libraries
+from femmt.optimization.optimization_dtos import MaterialDataSources, WorkingDirectories
 
 @dataclass
 class ItoInsulation:
@@ -28,15 +28,6 @@ class ItoInsulation:
     iso_secondary_to_secondary: float
     iso_primary_to_secondary: float
 
-@dataclass
-class IntegratedTransformerMaterialDataSources:
-    """Data sources for the FEM simulation."""
-
-    permeability_datasource: DataSource
-    permeability_datatype: MeasurementDataType
-    permittivity_datasource: DataSource
-    permittivity_datatype: MeasurementDataType
-
 @dataclass
 class ItoSingleInputConfig:
     """
@@ -78,18 +69,7 @@ class ItoSingleInputConfig:
     insulations: ItoInsulation
 
     # data sources
-    material_data_sources: IntegratedTransformerMaterialDataSources
-
-@dataclass
-class WorkingDirectories:
-    """Working directories for an integrated transformer optimization."""
-
-    fem_working_directory: str
-    reluctance_model_results_directory: str
-    fem_simulation_results_directory: str
-    fem_simulation_filtered_results_directory: str
-    fem_thermal_simulation_results_directory: str
-    fem_thermal_filtered_simulation_results_directory: str
+    material_data_sources: MaterialDataSources
 
 @dataclass
 class ItoTargetAndFixedParameters:

femmt/optimization/optimization_dtos.py

@@ -0,0 +1,28 @@
+"""Common data classes uses by multiple optimization classes and methods."""
+
+# python libraries
+import dataclasses
+
+# own libraries
+from materialdatabase.meta.data_enums import DataSource
+from materialdatabase.meta.setup_enums import MeasurementDataType
+
+@dataclasses.dataclass
+class MaterialDataSources:
+    """Data sources for the FEM simulation."""
+
+    permeability_datasource: DataSource
+    permeability_datatype: MeasurementDataType
+    permittivity_datasource: DataSource
+    permittivity_datatype: MeasurementDataType
+
+@dataclasses.dataclass
+class WorkingDirectories:
+    """Working directories for an integrated transformer optimization."""
+
+    fem_working_directory: str
+    reluctance_model_results_directory: str
+    fem_simulation_results_directory: str
+    fem_simulation_filtered_results_directory: str
+    fem_thermal_simulation_results_directory: str
+    fem_thermal_filtered_simulation_results_directory: str

femmt/optimization/sto_ct_dtos.py

@@ -4,9 +4,11 @@
 
 # 3rd party libraries
 import numpy as np
+
+# own libraries (mdb + femmt)
 from materialdatabase.meta.data_enums import DataSource
 from materialdatabase.meta.setup_enums import MeasurementDataType
-
+from femmt.optimization.ito_dtos import WorkingDirectories
 
 @dataclass
 class StoCtInsulation:
@@ -82,19 +84,6 @@ class ThermalConfig:
     boundary_temperatures: dict
     boundary_flags: dict
 
-
-@dataclass
-class WorkingDirectories:
-    """Working directories for an integrated transformer optimization."""
-
-    fem_working_directory: str
-    reluctance_model_results_directory: str
-    fem_simulation_results_directory: str
-    fem_simulation_filtered_results_directory: str
-    fem_thermal_simulation_results_directory: str
-    fem_thermal_filtered_simulation_results_directory: str
-
-
 @dataclass
 class StoCtTargetAndFixedParameters:
     """

femmt/optimization/sto_dtos.py

@@ -4,20 +4,10 @@
 
 # 3rd party libraries
 import numpy as np
-from materialdatabase.meta.data_enums import DataSource
-from femmt.enumerations import *
 from magnethub.loss import LossModel
 
-@dataclass
-class WorkingDirectories:
-    """Working directories for an integrated transformer optimization."""
-
-    fem_working_directory: str
-    reluctance_model_results_directory: str
-    fem_simulation_results_directory: str
-    fem_simulation_filtered_results_directory: str
-    fem_thermal_simulation_results_directory: str
-    fem_thermal_filtered_simulation_results_directory: str
+# own libraries
+from femmt.optimization.optimization_dtos import MaterialDataSources, WorkingDirectories
 
 @dataclass
 class StoTargetAndFixedParameters:
@@ -71,15 +61,6 @@ class StoInsulation:
     iso_secondary_to_secondary: float
     iso_primary_to_secondary: float
 
-@dataclass
-class StackedTransformerMaterialDataSources:
-    """Data sources for the FEM simulation."""
-
-    permeability_datasource: DataSource
-    permeability_datatype: MeasurementDataType
-    permittivity_datasource: DataSource
-    permittivity_datatype: MeasurementDataType
-
 @dataclass
 class StoSingleInputConfig:
     """
@@ -125,7 +106,7 @@ class StoSingleInputConfig:
     mesh_accuracy: float
 
     # data sources
-    material_data_sources: StackedTransformerMaterialDataSources
+    material_data_sources: MaterialDataSources
 
 @dataclass
 class FemInput:
@@ -151,13 +132,13 @@ class FemInput:
     insulations: StoInsulation
 
     # data sources
-    material_data_sources: StackedTransformerMaterialDataSources
+    material_data_sources: MaterialDataSources
 
     # operating point conditions
     temperature: float
     fundamental_frequency: float
-    time_current_1_vec: np.array
-    time_current_2_vec: np.array
+    time_current_1_vec: np.ndarray
+    time_current_2_vec: np.ndarray
 
 @dataclass
 class FemOutput:
@@ -176,7 +157,7 @@ class FemOutput:
 class ReluctanceModelInput:
     """Input DTO for reluctance model simulation within the inductor optimization."""
 
-    target_inductance_matrix: np.array
+    target_inductance_matrix: np.ndarray
     core_inner_diameter: float
     window_w: float
     window_h_bot: float

femmt/optimization/to_dtos.py

@@ -4,9 +4,7 @@
 
 # 3rd party libraries
 import numpy as np
-from materialdatabase.meta.data_enums import DataSource
-from femmt.enumerations import *
-
+from femmt.optimization.optimization_dtos import MaterialDataSources, WorkingDirectories
 
 @dataclass
 class ToInsulation:
@@ -63,10 +61,7 @@ class ToSingleInputConfig:
     mesh_accuracy: float
 
     # data sources
-    permeability_datasource: DataSource
-    permeability_datatype: MeasurementDataType
-    permittivity_datasource: DataSource
-    permittivity_datatype: MeasurementDataType
+    material_datasources: MaterialDataSources
 
 
 @dataclass
@@ -80,19 +75,6 @@ class ThermalConfig:
     boundary_temperatures: dict
     boundary_flags: dict
 
-
-@dataclass
-class WorkingDirectories:
-    """Working directories for an integrated transformer optimization."""
-
-    fem_working_directory: str
-    reluctance_model_results_directory: str
-    fem_simulation_results_directory: str
-    fem_simulation_filtered_results_directory: str
-    fem_thermal_simulation_results_directory: str
-    fem_thermal_filtered_simulation_results_directory: str
-
-
 @dataclass
 class ToTargetAndFixedParameters:
     """