Skip to content

Commit 0a0c225

Browse files
committed
Post-merge fixes/updates for PR #124
.ci-pipelines/ci-common-defs.sh - Alphabetize the F90 tests, move F90_feuler to the top docs/source/getting-started/00_revision_history.rst - Added sections for KPP 3.2.1 and 3.3.0 docs/source/tech_info/06_info_for_kpp_developers.rst - Convert the list of C-I tests to a list-table - Add info about F90_ros_h211b, F90_mcm_h211b tests - Remove mcm, that is now done with F90_mcm docs/source/using_kpp/04_input_for_rst.kpp - Extend underline for ICNTRL(8) section Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>
1 parent c8b924f commit 0a0c225

File tree

4 files changed

+136
-60
lines changed

4 files changed

+136
-60
lines changed

.ci-pipelines/ci-common-defs.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ C_rosadj
1212
C_sd
1313
C_sdadj
1414
C_small_strato
15+
F90_feuler
1516
F90_lsode
1617
F90_radau
1718
F90_rk
@@ -29,7 +30,6 @@ F90_sd
2930
F90_sdadj
3031
F90_seulex
3132
F90_small_strato
32-
F90_feuler
3333
"
3434
# Testing if #MINVERSION works
3535
MINVERSION_TEST="X_minver"

docs/source/getting_started/00_revision_history.rst

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,28 @@ of the changes, read `CHANGELOG.md
1010

1111
.. _unreleased:
1212

13-
==========
14-
Unreleased
15-
==========
13+
.. _kpp330:
1614

17-
- Added the **rosenbrock_h211b_qssa** integrator.
15+
=========
16+
KPP 3.3.0
17+
=========
18+
19+
- Added the :ref:`rosenbrock_h211b_qssa <rosenbrock-h211b-qssa>`
20+
integrator as described in :cite:t:`Dreger_2025`, along with the
21+
corresponding C-I tests.
22+
23+
.. _kpp321:
24+
25+
=========
26+
KPP 3.2.1
27+
=========
28+
29+
- Updated the Forward Euler integrator to return the :code:`Texit`
30+
value via the :code:`RSTATUS(1)` argument
31+
- Fixed parsing of :code:`INITVALUES` to allow Fortran
32+
double-precision exponents
33+
- Added carbon gases mechanism in :file:`models/carbon` folder
34+
- Added the C-I test :code:`F90_feuler` to validate the forward Euler integrator
1835

1936
.. _kpp320:
2037

docs/source/tech_info/06_info_for_kpp_developers.rst

Lines changed: 113 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -343,62 +343,118 @@ integration tests :ref:`locally on your own computer
343343
List of continuous integration tests
344344
------------------------------------
345345

346-
.. _table-ci-tests:
347-
348-
.. table:: Continuous integration tests
346+
.. list-table:: Continuous integration tests
347+
:header-rows: 1
349348
:align: center
350349

351-
+------------------------+-----------+-----------------+-----------------------+
352-
| C-I test | Language | Model | Integrator |
353-
+========================+===========+=================+=======================+
354-
| ``C_rk`` | C | small_strato | runge_kutta |
355-
+------------------------+-----------+-----------------+-----------------------+
356-
| ``C_rosadj`` | C | small_strato | rosenbrock_adj |
357-
+------------------------+-----------+-----------------+-----------------------+
358-
| ``C_sd`` | C | small_strato | sdirk |
359-
+------------------------+-----------+-----------------+-----------------------+
360-
| ``C_sdadj`` | C | small_strato | sdirk_adj |
361-
+------------------------+-----------+-----------------+-----------------------+
362-
| ``C_small_strato`` | C | small_strato | rosenbrock |
363-
+------------------------+-----------+-----------------+-----------------------+
364-
| ``F90_lsode`` | Fortran90 | small_strato | lsode |
365-
+------------------------+-----------+-----------------+-----------------------+
366-
| ``F90_radau`` | Fortran90 | saprc99 | radau5 |
367-
+------------------------+-----------+-----------------+-----------------------+
368-
| ``F90_rk`` | Fortran90 | small_strato | runge_kutta |
369-
+------------------------+-----------+-----------------+-----------------------+
370-
| ``F90_rktlm`` | Fortran90 | small_strato | runge_kutta_tlm |
371-
+------------------------+-----------+-----------------+-----------------------+
372-
| ``F90_ros`` | Fortran90 | small_strato | rosenbrock |
373-
+------------------------+-----------+-----------------+-----------------------+
374-
| ``F90_ros_autoreduce`` | Fortran90 | saprc99 | rosenbrock_autoreduce |
375-
+------------------------+-----------+-----------------+-----------------------+
376-
| ``F90_ros_split`` | Fortran90 | small_strato | rosenbrock |
377-
+------------------------+-----------+-----------------+-----------------------+
378-
| ``F90_ros_upcase`` | Fortran90 | saprc99 | rosenbrock |
379-
+------------------------+-----------+-----------------+-----------------------+
380-
| ``F90_rosadj`` | Fortran90 | small_strato | rosenbrock_adj |
381-
+------------------------+-----------+-----------------+-----------------------+
382-
| ``F90_rosenbrock`` | Fortran90 | saprc99 | rosenbrock |
383-
+------------------------+-----------+-----------------+-----------------------+
384-
| ``F90_rostlm`` | Fortran90 | small_strato | rosenbrock_tlm |
385-
+------------------------+-----------+-----------------+-----------------------+
386-
| ``F90_saprc_2006`` | Fortran90 | saprcnov | rosenbrock |
387-
+------------------------+-----------+-----------------+-----------------------+
388-
| ``F90_sd`` | Fortran90 | small_strato | sdirk |
389-
+------------------------+-----------+-----------------+-----------------------+
390-
| ``F90_sdadj`` | Fortran90 | small_strato | sdirk_adj |
391-
+------------------------+-----------+-----------------+-----------------------+
392-
| ``F90_seulex`` | Fortran90 | saprcnov | seulex |
393-
+------------------------+-----------+-----------------+-----------------------+
394-
| ``F90_small_strato`` | Fortran90 | small_strato | rosenbrock |
395-
+------------------------+-----------+-----------------+-----------------------+
396-
| ``F90_feuler`` | Fortran90 | carbon | feuler |
397-
+------------------------+-----------+-----------------+-----------------------+
398-
| ``mcm`` | Fortran90 | mcm | rosenbrock |
399-
+------------------------+-----------+-----------------+-----------------------+
400-
| ``X_minver`` | Fortran90 | small_strato | runge_kutta |
401-
+------------------------+-----------+-----------------+-----------------------+
350+
* - C-I test
351+
- Language
352+
- Model
353+
- Integrator
354+
* - :code:`C_rk`
355+
- C
356+
- small_strato
357+
- runge_kutta
358+
* - :code:`C_rosadj`
359+
- C
360+
- small_strato
361+
- rosenbrock_adj
362+
* - :code:`C_sd`
363+
- C
364+
- small_strato
365+
- sdirk
366+
* - :code:`C_sdadj`
367+
- C
368+
- small_strato
369+
- sdirk_adj
370+
* - :code:`C_small_strato`
371+
- C
372+
- small_strato
373+
- rosenbrock
374+
* - :code:`F90_feuler`
375+
- Fortran90
376+
- carbon
377+
- feuler
378+
* - :code:`F90_lsode`
379+
- Fortran90
380+
- small_strato
381+
- lsode
382+
* - :code:`F90_mcm`
383+
- Fortran90
384+
- mcm
385+
- rosenbrock
386+
* - :code:`F90_mcm_h211b`
387+
- Fortran90
388+
- mcm
389+
- rosenbrock_h211b_qssa
390+
* - :code:`F90_radau`
391+
- Fortran90
392+
- saprc99
393+
- radau5
394+
* - :code:`F90_rk`
395+
- Fortran90
396+
- small_strato
397+
- runge_kutta
398+
* - :code:`F90_rktlm`
399+
- Fortran90
400+
- small_strato
401+
- runge_kutta_tlm
402+
* - :code:`F90_ros`
403+
- Fortran90
404+
- small_strato
405+
- rosenbrock
406+
* - :code:`F90_rosadj`
407+
- Fortran90
408+
- small_strato
409+
- rosenbrock_adj
410+
* - :code:`F90_ros_autoreduce`
411+
- Fortran90
412+
- saprc99
413+
- rosenbrock_autoreduce
414+
* - :code:`F90_rosenbrock`
415+
- Fortran90
416+
- saprc99
417+
- rosenbrock
418+
* - :code:`F90_ros_h211b`
419+
- Fortran90
420+
- saprc99
421+
- rosenbrock_h211b_qssa
422+
* - :code:`F90_ros_split`
423+
- Fortran90
424+
- small_strato
425+
- rosenbrock
426+
* - :code:`F90_rostlm`
427+
- Fortran90
428+
- small_strato
429+
- rosenbrock_tlm
430+
* - :code:`F90_ros_upcase`
431+
- Fortran90
432+
- saprc99
433+
- rosenbrock
434+
* - :code:`F90_saprc_2006`
435+
- Fortran90
436+
- saprcnov
437+
- rosenbrock
438+
* - :code:`F90_sd`
439+
- Fortran90
440+
- small_strato
441+
- sdirk
442+
* - :code:`F90_sdadj`
443+
- Fortran90
444+
- small_strato
445+
- sdirk_adj
446+
* - :code:`F90_seulex`
447+
- Fortran90
448+
- saprcnov
449+
- seulex
450+
* - :code:`F90_small_strato`
451+
- Fortran90
452+
- small_strato
453+
- rosenbrock
454+
* - :code:`X_minver`
455+
- Fortran90
456+
- small_strato
457+
- runge_kutta
402458

403459
Notes about C-I tests:
404460

@@ -408,6 +464,9 @@ Notes about C-I tests:
408464
:ref:`running-kpp-with-an-example-mechanism`.
409465
#. :file:`X_minver` tests if the :ref:`minversion-cmd` command works
410466
properly.
467+
* Due to memory restrictions, the :file:`F90_mcm` and
468+
:file:`F90_mcm_h211b` are not run on the Microsoft Azure Dev
469+
pipelines platform. However, you can run these tests manaully.
411470

412471
Each continuous integration test is contained in a subdirectory of
413472
:file:`$KPP_HOME/ci-tests`. In each subdirectory is a KPP definition

docs/source/using_kpp/04_input_for_kpp.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1352,7 +1352,7 @@ Selects options for adjoint integrators.
13521352
+-----------------+------------+----------------------------------+
13531353

13541354
ICNTRL(8)
1355-
~~~~~~~~
1355+
~~~~~~~~~
13561356

13571357
Determines if LU factorization will be checkpointed at each step
13581358
(for adjoint integrators only).

0 commit comments

Comments
 (0)