+Minor code cleanup in initialization modules #301
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
Made the previously optional z_tol argument to find_depth_of_pressure_in_cell and cut_off_column_top non-optional. It was already being provided except in a call for unit testing, so adding it as a parameter there led to a simple change and the elimination of a hard-coded dimensional parameter. Also replaced the hard-coded fill values over land in MOM_temp_salt_initialize_from_Z for temperatures and salinities before regridding with the runtime variables temp_land_fill and salt_land_fill that are already being used in the same routine. This does not change any answers, probably because these values are not actually used. All answers are bitwise identical, but some subroutine arguments have been made non-optional.
Updated tc4/MOM_input to reflect the newer parameter settings, including replacing the obsolete NEW_SPONGES parameter with INTERPOLATE_SPONGE_TIME_SPACE. Without this change, NEW_SPONGES can not be formally and properly obsoleted without breaking the TC testing. All answers and testing are identical with this change.
Formally obsoleted the runtime parameter NEW_SPONGES. The agreed upon replacement is INTERPOLATE_SPONGE_TIME_SPACE, which has been available for almost a year. There is a warning message rather than a fatal error if NEW_SPONGES is used and both are set consistently, and a hint if they are not. Also added or amended comments describing a number of the internal variables or their units in MOM_state_initialization. All answers and output are bitwise identical.
Updated the comments in MOM_initialize_topography to reflect the fact that US is no longer an optional argument. Only comments are changed, and all answers are bitwise identical.
Added a description of the units to the comments for each of the real variables in MOM_grid_initialization and MOM_shared_initialization. Only comments are changed, and all answers are bitwise identical.
Codecov Report
@@ Coverage Diff @@
## dev/gfdl #301 +/- ##
=============================================
- Coverage 47.63% 37.10% -10.54%
=============================================
Files 41 263 +222
Lines 4532 73796 +69264
Branches 797 13753 +12956
=============================================
+ Hits 2159 27384 +25225
- Misses 2192 41352 +39160
- Partials 181 5060 +4879
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
marshallward
approved these changes
Jan 18, 2023
|
Gaea regression: https://gitlab.gfdl.noaa.gov/ogrp/MOM6/-/pipelines/18008 ✔️ 🟡 |
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 series of commits that cleans up minor issues with the code in the src/initialization directory. It includes commits that make the formerly optional z_tol arguments to find_depth_of_pressure_in_cell() and cut_off_column_top() non-optional. Two hard-coded but apparently unused fill values for temperature and salinity were replaced with standard fill values for land. It also formally obsoletes the archaic runtime parameter NEW_SPONGES, which required that the MOM_input file for .testing/tc4 be updated to reflect more recent parameter names and defaults. In addition, comments in several other modules were updated to reflect the units of a number of internal variables. All answers are bitwise identical, but there are a few spelling error corrections in some of the documents that go into MOM_parameter_doc files.
The commits in this PR include: