+Document or eliminate undocumented interfaces #107
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Address undocumented interfaces by adding explicit interfaces to replaces one
level of the pass-throughs or eliminated them. Specifically
- Eliminated global_field_sum() from MOM_domains, as it is no longer used
anywhere in the MOM6 code or drivers. At the config_src/infra level, the
pass-through calls to mpp_global_sum are commented out in case there are
other versions of the MOM6 code that still use global_field_sum.
- Added explicit interfaces to horizontal_interp_init() and
time_interp_extern_init() in the config_src/infra rather that leaving them
as undocumented pass-throughs to the FMS code.
- Added the explicit subroutine stdout_if_root() to MOM_io.F90 to replace an undocumented
pass-through to the FMS stdout function.
- Added comments describing the publicly visible encoding parameters ind_flux,
ind_alpha, and ind_csurf that are a part of the coupler_types module.
- Removed the unnecessary or commented-out public declarations for
post_data_1d_k, vert_fill_TS, and legacy_diabatic.
All answers are bitwise identical, but there are some minor changes to the
names of subroutines offered at the config_src/infra level to permit the
documentation of these interfaces without running afoul of some bugs with
certain versions of the gnu compiler.
Codecov Report
@@ Coverage Diff @@
## dev/gfdl #107 +/- ##
=========================================
Coverage 28.75% 28.76%
=========================================
Files 248 248
Lines 72974 72984 +10
=========================================
+ Hits 20985 20991 +6
- Misses 51989 51993 +4
Continue to review full report at Codecov.
|
marshallward
approved these changes
Apr 11, 2022
|
Gaea regression: https://gitlab.gfdl.noaa.gov/ogrp/MOM6/-/pipelines/15217 ✔️ |
This was referenced May 16, 2022
Hallberg-NOAA
added a commit
to Hallberg-NOAA/MOM6
that referenced
this pull request
Jul 18, 2022
Made post_data_1d_k publicly visible once again, rather than requiring calls to use post_data, to support backward compatibility with older versions of the ocean_BGC code. This interface was removed from public visibility as a part of github.com/NOAA-GFDL/pull/107, but it caused problems with some of GFDL's Earth System Models, as noted in NOAA-GFDL#168. All answers are bitwise identical for any cases that compiled before.
marshallward
pushed a commit
that referenced
this pull request
Jul 18, 2022
Made post_data_1d_k publicly visible once again, rather than requiring calls to use post_data, to support backward compatibility with older versions of the ocean_BGC code. This interface was removed from public visibility as a part of github.com//pull/107, but it caused problems with some of GFDL's Earth System Models, as noted in #168. All answers are bitwise identical for any cases that compiled before.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Address undocumented interfaces by adding explicit interfaces to replaces one
level of the pass-throughs or eliminated them. Specifically
Eliminated global_field_sum() from MOM_domains, as it is no longer used
anywhere in the MOM6 code or drivers. At the config_src/infra level, the
pass-through calls to mpp_global_sum are commented out in case there are
other versions of the MOM6 code that still use global_field_sum.
Added explicit interfaces to horizontal_interp_init() and
time_interp_extern_init() in the config_src/infra rather that leaving them
as undocumented pass-throughs to the FMS code.
Added the explicit subroutine stdout_if_root() to MOM_io.F90 to replace an undocumented
pass-through to the FMS stdout function.
Added comments describing the publicly visible encoding parameters ind_flux,
ind_alpha, and ind_csurf that are a part of the coupler_types module.
Removed the unnecessary or commented-out public declarations for
post_data_1d_k, vert_fill_TS, and legacy_diabatic.
All answers are bitwise identical, but there are some minor changes to the
names of subroutines offered at the config_src/infra level to permit the
documentation of these interfaces without running afoul of some bugs with
certain versions of the gnu compiler.