README.md
1# IDA
2### Version 5.3.0 (May 2020)
3
4**Alan C. Hindmarsh and Radu Serban
5 Center for Applied Scientific Computing, LLNL**
6
7IDA is a package for the solution of differential-algebraic equation (DAE)
8systems
9```
10F(t,y,y') = 0, y(t0) = y0, y'(t0) = y0'.
11```
12The integration methods used in IDA are variable-order, variable-coefficient BDF
13(Backward Differentiation Formula) methods in fixed-leading-coefficient form.
14
15IDA is part of the SUNDIALS Suite of Nonlinear and Differential/Algebraic
16equation Solvers which consists of ARKode, CVODE, CVODES, IDA, IDAS and KINSOL.
17It is written in ANSI standard C, but is derived from the package DASPK, which
18is written in FORTRAN. IDA can be used in a variety of computing environments
19including serial, shared memory, distributed memory, and accelerator-based
20(e.g., GPU) systems. This flexibility is obtained from a modular design that
21leverages the shared vector, matrix, linear solver, and nonlinear solver APIs
22used across SUNDIALS packages.
23
24For use with Fortran applications, a set of Fortran/C interface routines, called
25FIDA, is also supplied. These are written in C, but assume that the user calling
26program and all user-supplied routines are in Fortran.
27
28## Documentation
29
30See the [IDA User Guide](/doc/ida/ida_guide.pdf) and
31[IDA Examples](/doc/ida/ida_examples.pdf) document for more information
32about IDA 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 IDA User Guide.
38
39## Release History
40
41Information on recent changes to IDA can be found in the "Introduction"
42chapter of the IDA User Guide and a complete release history is available in
43the "SUNDIALS Release History" appendix of the IDA User Guide.
44
45## References
46
47* A. C. Hindmarsh, R. Serban, and A. Collier, "User Documentation for IDA v5.3.0,"
48 LLNL technical report UCRL-SM-208112, May 2020.
49
50* A. C. Hindmarsh, R. Serban, and A. Collier, "Example Programs for IDA v5.3.0,"
51 LLNL technical report UCRL-SM-208113, May 2020.
52
53* A. C. Hindmarsh, P. N. Brown, K. E. Grant, S. L. Lee, R. Serban,
54 D. E. Shumaker, and C. S. Woodward, "SUNDIALS, Suite of Nonlinear and
55 Differential/Algebraic Equation Solvers," ACM Trans. Math. Softw.,
56 31(3), pp. 363-396, 2005.
57
58* P. N. Brown, A. C. Hindmarsh, and L. R. Petzold, Using Krylov Methods
59 in the Solution of Large-Scale Differential-Algebraic Systems,
60 SIAM J. Sci. Comp., 15 (1994), pp. 1467-1488.
61
62* P. N. Brown, A. C. Hindmarsh, and L. R. Petzold, Consistent Initial
63 Condition Calculation for Differential-Algebraic Systems,
64 SIAM J. Sci. Comp., 19 (1998), pp. 1495-1512.
65