Cody Balos, David Gardner, Alan Hindmarsh, Slaven Peles, Daniel Reynolds, Radu Serban, and Carol Woodward
Center for Applied Scientific Computing, Lawrence Livermore National Laboratory
SUNDIALS is a family of software packages implemented with the goal of providing robust time integrators and nonlinear solvers that can easily be incorporated into existing simulation codes. The primary design goals are to require minimal information from the user, allow users to easily supply their own data structures underneath the packages, and allow for easy incorporation of user-supplied linear solvers and preconditioners. The various packages share many subordinate modules and are organized as a family with a directory structure that exploits sharing common functionality.
The SUNDIALS suite consists of the following packages:
-
ARKODE - for integration of stiff, nonstiff, and multirate ordinary differential equation systems (ODEs) of the form
M y' = f1(t,y) + f2(t,y), y(t0) = y0 -
CVODE - for integration of stiff and nonstiff ordinary differential equation systems (ODEs) of the form
y' = f(t,y), y(t0) = y0 -
CVODES - for integration and sensitivity analysis (forward and adjoint) of ordinary differential equation systems (ODEs) of the form
y' = f(t,y,p), y(t0) = y0(p) -
IDA - for integration of differential-algebraic equation systems (DAEs) of the form
F(t,y,y') = 0, y(t0) = y0, y'(t0) = y0' -
IDAS - for integration and sensitivity analysis (forward and adjoint) of differential-algebraic equation systems (DAEs) of the form
F(t,y,y',p) = 0, y(t0) = y0(p), y'(t0) = y0'(p) -
KINSOL - for solution of nonlinear algebraic systems of the form
F(u) = 0
For installation directions see the INSTALL_GUIDE or the installation chapter in any of the package user guides.
Warning to users who receive more than one of the individual packages at different times: Mixing old and new versions of SUNDIALS may fail. To avoid such failures, obtain all desired package at the same time.
Full user guides for SUNDIALS packages are provided in the doc directory along with documentation for example programs.
A list of Frequently Asked Questions on build and installation procedures as well as common usage issues is available on the SUNDIALS FAQ.
For dealing with systems with unphysical solutions or discontinuities see the SUNDIALS usage notes.
If you have a question not covered in the FAQ or usage notes, please submit your question to the SUNDIALS mailing list.
Bug fixes or minor changes are preferred via a pull request to the SUNDIALS GitHub repository. For more information on contributing see the CONTRIBUTING file.
| Date | SUNDIALS | ARKODE | CVODE | CVODES | IDA | IDAS | KINSOL |
|---|---|---|---|---|---|---|---|
| Feb 2019 | 4.1.0 | 3.1.0 | 4.1.0 | 4.1.0 | 4.1.0 | 3.1.0 | 4.1.0 |
| Jan 2019 | 4.0.2 | 3.0.2 | 4.0.2 | 4.0.2 | 4.0.2 | 3.0.2 | 4.0.2 |
| Dec 2018 | 4.0.1 | 3.0.1 | 4.0.1 | 4.0.1 | 4.0.1 | 3.0.1 | 4.0.1 |
| Dec 2018 | 4.0.0 | 3.0.0 | 4.0.0 | 4.0.0 | 4.0.0 | 3.0.0 | 4.0.0 |
| Oct 2018 | 3.2.1 | 2.2.1 | 3.2.1 | 3.2.1 | 3.2.1 | 2.2.1 | 3.2.1 |
| Sep 2018 | 3.2.0 | 2.2.0 | 3.2.0 | 3.2.0 | 3.2.0 | 2.2.0 | 3.2.0 |
| Jul 2018 | 3.1.2 | 2.1.2 | 3.1.2 | 3.1.2 | 3.1.2 | 2.1.2 | 3.1.2 |
| May 2018 | 3.1.1 | 2.1.1 | 3.1.1 | 3.1.1 | 3.1.1 | 2.1.1 | 3.1.1 |
| Nov 2017 | 3.1.0 | 2.1.0 | 3.1.0 | 3.1.0 | 3.1.0 | 2.1.0 | 3.1.0 |
| Sep 2017 | 3.0.0 | 2.0.0 | 3.0.0 | 3.0.0 | 3.0.0 | 2.0.0 | 3.0.0 |
| Sep 2016 | 2.7.0 | 1.1.0 | 2.9.0 | 2.9.0 | 2.9.0 | 1.3.0 | 2.9.0 |
| Aug 2015 | 2.6.2 | 1.0.2 | 2.8.2 | 2.8.2 | 2.8.2 | 1.2.2 | 2.8.2 |
| Mar 2015 | 2.6.1 | 1.0.1 | 2.8.1 | 2.8.1 | 2.8.1 | 1.2.1 | 2.8.1 |
| Mar 2015 | 2.6.0 | 1.0.0 | 2.8.0 | 2.8.0 | 2.8.0 | 1.2.0 | 2.8.0 |
| Mar 2012 | 2.5.0 | 2.7.0 | 2.7.0 | 2.7.0 | 1.1.0 | 2.7.0 | |
| May 2009 | 2.4.0 | 2.6.0 | 2.6.0 | 2.6.0 | 1.0.0 | 2.6.0 | |
| Nov 2006 | 2.3.0 | 2.5.0 | 2.5.0 | 2.5.0 | 2.5.0 | ||
| Mar 2006 | 2.2.0 | 2.4.0 | 2.4.0 | 2.4.0 | 2.4.0 | ||
| May 2005 | 2.1.1 | 2.3.0 | 2.3.0 | 2.3.0 | 2.3.0 | ||
| Apr 2005 | 2.1.0 | 2.3.0 | 2.2.0 | 2.3.0 | 2.3.0 | ||
| Mar 2005 | 2.0.2 | 2.2.2 | 2.1.2 | 2.2.2 | 2.2.2 | ||
| Jan 2005 | 2.0.1 | 2.2.1 | 2.1.1 | 2.2.1 | 2.2.1 | ||
| Dec 2004 | 2.0 | 2.2.0 | 2.1.0 | 2.2.0 | 2.2.0 | ||
| Jul 2002 | 1.0 | 2.0 | 1.0 | 2.0 | 2.0 |
The SUNDIALS Team: Carol S. Woodward, Daniel R. Reynolds, Alan C. Hindmarsh, David J. Gardner, Slaven Peles, and Cody J. Balos. We thank Radu Serban for significant and critical past contributions.
We also acknowledge past contributions of Scott D. Cohen, Peter N. Brown, George Byrne, Allan G. Taylor, Steven L. Lee, Keith E. Grant, Aaron Collier, Lawrence E. Banks, Steve Smith, Cosmin Petra, John Loffeld, Dan Shumaker, Ulrike Yang, James Almgren-Bell, Shelby L. Lockhart, Hilari C. Tiedeman, Ting Yan, Jean M. Sexton, and Chris White.
We ask users of SUNDIALS to cite the following paper in any publications reporting work done with SUNDIALS:
- Alan C. Hindmarsh, Peter N. Brown, Keith E. Grant, Steven L. Lee, Radu Serban, Dan E. Shumaker, and Carol S. Woodward. 2005. SUNDIALS: Suite of nonlinear and differential/algebraic equation solvers. ACM Trans. Math. Softw. 31, 3 (September 2005), 363-396. DOI=http://dx.doi.org/10.1145/1089014.1089020
SUNDIALS is released under the BSD 3-clause license. See the LICENSE and NOTICE files for details.
All new contributions must be made under the BSD 3-clause license.
Please Note If you are using SUNDIALS with any third party libraries linked in (e.g., LAPACK, KLU, SuperLU_MT, PETSc, or hypre), be sure to review the respective license of the package as that license may have more restrictive terms than the SUNDIALS license.
SPDX-License-Identifier: BSD-3-Clause
LLNL-CODE-667205 (ARKODE)
UCRL-CODE-155951 (CVODE)
UCRL-CODE-155950 (CVODES)
UCRL-CODE-155952 (IDA)
UCRL-CODE-237203 (IDAS)
LLNL-CODE-665877 (KINSOL)