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

MOM6: +Document data_override routines #1314

Merged
merged 5 commits into from
Feb 8, 2021

Conversation

Hallberg-NOAA
Copy link
Collaborator

This PR includes commits that add the new files MOM_data_override.F90 and
MOM_data_override_infra.F90 to document the data_override interfaces and provide
new interfaces or optional arguments that are tailored to their use by MOM6. It
also includes changes to other modules to use these new interfaces, along with
some cleanup of files in the framework directory. All answers are bitwise
identical, but there are changes to the documentation messages in some
MOM_parameter_doc files. The commits in this PR include:

  Added two new files, MOM_data_override.F90 and MOM_data_override_infra.F90, to
wrap the calls to the FMS data_override module, and to add MOM-specific variants
of these calls, including the ability to rescale quantities that are modified by
data_override into the right units or to use the right sign convention.  All
answers are bitwise identical, but there are new interfaces.
  Use the new MOM_data_override interfaces in the MOM6/config_src/solo_driver,
MOM6/config_src/coupled_driver, and MOM6/src code, instead of directly accessing
the mpp data_override_mod routines.  As a part of these, the dimensional
rescaling of variables is now done in many places via a scale argument to
data_override.  The changes in the solo_driver code are more extensive because
they were using arguments that do not seem to make sense, and because one of the
expressions had omitted dimensionally rescaling factors, although this
expression does not appear to have been used in any existing tests.  In
addition, the get_param calls for BUOY_CONFIG and WIND_CONFIG had not been
describing all of the available options, including data_override; this has now
been fixed.  A number of spelling errors in the same file were also corrected.
All answers are bitwise identical, but there are changes to some entries in some
MOM_parameter_doc files.
  Moved MOM_spatial_means.F90 from src/framework to src/diagnostics, and
eliminated MOM_transform_FMS.F90, which is no longer used.  Also correct an
instance of "the the " in one MOM_parameter_doc description, which changes some
MOM_parameter_doc.layout files.  All answers are bitwise identical.
@codecov
Copy link

codecov bot commented Feb 3, 2021

Codecov Report

Merging #1314 (16e61bd) into dev/gfdl (b5158bb) will increase coverage by 0.02%.
The diff coverage is 3.33%.

Impacted file tree graph

@@             Coverage Diff              @@
##           dev/gfdl    #1314      +/-   ##
============================================
+ Coverage     45.77%   45.80%   +0.02%     
============================================
  Files           234      234              
  Lines         72507    72465      -42     
============================================
  Hits          33193    33193              
+ Misses        39314    39272      -42     
Impacted Files Coverage Δ
src/diagnostics/MOM_spatial_means.F90 27.36% <ø> (ø)
src/framework/MOM_data_override_infra.F90 0.00% <0.00%> (ø)
src/framework/MOM_domains.F90 55.46% <ø> (ø)
src/tracer/MOM_offline_aux.F90 0.00% <ø> (ø)
src/user/MOM_wave_interface.F90 1.00% <0.00%> (ø)
config_src/solo_driver/MOM_surface_forcing.F90 26.54% <5.88%> (+0.76%) ⬆️

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 b5158bb...4f24d19. Read the comment docs.

@Hallberg-NOAA
Copy link
Collaborator Author

This PR has conditionally passed the pipeline testing at https://gitlab.gfdl.noaa.gov/ogrp/MOM6/-/pipelines/12006, with the expected messages that some of the MOM_parameter_doc files have changed, so that the reference files in MOM6-examples will have to be updated.

@adcroft adcroft self-assigned this Feb 5, 2021
Copy link
Collaborator

@adcroft adcroft left a comment

Choose a reason for hiding this comment

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

This has unrelated changes although I approve all of them. Because the docstrings were changed I will handle this at the command line when gaea returns.

@adcroft adcroft merged commit 270177f into mom-ocean:dev/gfdl Feb 8, 2021
@Hallberg-NOAA Hallberg-NOAA deleted the MOM_data_override branch July 30, 2021 16:07
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