changed powerloss -> power loss density

updated docstring of function calc_hystersis_losses_with_MagNet_model_PB_based_on_mesh_results

Author: Sebastian Schachten

femmt/component.py

@@ -246,15 +246,20 @@ def calc_hystersis_losses_with_MagNet_model_PB_based_on_reluctance(self, peak_ma
         elif b_wave is WaveformType.Custom:
             b_wave = custom_b_wave * b_field_peak
 
-        power_loss = ff.calc_powerloss_from_MagNet_model_PB(material_name=self.core.material.material, b_wave=b_wave, frequency=self.frequency,
-                                                            temperature=self.core.material.temperature) * self.calculate_core_volume()
+        power_loss = ff.calc_power_loss_from_MagNet_model_PB(material_name=self.core.material.material, b_wave=b_wave, frequency=self.frequency,
+                                                             temperature=self.core.material.temperature) * self.calculate_core_volume()
         return power_loss
 
     def calc_hystersis_losses_with_MagNet_model_PB_based_on_mesh_results(self, b_wave: WaveformType = WaveformType.Sine,
                                                                          custom_b_wave: np.ndarray = None) -> float:
         """
         Calculate the hysteresis losses with the MagNet model of Paderborn University based on FEM-simulation results.
 
+        - uses the local magnetic flux densitiy in each mesh cell
+        - arbitrary waveforms are possible. But FEM simulation assumes a sinusoidal waveform and the peak of the magnetic flux density result of each mesh cell
+          is used to linearly scale the arbitrary waveform to its max. value
+        - for each mesh cell, the magnet model is applied
+
         :param b_wave: type of the waveform of the magnetic flux density/magnetizing current
         :type b_wave: WaveformType
         :param custom_b_wave: normalized signal of the magnetic flux density/magnetizing current (normalized -> amplitude of 1)
@@ -269,9 +274,9 @@ def calc_hystersis_losses_with_MagNet_model_PB_based_on_mesh_results(self, b_wav
         elif b_wave is WaveformType.Custom:
             b_wave = np.array([custom_b_wave * b for b in flux])
 
-        hyst_losses_density = ff.calc_powerloss_from_MagNet_model_PB(material_name=self.core.material.material, b_wave=b_wave,
-                                                                     frequency=np.array([self.frequency] * b_wave.shape[0]),
-                                                                     temperature=np.array([self.core.material.temperature] * b_wave.shape[0]))
+        hyst_losses_density = ff.calc_power_loss_from_MagNet_model_PB(material_name=self.core.material.material, b_wave=b_wave,
+                                                                      frequency=np.array([self.frequency] * b_wave.shape[0]),
+                                                                      temperature=np.array([self.core.material.temperature] * b_wave.shape[0]))
         power_loss = float(np.dot(hyst_losses_density, volume))
         return power_loss
 

femmt/functions.py

@@ -2767,9 +2767,9 @@ def compare_excel_files(femmt_excel_path: str, femm_excel_path: str, comparison_
                 worksheet.set_column('A:Z', 35)
 
 
-def calc_powerloss_from_MagNet_model_PB(material_name: Material, b_wave: np.ndarray, frequency: float, temperature: float) -> float | None:
+def calc_power_loss_from_MagNet_model_PB(material_name: Material, b_wave: np.ndarray, frequency: float, temperature: float) -> float | None:
     """
-    Calculate the powerloss density with the help of the trained neural network of the MagNet Challenge 2023.
+    Calculate the power loss density with the help of the trained neural network of the MagNet Challenge 2023.
 
     :param material_name: Name of the material
     :type material_name: Material
@@ -2783,8 +2783,8 @@ def calc_powerloss_from_MagNet_model_PB(material_name: Material, b_wave: np.ndar
     """
     if material_name.value in ["3C90", "3C92", "3C94", "3C95", "3E6", "3F4", "77", "78", "79", "ML95S", "T37", "N27", "N30", "N49", "N87"]:
         mdl = mh.loss.LossModel(material=material_name.value, team="paderborn")
-        powerloss, h_wave = mdl(b_wave, frequency, temperature)
-        return powerloss
+        power_loss_density, h_wave = mdl(b_wave, frequency, temperature)
+        return power_loss_density
     else:
         logger.warning("Material" + str(material_name.value) + " not supported by MagNet Models.")
         return None