Update code according review remarks.

Update comments and remove obsolete comments.

Author: SevenOfNinePE

femmt/examples/basic_inductor_with_dc_offset.py

@@ -1,12 +1,12 @@
 """
-Basic example to show how to simulate an inductor.
+Basic example to show how to simulate an inductor with current offset.
 
-After starting the program, the geometry dimensions are displayed. Verify this geometry, close the window, to continue the simulation.
-After a short time, B-Field and winding losses simulation results are shown. Winding losses are shown as a colormap.
-In the core, the magnitude B-Field in Tesla is shown. With the gmsh window, one can move the picture in the 3D way (not recommended).
-If you close this window, the thermal simulation will be continued, if programmed. If true, the thermal heat distribution will be displayed.
-To continue with the next simulation (or end the program), you need to close this window. All results are written to the result
+This example shows the calculation of the air gap by a given (dynamic) inductance.
+The dynamic inductance is calculated with a start air gap. The result of the inductance is taken to change the air gap
+accordingly. This changes the magnetic flux density, which influences the dynamic induction, so that the air gap will
+be approximated, until the requested accuracy is reached. All results are written to the result
 folder .../femmt/examples/example_results/simulation_file_name/results/log_electro_magnetic.json. and .../results_thermal.json.
+and the air gap length, calculated dynamic inductance and target  inductance is displayed.
 """
 import femmt as fmt
 import os
@@ -87,12 +87,6 @@ def basic_example_inductor_with_dc_offset(onelab_folder: str = None, show_visual
 
     # 4. set insulation
     # it is preferred to assign the exact dimensions of the bobbin for running electrostatic simulations or obtaining the capacitance of the inductor component
-    # using the function below
-    # bobbin_db = fmt.bobbin_database()["PQ 40/40"]
-    # bobbin_dimensions = fmt.dtos.BobbinDimensions(bobbin_inner_diameter=bobbin_db["bobbin_inner_diameter"],
-    #                                               bobbin_window_w=bobbin_db["bobbin_window_w"],
-    #                                               bobbin_window_h=bobbin_db["bobbin_window_h"],
-    #                                               bobbin_h=bobbin_db["bobbin_h"])
     insulation = fmt.Insulation(flag_insulation=True)
     insulation.add_core_insulations(0.001, 0.001, 0.003, 0.001)
     insulation.add_winding_insulations([[0.0005, 0.0005]], per_layer_of_turns=False)

femmt/examples/core_materials_temp.pro

@@ -33,7 +33,7 @@
 class InductorOptimization:
     """Reluctance model and FEM simulation for the inductor optimization."""
 
-    # Saturation threshold for calculation with Inductor optimization
+    # Relative saturation threshold for material based on 'b_sat' from material data base
     _IO_SATURATION_THRESHOLD = 0.8
 
     @staticmethod
@@ -390,14 +390,11 @@ def single_reluctance_model_simulation_dc_offset(reluctance_input: IoReluctanceM
             :rtype: IoReluctanceModelOutput
             """
             if act_dynamic_mu_r_abs is None:
-                # Variable declarationreluctance_input = {IoReluctanceModelInput} IoReluctanceModelInput(target_inductance=1e-05,
-                # core_inner_diameter=0.02, window_w=0.012, window_h=0.013463557904098145,
-                # turns...imported_complex_material=<femmt.model.ImportedComplexCoreMaterial object at 0x7c3ca5521e20>,
-                # current_offset=5.998990605058874)... View
                 dynamic_mu_r_abs = reluctance_input.material_mu_r_abs
             else:
                 dynamic_mu_r_abs = act_dynamic_mu_r_abs
 
+            # Variable declaration
             previous_dynamic_mu_r_abs = dynamic_mu_r_abs
 
             # prepare equidistant flux vector for the magnet loss simulation
@@ -501,13 +498,9 @@ def single_reluctance_model_simulation_dc_offset(reluctance_input: IoReluctanceM
 
             winding_area = reluctance_input.turns * reluctance_input.litz_wire_diameter ** 2
 
+            # Winding loss calculation
             p_winding = 0
             for count, fft_frequency in enumerate(reluctance_input.fft_frequency_list):
-                # proximity_factor_assumption = fmt.calc_proximity_factor_air_gap(
-                #     litz_wire_name=litz_wire_name, number_turns=turns, r_1=config.insulations.core_left,
-                #     frequency=fft_frequency, winding_area=winding_area,
-                #     litz_wire_material_name='Copper', temperature=config.temperature)
-
                 proximity_factor_assumption = fmt.calc_proximity_factor(
                     litz_wire_name=reluctance_input.litz_wire_name, number_turns=reluctance_input.turns, window_h=reluctance_input.window_h,
                     iso_core_top=reluctance_input.insulations.core_top, iso_core_bot=reluctance_input.insulations.core_bot,