+MOM_wave_speed cleanup #304
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added or amended comments to document the units of numerous internal variables and function arguments in MOM_wave_speed.F90. Only comments are changed, but the position of some variable declarations is changed to help the comments make more sense. All answers are bitwise identical and no output is changed.
Made the CS argument mandatory for wave_speeds and added the new runtime parameter INTERNAL_WAVE_CG1_THRESH to specify the threshold first mode internal below which all higher mode speeds are reported as 0, replacing a previously hard-coded dimensional value. As a result of this change there is a new waves_CS element in diabatic_CS and a call to wave_speed_init from diabatic_driver_init. By default, all answers are bitwise identical, but there is a new entry in some MOM_parameter_doc files that have INTERNAL_TIDES=True.
Hallberg-NOAA
added
documentation
Codecov Report
@@ Coverage Diff @@
## dev/gfdl #304 +/- ##
============================================
- Coverage 37.14% 37.10% -0.04%
============================================
Files 263 263
Lines 73720 73799 +79
Branches 13738 13754 +16
============================================
Hits 27384 27384
- Misses 41276 41354 +78
- Partials 5060 5061 +1
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
Gaea regression: https://gitlab.gfdl.noaa.gov/ogrp/MOM6/-/pipelines/18012 ✔️ |
marshallward
approved these changes
Jan 18, 2023
This was referenced Apr 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR includes a pair of commits that expand the documentation of the internal variables and their units in the MOM_wave_speed module, and then adds a new runtime parameter, INTERNAL_WAVE_CG1_THRESH, to set a previously hard coded dimensional value for the threshold a first mode speed below which all higher mode speeds are simply given a speed of 0. By default, all answers are bitwise identical, but there is a new entry in the MOM_parameter_doc files for some cases.
The commits in this PR include: