Feature/error handling just the core

.github/workflows/extended-precision.yml

@@ -45,3 +45,4 @@ jobs:
           name: output_files
           path: |
             ${{ github.workspace }}/test/build_*/Testing/
+

.github/workflows/single-precision.yml

@@ -45,3 +45,4 @@ jobs:
           name: output_files
           path: |
             ${{ github.workspace }}/test/build_*/Testing/
+

CHANGELOG.md

@@ -57,9 +57,49 @@ method `ARKODE_VERNER_16_8_9`.
 Changed the `SUNProfiler` so that it does not rely on `MPI_WTime` in any case.
 This fixes https://github.com/LLNL/sundials/issues/312. 
 
+**Major feature**
 SUNDIALS now has more robust and uniform error handling. See the "Error Handling"
 section in the user guide for details.
 
+**Deprecation notice**
+The functions in `sundials_math.h` will be deprecated in the next release.
+
+```c
+  sunrealtype SUNRpowerI(sunrealtype base, int exponent);
+  sunrealtype SUNRpowerR(sunrealtype base, sunrealtype exponent);
+  sunbooleantype SUNRCompare(sunrealtype a, sunrealtype b);
+  sunbooleantype SUNRCompareTol(sunrealtype a, sunrealtype b, sunrealtype tol);
+  sunrealtype SUNStrToReal(const char* str);
+```
+
+Additionally, the following header files (and everything in them) will be deprecated -- users who
+rely on these are recommended to transition to the corresponding `SUNMatrix` and `SUNLinearSolver`
+modules:
+
+```
+sundials_direct.h
+sundials_dense.h
+sundials_band.h
+```
+
+**Breaking change**
+The following functions have had their signature updated to ensure they can leverage
+the new SUNDIALS error handling capabilties. 
+
+```c
+// From sundials_futils.h
+SUNDIALSFileOpen
+SUNDIALSFileClose
+
+// From sundials_memory.h
+SUNMemorNewEmpty
+SUNMemoryHelper_Alias
+SUNMemoryHelper_Wrap
+
+// From sundials_nvector.h
+N_VNewVectorArray
+```
+
 **Breaking change** 
 We have replaced the use of a type-erased (i.e., `void*`) pointer to a
 communicator in place of `MPI_Comm` throughout the SUNDIALS API with a
@@ -93,6 +133,7 @@ This will be picked up automatically in projects that use the SUNDIALS CMake tar
 The library `sundials_generic` has been superceded by `sundials_core` and is no longer available.
 This fixes some duplicate symbol errors on Windows when linking to multiple SUNDIALS libraries.
 
+
 ## Changes to SUNDIALS in release 6.6.2
 
 Fixed the build system support for MAGMA when using a NVIDIA HPC SDK installation of CUDA

cmake/SundialsBuildOptionsPre.cmake

@@ -317,6 +317,11 @@ sundials_option(SUNDIALS_TEST_DEVTESTS BOOL
 sundials_option(SUNDIALS_TEST_UNITTESTS BOOL
   "Include unit tests in make test" OFF ADVANCED)
 
+# Include unit tests in regression tests
+sundials_option(SUNDIALS_TEST_DISABLE_GTEST BOOL
+  "Diable GTest unit tests" OFF ADVANCED)
+
+
 sundials_option(SUNDIALS_SCHEDULER_COMMAND STRING "Job scheduler command to use to launch SUNDIALS MPI tests" "" ADVANCED)
 
 sundials_option(SUNDIALS_CALIPER_OUTPUT_DIR PATH "Location to write caliper output files" "" ADVANCED)

cmake/SundialsSetupTesting.cmake

@@ -135,7 +135,7 @@ if(SUNDIALS_TEST_DEVTESTS)
 endif()
 
 # Check if unit tests are enabled
-if(SUNDIALS_TEST_UNITTESTS)
+if(SUNDIALS_TEST_UNITTESTS AND NOT SUNDIALS_TEST_DISABLE_GTEST)
   find_package(GTest)
   if(NOT (TARGET GTest::gtest_main OR TARGET GTest::Main))
     include(FetchContent)

doc/arkode/guide/source/Introduction.rst

@@ -185,8 +185,64 @@ This fixes `GitHub Issue #312 <https://github.com/LLNL/sundials/issues/312>`_.
 
 Added Fortran support for the LAPACK  dense ``SUNLinearSolver`` implementation.
 
+**Major feature**
 SUNDIALS now has more robust and uniform error handling. See :numref:`SUNDIALS.Errors` for details.
 
+**Deprecation notice**
+The functions in `sundials_math.h` will be deprecated in the next release.
+
+.. code-block:: c
+
+  sunrealtype SUNRpowerI(sunrealtype base, int exponent);
+  sunrealtype SUNRpowerR(sunrealtype base, sunrealtype exponent);
+  sunbooleantype SUNRCompare(sunrealtype a, sunrealtype b);
+  sunbooleantype SUNRCompareTol(sunrealtype a, sunrealtype b, sunrealtype tol);
+  sunrealtype SUNStrToReal(const char* str);
+
+Additionally, the following header files (and everything in them) will be deprecated -- users who
+rely on these are recommended to transition to the corresponding :c:type:`SUNMatrix` and
+:c:type:`SUNLinearSolver` modules:
+
+.. code-block:: c
+
+  sundials_direct.h
+  sundials_dense.h
+  sundials_band.h
+
+**Breaking change**
+The following functions have had their signature updated to ensure they can leverage
+the new SUNDIALS error handling capabilties. 
+
+.. code-block:: c
+
+  // From sundials_futils.h
+  SUNDIALSFileOpen
+  SUNDIALSFileClose
+
+  // From sundials_memory.h
+  SUNMemorNewEmpty
+  SUNMemoryHelper_Alias
+  SUNMemoryHelper_Wrap
+
+  // From sundials_nvector.h
+  N_VNewVectorArray
+
+**Breaking change**
+The following functions have had their signature updated to ensure they can leverage
+the new SUNDIALS error handling capabilties. 
+
+From sundials_futils.h
+* :c:func:`SUNDIALSFileOpen`
+* :c:func:`SUNDIALSFileClose`
+
+From sundials_memory.h
+* :c:func:`SUNMemorNewEmpty`
+* :c:func:`SUNMemoryHelper_Alias`
+* :c:func:`SUNMemoryHelper_Wrap`
+
+From sundials_nvector.h
+* :c:func:`N_VNewVectorArray`
+
 **Breaking change** 
 We have replaced the use of a type-erased (i.e., ``void*``) pointer to a
 communicator in place of ``MPI_Comm`` throughout the SUNDIALS API with a

doc/cvode/guide/source/Introduction.rst

@@ -137,8 +137,47 @@ This fixes `GitHub Issue #312 <https://github.com/LLNL/sundials/issues/312>`_.
 
 Added Fortran support for the LAPACK  dense ``SUNLinearSolver`` implementation.
 
+**Major feature**
 SUNDIALS now has more robust and uniform error handling. See :numref:`SUNDIALS.Errors` for details.
 
+**Deprecation notice**
+The functions in `sundials_math.h` will be deprecated in the next release.
+
+.. code-block:: c
+
+  sunrealtype SUNRpowerI(sunrealtype base, int exponent);
+  sunrealtype SUNRpowerR(sunrealtype base, sunrealtype exponent);
+  sunbooleantype SUNRCompare(sunrealtype a, sunrealtype b);
+  sunbooleantype SUNRCompareTol(sunrealtype a, sunrealtype b, sunrealtype tol);
+  sunrealtype SUNStrToReal(const char* str);
+
+Additionally, the following header files (and everything in them) will be deprecated -- users who
+rely on these are recommended to transition to the corresponding :c:type:`SUNMatrix` and
+:c:type:`SUNLinearSolver` modules:
+
+.. code-block:: c
+
+  sundials_direct.h
+  sundials_dense.h
+  sundials_band.h
+
+
+**Breaking change**
+The following functions have had their signature updated to ensure they can leverage
+the new SUNDIALS error handling capabilties. 
+
+From sundials_futils.h
+* :c:func:`SUNDIALSFileOpen`
+* :c:func:`SUNDIALSFileClose`
+
+From sundials_memory.h
+* :c:func:`SUNMemorNewEmpty`
+* :c:func:`SUNMemoryHelper_Alias`
+* :c:func:`SUNMemoryHelper_Wrap`
+
+From sundials_nvector.h
+* :c:func:`N_VNewVectorArray`
+
 **Breaking change** 
 We have replaced the use of a type-erased (i.e., ``void*``) pointer to a
 communicator in place of ``MPI_Comm`` throughout the SUNDIALS API with a

doc/cvodes/guide/source/Introduction.rst

@@ -140,8 +140,47 @@ This fixes `GitHub Issue #312 <https://github.com/LLNL/sundials/issues/312>`_.
 
 Added Fortran support for the LAPACK  dense ``SUNLinearSolver`` implementation.
 
+**Major feature**
 SUNDIALS now has more robust and uniform error handling. See :numref:`SUNDIALS.Errors` for details.
 
+**Deprecation notice**
+The functions in `sundials_math.h` will be deprecated in the next release.
+
+.. code-block:: c
+
+  sunrealtype SUNRpowerI(sunrealtype base, int exponent);
+  sunrealtype SUNRpowerR(sunrealtype base, sunrealtype exponent);
+  sunbooleantype SUNRCompare(sunrealtype a, sunrealtype b);
+  sunbooleantype SUNRCompareTol(sunrealtype a, sunrealtype b, sunrealtype tol);
+  sunrealtype SUNStrToReal(const char* str);
+
+Additionally, the following header files (and everything in them) will be deprecated -- users who
+rely on these are recommended to transition to the corresponding :c:type:`SUNMatrix` and
+:c:type:`SUNLinearSolver` modules:
+
+.. code-block:: c
+
+  sundials_direct.h
+  sundials_dense.h
+  sundials_band.h
+
+
+**Breaking change**
+The following functions have had their signature updated to ensure they can leverage
+the new SUNDIALS error handling capabilties. 
+
+From sundials_futils.h
+* :c:func:`SUNDIALSFileOpen`
+* :c:func:`SUNDIALSFileClose`
+
+From sundials_memory.h
+* :c:func:`SUNMemorNewEmpty`
+* :c:func:`SUNMemoryHelper_Alias`
+* :c:func:`SUNMemoryHelper_Wrap`
+
+From sundials_nvector.h
+* :c:func:`N_VNewVectorArray`
+
 **Breaking change** 
 We have replaced the use of a type-erased (i.e., ``void*``) pointer to a
 communicator in place of ``MPI_Comm`` throughout the SUNDIALS API with a

doc/ida/guide/source/Introduction.rst

@@ -98,8 +98,47 @@ This fixes `GitHub Issue #312 <https://github.com/LLNL/sundials/issues/312>`_.
 
 Added Fortran support for the LAPACK  dense ``SUNLinearSolver`` implementation.
 
+**Major feature**
 SUNDIALS now has more robust and uniform error handling. See :numref:`SUNDIALS.Errors` for details.
 
+**Deprecation notice**
+The functions in `sundials_math.h` will be deprecated in the next release.
+
+.. code-block:: c
+
+  sunrealtype SUNRpowerI(sunrealtype base, int exponent);
+  sunrealtype SUNRpowerR(sunrealtype base, sunrealtype exponent);
+  sunbooleantype SUNRCompare(sunrealtype a, sunrealtype b);
+  sunbooleantype SUNRCompareTol(sunrealtype a, sunrealtype b, sunrealtype tol);
+  sunrealtype SUNStrToReal(const char* str);
+
+Additionally, the following header files (and everything in them) will be deprecated -- users who
+rely on these are recommended to transition to the corresponding :c:type:`SUNMatrix` and
+:c:type:`SUNLinearSolver` modules:
+
+.. code-block:: c
+
+  sundials_direct.h
+  sundials_dense.h
+  sundials_band.h
+
+
+**Breaking change**
+The following functions have had their signature updated to ensure they can leverage
+the new SUNDIALS error handling capabilties. 
+
+From sundials_futils.h
+* :c:func:`SUNDIALSFileOpen`
+* :c:func:`SUNDIALSFileClose`
+
+From sundials_memory.h
+* :c:func:`SUNMemorNewEmpty`
+* :c:func:`SUNMemoryHelper_Alias`
+* :c:func:`SUNMemoryHelper_Wrap`
+
+From sundials_nvector.h
+* :c:func:`N_VNewVectorArray`
+
 **Breaking change** 
 We have replaced the use of a type-erased (i.e., ``void*``) pointer to a
 communicator in place of ``MPI_Comm`` throughout the SUNDIALS API with a

doc/idas/guide/source/Introduction.rst

@@ -115,8 +115,47 @@ This fixes `GitHub Issue #312 <https://github.com/LLNL/sundials/issues/312>`_.
 
 Added Fortran support for the LAPACK  dense ``SUNLinearSolver`` implementation.
 
+**Major feature**
 SUNDIALS now has more robust and uniform error handling. See :numref:`SUNDIALS.Errors` for details.
 
+**Deprecation notice**
+The functions in `sundials_math.h` will be deprecated in the next release.
+
+.. code-block:: c
+
+  sunrealtype SUNRpowerI(sunrealtype base, int exponent);
+  sunrealtype SUNRpowerR(sunrealtype base, sunrealtype exponent);
+  sunbooleantype SUNRCompare(sunrealtype a, sunrealtype b);
+  sunbooleantype SUNRCompareTol(sunrealtype a, sunrealtype b, sunrealtype tol);
+  sunrealtype SUNStrToReal(const char* str);
+
+Additionally, the following header files (and everything in them) will be deprecated -- users who
+rely on these are recommended to transition to the corresponding :c:type:`SUNMatrix` and
+:c:type:`SUNLinearSolver` modules:
+
+.. code-block:: c
+
+  sundials_direct.h
+  sundials_dense.h
+  sundials_band.h
+
+
+**Breaking change**
+The following functions have had their signature updated to ensure they can leverage
+the new SUNDIALS error handling capabilties. 
+
+From sundials_futils.h
+* :c:func:`SUNDIALSFileOpen`
+* :c:func:`SUNDIALSFileClose`
+
+From sundials_memory.h
+* :c:func:`SUNMemorNewEmpty`
+* :c:func:`SUNMemoryHelper_Alias`
+* :c:func:`SUNMemoryHelper_Wrap`
+
+From sundials_nvector.h
+* :c:func:`N_VNewVectorArray`
+
 **Breaking change** 
 We have replaced the use of a type-erased (i.e., ``void*``) pointer to a
 communicator in place of ``MPI_Comm`` throughout the SUNDIALS API with a

doc/kinsol/guide/source/Introduction.rst

@@ -107,8 +107,47 @@ CMake targets.
 
 Added Fortran support for the LAPACK  dense ``SUNLinearSolver`` implementation.
 
+**Major feature**
 SUNDIALS now has more robust and uniform error handling. See :numref:`SUNDIALS.Errors` for details.
 
+**Deprecation notice**
+The functions in `sundials_math.h` will be deprecated in the next release.
+
+.. code-block:: c
+
+  sunrealtype SUNRpowerI(sunrealtype base, int exponent);
+  sunrealtype SUNRpowerR(sunrealtype base, sunrealtype exponent);
+  sunbooleantype SUNRCompare(sunrealtype a, sunrealtype b);
+  sunbooleantype SUNRCompareTol(sunrealtype a, sunrealtype b, sunrealtype tol);
+  sunrealtype SUNStrToReal(const char* str);
+
+Additionally, the following header files (and everything in them) will be deprecated -- users who
+rely on these are recommended to transition to the corresponding :c:type:`SUNMatrix` and
+:c:type:`SUNLinearSolver` modules:
+
+.. code-block:: c
+
+  sundials_direct.h
+  sundials_dense.h
+  sundials_band.h
+
+
+**Breaking change**
+The following functions have had their signature updated to ensure they can leverage
+the new SUNDIALS error handling capabilties. 
+
+From sundials_futils.h
+* :c:func:`SUNDIALSFileOpen`
+* :c:func:`SUNDIALSFileClose`
+
+From sundials_memory.h
+* :c:func:`SUNMemorNewEmpty`
+* :c:func:`SUNMemoryHelper_Alias`
+* :c:func:`SUNMemoryHelper_Wrap`
+
+From sundials_nvector.h
+* :c:func:`N_VNewVectorArray`
+
 **Breaking change** 
 We have replaced the use of a type-erased (i.e., ``void*``) pointer to a
 communicator in place of ``MPI_Comm`` throughout the SUNDIALS API with a