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

Wrap clocks #1298

Merged
merged 3 commits into from
Jan 27, 2021
Merged

Wrap clocks #1298

merged 3 commits into from
Jan 27, 2021

Conversation

adcroft
Copy link
Collaborator

@adcroft adcroft commented Jan 26, 2021

Documents API to clocks sitting on top of an infrastructure layer such as FMS

MOM_cpu_clock was making public several entities (functions and parameters)
belonging to MPP.

- This commit either wraps functions are creates new parameters.
- Also adds documentation for all new wrapping functions and parameters.
Since MOM code will not be allowed to directly reference the wrapper layer
around infrastructure this adds a layer that will remain in framework.

- Renamed MOM_cpu_clock.F90 to MOM_cpu_clock_infra.F90 . This module defines
  the API to clocks and any new wrappers must map between this and any
  alternate infrastructure clocks.
- Created new module MOM_cpu_clock.F90 which simply has pass throughs since
  no added "MOM-only" functinoality need be added.
@codecov-io
Copy link

Codecov Report

Merging #1298 (7f69add) into dev/gfdl (ee924f5) will increase coverage by 0.00%.
The diff coverage is 90.90%.

Impacted file tree graph

@@            Coverage Diff            @@
##           dev/gfdl    #1298   +/-   ##
=========================================
  Coverage     45.85%   45.85%           
=========================================
  Files           233      233           
  Lines         71865    71871    +6     
=========================================
+ Hits          32952    32958    +6     
  Misses        38913    38913           
Impacted Files Coverage Δ
src/framework/MOM_cpu_clock_infra.F90 90.90% <90.90%> (ø)

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 ee924f5...7f69add. Read the comment docs.

@Hallberg-NOAA
Copy link
Collaborator

This PR passed pipeline testing at https://gitlab.gfdl.noaa.gov/ogrp/MOM6/-/pipelines/11943

Copy link
Collaborator

@Hallberg-NOAA Hallberg-NOAA left a comment

Choose a reason for hiding this comment

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

These changes have passed all of our testing, and I deem the documentation to be correct, useful and complete.

@Hallberg-NOAA Hallberg-NOAA merged commit 09701df into mom-ocean:dev/gfdl Jan 27, 2021
@adcroft adcroft deleted the wrap-clocks branch March 2, 2021 19:50
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.

3 participants