Feature: Update Full RHS Calls

.github/workflows/double-precision.yml

@@ -4,6 +4,11 @@ name: double precision build and test with GCC+TPLs (no GPUs)
 on:
   push:
   pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
   build_and_test:
@@ -26,17 +31,17 @@ jobs:
           indexsize: ${{ matrix.indexsize }}
           precision: ${{ matrix.precision }}
       - name: Archive build files from failed build
-        uses: actions/upload-artifact@v2.2.4
+        uses: actions/upload-artifact@v3
         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@v2.2.4
+        uses: actions/upload-artifact@v3
         if: failure()
         with:
           name: output_files
           path: |
-            ${{ github.workspace }}/test/build_*/Testing/output
+            ${{ github.workspace }}/test/build_*/Testing/

.github/workflows/extended-precision.yml

@@ -3,6 +3,11 @@ name: extended precision build and test with GCC+TPLs (no GPUs)
 
 on:
   pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
   build_and_test:
@@ -25,17 +30,17 @@ jobs:
           indexsize: ${{ matrix.indexsize }}
           precision: ${{ matrix.precision }}
       - name: Archive build files from failed build
-        uses: actions/upload-artifact@v2.2.4
+        uses: actions/upload-artifact@v3
         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@v2.2.4
+        uses: actions/upload-artifact@v3
         if: failure()
         with:
           name: output_files
           path: |
-            ${{ github.workspace }}/test/build_*/Testing/output
+            ${{ github.workspace }}/test/build_*/Testing/

.github/workflows/macos-latest.yml

@@ -2,6 +2,11 @@ name: MacOS short test
 
 on:
   pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 env:
   # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)

.github/workflows/single-precision.yml

@@ -3,6 +3,11 @@ name: single precision build and test with GCC+TPLs (no GPUs)
 
 on:
   pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
   build_and_test:
@@ -25,17 +30,17 @@ jobs:
           indexsize: ${{ matrix.indexsize }}
           precision: ${{ matrix.precision }}
       - name: Archive build files from failed build
-        uses: actions/upload-artifact@v2.2.4
+        uses: actions/upload-artifact@v3
         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@v2.2.4
+        uses: actions/upload-artifact@v3
         if: failure()
         with:
           name: output_files
           path: |
-            ${{ github.workspace }}/test/build_*/Testing/output
+            ${{ github.workspace }}/test/build_*/Testing/

.github/workflows/spack-develop.yml

@@ -7,6 +7,10 @@ on:
   schedule:
   - cron: '00 22 * * *'
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   build_and_test:
     runs-on: ubuntu-latest
@@ -28,17 +32,17 @@ jobs:
           indexsize: ${{ matrix.indexsize }}
           precision: ${{ matrix.precision }}
       - name: Archive build files from failed build
-        uses: actions/upload-artifact@v2.2.4
+        uses: actions/upload-artifact@v3
         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@v2.2.4
+        uses: actions/upload-artifact@v3
         if: failure()
         with:
           name: output_files
           path: |
-            ${{ github.workspace }}/test/build_*/Testing/output
+            ${{ github.workspace }}/test/build_*/Testing/

.github/workflows/ubuntu-clang-latest.yml

@@ -2,6 +2,11 @@ name: Ubuntu (clang) short test
 
 on:
   pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 env:
   # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)

.github/workflows/windows-latest-mingw.yml

@@ -2,6 +2,11 @@ name: Windows (mingw) short test
 
 on:
   pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 env:
   # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)

.github/workflows/windows-latest.yml

@@ -2,6 +2,11 @@ name: Windows short test
 
 on:
   pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 env:
   # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)

CHANGELOG.md

@@ -54,6 +54,20 @@ the stop time. Additionally, with ARKODE, CVODE, and CVODES this fix removes an
 unnecessary interpolation of the solution at the stop time that could occur in
 this case.
 
+Fixed a bug in ERKStep where methods with `c[s-1] = 1` but `a[s-1,j] != b[j]`
+were incorrectly treated as having the first same as last (FSAL) property.
+
+Fixed a bug in `MRIStepCoupling_Write` where explicit coupling tables were not
+written to the output file pointer.
+
+ARKStep, ERKStep, MRIStep, and SPRKStep were updated to remove a potentially
+unnecessary right-hand side evaluation at the end of an integration. ARKStep was
+additionally updated to remove extra right-hand side evaluations when using an
+explicit method or an implicit method with an explicit first stage.
+
+The `MRIStepInnerStepper` class in MRIStep was updated to make supplying an
+`MRIStepInnerFullRhsFn` optional.
+
 ## Changes to SUNDIALS in release 6.6.0
 
 A new time-stepping module, `SPRKStep`, was added to ARKODE. This time-stepper

doc/README.md

@@ -0,0 +1,10 @@
+# SUNDIALS Documentation
+
+The SUNDIALS documentation is written using reStructuredText and
+[Sphinx](https://www.sphinx-doc.org/).
+
+To build the documentation with Sphinx you will need Python 3.9+. Sphinx and the
+necessary extensions can be installed using the requirements file i.e.,
+`pip install -r requirements.txt`. Additionally, building the developer
+documentation requires [Graphviz](https://graphviz.org/) for generating
+flowcharts.

doc/arkode/guide/source/ARKodeButcherTable.rst

@@ -76,33 +76,35 @@ ARKodeButcherTable functions
 .. _ARKodeButcherTable.FunctionsTable:
 .. table:: ARKodeButcherTable functions
 
-   +----------------------------------------------+------------------------------------------------------------+
-   | **Function name**                            | **Description**                                            |
-   +----------------------------------------------+------------------------------------------------------------+
-   | :c:func:`ARKodeButcherTable_LoadERK()`       | Retrieve a given explicit Butcher table by its unique ID   |
-   +----------------------------------------------+------------------------------------------------------------+
-   | :c:func:`ARKodeButcherTable_LoadERKByName()` | Retrieve a given explicit Butcher table by its unique name |
-   +----------------------------------------------+------------------------------------------------------------+
-   | :c:func:`ARKodeButcherTable_LoadDIRK()`      | Retrieve a given implicit Butcher table by its unique ID   |
-   +----------------------------------------------+------------------------------------------------------------+
-   | :c:func:`ARKodeButcherTable_LoadDIRKByName()`| Retrieve a given implicit Butcher table by its unique name |
-   +----------------------------------------------+------------------------------------------------------------+
-   | :c:func:`ARKodeButcherTable_Alloc()`         | Allocate an empty Butcher table                            |
-   +----------------------------------------------+------------------------------------------------------------+
-   | :c:func:`ARKodeButcherTable_Create()`        | Create a new Butcher table                                 |
-   +----------------------------------------------+------------------------------------------------------------+
-   | :c:func:`ARKodeButcherTable_Copy()`          | Create a copy of a Butcher table                           |
-   +----------------------------------------------+------------------------------------------------------------+
-   | :c:func:`ARKodeButcherTable_Space()`         | Get the Butcher table real and integer workspace size      |
-   +----------------------------------------------+------------------------------------------------------------+
-   | :c:func:`ARKodeButcherTable_Free()`          | Deallocate a Butcher table                                 |
-   +----------------------------------------------+------------------------------------------------------------+
-   | :c:func:`ARKodeButcherTable_Write()`         | Write the Butcher table to an output file                  |
-   +----------------------------------------------+------------------------------------------------------------+
-   | :c:func:`ARKodeButcherTable_CheckOrder()`    | Check the order of a Butcher table                         |
-   +----------------------------------------------+------------------------------------------------------------+
-   | :c:func:`ARKodeButcherTable_CheckARKOrder()` | Check the order of an ARK pair of Butcher tables           |
-   +----------------------------------------------+------------------------------------------------------------+
+   +--------------------------------------------------+------------------------------------------------------------+
+   | **Function name**                                | **Description**                                            |
+   +--------------------------------------------------+------------------------------------------------------------+
+   | :c:func:`ARKodeButcherTable_LoadERK()`           | Retrieve a given explicit Butcher table by its unique ID   |
+   +--------------------------------------------------+------------------------------------------------------------+
+   | :c:func:`ARKodeButcherTable_LoadERKByName()`     | Retrieve a given explicit Butcher table by its unique name |
+   +--------------------------------------------------+------------------------------------------------------------+
+   | :c:func:`ARKodeButcherTable_LoadDIRK()`          | Retrieve a given implicit Butcher table by its unique ID   |
+   +--------------------------------------------------+------------------------------------------------------------+
+   | :c:func:`ARKodeButcherTable_LoadDIRKByName()`    | Retrieve a given implicit Butcher table by its unique name |
+   +--------------------------------------------------+------------------------------------------------------------+
+   | :c:func:`ARKodeButcherTable_Alloc()`             | Allocate an empty Butcher table                            |
+   +--------------------------------------------------+------------------------------------------------------------+
+   | :c:func:`ARKodeButcherTable_Create()`            | Create a new Butcher table                                 |
+   +--------------------------------------------------+------------------------------------------------------------+
+   | :c:func:`ARKodeButcherTable_Copy()`              | Create a copy of a Butcher table                           |
+   +--------------------------------------------------+------------------------------------------------------------+
+   | :c:func:`ARKodeButcherTable_Space()`             | Get the Butcher table real and integer workspace size      |
+   +--------------------------------------------------+------------------------------------------------------------+
+   | :c:func:`ARKodeButcherTable_Free()`              | Deallocate a Butcher table                                 |
+   +--------------------------------------------------+------------------------------------------------------------+
+   | :c:func:`ARKodeButcherTable_Write()`             | Write the Butcher table to an output file                  |
+   +--------------------------------------------------+------------------------------------------------------------+
+   | :c:func:`ARKodeButcherTable_IsStifflyAccurate()` | Determine if ``A[stages - 1][i] == b[i]``                  |
+   +--------------------------------------------------+------------------------------------------------------------+
+   | :c:func:`ARKodeButcherTable_CheckOrder()`        | Check the order of a Butcher table                         |
+   +--------------------------------------------------+------------------------------------------------------------+
+   | :c:func:`ARKodeButcherTable_CheckARKOrder()`     | Check the order of an ARK pair of Butcher tables           |
+   +--------------------------------------------------+------------------------------------------------------------+
 
 .. c:function:: ARKodeButcherTable ARKodeButcherTable_LoadERK(ARKODE_ERKTableID emethod)
 
@@ -252,6 +254,19 @@ ARKodeButcherTable functions
       The *outfile* argument can be ``stdout`` or ``stderr``, or it
       may point to a specific file created using ``fopen``.
 
+.. c:function:: void ARKodeButcherTable_IsStifflyAccurate(ARKodeButcherTable B)
+
+   Determine if the table satisfies ``A[stages - 1][i] == b[i]``
+
+   **Arguments:**
+      * *B* -- the Butcher table.
+
+   **Returns**
+      * ``SUNTRUE`` if the method is "stiffly accurate", otherwise returns
+        ``SUNFALSE``
+
+   .. versionadded:: vX.X.X
+
 .. c:function:: int ARKodeButcherTable_CheckOrder(ARKodeButcherTable B, int* q, int* p, FILE* outfile)
 
    Determine the analytic order of accuracy for the specified Butcher

doc/arkode/guide/source/Introduction.rst

@@ -180,6 +180,21 @@ requested output time is the same as the stop time. Additionally, this fix
 removes an unnecessary interpolation of the solution at the stop time that could
 occur in this case.
 
+Fixed a bug in ERKStep where methods with :math:`c_s = 1` but
+:math:`a_{s,j} \neq b_j` were incorrectly treated as having the first same as
+last (FSAL) property.
+
+Fixed a bug in :c:func:`MRIStepCoupling_Write` where explicit coupling tables
+were not written to the output file pointer.
+
+ARKStep, ERKStep, MRIStep, and SPRKStep were updated to remove a potentially
+unnecessary right-hand side evaluation at the end of an integration. ARKStep was
+additionally updated to remove extra right-hand side evaluations when using an
+explicit method or an implicit method with an explicit first stage.
+
+The :c:type:`MRIStepInnerStepper` class in MRIStep was updated to make supplying
+an :c:func:`MRIStepInnerFullRhsFn` optional.
+
 Changes in v5.6.0
 -----------------