preparing release

Pressio · Jun 15, 2022 · 4306389 · 4306389
1 parent c9dc6b4
commit 4306389
Show file tree

Hide file tree

Showing 58 changed files with 737 additions and 162 deletions.
diff --git a/docs/.doctrees/burgers_2d_dirichlet.doctree b/docs/.doctrees/burgers_2d_dirichlet.doctree
diff --git a/docs/.doctrees/burgers_2d_periodic.doctree b/docs/.doctrees/burgers_2d_periodic.doctree
diff --git a/docs/.doctrees/diffusion_reaction_1d.doctree b/docs/.doctrees/diffusion_reaction_1d.doctree
diff --git a/docs/.doctrees/diffusion_reaction_2d.doctree b/docs/.doctrees/diffusion_reaction_2d.doctree
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/euler_2d_normal_shock.doctree b/docs/.doctrees/euler_2d_normal_shock.doctree
diff --git a/docs/.doctrees/problems_2d.doctree b/docs/.doctrees/problems_2d.doctree
diff --git a/docs/.doctrees/swe_2d.doctree b/docs/.doctrees/swe_2d.doctree
diff --git a/docs/_sources/burgers_2d_dirichlet.rst.txt b/docs/_sources/burgers_2d_dirichlet.rst.txt
@@ -0,0 +1,117 @@
+2D Burgers (Dirichlet BCs)
+==========================
+
+This problem solves the 2D nonlinear viscous Burgers equations
+
+.. math::
+
+   \frac{\partial u}{\partial t} + u \frac{\partial u}{\partial x} + v \frac{\partial u}{\partial y}  &= D \left( \frac{\partial^2 u}{\partial x^2} + \frac{\partial^2 u}{\partial y^2} \right) 
+
+   \frac{\partial v}{\partial t} + u \frac{\partial v}{\partial x} + v \frac{\partial v}{\partial y}  &= D \left( \frac{\partial^2 v}{\partial x^2} + \frac{\partial^2 v}{\partial y^2} \right)
+
+
+* Domain is :math:`[-1,1]^2` with homogeneous Dirichlet BC
+
+* Initial conditions are: :math:`u = v = \alpha \exp( - \frac{(x-x_0)^2+(y-y_0)^2}{\delta} )`
+
+* Default settings: :math:`\alpha = 0.5`, :math:`\delta = 0.15`, :math:`x_0=0, y_0=-0.2`, :math:`D = 0.00001`
+
+Mesh
+----
+
+.. code-block:: shell
+
+   python3 pressio-demoapps/meshing_scripts/create_full_mesh_for.py \
+           --problem burgers2d_dirichlet_s<stencilSize> -n Nx Ny --outDir <destination-path>
+
+where 
+
+- ``Nx, Ny`` is the number of cells you want along :math:`x` and :math:`y` respectively
+
+- ``<stencilSize> = 3 or 5 or 7``: defines the neighboring connectivity of each cell 
+
+- ``<destination-path>`` is where you want the mesh files to be generated.
+  The script creates the directory if it does not exist.
+
+
+.. Important::
+
+  When you set the ``<stencilSize>``, keep in mind the following constraints (more on this below):
+
+  - ``InviscidFluxReconstruction::FirstOrder`` requires ``<stencilSize> >= 3``
+
+  - ``InviscidFluxReconstruction::Weno3`` requires ``<stencilSize> >= 5``
+
+  - ``InviscidFluxReconstruction::Weno5`` requires ``<stencilSize> >= 7``
+
+.. Currently, the viscous reconstruction uses a three-point stencil, so it is always supported.
+
+
+C++ synopsis
+------------
+
+.. code-block:: c++
+
+   #include "pressiodemoapps/advection_diffusion2d.hpp"
+   // ...
+   namespace pda = pressiodemoapps;
+
+   const auto meshObj = pda::load_cellcentered_uniform_mesh_eigen("path-to-mesh");
+
+   const auto inviscidScheme = pda::InviscidFluxReconstruction::FirstOrder; // or Weno3, Weno5
+   const auto viscousScheme  = pda::ViscousFluxReconstruction::FirstOrder;  // must be FirstOrder
+
+   // A. constructor for problem using default values
+   {
+     const auto probId = pda::AdvectionDiffusion2d::BurgersDirichlet;
+     auto problem = pda::create_problem_eigen(meshObj, probId, inviscidScheme, viscousScheme);
+   }
+
+   // B. setting custom coefficients
+   {
+     using scalar_type = typename decltype(meshObj)::scalar_t;
+     const auto alpha  = /* something */;
+     const auto delta  = /* something */;
+     const auto D      = /* something */;
+     const auto x0     = /* something */;
+     const auto y0     = /* something */;
+     auto problem = pda::create_dirichlet_burgers_2d_problem_eigen(meshObj, inviscidScheme, 
+                                                                   viscousScheme, alpha, 
+                                                                   delta, D, x0, y0)
+   }
+
+Python synopsis
+---------------
+
+.. code-block:: py
+
+   import pressiodemoapps as pda
+
+   meshObj = pda.load_cellcentered_uniform_mesh("path-to-mesh")
+
+   inviscidScheme = pda.InviscidFluxReconstruction.FirstOrder; # or Weno3, Weno5
+   viscousScheme  = pda.ViscousFluxReconstruction.FirstOrder;  # must be FirstOrder
+
+   # A. constructor for problem using default values
+   probId  = pda.AdvectionDiffusion2d.BurgersPeriodic
+   problem = pda.create_problem(meshObj, probId, inviscidScheme, viscousScheme)
+
+   # B. setting custom coefficients
+   alpha  = # something 
+   delta  = # something 
+   D      = # something 
+   x0     = # something 
+   y0     = # something
+   problem = pda.create_dirichlet_burgers_2d_problem(meshObj, inviscidScheme, 
+                                                     viscousScheme, alpha, 
+                                                     delta, D, x0, y0)
+
+
+
+Notes:
+------
+
+.. important::
+
+   Note that we currently support only first order *viscous* 
+   flux reconstruction, which leads to a second-order scheme.
diff --git a/docs/_sources/burgers_2d.rst.txt → docs/_sources/burgers_2d_periodic.rst.txt b/docs/_sources/burgers_2d.rst.txt → docs/_sources/burgers_2d_periodic.rst.txt
@@ -1,18 +1,18 @@
-2D Burgers
-==========
-TODO: Add Initial conditions and parameters. Fix code blocks.
+2D Burgers (Periodic BCs)
+=========================
 
-This problem solves the 2D Burgers equations. We consider a two-dimensional nonlinear viscous Burgers equations
+This problem solves the 2D nonlinear viscous Burgers equations
 
 .. math::
 
-   \frac{\partial u}{\partial t} + u \nabla u = D \nabla^2 u
+   \frac{\partial u}{\partial t} + u \frac{\partial u}{\partial x} + v \frac{\partial u}{\partial y}  &= D \left( \frac{\partial^2 u}{\partial x^2} + \frac{\partial^2 u}{\partial y^2} \right) 
 
-with:
+   \frac{\partial v}{\partial t} + u \frac{\partial v}{\partial x} + v \frac{\partial v}{\partial y}  &= D \left( \frac{\partial^2 v}{\partial x^2} + \frac{\partial^2 v}{\partial y^2} \right)
 
-* Domain is :math:`[0,1]^2` with periodic BC
 
-* initial condition is: :math:`u = \alpha \exp( - \frac{(x-x_0)^2+(y-y_0)^2}{\delta} )`
+* Domain is :math:`[-1,1]^2` with periodic BC
+
+* Initial conditions are: :math:`u = v = \alpha \exp( - \frac{(x-x_0)^2+(y-y_0)^2}{\delta} )`
 
 * Default settings: :math:`\alpha = 0.5`, :math:`\delta = 0.15`, :math:`x_0=0, y_0=-0.2`, :math:`D = 0.00001`
 
@@ -22,7 +22,7 @@ Mesh
 .. code-block:: shell
 
    python3 pressio-demoapps/meshing_scripts/create_full_mesh_for.py \
-           --problem burgers2d_s<stencilSize> -n Nx Ny --outDir <destination-path>
+           --problem burgers2d_periodic_s<stencilSize> -n Nx Ny --outDir <destination-path>
 
 where 
 
@@ -63,7 +63,7 @@ C++ synopsis
 
    // A. constructor for problem using default values
    {
-     const auto probId = pda::AdvectionDiffusion2d::Burgers;
+     const auto probId = pda::AdvectionDiffusion2d::BurgersPeriodic;
      auto problem = pda::create_problem_eigen(meshObj, probId, inviscidScheme, viscousScheme);
    }
 
@@ -75,8 +75,9 @@ C++ synopsis
      const auto D      = /* something */;
      const auto x0     = /* something */;
      const auto y0     = /* something */;
-     auto problem = pda::create_burgers_2d_problem_eigen(meshObj, inviscidScheme, viscousScheme,
-                                                         alpha, delta, D, x0, y0)
+     auto problem = pda::create_periodic_burgers_2d_problem_eigen(meshObj, inviscidScheme, 
+                                                                  viscousScheme, alpha, 
+                                                                  delta, D, x0, y0)
    }
 
 Python synopsis
@@ -92,17 +93,18 @@ Python synopsis
    viscousScheme  = pda.ViscousFluxReconstruction.FirstOrder;  # must be FirstOrder
 
    # A. constructor for problem using default values
-   probId  = pda.AdvectionDiffusion2d::Burgers
-   problem = pda.create_problem(meshObj, probId, scheme)
+   probId  = pda.AdvectionDiffusion2d.BurgersPeriodic
+   problem = pda.create_problem(meshObj, probId, inviscidScheme, viscousScheme)
 
    # B. setting custom coefficients
-   alpha  = /* something */
-   delta  = /* something */
-   D      = /* something */
-   x0     = /* something */
-   y0     = /* something */
-   problem = pda.create_burgers_2d_problem(meshObj, inviscidScheme, viscousScheme,
-                                           alpha, delta, D, x0, y0)
+   alpha  = # something 
+   delta  = # something 
+   D      = # something 
+   x0     = # something 
+   y0     = # something
+   problem = pda.create_periodic_burgers_2d_problem(meshObj, inviscidScheme, 
+                                                    viscousScheme, alpha, 
+                                                    delta, D, x0, y0)
 
 
 

diff --git a/docs/_sources/diffusion_reaction_1d.rst.txt b/docs/_sources/diffusion_reaction_1d.rst.txt
@@ -22,7 +22,7 @@ This problem focuses on the following 1D diffusion reaction PDE:
 
   - :math:`u(x, t) = 4 x^2\sin(\pi x) \cos(4 \pi x)`
 
-* Domain is :math:`[0,1]` with homogenous Dirichlet BC
+* Domain is :math:`[0,1]` with homogeneous Dirichlet BC
 
 
 Mesh

diff --git a/docs/_sources/diffusion_reaction_2d.rst.txt b/docs/_sources/diffusion_reaction_2d.rst.txt
@@ -21,7 +21,7 @@ This problem focuses on the following 2D reaction diffusion PDE:
 
   - :math:`u(x, y, t) = 4 \sin(4 \pi x y) \sin(\pi x (y-2/10))`
 
-* Domain is unit square :math:`[0,1]^2` with homogenous Dirichlet BC
+* Domain is unit square :math:`[0,1]^2` with homogeneous Dirichlet BC
 
 
 Mesh

diff --git a/docs/_sources/euler_2d_normal_shock.rst.txt b/docs/_sources/euler_2d_normal_shock.rst.txt
@@ -20,7 +20,7 @@ where the pressure :math:`p` is related to the conserved quantities through the
 
 - Domain is :math:`[0, 2]\times[0, 1]` 
 
-- BC are homogenous Neumann at left (:math:`x=0`) and right (:math:`x=2`) boundaries, 
+- BC are homogeneous Neumann at left (:math:`x=0`) and right (:math:`x=2`) boundaries, 
    and reflective at top (:math:`y=1`) and bottom (:math:`y=0`) boundaries
 
 

diff --git a/docs/_sources/problems_2d.rst.txt b/docs/_sources/problems_2d.rst.txt
@@ -5,7 +5,8 @@
     :maxdepth: 2
 
     diffusion_reaction_2d
-    burgers_2d
+    burgers_2d_dirichlet
+    burgers_2d_periodic
     grayscott_2d
     swe_2d
     euler_2d_smooth

diff --git a/docs/_sources/swe_2d.rst.txt b/docs/_sources/swe_2d.rst.txt
@@ -104,16 +104,16 @@ Python synopsis
 
    meshObj = pda.load_cellcentered_uniform_mesh_eigen("path-to-mesh")
 
-   probId  = pda.Swe2d::SlipWall;
+   probId  = pda.Swe2d.SlipWall;
    scheme  = pda.InviscidFluxReconstruction.FirstOrder # or Weno3, Weno5
 
    # A. constructor for problem using default values
    problem = pda.create_problem(meshObj, probId, scheme)
 
    # B. constructor for problem specifying all coefficients
-   gravity  = ...
-   coriolis = ...
-   alpha    = ...
+   gravity  = # some value
+   coriolis = # some value
+   alpha    = # some value
    problem = pda.create_slip_wall_swe_2d_problem(meshObj, scheme, gravity, coriolis, alpha)
 
 

diff --git a/docs/advection_1d.html b/docs/advection_1d.html
@@ -175,7 +175,8 @@
 </li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="problems_2d.html">2d Problems</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="diffusion_reaction_2d.html">2D single-species reaction diffusion</a></li>
-<li class="toctree-l2"><a class="reference internal" href="burgers_2d.html">2D Burgers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="burgers_2d_dirichlet.html">2D Burgers Dirichlet</a></li>
+<li class="toctree-l2"><a class="reference internal" href="burgers_2d_periodic.html">2D Burgers Periodic</a></li>
 <li class="toctree-l2"><a class="reference internal" href="grayscott_2d.html">2D Gray Scott reaction-diffusion</a></li>
 <li class="toctree-l2"><a class="reference internal" href="swe_2d.html">2D Shallow water equations</a></li>
 <li class="toctree-l2"><a class="reference internal" href="euler_2d_smooth.html">2D Euler Smooth</a></li>
@@ -334,7 +335,7 @@ <h2>Sample Solution<a class="headerlink" href="#sample-solution" title="Permalin
 
         <div class="related-information">
               Copyright &#169; 2021, National Technology &amp; Engineering Solutions of Sandia, LLC (NTESS) |
-            Last updated on Mar 30, 2022. |
+            Last updated on Jun 15, 2022. |
           Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
           <a href="https://github.com/pradyunsg/furo">Furo theme</a>.
             | <a class="muted-link" href="_sources/advection_1d.rst.txt"

diff --git a/docs/apicpp.html b/docs/apicpp.html
@@ -175,7 +175,8 @@
 </li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="problems_2d.html">2d Problems</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="diffusion_reaction_2d.html">2D single-species reaction diffusion</a></li>
-<li class="toctree-l2"><a class="reference internal" href="burgers_2d.html">2D Burgers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="burgers_2d_dirichlet.html">2D Burgers Dirichlet</a></li>
+<li class="toctree-l2"><a class="reference internal" href="burgers_2d_periodic.html">2D Burgers Periodic</a></li>
 <li class="toctree-l2"><a class="reference internal" href="grayscott_2d.html">2D Gray Scott reaction-diffusion</a></li>
 <li class="toctree-l2"><a class="reference internal" href="swe_2d.html">2D Shallow water equations</a></li>
 <li class="toctree-l2"><a class="reference internal" href="euler_2d_smooth.html">2D Euler Smooth</a></li>
@@ -441,7 +442,7 @@ <h1>C++ API<a class="headerlink" href="#c-api" title="Permalink to this headline
 
         <div class="related-information">
               Copyright &#169; 2021, National Technology &amp; Engineering Solutions of Sandia, LLC (NTESS) |
-            Last updated on Mar 30, 2022. |
+            Last updated on Jun 15, 2022. |
           Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
           <a href="https://github.com/pradyunsg/furo">Furo theme</a>.
             | <a class="muted-link" href="_sources/apicpp.rst.txt"

diff --git a/docs/apipy.html b/docs/apipy.html
@@ -175,7 +175,8 @@
 </li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="problems_2d.html">2d Problems</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="diffusion_reaction_2d.html">2D single-species reaction diffusion</a></li>
-<li class="toctree-l2"><a class="reference internal" href="burgers_2d.html">2D Burgers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="burgers_2d_dirichlet.html">2D Burgers Dirichlet</a></li>
+<li class="toctree-l2"><a class="reference internal" href="burgers_2d_periodic.html">2D Burgers Periodic</a></li>
 <li class="toctree-l2"><a class="reference internal" href="grayscott_2d.html">2D Gray Scott reaction-diffusion</a></li>
 <li class="toctree-l2"><a class="reference internal" href="swe_2d.html">2D Shallow water equations</a></li>
 <li class="toctree-l2"><a class="reference internal" href="euler_2d_smooth.html">2D Euler Smooth</a></li>
@@ -479,7 +480,7 @@ <h1>Python API<a class="headerlink" href="#python-api" title="Permalink to this
 
         <div class="related-information">
               Copyright &#169; 2021, National Technology &amp; Engineering Solutions of Sandia, LLC (NTESS) |
-            Last updated on Mar 30, 2022. |
+            Last updated on Jun 15, 2022. |
           Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
           <a href="https://github.com/pradyunsg/furo">Furo theme</a>.
             | <a class="muted-link" href="_sources/apipy.rst.txt"