Minor fixes to docs formatting, added sdc to compressible solver comparisons

Author: harpolea

docs/source/compressible_basics.rst

@@ -24,8 +24,8 @@ pyro has several compressible solvers:
 * :py:mod:`compressible_fv4` uses a 4th order accurate method with RK4
   time integration
 
-* :py:mod:`compressible_sdc` uses fourth-order compressible solver,
-  with spectral-deferred correction (SDC) for the time integration.
+* :py:mod:`compressible_sdc` uses a 4th order accurate method
+  with spectral-deferred correction (SDC) for the time integration
 
 The implementations here have flattening at shocks, artificial
 viscosity, a simple gamma-law equation of state, and (in some cases) a

docs/source/compressible_compare.rst

@@ -15,10 +15,11 @@ The image below shows the KH problem initialized with McNally's test. It ran on
   ./pyro.py compressible kh inputs.kh kh.vbulk=0
   ./pyro.py compressible_rk kh inputs.kh kh.vbulk=0
   ./pyro.py compressible_fv4 kh inputs.kh kh.vbulk=0
+  ./pyro.py compressible_sdc kh inputs.kh kh.vbulk=0
 
 .. image:: ./solver_comparisons/kh.png
    :align: center
-	     
+
 
 We vary the velocity in the positive y-direction (vbulk) to see how effective the solvers are at preserving the initial shape.
 
@@ -28,20 +29,24 @@ Sedov
 The Sedov problem ran on a 128 x 128 grid, with gamma = 1.4, and until t = 0.1, which can be run as:
 
 .. code-block:: none
-  
+
    ./pyro.py compressible sedov inputs.sedov
    ./pyro.py compressible_rk sedov inputs.sedov
    ./pyro.py compressible_fv4 sedov inputs.sedov
+   ./pyro.py compressible_sdc sedov inputs.sedov
 
 .. image:: ./solver_comparisons/sedov.png
    :align: center
-	
+
 .. image:: ./solver_comparisons/sedov_rk.png
    :align: center
-	   
+
 .. image:: ./solver_comparisons/sedov_fv4.png
    :align: center
-	   
+
+.. image:: ./solver_comparisons/sedov_sdc.png
+   :align: center
+
 Quad
 ^^^^
 The quad problem ran on a 256 x 256 grid until t = 0.8, which can be run as:
@@ -51,17 +56,21 @@ The quad problem ran on a 256 x 256 grid until t = 0.8, which can be run as:
    ./pyro.py compressible quad inputs.quad
    ./pyro.py compressible_rk quad inputs.quad
    ./pyro.py compressible_fv4 quad inputs.quad
+   ./pyro.py compressible_sdc quad inputs.quad
 
 .. image:: ./solver_comparisons/quad.png
    :align: center
-	
+
 .. image:: ./solver_comparisons/quad_rk.png
    :align: center
 
 .. image:: ./solver_comparisons/quad_fv4.png
    :align: center
-	      
-   
+
+.. image:: ./solver_comparisons/quad_sdc.png
+   :align: center
+
+
 Bubble
 ^^^^^^
 The bubble problem ran on a 128 x 256 grid until t = 3.0, which can be run as:
@@ -71,6 +80,7 @@ The bubble problem ran on a 128 x 256 grid until t = 3.0, which can be run as:
    ./pyro.py compressible bubble inputs.bubble
    ./pyro.py compressible_rk bubble inputs.bubble
    ./pyro.py compressible_fv4 bubble inputs.bubble
+   ./pyro.py compressible_sdc bubble inputs.bubble
 
 .. image:: ./solver_comparisons/bubble.png
    :align: center
@@ -81,6 +91,9 @@ The bubble problem ran on a 128 x 256 grid until t = 3.0, which can be run as:
 .. image:: ./solver_comparisons/bubble_fv4.png
    :align: center
 
+.. image:: ./solver_comparisons/bubble_sdc.png
+   :align: center
+
 
 Rayleigh-Taylor
 ^^^^^^^^^^^^^^^
@@ -91,12 +104,16 @@ The Rayleigh-Taylor problem ran on a 64 x 192 grid until t = 3.0, which can be r
    ./pyro.py compressible rt inputs.rt
    ./pyro.py compressible_rk rt inputs.rt
    ./pyro.py compressible_fv4 rt inputs.rt
+   ./pyro.py compressible_sdc rt inputs.rt
 
 .. image:: ./solver_comparisons/rt.png
    :align: center
 
 .. image:: ./solver_comparisons/rt_rk.png
    :align: center
-		      
+
 .. image:: ./solver_comparisons/rt_fv4.png
    :align: center
+
+.. image:: ./solver_comparisons/rt_sdc.png
+   :align: center

docs/source/design.rst

@@ -43,13 +43,13 @@ The overall structure is:
 * ``advection_fv4/``: The fourth-order accurate finite-volume advection
   solver that uses RK4 time integration.
 
-    * ``problems/``: The problem setups for the fourth-order advection solver.
-    * ``tests/``: Reference advection output files for comparison and regression testing.
+  * ``problems/``: The problem setups for the fourth-order advection solver.
+  * ``tests/``: Reference advection output files for comparison and regression testing.
 
 * ``advection_nonuniform/``: The solver for advection with a non-uniform velocity field.
 
-    * ``problems/``: The problem setups for the non-uniform advection solver.
-    * ``tests/``: Reference advection output files for comparison and regression testing.
+  * ``problems/``: The problem setups for the non-uniform advection solver.
+  * ``tests/``: Reference advection output files for comparison and regression testing.
 
 * ``advection_rk/``: The linear advection equation solver using the
   method-of-lines approach.
@@ -65,8 +65,8 @@ The overall structure is:
 * ``analysis/``: Various analysis scripts for processing pyro output files.
 
 * ``compressible/``: The fourth-order accurate finite-volume compressible
-   hydro solver that uses RK4 time integration.  This is built from the
-   method of McCourquodale and Colella (2011).
+  hydro solver that uses RK4 time integration.  This is built from the
+  method of McCourquodale and Colella (2011).
 
   * ``problems/``: The problem setups for the fourth-order compressible hydrodynamics solver.
   * ``tests/``: Reference compressible hydro output for regression testing.
@@ -83,7 +83,7 @@ The overall structure is:
   * ``tests/``: Reference compressible hydro output for regression testing.
 
 * ``compressible_sdc/``: The fourth-order compressible solver,
-using spectral-deferred correction (SDC) for the time integration.
+  using spectral-deferred correction (SDC) for the time integration.
 
   * ``problems/``: This is a symbolic link to the compressible/problems/ directory.
   * ``tests/``: Reference compressible hydro output for regression testing.

docs/source/running.rst

@@ -50,7 +50,7 @@ Pyro class
 ----------
 
 Alternatively, pyro can be run using the :func:`Pyro <pyro.Pyro>` class. This provides
-an interface that enables simulations to be set up and run in a Jupyter notebook - see
+an interface that enables simulations to be set up and run in a Jupyter notebook -- see
 ``examples/examples.ipynb`` for an example notebook. A simulation can be set up and run
 by carrying out the following steps:
 
@@ -72,8 +72,8 @@ Instead of using an inputs file to define the problem parameters, we can define
 dictionary of parameters and pass them into the :func:`initialize_problem
 <pyro.Pyro.initialize_problem>` function using the keyword argument ``inputs_dict``.
 If an inputs file is also passed into the function, the parameters in the dictionary
- will override any parameters in the file. For example, if we wished to turn off
- visualization for the previous example, we would do:
+will override any parameters in the file. For example, if we wished to turn off
+visualization for the previous example, we would do:
 
 .. code-block:: python