Skip to content

Docs PR #2708

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

Merged
asalmgren merged 6 commits into from
Nov 14, 2025
Merged

Docs PR #2708

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
12db2ca
Add missing flags to Inputs
jmsexton03 Nov 11, 2025
be21341
Add more inputs comments to buoyancy
jmsexton03 Nov 11, 2025
471e5c0
Add some theory equations for PBL
jmsexton03 Nov 11, 2025
b739b0c
Add more input flag docs
jmsexton03 Nov 11, 2025
42466d2
Add detection docs
jmsexton03 Nov 12, 2025
3ebb617
Style
jmsexton03 Nov 12, 2025
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
77 changes: 74 additions & 3 deletions Docs/sphinx_doc/Inputs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,14 @@ Governing Equations
| | all amr levels) or a list of| | |
| | values (one per level) | | |
+--------------------------+-----------------------------+---------------+-------------+
| **erf.buoyancy_type** | Controls how buoyancy is | 1, 2, 3, 4 | 1 (may be |
| | calculated: 1=density | | auto-set to |
| | perturbation, 2/3=temp. | | 2 or 3 based|
| | perturbation, 4=potential | | on moisture |
| | temp. perturbation. | | and solver) |
| | See :ref:`Buoyancy` for | | |
| | details | | |
+--------------------------+-----------------------------+---------------+-------------+
| **erf.use_fft** | use FFT rather than | true / false | false |
| | multigrid to solve the | | |
| | the Poisson equations | | |
Expand Down Expand Up @@ -837,7 +845,7 @@ List of Parameters
+===================================+==================+================+================+
| **erf.line_sampling_interval**, | Output | Integer | -1 |
| **erf.plane_sampling_interval** | frequency (steps)| | |
+===================================+==================+================+================+
+-----------------------------------+------------------+----------------+----------------+
| **erf.line_sampling_per**, | Output | Real | -1 |
| **erf.plane_sampling_per** | frequency (time) | | |
+-----------------------------------+------------------+----------------+----------------+
Expand Down Expand Up @@ -1100,7 +1108,9 @@ List of Parameters
| | | Values | |
+=========================================+====================+=====================+=============+
| **erf.pbl_type** | Name of PBL Scheme | "None", "MYNN25", | "None" |
| | to be used | "YSU" | |
| | to be used | "MYNNEDMF", "MYJ", | |
| | | "YSU", "MRF", | |
| | | "SHOC" | |
+-----------------------------------------+--------------------+---------------------+-------------+
| **erf.pbl_mynn_A1** | MYNN Constant A1 | Real | 1.18 |
+-----------------------------------------+--------------------+---------------------+-------------+
Expand Down Expand Up @@ -1232,6 +1242,11 @@ List of Parameters
| | delimited | | |
| | columns) | | |
+-------------------------------------+------------------------+-------------------+---------------------+
| **erf.windfarm_type** | Wind farm | "None", | "None" |
| | parameterization | "Fitch", "EWP", | |
| | | "SimpleActuator", | |
| | | "GeneralActuator" | |
+-------------------------------------+------------------------+-------------------+---------------------+
| **erf.const_massflux_u** | Include a momentum | Real | 0. |
| **erf.const_massflux_v** | source at each time, | | |
| | (e.g., representing a | | |
Expand Down Expand Up @@ -1372,6 +1387,8 @@ function(s).
Note that ``erf.add_custom_geostrophic_profile`` cannot be used in combination
with an ``erf.abl_geo_wind_table``.

- Wind farm parameterization requires ``USE_WINDFARM=TRUE`` at build time. See :ref:`WindFarmModels` for theory and examples.


Numerical Stability
===================
Expand Down Expand Up @@ -1661,6 +1678,53 @@ Examples of Usage
with the (x,y) values we have just read in. Note that the z-values are in the
order z(x1,y1), z(x1,y2), z(x1,y3), ... which is contrary to standard Fortran ordering

Land Surface Model
==================

The land surface model provides energy and moisture fluxes at the lower boundary.

List of Parameters
------------------

+--------------------------------+----------------------------+--------------------+-------------+
| Parameter | Definition | Acceptable | Default |
| | | Values | |
+================================+============================+====================+=============+
| **erf.land_surface_model** | Enables land surface | "None", | "None" |
| | energy and moisture | "Noah-MP", | |
| | fluxes | "MM5", "SLM" | |
+--------------------------------+----------------------------+--------------------+-------------+

.. note::

Noah-MP requires ``USE_NOAHMP=TRUE`` at build time. See :ref:`CouplingToNoahMP` for details.

Coupling Type (Data Exchange)
==============================

For coupled simulations with AMR-Wind or WaveWatch3, this controls the directionality of data exchange.


List of Parameters
------------------

+--------------------------------+----------------------------+--------------------+-------------+
| Parameter | Definition | Acceptable | Default |
| | | Values | |
+================================+============================+====================+=============+
| **erf.coupling_type** | Coupling mode for | "OneWay", | "None" |
| | coupled simulations with | "TwoWay" | |
| | AMR-Wind or WaveWatch3 | | |
+--------------------------------+----------------------------+--------------------+-------------+

Notes
-----

- **TwoWay**: Bidirectional coupling - ERF both receives and sends data
- **OneWay**: ERF receives forcing but doesn't send data back

See :ref:`CouplingToAMRWind` and :ref:`CouplingToWW3` for more information.

Moisture
========

Expand All @@ -1683,7 +1747,7 @@ List of Parameters
| | | "Morrison", | |
| | | "Morrison_NoIce", | |
| | | "SAM_NoPrecip_NoIce",| |
| | | "SAM_NoIce" | |
| | | "SAM_NoIce", "P3" | |
+---------------------------------+--------------------------+-----------------------+------------+
| **erf.moisture_tight_coupling** | If true, advance | Bool | false |
| | microphysics after every | | |
Expand Down Expand Up @@ -1718,6 +1782,9 @@ List of Parameters
| Parameter | Definition | Acceptable | Default |
| | | Values | |
+================================+==========================+====================+===================================+
| **erf.radiation_model** | Enables radiation | "None", | "None" |
| | transfer calculations | "RRTMGP" | |
+--------------------------------+--------------------------+--------------------+-----------------------------------+
| **erf.rad_freq_in_steps** | Number of steps between | int | 1 |
+--------------------------------+--------------------------+--------------------+-----------------------------------+
| **erf.rad_write_fluxes** | Flag to write fluxes | Bool | false |
Expand Down Expand Up @@ -1753,6 +1820,10 @@ List of Parameters

The lookup data may be downloaded as a package from `here <https://doi.org/10.22002/ppv8a-4q131>`_.

.. note::

Using RRTMGP requires ``USE_RRTMGP=TRUE`` at build time. See :ref:`building` for build instructions.

Runtime Error Checking
======================

Expand Down
Loading
Loading