Updated README and docs to include new solvers

Author: harpolea

README.md

@@ -116,6 +116,8 @@ pyro provides the following solvers (all in 2-d):
   - `advection_fv4`: a fourth-order accurate finite-volume advection
     solver that uses RK4 time integration.
 
+  - `advection_nonuniform`: a solver for advection with a non-uniform velocity field.
+
   - `advection_rk`: a second-order unsplit solver for linear advection
     that uses Runge-Kutta integration instead of characteristic
     tracing.
@@ -136,13 +138,16 @@ pyro provides the following solvers (all in 2-d):
      equations that uses Runge-Kutta integration instead of
 	 characteristic tracing.
 
-  - `incompressible`: a second-order cell-centered approximate
-    projection method for the incompressible equations of
-    hydrodynamics.
+  - `compressible_sdc`: a fourth-order compressible solver,
+  using spectral-deferred correction (SDC) for the time integration.
 
   - `diffusion`: a Crank-Nicolson time-discretized solver for the
     constant-coefficient diffusion equation.
 
+  - `incompressible`: a second-order cell-centered approximate
+    projection method for the incompressible equations of
+    hydrodynamics.
+
   - `lm_atm`: a solver for the equations of low Mach number
     hydrodynamics for atmospheric flows.
 
@@ -154,6 +159,8 @@ pyro provides the following solvers (all in 2-d):
     variable-coefficient Poisson equation (which inherits from the
     constant-coefficient solver).
 
+  - `particles`: a solver for Lagrangian tracer particles.
+
   - `swe`: a solver for the shallow water equations.
 
 

docs/source/compressible_basics.rst

@@ -24,6 +24,9 @@ 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.
+
 The implementations here have flattening at shocks, artificial
 viscosity, a simple gamma-law equation of state, and (in some cases) a
 choice of Riemann solvers. Optional constant gravity in the vertical

docs/source/design.rst

@@ -40,25 +40,54 @@ The overall structure is:
   * ``problems/``: The problem setups for the advection solver.
   * ``tests/``: Reference advection output files for comparison and regression testing.
 
+* ``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.
+
+* ``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.
+
 * ``advection_rk/``: The linear advection equation solver using the
   method-of-lines approach.
 
   * ``problems/``: This is a symbolic link to the advection/problems/ directory.
   * ``tests/``: Reference advection output files for comparison and regression testing.
 
+* ``advection_weno/``: The method-of-lines WENO solver for linear
+  advection.
+
+  * ``problems/``: This is a symbolic link to the advection/problems/ directory.
+
 * ``analysis/``: Various analysis scripts for processing pyro output files.
 
-* ``compressible/``: The compressible hydrodynamics solver using the
+* ``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).
+
+  * ``problems/``: The problem setups for the fourth-order compressible hydrodynamics solver.
+  * ``tests/``: Reference compressible hydro output for regression testing.
+
+* ``compressible_fv4/``: The compressible hydrodynamics solver using the
   CTU method. All source files specific to this solver live here.
 
-  * ``problems/``: The problem setups for the compressible hydrodynamics solver.
+  * ``problems/``: This is a symbolic link to the compressible/problems/ directory.
   * ``tests/``: Reference compressible hydro output for regression testing.
 
 * ``compressible_rk/``: The compressible hydrodynamics solver using method of lines integration.
 
   * ``problems/``: This is a symbolic link to the compressible/problems/ directory.
   * ``tests/``: Reference compressible hydro output for regression testing.
 
+* ``compressible_sdc/``: The fourth-order compressible solver,
+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.
+
 * ``diffusion/``: The implicit (thermal) diffusion solver. All diffusion-specific routines live here.
 
   * ``problems/``: The problem setups for the diffusion solver.
@@ -85,6 +114,10 @@ The overall structure is:
   * ``problems/``: The problem setups for when the multigrid solver is used in a stand-alone fashion.
   * ``tests/``: Reference multigrid solver solutions (from when the multigrid solver is used stand-alone) for regression testing.
 
+* ``particles/``: The solver for Lagrangian tracer particles.
+
+  * ``tests/``: Particle solver testing.
+
 * ``swe/``: The shallow water solver.
 
   * ``problems/``: The problem setups for the shallow water solver.

docs/source/modules.rst

@@ -6,6 +6,7 @@ pyro2
 
    advection
    advection_fv4
+   advection_nonuniform
    advection_rk
    advection_weno
    compare