Update documentation

docs/_modules/motulator/common/model/_converter.html

@@ -379,9 +379,9 @@ <h1>Source code for motulator.common.model._converter</h1><div class="highlight"
 <span></span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">Continuous-time models for converters.</span>
 
-<span class="sd">A three-phase voltage-source inverter with optional DC-bus dynamics is</span>
-<span class="sd">modelled, along with a six-pulse diode bridge rectifier supplied from a stiff</span>
-<span class="sd">grid. Complex space vectors are used also for duty ratios and switching states,</span>
+<span class="sd">A three-phase voltage-source inverter with optional DC-bus dynamics is modeled,</span>
+<span class="sd">along with a six-pulse diode bridge rectifier supplied from a stiff grid.</span>
+<span class="sd">Complex space vectors are used also for duty ratios and switching states,</span>
 <span class="sd">wherever applicable.</span>
 
 <span class="sd">&quot;&quot;&quot;</span>
@@ -512,7 +512,7 @@ <h1>Source code for motulator.common.model._converter</h1><div class="highlight"
         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">set_outputs</span><span class="p">(</span><span class="n">t</span><span class="p">)</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">out</span><span class="o">.</span><span class="n">i_L</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">state</span><span class="o">.</span><span class="n">i_L</span><span class="o">.</span><span class="n">real</span></div>
 
-<div class="viewcode-block" id="FrequencyConverter.set_inputs"><a class="viewcode-back" href="../../../../autoapi/motulator/drive/model/index.html#motulator.drive.model.FrequencyConverter.set_inputs">[docs]</a>    <span class="k">def</span> <span class="nf">set_inputs</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">t</span><span class="p">):</span>
+<div class="viewcode-block" id="FrequencyConverter.set_inputs"><a class="viewcode-back" href="../../../../autoapi/motulator/drive/model/index.html#motulator.drive.model.FrequencyConverter.set_inputs">[docs]</a>    <span class="k">def</span> <span class="nf">set_inputs</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">_</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Set output variables.&quot;&quot;&quot;</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">inp</span><span class="o">.</span><span class="n">i_dc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">out</span><span class="o">.</span><span class="n">i_L</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">inp</span><span class="o">.</span><span class="n">u_dc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">out</span><span class="o">.</span><span class="n">u_dc</span></div>

docs/_modules/motulator/drive/model/_drive.html

@@ -488,64 +488,6 @@ <h1>Source code for motulator.drive.model._drive</h1><div class="highlight"><pre
         <span class="bp">self</span><span class="o">.</span><span class="n">mechanics</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">tau_M</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">machine</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">tau_M</span>
         <span class="c1"># Post-processing based on the inputs and the states</span>
         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">post_process_with_inputs</span><span class="p">()</span></div></div>
-
-
-<span class="c1"># %%</span>
-<div class="viewcode-block" id="DriveWithDiodeBridge"><a class="viewcode-back" href="../../../../autoapi/motulator/drive/model/index.html#motulator.drive.model.DriveWithDiodeBridge">[docs]</a><span class="k">class</span> <span class="nc">DriveWithDiodeBridge</span><span class="p">(</span><span class="n">Model</span><span class="p">):</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">    Machine drive with a diode bridge rectifier.</span>
-
-<span class="sd">    Parameters</span>
-<span class="sd">    ----------</span>
-<span class="sd">    diode_bridge : DiodeBridge</span>
-<span class="sd">        Diode bridge model.</span>
-<span class="sd">    converter : VoltageSourceConverter</span>
-<span class="sd">        Converter model.</span>
-<span class="sd">    machine : InductionMachine | SynchronousMachine</span>
-<span class="sd">        Machine model.</span>
-<span class="sd">    mechanics : ExternalRotorSpeed | StiffMechanicalSystem |\</span>
-<span class="sd">                TwoMassMechanicalSystem</span>
-<span class="sd">        Mechanical subsystem model.</span>
-
-<span class="sd">    &quot;&quot;&quot;</span>
-
-    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
-            <span class="bp">self</span><span class="p">,</span>
-            <span class="n">diode_bridge</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
-            <span class="n">converter</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
-            <span class="n">machine</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
-            <span class="n">mechanics</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
-        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">diode_bridge</span> <span class="o">=</span> <span class="n">diode_bridge</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">converter</span> <span class="o">=</span> <span class="n">converter</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">machine</span> <span class="o">=</span> <span class="n">machine</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">mechanics</span> <span class="o">=</span> <span class="n">mechanics</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">subsystems</span> <span class="o">=</span> <span class="p">[</span>
-            <span class="bp">self</span><span class="o">.</span><span class="n">diode_bridge</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">converter</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">machine</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">mechanics</span>
-        <span class="p">]</span>
-
-<div class="viewcode-block" id="DriveWithDiodeBridge.interconnect"><a class="viewcode-back" href="../../../../autoapi/motulator/drive/model/index.html#motulator.drive.model.DriveWithDiodeBridge.interconnect">[docs]</a>    <span class="k">def</span> <span class="nf">interconnect</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">_</span><span class="p">):</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;Interconnect the subsystems.&quot;&quot;&quot;</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">diode_bridge</span><span class="o">.</span><span class="n">inp</span><span class="o">.</span><span class="n">u_dc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">converter</span><span class="o">.</span><span class="n">out</span><span class="o">.</span><span class="n">u_dc</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">converter</span><span class="o">.</span><span class="n">inp</span><span class="o">.</span><span class="n">i_ext</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">diode_bridge</span><span class="o">.</span><span class="n">out</span><span class="o">.</span><span class="n">i_L</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">converter</span><span class="o">.</span><span class="n">inp</span><span class="o">.</span><span class="n">i_cs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">machine</span><span class="o">.</span><span class="n">out</span><span class="o">.</span><span class="n">i_ss</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">machine</span><span class="o">.</span><span class="n">inp</span><span class="o">.</span><span class="n">u_ss</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">converter</span><span class="o">.</span><span class="n">out</span><span class="o">.</span><span class="n">u_cs</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">mechanics</span><span class="o">.</span><span class="n">inp</span><span class="o">.</span><span class="n">tau_M</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">machine</span><span class="o">.</span><span class="n">out</span><span class="o">.</span><span class="n">tau_M</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">machine</span><span class="o">.</span><span class="n">inp</span><span class="o">.</span><span class="n">w_M</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">mechanics</span><span class="o">.</span><span class="n">out</span><span class="o">.</span><span class="n">w_M</span></div>
-
-<div class="viewcode-block" id="DriveWithDiodeBridge.post_process"><a class="viewcode-back" href="../../../../autoapi/motulator/drive/model/index.html#motulator.drive.model.DriveWithDiodeBridge.post_process">[docs]</a>    <span class="k">def</span> <span class="nf">post_process</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;Post-process the solution.&quot;&quot;&quot;</span>
-        <span class="c1"># Post-processing based on the states</span>
-        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">post_process_states</span><span class="p">()</span>
-        <span class="c1"># Add the input data to the subsystems for post-processing</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">diode_bridge</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">u_dc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">converter</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">u_dc</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">converter</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">i_ext</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">diode_bridge</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">i_L</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">converter</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">i_cs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">machine</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">i_ss</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">machine</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">u_ss</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">converter</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">u_cs</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">machine</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">w_M</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">mechanics</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">w_M</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">mechanics</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">tau_M</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">machine</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">tau_M</span>
-        <span class="c1"># Post-processing based on the inputs and the states</span>
-        <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">post_process_with_inputs</span><span class="p">()</span></div></div>
 </pre></div>
 
                 </article>

docs/_sources/autoapi/motulator/drive/model/index.rst

@@ -34,7 +34,6 @@ Classes
 
    motulator.drive.model.CarrierComparison
    motulator.drive.model.Drive
-   motulator.drive.model.DriveWithDiodeBridge
    motulator.drive.model.DriveWithLCFilter
    motulator.drive.model.ExternalRotorSpeed
    motulator.drive.model.FrequencyConverter
@@ -199,88 +198,6 @@ Package Contents
 
 
 
-      ..
-          !! processed by numpydoc !!
-
-
-.. py:class:: DriveWithDiodeBridge(diode_bridge=None, converter=None, machine=None, mechanics=None)
-
-   Bases: :py:obj:`motulator.common.model.Model`
-
-
-
-   Machine drive with a diode bridge rectifier.
-
-   :param diode_bridge: Diode bridge model.
-   :type diode_bridge: DiodeBridge
-   :param converter: Converter model.
-   :type converter: VoltageSourceConverter
-   :param machine: Machine model.
-   :type machine: InductionMachine | SynchronousMachine
-   :param mechanics: Mechanical subsystem model.
-   :type mechanics: ExternalRotorSpeed | StiffMechanicalSystem |                TwoMassMechanicalSystem
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-   ..
-       !! processed by numpydoc !!
-
-   .. py:method:: interconnect(_)
-
-      
-      Interconnect the subsystems.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-      ..
-          !! processed by numpydoc !!
-
-
-   .. py:method:: post_process()
-
-      
-      Post-process the solution.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
       ..
           !! processed by numpydoc !!
 
@@ -630,7 +547,7 @@ Package Contents
           !! processed by numpydoc !!
 
 
-   .. py:method:: set_inputs(t)
+   .. py:method:: set_inputs(_)
 
       
       Set output variables.

docs/_sources/drive_examples/flux_vector/plot_flux_vector_im_2kw.rst

@@ -180,7 +180,7 @@ Plot results in per-unit values.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 9.833 seconds)
+   **Total running time of the script:** (0 minutes 10.133 seconds)
 
 
 .. _sphx_glr_download_drive_examples_flux_vector_plot_flux_vector_im_2kw.py:

docs/_sources/drive_examples/flux_vector/plot_flux_vector_pmsm_2kw.rst

@@ -168,7 +168,7 @@ Plot results in per-unit values.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 5.218 seconds)
+   **Total running time of the script:** (0 minutes 5.277 seconds)
 
 
 .. _sphx_glr_download_drive_examples_flux_vector_plot_flux_vector_pmsm_2kw.py:

docs/_sources/drive_examples/flux_vector/plot_flux_vector_pmsyrm_5kw.rst

@@ -357,7 +357,7 @@ Plot results in per-unit values.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 15.545 seconds)
+   **Total running time of the script:** (0 minutes 15.937 seconds)
 
 
 .. _sphx_glr_download_drive_examples_flux_vector_plot_flux_vector_pmsyrm_5kw.py:

docs/_sources/drive_examples/flux_vector/plot_flux_vector_syrm_7kw.rst

@@ -280,7 +280,7 @@ machine has no magnets.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 14.955 seconds)
+   **Total running time of the script:** (0 minutes 15.398 seconds)
 
 
 .. _sphx_glr_download_drive_examples_flux_vector_plot_flux_vector_syrm_7kw.py:

docs/_sources/drive_examples/flux_vector/sg_execution_times.rst

@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:45.551** total execution time for 4 files **from drive_examples/flux_vector**:
+**00:46.744** total execution time for 4 files **from drive_examples/flux_vector**:
 
 .. container::
 
@@ -33,14 +33,14 @@ Computation times
      - Time
      - Mem (MB)
    * - :ref:`sphx_glr_drive_examples_flux_vector_plot_flux_vector_pmsyrm_5kw.py` (``plot_flux_vector_pmsyrm_5kw.py``)
-     - 00:15.545
+     - 00:15.937
      - 0.0
    * - :ref:`sphx_glr_drive_examples_flux_vector_plot_flux_vector_syrm_7kw.py` (``plot_flux_vector_syrm_7kw.py``)
-     - 00:14.955
+     - 00:15.398
      - 0.0
    * - :ref:`sphx_glr_drive_examples_flux_vector_plot_flux_vector_im_2kw.py` (``plot_flux_vector_im_2kw.py``)
-     - 00:09.833
+     - 00:10.133
      - 0.0
    * - :ref:`sphx_glr_drive_examples_flux_vector_plot_flux_vector_pmsm_2kw.py` (``plot_flux_vector_pmsm_2kw.py``)
-     - 00:05.218
+     - 00:05.277
      - 0.0

docs/_sources/drive_examples/obs_vhz/plot_obs_vhz_ctrl_im_2kw.rst

@@ -197,7 +197,7 @@ the results in SI units.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 8.982 seconds)
+   **Total running time of the script:** (0 minutes 9.196 seconds)
 
 
 .. _sphx_glr_download_drive_examples_obs_vhz_plot_obs_vhz_ctrl_im_2kw.py:

docs/_sources/drive_examples/obs_vhz/plot_obs_vhz_ctrl_pmsm_2kw.rst

@@ -175,7 +175,7 @@ the results in SI units.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 23.917 seconds)
+   **Total running time of the script:** (0 minutes 24.646 seconds)
 
 
 .. _sphx_glr_download_drive_examples_obs_vhz_plot_obs_vhz_ctrl_pmsm_2kw.py:

docs/_sources/drive_examples/obs_vhz/plot_obs_vhz_ctrl_pmsm_2kw_two_mass.rst

@@ -265,7 +265,7 @@ rotor speed w_M.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 4.749 seconds)
+   **Total running time of the script:** (0 minutes 4.799 seconds)
 
 
 .. _sphx_glr_download_drive_examples_obs_vhz_plot_obs_vhz_ctrl_pmsm_2kw_two_mass.py:

docs/_sources/drive_examples/obs_vhz/plot_obs_vhz_ctrl_pmsyrm_thor.rst

@@ -287,7 +287,7 @@ the results in SI units.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 51.017 seconds)
+   **Total running time of the script:** (0 minutes 50.890 seconds)
 
 
 .. _sphx_glr_download_drive_examples_obs_vhz_plot_obs_vhz_ctrl_pmsyrm_thor.py:

docs/_sources/drive_examples/obs_vhz/plot_obs_vhz_ctrl_syrm_7kw.rst

@@ -266,7 +266,7 @@ the results in SI units.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 28.140 seconds)
+   **Total running time of the script:** (0 minutes 28.956 seconds)
 
 
 .. _sphx_glr_download_drive_examples_obs_vhz_plot_obs_vhz_ctrl_syrm_7kw.py:

docs/_sources/drive_examples/obs_vhz/sg_execution_times.rst

@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**01:56.805** total execution time for 5 files **from drive_examples/obs_vhz**:
+**01:58.487** total execution time for 5 files **from drive_examples/obs_vhz**:
 
 .. container::
 
@@ -33,17 +33,17 @@ Computation times
      - Time
      - Mem (MB)
    * - :ref:`sphx_glr_drive_examples_obs_vhz_plot_obs_vhz_ctrl_pmsyrm_thor.py` (``plot_obs_vhz_ctrl_pmsyrm_thor.py``)
-     - 00:51.017
+     - 00:50.890
      - 0.0
    * - :ref:`sphx_glr_drive_examples_obs_vhz_plot_obs_vhz_ctrl_syrm_7kw.py` (``plot_obs_vhz_ctrl_syrm_7kw.py``)
-     - 00:28.140
+     - 00:28.956
      - 0.0
    * - :ref:`sphx_glr_drive_examples_obs_vhz_plot_obs_vhz_ctrl_pmsm_2kw.py` (``plot_obs_vhz_ctrl_pmsm_2kw.py``)
-     - 00:23.917
+     - 00:24.646
      - 0.0
    * - :ref:`sphx_glr_drive_examples_obs_vhz_plot_obs_vhz_ctrl_im_2kw.py` (``plot_obs_vhz_ctrl_im_2kw.py``)
-     - 00:08.982
+     - 00:09.196
      - 0.0
    * - :ref:`sphx_glr_drive_examples_obs_vhz_plot_obs_vhz_ctrl_pmsm_2kw_two_mass.py` (``plot_obs_vhz_ctrl_pmsm_2kw_two_mass.py``)
-     - 00:04.749
+     - 00:04.799
      - 0.0

docs/_sources/drive_examples/signal_inj/plot_signal_inj_pmsm_2kw.rst

@@ -210,7 +210,7 @@ Plot results in per-unit values.
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 12.705 seconds)
+   **Total running time of the script:** (0 minutes 13.034 seconds)
 
 
 .. _sphx_glr_download_drive_examples_signal_inj_plot_signal_inj_pmsm_2kw.py: