Skip to content

Commit 0cb157d

Browse files
authored
SUNDIALS installation instructions (#4588)
## Summary Include SUNDIALS installation instructions. ## Additional background ## Checklist The proposed changes: - [ ] fix a bug or incorrect behavior in AMReX - [ ] add new capabilities to AMReX - [ ] changes answers in the test suite to more than roundoff level - [ ] are likely to significantly affect the results of downstream AMReX users - [x] include documentation in the code and/or rst files, if appropriate
1 parent 49f78b3 commit 0cb157d

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

Docs/sphinx_documentation/source/TimeIntegration_Chapter.rst

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,26 @@ Using SUNDIALS
100100
The AMReX Time Integration interface also supports a SUNDIALS backend that
101101
provides explicit, implicit, and implicit-explicit (ImEx) Runge-Kutta methods
102102
as well a multirate (MRI) methods from the ARKODE package in SUNDIALS.
103-
To use SUNDIALS integrators, the user needs to compile AMReX with
104-
``USE_SUNDIALS=TRUE`` and use SUNDIALS v6.0 or later.
103+
Presently, SUNDIALS v6.0 or later is required, but v7.4.0 has been successfully tested.
104+
To install SUNDIALS, the full documentation is available at
105+
https://sundials.readthedocs.io/en/latest/sundials/Install_link.html
106+
107+
Here is a summary of steps that you need to take using cmake.
108+
First obtain the source code from either
109+
https://computing.llnl.gov/projects/sundials/sundials-software or the github page at
110+
https://github.com/LLNL/sundials.
111+
Once you have unpacked or cloned the source code, run the following
112+
(altering the ENABLE_MPI and ENABLE_CUDA lines as appropriate):
113+
114+
::
115+
116+
cmake -S /path_to_sundials_source_code -B /path_to_sundials_build_dir -D CMAKE_INSTALL_PREFIX=/path_to_sundials_install_dir -D ENABLE_MPI=ON -D ENABLE_CUDA=ON
117+
cd /path_to_sundials_build_dir
118+
make
119+
make install
120+
121+
To use SUNDIALS integrators, the user needs to compile their AMReX application with
122+
``USE_SUNDIALS=TRUE`` and ``SUNDIALS_HOME=/path_to_sundials_install_dir``
105123

106124
The SUNDIALS interface supports ``MultiFab`` or ``Vector<MultiFab>`` data
107125
types. Using a ``Vector<MultiFab>`` permits integrating state data with

0 commit comments

Comments
 (0)