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

Change bounding of Kv_BBL and bbl_thick in set_viscous_BBL() #1223

Merged
merged 5 commits into from
Oct 16, 2020
Merged

Change bounding of Kv_BBL and bbl_thick in set_viscous_BBL() #1223

merged 5 commits into from
Oct 16, 2020

Conversation

adcroft
Copy link
Collaborator

@adcroft adcroft commented Oct 15, 2020

The majority of this PR is new documentation, in the form of both code comments and equations in doxygen-generated material, with a small but optionally answer changing fix in the last commit.

  • The BBL viscosity used to be simply bounded to be no less than a minimum, KV_BBL_MIN. In some limits where the BBL thickness was smaller than the bottom layer thickness, this viscosity led to too much drag on the bottom layer.
  • If CORRECT_BBL_BOUNDS=True we now also adjust bbl_thick when bounding Kv_bbl so that the implied stress, viscosity and thickness are all consistent.
  • By default, CORRECT_BBL_BOUNDS=False so that existing answers are unchanged.
  • This introduces a new run-time parameter so changes the doc strings in MOM-examples.

First commit:

  • Added lots of comments explaining method/equations
  • Small refactor of code to reduce duplicated code a smidgen but really in preparation for a solution-changing fix coming later
  • Also removed unused diagnostic ids in MOM_vert_friction.F90

Second commit:

  • Wrote out equations being solve with reference to model parameters. Includes references.

Third commit:

  • Switched to non-English spelling of bottom-most

Fourth commit:

  • The actual code correction.

- Added lots of comments explaining method/equations
- Small refactor code to reduce duplicated code a smidge but really
  in preparation for a later solution changing fix
- Also removed unused diagnostic ids frin MOM_vert_friction.F90
- Wrote out equations being solve with reference to model
  parameters. Includes references.
- This must be a side effect of Brexit
- The BBL viscosity used to be simply bounded to be no less than a
  minimum, KV_BBL_MIN. In some limits where the BBL thickness was smaller
  than the bottom layer thickness, this viscosity led to too much drag on
  the bottom layer.
- If CORRECT_BBL_BOUNDS=True we now also adjust bbl_thick when bounding
  Kv_bbl so that the implied stress, viscosity and thickness are all
  consistent.
- By default, CORRECT_BBL_BOUNDS=False so that existing answers are
  unchanged.
@codecov-io
Copy link

Codecov Report

Merging #1223 into dev/gfdl will increase coverage by 0.02%.
The diff coverage is 33.65%.

Impacted file tree graph

@@             Coverage Diff              @@
##           dev/gfdl    #1223      +/-   ##
============================================
+ Coverage     46.08%   46.11%   +0.02%     
============================================
  Files           214      224      +10     
  Lines         69399    70954    +1555     
============================================
+ Hits          31984    32721     +737     
- Misses        37415    38233     +818     
Impacted Files Coverage Δ
...g_src/external/GFDL_ocean_BGC/FMS_coupler_util.F90 0.00% <0.00%> (ø)
...fig_src/external/GFDL_ocean_BGC/generic_tracer.F90 0.00% <0.00%> (ø)
...c/external/GFDL_ocean_BGC/generic_tracer_utils.F90 0.00% <0.00%> (ø)
config_src/external/ODA_hooks/kdtree.f90 0.00% <0.00%> (ø)
config_src/external/ODA_hooks/ocean_da_core.F90 0.00% <0.00%> (ø)
config_src/external/ODA_hooks/ocean_da_types.F90 0.00% <0.00%> (ø)
config_src/external/ODA_hooks/write_ocean_obs.F90 0.00% <0.00%> (ø)
config_src/solo_driver/MESO_surface_forcing.F90 0.00% <0.00%> (ø)
config_src/solo_driver/user_surface_forcing.F90 0.00% <0.00%> (ø)
src/ALE/MOM_regridding.F90 31.47% <0.00%> (-0.17%) ⬇️
... and 217 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 48da975...61c84ad. Read the comment docs.

@Hallberg-NOAA
Copy link
Collaborator

The pipeline testing for this PR has been triggered at https://gitlab.gfdl.noaa.gov/ogrp/MOM6/-/pipelines/11392.

Copy link
Collaborator

@Hallberg-NOAA Hallberg-NOAA left a comment

Choose a reason for hiding this comment

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

Now that the Queen's English spelling of bottommost has been changed back to the proper American English spelling, and the pipeline tests have passed (while noting the new entries in the MOM_parameter_doc files), this PR is acceptable.

@marshallward marshallward merged commit 136afce into mom-ocean:dev/gfdl Oct 16, 2020
@adcroft adcroft deleted the kv-doc branch November 9, 2020 23:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants