Release/6.6.0 (#306)

CHANGELOG.md

@@ -2,21 +2,17 @@
 
 ## Changes to SUNDIALS in release 6.6.0
 
+A new time-stepping module, `SPRKStep`, was added to ARKODE. This time-stepper
+provides explicit symplectic partitioned Runge-Kutta methods up to order 10
+for separable Hamiltonian systems.
+
 Added support for relaxation Runge-Kutta methods to ERKStep and ARKStep in
 ARKODE.
 
 Added the second order IMEX method from Giraldo, Kelly, and Constantinescu 2013
 as the default second order IMEX method in ARKStep. The explicit table is given
 by `ARKODE_ARK2_ERK_3_1_2` and the implicit table by `ARKODE_ARK2_DIRK_3_1_2`.
 
-Updated the F2003 utility routines `SUNDIALSFileOpen` and `SUNDIALSFileClose`
-to support user specification of `stdout` and `stderr` strings for the output
-file names.
-
-A new time-stepping module, `SPRKStep`, was added to ARKODE. This time-stepper
-provides explicit symplectic partitioned Runge-Kutta methods up to order 10 
-for separable Hamiltonian systems. 
-
 Updated CVODE, CVODES and ARKODE default behavior when returning the solution when
 the internal time has reached a user-specified stop time.  Previously, the output
 solution was interpolated to the value of `tstop`; the default is now to copy the
@@ -30,6 +26,10 @@ step in which an inequality constraint violation occurred. In this case, the
 values returned by `ARKStepGetEstLocalErrors` or `ERKStepGetEstLocalErrors` may
 have been invalid.
 
+Updated the F2003 utility routines `SUNDIALSFileOpen` and `SUNDIALSFileClose`
+to support user specification of `stdout` and `stderr` strings for the output
+file names.
+
 ## Changes to SUNDIALS in release 6.5.1
 
 Added the functions `ARKStepClearStopTime`, `ERKStepClearStopTime`,

CITATIONS.md

@@ -46,11 +46,15 @@ If any GPU features of SUNDIALS were utilized, please also cite:
 When using the ARKODE package from SUNDIALS, please also cite:
 
 ```bibtex
-@article{reynolds2022arkode,
+@article{reynolds2023arkode,
   title   = {{ARKODE: A flexible IVP solver infrastructure for one-step methods}},
   author  = {Reynolds, Daniel R and Gardner, David J and Woodward, Carol S and Chinomona, Rujeko},
-  journal = {arXiv preprint arXiv:2205.14077},
-  year    = {2022}
+  journal = {ACM Transactions on Mathematical Software},
+  volume  = {49},
+  number  = {2},
+  pages   = {1--26},
+  year    = {2023},
+  doi     = {10.1145/3594632}
 }
 ```
 
@@ -62,7 +66,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   = {2023},
-  note   = {v5.5.1}
+  note   = {v5.6.0}
 }
 ```
 
@@ -71,7 +75,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   = {2023},
-  note   = {v6.5.1}
+  note   = {v6.6.0}
 }
 ```
 
@@ -80,7 +84,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   = {2023},
-  note   = {v6.5.1}
+  note   = {v6.6.0}
 }
 ```
 
@@ -89,7 +93,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   = {2023},
-  note   = {v6.5.1}
+  note   = {v6.6.0}
 }
 ```
 
@@ -98,7 +102,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   = {2023},
-  note   = {v5.5.1}
+  note   = {v5.6.0}
 }
 ```
 
@@ -107,6 +111,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   = {2023},
-  note   = {v6.5.1}
+  note   = {v6.6.0}
 }
 ```

CMakeLists.txt

@@ -42,7 +42,7 @@ include(FindPackageHandleStandardArgs)
 # Set some variables with info on the SUNDIALS project
 set(PACKAGE_BUGREPORT "[email protected]")
 set(PACKAGE_NAME "SUNDIALS")
-set(PACKAGE_STRING "SUNDIALS 6.5.1")
+set(PACKAGE_STRING "SUNDIALS 6.6.0")
 set(PACKAGE_TARNAME "sundials")
 
 # Set SUNDIALS version numbers
@@ -51,8 +51,8 @@ message(STATUS "SUNDIALS_GIT_VERSION: ${SUNDIALS_GIT_VERSION}")
 
 # (use "" for the version label if none is needed)
 set(PACKAGE_VERSION_MAJOR "6")
-set(PACKAGE_VERSION_MINOR "5")
-set(PACKAGE_VERSION_PATCH "1")
+set(PACKAGE_VERSION_MINOR "6")
+set(PACKAGE_VERSION_PATCH "0")
 set(PACKAGE_VERSION_LABEL "")
 
 if(PACKAGE_VERSION_LABEL)
@@ -67,37 +67,37 @@ endif()
 
 # Specify the VERSION and SOVERSION for shared libraries
 
-set(arkodelib_VERSION "5.5.1")
+set(arkodelib_VERSION "5.6.0")
 set(arkodelib_SOVERSION "5")
 
-set(cvodelib_VERSION "6.5.1")
+set(cvodelib_VERSION "6.6.0")
 set(cvodelib_SOVERSION "6")
 
-set(cvodeslib_VERSION "6.5.1")
+set(cvodeslib_VERSION "6.6.0")
 set(cvodeslib_SOVERSION "6")
 
-set(idalib_VERSION "6.5.1")
+set(idalib_VERSION "6.6.0")
 set(idalib_SOVERSION "6")
 
-set(idaslib_VERSION "5.5.1")
+set(idaslib_VERSION "5.6.0")
 set(idaslib_SOVERSION "5")
 
-set(kinsollib_VERSION "6.5.1")
+set(kinsollib_VERSION "6.6.0")
 set(kinsollib_SOVERSION "6")
 
 set(cpodeslib_VERSION "0.0.0")
 set(cpodeslib_SOVERSION "0")
 
-set(nveclib_VERSION "6.5.1")
+set(nveclib_VERSION "6.6.0")
 set(nveclib_SOVERSION "6")
 
-set(sunmatrixlib_VERSION "4.5.1")
+set(sunmatrixlib_VERSION "4.6.0")
 set(sunmatrixlib_SOVERSION "4")
 
-set(sunlinsollib_VERSION "4.5.1")
+set(sunlinsollib_VERSION "4.6.0")
 set(sunlinsollib_SOVERSION "4")
 
-set(sunnonlinsollib_VERSION "3.5.1")
+set(sunnonlinsollib_VERSION "3.6.0")
 set(sunnonlinsollib_SOVERSION "3")
 
 set(sundialslib_VERSION

README.md

@@ -1,5 +1,5 @@
 # SUNDIALS: SUite of Nonlinear and DIfferential/ALgebraic equation Solvers #
-### Version 6.5.1 (Mar 2023) ###
+### Version 6.6.0 (Jul 2023) ###
 
 **Center for Applied Scientific Computing, Lawrence Livermore National Laboratory**
 
@@ -82,9 +82,9 @@ We thank Radu Serban for significant and critical past contributions.
 Other contributors to SUNDIALS include: James Almgren-Bell, Lawrence E. Banks,
 Peter N. Brown, George Byrne, Rujeko Chinomona, Scott D. Cohen, Aaron Collier,
 Keith E. Grant, Steven L. Lee, Shelby L. Lockhart, John Loffeld, Daniel McGreer,
-Slaven Peles, Cosmin Petra, H. Hunter Schwartz, Jean M. Sexton,
-Dan Shumaker, Steve G. Smith, Allan G. Taylor, Hilari C. Tiedeman, Chris White,
-Ting Yan, and Ulrike M. Yang.
+Yu Pan, Slaven Peles, Cosmin Petra, Steven B. Roberts, H. Hunter Schwartz,
+Jean M. Sexton, Dan Shumaker, Steve G. Smith, Shahbaj Sohal, Allan G. Taylor,
+Hilari C. Tiedeman, Chris White, Ting Yan, and Ulrike M. Yang.
 
 ## License ##
 

doc/arkode/examples/source/conf.py

@@ -403,9 +403,9 @@
 Other contributors to SUNDIALS include: James Almgren-Bell, Lawrence E. Banks,
 Peter N. Brown, George Byrne, Rujeko Chinomona, Scott D. Cohen, Aaron Collier,
 Keith E. Grant, Steven L. Lee, Shelby L. Lockhart, John Loffeld, Daniel McGreer,
-Slaven Peles, Cosmin Petra, H. Hunter Schwartz, Jean M. Sexton,
-Dan Shumaker, Steve G. Smith, Allan G. Taylor, Hilari C. Tiedeman, Chris White,
-Ting Yan, and Ulrike M. Yang.
+Yu Pan, Slaven Peles, Cosmin Petra, Steven B. Roberts, H. Hunter Schwartz,
+Jean M. Sexton, Dan Shumaker, Steve G. Smith, Shahbaj Sohal, Allan G. Taylor,
+Hilari C. Tiedeman, Chris White, Ting Yan, and Ulrike M. Yang.
 \clearpage
 
 % clear empty double page

doc/arkode/guide/source/Introduction.rst

@@ -133,6 +133,9 @@ Changes from previous versions
 Changes in v5.6.0
 -----------------
 
+A new time-stepping module, :ref:`SPRKStep <ARKODE.Mathematics.SPRKStep>`, was
+added to ARKODE. This time-stepper provides explicit symplectic partitioned
+Runge-Kutta methods up to order 10 for separable Hamiltonian systems.
 
 Added support for relaxation Runge-Kutta methods in ERKStep and ARKStep, see
 :numref:`ARKODE.Mathematics.Relaxation`, :numref:`ARKODE.Usage.ERKStep.Relaxation`,
@@ -143,14 +146,6 @@ default second order IMEX method in ARKStep. The explicit table is given by
 ``ARKODE_ARK2_ERK_3_1_2`` (see :numref:`Butcher.ARK2_ERK`) and the implicit
 table by ``ARKODE_ARK2_DIRK_3_1_2`` (see :numref:`Butcher.ARK2_DIRK`).
 
-Updated the F2003 utility routines :c:func:`SUNDIALSFileOpen` and :c:func:`SUNDIALSFileClose`
-to support user specification of ``stdout`` and ``stderr`` strings for the output
-file names.
-
-A new time-stepping module, :ref:`SPRKStep <ARKODE.Mathematics.SPRKStep>`, was
-added to ARKODE. This time-stepper provides explicit symplectic partitioned
-Runge-Kutta methods up to order 10 for separable Hamiltonian systems. 
-
 Updated the default ARKODE behavior when returning the solution when
 the internal time has reached a user-specified stop time.  Previously, the output
 solution was interpolated to the value of ``tstop``; the default is now to copy the
@@ -164,6 +159,10 @@ after a failed step in which an inequality constraint violation occurred. In
 this case, the values returned by :c:func:`ARKStepGetEstLocalErrors` or
 :c:func:`ERKStepGetEstLocalErrors` may have been invalid.
 
+Updated the F2003 utility routines :c:func:`SUNDIALSFileOpen` and :c:func:`SUNDIALSFileClose`
+to support user specification of ``stdout`` and ``stderr`` strings for the output
+file names.
+
 Changes in v5.5.1
 -----------------
 

doc/arkode/guide/source/Landing.rst

@@ -20,11 +20,12 @@
    Woodward. We thank Radu Serban for significant and critical past
    contributions.
 
-   Other contributors to SUNDIALS include: James Almgren-Bell, Lawrence E.
-   Banks, Peter N. Brown, George Byrne, Rujeko Chinomona, Scott D. Cohen, Aaron
-   Collier, Keith E. Grant, Steven L. Lee, Shelby L. Lockhart, John Loffeld,
-   Daniel McGreer, Slaven Peles, Cosmin Petra, H. Hunter Schwartz, Jean M.
-   Sexton, Dan Shumaker, Steve G. Smith, Allan G. Taylor, Hilari C. Tiedeman,
+   Other contributors to SUNDIALS include: James Almgren-Bell,
+   Lawrence E. Banks, Peter N. Brown, George Byrne, Rujeko Chinomona,
+   Scott D. Cohen, Aaron Collier, Keith E. Grant, Steven L. Lee,
+   Shelby L. Lockhart, John Loffeld, Daniel McGreer, Yu Pan, Slaven Peles,
+   Cosmin Petra, Steven B. Roberts, H. Hunter Schwartz, Jean M. Sexton, Dan
+   Shumaker, Steve G. Smith, Shahbaj Sohal, Allan G. Taylor, Hilari C. Tiedeman,
    Chris White, Ting Yan, and Ulrike M. Yang.
 
    .. ifconfig:: package_name != 'super'
@@ -37,11 +38,15 @@
 
       .. code-block:: latex
 
-         @article{reynolds2022arkode,
+         @article{reynolds2023arkode,
            title   = {{ARKODE: A flexible IVP solver infrastructure for one-step methods}},
            author  = {Reynolds, Daniel R and Gardner, David J and Woodward, Carol S and Chinomona, Rujeko},
-           journal = {arXiv preprint arXiv:2205.14077},
-           year    = {2022}
+           journal = {ACM Transactions on Mathematical Software},
+           volume  = {49},
+           number  = {2},
+           pages   = {1--26},
+           year    = {2023},
+           doi     = {10.1145/3594632}
          }
 
       The ARKODE documentation can be cited:

doc/cvode/guide/source/Introduction.rst

@@ -114,16 +114,16 @@ Changes from previous versions
 Changes in v6.6.0
 -----------------
 
-Updated the F2003 utility routines :c:func:`SUNDIALSFileOpen` and :c:func:`SUNDIALSFileClose`
-to support user specification of ``stdout`` and ``stderr`` strings for the output
-file names.
-
 Updated the default CVODE behavior when returning the solution when
 the internal time has reached a user-specified stop time.  Previously, the output
 solution was interpolated to the value of ``tstop``; the default is now to copy the
 internal solution vector.  Users who wish to revert to interpolation may call the
 routine :c:func:`CVodeSetInterpolateStopTime`.
 
+Updated the F2003 utility routines :c:func:`SUNDIALSFileOpen` and :c:func:`SUNDIALSFileClose`
+to support user specification of ``stdout`` and ``stderr`` strings for the output
+file names.
+
 Changes in v6.5.1
 -----------------
 

doc/cvode/guide/source/Landing.rst

@@ -27,11 +27,12 @@
    Woodward. We thank Radu Serban for significant and critical past
    contributions.
 
-   Other contributors to SUNDIALS include: James Almgren-Bell, Lawrence E.
-   Banks, Peter N. Brown, George Byrne, Rujeko Chinomona, Scott D. Cohen, Aaron
-   Collier, Keith E. Grant, Steven L. Lee, Shelby L. Lockhart, John Loffeld,
-   Daniel McGreer, Slaven Peles, Cosmin Petra, H. Hunter Schwartz, Jean M.
-   Sexton, Dan Shumaker, Steve G. Smith, Allan G. Taylor, Hilari C. Tiedeman,
+   Other contributors to SUNDIALS include: James Almgren-Bell,
+   Lawrence E. Banks, Peter N. Brown, George Byrne, Rujeko Chinomona,
+   Scott D. Cohen, Aaron Collier, Keith E. Grant, Steven L. Lee,
+   Shelby L. Lockhart, John Loffeld, Daniel McGreer, Yu Pan, Slaven Peles,
+   Cosmin Petra, Steven B. Roberts, H. Hunter Schwartz, Jean M. Sexton, Dan
+   Shumaker, Steve G. Smith, Shahbaj Sohal, Allan G. Taylor, Hilari C. Tiedeman,
    Chris White, Ting Yan, and Ulrike M. Yang.
 
    .. ifconfig:: package_name != 'super'

doc/cvodes/guide/source/Introduction.rst

@@ -114,16 +114,16 @@ Changes from previous versions
 Changes in v6.6.0
 -----------------
 
-Updated the F2003 utility routines :c:func:`SUNDIALSFileOpen` and :c:func:`SUNDIALSFileClose`
-to support user specification of ``stdout`` and ``stderr`` strings for the output
-file names.
-
 Updated the default CVODES behavior when returning the solution when
 the internal time has reached a user-specified stop time.  Previously, the output
 solution was interpolated to the value of ``tstop``; the default is now to copy the
 internal solution vector.  Users who wish to revert to interpolation may call the
 routine :c:func:`CVodeSetInterpolateStopTime`.
 
+Updated the F2003 utility routines :c:func:`SUNDIALSFileOpen` and :c:func:`SUNDIALSFileClose`
+to support user specification of ``stdout`` and ``stderr`` strings for the output
+file names.
+
 Changes in v6.5.1
 -----------------
 

doc/cvodes/guide/source/Landing.rst

@@ -27,11 +27,12 @@
    Woodward. We thank Radu Serban for significant and critical past
    contributions.
 
-   Other contributors to SUNDIALS include: James Almgren-Bell, Lawrence E.
-   Banks, Peter N. Brown, George Byrne, Rujeko Chinomona, Scott D. Cohen, Aaron
-   Collier, Keith E. Grant, Steven L. Lee, Shelby L. Lockhart, John Loffeld,
-   Daniel McGreer, Slaven Peles, Cosmin Petra, H. Hunter Schwartz, Jean M.
-   Sexton, Dan Shumaker, Steve G. Smith, Allan G. Taylor, Hilari C. Tiedeman,
+   Other contributors to SUNDIALS include: James Almgren-Bell,
+   Lawrence E. Banks, Peter N. Brown, George Byrne, Rujeko Chinomona,
+   Scott D. Cohen, Aaron Collier, Keith E. Grant, Steven L. Lee,
+   Shelby L. Lockhart, John Loffeld, Daniel McGreer, Yu Pan, Slaven Peles,
+   Cosmin Petra, Steven B. Roberts, H. Hunter Schwartz, Jean M. Sexton, Dan
+   Shumaker, Steve G. Smith, Shahbaj Sohal, Allan G. Taylor, Hilari C. Tiedeman,
    Chris White, Ting Yan, and Ulrike M. Yang.
 
    .. ifconfig:: package_name != 'super'

doc/ida/guide/source/Landing.rst

@@ -27,11 +27,12 @@
    Woodward. We thank Radu Serban for significant and critical past
    contributions.
 
-   Other contributors to SUNDIALS include: James Almgren-Bell, Lawrence E.
-   Banks, Peter N. Brown, George Byrne, Rujeko Chinomona, Scott D. Cohen, Aaron
-   Collier, Keith E. Grant, Steven L. Lee, Shelby L. Lockhart, John Loffeld,
-   Daniel McGreer, Slaven Peles, Cosmin Petra, H. Hunter Schwartz, Jean M.
-   Sexton, Dan Shumaker, Steve G. Smith, Allan G. Taylor, Hilari C. Tiedeman,
+   Other contributors to SUNDIALS include: James Almgren-Bell,
+   Lawrence E. Banks, Peter N. Brown, George Byrne, Rujeko Chinomona,
+   Scott D. Cohen, Aaron Collier, Keith E. Grant, Steven L. Lee,
+   Shelby L. Lockhart, John Loffeld, Daniel McGreer, Yu Pan, Slaven Peles,
+   Cosmin Petra, Steven B. Roberts, H. Hunter Schwartz, Jean M. Sexton, Dan
+   Shumaker, Steve G. Smith, Shahbaj Sohal, Allan G. Taylor, Hilari C. Tiedeman,
    Chris White, Ting Yan, and Ulrike M. Yang.
 
    .. ifconfig:: package_name != 'super'

doc/idas/guide/source/Introduction.rst

@@ -93,7 +93,6 @@ Updated the F2003 utility routines :c:func:`SUNDIALSFileOpen` and :c:func:`SUNDI
 to support user specification of ``stdout`` and ``stderr`` strings for the output
 file names.
 
-
 Changes in v5.5.1
 -----------------