Moved duplicated SUNStepper overview to shared folder

LLNL · Oct 25, 2024 · 51406bc · 51406bc
1 parent 9f483e0
commit 51406bc
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 51 deletions.
diff --git a/doc/arkode/guide/source/sunstepper/index.rst b/doc/arkode/guide/source/sunstepper/index.rst
@@ -12,31 +12,7 @@
    SUNDIALS Copyright End
    ----------------------------------------------------------------
 
-.. _SUNStepper:
-
-#####################################
-Stepper Data Structure
-#####################################
-
-This section presents the :c:type:`SUNStepper` base class which represents a
-generic solution procedure for IVPs of the form
-
-.. math::
-   \dot{v}(t) = f(t, v) + r(t), \qquad v(t_0) = v_0,
-   :label: SUNStepper_IVP
-
-on an interval :math:`t \in [t_0, t_f]`. The time dependent forcing term,
-:math:`r_i(t)`, is given by
-
-.. math::
-   r(t) = \sum_{k = 0}^{n_{\text{forcing}}-1}
-   \left( \frac{t - t_{\text{shift}}}{t_{\text{scale}}} \right)^{k} \widehat{f}_k.
-   :label: SUNStepper_forcing
-
-:c:type:`SUNStepper` provides an abstraction over SUNDIALS integrators, custom
-integrators, exact solution procedures, or other approaches for solving
-:eq:`SUNStepper_IVP`. These are used, for example, in operator splitting and
-forcing methods to solve inner IVPs in a flexible way.
+.. include:: ../../../../shared/sunstepper/SUNStepper_Structure.rst
 
 .. toctree::
    :maxdepth: 1

diff --git a/doc/shared/sunstepper/SUNStepper_Description.rst b/doc/shared/sunstepper/SUNStepper_Description.rst
@@ -302,7 +302,7 @@ abstract base class.
 .. c:type:: SUNErrCode (*SUNStepperFullRhsFn)(SUNStepper stepper, sunrealtype t, N_Vector v, N_Vector f)
 
    This type represents a function with the signature of
-   :c:func:`SUNStepper_FullRhsFn`.
+   :c:func:`SUNStepper_FullRhs`.
 
 
 .. c:type:: SUNErrCode (*SUNStepperResetFn)(SUNStepper stepper, sunrealtype tR, N_Vector vR)

diff --git a/doc/shared/sunstepper/SUNStepper_Structure.rst b/doc/shared/sunstepper/SUNStepper_Structure.rst
@@ -0,0 +1,39 @@
+.. ----------------------------------------------------------------
+   Programmer(s): Steven B. Roberts @ LLNL
+   ----------------------------------------------------------------
+   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
+   ----------------------------------------------------------------
+
+.. _SUNStepper:
+
+#####################################
+Stepper Data Structure
+#####################################
+
+This section presents the :c:type:`SUNStepper` base class which represents a
+generic solution procedure for IVPs of the form
+
+.. math::
+   \dot{v}(t) = f(t, v) + r(t), \qquad v(t_0) = v_0,
+   :label: SUNStepper_IVP
+
+on an interval :math:`t \in [t_0, t_f]`. The time dependent forcing term,
+:math:`r_i(t)`, is given by
+
+.. math::
+   r(t) = \sum_{k = 0}^{n_{\text{forcing}}-1}
+   \left( \frac{t - t_{\text{shift}}}{t_{\text{scale}}} \right)^{k} \widehat{f}_k.
+   :label: SUNStepper_forcing
+
+:c:type:`SUNStepper` provides an abstraction over SUNDIALS integrators, custom
+integrators, exact solution procedures, or other approaches for solving
+:eq:`SUNStepper_IVP`. These are used, for example, in operator splitting and
+forcing methods to solve inner IVPs in a flexible way.
diff --git a/doc/superbuild/source/sunstepper/index.rst b/doc/superbuild/source/sunstepper/index.rst
@@ -12,31 +12,7 @@
    SUNDIALS Copyright End
    ----------------------------------------------------------------
 
-.. _SUNStepper:
-
-#####################################
-Stepper Data Structure
-#####################################
-
-This section presents the :c:type:`SUNStepper` base class which represents a
-generic solution procedure for IVPs of the form
-
-.. math::
-   \dot{v}(t) = f(t, v) + r(t), \qquad v(t_0) = v_0,
-   :label: SUNStepper_IVP
-
-on an interval :math:`t \in [t_0, t_f]`. The time dependent forcing term,
-:math:`r_i(t)`, is given by
-
-.. math::
-   r(t) = \sum_{k = 0}^{n_{\text{forcing}}}
-   \frac{t - t_{\text{shift}}}{t_{\text{scale}}} \widehat{f}_k.
-   :label: SUNStepper_forcing
-
-:c:type:`SUNStepper` provides an abstraction over SUNDIALS integrators, custom
-integrators, exact solution procedures, or other approaches for solving
-:eq:`SUNStepper_IVP`. These are used, for example, in operator splitting and
-forcing methods to solve inner IVPs in a flexible way.
+.. include:: ../../../shared/sunstepper/SUNStepper_Structure.rst
 
 .. toctree::
    :maxdepth: 1