Deploying to gh-pages from @ cf89515 🚀

Parallel-in-Time · Sep 22, 2023 · c0baa43 · c0baa43
1 parent 9aa82b8
commit c0baa43
Show file tree

Hide file tree

Showing 360 changed files with 1,464 additions and 895 deletions.
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/projects/Hamiltonian.doctree b/.doctrees/projects/Hamiltonian.doctree
diff --git a/.doctrees/projects/doc_fput.doctree b/.doctrees/projects/doc_fput.doctree
diff --git a/.doctrees/projects/doc_matrixPFASST_matrix.doctree b/.doctrees/projects/doc_matrixPFASST_matrix.doctree
diff --git a/.doctrees/projects/doc_matrixPFASST_propagator.doctree b/.doctrees/projects/doc_matrixPFASST_propagator.doctree
diff --git a/.doctrees/projects/matrixPFASST.doctree b/.doctrees/projects/matrixPFASST.doctree
diff --git a/.doctrees/pySDC/implementations.convergence_controller_classes.doctree b/.doctrees/pySDC/implementations.convergence_controller_classes.doctree
diff --git a/.doctrees/pySDC/implementations.convergence_controller_classes.stop_at_nan.doctree b/.doctrees/pySDC/implementations.convergence_controller_classes.stop_at_nan.doctree
diff --git a/.doctrees/tutorial/doc_step_1_A.doctree b/.doctrees/tutorial/doc_step_1_A.doctree
diff --git a/.doctrees/tutorial/doc_step_1_B.doctree b/.doctrees/tutorial/doc_step_1_B.doctree
diff --git a/.doctrees/tutorial/doc_step_1_D.doctree b/.doctrees/tutorial/doc_step_1_D.doctree
diff --git a/.doctrees/tutorial/doc_step_2_A.doctree b/.doctrees/tutorial/doc_step_2_A.doctree
diff --git a/.doctrees/tutorial/doc_step_2_B.doctree b/.doctrees/tutorial/doc_step_2_B.doctree
diff --git a/.doctrees/tutorial/doc_step_2_C.doctree b/.doctrees/tutorial/doc_step_2_C.doctree
diff --git a/.doctrees/tutorial/doc_step_3_A.doctree b/.doctrees/tutorial/doc_step_3_A.doctree
diff --git a/.doctrees/tutorial/doc_step_3_B.doctree b/.doctrees/tutorial/doc_step_3_B.doctree
diff --git a/.doctrees/tutorial/doc_step_3_C.doctree b/.doctrees/tutorial/doc_step_3_C.doctree
diff --git a/.doctrees/tutorial/doc_step_4_C.doctree b/.doctrees/tutorial/doc_step_4_C.doctree
diff --git a/.doctrees/tutorial/doc_step_4_D.doctree b/.doctrees/tutorial/doc_step_4_D.doctree
diff --git a/.doctrees/tutorial/doc_step_7_A.doctree b/.doctrees/tutorial/doc_step_7_A.doctree
diff --git a/.doctrees/tutorial/doc_step_7_B.doctree b/.doctrees/tutorial/doc_step_7_B.doctree
diff --git a/.doctrees/tutorial/doc_step_7_C.doctree b/.doctrees/tutorial/doc_step_7_C.doctree
diff --git a/.doctrees/tutorial/doc_step_8_B.doctree b/.doctrees/tutorial/doc_step_8_B.doctree
diff --git a/.doctrees/tutorial/doc_step_8_C.doctree b/.doctrees/tutorial/doc_step_8_C.doctree
diff --git a/.doctrees/tutorial/step_1.doctree b/.doctrees/tutorial/step_1.doctree
diff --git a/.doctrees/tutorial/step_2.doctree b/.doctrees/tutorial/step_2.doctree
diff --git a/.doctrees/tutorial/step_3.doctree b/.doctrees/tutorial/step_3.doctree
diff --git a/.doctrees/tutorial/step_4.doctree b/.doctrees/tutorial/step_4.doctree
diff --git a/.doctrees/tutorial/step_7.doctree b/.doctrees/tutorial/step_7.doctree
diff --git a/.doctrees/tutorial/step_8.doctree b/.doctrees/tutorial/step_8.doctree
diff --git a/_images/convergence.png b/_images/convergence.png
diff --git a/_images/fput_hamiltonian.png b/_images/fput_hamiltonian.png
diff --git a/_images/full_solar_system_hamiltonian.png b/_images/full_solar_system_hamiltonian.png
diff --git a/_images/harmonic_hamiltonian.png b/_images/harmonic_hamiltonian.png
diff --git a/_images/henonheiles_hamiltonian.png b/_images/henonheiles_hamiltonian.png
diff --git a/_images/iteration.png b/_images/iteration.png
diff --git a/_images/outer_solar_system_hamiltonian.png b/_images/outer_solar_system_hamiltonian.png
diff --git a/_images/parallelSDC_preconditioner_vanderpol.png b/_images/parallelSDC_preconditioner_vanderpol.png
diff --git a/_images/piline_hotrod_1procs.png b/_images/piline_hotrod_1procs.png
diff --git a/_images/piline_hotrod_4procs.png b/_images/piline_hotrod_4procs.png
diff --git a/_images/piline_hotrod_adaptive_1procs.png b/_images/piline_hotrod_adaptive_1procs.png
diff --git a/_images/piline_hotrod_adaptive_4procs.png b/_images/piline_hotrod_adaptive_4procs.png
diff --git a/_images/piline_solution_adaptive.png b/_images/piline_solution_adaptive.png
diff --git a/_images/step_1_accuracy_test_coll.png b/_images/step_1_accuracy_test_coll.png
diff --git a/_images/step_1_accuracy_test_space.png b/_images/step_1_accuracy_test_space.png
diff --git a/_images/step_8_residuals.png b/_images/step_8_residuals.png
diff --git a/_images/timings_SDC_variants_Fisher.png b/_images/timings_SDC_variants_Fisher.png
diff --git a/_images/timings_SDC_variants_GrayScott.png b/_images/timings_SDC_variants_GrayScott.png
diff --git a/_modules/implementations/convergence_controller_classes/stop_at_nan.html b/_modules/implementations/convergence_controller_classes/stop_at_nan.html
@@ -0,0 +1,169 @@
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="../../../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>implementations.convergence_controller_classes.stop_at_nan &#8212; pySDC 5.3.0 documentation</title>
+    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=fa44fd50" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/classic.css?v=514cf933" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/custom.css?v=c40552b6" />
+
+    <script src="../../../_static/documentation_options.js?v=5c0b1849"></script>
+    <script src="../../../_static/doctools.js?v=888ff710"></script>
+    <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
+
+    <link rel="index" title="Index" href="../../../genindex.html" />
+    <link rel="search" title="Search" href="../../../search.html" /> 
+  </head><body>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../../../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">pySDC 5.3.0 documentation</a> &#187;</li>
+          <li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">implementations.convergence_controller_classes.stop_at_nan</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+
+  <h1>Source code for implementations.convergence_controller_classes.stop_at_nan</h1><div class="highlight"><pre>
+<span></span><span class="kn">from</span> <span class="nn">pySDC.core.ConvergenceController</span> <span class="kn">import</span> <span class="n">ConvergenceController</span>
+<span class="kn">from</span> <span class="nn">pySDC.core.Errors</span> <span class="kn">import</span> <span class="n">ConvergenceError</span>
+<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
+
+
+<div class="viewcode-block" id="StopAtNan">
+<a class="viewcode-back" href="../../../pySDC/implementations.convergence_controller_classes.stop_at_nan.html#implementations.convergence_controller_classes.stop_at_nan.StopAtNan">[docs]</a>
+<span class="k">class</span> <span class="nc">StopAtNan</span><span class="p">(</span><span class="n">ConvergenceController</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Crash the code when the norm of the solution exceeds some limit or contains nan.</span>
+<span class="sd">    This class is useful when running with MPI in the sweeper or controller.</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">controller</span><span class="p">,</span> <span class="n">params</span><span class="p">,</span> <span class="n">description</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</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="n">controller</span><span class="p">,</span> <span class="n">params</span><span class="p">,</span> <span class="n">description</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">comm</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">useMPI</span><span class="p">:</span>
+            <span class="kn">from</span> <span class="nn">mpi4py</span> <span class="kn">import</span> <span class="n">MPI</span>
+
+            <span class="bp">self</span><span class="o">.</span><span class="n">MPI_OR</span> <span class="o">=</span> <span class="n">MPI</span><span class="o">.</span><span class="n">LOR</span>
+
+<div class="viewcode-block" id="StopAtNan.setup">
+<a class="viewcode-back" href="../../../pySDC/implementations.convergence_controller_classes.stop_at_nan.html#implementations.convergence_controller_classes.stop_at_nan.StopAtNan.setup">[docs]</a>
+    <span class="k">def</span> <span class="nf">setup</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">controller</span><span class="p">,</span> <span class="n">params</span><span class="p">,</span> <span class="n">description</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Define parameters here.</span>
+
+<span class="sd">        Default parameters are:</span>
+<span class="sd">         - tresh (float): Crash the code when the norm of the solution exceeds this threshold</span>
+
+<span class="sd">        Args:</span>
+<span class="sd">            controller (pySDC.Controller): The controller</span>
+<span class="sd">            params (dict): The params passed for this specific convergence controller</span>
+<span class="sd">            description (dict): The description object used to instantiate the controller</span>
+
+<span class="sd">        Returns:</span>
+<span class="sd">            (dict): The updated params dictionary</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">comm</span> <span class="o">=</span> <span class="n">description</span><span class="p">[</span><span class="s1">&#39;sweeper_params&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;comm&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
+        <span class="n">defaults</span> <span class="o">=</span> <span class="p">{</span>
+            <span class="s2">&quot;control_order&quot;</span><span class="p">:</span> <span class="mi">95</span><span class="p">,</span>
+            <span class="s2">&quot;thresh&quot;</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">inf</span><span class="p">,</span>
+        <span class="p">}</span>
+
+        <span class="k">return</span> <span class="p">{</span><span class="o">**</span><span class="n">defaults</span><span class="p">,</span> <span class="o">**</span><span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">setup</span><span class="p">(</span><span class="n">controller</span><span class="p">,</span> <span class="n">params</span><span class="p">,</span> <span class="n">description</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)}</span></div>
+
+
+<div class="viewcode-block" id="StopAtNan.post_iteration_processing">
+<a class="viewcode-back" href="../../../pySDC/implementations.convergence_controller_classes.stop_at_nan.html#implementations.convergence_controller_classes.stop_at_nan.StopAtNan.post_iteration_processing">[docs]</a>
+    <span class="k">def</span> <span class="nf">post_iteration_processing</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">controller</span><span class="p">,</span> <span class="n">S</span><span class="p">,</span> <span class="n">comm</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Check if we need to crash the code.</span>
+
+<span class="sd">        Args:</span>
+<span class="sd">            controller (pySDC.Controller.controller): Controller</span>
+<span class="sd">            S (pySDC.Step.step): Step</span>
+<span class="sd">            comm (mpi4py.MPI.Intracomm or None): Communicator of the controller, if applicable</span>
+
+<span class="sd">        Raises:</span>
+<span class="sd">            ConvergenceError: If the solution does not fall within the allowed space</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="n">isfinite</span><span class="p">,</span> <span class="n">below_limit</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="kc">True</span>
+        <span class="n">crash</span> <span class="o">=</span> <span class="kc">False</span>
+
+        <span class="k">for</span> <span class="n">lvl</span> <span class="ow">in</span> <span class="n">S</span><span class="o">.</span><span class="n">levels</span><span class="p">:</span>
+            <span class="k">for</span> <span class="n">u</span> <span class="ow">in</span> <span class="n">lvl</span><span class="o">.</span><span class="n">u</span><span class="p">:</span>
+                <span class="k">if</span> <span class="n">u</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+                    <span class="k">break</span>
+                <span class="n">isfinite</span> <span class="o">=</span> <span class="nb">all</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">isfinite</span><span class="p">(</span><span class="n">u</span><span class="p">))</span>
+                <span class="n">below_limit</span> <span class="o">=</span> <span class="nb">abs</span><span class="p">(</span><span class="n">u</span><span class="p">)</span> <span class="o">&lt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="o">.</span><span class="n">thresh</span>
+
+                <span class="n">crash</span> <span class="o">=</span> <span class="ow">not</span> <span class="p">(</span><span class="n">isfinite</span> <span class="ow">and</span> <span class="n">below_limit</span><span class="p">)</span>
+
+                <span class="k">if</span> <span class="n">crash</span><span class="p">:</span>
+                    <span class="k">break</span>
+            <span class="k">if</span> <span class="n">crash</span><span class="p">:</span>
+                <span class="k">break</span>
+
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">comm</span><span class="p">:</span>
+            <span class="n">crash</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">comm</span><span class="o">.</span><span class="n">allreduce</span><span class="p">(</span><span class="n">crash</span><span class="p">,</span> <span class="n">op</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">MPI_OR</span><span class="p">)</span>
+        <span class="k">elif</span> <span class="n">comm</span><span class="p">:</span>
+            <span class="n">crash</span> <span class="o">=</span> <span class="n">comm</span><span class="o">.</span><span class="n">allreduce</span><span class="p">(</span><span class="n">crash</span><span class="p">,</span> <span class="n">op</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">MPI_OR</span><span class="p">)</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="n">crash</span> <span class="o">=</span> <span class="ow">not</span> <span class="n">isfinite</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">below_limit</span>
+
+        <span class="k">if</span> <span class="n">crash</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="n">ConvergenceError</span><span class="p">(</span><span class="sa">f</span><span class="s1">&#39;Solution exceeds bounds! Crashing code at </span><span class="si">{</span><span class="n">S</span><span class="o">.</span><span class="n">time</span><span class="si">}</span><span class="s1">!&#39;</span><span class="p">)</span></div>
+</div>
+
+</pre></div>
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../../../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../../../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">pySDC 5.3.0 documentation</a> &#187;</li>
+          <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">implementations.convergence_controller_classes.stop_at_nan</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    &#169; Copyright 2023, Robert Speck.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
+    </div>
+  </body>
+</html>
diff --git a/_modules/index.html b/_modules/index.html
@@ -72,6 +72,7 @@ <h1>All modules for which code is available</h1>
 <li><a href="implementations/convergence_controller_classes/interpolate_between_restarts.html">implementations.convergence_controller_classes.interpolate_between_restarts</a></li>
 <li><a href="implementations/convergence_controller_classes/spread_step_sizes.html">implementations.convergence_controller_classes.spread_step_sizes</a></li>
 <li><a href="implementations/convergence_controller_classes/step_size_limiter.html">implementations.convergence_controller_classes.step_size_limiter</a></li>
+<li><a href="implementations/convergence_controller_classes/stop_at_nan.html">implementations.convergence_controller_classes.stop_at_nan</a></li>
 <li><a href="implementations/convergence_controller_classes/store_uold.html">implementations.convergence_controller_classes.store_uold</a></li>
 <li><a href="implementations/datatype_classes/cupy_mesh.html">implementations.datatype_classes.cupy_mesh</a></li>
 <li><a href="implementations/datatype_classes/fenics_mesh.html">implementations.datatype_classes.fenics_mesh</a></li>

diff --git a/_sources/pySDC/implementations.convergence_controller_classes.rst.txt b/_sources/pySDC/implementations.convergence_controller_classes.rst.txt
@@ -21,6 +21,7 @@ Submodules
    implementations.convergence_controller_classes.interpolate_between_restarts
    implementations.convergence_controller_classes.spread_step_sizes
    implementations.convergence_controller_classes.step_size_limiter
+   implementations.convergence_controller_classes.stop_at_nan
    implementations.convergence_controller_classes.store_uold
 
 Module contents

diff --git a/_sources/pySDC/implementations.convergence_controller_classes.stop_at_nan.rst.txt b/_sources/pySDC/implementations.convergence_controller_classes.stop_at_nan.rst.txt
@@ -0,0 +1,7 @@
+implementations.convergence\_controller\_classes.stop\_at\_nan module
+=====================================================================
+
+.. automodule:: implementations.convergence_controller_classes.stop_at_nan
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/coverage/coverage-badge.svg b/coverage/coverage-badge.svg
diff --git a/coverage/d_020efe120a771d8a_fput_py.html b/coverage/d_020efe120a771d8a_fput_py.html
@@ -65,7 +65,7 @@ <h2>
             <a id="nextFileLink" class="nav" href="d_020efe120a771d8a_hamiltonian_and_energy_output_py.html">&#xbb; next</a>
             &nbsp; &nbsp; &nbsp;
             <a class="nav" href="https://coverage.readthedocs.io/en/7.3.1">coverage.py v7.3.1</a>,
-            created at 2023-09-22 06:42 +0000
+            created at 2023-09-22 15:54 +0000
         </p>
         <aside class="hidden">
             <button type="button" class="button_next_chunk" data-shortcut="j"/>
@@ -328,7 +328,7 @@ <h2>
             <a id="nextFileLink" class="nav" href="d_020efe120a771d8a_hamiltonian_and_energy_output_py.html">&#xbb; next</a>
             &nbsp; &nbsp; &nbsp;
             <a class="nav" href="https://coverage.readthedocs.io/en/7.3.1">coverage.py v7.3.1</a>,
-            created at 2023-09-22 06:42 +0000
+            created at 2023-09-22 15:54 +0000
         </p>
     </div>
 </footer>