Skip to content

Commit

Permalink
Updates to the "tech_info" sections of the ReadTheDocs manual
Browse files Browse the repository at this point in the history
06_info_for_kpp_developers.rst
- Add info about small_strato C-I test

07_numerical_methods.rst
- Remove LaTeX labels from Math sections

Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>
  • Loading branch information
yantosca committed May 17, 2022
1 parent 6c563cd commit 7bca904
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
5 changes: 5 additions & 0 deletions docs/source/tech_info/06_info_for_kpp_developers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -395,6 +395,11 @@ List of continuous integration tests
| :file:`small_f90` | Uses the LSODE integrator with the |
| | small_strato chemical mechanism. |
+-----------------------+------------------------------------------------+
| :file:`small_strato` | Uses the Rosenbrock integrator with the |
| | small_strato chemical mechanism. This uses |
| | the same options as the example described in |
| | :ref:`running-kpp-with-an-example-mechanism`. |
+-----------------------+------------------------------------------------+

Each continuous integration test is contained in a subfolder of
:file:`$KPP_HOME/ci-tests` and contains the following files (or
Expand Down
12 changes: 4 additions & 8 deletions docs/source/tech_info/07_numerical_methods.rst
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,6 @@ Section II.1 of :cite:`1993:Hairer_Norsett_and_Wanner`)
.. math::
\begin{aligned}
\label{eqn:RungeKutta}
y^{n+1} &=& y^n + h \sum_{i=1}^s b_i k_i~,\\
\nonumber
T_i &=& t^n + c_i h~, \quad
Expand Down Expand Up @@ -420,7 +419,6 @@ The tangent linear method associated with the Runge-Kutta method is
.. math::
\begin{aligned}
\label{eqn:RK-TLM}
%y^{n+1} &=& y^n + h \sum_{i=1}^s b_i k_i~,\\
\delta y^{n+1} &=& \delta y^n + h \sum_{i=1}^s b_i \ell_i~,\\
\nonumber
Expand All @@ -430,10 +428,10 @@ The tangent linear method associated with the Runge-Kutta method is
%k_i &=& f\left( \, T_i, \, Y_i \,\right)~,\\
\ell_i &=& J\left(T_i, \, Y_i \right) \cdot \delta Y_i ~.\end{aligned}
The system (`[eqn:RK-TLM] <#eqn:RK-TLM>`__) is linear and does not
require an iterative procedure. However, even for a SDIRK method
(:math:`a_{ij}=0` for :math:`i>j` and :math:`a_{ii}=\gamma`) each stage
requires the LU factorization of a different matrix.
The system is linear and does not require an iterative
procedure. However, even for a SDIRK method (:math:`a_{ij}=0` for
:math:`i>j` and :math:`a_{ii}=\gamma`) each stage requires the LU
factorization of a different matrix.

.. _rk-adj:

Expand All @@ -445,7 +443,6 @@ The first order Runge-Kutta adjoint is
.. math::
\begin{aligned}
\label{RK-adj}
u_i &=& h \, J^T(T_i,Y_i)\cdot
\left( b_i \lambda^{n+1} + \sum_{j=1}^s a_{ji} u_j \right)\\ %\quad i = 1 \cdots s\\
\nonumber
Expand All @@ -457,7 +454,6 @@ another Runge-Kutta method:
.. math::
\begin{aligned}
\label{RK-adj-2}
u_i &=& h \, J^T(T_i,Y_i)\cdot
\left( \lambda^{n+1} + \sum_{j=1}^s \frac{b_j \,
a_{ji}}{b_i} u_j \right)\\ %~, \quad i = 1 \cdots s\\
Expand Down

0 comments on commit 7bca904

Please sign in to comment.