Skip to content

Commit 70bc2fe

Browse files
committed
udpate docs
1 parent 3bb3160 commit 70bc2fe

2 files changed

Lines changed: 18 additions & 10 deletions

File tree

Docs/source/SUNDIALS_Tutorial.rst

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,18 @@ user-supplied reaction and diffusion coefficients:
2323
The inputs file contains a template for MRI approaches, where the diffusion process
2424
can be treated as a "fast" partition relative to the reaction process.
2525

26-
The advection-diffusion examples at
27-
``amrex-tutorials/ExampleCodes/SUNDIALS/AdvDiff-HyprePrecon`` and
28-
``amrex-tutorials/ExampleCodes/SUNDIALS/AdvDiff-MLMGPrecon`` demonstrate
29-
SUNDIALS with preconditioning for an implicit diffusion solve using HYPRE and
30-
AMReX MLMG, respectively. The MLMG example can also use MLMG's HYPRE bottom
31-
solver interface when AMReX is built with HYPRE support. Their inputs also
32-
show how to select the SUNDIALS SPGMR
33-
preconditioning side with ``integration.sundials.linear_solver_preconditioning``.
34-
Please see each respective inputs file or
26+
The third example code at ``amrex-tutorials/ExampleCodes/SUNDIALS/AdvDiff-MLMGPrecon``
27+
solves the advection-diffusion equation, where :math:`A` and :math:`D` are
28+
user-supplied advection and diffusion coefficients:
29+
30+
.. math:: \frac{\partial\phi}{\partial t} = D \nabla^2\phi - A \nabla\phi.
31+
32+
The inputs file contains a template for IMEX approaches, where diffusion is
33+
treated implicitly with a SUNDIALS preconditioner that uses AMReX MLMG. The
34+
example can also use MLMG's HYPRE bottom solver interface when AMReX is built
35+
with HYPRE support.
36+
37+
Please see the inputs file or
3538
`AMReX User Guide:Time Integration`_ for more details.
3639

3740
.. _`AMReX User Guide:Time Integration`: https://amrex-codes.github.io/amrex/docs_html/TimeIntegration_Chapter.html#

ExampleCodes/SUNDIALS/AdvDiff-MLMGPrecon/Exec/README_sundials

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,9 @@ for SUNDIALS installation, build, and usage instructions.
33

44
Make sure that SUNDIALS_HOME in the GNUmakefile points to the installation directory.
55
This tutorial also requires AMReX to be built with MLMG linear solver support.
6-
Set USE_HYPRE=TRUE and mlmg.use_hypre=1 to use MLMG's HYPRE bottom solver interface.
6+
The default inputs use a SUNDIALS IMEX-RK method with GMRES and an AMReX MLMG
7+
preconditioner for the implicit diffusion solve.
8+
9+
Set USE_HYPRE=TRUE when building and mlmg.use_hypre=1 in inputs_sundials to use
10+
MLMG's HYPRE bottom solver interface. The HYPRE interface and options namespace
11+
are controlled by mlmg.hypre_interface and mlmg.hypre_options_namespace.

0 commit comments

Comments
 (0)