README.md
1# ARKode
2### Version 4.3.0 (May 2020)
3
4**Daniel R. Reynolds and Jean M. Sexton
5 Department of Mathematics, SMU**
6
7**David J. Gardner, Alan C. Hindmarsh, and Carol S. Woodward
8 Center for Applied Scientific Computing, LLNL**
9
10ARKode is a package for the solution of stiff, nonstiff, and multirate ordinary
11differential equation (ODE) systems (initial value problems) given in linearly
12implicit the form
13```
14M y' = f1(t,y) + f2(t,y), y(t0) = y0.
15```
16The integration methods implemented in ARKode include explicit and implicit
17Runge-Kutta methods, implicit-explicit (IMEX) additive Runge-Kutta methods, and
18multirate infatesemial step (MIS) methods.
19
20ARKode is part of a the SUNDIALS Suite of Nonlinear and Differential/Algebraic
21equation Solvers which consists of ARKode, CVODE, CVODES, IDA, IDAS, and KINSOL.
22It is written in ANSI standard C and can be used in a variety of computing
23environments including serial, shared memory, distributed memory, and
24accelerator-based (e.g., GPU) systems. This flexibility is obtained from a
25modular design that leverages the shared vector, matrix, linear solver, and
26nonlinear solver APIs used across SUNDIALS packages.
27
28For use with Fortran applications, a set of Fortran/C interface routines, called
29FARKODE, is also supplied. These are written in C, but assume that the user
30calling program and all user-supplied routines are in Fortran.
31
32## Documentation
33
34See the [ARKode User Guide](/doc/arkode/ark_guide.pdf) and
35[ARKode Examples](/doc/arkode/ark_examples.pdf) document for more information
36about ARKode usage and the provided example programs respectively.
37
38## Installation
39
40For installation instructions see the [INSTALL_GUIDE](/INSTALL_GUIDE.pdf)
41or "Installation Procedure" chapter in the ARKode User Guide.
42
43## Release History
44
45Information on recent changes to ARKode can be found in the "Introduction"
46chapter of the ARKode User Guide and a complete release history is available in
47the "SUNDIALS Release History" appendix of the ARKode User Guide.
48
49## References
50
51* D. R. Reynolds, D. J. Gardner, A. C. Hindmarsh, C. S. Woodward, and
52 J. M. Sexton, "User Documentation for ARKode v4.3.0," LLNL technical report
53 LLNL-SM-668082, May 2020.
54
55* D. R. Reynolds, "Example Programs for ARKode v4.3.0," Technical Report,
56 Southern Methodist University Center for Scientific Computation, May 2020.
57