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

+Steps to correct Kelvin_initialization issues #839

Open
wants to merge 1 commit into
base: dev/gfdl
Choose a base branch
from

Conversation

Hallberg-NOAA
Copy link
Member

This commit takes the first steps toward correcting problems with the Kelvin initialization code, including making the OBC nudging timescale an explicit parameter and adding a number of comments identifying concerns and suggesting possible improvements with the code that is used when KELVIN_WAVE_MODE > 0. This commit includes the introduction of the new runtime parameter KELVIN_WAVE_VEL_NUDGING_TIMESCALE, with a default value set to recover the current hard-coded answers. A new warning message cautions about the suspected problems with the internal wave version of the code. By default, all answers are bitwise identical in the 4 Kelvin wave test cases that can be found at github.com/ESMG/ESMG-configs, but there is a new parameter in the MOM_parameter_doc.all files these cases.

  This commit takes the first steps toward correcting problems with the Kelvin
initialization code, including making the OBC nudging timescale an explicit
parameter and adding a number of comments identifying concerns and suggesting
possible improvements with the code that is used when KELVIN_WAVE_MODE > 0.
This commit includes the introduction of the new runtime parameter
KELVIN_WAVE_VEL_NUDGING_TIMESCALE, with a default value set to recover the
current hard-coded answers.  A new warning message cautions about the suspected
problems with the internal wave version of the code.  By default, all answers
are bitwise identical in the 4 Kelvin wave test cases that can be found at
github.com/ESMG/ESMG-configs, but there is a new parameter in the
MOM_parameter_doc.all files these cases.
@Hallberg-NOAA Hallberg-NOAA added the documentation Improvements or additions to documentation label Feb 22, 2025
@Hallberg-NOAA
Copy link
Member Author

@kshedstrom, because you originally contributed the user/Kelvin_initialization.F90 code, I would greatly appreciate it if you could examine these changes at your convenience to ensure that you agree with them, and in particular with the comments I have added about the internal Kelvin wave cases and how they might be fixed.

Copy link

codecov bot commented Feb 22, 2025

Codecov Report

Attention: Patch coverage is 0% with 5 lines in your changes missing coverage. Please review.

Project coverage is 38.10%. Comparing base (3b3fb5e) to head (6f7d22c).
Report is 5 commits behind head on dev/gfdl.

Files with missing lines Patch % Lines
src/user/Kelvin_initialization.F90 0.00% 5 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##           dev/gfdl     #839      +/-   ##
============================================
- Coverage     38.11%   38.10%   -0.01%     
============================================
  Files           298      298              
  Lines         87641    87652      +11     
  Branches      16417    16422       +5     
============================================
+ Hits          33400    33404       +4     
- Misses        48223    48225       +2     
- Partials       6018     6023       +5     

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

@kshedstrom
Copy link

I approve these changes. Thank you for looking into this problem and providing excellent suggestions in the comments.

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants