deploy: 4cfef20

Author: gituser789

_sources/user_guide_model_creation.rst.txt

@@ -26,15 +26,15 @@ This results to the following code:
    import femmt as fmt
 
    geo = fmt.MagneticComponent(simulation_type=fmt.SimulationType.FreqDomain,
-                                component_type=fmt.ComponentType.Transformer, working_directory=working_directory,
-                                verbosity=fmt.Verbosity.ToConsole, is_gui=is_test)
+                               component_type=fmt.ComponentType.Transformer, working_directory=working_directory,
+                               onelab_verbosity=fmt.Verbosity.ToConsole)
 
 The ``simulation_type`` specifies the type of simulation to be performed.
 
 - If set to ``FreqDomain``, indicating a frequency domain simulation.
 - If set to ``TimeDomain``, indicating a time domain simulations.
 
-The ``Verbosity`` controls the level of detail in the output.
+The ``onelab_verbosity`` controls the level of the FEM simulation software ``Onelab`` details in the output.
 
 - If set to ``ToConsole``, all output messages are shown in the commend line .
 - If set to ``ToFile``, all output messages are written to files.
@@ -81,16 +81,15 @@ Now the core object can be created and added to the model (geo object)
                                                     window_h=core_db["window_h"],
                                                     core_h=core_db["core_h"])
 
-   core = fmt.Core(core_type=fmt.CoreType.Single,
+   core_material = fmt.ImportedComplexCoreMaterial(material=fmt.Material.N49,
+                                                   temperature=45,
+                                                   permeability_datasource=fmt.DataSource.TDK_MDT,
+                                                   permittivity_datasource=fmt.DataSource.LEA_MTB)
+
+    core = fmt.Core(material=core_material,
+                    core_type=fmt.CoreType.Single,
                     core_dimensions=core_dimensions,
-                    detailed_core_model=False,
-                    material=mdb.Material.N49, temperature=45, frequency=inductor_frequency,
-                    permeability_datasource=fmt.MaterialDataSource.Measurement,
-                    permeability_datatype=fmt.MeasurementDataType.ComplexPermeability,
-                    permeability_measurement_setup=mdb.MeasurementSetup.LEA_LK,
-                    permittivity_datasource=fmt.MaterialDataSource.Measurement,
-                    permittivity_datatype=fmt.MeasurementDataType.ComplexPermittivity,
-                    permittivity_measurement_setup=mdb.MeasurementSetup.LEA_LK, mdb_verbosity=fmt.Verbosity.Silent)
+                    detailed_core_model=False)
    geo.set_core(core)
 
 Material database
@@ -351,7 +350,7 @@ To create a conductor have a look at the following code example:
 
 .. code:: python
 
-   winding1 = fmt.Conductor(winding_number=0, conductivity=fmt.Conductivity.Copper)
+   winding1 = fmt.Conductor(winding_number=0, conductivity=fmt.ConductorMaterial.Copper)
    winding1.set_solid_round_conductor(conductor_radius=0.0011, conductor_arrangement=fmt.ConductorArrangement.Square)
 
 Add conductors to virtual winding windows

intro.html

@@ -540,16 +540,16 @@ <h2><span class="sectnum">2.1 </span>Working directory<a class="headerlink" href
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span><span class="w"> </span><span class="nn">femmt</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">fmt</span>
 
 <span class="n">geo</span> <span class="o">=</span> <span class="n">fmt</span><span class="o">.</span><span class="n">MagneticComponent</span><span class="p">(</span><span class="n">simulation_type</span><span class="o">=</span><span class="n">fmt</span><span class="o">.</span><span class="n">SimulationType</span><span class="o">.</span><span class="n">FreqDomain</span><span class="p">,</span>
-                             <span class="n">component_type</span><span class="o">=</span><span class="n">fmt</span><span class="o">.</span><span class="n">ComponentType</span><span class="o">.</span><span class="n">Transformer</span><span class="p">,</span> <span class="n">working_directory</span><span class="o">=</span><span class="n">working_directory</span><span class="p">,</span>
-                             <span class="n">verbosity</span><span class="o">=</span><span class="n">fmt</span><span class="o">.</span><span class="n">Verbosity</span><span class="o">.</span><span class="n">ToConsole</span><span class="p">,</span> <span class="n">is_gui</span><span class="o">=</span><span class="n">is_test</span><span class="p">)</span>
+                            <span class="n">component_type</span><span class="o">=</span><span class="n">fmt</span><span class="o">.</span><span class="n">ComponentType</span><span class="o">.</span><span class="n">Transformer</span><span class="p">,</span> <span class="n">working_directory</span><span class="o">=</span><span class="n">working_directory</span><span class="p">,</span>
+                            <span class="n">onelab_verbosity</span><span class="o">=</span><span class="n">fmt</span><span class="o">.</span><span class="n">Verbosity</span><span class="o">.</span><span class="n">ToConsole</span><span class="p">)</span>
 </pre></div>
 </div>
 <p>The <code class="docutils literal notranslate"><span class="pre">simulation_type</span></code> specifies the type of simulation to be performed.</p>
 <ul class="simple">
 <li><p>If set to <code class="docutils literal notranslate"><span class="pre">FreqDomain</span></code>, indicating a frequency domain simulation.</p></li>
 <li><p>If set to <code class="docutils literal notranslate"><span class="pre">TimeDomain</span></code>, indicating a time domain simulations.</p></li>
 </ul>
-<p>The <code class="docutils literal notranslate"><span class="pre">Verbosity</span></code> controls the level of detail in the output.</p>
+<p>The <code class="docutils literal notranslate"><span class="pre">onelab_verbosity</span></code> controls the level of the FEM simulation software <code class="docutils literal notranslate"><span class="pre">Onelab</span></code> details in the output.</p>
 <ul class="simple">
 <li><p>If set to <code class="docutils literal notranslate"><span class="pre">ToConsole</span></code>, all output messages are shown in the commend line .</p></li>
 <li><p>If set to <code class="docutils literal notranslate"><span class="pre">ToFile</span></code>, all output messages are written to files.</p></li>
@@ -585,16 +585,15 @@ <h2><span class="sectnum">2.2 </span>Creating a core<a class="headerlink" href="
                                                  <span class="n">window_h</span><span class="o">=</span><span class="n">core_db</span><span class="p">[</span><span class="s2">&quot;window_h&quot;</span><span class="p">],</span>
                                                  <span class="n">core_h</span><span class="o">=</span><span class="n">core_db</span><span class="p">[</span><span class="s2">&quot;core_h&quot;</span><span class="p">])</span>
 
-<span class="n">core</span> <span class="o">=</span> <span class="n">fmt</span><span class="o">.</span><span class="n">Core</span><span class="p">(</span><span class="n">core_type</span><span class="o">=</span><span class="n">fmt</span><span class="o">.</span><span class="n">CoreType</span><span class="o">.</span><span class="n">Single</span><span class="p">,</span>
+<span class="n">core_material</span> <span class="o">=</span> <span class="n">fmt</span><span class="o">.</span><span class="n">ImportedComplexCoreMaterial</span><span class="p">(</span><span class="n">material</span><span class="o">=</span><span class="n">fmt</span><span class="o">.</span><span class="n">Material</span><span class="o">.</span><span class="n">N49</span><span class="p">,</span>
+                                                <span class="n">temperature</span><span class="o">=</span><span class="mi">45</span><span class="p">,</span>
+                                                <span class="n">permeability_datasource</span><span class="o">=</span><span class="n">fmt</span><span class="o">.</span><span class="n">DataSource</span><span class="o">.</span><span class="n">TDK_MDT</span><span class="p">,</span>
+                                                <span class="n">permittivity_datasource</span><span class="o">=</span><span class="n">fmt</span><span class="o">.</span><span class="n">DataSource</span><span class="o">.</span><span class="n">LEA_MTB</span><span class="p">)</span>
+
+ <span class="n">core</span> <span class="o">=</span> <span class="n">fmt</span><span class="o">.</span><span class="n">Core</span><span class="p">(</span><span class="n">material</span><span class="o">=</span><span class="n">core_material</span><span class="p">,</span>
+                 <span class="n">core_type</span><span class="o">=</span><span class="n">fmt</span><span class="o">.</span><span class="n">CoreType</span><span class="o">.</span><span class="n">Single</span><span class="p">,</span>
                  <span class="n">core_dimensions</span><span class="o">=</span><span class="n">core_dimensions</span><span class="p">,</span>
-                 <span class="n">detailed_core_model</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
-                 <span class="n">material</span><span class="o">=</span><span class="n">mdb</span><span class="o">.</span><span class="n">Material</span><span class="o">.</span><span class="n">N49</span><span class="p">,</span> <span class="n">temperature</span><span class="o">=</span><span class="mi">45</span><span class="p">,</span> <span class="n">frequency</span><span class="o">=</span><span class="n">inductor_frequency</span><span class="p">,</span>
-                 <span class="n">permeability_datasource</span><span class="o">=</span><span class="n">fmt</span><span class="o">.</span><span class="n">MaterialDataSource</span><span class="o">.</span><span class="n">Measurement</span><span class="p">,</span>
-                 <span class="n">permeability_datatype</span><span class="o">=</span><span class="n">fmt</span><span class="o">.</span><span class="n">MeasurementDataType</span><span class="o">.</span><span class="n">ComplexPermeability</span><span class="p">,</span>
-                 <span class="n">permeability_measurement_setup</span><span class="o">=</span><span class="n">mdb</span><span class="o">.</span><span class="n">MeasurementSetup</span><span class="o">.</span><span class="n">LEA_LK</span><span class="p">,</span>
-                 <span class="n">permittivity_datasource</span><span class="o">=</span><span class="n">fmt</span><span class="o">.</span><span class="n">MaterialDataSource</span><span class="o">.</span><span class="n">Measurement</span><span class="p">,</span>
-                 <span class="n">permittivity_datatype</span><span class="o">=</span><span class="n">fmt</span><span class="o">.</span><span class="n">MeasurementDataType</span><span class="o">.</span><span class="n">ComplexPermittivity</span><span class="p">,</span>
-                 <span class="n">permittivity_measurement_setup</span><span class="o">=</span><span class="n">mdb</span><span class="o">.</span><span class="n">MeasurementSetup</span><span class="o">.</span><span class="n">LEA_LK</span><span class="p">,</span> <span class="n">mdb_verbosity</span><span class="o">=</span><span class="n">fmt</span><span class="o">.</span><span class="n">Verbosity</span><span class="o">.</span><span class="n">Silent</span><span class="p">)</span>
+                 <span class="n">detailed_core_model</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
 <span class="n">geo</span><span class="o">.</span><span class="n">set_core</span><span class="p">(</span><span class="n">core</span><span class="p">)</span>
 </pre></div>
 </div>
@@ -959,7 +958,7 @@ <h2><span class="sectnum">2.6 </span>Add conductors<a class="headerlink" href="#
 <li><p><strong>RectangularSolid</strong></p></li>
 </ul>
 <p>To create a conductor have a look at the following code example:</p>
-<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">winding1</span> <span class="o">=</span> <span class="n">fmt</span><span class="o">.</span><span class="n">Conductor</span><span class="p">(</span><span class="n">winding_number</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">conductivity</span><span class="o">=</span><span class="n">fmt</span><span class="o">.</span><span class="n">Conductivity</span><span class="o">.</span><span class="n">Copper</span><span class="p">)</span>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">winding1</span> <span class="o">=</span> <span class="n">fmt</span><span class="o">.</span><span class="n">Conductor</span><span class="p">(</span><span class="n">winding_number</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">conductivity</span><span class="o">=</span><span class="n">fmt</span><span class="o">.</span><span class="n">ConductorMaterial</span><span class="o">.</span><span class="n">Copper</span><span class="p">)</span>
 <span class="n">winding1</span><span class="o">.</span><span class="n">set_solid_round_conductor</span><span class="p">(</span><span class="n">conductor_radius</span><span class="o">=</span><span class="mf">0.0011</span><span class="p">,</span> <span class="n">conductor_arrangement</span><span class="o">=</span><span class="n">fmt</span><span class="o">.</span><span class="n">ConductorArrangement</span><span class="o">.</span><span class="n">Square</span><span class="p">)</span>
 </pre></div>
 </div>