Document custom forcing

ewquon · Jan 27, 2024 · 309975f · 309975f
1 parent a731260
commit 309975f
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/Docs/sphinx_doc/Inputs.rst b/Docs/sphinx_doc/Inputs.rst
@@ -771,6 +771,30 @@ List of Parameters
 |                                  | Rayleigh damping  |                   |             |
 +----------------------------------+-------------------+-------------------+-------------+
 
+In addition, custom forcings or tendencies may be defined on a problem-specific
+basis. This affords additional flexibility in defining the RHS source term as
+a function of time and/or height. Implementation entails modifying problem
+source code inside the Exec directory and overriding the ``update_*_sources()``
+function(s).
+
++--------------------------------------------+-------------------+-------------------+-------------+
+| Parameter                                  | Definition        | Acceptable        | Default     |
+|                                            |                   | Values            |             |
++============================================+===================+===================+=============+
+| **erf.custom_forcing_uses_primitive_vars** | User-defined      | true or false     | false       |
+|                                            | source terms set  |                   |             |
+|                                            | the tendency of   |                   |             |
+|                                            | primitive         |                   |             |
+|                                            | variables instead |                   |             |
+|                                            | of conserved      |                   |             |
+|                                            | quantities        |                   |             |
+|                                            | (rho*prim_var)    |                   |             |
++--------------------------------------------+-------------------+-------------------+-------------+
+| **erf.add_custom_rhotheta_forcing**        | Apply the         | true or false     | false       |
+|                                            | user-defined      |                   |             |
+|                                            | temperature source|                   |             |
+|                                            | term              |                   |             |
++--------------------------------------------+-------------------+-------------------+-------------+
 
 Initialization
 ==============