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

---

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

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.78%. Comparing base (41fabb4) to head (545c116).
⚠️ Report is 7 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #238   +/-   ##
=======================================
  Coverage   91.78%   91.78%           
=======================================
  Files           1        1           
  Lines         146      146           
=======================================
  Hits          134      134           
  Misses         12       12           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

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

[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.

[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"]

[akshaysridhar]

The equation references aren't accompanied by a DOI paper link; could you please include that here as well ?

[akshaysridhar]

Suggested change

	description = "Mountain shape parameter (β), L(z) = L_b(1 - z/h)^β (equation 12), β=1 for triangular mountains and β<1 for blunt mounrains, β>1 for pointy mountains."
	description = "Mountain shape parameter (β), L(z) = L_b(1 - z/h)^β (equation 12), β=1 for triangular mountains and β<1 for blunt mountains, β>1 for pointy mountains."

[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.