Skip to content
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.

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

+Add runtime parameters for MOM_wave_interface #289

Merged
merged 2 commits into from
Dec 29, 2022

Conversation

Hallberg-NOAA
Copy link
Member

Added 7 new runtime parameters (LA_DEPTH_MIN, DHH85_MIN_WAVE_FREQ, DHH85_MAX_WAVE_FREQ, RHO_AIR, VISCOSITY_AIR, WAVE_HEIGHT_SCALE_FACTOR and VON_KARMAN_WAVES) to specify the previously hard-coded dimensional parameters in the MOM_wave_interface module. Because there are several different ways to set the parameters related to the Langmuir number calculation, several of these parameters are set in the new private subroutine set_LF17_wave_params, which in turn is called in two different places. Some comments were also added to annotate the units of some of the variables in this module. By default all answers are bitwise identical, but there are new entries in the MOM_parameter_doc.all files for some configurations that use the MOM6 surface wave module.

  Added 7 new runtime parameters (LA_DEPTH_MIN, DHH85_MIN_WAVE_FREQ,
DHH85_MAX_WAVE_FREQ, RHO_AIR, VISCOSITY_AIR, WAVE_HEIGHT_SCALE_FACTOR and
VON_KARMAN_WAVES) to specify the previously hard-coded dimensional parameters in
the MOM_wave_interface module.  Because there are several different ways to set
the parameters related to the Langmuir number calculation, several of these
parameters are set in the new private subroutine set_LF17_wave_params, which in
turn is called in two different places.  Some comments were also added to
annotate the units of some of the variables in this module.  By default all
answers are bitwise identical, but there are new entries in the
MOM_parameter_doc.all files for some configurations that use the MOM6 surface
wave module.
@Hallberg-NOAA Hallberg-NOAA added documentation Improvements or additions to documentation Parameter change Input parameter changes (addition, removal, or description) labels Dec 21, 2022
@codecov
Copy link

codecov bot commented Dec 21, 2022

Codecov Report

Merging #289 (4626487) into dev/gfdl (3310ee3) will decrease coverage by 0.00%.
The diff coverage is 0.00%.

@@             Coverage Diff              @@
##           dev/gfdl     #289      +/-   ##
============================================
- Coverage     37.08%   37.07%   -0.01%     
============================================
  Files           263      263              
  Lines         73611    73620       +9     
  Branches      13719    13720       +1     
============================================
  Hits          27296    27296              
- Misses        41278    41287       +9     
  Partials       5037     5037              
Impacted Files Coverage Δ
src/user/MOM_wave_interface.F90 1.30% <0.00%> (-0.02%) ⬇️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link

@breichl breichl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ability to set these parameters at runtime is an improvement to the code and looks correct to me. The additional comments also look to improve the description of the code.

Copy link
Member

@marshallward marshallward left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved on behalf of @breichl

@marshallward
Copy link
Member

marshallward commented Dec 29, 2022

Gaea regression: https://gitlab.gfdl.noaa.gov/ogrp/MOM6/-/pipelines/17819 ✔️ 🟡

@marshallward marshallward merged commit ec7a57f into NOAA-GFDL:dev/gfdl Dec 29, 2022
@Hallberg-NOAA Hallberg-NOAA deleted the explicit_wave_params branch February 2, 2023 13:37
marshallward pushed a commit that referenced this pull request Mar 1, 2023
  Corrected the units in the get_param call for WAVE_HEIGHT_SCALE_FACTOR, and
corrected the units descriptions in comments of 22 wind stress related variables
in 6 driver routines, from [R L Z T-1 ~> Pa] to [R L Z T-2 ~> Pa], but the
actual conversion factors in the code are correct.  Also fixed 42 other
inconsistent units in comments in 28 files scattered throughout the MOM6 code.
WAVE_HEIGHT_SCALE_FACTOR was added in December 2022 as a part of PR #289 to
dev/gfdl. These inconsistent units were detected because they do not match the
patterns of other valid units; most are recent additions.  Apart from a single
unit in a get_param call, only comments are changed, and all answers are bitwise
identical.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Parameter change Input parameter changes (addition, removal, or description)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants