Feature: Logging Updates

.github/actions/test-driver/action.yml

@@ -8,6 +8,9 @@ inputs:
   indexsize:
     description: SUNDIALS_INDEX_SIZE
     required: true
+  tpls:
+    description: "enable/disable TPLs"
+    required: true
 
 runs:
   using: composite
@@ -26,5 +29,10 @@ runs:
       run: |
         git config --global --add safe.directory $GITHUB_WORKSPACE
         cd test
-        ./test_driver.sh --testtype CUSTOM --env env/docker.sh --tpls --sunrealtype ${{ inputs.precision }} --indexsize ${{ inputs.indexsize }}
+        ./test_driver.sh \
+        --testtype CUSTOM \
+        --env env/docker.sh \
+        --tpls ${{ inputs.tpls }} \
+        --sunrealtype ${{ inputs.precision }} \
+        --indexsize ${{ inputs.indexsize }}
       shell: bash

.github/workflows/test-address-sanitizer.yml

@@ -0,0 +1,59 @@
+#
+name: Build and Test - Ubuntu/gcc (Address Sanitizer)
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+  merge_group:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref_name }}
+  cancel-in-progress: true
+
+jobs:
+  sanitizer_build_and_test:
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/llnl/sundials-ci-int${{ matrix.indexsize }}-${{ matrix.precision }}:latest
+      options: --user root
+    strategy:
+      max-parallel: 2
+      matrix:
+        indexsize: [32, 64]
+        precision: ['double']
+        buildtype: ['Debug']
+        # Address sanitizer is enabled in test_driver.sh with TPLs OFF
+        tpls: ['OFF']
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+      - name: Run test_driver.sh
+        uses: ./.github/actions/test-driver
+        with:
+          indexsize: ${{ matrix.indexsize }}
+          precision: ${{ matrix.precision }}
+          tpls: ${{ matrix.tpls }}
+        env:
+          CMAKE_BUILD_TYPE: ${{ matrix.buildtype }}
+      - name: Archive build files from failed build
+        uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: build_files
+          path: |
+            ${{ github.workspace }}/test/build_*
+            !${{ github.workspace }}/test/build_*/Testing/output
+      - name: Archive output files from failed build
+        uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: output_files
+          path: |
+            ${{ github.workspace }}/test/build_*/Testing/

.github/workflows/ubuntu-latest.yml

@@ -27,6 +27,7 @@ jobs:
         # Disable extended tests until compiler warnings are addressed
         precision: ['single', 'double']
         buildtype: ['Debug', 'Release', 'RelWithDebInfo']
+        tpls: ['ON']
         exclude:
           - buildtype: Debug
             precision: single
@@ -49,6 +50,7 @@ jobs:
         with:
           indexsize: ${{ matrix.indexsize }}
           precision: ${{ matrix.precision }}
+          tpls: ${{ matrix.tpls }}
         env:
           CMAKE_BUILD_TYPE: ${{ matrix.buildtype }}
       - name: Archive build files from failed build

CHANGELOG.md

@@ -86,6 +86,11 @@ provided.
 
 Fixed the loading of ARKStep's default first order explicit method.
 
+Fixed a bug in ARKODE when enabling rootfinding with fixed step sizes and the
+initial value of the rootfinding function is zero. In this case, uninitialized
+right-hand side data was used to compute a state value near the initial
+condition to determine if any rootfinding functions are initially active.
+
 Fixed a CMake bug regarding usage of missing "print_warning" macro
 that was only triggered when the deprecated `CUDA_ARCH` option was used.
 
@@ -104,6 +109,19 @@ not include contributions from the fast right-hand side function. With this fix,
 will see one additional fast right-hand side function evaluation per slow step with the
 Hermite interpolation option.
 
+Fixed a bug in SPRKStep when using compensated summations where the error vector
+was not initialized to zero.
+
+Fixed potential memory leaks and out of bounds array accesses that could occur
+in the ARKODE Lagrange interpolation module when changing the method order or
+polynomial degree after re-initializing an integrator.
+
+Fixed a bug in the 32-bit ``sunindextype`` Fortran interfaces to
+``N_VGetSubvectorArrayPointer_ManyVector``,
+``N_VGetSubvectorArrayPointer_MPIManyVector``, ``SUNBandMatrix_Column`` and
+``SUNDenseMatrix_Column`` where 64-bit ``sunindextype`` interface functions were
+used.
+
 Fixed a CMake configuration issue related to aliasing an `ALIAS` target when
 using `ENABLE_KLU=ON` in combination with a static-only build of SuiteSparse.
 

doc/shared/RecentChanges.rst

@@ -96,6 +96,11 @@ of ``0`` was provided.
 
 Fixed the loading of ARKStep's default first order explicit method.
 
+Fixed a bug in ARKODE when enabling rootfinding with fixed step sizes and the
+initial value of the rootfinding function is zero. In this case, uninitialized
+right-hand side data was used to compute a state value near the initial
+condition to determine if any rootfinding functions are initially active.
+
 Fixed a CMake bug regarding usage of missing "print_warning" macro
 that was only triggered when the deprecated ``CUDA_ARCH`` option was used.
 
@@ -114,6 +119,19 @@ not include contributions from the fast right-hand side function. With this fix,
 will see one additional fast right-hand side function evaluation per slow step with the
 Hermite interpolation option.
 
+Fixed a bug in SPRKStep when using compensated summations where the error vector
+was not initialized to zero.
+
+Fixed potential memory leaks and out of bounds array accesses that could occur
+in the ARKODE Lagrange interpolation module when changing the method order or
+polynomial degree after re-initializing an integrator.
+
+Fixed a bug in the 32-bit ``sunindextype`` Fortran interfaces to
+:c:func:`N_VGetSubvectorArrayPointer_ManyVector`,
+:c:func:`N_VGetSubvectorArrayPointer_MPIManyVector`,
+:c:func:`SUNBandMatrix_Column` and :c:func:`SUNDenseMatrix_Column` where 64-bit
+``sunindextype`` interface functions were used.
+
 Fixed a CMake configuration issue related to aliasing an ``ALIAS`` target when
 using ``ENABLE_KLU=ON`` in combination with a static-only build of SuiteSparse.
 

doc/superbuild/source/developers/style_guide/SourceCode.rst

@@ -502,6 +502,8 @@ Python module for parsing log files are as follows:
 
 * ``begin-linear-iterate`` / ``end-linear-iterate``
 
+* ``begin-group`` / ``end-group``
+
 * ``begin-stage`` / ``end-stage``
 
 * ``begin-fast-steps`` / ``end-fast-steps``
@@ -578,7 +580,7 @@ To log extra debugging messages use the following macros:
 .. c:macro:: SUNLogExtraDebug(logger, label, msg_txt, ...)
 
    When extra debugging logging is enabled, this macro expands to a call to
-   :c:func:`SUNLogger_QueueMsg` to log a debug message. Otherwise, this expands
+   :c:func:`SUNLogger_QueueMsg` to log an extra debug message. Otherwise, this expands
    to nothing.
 
    :param logger: the :c:type:`SUNLogger` to handle the message.
@@ -590,7 +592,7 @@ To log extra debugging messages use the following macros:
 .. c:macro:: SUNLogExtraDebugIf(condition, logger, label, msg_txt, ...)
 
    When extra debugging logging is enabled, this macro expands to a conditional
-   call to :c:func:`SUNLogger_QueueMsg` to log a debug message. Otherwise, this
+   call to :c:func:`SUNLogger_QueueMsg` to log an extra debug message. Otherwise, this
    expands to nothing.
 
    :param condition: a boolean expression that determines if the log message
@@ -604,8 +606,8 @@ To log extra debugging messages use the following macros:
 .. c:macro:: SUNLogExtraDebugVec(logger, label, vec, msg_txt, ...)
 
    When extra debugging logging is enabled, this macro expands to a call to
-   :c:func:`SUNLogger_QueueMsg` and :c:func:`N_VPrintFile` to log a debug
-   message and output the vector data. Otherwise, this expands to nothing.
+   :c:func:`SUNLogger_QueueMsg` and :c:func:`N_VPrintFile` to log an extra
+   debug message and output the vector data. Otherwise, this expands to nothing.
 
    :param logger: the :c:type:`SUNLogger` to handle the message.
    :param label: the ``const char*`` message label.
@@ -617,7 +619,7 @@ To log extra debugging messages use the following macros:
 .. c:macro:: SUNLogExtraDebugVecIf(condition, logger, label, vec, msg_txt, ...)
 
    When extra debugging logging is enabled, this macro expands to a conditional
-   call to :c:func:`SUNLogger_QueueMsg` and :c:func:`N_VPrintFile` to log a
+   call to :c:func:`SUNLogger_QueueMsg` and :c:func:`N_VPrintFile` to log an extra
    debug message and output the vector data. Otherwise, this expands to nothing.
 
    :param condition: a boolean expression that determines if the log message
@@ -633,7 +635,7 @@ To log extra debugging messages use the following macros:
 
    When extra debugging logging is enabled, this macro expands to a loop calling
    :c:func:`SUNLogger_QueueMsg` and :c:func:`N_VPrintFile` for each vector in
-   the vector array to log a debug message and output the vector data.
+   the vector array to log an extra debug message and output the vector data.
    Otherwise, this expands to nothing.
 
    :param logger: the :c:type:`SUNLogger` to handle the message.

examples/arkode/C_serial/ark_dissipated_exp_entropy.c

@@ -174,14 +174,13 @@ int main(int argc, char* argv[])
   if (check_flag(flag, "SUNContext_Create")) { return 1; }
 
   /* Create serial vector and set the initial condition values */
-  y = N_VNew_Serial(2, ctx);
+  y = N_VNew_Serial(1, ctx);
   if (check_ptr(y, "N_VNew_Serial")) { return 1; }
 
   ydata = N_VGetArrayPointer(y);
   if (check_ptr(ydata, "N_VGetArrayPointer")) { return 1; }
 
-  ydata[0] = SUN_RCONST(1.0);
-  ydata[1] = SUN_RCONST(0.5);
+  ydata[0] = SUN_RCONST(0.5);
 
   ytrue = N_VClone(y);
   if (check_ptr(ytrue, "N_VClone")) { return 1; }
@@ -208,7 +207,7 @@ int main(int argc, char* argv[])
   if (implicit)
   {
     /* Create dense matrix and linear solver */
-    A = SUNDenseMatrix(2, 2, ctx);
+    A = SUNDenseMatrix(1, 1, ctx);
     if (check_ptr(A, "SUNDenseMatrix")) { return 1; }
 
     LS = SUNLinSol_Dense(y, A, ctx);
@@ -445,7 +444,7 @@ int JacEnt(N_Vector y, N_Vector J, void* user_data)
 int ans(sunrealtype t, N_Vector y)
 {
   sunrealtype* ydata = N_VGetArrayPointer(y);
-  ydata[0]           = LOG(EXP(SUN_RCONST(-0.5)) + t);
+  ydata[0]           = -LOG(EXP(SUN_RCONST(-0.5)) + t);
   return 0;
 }
 

examples/arkode/C_serial/ark_dissipated_exp_entropy_1_0.out

@@ -7,20 +7,19 @@ Dissipated Exponential Entropy problem:
 
  step   t              u              e              u_err          delta e
  -------------------------------------------------------------------------------
-    0   0.000000e+00   1.000000e+00   2.718282e+00   0.000000e+00   0.000000e+00
-   40   4.675332e-01   1.798296e-01   1.197013e+00   1.083801e-01  -1.521269e+00
-   80   1.147092e+00  -4.153968e-01   6.600783e-01  -9.770808e-01  -2.058204e+00
-  120   3.654055e+00  -1.391763e+00   2.486366e-01  -2.841170e+00  -2.469645e+00
+    0   0.000000e+00   5.000000e-01   1.648721e+00   0.000000e+00   0.000000e+00
+   40   5.092477e-01  -1.095523e-01   8.962353e-01   2.657564e-09  -7.524860e-01
+   80   1.755130e+00  -8.593651e-01   4.234308e-01   5.763892e-09  -1.225290e+00
  -------------------------------------------------------------------------------
 
 Final Solver Statistics:
-   Internal solver steps = 130 (attempted = 130)
-   Total number of error test failures = 0
-   Total RHS evals:  Fe = 652,  Fi = 0
-   Total Relaxation Fn evals    = 391
-   Total Relaxation Jac evals   = 781
+   Internal solver steps = 116 (attempted = 118)
+   Total number of error test failures = 2
+   Total RHS evals:  Fe = 590,  Fi = 0
+   Total Relaxation Fn evals    = 353
+   Total Relaxation Jac evals   = 707
    Total Relaxation fails       = 0
    Total Relaxation bound fails = 0
    Total Relaxation NLS fails   = 0
-   Total Relaxation NLS iters   = 131
+   Total Relaxation NLS iters   = 117
 

examples/arkode/C_serial/ark_dissipated_exp_entropy_1_1.out

@@ -7,53 +7,54 @@ Dissipated Exponential Entropy problem:
 
  step   t              u              e              u_err          delta e
  -------------------------------------------------------------------------------
-    0   0.000000e+00   1.000000e+00   2.718282e+00   0.000000e+00   0.000000e+00
-   40   5.537896e-02   8.597725e-01   2.362623e+00   1.272399e+00  -3.556587e-01
-   80   1.099922e-01   7.384132e-01   2.092612e+00   1.071758e+00  -6.256694e-01
-  120   1.627168e-01   6.337541e-01   1.884673e+00   8.960967e-01  -8.336092e-01
-  160   2.138163e-01   5.418080e-01   1.719112e+00   7.398360e-01  -9.991696e-01
-  200   2.785993e-01   4.362152e-01   1.546842e+00   5.582361e-01  -1.171440e+00
-  240   3.461651e-01   3.368102e-01   1.400473e+00   3.852698e-01  -1.317809e+00
-  280   4.117847e-01   2.488924e-01   1.282604e+00   2.307427e-01  -1.435678e+00
-  320   4.756921e-01   1.701108e-01   1.185436e+00   9.109375e-02  -1.532846e+00
-  360   5.336712e-01   1.036393e-01   1.109200e+00  -2.756595e-02  -1.609081e+00
-  400   5.801378e-01   5.338279e-02   1.054833e+00  -1.177670e-01  -1.663448e+00
-  440   6.128657e-01   1.944281e-02   1.019633e+00  -1.789132e-01  -1.698649e+00
-  480   6.300899e-01   2.032891e-03   1.002035e+00  -2.103494e-01  -1.716247e+00
-  520   6.349961e-01  -2.871232e-03   9.971329e-01  -2.192131e-01  -1.721149e+00
-  560   6.468398e-01  -1.461180e-02   9.854944e-01  -2.404481e-01  -1.732787e+00
-  600   6.694857e-01  -3.668375e-02   9.639809e-01  -2.804267e-01  -1.754301e+00
-  640   7.021782e-01  -6.771234e-02   9.345293e-01  -3.367534e-01  -1.783753e+00
-  680   7.458296e-01  -1.076957e-01   8.979008e-01  -4.095471e-01  -1.820381e+00
-  720   8.007408e-01  -1.558236e-01   8.557101e-01  -4.974763e-01  -1.862572e+00
-  760   8.752295e-01  -2.176153e-01   8.044349e-01  -6.108460e-01  -1.913847e+00
-  800   9.636774e-01  -2.863486e-01   7.510008e-01  -7.375568e-01  -1.967281e+00
-  840   1.066491e+00  -3.607260e-01   6.971700e-01  -8.753575e-01  -2.021112e+00
-  880   1.204472e+00  -4.525717e-01   6.359904e-01  -1.046452e+00  -2.082291e+00
-  920   1.362583e+00  -5.483883e-01   5.778804e-01  -1.225972e+00  -2.140401e+00
-  960   1.551610e+00  -6.520589e-01   5.209720e-01  -1.421306e+00  -2.197310e+00
- 1000   1.797284e+00  -7.724955e-01   4.618590e-01  -1.649552e+00  -2.256423e+00
- 1040   2.083087e+00  -8.964821e-01   4.080024e-01  -1.885881e+00  -2.310279e+00
- 1080   2.422755e+00  -1.026269e+00   3.583416e-01  -2.134596e+00  -2.359940e+00
- 1120   2.874633e+00  -1.176348e+00   3.084029e-01  -2.423715e+00  -2.409879e+00
- 1160   3.418118e+00  -1.331309e+00   2.641313e-01  -2.723747e+00  -2.454151e+00
- 1200   4.078701e+00  -1.492135e+00   2.248921e-01  -3.036550e+00  -2.493390e+00
- 1240   4.884676e+00  -1.658714e+00   1.903836e-01  -3.361862e+00  -2.527898e+00
+    0   0.000000e+00   5.000000e-01   1.648721e+00   0.000000e+00   0.000000e+00
+   40   5.415674e-02   4.144745e-01   1.513575e+00   4.128002e-08  -1.351461e-01
+   80   1.081866e-01   3.358683e-01   1.399155e+00   6.309560e-08  -2.495665e-01
+  120   1.608974e-01   2.647106e-01   1.303054e+00   7.765270e-08  -3.456674e-01
+  160   2.124232e-01   1.997276e-01   1.221070e+00   8.845053e-08  -4.276512e-01
+  200   2.628598e-01   1.399630e-01   1.150231e+00   9.362293e-08  -4.984900e-01
+  240   3.084856e-01   8.881351e-02   1.092877e+00   7.376738e-08  -5.558444e-01
+  280   3.455218e-01   4.913523e-02   1.050362e+00   6.221645e-08  -5.983589e-01
+  320   3.727057e-01   2.098228e-02   1.021204e+00   5.764933e-08  -6.275173e-01
+  360   3.890271e-01   4.452145e-03   1.004462e+00   5.523737e-08  -6.442592e-01
+  400   3.941524e-01  -6.827931e-04   9.993174e-01   5.497047e-08  -6.494038e-01
+  440   4.005241e-01  -7.029981e-03   9.929947e-01   5.474605e-08  -6.557266e-01
+  480   4.140846e-01  -2.040562e-02   9.798012e-01   5.453027e-08  -6.689201e-01
+  520   4.345895e-01  -4.029720e-02   9.605039e-01   5.467294e-08  -6.882173e-01
+  560   4.626231e-01  -6.686741e-02   9.353192e-01   5.520839e-08  -7.134021e-01
+  600   4.973590e-01  -9.883992e-02   9.058877e-01   5.899048e-08  -7.428336e-01
+  640   5.432713e-01  -1.395897e-01   8.697150e-01   6.097036e-08  -7.790062e-01
+  680   5.987904e-01  -1.867459e-01   8.296545e-01   6.604792e-08  -8.190667e-01
+  720   6.615702e-01  -2.375203e-01   7.885809e-01   7.096595e-08  -8.601404e-01
+  760   7.441152e-01  -3.005828e-01   7.403866e-01   8.639873e-08  -9.083347e-01
+  800   8.291615e-01  -3.616470e-01   6.965282e-01   9.435878e-08  -9.521931e-01
+  840   9.468128e-01  -4.404095e-01   6.437727e-01   1.147833e-07  -1.004949e+00
+  880   1.069867e+00  -5.166468e-01   5.965174e-01   1.384619e-07  -1.052204e+00
+  920   1.227474e+00  -6.065017e-01   5.452550e-01   1.625221e-07  -1.103466e+00
+  960   1.404582e+00  -6.986879e-01   4.972373e-01   1.907560e-07  -1.151484e+00
+ 1000   1.614505e+00  -7.979735e-01   4.502405e-01   2.176350e-07  -1.198481e+00
+ 1040   1.872242e+00  -9.077633e-01   4.034256e-01   2.731687e-07  -1.245296e+00
+ 1080   2.149170e+00  -1.013671e+00   3.628843e-01   2.957052e-07  -1.285837e+00
+ 1120   2.524196e+00  -1.141265e+00   3.194148e-01   3.419873e-07  -1.329306e+00
+ 1160   2.940656e+00  -1.266154e+00   2.819137e-01   4.138031e-07  -1.366808e+00
+ 1200   3.435286e+00  -1.396694e+00   2.474136e-01   4.319564e-07  -1.401308e+00
+ 1240   4.068492e+00  -1.542234e+00   2.139028e-01   4.695475e-07  -1.434818e+00
+ 1280   4.793715e+00  -1.686444e+00   1.851769e-01   5.328542e-07  -1.463544e+00
  -------------------------------------------------------------------------------
 
 Final Solver Statistics:
-   Internal solver steps = 1245 (attempted = 1246)
+   Internal solver steps = 1290 (attempted = 1291)
    Total number of error test failures = 1
-   Total RHS evals:  Fe = 0,  Fi = 10907
-   Total number of Newton iterations = 7168
-   Total number of linear solver convergence failures = 111
-   Total linear solver setups = 179
-   Total number of Jacobian evaluations = 125
+   Total RHS evals:  Fe = 0,  Fi = 11269
+   Total number of Newton iterations = 7395
+   Total number of linear solver convergence failures = 119
+   Total linear solver setups = 190
+   Total number of Jacobian evaluations = 134
    Total RHS evals for setting up the linear system = 0
-   Total Relaxation Fn evals    = 4401
-   Total Relaxation Jac evals   = 5647
+   Total Relaxation Fn evals    = 4371
+   Total Relaxation Jac evals   = 5662
    Total Relaxation fails       = 0
    Total Relaxation bound fails = 0
    Total Relaxation NLS fails   = 0
-   Total Relaxation NLS iters   = 1909
+   Total Relaxation NLS iters   = 1789
 

examples/arkode/C_serial/ark_kepler_--stepper_SPRK_--step-mode_fixed_--count-orbits_--use-compensated-sums.out

@@ -135,5 +135,5 @@ Initial step size            = 0.01
 Last step size               = 0.01
 Current step size            = 0.01
 Root fn evals                = 10280
-f1 RHS fn evals              = 40031
-f2 RHS fn evals              = 40031
+f1 RHS fn evals              = 40032
+f2 RHS fn evals              = 40032

examples/arkode/F2003_serial/ark_roberts_dns_f2003.f90

@@ -435,6 +435,7 @@ program main
   retval = FSUNLinSolFree(sunlinsol_LS)
   call FSUNMatDestroy(sunmat_A)
   call FN_VDestroy(sunvec_y)
+  call FN_VDestroy(sunvec_f)
   call FN_VDestroy(sunvec_dky)
   call FN_VDestroy(sunvec_av)
   retval = FSUNContext_Free(sunctx)