Skip to content

Commit 061ef3c

Browse files
author
Nathan Goldbaum
committed
refer to multigrid examples with an explicit path
1 parent 4e17296 commit 061ef3c

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

docs/source/multigrid_basics.rst

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,13 @@ Examples
3232

3333
multigrid test
3434
^^^^^^^^^^^^^^
35-
A basic multigrid test is run as:
35+
36+
A basic multigrid test is run as (using a path relative to the root of the
37+
``pyro2`` repository):
3638

3739
.. code-block:: none
3840
39-
./mg_test_simple.py
41+
./examples/multigrid/mg_test_simple.py
4042
4143
The ``mg_test_simple.py`` script solves a Poisson equation with a
4244
known analytic solution. This particular example comes from the text
@@ -77,17 +79,21 @@ The movie below shows the smoothing at each level to realize this solution:
7779
<iframe src="https://www.youtube.com/embed/h9MUgwJvr-g?rel=0" frameborder="0" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe>
7880
</div><br>
7981

82+
You can run this example locally by running the ``mg_vis.py`` script:
83+
84+
.. code-block:: none
85+
86+
./examples/multigrid/mg_vis.py
8087
8188
projection
8289
^^^^^^^^^^
8390

84-
Another example (``examples/multigrid/project_periodic.py``) uses
85-
multigrid to extract the divergence free part of a velocity field.
86-
This is run as:
91+
Another example uses multigrid to extract the divergence free part of a velocity
92+
field. This is run as:
8793

8894
.. code-block:: none
8995
90-
./project-periodic.py
96+
./examples/multigrid/project_periodic.py
9197
9298
Given a vector field, :math:`U`, we can decompose it into a divergence free part, :math:`U_d`, and the gradient of a scalar, :math:`\phi`:
9399

0 commit comments

Comments
 (0)