From c864f790ca0640a0529e9f381866c6f1af202519 Mon Sep 17 00:00:00 2001 From: Eliot Quon Date: Thu, 19 Dec 2024 13:59:32 -0700 Subject: [PATCH] Update rayleigh inputs in docs (#2032) --- Docs/sphinx_doc/Inputs.rst | 29 +++++++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) diff --git a/Docs/sphinx_doc/Inputs.rst b/Docs/sphinx_doc/Inputs.rst index c302c456b..1755bf6ce 100644 --- a/Docs/sphinx_doc/Inputs.rst +++ b/Docs/sphinx_doc/Inputs.rst @@ -1087,11 +1087,32 @@ List of Parameters | **erf.coriolis_3d** | Include z component in | true / false | true | | | the Coriolis forcing | | | +-------------------------------------+------------------------+-------------------+---------------------+ -| **erf.use_rayleigh_damping** | Include explicit | true / false | false | -| | Rayleigh damping | | | +| **erf.rayleigh_damp_U** | Include explicit | true / false | false | +| | Rayleigh damping in | | | +| | the x-momentum equation| | | +-------------------------------------+------------------------+-------------------+---------------------+ -| **erf.nudging_from_input_sounding** | Include explicit | true / false | false | -| | Rayleigh damping | | | +| **erf.rayleigh_damp_V** | Include explicit | true / false | false | +| | Rayleigh damping in | | | +| | the y-momentum equation| | | ++-------------------------------------+------------------------+-------------------+---------------------+ +| **erf.rayleigh_damp_W** | Include explicit | true / false | false | +| | Rayleigh damping in | | | +| | the z-momentum equation| | | ++-------------------------------------+------------------------+-------------------+---------------------+ +| **erf.rayleigh_damp_T** | Include explicit | true / false | false | +| | Rayleigh damping in | | | +| | the potential | | | +| | temperature equation | | | ++-------------------------------------+------------------------+-------------------+---------------------+ +| **erf.rayleigh_dampcoef** | Rayleigh damping | Real | 0.2 | +| | coefficient, an inverse| | | +| | timescale | | | ++-------------------------------------+------------------------+-------------------+---------------------+ +| **erf.nudging_from_input_sounding** | Add momentum source | true / false | false | +| | terms to nudge the | | | +| | solution towards the | | | +| | initial sounding | | | +| | profile | | | +-------------------------------------+------------------------+-------------------+---------------------+ | **erf.input_sounding_file** | Name(s) of the | String(s) | input_sounding_file | | | input sounding file(s) | | |