Added gravity-wave parameters

[ray-chew]

Purpose

Added the parameters for the orographic gravity wave parametrisation. For now, a placeholder is used for the non-orographic gravity wave module.

To-do

Move the hard-coded non-orographic gravity-wave parameters into ClimaParams.

Content

---

• [x] I have read and checked the items on the review checklist.

[codecov[bot]]

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 98.50%. Comparing base (e079116) to head (23fe4e7).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #238   +/-   ##
=======================================
  Coverage   98.50%   98.50%           
=======================================
  Files           2        2           
  Lines         134      134           
=======================================
  Hits          132      132           
  Misses          2        2           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:

• :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[ray-chew]

Thanks for adding these parameters! I left two minor comments and have one general request: the parameter names should be made more specific, since they exist in the global namespace. One quick fix would be to prefix them with ogw_. In particular, density_scale_factor and critical_height_threshold are quite generic.

Thank you for these suggestions! :3 I added ogw_ everyway, including in ClimaAtmos create_parameters.jl and removed the last topography parameter. I hope I can keep the placeholder. I promise to have it fleshed out in the next weeks!

[nefrathenrici]

Thanks for adding these parameters! I left two minor comments and have one general request: the parameter names should be made more specific, since they exist in the global namespace. One quick fix would be to prefix them with ogw_. In particular, density_scale_factor and critical_height_threshold are quite generic.

Thank you for these suggestions! :3 I added ogw_ everyway, including in ClimaAtmos create_parameters.jl and removed the last topography parameter. I hope I can keep the placeholder. I promise to have it fleshed out in the next weeks!

The placeholder can not be merged, since removing it would be a future breaking change. Instead of merging this PR now, you could create a custom TOML file with these parameters and use the file to test these parameters. Here is an example just using ClimaParams:

import ClimaParams
ClimaParams.create_toml_dict(Float64; override_file="path/to/my/parameters.toml")

In ClimaAtmos, you will need to add this to your config for the time being:

toml: ["path/to/my/parameters.toml"]

[ray-chew]

Hey y'all, just wanted to let you know that I will work on this PR when I return to completing the gravity-wave parameterization. But I am letting this sit for now.