+Add explicit API documentation to MOM6 framework #1297
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
Overloaded get_domain_extent to extract index ranges with domain2D types as well as MOM_domain_types. Also made the global extent arguments optional to get_domain_extent_MD. All answers are bitwise identical.
Added MOM_coupler_types.F90 and MOM_couplertype_infra.F90 to provide explicit interfaces for the routines from coupler_type_mod that MOM6 uses, with some new interfaces, extract_coupler_type_data and set_coupler_type_data, that are tailored to their use in MOM6. All answers are bitwise identical, but there are some new public interfaces.
Modified the various MOM6 tracer packages to use the MOM_coupler_types module along with new and simpler MOM_coupler_types interfaces. Also modified the module use statements in some of the core and diagnostics modules to access the coupler_types routines via MOM_coupler_types module. All answers are bitwise identical.
Channel all infrastructure calls from coupled_driver via the MOM6 framework code. This includes changing the type of one of the arguments and eliminating another argument to initialize_ocean_public_type to pass a MOM_domain_type, and using clone_MOM_domain to create the domain2D element of the Ocean_sfc type. All answers are bitwise identical.
Channel all infrastructure calls from solo_driver via the MOM6 framework code. This includes adding 2 more interfaces to MOM_ensemble_manager and making the affinity routines to those that are publicly accessible from MOM_domains. Several spelling errors in comments were also corrected. All answers are bitwise identical, but some subroutines are accessible from new modules.
Added explicitly documented interfaces to close_file, flux_file, io_infra_init, io_infra_end, get_file_info, get_file_fields, and get_field_atts to MOM_io_infra.F90. Also changed from get_file_atts to get_field_atts for the routine that is available via MOM_io.F90 and used in MOM_restart, since this name captures the use of this call and reflects which of the underlying routines the overloaded interface mpp_get_atts resolves to. All answers are bitwise identical, but there is a localized interface name change, and not all of the optional arguments in the underlying FMS or mpp routines are being made available for use with MOM6 code.
Codecov Report
@@ Coverage Diff @@
## dev/gfdl #1297 +/- ##
============================================
- Coverage 45.90% 45.85% -0.06%
============================================
Files 231 233 +2
Lines 71733 71865 +132
============================================
+ Hits 32929 32952 +23
- Misses 38804 38913 +109
Continue to review full report at Codecov.
|
adcroft
approved these changes
Jan 26, 2021
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.
This PR includes a number of steps to add explicit APIs within the MOM6
framework code, to eliminate the direct use of FMS or mpp routies, and to
simplify the interfaces used by MOM6. This PR includes the new files
MOM_coupler_types.F90 and MOM_couplertype_infra.F90, and some interfaces
are slightly changed.
The commits in this PR include: