add docstrings to the advection tests (#274)

Author: zingale

pyro/advection/problems/smooth.py

@@ -1,3 +1,7 @@
+"""Initialize a Gaussian profile (shifted so the minimum value is 1.0).  This
+is smooth and the limiters should not kick in too much, so this can be used
+for testing convergence."""
+
 import numpy
 
 from pyro.util import msg

pyro/advection/problems/test.py

@@ -1,3 +1,5 @@
+"""A problem setup for the unit testing."""
+
 DEFAULT_INPUTS = None
 
 PROBLEM_PARAMS = {}

pyro/advection/problems/tophat.py

@@ -1,3 +1,9 @@
+"""Initialize a tophat profile---the value inside a small circular
+regions is set to 1.0 and is zero otherwise.  This will exercise the
+limiters significantly.
+
+"""
+
 from pyro.util import msg
 
 DEFAULT_INPUTS = "inputs.tophat"

pyro/advection_nonuniform/problems/slotted.py

@@ -1,3 +1,9 @@
+"""A circular profile with a rectangular slot cut out of it.  This is
+meant to be run with the velocity field that causes it to rotate about
+the center, to understand how well we preserve symmetry.
+
+"""
+
 import numpy as np
 
 from pyro.util import msg

pyro/advection_nonuniform/problems/test.py

@@ -1,3 +1,5 @@
+"""A test setup used for unit testing."""
+
 DEFAULT_INPUTS = None
 
 PROBLEM_PARAMS = {}