README.md
1# CVODES
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
9
10CVODES is a package for the solution of stiff and nonstiff ordinary differential
11equation (ODE) systems (initial value problem) given in explicit form
12```
13dy/dt = f(t,y,p), y(t0) = y0(p)
14```
15with sensitivity analysis capabilities (both forward and adjoint modes). CVODES
16provides a choice of two variable-order, variable-coefficient multistep methods,
17Adams-Moulton methods for non-stiff problems or BDF (Backward Differentiation
18Formula) methods in fixed-leading-coefficient form for stiff problems.
19
20CVODES is part of 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
28## Documentation
29
30See the [CVODES User Guide](/doc/cvodes/cvs_guide.pdf) and
31[CVODES Examples](/doc/cvodes/cvs_examples.pdf) document for more information
32about CVODES usage and the provided example programs respectively.
33
34## Installation
35
36For installation instructions see the [INSTALL_GUIDE](/INSTALL_GUIDE.pdf)
37or the "Installation Procedure" chapter in the CVODES User Guide.
38
39## Release History
40
41Information on recent changes to CVODES can be found in the "Introduction"
42chapter of the CVODES User Guide and a complete release history is available in
43the "SUNDIALS Release History" appendix of the CVODES User Guide.
44
45## References
46
47* A. C. Hindmarsh, R. Serban, C. J. Balos, D. J. Gardner, D. R. Reynolds
48 and C. S. Woodward, "User Documentation for CVODES v5.7.0,"
49 LLNL technical report UCRL-SM-208111, Jan 2021.
50
51* A. C. Hindmarsh and R. Serban, "Example Programs for CVODES v5.7.0,"
52 LLNL technical report UCRL-SM-208115, Jan 2021.
53
54* R. Serban and A. C. Hindmarsh, "CVODES: the Sensitivity-Enabled ODE
55 solver in SUNDIALS," Proceedings of IDETC/CIE 2005, Sept. 2005,
56 Long Beach, CA.
57
58* A. C. Hindmarsh, P. N. Brown, K. E. Grant, S. L. Lee, R. Serban,
59 D. E. Shumaker, and C. S. Woodward, "SUNDIALS, Suite of Nonlinear and
60 Differential/Algebraic Equation Solvers," ACM Trans. Math. Softw.,
61 31(3), pp. 363-396, 2005.
62