Finished first pass at revised ARKODE documentation

LLNL · Apr 24, 2024 · 6d633d6 · 6d633d6
1 parent 05290be
commit 6d633d6
Show file tree

Hide file tree

Showing 8 changed files with 739 additions and 183 deletions.
diff --git a/doc/arkode/guide/source/Usage/ARKStep_c_interface/User_callable.rst b/doc/arkode/guide/source/Usage/ARKStep_c_interface/User_callable.rst
@@ -21,10 +21,19 @@ This section describes the ARKStep-specific functions that may be called
 by the user to setup and then solve an IVP using the ARKStep time-stepping
 module.  The large majority of these routines merely wrap :ref:`underlying
 ARKODE functions <ARKODE.Usage.UserCallable>`, and will be deprecated in an
-upcoming release -- each of these are clearly marked below.  However, some
-of these user-callable functions are specific to ARKStep, and are explained
+upcoming release -- each of these are clearly marked.  However, some
+of these user-callable functions are specific to ARKStep, as explained
 below.
 
+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.
+ARKStep supports *all categories*:
+
+* temporal adaptivity
+* implicit nonlinear and/or linear solvers
+* non-identity mass matrices
+* relaxation Runge--Kutta methods
 
 
 .. _ARKODE.Usage.ARKStep.Initialization:

diff --git a/doc/arkode/guide/source/Usage/ERKStep_c_interface/User_callable.rst b/doc/arkode/guide/source/Usage/ERKStep_c_interface/User_callable.rst
@@ -21,10 +21,18 @@ This section describes the ERKStep-specific functions that may be called
 by the user to setup and then solve an IVP using the ERKStep time-stepping
 module.  The large majority of these routines merely wrap :ref:`underlying
 ARKODE functions <ARKODE.Usage.UserCallable>`, and will be deprecated in an
-upcoming release -- each of these are clearly marked below.  However, some
-of these user-callable functions are specific to ERKStep, and are explained
+upcoming release -- each of these are clearly marked.  However, some
+of these user-callable functions are specific to ERKStep, as explained
 below.
 
+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.
+ERKStep supports the following categories:
+
+* temporal adaptivity
+* relaxation Runge--Kutta methods
+
 
 
 .. _ARKODE.Usage.ERKStep.Initialization:

diff --git a/doc/arkode/guide/source/Usage/MRIStep_c_interface/User_callable.rst b/doc/arkode/guide/source/Usage/MRIStep_c_interface/User_callable.rst
@@ -22,10 +22,17 @@ This section describes the MRIStep-specific functions that may be called
 by the user to setup and then solve an IVP using the MRIStep time-stepping
 module.  The large majority of these routines merely wrap :ref:`underlying
 ARKODE functions <ARKODE.Usage.UserCallable>`, and will be deprecated in an
-upcoming release -- each of these are clearly marked below.  However, some
-of these user-callable functions are specific to MRIStep, and are explained
+upcoming release -- each of these are clearly marked.  However, some
+of these user-callable functions are specific to ERKStep, as explained
 below.
 
+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.
+MRIStep supports the following categories:
+
+* implicit nonlinear and/or linear solvers
+
 
 
 .. _ARKODE.Usage.MRIStep.Initialization:

diff --git a/doc/arkode/guide/source/Usage/SPRKStep_c_interface/User_callable.rst b/doc/arkode/guide/source/Usage/SPRKStep_c_interface/User_callable.rst
@@ -19,10 +19,17 @@ This section describes the SPRKStep-specific functions that may be called
 by the user to setup and then solve an IVP using the SPRKStep time-stepping
 module. The large majority of these routines merely wrap :ref:`underlying
 ARKODE functions <ARKODE.Usage.UserCallable>`, and will be deprecated in an
-upcoming release -- each of these are clearly marked below.  However, some
-of these user-callable functions are specific to SPRKStep, and are explained
+upcoming release -- each of these are clearly marked.  However, some
+of these user-callable functions are specific to ERKStep, as explained
 below.
 
+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.
+SPRKStep supports only the basic set of user-callable functions, and
+does not support any of the restricted groups (time adaptivity, implicit
+solvers, etc.).
+
 
 .. _ARKODE.Usage.SPRKStep.Initialization: