README.md
1# CVODE
2### Version 5.7.0 (Jan 2021)
3
4**Alan C. Hindmarsh, Radu Serban, Cody J. Balos, David J. Gardner,
5 and Carol S. Woodward, Center for Applied Scientific Computing, LLNL**
6
7**Daniel R. Reynolds, Department of Mathematics, Southern Methodist University**
8
9CVODE is a package for the solution of stiff and nonstiff ordinary differential
10equation (ODE) systems (initial value problems) given in explicit form
11```
12dy/dt = f(t,y), y(t0) = y0.
13```
14CVODE provides a choice of two variable-order, variable-coefficient multistep
15methods, Adams-Moulton methods for non-stiff problems or BDF (Backward
16Differentiation Formula) methods in fixed-leading-coefficient form for stiff
17problems.
18
19CVODE is part of the SUNDIALS Suite of Nonlinear and Differential/Algebraic
20equation Solvers which consists of ARKode, CVODE, CVODES, IDA, IDAS and KINSOL.
21It is written in ANSI standard C and can be used in a variety of computing
22environments including serial, shared memory, distributed memory, and
23accelerator-based (e.g., GPU) systems. This flexibility is obtained from a
24modular design that leverages the shared vector, matrix, linear solver, and
25nonlinear solver APIs used across SUNDIALS packages.
26
27For use with Fortran applications, a set of Fortran/C interface routines, called
28FCVODE, is also supplied. These are written in C, but assume that the user
29calling program and all user-supplied routines are in Fortran.
30
31## Documentation
32
33See the [CVODE User Guide](/doc/cvode/cv_guide.pdf) and
34[CVODE Examples](/doc/cvode/cv_examples.pdf) document for more information
35about CVODE usage and the provided example programs respectively.
36
37## Installation
38
39For installation instructions see the [INSTALL_GUIDE](/INSTALL_GUIDE.pdf)
40or the "Installation Procedure" chapter in the CVODE User Guide.
41
42## Release History
43
44Information on recent changes to CVODE can be found in the "Introduction"
45chapter of the CVODE User Guide and a complete release history is available in
46the "SUNDIALS Release History" appendix of the CVODE User Guide.
47
48## References
49
50* A. C. Hindmarsh, R. Serban, C. J. Balos, D. J. Gardner, D. R. Reynolds
51 and C. S. Woodward, "User Documentation for CVODE v5.7.0,"
52 LLNL technical report UCRL-SM-208108, Jan 2021.
53
54* A. C. Hindmarsh and R. Serban, "Example Programs for CVODE v5.7.0,"
55 LLNL technical report UCRL-SM-208110, Jan 2021.
56
57* S.D. Cohen and A.C. Hindmarsh, "CVODE, a Stiff/nonstiff ODE Solver in C,"
58 Computers in Physics, 10(2), pp. 138-143, 1996.
59
60* A. C. Hindmarsh, P. N. Brown, K. E. Grant, S. L. Lee, R. Serban,
61 D. E. Shumaker, and C. S. Woodward, "SUNDIALS, Suite of Nonlinear and
62 Differential/Algebraic Equation Solvers," ACM Trans. Math. Softw.,
63 31(3), pp. 363-396, 2005.
64