Skip to content

Commit b23588d

Browse files
authored
add docstrings to the Burgers problems (#277)
1 parent bc59234 commit b23588d

File tree

3 files changed

+8
-0
lines changed

3 files changed

+8
-0
lines changed

pyro/burgers/problems/converge.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
"""Setup a smooth velocity field (each component is an exponential). This can
2+
be used to test convergence of the solver."""
3+
14
import numpy
25

36
from pyro.util import msg

pyro/burgers/problems/test.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
"""Create a shock moving diagonally (from lower-left to upper-right)
2+
through the domain."""
3+
14
from pyro.util import msg
25

36
DEFAULT_INPUTS = "inputs.test"

pyro/burgers/problems/tophat.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
"""Initialize a circular "tophat" region that will drive a shock."""
2+
13
from pyro.util import msg
24

35
DEFAULT_INPUTS = "inputs.tophat"

0 commit comments

Comments
 (0)