Release: 7.2.1 (#628)

SUNDIALS Release v7.2.1 --------- Co-authored-by: Cody Balos <cjbalos@gmail.com> Co-authored-by: Daniel R. Reynolds <reynolds@smu.edu>
LLNL · Dec 20, 2024 · 5c53be8 · 5c53be8
1 parent ab2f4ad
commit 5c53be8
Show file tree

Hide file tree

Showing 25 changed files with 102 additions and 100 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,20 +1,20 @@
 # SUNDIALS Changelog
 
-## Changes to SUNDIALS in release X.Y.Z
-
-### Major Features
+## Changes to SUNDIALS in release 7.2.1
 
 ### New Features and Enhancements
 
+Unit tests were separated from examples. To that end, the following directories 
+were moved out of the `examples/` directory to the `test/unit_tests` directory:
+`nvector`, `sunmatrix`, `sunlinsol`, and `sunnonlinsol`.
+
 ### Bug Fixes
 
 Fixed a bug in ARKStep where an extra right-hand side evaluation would occur
 each time step when enabling the ``ARKodeSetAutonomous`` option and using an
 IMEX method where the DIRK table has an implicit first stage and is not stiffly
 accurate.
 
-### Deprecation Notices
-
 ## Changes to SUNDIALS in release 7.2.0
 
 ### Major Features

diff --git a/CITATIONS.md b/CITATIONS.md
@@ -69,7 +69,7 @@ they are using rather than the combined SUNDIALS online guide:
   author = {Daniel R. Reynolds and David J. Gardner and Carol S. Woodward and Cody J. Balos},
   title  = {User Documentation for ARKODE},
   year   = {2024},
-  note   = {v6.2.0}
+  note   = {v6.2.1}
 }
 ```
 
@@ -78,7 +78,7 @@ they are using rather than the combined SUNDIALS online guide:
   author = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward},
   title  = {User Documentation for CVODE},
   year   = {2024},
-  note   = {v7.2.0}
+  note   = {v7.2.1}
 }
 ```
 
@@ -87,7 +87,7 @@ they are using rather than the combined SUNDIALS online guide:
   author = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward},
   title  = {User Documentation for CVODES},
   year   = {2024},
-  note   = {v7.2.0}
+  note   = {v7.2.1}
 }
 ```
 
@@ -96,7 +96,7 @@ they are using rather than the combined SUNDIALS online guide:
   author = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward},
   title  = {User Documentation for IDA},
   year   = {2024},
-  note   = {v7.2.0}
+  note   = {v7.2.1}
 }
 ```
 
@@ -105,7 +105,7 @@ they are using rather than the combined SUNDIALS online guide:
   author = {Radu Serban and Cosmin Petra and Alan C. Hindmarsh and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward},
   title  = {User Documentation for IDAS},
   year   = {2024},
-  note   = {v6.2.0}
+  note   = {v6.2.1}
 }
 ```
 
@@ -114,6 +114,6 @@ they are using rather than the combined SUNDIALS online guide:
   author = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward},
   title  = {User Documentation for KINSOL},
   year   = {2024},
-  note   = {v7.2.0}
+  note   = {v7.2.1}
 }
 ```
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -44,7 +44,7 @@ include(FindPackageHandleStandardArgs)
 # Set some variables with info on the SUNDIALS project
 set(PACKAGE_BUGREPORT "sundials-users@llnl.gov")
 set(PACKAGE_NAME "SUNDIALS")
-set(PACKAGE_STRING "SUNDIALS 7.2.0")
+set(PACKAGE_STRING "SUNDIALS 7.2.1")
 set(PACKAGE_TARNAME "sundials")
 
 # Set SUNDIALS version numbers
@@ -54,7 +54,7 @@ message(STATUS "SUNDIALS_GIT_VERSION: ${SUNDIALS_GIT_VERSION}")
 # (use "" for the version label if none is needed)
 set(PACKAGE_VERSION_MAJOR "7")
 set(PACKAGE_VERSION_MINOR "2")
-set(PACKAGE_VERSION_PATCH "0")
+set(PACKAGE_VERSION_PATCH "1")
 set(PACKAGE_VERSION_LABEL "")
 
 if(PACKAGE_VERSION_LABEL)
@@ -69,37 +69,37 @@ endif()
 
 # Specify the VERSION and SOVERSION for shared libraries
 
-set(arkodelib_VERSION "6.2.0")
+set(arkodelib_VERSION "6.2.1")
 set(arkodelib_SOVERSION "6")
 
-set(cvodelib_VERSION "7.2.0")
+set(cvodelib_VERSION "7.2.1")
 set(cvodelib_SOVERSION "7")
 
-set(cvodeslib_VERSION "7.2.0")
+set(cvodeslib_VERSION "7.2.1")
 set(cvodeslib_SOVERSION "7")
 
-set(idalib_VERSION "7.2.0")
+set(idalib_VERSION "7.2.1")
 set(idalib_SOVERSION "7")
 
-set(idaslib_VERSION "6.2.0")
+set(idaslib_VERSION "6.2.1")
 set(idaslib_SOVERSION "6")
 
-set(kinsollib_VERSION "7.2.0")
+set(kinsollib_VERSION "7.2.1")
 set(kinsollib_SOVERSION "7")
 
 set(cpodeslib_VERSION "0.0.0")
 set(cpodeslib_SOVERSION "0")
 
-set(nveclib_VERSION "7.2.0")
+set(nveclib_VERSION "7.2.1")
 set(nveclib_SOVERSION "7")
 
-set(sunmatrixlib_VERSION "5.2.0")
+set(sunmatrixlib_VERSION "5.2.1")
 set(sunmatrixlib_SOVERSION "5")
 
-set(sunlinsollib_VERSION "5.2.0")
+set(sunlinsollib_VERSION "5.2.1")
 set(sunlinsollib_SOVERSION "5")
 
-set(sunnonlinsollib_VERSION "4.2.0")
+set(sunnonlinsollib_VERSION "4.2.1")
 set(sunnonlinsollib_SOVERSION "4")
 
 set(sundialslib_VERSION

diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 # SUNDIALS: SUite of Nonlinear and DIfferential/ALgebraic equation Solvers #
-### Version 7.2.0 (Dec 2024) ###
+### Version 7.2.1 (Dec 2024) ###
 
 **Center for Applied Scientific Computing, Lawrence Livermore National Laboratory**
 

diff --git a/doc/arkode/guide/source/Introduction.rst b/doc/arkode/guide/source/Introduction.rst
@@ -126,7 +126,7 @@ require a linear solver, ARKODE may use a variety of SUNLinearSolver modules
 provided with SUNDIALS, or again may utilize a user-supplied module.
 
 
-Changes to SUNDIALS in release X.Y.Z
+Changes to SUNDIALS in release 6.2.1
 ====================================
 
 .. include:: ../../../shared/RecentChanges.rst

diff --git a/doc/cvode/guide/source/Introduction.rst b/doc/cvode/guide/source/Introduction.rst
@@ -108,7 +108,7 @@ implementations.
 .. efficiency of C, and the greater ease of interfacing the solver to
 .. applications written in extended Fortran.
 
-Changes to SUNDIALS in release X.Y.Z
+Changes to SUNDIALS in release 7.2.1
 ====================================
 
 .. include:: ../../../shared/RecentChanges.rst

diff --git a/doc/cvodes/guide/source/Introduction.rst b/doc/cvodes/guide/source/Introduction.rst
@@ -109,7 +109,7 @@ greater ease of interfacing the solver to applications written in extended
 Fortran.
 
 
-Changes to SUNDIALS in release X.Y.Z
+Changes to SUNDIALS in release 7.2.1
 ====================================
 
 .. include:: ../../../shared/RecentChanges.rst

diff --git a/doc/ida/guide/source/Introduction.rst b/doc/ida/guide/source/Introduction.rst
@@ -69,7 +69,7 @@ systems.
    the greater ease of interfacing the solver to applications written in extended
    Fortran.
 
-Changes to SUNDIALS in release X.Y.Z
+Changes to SUNDIALS in release 7.2.1
 ====================================
 
 .. include:: ../../../shared/RecentChanges.rst

diff --git a/doc/idas/guide/source/Introduction.rst b/doc/idas/guide/source/Introduction.rst
@@ -83,7 +83,7 @@ integrate any final-condition ODE dependent on the solution of the original IVP
    the greater ease of interfacing the solver to applications written in extended
    Fortran.
 
-Changes to SUNDIALS in release X.Y.Z
+Changes to SUNDIALS in release 6.2.1
 ====================================
 
 .. include:: ../../../shared/RecentChanges.rst

diff --git a/doc/kinsol/guide/source/Introduction.rst b/doc/kinsol/guide/source/Introduction.rst
@@ -85,7 +85,7 @@ applications written in Fortran.
 
 .. _KINSOL.Introduction.Changes:
 
-Changes to SUNDIALS in release X.Y.Z
+Changes to SUNDIALS in release 7.2.1
 ====================================
 
 .. include:: ../../../shared/RecentChanges.rst

diff --git a/doc/shared/Changelog.rst b/doc/shared/Changelog.rst
@@ -21,7 +21,7 @@ Changelog
 
 .. SED_REPLACEMENT_KEY
 
-Changes to SUNDIALS in release X.Y.Z
+Changes to SUNDIALS in release 7.2.1
 ====================================
 
 .. include:: RecentChanges_link.rst

diff --git a/doc/shared/History.rst b/doc/shared/History.rst
@@ -21,6 +21,8 @@ Release History
 +----------+-------------------+-------------------+-------------------+-------------------+-------------------+-------------------+-------------------+
 | Date     | SUNDIALS          | ARKODE            | CVODE             | CVODES            | IDA               | IDAS              | KINSOL            |
 +==========+===================+===================+===================+===================+===================+===================+===================+
+| Dec 2024 | 7.2.1             | 6.2.1             | 7.2.1             | 7.2.1             | 7.2.1             | 6.2.1             | 7.2.1             |
++----------+-------------------+-------------------+-------------------+-------------------+-------------------+-------------------+-------------------+
 | Dec 2024 | 7.2.0             | 6.2.0             | 7.2.0             | 7.2.0             | 7.2.0             | 6.2.0             | 7.2.0             |
 +----------+-------------------+-------------------+-------------------+-------------------+-------------------+-------------------+-------------------+
 | Jun 2024 | 7.1.1             | 6.1.1             | 7.1.1             | 7.1.1             | 7.1.1             | 6.1.1             | 7.1.1             |

diff --git a/doc/shared/RecentChanges.rst b/doc/shared/RecentChanges.rst
@@ -1,12 +1,12 @@
-**Major Features**
+** New Features and Enhancements **
 
-**New Features and Enhancements**
+Unit tests were separated from examples. To that end, the following directories 
+were moved out of the ``examples/`` directory to the ``test/unit_tests`` directory:
+``nvector``, ``sunmatrix``, ``sunlinsol``, and ``sunnonlinsol``.
 
 **Bug Fixes**
 
 Fixed a bug in ARKStep where an extra right-hand side evaluation would occur
 each time step when enabling the :c:func:`ARKodeSetAutonomous` option and using
 an IMEX method where the DIRK table has an implicit first stage and is not stiffly
 accurate.
-
-**Deprecation Notices**
diff --git a/doc/shared/sundials.bib b/doc/shared/sundials.bib
@@ -27,7 +27,7 @@
 %
 @techreport{arkode_ug,
 author      = {Daniel R. Reynolds and David J. Gardner and Carol S. Woodward and Rujeko Chinomona and Cody J. Balos},
-title       = {{User Documentation for ARKODE v6.2.0}},
+title       = {{User Documentation for ARKODE v6.2.1}},
 institution = {LLNL},
 number      = {LLNL-SM-668082},
 year        = 2024
@@ -37,7 +37,7 @@ @techreport{arkode_ug
 %
 @techreport{arkode_ex,
 author      = {Daniel R. Reynolds},
-title       = {{Example Programs for ARKODE v6.2.0}},
+title       = {{Example Programs for ARKODE v6.2.1}},
 institution = {Southern Methodist University},
 year        = 2024
 }
@@ -46,7 +46,7 @@ @techreport{arkode_ex
 %
 @techreport{cvode_ug,
 author      = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward},
-title       = {{User Documentation for CVODE v7.2.0}},
+title       = {{User Documentation for CVODE v7.2.1}},
 institution = {LLNL},
 number      = {UCRL-SM-208108},
 year        = 2024
@@ -56,7 +56,7 @@ @techreport{cvode_ug
 %
 @techreport{cvode_ex,
 author      = {Alan C. Hindmarsh and Radu Serban},
-title       = {{Example Programs for CVODE v7.2.0}},
+title       = {{Example Programs for CVODE v7.2.1}},
 institution = {LLNL},
 note        = {UCRL-SM-208110},
 year        = 2024
@@ -66,7 +66,7 @@ @techreport{cvode_ex
 %
 @techreport{cvodes_ug,
 author      = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward},
-title       = {{User Documentation for CVODES v7.2.0}},
+title       = {{User Documentation for CVODES v7.2.1}},
 institution = {LLNL},
 note        = {UCRL-SM-208111},
 year        = 2024
@@ -76,7 +76,7 @@ @techreport{cvodes_ug
 %
 @techreport{cvodes_ex,
 author      = {Radu Serban and Alan C. Hindmarsh},
-title       = {{Example Programs for CVODES v7.2.0}},
+title       = {{Example Programs for CVODES v7.2.1}},
 institution = {LLNL},
 number      = {UCRL-SM-208115},
 year        = 2024
@@ -86,7 +86,7 @@ @techreport{cvodes_ex
 %
 @techreport{ida_ug,
 author      = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward},
-title       = {{User Documentation for IDA v7.2.0}},
+title       = {{User Documentation for IDA v7.2.1}},
 institution = {LLNL},
 number      = {UCRL-SM-208112},
 year        = 2024
@@ -96,7 +96,7 @@ @techreport{ida_ug
 %
 @techreport{ida_ex,
 author      = {Alan C. Hindmarsh and Radu Serban and Aaron Collier},
-title       = {{Example Programs for IDA v7.2.0}},
+title       = {{Example Programs for IDA v7.2.1}},
 institution = {LLNL},
 number      = {UCRL-SM-208113},
 year        = 2024
@@ -106,7 +106,7 @@ @techreport{ida_ex
 %
 @techreport{idas_ug,
 author      = {Radu Serban and Cosmin Petra and Alan C. Hindmarsh and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward},
-title       = {{User Documentation for IDAS v6.2.0}},
+title       = {{User Documentation for IDAS v6.2.1}},
 institution = {LLNL},
 number      = {UCRL-SM-234051},
 year        = 2024
@@ -116,7 +116,7 @@ @techreport{idas_ug
 %
 @techreport{idas_ex,
 author      = {Radu Serban and Alan C. Hindmarsh},
-title       = {{Example Programs for IDAS v6.2.0}},
+title       = {{Example Programs for IDAS v6.2.1}},
 institution = {LLNL},
 number      = {LLNL-TR-437091},
 year        = 2024
@@ -126,7 +126,7 @@ @techreport{idas_ex
 %
 @techreport{kinsol_ug,
 author      = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward},
-title       = {{User Documentation for KINSOL v7.2.0}},
+title       = {{User Documentation for KINSOL v7.2.1}},
 institution = {LLNL},
 number      = {UCRL-SM-208116},
 year        = 2024
@@ -136,7 +136,7 @@ @techreport{kinsol_ug
 %
 @techreport{kinsol_ex,
 author      = {Aaron M. Collier and Radu Serban},
-title       = {{Example Programs for KINSOL v7.2.0}},
+title       = {{Example Programs for KINSOL v7.2.1}},
 institution = {LLNL},
 number      = {UCRL-SM-208114},
 year        = 2024

diff --git a/doc/shared/sundials_vars.py b/doc/shared/sundials_vars.py
@@ -9,14 +9,14 @@
 # SPDX-License-Identifier: BSD-3-Clause
 # SUNDIALS Copyright End
 # ----------------------------------------------------------------
-doc_version = 'develop'
-sundials_version = 'v7.2.0'
-arkode_version = 'v6.2.0'
-cvode_version = 'v7.2.0'
-cvodes_version = 'v7.2.0'
-ida_version = 'v7.2.0'
-idas_version = 'v6.2.0'
-kinsol_version = 'v7.2.0'
+doc_version = 'v7.2.1'
+sundials_version = 'v7.2.1'
+arkode_version = 'v6.2.1'
+cvode_version = 'v7.2.1'
+cvodes_version = 'v7.2.1'
+ida_version = 'v7.2.1'
+idas_version = 'v6.2.1'
+kinsol_version = 'v7.2.1'
 year = '2024'
 
 # Warn about all references where the target cannot be found