Feature/arkode sts

.gitignore

@@ -36,6 +36,8 @@ compile_commands.json
 *.orig
 *.nvvp
 *.ptp-sync*
+*.project
+*.cproject
 *~
 \#*
 

doc/arkode/guide/source/Mathematics.rst

@@ -61,13 +61,15 @@ for interpolated solution output.  We then discuss the current suite
 of time-stepping modules supplied with ARKODE, including the ARKStep
 module for :ref:`additive Runge--Kutta methods <ARKODE.Mathematics.ARK>`,
 the ERKStep module that is optimized for :ref:`explicit Runge--Kutta
-methods <ARKODE.Mathematics.ERK>`, and the MRIStep module for :ref:`multirate
-infinitesimal step (MIS), multirate infinitesimal GARK (MRI-GARK), and
-implicit-explicit MRI-GARK (IMEX-MRI-GARK) methods <ARKODE.Mathematics.MRIStep>`.
-We then discuss the :ref:`adaptive temporal error controllers
-<ARKODE.Mathematics.Adaptivity>` shared by the time-stepping modules, including
-discussion of our choice of norms for measuring errors within various components
-of the solver.
+methods <ARKODE.Mathematics.ERK>`, the SPRKStep module that provides
+:ref:`symplectic partitioned Runge--Kutta methods <ARKODE.Mathematics.SPRKStep>`
+for Hamiltonian dynamics, the MRIStep module that provides a variety of
+:ref:`multirate infinitesimal methods <ARKODE.Mathematics.MRIStep>`, and the
+LSRKStep module that supports :ref:`low-storage Runge--Kutta methods
+<ARKODE.Mathematics.LSRK>`.  We then discuss the :ref:`adaptive temporal
+error controllers <ARKODE.Mathematics.Adaptivity>` shared by the time-stepping
+modules, including discussion of our choice of norms for measuring errors
+within various components of the solver.
 
 We then discuss the nonlinear and linear solver strategies used by
 ARKODE for solving implicit algebraic systems that arise in computing each
@@ -729,6 +731,20 @@ may supply their own method by defining and attaching a coupling table, see
 :numref:`ARKODE.Usage.MRIStep.MRIStepCoupling` for more information.
 
 
+.. _ARKODE.Mathematics.LSRK:
+
+LSRKStep -- Low-Storage Runge--Kutta methods
+============================================
+
+The LSRKStep time-stepping module in ARKODE supports a variety of so-called
+"low-storage" Runge--Kutta methods, including traditional explicit low-storage
+RK methods, adaptive and mixed implicit-explicit low-storage RK methods, and a
+variety of "super-time-stepping" methods.
+
+(To-Do: add discussion regarding the mathematics of these methods and citations
+of relevant papers).
+
+
 .. _ARKODE.Mathematics.Error.Norm:
 
 Error norms

doc/arkode/guide/source/Usage/LSRKStep/User_callable.rst

@@ -0,0 +1,62 @@
+.. ----------------------------------------------------------------
+   Programmer(s): Daniel R. Reynolds @ SMU
+   ----------------------------------------------------------------
+   SUNDIALS Copyright Start
+   Copyright (c) 2002-2024, Lawrence Livermore National Security
+   and Southern Methodist University.
+   All rights reserved.
+
+   See the top-level LICENSE and NOTICE files for details.
+
+   SPDX-License-Identifier: BSD-3-Clause
+   SUNDIALS Copyright End
+   ----------------------------------------------------------------
+
+.. _ARKODE.Usage.LSRKStep.UserCallable:
+
+LSRKStep User-callable functions
+==================================
+
+This section describes the LSRKStep-specific functions that may be called
+by the user to setup and then solve an IVP using the LSRKStep time-stepping
+module.  As mentioned in Section :numref:`ARKODE.Usage.UserCallable`,
+shared ARKODE-level routines may be used for the large majority of LSRKStep
+configuration and use.  In this section, we describe only those routines
+that are specific to LSRKStep.
+
+As discussed in the main :ref:`ARKODE user-callable function introduction
+<ARKODE.Usage.UserCallable>`, each of ARKODE's time-stepping modules
+clarifies the categories of user-callable functions that it supports.
+LSRKStep supports the following categories:
+
+* (fill these in)
+
+
+
+.. _ARKODE.Usage.LSRKStep.Initialization:
+
+LSRKStep initialization functions
+---------------------------------
+
+
+
+
+.. _ARKODE.Usage.LSRKStep.OptionalInputs:
+
+Optional input functions
+-------------------------
+
+
+
+.. _ARKODE.Usage.LSRKStep.OptionalOutputs:
+
+Optional output functions
+------------------------------
+
+
+
+
+.. _ARKODE.Usage.LSRKStep.Reinitialization:
+
+LSRKStep re-initialization function
+-------------------------------------

doc/arkode/guide/source/Usage/LSRKStep/index.rst

@@ -0,0 +1,30 @@
+.. ----------------------------------------------------------------
+   Programmer(s): Daniel R. Reynolds @ SMU
+   ----------------------------------------------------------------
+   SUNDIALS Copyright Start
+   Copyright (c) 2002-2024, Lawrence Livermore National Security
+   and Southern Methodist University.
+   All rights reserved.
+
+   See the top-level LICENSE and NOTICE files for details.
+
+   SPDX-License-Identifier: BSD-3-Clause
+   SUNDIALS Copyright End
+   ----------------------------------------------------------------
+
+.. _ARKODE.Usage.LSRKStep:
+
+=======================================
+Using the LSRKStep time-stepping module
+=======================================
+
+This section is concerned with the use of the LSRKStep time-stepping
+module for the solution of initial value problems (IVPs) in a C or C++
+language setting.  Usage of LSRKStep follows that of the rest of ARKODE,
+and so in this section we primarily focus on those usage aspects that
+are specific to LSRKStep.
+
+.. toctree::
+   :maxdepth: 1
+
+   User_callable

doc/arkode/guide/source/Usage/index.rst

@@ -37,8 +37,8 @@ ARKODE's time stepping modules, including "relaxation" methods and
 preconitioners.  Following our discussion of these commonalities, we
 separately discuss the usage details that that are specific to each of ARKODE's
 time stepping modules: :ref:`ARKStep <ARKODE.Usage.ARKStep>`,
-:ref:`ERKStep <ARKODE.Usage.ERKStep>`, :ref:`SPRKStep <ARKODE.Usage.SPRKStep>`
-and :ref:`MRIStep <ARKODE.Usage.MRIStep>`.
+:ref:`ERKStep <ARKODE.Usage.ERKStep>`, :ref:`SPRKStep <ARKODE.Usage.SPRKStep>`,
+:ref:`MRIStep <ARKODE.Usage.MRIStep>`, and :ref:`LSRKStep <ARKODE.Usage.LSRKStep>`.
 
 ARKODE also uses various input and output constants; these are defined as
 needed throughout this chapter, but for convenience the full list is provided
@@ -79,3 +79,4 @@ ARKBBDPRE can only be used with NVECTOR_PARALLEL.
    ERKStep/index.rst
    SPRKStep/index.rst
    MRIStep/index.rst
+   LSRKStep/index.rst

examples/arkode/C_serial/CMakeLists.txt

@@ -22,6 +22,9 @@
 set(ARKODE_examples
     # tests that are always run
     "ark_analytic\;\;"
+    "lsrk_analytic\;\;"
+    "lsrk_analytic_VarJac\;\;"
+    "erk_analytic\;\;"
     # develop tests
     "ark_analytic_mels\;\;develop"
     "ark_analytic_nonlin\;\;develop"

examples/arkode/C_serial/ark_analytic.c

@@ -193,6 +193,7 @@ int main(void)
   printf("   Total number of Newton iterations = %li\n", nni);
   printf("   Total number of linear solver convergence failures = %li\n", ncfn);
   printf("   Total number of error test failures = %li\n\n", netf);
+  printf("   \n");
 
   /* check the solution error */
   flag = check_ans(y, t, reltol, abstol);