Skip to content

Commit d6f2998

Browse files
authored
fix a stray math mark in the MG docs (#265)
also add a link to the MG examples
1 parent 0696666 commit d6f2998

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

docs/source/multigrid.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ There are three solvers:
2121
* The class :func:`general_MG.GeneralMG2d <pyro.multigrid.general_MG.GeneralMG2d>` solves a general elliptic
2222
equation of the form
2323

24-
$$`\alpha \phi + \nabla \cdot ( \beta \nabla \phi) + \gamma \cdot \nabla \phi = f$$
24+
$$\alpha \phi + \nabla \cdot ( \beta \nabla \phi) + \gamma \cdot \nabla \phi = f$$
2525

2626
This class inherits
2727
the core functionality from :func:`MG.CellCenterMG2d <pyro.multigrid.MG.CellCenterMG2d>`.
@@ -35,6 +35,8 @@ to square grids with zoning a power of 2.
3535
.. note::
3636

3737
The multigrid solver is not controlled through ``pyro_sim.py``
38-
since there is no time-dependence in pure elliptic problems. Instead,
39-
there are a few scripts in the multigrid/ subdirectory that
40-
demonstrate its use.
38+
since there is no time-dependence in pure elliptic
39+
problems. Instead, there are a few scripts in the ``multigrid/``
40+
subdirectory (see:
41+
https://github.com/python-hydro/pyro2/tree/main/pyro/multigrid/examples)
42+
that demonstrate its use.

0 commit comments

Comments
 (0)