Skip to content

Document MOM_regridding and coord variable units#561

Merged
marshallward merged 2 commits into
NOAA-GFDL:dev/gfdlfrom
Hallberg-NOAA:document_coord_code
Feb 9, 2024
Merged

Document MOM_regridding and coord variable units#561
marshallward merged 2 commits into
NOAA-GFDL:dev/gfdlfrom
Hallberg-NOAA:document_coord_code

Conversation

@Hallberg-NOAA
Copy link
Copy Markdown
Member

Added or amended comments describing about 90 variables in the MOM_regridding, coord_adapt, coord_rho, and coord_sigma modules to document the purpose and units of real variables using the MOM6 standard syntax. A missing doxygen comment was also added to describe inflate_vanished_layers_old(). A few unused internal variables were also eliminated, including the max_depth_index_scale element of the regridding_CS type. All answers are bitwise identical and only comments are changed.

@Hallberg-NOAA Hallberg-NOAA added the documentation Improvements or additions to documentation label Feb 1, 2024
@codecov
Copy link
Copy Markdown

codecov Bot commented Feb 1, 2024

Codecov Report

Attention: 4 lines in your changes are missing coverage. Please review.

Comparison is base (4757bcb) 37.20% compared to head (f6a663b) 37.26%.

Files Patch % Lines
src/ALE/coord_adapt.F90 0.00% 2 Missing ⚠️
src/ALE/coord_rho.F90 0.00% 2 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##           dev/gfdl     #561      +/-   ##
============================================
+ Coverage     37.20%   37.26%   +0.05%     
============================================
  Files           271      270       -1     
  Lines         80440    79583     -857     
  Branches      14999    14789     -210     
============================================
- Hits          29930    29655     -275     
+ Misses        44944    44439     -505     
+ Partials       5566     5489      -77     

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

  Added or amended comments describing about 90 variables in the MOM_regridding,
coord_adapt, coord_rho, and coord_sigma modules to document the purpose and
units of real variables using the MOM6 standard syntax.  A missing doxygen
comment was also added to describe inflate_vanished_layers_old().  A few unused
internal variables were also eliminated, including the max_depth_index_scale
element of the regridding_CS type.  All answers are bitwise identical and only
comments are changed.
@marshallward
Copy link
Copy Markdown
Member

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

@marshallward marshallward merged commit de7e5b7 into NOAA-GFDL:dev/gfdl Feb 9, 2024
@Hallberg-NOAA Hallberg-NOAA deleted the document_coord_code branch May 10, 2024 21:47
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