From 2618cc64f753ec3a494edb973d6e36addf7d811e Mon Sep 17 00:00:00 2001 From: Andy Nonaka Date: Mon, 19 Aug 2024 07:50:33 -0700 Subject: [PATCH] update README to sundials install --- ExampleCodes/SUNDIALS/Exec/README_sundials | 49 +++++++--------------- 1 file changed, 14 insertions(+), 35 deletions(-) diff --git a/ExampleCodes/SUNDIALS/Exec/README_sundials b/ExampleCodes/SUNDIALS/Exec/README_sundials index c0f315aa..bf0e47c1 100644 --- a/ExampleCodes/SUNDIALS/Exec/README_sundials +++ b/ExampleCodes/SUNDIALS/Exec/README_sundials @@ -3,13 +3,19 @@ https://computing.llnl.gov/projects/sundials/faq#inst Installation -# Download sundials-x.y.z.tar.gz file for SUNDIALS and extract it at the same level as amrex. -# Update 6/11/24 - v7.0.0. tested -https://computing.llnl.gov/projects/sundials/sundials-software - +# You need SUNDIALS v7.1.1 or later. +# Check https://computing.llnl.gov/projects/sundials/sundials-software to see if it's available for download. +# If so, download sundials-x.y.z.tar.gz and extract it at the same level as amrex using >> tar -xzvf sundials-x.y.z.tar.gz # where x.y.z is the version of sundials +>> mv sundials-x.y.z sundials-src + +# If v7.1.1. is not available on the website, clone the git repo directly and use the latest version +# At the same level that amrex is cloned, do: + +>> git clone https://github.com/LLNL/sundials.git +>> mv sundials sundials-src -# at the same level that amrex is cloned, do: +# Next >> mkdir sundials >> cd sundials @@ -22,7 +28,7 @@ HOST BUILD >> mkdir builddir >> cd builddir ->> cmake -DCMAKE_INSTALL_PREFIX=/pathto/sundials/instdir -DEXAMPLES_INSTALL_PATH=/pathto/sundials/instdir/examples -DENABLE_MPI=ON ../../sundials-x.y.z +>> cmake -DCMAKE_INSTALL_PREFIX=/pathto/sundials/instdir -DEXAMPLES_INSTALL_PATH=/pathto/sundials/instdir/examples -DENABLE_MPI=ON ../../sundials-src ###################### NVIDIA/CUDA BUILD @@ -34,7 +40,7 @@ NVIDIA/CUDA BUILD >> mkdir builddir_cuda >> cd builddir_cuda ->> cmake -DCMAKE_INSTALL_PREFIX=/pathto/sundials/instdir_cuda -DEXAMPLES_INSTALL_PATH=/pathto/sundials/instdir_cuda/examples -DENABLE_CUDA=ON -DENABLE_MPI=ON ../../sundials-x.y.z +>> cmake -DCMAKE_INSTALL_PREFIX=/pathto/sundials/instdir_cuda -DEXAMPLES_INSTALL_PATH=/pathto/sundials/instdir_cuda/examples -DENABLE_CUDA=ON -DENABLE_MPI=ON ../../sundials-src ###################### @@ -55,31 +61,4 @@ NVIDIA/CUDA BUILD >> make -j4 # optional to have 'USE_CUDA=TRUE' as well -# in your inputs file, you will need to have: - -# INTEGRATION -## integration.type can take on the following values: -## 0 or "ForwardEuler" => Native AMReX Forward Euler integrator -## 1 or "RungeKutta" => Native AMReX Explicit Runge Kutta controlled by integration.rk.type -## 2 or "SUNDIALS" => SUNDIALS backend controlled by integration.sundials.strategy -integration.type = - -## Native AMReX Explicit Runge-Kutta parameters -# -## integration.rk.type can take the following values: -### 0 = User-specified Butcher Tableau -### 1 = Forward Euler -### 2 = Trapezoid Method -### 3 = SSPRK3 Method -### 4 = RK4 Method -integration.rk.type = 3 - -## If using the SUNDIALS Submodule, then -## compile with USE_SUNDIALS=TRUE or AMReX_SUNDIALS=ON and -## set strategy here: -# -## integration.sundials.strategy can take the following values: -### ERK = ERKStep from ARKode with SSPRK3 Method -### MRI = MRIStep from ARKode with Explict Trapezoid Method -### MRITEST = MRIStep from ARKode modified to use no-op inner f0 -integration.sundials.strategy = ERK +# Refer to inputs to see how to enable different integrators