add docstrings to the Burgers problems (#277)

python-hydro · Sep 15, 2024 · b23588d · b23588d
1 parent bc59234
commit b23588d
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/pyro/burgers/problems/converge.py b/pyro/burgers/problems/converge.py
@@ -1,3 +1,6 @@
+"""Setup a smooth velocity field (each component is an exponential).  This can
+be used to test convergence of the solver."""
+
 import numpy
 
 from pyro.util import msg

diff --git a/pyro/burgers/problems/test.py b/pyro/burgers/problems/test.py
@@ -1,3 +1,6 @@
+"""Create a shock moving diagonally (from lower-left to upper-right)
+through the domain."""
+
 from pyro.util import msg
 
 DEFAULT_INPUTS = "inputs.test"

diff --git a/pyro/burgers/problems/tophat.py b/pyro/burgers/problems/tophat.py
@@ -1,3 +1,5 @@
+"""Initialize a circular "tophat" region that will drive a shock."""
+
 from pyro.util import msg
 
 DEFAULT_INPUTS = "inputs.tophat"