Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc-fix: remove out-of-date info about inflation flavor character strings #715

Merged
merged 3 commits into from
Aug 29, 2024
Merged

doc-fix: remove out-of-date info about inflation flavor character strings #715

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d4d8d11
doc: remove out-of-date info about inflation flavor character strings
hkershaw-brown Aug 9, 2024
0e04d67
doc-fix: inflation error codes
hkershaw-brown Aug 28, 2024
2c3b844
Merge branch 'main' into doc-filter-inf
hkershaw-brown Aug 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 3 additions & 36 deletions assimilation_code/modules/assimilation/filter_mod.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,11 +270,11 @@ prior inflation and the second controls the posterior inflation.
| | | defaults to model timestep size. |
+------------------------------+---------------------+-------------------------------------------+
| All variables named inf_* are arrays of length 2. The first element controls the prior, |
| the second element controls the posterior inflation. See :doc:`../../programs/filter/filter` |
| the second element controls the posterior inflation. See :ref:`Inflation` |
| for a discussion of inflation and effective strategies. |
+------------------------------+---------------------+-------------------------------------------+
| inf_flavor | character(len=32), | Inflation flavor [prior, posterior] |
| | dimension(2) | see `Inflation Options`_ below. |
| inf_flavor | integer, | Inflation flavor [prior, posterior] |
| | dimension(2) | see :ref:`Inflation` for details |
+------------------------------+---------------------+-------------------------------------------+
| inf_initial_from_restart | logical, | If ``.true.``, get initial mean values |
| | dimension(2) | for inflation from inflation file. |
Expand Down Expand Up @@ -407,39 +407,6 @@ prior inflation and the second controls the posterior inflation.
| | | volume of output. |
+------------------------------+---------------------+-------------------------------------------+

Inflation Options
-----------------

The value for the ``inf_flavor`` is a character string. For backwards compatiblity
(it was an integer code), the specification of the integer is still supported.
Inflation values (for flavors other than 0) will be time-varying
only if ``inf_sd_initial`` > 0.

+--------------------------------+---------------------------------------------------------+
| inflation option | description |
+================================+=========================================================+
| | 0 | no inflation |
| | '0' | |
| | 'NO_INFLATION' | |
+--------------------------------+---------------------------------------------------------+
| | 2 | spatially-varying state-space (gaussian) |
| | '2' | |
| | 'VARYING_SS_INFLATION' | |
+--------------------------------+---------------------------------------------------------+
| | 3 | spatially-fixed state-space (gaussian) |
| | '3' | |
| | 'SINGLE_SS_INFLATION' | |
+--------------------------------+---------------------------------------------------------+
| | 4 | Relaxation To Prior Spread (Posterior inflation only) |
| | '4' | |
| | 'RELAXATION_TO_PRIOR_SPREAD' | |
| | 'RTPS | |
+--------------------------------+---------------------------------------------------------+
| | 5 | Enhanced spatially-varying state-space (inverse gamma). |
| | '5' | Refer to ``inf_sd_initial`` for how to set the |
| | 'ENHANCED_SS_INFLATION' | time evolution options. |
+--------------------------------+---------------------------------------------------------+


.. _pert_model_copies:

Expand Down
2 changes: 2 additions & 0 deletions guide/inflation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _inflation:

Inflation
=========

Expand Down