Skip to content

+Argument cleanup in vertical diffusivity code#1533

Merged
marshallward merged 4 commits into
mom-ocean:dev/gfdlfrom
Hallberg-NOAA:vert_diff_opt_args
Nov 9, 2021
Merged

+Argument cleanup in vertical diffusivity code#1533
marshallward merged 4 commits into
mom-ocean:dev/gfdlfrom
Hallberg-NOAA:vert_diff_opt_args

Conversation

@Hallberg-NOAA
Copy link
Copy Markdown
Collaborator

Cleaned up 26 falsely optional or unused arguments in the vertical
diffusivity code, and related changes. Several descriptive comments were
also corrected, including the correction of the units of 10 variables related
to CVMix_KPP. This commit includes:

  • Made the Kd_int arguments to set_diffusivity() and 3 subsidiary routines
    mandatory and reordered the arguments so that the non-optional arguments
    come before the grid types
  • Made the halo_TS and double_diffuse arguments to set_diffusivity_init()
    mandatory.
  • Made the Time argument to ALE_sponge() mandatory.
  • Made the Kd and Kv arguments to calculate_CVMIX_conv() mandatory.
  • Removed the unused halo argument to adjust_salt().
  • Removed the unused Kddt_convect argument to full_convection().
  • Made the halo arguments to full_convection()and smoothed_dRdT_dRdS()
    mandatory.
  • Made the useALEalgorithm argument to geothermal_init() mandatory.
  • Removed the unused initialize_all arguments to Calculate_kappa_shear() and
    Calc_kappa_shear_vertex().
  • Removed the unused I_Ld2_1d and dz_Int_1d arguments to kappa_shear_column().
  • Made 3 arguments to calculate_projected_state() mandatory and reordered the
    arguments accordingly.
  • Eliminating the unused skip_diags arguments to calculateBuoyancyFlux() and
    extractFluxes(), which are now effectively always false.
    All answers are bitwise identical, and no output is changed.

  Cleaned up 26 falsely optional or unused arguments in the vertical
diffusivity code, and related changes.  Several descriptive comments were
also corrected, including the correction of the units of 10 variables related
to CVMix_KPP.  This commit includes:
 - Made the Kd_int arguments to set_diffusivity() and 3 subsidiary routines
   mandatory and reordered the arguments so that the non-optional arguments
   come before the grid types
 - Made the halo_TS and double_diffuse arguments to set_diffusivity_init()
   mandatory.
 - Made the Time argument to ALE_sponge() mandatory.
 - Made the Kd and Kv arguments to calculate_CVMIX_conv() mandatory.
 - Removed the unused halo argument to adjust_salt().
 - Removed the unused Kddt_convect argument to full_convection().
 - Made the halo arguments to full_convection()and smoothed_dRdT_dRdS()
   mandatory.
 - Made the useALEalgorithm argument to geothermal_init() mandatory.
 - Removed the unused initialize_all arguments to Calculate_kappa_shear() and
   Calc_kappa_shear_vertex().
 - Removed the unused I_Ld2_1d and dz_Int_1d arguments to kappa_shear_column().
 - Made 3 arguments to calculate_projected_state() mandatory and reordered the
   arguments accordingly.
 - Eliminating the unused skip_diags arguments to calculateBuoyancyFlux() and
   extractFluxes(), which are now effectively always false.
All answers are bitwise identical, and no output is changed.
@codecov
Copy link
Copy Markdown

codecov Bot commented Oct 22, 2021

Codecov Report

Merging #1533 (1beaeae) into dev/gfdl (1324656) will increase coverage by 0.00%.
The diff coverage is 30.57%.

Impacted file tree graph

@@            Coverage Diff            @@
##           dev/gfdl    #1533   +/-   ##
=========================================
  Coverage     29.15%   29.15%           
=========================================
  Files           239      239           
  Lines         71533    71467   -66     
=========================================
- Hits          20855    20837   -18     
+ Misses        50678    50630   -48     
Impacted Files Coverage Δ
src/parameterizations/vertical/MOM_ALE_sponge.F90 15.65% <ø> (-0.07%) ⬇️
src/parameterizations/vertical/MOM_CVMix_KPP.F90 0.99% <ø> (ø)
src/parameterizations/vertical/MOM_CVMix_conv.F90 9.90% <0.00%> (+0.19%) ⬆️
...rc/parameterizations/vertical/MOM_diabatic_aux.F90 34.67% <0.00%> (+0.09%) ⬆️
...parameterizations/vertical/MOM_full_convection.F90 0.00% <0.00%> (ø)
src/core/MOM_forcing_type.F90 47.43% <20.00%> (+0.21%) ⬆️
...parameterizations/vertical/MOM_diabatic_driver.F90 39.20% <20.00%> (-0.04%) ⬇️
...parameterizations/vertical/MOM_set_diffusivity.F90 32.70% <29.78%> (-0.11%) ⬇️
src/parameterizations/vertical/MOM_kappa_shear.F90 34.40% <46.34%> (-0.09%) ⬇️
src/parameterizations/vertical/MOM_geothermal.F90 21.54% <100.00%> (ø)
... and 2 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 1324656...1beaeae. Read the comment docs.

@marshallward
Copy link
Copy Markdown
Collaborator

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

Parameter update required, presumably from an older PR.

@marshallward marshallward merged commit f2e9983 into mom-ocean:dev/gfdl Nov 9, 2021
@Hallberg-NOAA Hallberg-NOAA deleted the vert_diff_opt_args branch November 27, 2021 11:20
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.

2 participants