Skip to content

fix convection options in idealised_moist_phys.rst #296

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

Open
malcolmmaas wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix convection options in idealised_moist_phys.rst #296

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 10 additions & 10 deletions docs/source/modules/idealised_moist_phys.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ NB. Defaults are generally set to ``False`` to avoid accidental use of modules,

Humidity, Condensation and Convection
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Four convection schemes, and the option of no convection, are currently available in Isca. The defaults are set so the user should actively select a scheme to use via one of the methods below. Large-scale condensation will be called following the convection scheme in all cases, unless ``DRY_CONV`` is selected.
Four convection schemes, and the option of no convection, are currently available in Isca. The defaults are set so the user should actively select a scheme to use via one of the methods below. Large-scale condensation will be called following the convection scheme in all cases, unless ``DRY`` is selected.

Method 1 (preferred)
""""""""""""""""""""
Expand All @@ -43,15 +43,15 @@ The scheme to be used can be selected using the ``convection_scheme`` namelist p
+--------------------------+---------------------------------------------------------------------------+
|Value |Effect |
+==========================+===========================================================================+
|``SIMPLE_BETTS_CONV`` |Use Frierson Quasi-Equilibrium convection scheme [Frierson2007]_. |
|``SIMPLE_BETTS_MILLER`` |Use Frierson Quasi-Equilibrium convection scheme [Frierson2007]_. |
+--------------------------+---------------------------------------------------------------------------+
|``FULL_BETTS_MILLER_CONV``|Use the Betts-Miller convection scheme [Betts1986]_, [BettsMiller1986]_. |
|``FULL_BETTS_MILLER`` |Use the Betts-Miller convection scheme [Betts1986]_, [BettsMiller1986]_. |
+--------------------------+---------------------------------------------------------------------------+
|``RAS_CONV`` |Use the relaxed Arakawa Schubert convection scheme [Moorthi1992]_. |
|``RAS`` |Use the relaxed Arakawa Schubert convection scheme [Moorthi1992]_. |
+--------------------------+---------------------------------------------------------------------------+
|``DRY_CONV`` |Use the dry convection scheme [Schneider2006]_. |
|``DRY`` |Use the dry convection scheme [Schneider2006]_. |
+--------------------------+---------------------------------------------------------------------------+
|``NO_CONV`` |Use no convection scheme. |
|``NONE`` |Use no convection scheme. |
+--------------------------+---------------------------------------------------------------------------+
|``UNSET`` |Model looks through flags listed under Method 2. |
+--------------------------+---------------------------------------------------------------------------+
Expand All @@ -65,11 +65,11 @@ Three namelist parameters exist as switches to select the convection options:
+-------------------+----------------------------------------------------------------------------------+---------+
| Option | Summary |Default |
+===================+==================================================================================+=========+
|``lwet_convection``|If true, this is equivalent to specifying ``SIMPLE_BETTS_CONV`` in Method 1. |``False``|
|``lwet_convection``|If true, this is equivalent to specifying ``SIMPLE_BETTS_MILLER`` in Method 1. |``False``|
+-------------------+----------------------------------------------------------------------------------+---------+
|``do_bm`` |If true, this is equivalent to specifying ``FULL_BETTS_MILLER_CONV`` in Method 1. |``False``|
|``do_bm`` |If true, this is equivalent to specifying ``FULL_BETTS_MILLER`` in Method 1. |``False``|
+-------------------+----------------------------------------------------------------------------------+---------+
|``do_ras`` |If true, this is equivalent to specifying ``RAS_CONV`` in Method 1. |``False``|
|``do_ras`` |If true, this is equivalent to specifying ``RAS`` in Method 1. |``False``|
+-------------------+----------------------------------------------------------------------------------+---------+

If multiple flags are set as True, or all are False, an error will be raised. This method exists for compatibility with configurations pre-dating method 1. Method 1 is preferred for new model configurations.
Expand Down Expand Up @@ -296,4 +296,4 @@ References

Authors
-------
This documentation was written by Ruth Geen, peer reviewed by Marianne Pietschnig, and quality controlled by Ross Castle.
This documentation was written by Ruth Geen, peer reviewed by Marianne Pietschnig, and quality controlled by Ross Castle.