move sunorg1 figure to start of "Using SUNDIALS"

LLNL · Mar 28, 2024 · 4e371d1 · 4e371d1
1 parent 99cc735
commit 4e371d1
Show file tree

Hide file tree

Showing 20 changed files with 73 additions and 158 deletions.
diff --git a/doc/arkode/guide/source/Introduction.rst b/doc/arkode/guide/source/Introduction.rst
@@ -149,8 +149,8 @@ The structure of this document is as follows:
   underlying :ref:`mathematical algorithms <ARKODE.Mathematics>` used within
   the ARKODE family of solvers.
 
-* We follow this with an overview of how the source code for both
-  SUNDIALS and ARKODE are :ref:`organized <ARKODE.Organization>`.
+* We follow this with an overview of how the source code for
+  ARKODE is :ref:`organized <ARKODE.Organization>`.
 
 * The largest section follows, providing a full account of how to use
   ARKODE's time-stepping modules, :ref:`ARKStep <ARKODE.Usage.ARKStep>`,

diff --git a/doc/arkode/guide/source/Organization.rst b/doc/arkode/guide/source/Organization.rst
@@ -18,16 +18,6 @@
 Code Organization
 *****************
 
-.. ifconfig:: package_name != 'super'
-
-   .. include:: ../../../shared/SundialsOrganization.rst
-
-
-.. _ARKODE.Organization.ARKODE:
-
-ARKODE organization
-===================
-
 The ARKODE package is written in the ANSI C language.  The
 following summarizes the basic structure of the package, although
 knowledge of this structure is not necessary for its use.

diff --git a/doc/arkode/guide/source/sundials/index.rst b/doc/arkode/guide/source/sundials/index.rst
@@ -16,11 +16,15 @@
 Using SUNDIALS
 **************
 
-As discussed in :numref:`ARKODE.Organization`, the six solvers packages
-(CVODE(S), IDA(S), ARKODE, KINSOL) that make up SUNDIALS are built upon common
-classes/modules for vectors, matrices, and algebraic solvers. In addition, the
-six packages all leverage some other common infrastructure, which we discuss
-in this section.
+.. _Organization.Sundials.HighLevelDiagram:
+.. figure:: ../figs/sunorg1.png
+   :align: center
+
+   High-level diagram of the SUNDIALS suite.
+
+The packages that make up SUNDIALS are built upon shared classes for vectors,
+matrices, and algebraic solvers. In addition, the packages all leverage some
+other common infrastructure, which we discuss in this section.
 
 .. toctree::
    Types_link

diff --git a/doc/cvode/guide/source/Introduction.rst b/doc/cvode/guide/source/Introduction.rst
@@ -154,9 +154,8 @@ The structure of this document is as follows:
    detection (:numref:`CVODE.Mathematics.stablimit`), and rootfinding
    (:numref:`CVODE.Mathematics.rootfinding`).
 
--  The following chapter describes the structure of the SUNDIALS
-   suite of solvers (:numref:`CVODE.Organization`) and the software
-   organization of the CVODE solver (:numref:`CVODE.Organization.CVODE`).
+-  The following chapter describes the software organization of the CVODE
+   solver (:numref:`CVODE.Organization`).
 
 -  :numref:`CVODE.Usage.CC` is the main usage document
    for CVODE for C applications. It includes a complete

diff --git a/doc/cvode/guide/source/Organization.rst b/doc/cvode/guide/source/Organization.rst
@@ -16,16 +16,6 @@
 Code Organization
 *****************
 
-.. ifconfig:: package_name != 'super'
-
-   .. include:: ../../../shared/SundialsOrganization.rst
-
-
-.. _CVODE.Organization.CVODE:
-
-CVODE organization
-==================
-
 The CVODE package is written in ANSI C. The following summarizes
 the basic structure of the package, although knowledge of this structure
 is not necessary for its use.

diff --git a/doc/cvode/guide/source/sundials/index.rst b/doc/cvode/guide/source/sundials/index.rst
@@ -16,11 +16,15 @@
 Using SUNDIALS
 **************
 
-As discussed in :numref:`CVODE.Organization`, the six solvers packages
-(CVODE(S), IDA(S), ARKODE, KINSOL) that make up SUNDIALS are built upon common
-classes/modules for vectors, matrices, and algebraic solvers. In addition, the
-six packages all leverage some other common infrastructure, which we discuss
-in this section.
+.. _Organization.Sundials.HighLevelDiagram:
+.. figure:: ../figs/sunorg1.png
+   :align: center
+
+   High-level diagram of the SUNDIALS suite.
+
+The packages that make up SUNDIALS are built upon shared classes for vectors,
+matrices, and algebraic solvers. In addition, the packages all leverage some
+other common infrastructure, which we discuss in this section.
 
 .. toctree::
    Types_link

diff --git a/doc/cvodes/guide/source/Introduction.rst b/doc/cvodes/guide/source/Introduction.rst
@@ -167,9 +167,8 @@ The structure of this document is as follows:
    (:numref:`CVODES.Mathematics.FSA`) and adjoint
    (:numref:`CVODES.Mathematics.ASA`).
 
--  The following chapter describes the structure of the SUNDIALS suite of solvers
-   (:numref:`CVODES.Organization`) and the software organization of the CVODES solver
-   (:numref:`CVODES.Organization.CVODES`).
+-  The following chapter describes the software organization of the CVODES
+   solver (:numref:`CVODES.Organization`).
 
 -  Chapter :numref:`CVODES.Usage.SIM` is the main usage document for CVODES for simulation applications.
    It includes a complete description of the user interface for the integration
@@ -195,7 +194,7 @@ The structure of this document is as follows:
 -  Chapter :numref:`NVectors` gives a brief overview of the generic ``N_Vector`` module shared among the
    various components of SUNDIALS, and details on the ``N_Vector`` implementations provided with SUNDIALS.
 
-- Chapter :numref:`SUNMatrix` gives a brief overview of the generic
+-  Chapter :numref:`SUNMatrix` gives a brief overview of the generic
    ``SUNMatrix`` module shared among the various components of SUNDIALS, and
    details on the ``SUNMatrix`` implementations provided with SUNDIALS: a dense
    implementation (:numref:`SUNMatrix.Dense`), a banded implementation

diff --git a/doc/cvodes/guide/source/Organization.rst b/doc/cvodes/guide/source/Organization.rst
@@ -16,16 +16,6 @@
 Code Organization
 *****************
 
-.. ifconfig:: package_name != 'super'
-
-   .. include:: ../../../shared/SundialsOrganization.rst
-
-
-.. _CVODES.Organization.CVODES:
-
-CVODES organization
-===================
-
 The CVODES package is written in ANSI C. The following summarizes
 the basic structure of the package, although knowledge of this structure
 is not necessary for its use.

diff --git a/doc/cvodes/guide/source/sundials/index.rst b/doc/cvodes/guide/source/sundials/index.rst
@@ -16,11 +16,15 @@
 Using SUNDIALS
 **************
 
-As discussed in :numref:`CVODES.Organization`, the six solvers packages
-(CVODE(S), IDA(S), ARKODE, KINSOL) that make up SUNDIALS are built upon common
-classes/modules for vectors, matrices, and algebraic solvers. In addition, the
-six packages all leverage some other common infrastructure, which we discuss
-in this section.
+.. _Organization.Sundials.HighLevelDiagram:
+.. figure:: ../figs/sunorg1.png
+   :align: center
+
+   High-level diagram of the SUNDIALS suite.
+
+The packages that make up SUNDIALS are built upon shared classes for vectors,
+matrices, and algebraic solvers. In addition, the packages all leverage some
+other common infrastructure, which we discuss in this section.
 
 .. toctree::
    Types_link

diff --git a/doc/ida/guide/source/Introduction.rst b/doc/ida/guide/source/Introduction.rst
@@ -90,9 +90,8 @@ The structure of this document is as follows:
   (:numref:`IDA.Mathematics.Preconditioning`) and rootfinding
   (:numref:`IDA.Mathematics.rootfinding`).
 
-* The following chapter describes the structure of the SUNDIALS suite of solvers
-  (:numref:`IDA.Organization`) and the software organization of the IDA solver
-  (:numref:`IDA.Organization.IDA`).
+* The following chapter describes the software organization of the IDA
+  solver (:numref:`IDA.Organization`).
 
 * Chapter :numref:`IDA.Usage.CC` is the main usage document for IDA for C and C++
   applications. It includes a complete description of the user interface for the

diff --git a/doc/ida/guide/source/Organization.rst b/doc/ida/guide/source/Organization.rst
@@ -16,16 +16,6 @@
 Code Organization
 *****************
 
-.. ifconfig:: package_name != 'super'
-
-   .. include:: ../../../shared/SundialsOrganization.rst
-
-
-.. _IDA.Organization.IDA:
-
-IDA organization
-================
-
 The IDA package is written in ANSI C. The following summarizes the basic
 structure of the package, although knowledge of this structure is not necessary
 for its use.

diff --git a/doc/ida/guide/source/sundials/index.rst b/doc/ida/guide/source/sundials/index.rst
@@ -16,11 +16,15 @@
 Using SUNDIALS
 **************
 
-As discussed in :numref:`IDA.Organization`, the six solvers packages
-(CVODE(S), IDA(S), ARKODE, KINSOL) that make up SUNDIALS are built upon common
-classes/modules for vectors, matrices, and algebraic solvers. In addition, the
-six packages all leverage some other common infrastructure, which we discuss
-in this section.
+.. _Organization.Sundials.HighLevelDiagram:
+.. figure:: ../figs/sunorg1.png
+   :align: center
+
+   High-level diagram of the SUNDIALS suite.
+
+The packages that make up SUNDIALS are built upon shared classes for vectors,
+matrices, and algebraic solvers. In addition, the packages all leverage some
+other common infrastructure, which we discuss in this section.
 
 .. toctree::
    Types_link

diff --git a/doc/idas/guide/source/Introduction.rst b/doc/idas/guide/source/Introduction.rst
@@ -104,9 +104,8 @@ The structure of this document is as follows:
   (:numref:`IDAS.Mathematics.Preconditioning`) and rootfinding
   (:numref:`IDAS.Mathematics.rootfinding`).
 
-* The following chapter describes the structure of the SUNDIALS suite of solvers
-  (:numref:`IDAS.Organization`) and the software organization of the IDAS solver
-  (:numref:`IDAS.Organization.IDAS`).
+* The following chapter describes the software organization of the IDAS
+  solver (:numref:`IDAS.Organization`).
 
 * Chapter :numref:`IDAS.Usage.SIM` is the main usage document for IDAS
   for simulation applications. It includes a complete description of the user

diff --git a/doc/idas/guide/source/Organization.rst b/doc/idas/guide/source/Organization.rst
@@ -16,16 +16,6 @@
 Code Organization
 *****************
 
-.. ifconfig:: package_name != 'super'
-
-   .. include:: ../../../shared/SundialsOrganization.rst
-
-
-.. _IDAS.Organization.IDAS:
-
-IDAS organization
-=================
-
 The IDAS package is written in ANSI C. The following summarizes the basic
 structure of the package, although knowledge of this structure is not necessary
 for its use.

diff --git a/doc/idas/guide/source/sundials/index.rst b/doc/idas/guide/source/sundials/index.rst
@@ -16,10 +16,15 @@
 Using SUNDIALS
 **************
 
-As discussed in :numref:`IDAS.Organization`, the all SUNDIALS packages are built upon
-a common set of interfaces for vectors, matrices, and algebraic solvers. In
-addition, the packages all leverage some other common infrastructure discussed
-in this section.
+.. _Organization.Sundials.HighLevelDiagram:
+.. figure:: ../figs/sunorg1.png
+   :align: center
+
+   High-level diagram of the SUNDIALS suite.
+
+The packages that make up SUNDIALS are built upon shared classes for vectors,
+matrices, and algebraic solvers. In addition, the packages all leverage some
+other common infrastructure, which we discuss in this section.
 
 .. toctree::
    Types_link

diff --git a/doc/kinsol/guide/source/Introduction.rst b/doc/kinsol/guide/source/Introduction.rst
@@ -115,9 +115,8 @@ The structure of this document is as follows:
 -  In Chapter :numref:`KINSOL.Mathematics`, we provide short descriptions of the numerical methods implemented by KINSOL
    for the solution of nonlinear systems.
 
--  The following chapter describes the structure of the SUNDIALS suite of solvers
-   (:numref:`KINSOL.Organization`) and the software organization of the KINSOL solver
-   (:numref:`KINSOL.Organization.KINSOL`).
+-  The following chapter describes the software organization of the KINSOL
+   solver (:numref:`KINSOL.Organization`).
 
 -  Chapter :numref:KINSOL.Usage.CC is the main usage document for KINSOL for C applications. It includes a
    complete description of the user interface for the solution of nonlinear algebraic systems.

diff --git a/doc/kinsol/guide/source/Organization.rst b/doc/kinsol/guide/source/Organization.rst
@@ -16,16 +16,6 @@
 Code Organization
 *****************
 
-.. ifconfig:: package_name != 'super'
-
-   .. include:: ../../../shared/SundialsOrganization.rst
-
-
-.. _KINSOL.Organization.KINSOL:
-
-KINSOL organization
-===================
-
 The KINSOL package is written in ANSI C. The following summarizes the basic
 structure of the package, although knowledge of this structure is not necessary
 for its use.

diff --git a/doc/kinsol/guide/source/sundials/index.rst b/doc/kinsol/guide/source/sundials/index.rst
@@ -16,11 +16,15 @@
 Using SUNDIALS
 **************
 
-As discussed in :numref:`KINSOL.Organization`, the six solvers packages
-(CVODE(S), IDA(S), ARKODE, KINSOL) that make up SUNDIALS are built upon common
-classes/modules for vectors, matrices, and algebraic solvers. In addition, the
-six packages all leverage some other common infrastructure, which we discuss
-in this section.
+.. _Organization.Sundials.HighLevelDiagram:
+.. figure:: ../figs/sunorg1.png
+   :align: center
+
+   High-level diagram of the SUNDIALS suite.
+
+The packages that make up SUNDIALS are built upon shared classes for vectors,
+matrices, and algebraic solvers. In addition, the packages all leverage some
+other common infrastructure, which we discuss in this section.
 
 .. toctree::
    Types_link

diff --git a/doc/shared/SundialsOrganization.rst b/doc/shared/SundialsOrganization.rst
diff --git a/doc/superbuild/source/sundials/index.rst b/doc/superbuild/source/sundials/index.rst
@@ -16,6 +16,12 @@
 Using SUNDIALS
 **************
 
+.. _Organization.Sundials.HighLevelDiagram:
+.. figure:: ../figs/sunorg1.png
+   :align: center
+
+   High-level diagram of the SUNDIALS suite.
+
 The packages that make up SUNDIALS are built upon shared classes for vectors,
 matrices, and algebraic solvers. In addition, the packages all leverage some
 other common infrastructure, which we discuss in this section.