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

Document units in 8 lat_param or diag modules #256

Merged
merged 2 commits into from
Dec 12, 2022

Conversation

Hallberg-NOAA
Copy link
Member

Documented numerous internal variables and their units in 3 lateral parameterization modules (MOM_hor_visc, MOM_lateral_mixing_coeffs, MOM_MEKE_types) and the write_cputime module. In addition, the units of a number of internal variables in the MOM_sum_output module and arguments to call_tracer_stocks were added to their descriptions in comments. This commit includes the addition of units or scale=1.0 arguments in 9 unlogged get_param calls. A number of spelling errors were also corrected in comments. All answers and output are bitwise identical.

@Hallberg-NOAA Hallberg-NOAA added the documentation Improvements or additions to documentation label Nov 25, 2022
@codecov
Copy link

codecov bot commented Nov 25, 2022

Codecov Report

Merging #256 (4019f16) into dev/gfdl (9bc8772) will decrease coverage by 0.00%.
The diff coverage is 76.74%.

@@             Coverage Diff              @@
##           dev/gfdl     #256      +/-   ##
============================================
- Coverage     37.13%   37.12%   -0.01%     
============================================
  Files           263      263              
  Lines         73434    73434              
  Branches      13674    13674              
============================================
- Hits          27268    27265       -3     
- Misses        41142    41145       +3     
  Partials       5024     5024              
Impacted Files Coverage Δ
src/parameterizations/lateral/MOM_MEKE_types.F90 0.00% <ø> (ø)
src/tracer/MOM_tracer_flow_control.F90 25.00% <ø> (ø)
src/diagnostics/MOM_sum_output.F90 64.84% <64.28%> (-0.18%) ⬇️
src/parameterizations/lateral/MOM_hor_visc.F90 50.40% <75.00%> (ø)
...eterizations/lateral/MOM_lateral_mixing_coeffs.F90 42.74% <88.88%> (ø)
src/core/MOM_barotropic.F90 58.98% <100.00%> (ø)
src/framework/MOM_write_cputime.F90 68.25% <100.00%> (ø)
src/framework/testing/MOM_file_parser_tests.F90 94.15% <100.00%> (ø)
src/framework/MOM_document.F90 73.88% <0.00%> (-0.45%) ⬇️

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

@Hallberg-NOAA Hallberg-NOAA force-pushed the lat_param_doc_units branch 2 times, most recently from 60c1080 to cf77c27 Compare November 30, 2022 11:05
@Hallberg-NOAA
Copy link
Member Author

This PR has now been amended to eliminate the scale=1.0 arguments.

  Documented numerous internal variables and their units in 3 lateral
parameterization modules (MOM_hor_visc, MOM_lateral_mixing_coeffs,
MOM_MEKE_types) and the write_cputime module.  In addition, the units of a
number of internal variables in the MOM_sum_output module and arguments to
call_tracer_stocks were added to their descriptions in comments.  This commit
includes the addition of units arguments in 9 unlogged get_param calls, comments
describing why parameters are not rescaled, and the rescaling of MAXVEL in
hor_visc_init.  A number of spelling errors were also corrected in comments.
All answers and output are bitwise identical.
@marshallward
Copy link
Member

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

@marshallward marshallward merged commit 3327037 into NOAA-GFDL:dev/gfdl Dec 12, 2022
@Hallberg-NOAA Hallberg-NOAA deleted the lat_param_doc_units branch February 2, 2023 13:31
marshallward pushed a commit that referenced this pull request Oct 25, 2023
Add option to apply non-local momentum flux
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.

3 participants