├── CODEOWNERS
├── cime_config
    ├── testdefs
    │   └── testmods_dirs
    │   │   └── drv
    │   │       ├── glcnec10
    │   │           ├── include_user_mods
    │   │           └── shell_commands
    │   │       ├── aoflux_ogrid
    │   │           └── user_nl_cpl
    │   │       ├── 5steps
    │   │           └── shell_commands
    │   │       ├── y100k
    │   │           ├── shell_commands
    │   │           └── README
    │   │       ├── default
    │   │           └── shell_commands
    │   │       ├── som
    │   │           └── shell_commands
    │   │       ├── interim_restart
    │   │           └── shell_commands
    │   │       ├── asyncio1node
    │   │           └── shell_commands
    │   │       └── asyncio1pernode
    │   │           └── shell_commands
    ├── user_nl_cpl
    ├── config_archive.xml
    ├── runseq
    │   ├── runseq_TG.py
    │   ├── gen_runseq.py
    │   └── runseq_D.py
    ├── ExpectedTestFails.xml
    ├── config_compsets.xml
    ├── buildexe
    └── config_pes.xml
├── doc
    ├── .gitignore
    ├── source
    │   ├── CMEPS-grid1.png
    │   ├── CMEPS-grid2.png
    │   ├── CMEPS-grid3.png
    │   ├── _templates
    │   │   ├── layout.html
    │   │   └── footer.html
    │   ├── addendum
    │   │   ├── index.rst
    │   │   ├── req_attributes.rst
    │   │   ├── req_attributes_cesm.rst
    │   │   └── fieldnames.rst
    │   ├── index.rst
    │   ├── _static
    │   │   └── pop_ver.js
    │   ├── prep.rst
    │   ├── fractions.rst
    │   ├── conf.py
    │   └── generic.rst
    └── Makefile
├── .travis.yml
├── mediator
    ├── ESMFVersionDefine.h
    ├── ESMFConvenienceMacros.h
    ├── med_constants_mod.F90
    ├── med_kind_mod.F90
    ├── CMakeLists.txt
    ├── med_utils_mod.F90
    ├── med_phases_post_wav_mod.F90
    ├── med_phases_post_ice_mod.F90
    ├── med_phases_post_ocn_mod.F90
    ├── med_phases_post_lnd_mod.F90
    ├── Makefile
    ├── med_phases_post_atm_mod.F90
    └── med_phases_prep_lnd_mod.F90
├── ufs
    ├── CMakeLists.txt
    ├── perf_mod.F90
    ├── ccpp
    │   ├── suites
    │   │   └── suite_FV3_sfc_ocean.xml
    │   ├── data
    │   │   ├── MED_data.F90
    │   │   └── MED_data.meta
    │   ├── driver
    │   │   └── med_ccpp_driver.F90
    │   └── config
    │   │   └── ccpp_prebuild_config.py
    ├── ufs_kind_mod.F90
    ├── glc_elevclass_mod.F90
    └── ufs_const_mod.F90
├── tcipylint
├── README.md
├── .gitignore
├── .github
    ├── workflows
    │   ├── bumpversion.yml
    │   ├── extbuild.yml
    │   └── srt.yml
    └── pull_request_template.md
├── .pre-commit-config.yaml
├── CMakeLists.txt
├── cesm
    ├── nuopc_cap_share
    │   ├── esm_utils_mod.F90
    │   ├── shr_carma_mod.F90
    │   ├── shr_ndep_mod.F90
    │   ├── shr_lightning_coupling_mod.F90
    │   ├── shr_ozone_coupling_mod.F90
    │   └── shr_expr_parser_mod.F90
    ├── driver
    │   ├── util.F90
    │   └── t_driver_timers_mod.F90
    └── flux_atmocn
    │   ├── shr_flux_mod.F90
    │   └── flux_atmocn_driver_mod.F90
└── cmake
    ├── FindESMF.cmake
    ├── FindPIO.cmake
    └── LibCheck.cmake


/CODEOWNERS:
--------------------------------------------------------------------------------
1 | /cesm/flux_atmocn/ @megandevlan
2 | 


--------------------------------------------------------------------------------
/cime_config/testdefs/testmods_dirs/drv/glcnec10/include_user_mods:
--------------------------------------------------------------------------------
1 | ../default
2 | 


--------------------------------------------------------------------------------
/doc/.gitignore:
--------------------------------------------------------------------------------
1 | # Ignore auto-generated documentation for the addendum
2 | build
3 | 


--------------------------------------------------------------------------------
/cime_config/testdefs/testmods_dirs/drv/glcnec10/shell_commands:
--------------------------------------------------------------------------------
1 | ./xmlchange GLC_NEC=10


--------------------------------------------------------------------------------
/cime_config/testdefs/testmods_dirs/drv/aoflux_ogrid/user_nl_cpl:
--------------------------------------------------------------------------------
1 | aoflux_grid = "ogrid"
2 | 


--------------------------------------------------------------------------------
/cime_config/testdefs/testmods_dirs/drv/5steps/shell_commands:
--------------------------------------------------------------------------------
1 | ./xmlchange STOP_OPTION="nsteps"
2 | 
3 | 


--------------------------------------------------------------------------------
/cime_config/testdefs/testmods_dirs/drv/y100k/shell_commands:
--------------------------------------------------------------------------------
1 | ./xmlchange RUN_STARTDATE=99999-12-28
2 | 


--------------------------------------------------------------------------------
/doc/source/CMEPS-grid1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ESCOMP/CMEPS/main/doc/source/CMEPS-grid1.png


--------------------------------------------------------------------------------
/doc/source/CMEPS-grid2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ESCOMP/CMEPS/main/doc/source/CMEPS-grid2.png


--------------------------------------------------------------------------------
/doc/source/CMEPS-grid3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ESCOMP/CMEPS/main/doc/source/CMEPS-grid3.png


--------------------------------------------------------------------------------
/cime_config/testdefs/testmods_dirs/drv/default/shell_commands:
--------------------------------------------------------------------------------
1 | ./xmlchange HIST_OPTION=ndays
2 | ./xmlchange HIST_N=1
3 | 


--------------------------------------------------------------------------------
/cime_config/testdefs/testmods_dirs/drv/som/shell_commands:
--------------------------------------------------------------------------------
1 | ./xmlchange DOCN_SOM_FILENAME="pop_frc.1x1d.090130.nc"
2 | 
3 | 


--------------------------------------------------------------------------------
/doc/source/_templates/layout.html:
--------------------------------------------------------------------------------
1 | {% extends "!layout.html" %}
2 | 
3 | {% set script_files = script_files + ["_static/pop_ver.js"] %}


--------------------------------------------------------------------------------
/cime_config/testdefs/testmods_dirs/drv/interim_restart/shell_commands:
--------------------------------------------------------------------------------
1 | # use this with the ERR test to test the interim restart capability
2 | ./xmlchange REST_N=2


--------------------------------------------------------------------------------
/doc/source/addendum/index.rst:
--------------------------------------------------------------------------------
 1 | .. _addendum:
 2 | 
 3 | Addendum
 4 | ========
 5 | 
 6 | .. toctree::
 7 |    :maxdepth: 1
 8 | 
 9 |    req_attributes.rst
10 |    req_attributes_cesm.rst
11 |    fieldnames.rst
12 | 


--------------------------------------------------------------------------------
/doc/source/_templates/footer.html:
--------------------------------------------------------------------------------
1 | {% extends "!footer.html" %}
2 | {% block extrafooter %}
3 |     {{ super() }}
4 | <script>var version_json_loc = "{{ pathto('../../versions.json', 1) }}";</script>
5 | {% endblock %}
6 | 


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
 1 | language: python
 2 | 
 3 | install:
 4 |   - pip install pylint
 5 | 
 6 | python:
 7 |   - '3.7'
 8 |   - '3.8'
 9 |   - '3.9'
10 | 
11 | branches:
12 |   only:
13 |   - master
14 | 
15 | script: ./tcipylint
16 | 


--------------------------------------------------------------------------------
/mediator/ESMFVersionDefine.h:
--------------------------------------------------------------------------------
1 | #if 0
2 | //
3 | // Make this header file available as ESMFVersionDefine.h in order to build
4 | // UFS against an ESMF installation that contains a reference level NUOPC Layer.
5 | //
6 | #endif
7 | 
8 | #include "./ESMFConvenienceMacros.h"
9 | 


--------------------------------------------------------------------------------
/cime_config/testdefs/testmods_dirs/drv/y100k/README:
--------------------------------------------------------------------------------
1 | This tests the ability to use 6-digit years.
2 | 
3 | As of the time this test was created, the max year is about 214747 -
4 | otherwise we exceed the limit of 4-byte integers when storing dates as
5 | integers (yyyyyymmdd).
6 | 


--------------------------------------------------------------------------------
/ufs/CMakeLists.txt:
--------------------------------------------------------------------------------
1 | project(CMEPS_share Fortran)
2 | include(ExternalProject)
3 | 
4 | add_library(cmeps_share flux_atmocn_mod.F90 glc_elevclass_mod.F90 perf_mod.F90 ufs_const_mod.F90 ufs_kind_mod.F90)
5 | 
6 | target_include_directories (cmeps_share PUBLIC ${CMAKE_CURRENT_SOURCE_DIR} ${ESMF_F90COMPILEPATHS} ${PIO_Fortran_INCLUDE_DIRS})
7 | 


--------------------------------------------------------------------------------
/tcipylint:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env sh
2 | args="--disable=I,C,R,logging-not-lazy,wildcard-import,unused-wildcard-import,fixme,broad-except,bare-except,eval-used,exec-used,global-statement,logging-format-interpolation,no-name-in-module,import-error"
3 | failed=0
4 | for file in cime_config/buildexe cime_config/buildnml cime_config/runseq/*
5 | do
6 |     pylint $args $file || failed=$(( failed + 1 ))
7 | done
8 | exit $failed
9 | 


--------------------------------------------------------------------------------
/mediator/ESMFConvenienceMacros.h:
--------------------------------------------------------------------------------
1 | #if 0
2 | // ----------- ERROR handling macros ------------------------------------------
3 | #endif
4 | 
5 | #define ESMF_ERR_ABORT(rc) if (ESMF_LogFoundError(rc, msg="Aborting UFS", line=__LINE__, file=__FILE__)) call ESMF_Finalize(endflag=ESMF_END_ABORT)
6 | 
7 | #define ESMF_ERR_RETURN(rc,rcOut) if (ESMF_LogFoundError(rc, msg="Breaking out of subroutine", line=__LINE__, file=__FILE__, rcToReturn=rcOut)) return
8 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # CMEPS
 2 | NUOPC based Community Mediator for Earth Prediction Systems
 3 | 
 4 | ## Overview and resources
 5 | 
 6 | The Community Mediator for Earth Prediction Systems (CMEPS) is a
 7 | NUOPC-compliant Mediator component used for coupling Earth system
 8 | model components. It is currently being used in NCAR's Community
 9 | Earth System Model (CESM) and NOAA's UFS subseasonal-to-seasonal
10 | coupled system application.
11 | 
12 | For documentation see
13 | 
14 | https://escomp.github.io/CMEPS/
15 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | # Prerequisites
 2 | *.d
 3 | 
 4 | # Compiled Object files
 5 | *.slo
 6 | *.lo
 7 | *.o
 8 | *.obj
 9 | 
10 | # Python compiled files
11 | *.pyc
12 | cime_config/buildnmlc
13 | cime_config/buildexec
14 | 
15 | # Precompiled Headers
16 | *.gch
17 | *.pch
18 | 
19 | # Compiled Dynamic libraries
20 | *.so
21 | *.dylib
22 | *.dll
23 | 
24 | # Fortran module files
25 | *.mod
26 | *.smod
27 | 
28 | # Compiled Static libraries
29 | *.lai
30 | *.la
31 | *.a
32 | *.lib
33 | 
34 | # Executables
35 | *.exe
36 | *.out
37 | *.app
38 | 


--------------------------------------------------------------------------------
/.github/workflows/bumpversion.yml:
--------------------------------------------------------------------------------
 1 | name: Bump version
 2 | on:
 3 |   push:
 4 |     branches:
 5 |       - main
 6 | jobs:
 7 |   build:
 8 |     runs-on: ubuntu-latest
 9 |     steps:
10 |       - uses: actions/checkout@v2
11 |       - name: Bump version and push tag
12 |         id: tag_version
13 |         uses: mathieudutour/github-tag-action@v6.2
14 |         with:
15 |           github_token: ${{ secrets.GITHUB_TOKEN }}
16 |           create_annotated_tag: true
17 |           default_bump: patch
18 |           dry_run: false
19 |           tag_prefix: cmeps
20 | 


--------------------------------------------------------------------------------
/.github/pull_request_template.md:
--------------------------------------------------------------------------------
 1 | ### Description of changes
 2 | 
 3 | ### Specific notes
 4 | 
 5 | Contributors other than yourself, if any:
 6 | 
 7 | CMEPS Issues Fixed (include github issue #):
 8 | 
 9 | Are changes expected to change answers? (specify if bfb, different at roundoff, more substantial) 
10 | 
11 | Any User Interface Changes (namelist or namelist defaults changes)?
12 | 
13 | ### Testing performed
14 | Please describe the tests along with the target model and machine(s) 
15 | If possible, please also added hashes that were used in the testing
16 | 
17 | 


--------------------------------------------------------------------------------
/ufs/perf_mod.F90:
--------------------------------------------------------------------------------
 1 | module perf_mod
 2 | 
 3 |   use ESMF
 4 | 
 5 |   implicit none
 6 |   public
 7 | 
 8 |   public t_startf
 9 |   public t_stopf
10 | 
11 | contains
12 | 
13 |    subroutine t_startf(event, handle)
14 |      character(len=*), intent(in) :: event
15 |      integer,  optional :: handle
16 |      call ESMF_TraceRegionEnter(event)
17 |    end subroutine t_startf
18 | 
19 |    subroutine t_stopf(event, handle)
20 |      character(len=*), intent(in) :: event
21 |      integer,  optional :: handle
22 |      call ESMF_TraceRegionExit(event)
23 |    end subroutine t_stopf
24 | 
25 | end module perf_mod
26 | 


--------------------------------------------------------------------------------
/cime_config/testdefs/testmods_dirs/drv/asyncio1node/shell_commands:
--------------------------------------------------------------------------------
 1 | # This will add 4 asyncio tasks on the first node
 2 | ./xmlchange PIO_ASYNCIO_ROOTPE=0
 3 | ./xmlchange PIO_ASYNCIO_STRIDE=1
 4 | ./xmlchange PIO_ASYNCIO_NTASKS=4
 5 | ./xmlchange PIO_REARRANGER=2
 6 | ./xmlchange PIO_ASYNC_INTERFACE=TRUE
 7 | for comp in ATM OCN LND ICE CPL GLC ROF
 8 | do
 9 |   rootpe=`./xmlquery --value ROOTPE_$comp`
10 |   let newrootpe=rootpe+4
11 |   ./xmlchange ROOTPE_$comp=$newrootpe
12 | done
13 | comp_ocn=`./xmlquery --value COMP_OCN`
14 | # MOM ocn has no pio interface
15 | if [[ "$comp_ocn" == "mom" ]]; then
16 |   ./xmlchange PIO_ASYNC_INTERFACE_OCN=FALSE;
17 | fi
18 | 


--------------------------------------------------------------------------------
/ufs/ccpp/suites/suite_FV3_sfc_ocean.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | 
 3 | <suite name="FV3_sfc_ocean" version="1">
 4 |   <group name="physics">
 5 |     <subcycle loop="1">
 6 |       <scheme>GFS_surface_composites_pre</scheme>
 7 |     </subcycle>
 8 |     <subcycle loop="2">
 9 |       <scheme>sfc_diff</scheme>
10 |       <scheme>GFS_surface_loop_control_part1</scheme>
11 |       <scheme>sfc_ocean</scheme>
12 |       <scheme>GFS_surface_loop_control_part2</scheme>
13 |     </subcycle>
14 |     <subcycle loop="1">
15 |       <scheme>GFS_surface_composites_post</scheme>
16 |       <scheme>sfc_diag</scheme>
17 |     </subcycle>
18 |   </group>
19 | </suite>
20 | 


--------------------------------------------------------------------------------
/doc/Makefile:
--------------------------------------------------------------------------------
 1 | # Minimal makefile for Sphinx documentation
 2 | #
 3 | 
 4 | # You can set these variables from the command line.
 5 | SPHINXOPTS    =
 6 | SPHINXBUILD   = sphinx-build
 7 | SPHINXPROJ    = CMEPS
 8 | SOURCEDIR     = source
 9 | BUILDDIR      = build
10 | 
11 | # Put it first so that "make" without argument is like "make help".
12 | help:
13 | 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14 | 
15 | .PHONY: help Makefile
16 | 
17 | # Catch-all target: route all unknown targets to Sphinx using the new
18 | # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
19 | %: Makefile
20 | 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
21 | 


--------------------------------------------------------------------------------
/doc/source/index.rst:
--------------------------------------------------------------------------------
 1 | .. on documentation main file, created by
 2 |    sphinx-quickstart on Mon May 18 11:50:23 2020.
 3 |    You can adapt this file completely to your liking, but it should at least
 4 |    contain the root `toctree` directive.
 5 | 
 6 | CMEPS documentation
 7 | ===================
 8 | The Community Mediator for Earth Prediction Systems (CMEPS) is a
 9 | NUOPC-compliant Mediator component used for coupling Earth system
10 | model components. It is currently being used in NCAR's Community
11 | Earth System Model (CESM) and NOAA's subseasonal-to-seasonal
12 | coupled system.
13 | 
14 | Table of contents
15 | -----------------
16 | .. toctree::
17 |    :maxdepth: 2
18 |    :numbered:
19 | 
20 |    introduction.rst
21 |    esmflds.rst
22 |    fractions.rst
23 |    prep.rst
24 |    generic.rst
25 |    addendum/index.rst
26 | 


--------------------------------------------------------------------------------
/.pre-commit-config.yaml:
--------------------------------------------------------------------------------
 1 | exclude: ^utils/.*$
 2 | 
 3 | repos:
 4 |   - repo: https://github.com/pre-commit/pre-commit-hooks
 5 |     rev: v4.0.1
 6 |     hooks:
 7 |       - id: check-xml
 8 |         files: cime_config/
 9 |       - id: end-of-file-fixer
10 |         exclude: doc/
11 |       - id: trailing-whitespace
12 |         exclude: doc/
13 |   - repo: https://github.com/psf/black
14 |     rev: 22.3.0
15 |     hooks:
16 |       - id: black
17 |         files: ./
18 |   - repo: https://github.com/PyCQA/pylint
19 |     rev: v2.11.1
20 |     hooks:
21 |       - id: pylint
22 |         args:
23 |           - --disable=I,C,R,logging-not-lazy,wildcard-import,unused-wildcard-import,fixme,broad-except,bare-except,eval-used,exec-used,global-statement,logging-format-interpolation,no-name-in-module,arguments-renamed,unspecified-encoding,protected-access,import-error,no-member
24 |         files: cime_config
25 | 


--------------------------------------------------------------------------------
/mediator/med_constants_mod.F90:
--------------------------------------------------------------------------------
 1 | module med_constants_mod
 2 | 
 3 |   use med_kind_mod, only : CX=>SHR_KIND_CX, CS=>SHR_KIND_CS, CL=>SHR_KIND_CL, R8=>SHR_KIND_R8
 4 | #ifdef CESMCOUPLED
 5 |   use shr_const_mod
 6 | #else
 7 |   use ufs_const_mod
 8 | #endif
 9 | 
10 |   implicit none
11 |   public
12 | 
13 |   logical,  parameter :: med_constants_statewrite_flag = .false.
14 |   real(R8), parameter :: med_constants_spval_init      = 0.0_R8  ! spval for initialization
15 |   real(R8), parameter :: med_constants_spval           = 0.0_R8  ! spval
16 |   real(R8), parameter :: med_constants_czero           = 0.0_R8  ! spval
17 |   integer,  parameter :: med_constants_ispval_mask     = -987987 ! spval for RH mask values
18 |   integer,  parameter :: med_constants_SecPerDay       = 86400   ! Seconds per day
19 |   integer             :: med_constants_dbug_flag       = 0
20 | 
21 | end module med_constants_mod
22 | 


--------------------------------------------------------------------------------
/cime_config/user_nl_cpl:
--------------------------------------------------------------------------------
 1 | !------------------------------------------------------------------------
 2 | ! Users should ONLY USE user_nl_cpl to change namelists variables
 3 | ! for namelist variables in drv_in (except for the ones below) and
 4 | ! any keyword/values in seq_maps.rc
 5 | ! Users should add ALL user specific namelist and seq_maps.rc changes below
 6 | ! using the following syntax
 7 | !   namelist_var = new_namelist_value
 8 | ! or
 9 | !   mapname = new_map_name
10 | ! For example to change the default value of ocn2atm_fmapname to 'foo' use
11 | !   ocn2atm_fmapname =  'foo'
12 | !
13 | ! Note that some namelist variables MAY NOT be changed in user_nl_cpl - 
14 | ! they are defined in a $CASEROOT xml file and must be changed with
15 | ! xmlchange.
16 | !
17 | ! For example, rather than set username to 'foo' in user_nl_cpl, call
18 | ! ./xmlchange USER=foo
19 | !------------------------------------------------------------------------
20 | 


--------------------------------------------------------------------------------
/cime_config/testdefs/testmods_dirs/drv/asyncio1pernode/shell_commands:
--------------------------------------------------------------------------------
 1 | # This will add one async pio task per node to a test
 2 | # does not work for all cases
 3 | max2() { printf '%d' $(( $1 > $2 ? $1 : $2 )); }
 4 | let totaltasks=0
 5 | ./xmlchange --force --force PIO_ASYNC_INTERFACE=TRUE
 6 | for comp in ATM OCN LND ICE CPL GLC ROF
 7 | do
 8 |   ntasks=`./xmlquery --value NTASKS_$comp`
 9 |   rootpe=`./xmlquery --value ROOTPE_$comp`
10 |   let maxpe=ntasks+rootpe
11 |   totaltasks=$(( $totaltasks > $maxpe ? $totaltasks : $maxpe ))
12 | done
13 | echo "totaltasks is $totaltasks"
14 | tpn=`./xmlquery --value MAX_MPITASKS_PER_NODE`
15 | ./xmlchange --force --force PIO_ASYNCIO_STRIDE=$tpn
16 | let piontasks=totaltasks/tpn
17 | echo "piontasks=$piontasks"
18 | ./xmlchange --force --force PIO_ASYNCIO_NTASKS=$piontasks
19 | let newntasks=totaltasks-piontasks
20 | echo "newntasks=$newntasks"
21 | ./xmlchange --force --force NTASKS=$newntasks
22 | ./xmlchange --force --force PIO_REARRANGER=2
23 | 


--------------------------------------------------------------------------------
/cime_config/config_archive.xml:
--------------------------------------------------------------------------------
 1 | <components version="2.0">
 2 |   <comp_archive_spec compname="drv" compclass="cpl">
 3 |     <rest_file_extension>r</rest_file_extension>
 4 |     <hist_file_extension>h[ix]?\d*\..*\.nc(\.gz)?$</hist_file_extension>
 5 |     <rest_history_varname>unset</rest_history_varname>
 6 |     <rpointer>
 7 |       <rpointer_file>rpointer.cpl$NINST_STRING.$DATENAME</rpointer_file>
 8 |       <rpointer_content >$CASE.cpl$NINST_STRING.r.$DATENAME.nc</rpointer_content>
 9 |     </rpointer>
10 |     <test_file_names>
11 |       <tfile disposition="move">cpl_0001.log.5548574.chadmin1.180228-124723.gz</tfile>
12 |       <tfile disposition="copy">casename.cpl.r.1976-01-01-00000.nc</tfile>
13 |       <tfile disposition="copy">rpointer.cpl_0001.1976-01-01-00000</tfile>
14 |       <tfile disposition="ignore">rpointer.cpl_0001.1976-01-01-43200</tfile>
15 |       <tfile disposition="copy">rpointer.cpl.1976-01-01-00000</tfile>
16 |       <tfile disposition="ignore">casenamenot.cpl.r.1976-01-01-00000.nc</tfile>
17 |     </test_file_names>
18 |   </comp_archive_spec>
19 | 
20 | </components>
21 | 


--------------------------------------------------------------------------------
/ufs/ufs_kind_mod.F90:
--------------------------------------------------------------------------------
 1 | MODULE ufs_kind_mod
 2 | 
 3 |   !----------------------------------------------------------------------------
 4 |   ! precision/kind constants add data public
 5 |   !----------------------------------------------------------------------------
 6 |   public
 7 |   integer,parameter :: SHR_KIND_R8 = selected_real_kind(12) ! 8 byte real
 8 |   integer,parameter :: SHR_KIND_R4 = selected_real_kind( 6) ! 4 byte real
 9 |   integer,parameter :: SHR_KIND_RN = kind(1.0)              ! native real
10 |   integer,parameter :: SHR_KIND_I8 = selected_int_kind (13) ! 8 byte integer
11 |   integer,parameter :: SHR_KIND_I4 = selected_int_kind ( 6) ! 4 byte integer
12 |   integer,parameter :: SHR_KIND_IN = kind(1)                ! native integer
13 |   integer,parameter :: SHR_KIND_CS = 80                     ! short char
14 |   integer,parameter :: SHR_KIND_CM = 160                    ! mid-sized char
15 |   integer,parameter :: SHR_KIND_CL = 256                    ! long char
16 |   integer,parameter :: SHR_KIND_CX = 512                    ! extra-long char
17 |   integer,parameter :: SHR_KIND_CXX= 4096                   ! extra-extra-long char
18 | 
19 | END MODULE ufs_kind_mod
20 | 


--------------------------------------------------------------------------------
/mediator/med_kind_mod.F90:
--------------------------------------------------------------------------------
 1 | module med_kind_mod
 2 | 
 3 |   !----------------------------------------------------------------------------
 4 |   ! precision/kind constants add data public
 5 |   !----------------------------------------------------------------------------
 6 |   public
 7 |   integer,parameter :: SHR_KIND_R8 = selected_real_kind(12) ! 8 byte real
 8 |   integer,parameter :: SHR_KIND_R4 = selected_real_kind( 6) ! 4 byte real
 9 |   integer,parameter :: SHR_KIND_RN = kind(1.0)              ! native real
10 |   integer,parameter :: SHR_KIND_I8 = selected_int_kind (13) ! 8 byte integer
11 |   integer,parameter :: SHR_KIND_I4 = selected_int_kind ( 6) ! 4 byte integer
12 |   integer,parameter :: SHR_KIND_IN = kind(1)                ! native integer
13 |   integer,parameter :: SHR_KIND_CS = 80                     ! short char
14 |   integer,parameter :: SHR_KIND_CM = 160                    ! mid-sized char
15 |   integer,parameter :: SHR_KIND_CL = 256                    ! long char
16 |   integer,parameter :: SHR_KIND_CX = 512                    ! extra-long char
17 |   integer,parameter :: SHR_KIND_CXX= 4096                   ! extra-extra-long char
18 | 
19 | end module med_kind_mod
20 | 


--------------------------------------------------------------------------------
/ufs/ccpp/data/MED_data.F90:
--------------------------------------------------------------------------------
 1 | !> \file MED_data.F90
 2 | !!  Contains type definitions for CMEPS-related and physics-related variables
 3 | 
 4 | module MED_data 
 5 | 
 6 | !> \section arg_table_MED_data
 7 | !! \htmlinclude MED_data.html
 8 | !!
 9 | 
10 |   use MED_typedefs, only: MED_statein_type
11 |   use MED_typedefs, only: MED_stateout_type
12 |   use MED_typedefs, only: MED_init_type
13 |   use MED_typedefs, only: MED_interstitial_type
14 |   use MED_typedefs, only: MED_control_type
15 |   use MED_typedefs, only: MED_coupling_type
16 |   use MED_typedefs, only: MED_grid_type
17 |   use MED_typedefs, only: MED_sfcprop_type  
18 |   use MED_typedefs, only: MED_diag_type
19 |   use ccpp_types,   only: ccpp_t
20 | 
21 |   implicit none
22 | 
23 |   public physics
24 | 
25 | !! \section arg_table_physics_type
26 | !! \htmlinclude physics_type.html
27 | !!
28 |   type physics_type
29 |     type(MED_init_type)         :: init
30 |     type(MED_statein_type)      :: statein
31 |     type(MED_stateout_type)     :: stateout
32 |     type(MED_interstitial_type) :: interstitial
33 |     type(MED_control_type)      :: model
34 |     type(MED_coupling_type)     :: coupling 
35 |     type(MED_grid_type)         :: grid
36 |     type(MED_sfcprop_type)      :: sfcprop
37 |     type(MED_diag_type)         :: diag
38 |   end type physics_type
39 | 
40 |   type(physics_type), save, target :: physics
41 |   type(ccpp_t),       save, target :: cdata
42 | 
43 | contains
44 | 
45 | end module MED_data
46 | 


--------------------------------------------------------------------------------
/CMakeLists.txt:
--------------------------------------------------------------------------------
 1 | cmake_minimum_required(VERSION 3.10)
 2 | include(ExternalProject)
 3 | 
 4 | if (DEFINED CIMEROOT)
 5 |   message("Using CIME in ${CIMEROOT} with compiler ${COMPILER}")
 6 |   include(${CASEROOT}/Macros.cmake)
 7 |   if (${PIO_VERSION} LESS 2)
 8 |     message( FATAL_ERROR "Version 2 of the PIO library required")
 9 |   endif()
10 |   if (${MPILIB} STREQUAL "mpi-serial")
11 |     set(CMAKE_C_COMPILER ${SCC})
12 |     set(CMAKE_Fortran_COMPILER ${SFC})
13 |     set(CMAKE_CXX_COMPILER ${SCXX})
14 |   else()
15 |     set(CMAKE_C_COMPILER ${MPICC})
16 |     set(CMAKE_Fortran_COMPILER ${MPIFC})
17 |     set(CMAKE_CXX_COMPILER ${MPICXX})
18 |   endif()
19 |   set(CMAKE_Fortran_FLAGS "${FFLAGS} -I${LIBROOT}/include -I${LIBROOT}/finclude -I${LIBROOT}/nuopc/esmf/${NINST_VALUE}/include")
20 | else()
21 |   set(BLD_STANDALONE TRUE)
22 | endif()
23 | 
24 | project(CMEPS LANGUAGES Fortran VERSION 0.1)
25 | 
26 | list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
27 | 
28 | message("CMAKE_MODULE_PATH is ${CMAKE_MODULE_PATH}")
29 | 
30 | find_package(ESMF REQUIRED)
31 | if (DEFINED PIO)
32 |   set(PIO_PATH ${PIO})
33 | else()
34 |   set(PIO_PATH $ENV{PIO})
35 | endif()
36 | find_package(PIO REQUIRED COMPONENT C Fortran PATH ${PIO_PATH})
37 | 
38 | if (NOT DEFINED MPILIB OR NOT ${MPILIB} STREQUAL "mpi-serial")
39 |   find_package(MPI REQUIRED)
40 | endif()
41 | 
42 | if(BLD_STANDALONE)
43 |   add_subdirectory(ufs)
44 |   list(APPEND EXTRA_LIBS cmeps_share)
45 |   list(APPEND EXTRA_INCLUDES "${CMAKE_BINARY_DIR}/ufs")
46 | endif()
47 | 
48 | add_subdirectory(mediator)
49 | 


--------------------------------------------------------------------------------
/cesm/nuopc_cap_share/esm_utils_mod.F90:
--------------------------------------------------------------------------------
 1 | module esm_utils_mod
 2 | 
 3 |   implicit none
 4 |   public
 5 | 
 6 |   logical :: maintask
 7 |   integer :: logunit
 8 |   integer :: dbug_flag = 0
 9 | 
10 |   character(*), parameter :: u_FILE_u = &
11 |        __FILE__
12 | 
13 | !===============================================================================
14 | contains
15 | !===============================================================================
16 | 
17 |   logical function ChkErr(rc, line, file, mpierr)
18 | #ifndef NO_MPI2
19 |     use mpi, only : MPI_ERROR_STRING, MPI_MAX_ERROR_STRING, MPI_SUCCESS
20 | #else
21 |     use mpi, only : MPI_SUCCESS
22 | #endif
23 |     use ESMF, only : ESMF_LogFoundError, ESMF_LOGERR_PASSTHRU, ESMF_LOGMSG_INFO
24 |     use ESMF, only : ESMF_FAILURE, ESMF_LogWrite
25 | 
26 |     integer, intent(in) :: rc
27 |     integer, intent(in) :: line
28 | 
29 |     character(len=*), intent(in) :: file
30 |     logical, optional, intent(in) :: mpierr
31 | #ifdef NO_MPI2
32 |     integer, parameter :: MPI_MAX_ERROR_STRING=80
33 | #endif
34 |     character(MPI_MAX_ERROR_STRING) :: lstring
35 |     integer :: dbrc, lrc, len, ierr
36 | 
37 |     ChkErr = .false.
38 |     lrc = rc
39 |     if (present(mpierr)) then
40 |        if(mpierr) then
41 |           if (rc == MPI_SUCCESS) return
42 | #ifdef USE_MPI2
43 |           call MPI_ERROR_STRING(rc, lstring, len, ierr)
44 | #else
45 |           write(lstring,*) "ERROR in mct mpi-serial library rc=",rc
46 | #endif
47 |           call ESMF_LogWrite("ERROR: "//trim(lstring), ESMF_LOGMSG_INFO, line=line, file=file, rc=dbrc)
48 |           lrc = ESMF_FAILURE
49 |        endif
50 |     endif
51 | 
52 |     if (ESMF_LogFoundError(rcToCheck=lrc, msg=ESMF_LOGERR_PASSTHRU, line=line, file=file)) then
53 |        ChkErr = .true.
54 |     endif
55 |   end function ChkErr
56 | 
57 | end module esm_utils_mod
58 | 


--------------------------------------------------------------------------------
/mediator/CMakeLists.txt:
--------------------------------------------------------------------------------
 1 | project(cmeps Fortran)
 2 | 
 3 | set(SRCFILES esmFldsExchange_cesm_mod.F90 med_fraction_mod.F90
 4 |               med_methods_mod.F90 med_phases_prep_ice_mod.F90
 5 |               med_phases_restart_mod.F90 esmFldsExchange_hafs_mod.F90
 6 |               med_internalstate_mod.F90 med_phases_aofluxes_mod.F90
 7 |               med_phases_prep_lnd_mod.F90
 8 |               esmFldsExchange_ufs_mod.F90 med_io_mod.F90
 9 |               med_phases_history_mod.F90 med_phases_prep_ocn_mod.F90
10 |               med_utils_mod.F90 esmFlds.F90 med_kind_mod.F90
11 |               med_phases_prep_rof_mod.F90
12 |               med_constants_mod.F90 med_map_mod.F90
13 |               med_phases_prep_atm_mod.F90 med_phases_prep_wav_mod.F90
14 |               med.F90 med_merge_mod.F90 med_phases_prep_glc_mod.F90
15 |               med_phases_profile_mod.F90 med_diag_mod.F90
16 |               med_phases_post_ocn_mod.F90  med_phases_ocnalb_mod.F90
17 |               med_phases_post_atm_mod.F90 med_phases_post_ice_mod.F90
18 |               med_phases_post_lnd_mod.F90 med_phases_post_glc_mod.F90
19 |               med_phases_post_rof_mod.F90 med_phases_post_wav_mod.F90)
20 | 
21 | foreach(FILE ${SRCFILES})
22 |   if(EXISTS "${CASEROOT}/SourceMods/src.cmeps/${FILE}")
23 |     list(REMOVE_ITEM SRCFILES ${FILE})
24 |     list(APPEND SRCFILES "${CASEROOT}/SourceMods/src.cmeps/${FILE}")
25 |     message("Using ${FILE} from ${CASEROOT}/SourceMods/src.cmeps")
26 |   endif()
27 | endforeach()
28 | add_library(cmeps ${SRCFILES})
29 | 
30 | if(BLD_STANDALONE)
31 |   add_dependencies(cmeps cmeps_share)
32 | endif()
33 | 
34 | target_include_directories (cmeps PUBLIC ${ESMF_F90COMPILEPATHS})
35 | target_include_directories (cmeps PUBLIC "${CMAKE_BINARY_DIR}/ufs")
36 | target_include_directories (cmeps PUBLIC ${PIO_Fortran_INCLUDE_DIR})
37 | 
38 | install(TARGETS cmeps
39 |         LIBRARY DESTINATION lib)
40 | 


--------------------------------------------------------------------------------
/cime_config/runseq/runseq_TG.py:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env python3
 2 | 
 3 | import os, shutil, sys
 4 | from CIME.utils import expect
 5 | from gen_runseq import RunSeq
 6 | from driver_config import DriverConfig
 7 | 
 8 | _CIMEROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), os.pardir,os.pardir,os.pardir,os.pardir))
 9 | sys.path.append(os.path.join(_CIMEROOT, "scripts", "Tools"))
10 | 
11 | from standard_script_setup import *
12 | 
13 | #pylint:disable=undefined-variable
14 | logger = logging.getLogger(__name__)
15 | 
16 | def gen_runseq(case, coupling_times):
17 | 
18 |     rundir         = case.get_value("RUNDIR")
19 |     caseroot       = case.get_value("CASEROOT")
20 | 
21 |     driver_config = DriverConfig(case, coupling_times)
22 |     run_glc, med_to_glc, glc_cpl_time = driver_config['glc']
23 |     run_lnd,  _        , lnd_cpl_time = driver_config['lnd']
24 | 
25 |     if lnd_cpl_time != glc_cpl_time:
26 |         expect(False,"for TG compset require that lnd_cpl_time equal glc_cpl_time")
27 | 
28 |     with RunSeq(os.path.join(caseroot, "CaseDocs", "nuopc.runseq")) as runseq:
29 | 
30 |         runseq.enter_time_loop(glc_cpl_time, True)
31 | 
32 |         runseq.add_action ("LND"                            , run_lnd)
33 |         runseq.add_action ("LND -> MED :remapMethod=redist" , run_lnd)
34 |         runseq.add_action ("MED med_phases_post_lnd"        , run_lnd)
35 |         runseq.add_action ("MED med_phases_prep_glc"        , med_to_glc)
36 |         runseq.add_action ("MED -> GLC :remapMethod=redist" , med_to_glc)
37 |         runseq.add_action ("GLC"                            , run_glc)
38 |         # Need to do GLC -> MED even if not running GLC; otherwise, we get a
39 |         # failure in InitializeRealize ("Object being used before creation")
40 |         runseq.add_action ("GLC -> MED :remapMethod=redist" , med_to_glc)
41 |         runseq.add_action ("MED med_phases_history_write"   , True)
42 | 
43 |         runseq.leave_time_loop(True)
44 | 
45 |     shutil.copy(os.path.join(caseroot, "CaseDocs", "nuopc.runseq"), rundir)
46 | 


--------------------------------------------------------------------------------
/cime_config/ExpectedTestFails.xml:
--------------------------------------------------------------------------------
 1 | <?xml version= "1.0"?>
 2 | 
 3 | <expectedFails version="1.1">
 4 | 
 5 |   <!-- Notes about the format of this file:
 6 | 
 7 |        The required elements for a given failure are just:
 8 | 
 9 |          <test name="...">
10 |            <phase name="...">
11 |              <status>...</status>
12 |            </phase>
13 |          </test>
14 | 
15 |        There can be multiple phase blocks in a given test block.
16 | 
17 |        In addition, a number of optional elements are allowed, which
18 |        currently are just for human consumption (not parsed by any
19 |        scripts):
20 | 
21 |        - A phase block can contain an "issue" element, which gives the
22 |        issue number associated with this failure. (#123 refers to issue
23 |        #123 in the ESCOMP/ctsm repository. Issues in other repositories
24 |        should be specified as ORG/repo#123 - e.g., ESMCI/cime#123.)
25 | 
26 |        - A phase block can contain a "comment" element, which gives any
27 |        sort of comment you desire.
28 |   -->
29 | 
30 | 
31 |   <!-- aux_clm test suite failures -->
32 | 
33 |   <test name="ERR_Vnuopc_Ld5.f19_g16.BMOM.cheyenne_intel.allactive-nuopc_cap_io">
34 |     <phase name="COMPARE_base_rest">
35 |       <status>FAIL</status>
36 |       <comment>Mom restarts are offset</comment>
37 |     </phase>
38 |   </test>
39 |   <test name="ERS_Vnuopc_Ld5.T62_g16.CMOM.cheyenne_intel.mom-nuopc_cap">
40 |     <phase name="COMPARE_base_rest">
41 |       <status>FAIL</status>
42 |       <comment>Mom restarts are offset</comment>
43 |     </phase>
44 |   </test>
45 |   <test name="ERS_Vnuopc_Ld5.T62_g16.GMOM.cheyenne_intel.mom-nuopc_cap">
46 |     <phase name="COMPARE_base_rest">
47 |       <status>FAIL</status>
48 |       <comment>Mom restarts are offset</comment>
49 |     </phase>
50 |   </test>
51 |   <test name="SMS_Vnuopc_Ln11_D.f19_g17_rx1.A.cheyenne_intel">
52 |     <phase name="RUN">
53 |       <status>FAIL</status>
54 |       <comment>Debug run fails due to esmf issue</comment>
55 |     </phase>
56 |   </test>
57 | </expectedFails>
58 | 


--------------------------------------------------------------------------------
/cmake/FindESMF.cmake:
--------------------------------------------------------------------------------
 1 | 
 2 | if (DEFINED ENV{ESMFMKFILE})
 3 |   message("ESMFMKFILE:   $ENV{ESMFMKFILE}")
 4 | else()
 5 |   message(FATAL_ERROR "ESMFMKFILE env variable is not defined")
 6 | endif()
 7 | 
 8 | set(ESMFMKFILE $ENV{ESMFMKFILE})
 9 | 
10 | # convert esmf.mk makefile variables to cmake variables until ESMF
11 | # provides proper cmake package
12 | file(STRINGS ${ESMFMKFILE} esmf_mk_text)
13 | foreach(line ${esmf_mk_text})
14 |   string(REGEX REPLACE "^[ ]+" "" line ${line}) # strip leading spaces
15 |   if (line MATCHES "^ESMF_*")                   # process only line starting with ESMF_
16 |     string(REGEX MATCH "^ESMF_[^=]+" esmf_name ${line})
17 |     string(REPLACE "${esmf_name}=" "" emsf_value ${line})
18 |     set(${esmf_name} "${emsf_value}")
19 |   endif()
20 | endforeach()
21 | string(REPLACE "-I" "" ESMF_F90COMPILEPATHS ${ESMF_F90COMPILEPATHS})
22 | string(REPLACE " " ";" ESMF_F90COMPILEPATHS ${ESMF_F90COMPILEPATHS})
23 | 
24 | # We use only these 4 variables in our build system. Make sure they are all set
25 | if(ESMF_VERSION_MAJOR AND
26 |    ESMF_F90COMPILEPATHS AND
27 |    ESMF_F90ESMFLINKRPATHS AND
28 |    ESMF_F90ESMFLINKLIBS)
29 |   message(" Found ESMF:")
30 |   message("ESMF_VERSION_MAJOR:     ${ESMF_VERSION_MAJOR}")
31 |   message("ESMF_F90COMPILEPATHS:   ${ESMF_F90COMPILEPATHS}")
32 |   message("ESMF_F90ESMFLINKRPATHS: ${ESMF_F90ESMFLINKRPATHS}")
33 |   message("ESMF_F90ESMFLINKLIBS:   ${ESMF_F90ESMFLINKLIBS}")
34 | else()
35 |   message("One of the ESMF_ variables is not defined")
36 | endif()
37 | 
38 | include(FindPackageHandleStandardArgs)
39 | find_package_handle_standard_args(ESMF
40 |                                     FOUND_VAR
41 |                                       ESMF_FOUND
42 |                                     REQUIRED_VARS
43 |                                       ESMF_F90COMPILEPATHS
44 |                                       ESMF_F90ESMFLINKRPATHS
45 |                                       ESMF_F90ESMFLINKLIBS
46 |                                     VERSION_VAR
47 |                                       ESMF_VERSION_STRING)
48 | 


--------------------------------------------------------------------------------
/doc/source/_static/pop_ver.js:
--------------------------------------------------------------------------------
 1 | $(document).ready(function() {
 2 |     /* For a URL that looks like
 3 |     https://blah.github.io/versions/VERSIONFOO/html/bar/index.html, set cur_version_dir to
 4 |     'VERSIONFOO' (i.e., the portion of the path following 'versions').
 5 |     */
 6 |     var proj_end = document.baseURI.indexOf("versions") + 9;
 7 |     var end = document.baseURI.indexOf("/", proj_end);
 8 |     var cur_version_dir = document.baseURI.substring(proj_end, end);
 9 |     var mylist = $("#version-list");
10 |     mylist.empty();
11 |     $.getJSON(version_json_loc, function(data) {
12 |         if (data.hasOwnProperty(cur_version_dir)) {
13 |             /* First add the current version so that it appears first in the drop-down
14 |                menu and starts as the selected element of the menu. If you click on the
15 |                current version, you should stay at the current page.
16 | 
17 |                The conditional around this block should generally be true, but we check it
18 |                just in case the current version is missing from the versions.json file for
19 |                some reason.
20 |             */
21 |             cur_version_name = data[cur_version_dir];
22 |             mylist.append($("<option>", {value: document.baseURI, text: cur_version_name}));
23 |         }
24 |         // Now add the other versions
25 |         $.each(data, function(version_dir, version_name) {
26 |             if (version_dir != cur_version_dir) {
27 |                 /* If you click on a different version, you should go to the root of the
28 |                    documentation for that version. This assumes paths like
29 |                    https://blah.github.io/versions/VERSIONFOO/html/bar/index.html. So we
30 |                    need to go up two levels from the URL_ROOT (html) to then go back down
31 |                    into the appropriate version's html directory.
32 |                 */
33 |                 mylist.append($("<option>", {value: DOCUMENTATION_OPTIONS.URL_ROOT + '../../' + version_dir + '/html', text: version_name}));
34 |             }
35 |         });
36 |     });
37 | });
38 | 


--------------------------------------------------------------------------------
/cime_config/runseq/gen_runseq.py:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env python3
 2 | 
 3 | class RunSeq:
 4 |     def __init__(self, outfile):
 5 |         self.__time_loop = list()
 6 |         self.__outfile_name = outfile
 7 |         self.__outfile = None
 8 | 
 9 |     def __enter__(self):
10 |         self.__outfile = open(self.__outfile_name, "w", encoding="utf-8")
11 |         self.__outfile.write("runSeq:: \n")
12 |         return self
13 | 
14 |     def __exit__(self, *_):
15 |         self.__exit_sequence()
16 |         self.__outfile.close()
17 |         return False
18 | 
19 |     @property
20 |     def time_loop(self):
21 |         if self.__time_loop:
22 |             return self.__time_loop[-1][0]  # this is the first element of the last tuple
23 |         else:
24 |             return 0
25 | 
26 |     @property
27 |     def active_depth(self):
28 |         if self.__time_loop:
29 |             return self.__time_loop[-1][1]
30 |         else:
31 |             return -1
32 | 
33 |     def enter_time_loop(self, coupling_time, active=True, newtime=True, addextra_atsign=False):
34 |         if newtime:
35 |             if addextra_atsign:
36 |                 self.__outfile.write ("@@" + str(coupling_time) + " \n" )
37 |             else:
38 |                 self.__outfile.write ("@" + str(coupling_time) + " \n" )
39 |             if active:
40 |                 self.__time_loop.append((self.time_loop+1, self.active_depth+1))
41 |             else:
42 |                 self.__time_loop.append((self.time_loop+1, self.active_depth))
43 | 
44 |     def add_action(self, action, if_add):
45 |         if if_add:
46 |             self.__outfile.write ("  {}\n".format(action))
47 | 
48 |     def leave_time_loop(self, leave_time, if_write_hist_rest=False, addextra_atsign=False ):
49 |         if leave_time and self.__time_loop:
50 |             _, active_depth = self.__time_loop.pop()
51 |             if if_write_hist_rest or active_depth == 0:
52 |                 self.__outfile.write ("  MED med_phases_history_write        \n" )
53 |                 self.__outfile.write ("  MED med_phases_restart_write        \n" )
54 |                 self.__outfile.write ("  MED med_phases_profile              \n" )
55 |             if addextra_atsign: 
56 |                 self.__outfile.write ("@@ \n" )
57 |             else:
58 |                 self.__outfile.write ("@ \n" )
59 | 
60 |     def __exit_sequence(self):
61 |         while self.__time_loop:
62 |             self.leave_time_loop(True)
63 |         self.__outfile.write ("::\n" )
64 | 


--------------------------------------------------------------------------------
/ufs/ccpp/data/MED_data.meta:
--------------------------------------------------------------------------------
 1 | [ccpp-table-properties]
 2 |   name = physics_type
 3 |   type = ddt
 4 |   dependencies = MED_typedefs.F90
 5 | 
 6 | [ccpp-arg-table]
 7 |   name = physics_type
 8 |   type = ddt 
 9 | [Init]
10 |   standard_name = MED_init_type_instance
11 |   long_name = instance of derived type MED_init_type
12 |   units = DDT
13 |   dimensions = ()
14 |   type = MED_init_type
15 | [Statein]
16 |   standard_name = MED_statein_type_instance
17 |   long_name = instance of derived type MED_statein_type
18 |   units = DDT
19 |   dimensions = ()
20 |   type = MED_statein_type
21 | [Interstitial]
22 |   standard_name = MED_interstitial_type_instance
23 |   long_name = instance of derived type MED_interstitial_type
24 |   units = DDT
25 |   dimensions = ()
26 |   type = MED_interstitial_type
27 | [Model]
28 |   standard_name = MED_control_type_instance
29 |   long_name = instance of derived type MED_control_type
30 |   units = DDT
31 |   dimensions = ()
32 |   type = MED_control_type
33 | [Coupling]
34 |   standard_name = MED_coupling_type_instance
35 |   long_name = instance of derived type MED_coupling_type
36 |   units = DDT
37 |   dimensions = ()
38 |   type = MED_coupling_type
39 | [Grid]
40 |   standard_name = MED_grid_type_instance
41 |   long_name = instance of derived type MED_grid_type
42 |   units = DDT
43 |   dimensions = ()
44 |   type = MED_grid_type
45 | [Sfcprop]
46 |   standard_name = MED_sfcprop_type_instance
47 |   long_name = instance of derived type MED_sfcprop_type
48 |   units = DDT
49 |   dimensions = ()
50 |   type = MED_sfcprop_type
51 | [Diag]
52 |   standard_name = MED_diag_type_instance
53 |   long_name = fields targeted for diagnostic output
54 |   units = DDT
55 |   dimensions = ()
56 |   type = MED_diag_type
57 | 
58 | ########################################################################
59 | [ccpp-table-properties]
60 |   name = MED_data
61 |   type = module
62 |   dependencies = MED_typedefs.F90
63 | 
64 | [ccpp-arg-table]
65 |   name = MED_data
66 |   type = module
67 | [physics_type]
68 |   standard_name = physics_type
69 |   long_name = definition of type physics_type
70 |   units = DDT
71 |   dimensions = ()
72 |   type = physics_type
73 | [physics]
74 |   standard_name = physics_type_instance
75 |   long_name = instance of derived data type physics_type
76 |   units = DDT
77 |   dimensions = ()
78 |   type = physics_type
79 | [cdata]
80 |   standard_name = ccpp_t_instance
81 |   long_name = instance of derived data type ccpp_t
82 |   units = DDT
83 |   dimensions = ()
84 |   type = ccpp_t
85 | 


--------------------------------------------------------------------------------
/cesm/driver/util.F90:
--------------------------------------------------------------------------------
 1 | module util
 2 | 
 3 |   !-----------------------------------------------------------------------------
 4 |   ! CustomFieldDictionaryProto utility module
 5 |   !-----------------------------------------------------------------------------
 6 | 
 7 |   use ESMF, only : ESMF_SUCCESS, ESMF_MAXSTR, ESMF_IOFmt_flag, ESMF_LogWrite
 8 |   use ESMF, only : ESMF_LOGMSG_INFO, ESMF_LOGERR_PASSTHRU, ESMF_LOGFoundError
 9 |   use NUOPC, only : nuopc_freeFormat, nuopc_freeformatLog, nuopc_fieldDictionaryEgest
10 |   
11 |   implicit none
12 |   
13 |   private
14 |   
15 |   public FieldDictionaryLog
16 |   
17 |   !-----------------------------------------------------------------------------
18 |   contains
19 |   !-----------------------------------------------------------------------------
20 | 
21 |   subroutine FieldDictionaryLog(label, iofmt, rc)
22 | 
23 |     character(len=*),      intent(in)            :: label
24 |     type(ESMF_IOFmt_Flag), intent(in),  optional :: iofmt
25 |     integer,               intent(out), optional :: rc
26 | 
27 |     integer                    :: ibeg, iend, length
28 |     character(len=ESMF_MAXSTR) :: sep, title
29 |     type(NUOPC_FreeFormat)     :: freeFormat
30 | 
31 |     if (present(rc)) rc = ESMF_SUCCESS
32 | 
33 |     write(sep,'(64("="))')
34 | 
35 |     ! build section separator with title
36 |     title = "> Begin Field Dictionary: " // trim(label) // " <"
37 |     length = len_trim(title)
38 | 
39 |     ! center title within separator
40 |     ibeg = max((64 - length)/2,1)
41 |     iend = min(ibeg+length-1,ESMF_MAXSTR)
42 |     sep(ibeg:iend) = title(1:iend-ibeg+1)
43 | 
44 |     call ESMF_LogWrite(sep, ESMF_LOGMSG_INFO, rc=rc)
45 |     if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
46 |       line=__LINE__, &
47 |       file=__FILE__)) &
48 |       return  ! bail out
49 | 
50 |     call NUOPC_FieldDictionaryEgest(freeFormat, iofmt=iofmt, rc=rc)
51 |     if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
52 |       line=__LINE__, &
53 |       file=__FILE__)) &
54 |       return  ! bail out
55 | 
56 |     call NUOPC_FreeFormatLog(freeFormat, rc=rc)
57 |     if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
58 |       line=__LINE__, &
59 |       file=__FILE__)) &
60 |       return  ! bail out
61 | 
62 |     ! build section separator with title
63 |     title = "> End Field Dictionary: " // trim(label) // " <"
64 |     length = len_trim(title)
65 | 
66 |     ! align with opening title
67 |     sep = ""
68 |     write(sep,'(64("="))')
69 |     iend = min(ibeg+length-1,ESMF_MAXSTR)
70 |     sep(ibeg:iend) = title(1:iend-ibeg+1)
71 | 
72 |     call ESMF_LogWrite(sep, ESMF_LOGMSG_INFO, rc=rc)
73 |     if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
74 |       line=__LINE__, &
75 |       file=__FILE__)) &
76 |       return  ! bail out
77 | 
78 |   end subroutine FieldDictionaryLog
79 | 
80 | end module
81 | 


--------------------------------------------------------------------------------
/doc/source/addendum/req_attributes.rst:
--------------------------------------------------------------------------------
 1 | .. _attributes:
 2 | 
 3 | ==========================================
 4 |  CMEPS Application Independent Attributes
 5 | ==========================================
 6 | 
 7 | The following attributes are obtained from the respective driver and
 8 | available to all components that the driver uses.  In the case of
 9 | UFS, the UFS driver ingests these attributes from the
10 | ``ufs.configure`` file.  In the case of CESM, the CESM driver ingests
11 | these attributes from the ``nuopc.runconfig`` file.  The list of
12 | attributes below are separated into application independent attributes
13 | and at this time additional attributes required by CESM. There are no
14 | UFS-specific attributes required by the UFS application.
15 | 
16 | 
17 | General
18 | -------
19 | 
20 | **coupling_mode** (required)
21 | 
22 |   The coupling_mode attribute determines which
23 |   ``esmFlds_exchange_xxx_mod.F90`` and ``fd_xxx.yaml`` is used by
24 |   CMEPS and is also leveraged in some of the custom calculations in
25 |   the ``prep`` modules.
26 | 
27 |   The currently supported values for ``coupling_mode`` are ``cesm``, ``ufs.(frac,nfrac).(aoflux)``, and ``hafs``.
28 | 
29 | Scalar attributes
30 | -----------------
31 | 
32 | **ScalarFieldCount**
33 |   The maximum number of scalars that are going to be communicated
34 |   between the mediator and a component.  Currently scalar values are
35 |   put into a field bundle that only contains an undistributed
36 |   dimension equal to the size of ``ScalarFieldCount`` and communicated
37 |   between the component and the mediator on the `main task` of each
38 |   component.
39 | 
40 | **ScalarFieldName** (required)
41 |   This is the name of the scalar field bundle. By default it is ``cpl_scalars``.
42 | 
43 | **ScalarFieldIdxGridNX**, **ScalarFieldIdxGridNY** (required)
44 |   The global number of longitude and latitude points. For unstructured grids::
45 | 
46 |     ScalarFieldIdxGridNY = 1
47 |     ScalarFieldIdxGridNX = global size of mesh
48 | 
49 |   For cases where ``ScalarFieldIdxGridNY`` is not 1, this scalar data
50 |   is needed by the mediator for the history output.
51 | 
52 | **ScalarFieldIdxNextSwCday** (optional)
53 |  Send by the atmosphere component to specify the calendar day of its
54 |  next short wave computation.  This is subsequently used by other
55 |  components (e.g. cesm-land and sea-ice) in determining the zenith
56 |  angle for its albedo calculation. It is also used in the mediator
57 |  routine ``med_phases_ocnalb_mod.F90`` to determine the zenith angle
58 |  in the ocean albedo calculation.
59 | 
60 | Mediator history and restart attributes
61 | ---------------------------------------
62 | 
63 | **history_option**, **history_n** (required)
64 |   Determines the write frequency for a mediator history file (see :ref:`mediator history writes<history_writes>`).
65 | **restart_option**, **restart_n** (required)
66 |   Determines the write frequency for a mediator restart file (see :ref:`mediator restart writes<restart_writes>`).
67 | **read_restart** (required)
68 |   Determines if a mediator restart file is read in.
69 | 


--------------------------------------------------------------------------------
/cime_config/runseq/runseq_D.py:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env python3
 2 | 
 3 | import os, shutil, sys
 4 | from CIME.utils import expect
 5 | from gen_runseq import RunSeq
 6 | from driver_config import DriverConfig
 7 | 
 8 | _CIMEROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), os.pardir,os.pardir,os.pardir,os.pardir))
 9 | sys.path.append(os.path.join(_CIMEROOT, "scripts", "Tools"))
10 | 
11 | from standard_script_setup import *
12 | 
13 | #pylint:disable=undefined-variable
14 | logger = logging.getLogger(__name__)
15 | 
16 | def gen_runseq(case, coupling_times):
17 | 
18 |     rundir   = case.get_value("RUNDIR")
19 |     caseroot = case.get_value("CASEROOT")
20 | 
21 |     driver_config = DriverConfig(case, coupling_times)
22 |     run_atm, med_to_atm, atm_cpl_time = driver_config['atm']
23 |     run_ice, med_to_ice, ice_cpl_time = driver_config['ice']
24 |     run_ocn, med_to_ocn, ocn_cpl_time = driver_config['ocn']
25 |     run_rof, _         , _            = driver_config['rof']
26 | 
27 |     if ice_cpl_time != atm_cpl_time:
28 |         expect(False,"for D compsets require that ice_cpl_time equal atm_cpl_time")
29 | 
30 |     with RunSeq(os.path.join(caseroot, "CaseDocs", "nuopc.runseq")) as runseq:
31 | 
32 |         runseq.enter_time_loop(ocn_cpl_time, newtime=((ocn_cpl_time)))
33 | 
34 |         runseq.add_action("MED med_phases_prep_ocn_avg"    , med_to_ocn)
35 |         runseq.add_action("MED -> OCN :remapMethod=redist" , med_to_ocn)
36 | 
37 |         runseq.enter_time_loop(atm_cpl_time, newtime=((atm_cpl_time < ocn_cpl_time)))
38 | 
39 |         runseq.add_action ("MED med_phases_aofluxes_run"   , run_ocn and run_atm and (med_to_ocn or med_to_atm))
40 |         runseq.add_action ("MED med_phases_prep_ocn_accum" , med_to_ocn)
41 |         runseq.add_action ("MED med_phases_ocnalb_run"     , med_to_ocn)
42 | 
43 |         runseq.add_action ("MED med_phases_prep_ice"        , med_to_ice)
44 |         runseq.add_action ("MED -> ICE :remapMethod=redist" , med_to_ice)
45 | 
46 |         runseq.add_action ("ICE" , run_ice)
47 |         runseq.add_action ("ROF" , run_rof)
48 |         runseq.add_action ("ATM" , run_atm)
49 | 
50 |         runseq.add_action ("ICE -> MED :remapMethod=redist" , run_ice)
51 |         runseq.add_action("MED med_phases_post_ice"         , run_ice)
52 | 
53 |         runseq.add_action ("ROF -> MED :remapMethod=redist" , run_rof)
54 |         runseq.add_action("MED med_phases_post_rof"         , run_rof)
55 | 
56 |         runseq.add_action ("ATM -> MED :remapMethod=redist" , run_atm)
57 |         runseq.add_action ("MED med_phases_history_write"   , atm_cpl_time == ocn_cpl_time)
58 |         runseq.add_action ("MED med_phases_post_atm"        , run_atm)
59 | 
60 |         runseq.leave_time_loop(run_rof and (atm_cpl_time < ocn_cpl_time))
61 | 
62 |         runseq.add_action ("OCN"                            , run_ocn)
63 |         runseq.add_action ("OCN -> MED :remapMethod=redist" , run_ocn)
64 |         runseq.add_action ("MED med_phases_history_write"   , atm_cpl_time < ocn_cpl_time)
65 |         runseq.add_action ("MED med_phases_post_ocn"        , run_ocn)
66 | 
67 |         runseq.leave_time_loop(True)
68 | 
69 |     shutil.copy(os.path.join(caseroot, "CaseDocs", "nuopc.runseq"), rundir)
70 | 


--------------------------------------------------------------------------------
/ufs/ccpp/driver/med_ccpp_driver.F90:
--------------------------------------------------------------------------------
 1 | module med_ccpp_driver
 2 | 
 3 |   use ccpp_types,          only: ccpp_t
 4 |   use ccpp_static_api_med, only: ccpp_physics_init
 5 |   use ccpp_static_api_med, only: ccpp_physics_run
 6 |   use ccpp_static_api_med, only: ccpp_physics_finalize
 7 | 
 8 |   use MED_data,        only: physics, cdata 
 9 | 
10 |   implicit none
11 | 
12 |   private ! default private
13 | 
14 |   public :: med_ccpp_driver_init
15 |   public :: med_ccpp_driver_run
16 |   public :: med_ccpp_driver_finalize
17 | 
18 | !===============================================================================
19 | contains
20 | !===============================================================================
21 | 
22 |   subroutine med_ccpp_driver_init(ccpp_suite)
23 |     implicit none
24 | 
25 |     !--- input arguments --------------------------------
26 |     character(len=*), intent(in) :: ccpp_suite
27 | 
28 |     !--- local variables --------------------------------
29 |     integer :: ierr
30 | 
31 |     ! for physics running over the entire domain, block and thread
32 |     ! number are not used; set to safe values
33 |     cdata%blk_no = 1
34 |     cdata%thrd_no = 1
35 | 
36 |     ! initialize CCPP physics (run all _init routines)
37 |     call ccpp_physics_init(cdata, suite_name=trim(ccpp_suite), ierr=ierr)
38 |     if (ierr /= 0) then
39 |        write(0,'(a)') "An error occurred in ccpp_physics_init"
40 |        write(0,'(a)') trim(cdata%errmsg)
41 |        return
42 |     end if
43 | 
44 |   end subroutine med_ccpp_driver_init
45 | 
46 |   !=============================================================================
47 |   subroutine med_ccpp_driver_run(ccpp_suite, group)
48 |     implicit none
49 | 
50 |     !--- input arguments --------------------------------
51 |     character(len=*), intent(in) :: ccpp_suite
52 |     character(len=*), optional, intent(in) :: group
53 | 
54 |     !--- local variables --------------------------------
55 |     integer :: ierr
56 | 
57 |     ! run CCPP physics (run all _run routines)
58 |     if (present(group)) then
59 |        call ccpp_physics_run(cdata, suite_name=trim(ccpp_suite), group_name=trim(group), ierr=ierr)
60 |     else
61 |        call ccpp_physics_run(cdata, suite_name=trim(ccpp_suite), ierr=ierr)
62 |     end if
63 |     if (ierr /= 0) then
64 |        write(0,'(a)') "An error occurred in ccpp_physics_run"
65 |        write(0,'(a)') trim(cdata%errmsg)
66 |        return
67 |     end if
68 | 
69 |   end subroutine med_ccpp_driver_run
70 | 
71 |   !=============================================================================
72 |   subroutine med_ccpp_driver_finalize(ccpp_suite)
73 |     implicit none
74 | 
75 |     !--- input arguments --------------------------------
76 |     character(len=*), intent(in) :: ccpp_suite
77 | 
78 |     !--- local variables --------------------------------
79 |     integer :: ierr
80 | 
81 |     ! finalize CCPP physics (run all _finalize routines)
82 |     call ccpp_physics_finalize(cdata, suite_name=trim(ccpp_suite), ierr=ierr)
83 |     if (ierr /= 0) then
84 |        write(0,'(a)') "An error occurred in ccpp_physics_finalize"
85 |        write(0,'(a)') trim(cdata%errmsg)
86 |        return
87 |     end if
88 | 
89 |   end subroutine med_ccpp_driver_finalize
90 | 
91 | end module med_ccpp_driver
92 | 


--------------------------------------------------------------------------------
/cesm/nuopc_cap_share/shr_carma_mod.F90:
--------------------------------------------------------------------------------
 1 | module shr_carma_mod
 2 | 
 3 |   !================================================================================
 4 |   ! This reads the carma_inparm namelist in drv_flds_in and makes the relavent
 5 |   ! information available to CAM, CLM, and driver. 
 6 |   !================================================================================
 7 | 
 8 |   use shr_kind_mod , only : r8 => shr_kind_r8, CX => SHR_KIND_CX
 9 |   use shr_sys_mod  , only : shr_sys_abort
10 |   use shr_log_mod  , only : shr_log_getLogUnit
11 |   use shr_nl_mod   , only : shr_nl_find_group_name
12 | 
13 |   implicit none
14 |   private
15 | 
16 |   public :: shr_carma_readnl ! reads carma_inparm namelist
17 | 
18 | !-------------------------------------------------------------------------
19 | contains
20 | !-------------------------------------------------------------------------
21 | 
22 |   subroutine shr_carma_readnl( NLFileName, carma_fields)
23 | 
24 |     !-------------------------------------------------------------------------
25 |     ! This reads the carma_emis_nl namelist group in drv_flds_in and parses the
26 |     ! namelist information for the driver, CLM, and CAM.
27 |     !-------------------------------------------------------------------------
28 | 
29 |     use ESMF, only : ESMF_VM, ESMF_VMGetCurrent, ESMF_VMGet, ESMF_VMBroadcast
30 | 
31 |     character(len=*) , intent(in)  :: NLFileName
32 |     character(len=CX), intent(out) :: carma_fields
33 | 
34 |     type(ESMF_VM) :: vm
35 |     integer :: localPet
36 |     integer :: rc
37 |     integer :: unitn            ! namelist unit number
38 |     integer :: ierr             ! error code
39 |     logical :: exists           ! if file exists or not
40 |     integer :: i, tmp(1)
41 |     integer :: logunit
42 |     character(*),parameter :: F00   = "('(shr_carma_readnl) ',2a)"
43 | 
44 |     namelist /carma_inparm/ carma_fields
45 |     call shr_log_getLogUnit(logunit)
46 | 
47 |     carma_fields = ' '
48 |     call ESMF_VMGetCurrent(vm, rc=rc)
49 |     call ESMF_VMGet(vm, localpet=localpet, rc=rc)
50 |     tmp = 0
51 |     if (localpet==0) then
52 |        inquire( file=trim(NLFileName), exist=exists)
53 |        if ( exists ) then
54 |           open(newunit=unitn, file=trim(NLFilename), status='old' )
55 |           write(logunit,F00) 'Read in carma_inparm namelist from: ', trim(NLFilename)
56 |           call shr_nl_find_group_name(unitn, 'carma_inparm', status=ierr)
57 |           if (ierr == 0) then
58 |              read(unitn, carma_inparm, iostat=ierr)
59 |              if (ierr > 0) then
60 |                 call shr_sys_abort( 'problem on read of carma_inparm namelist in shr_carma_readnl' )
61 |              endif
62 |           else
63 |              write(logunit,*) 'shr_carma_readnl:  no carma_inparm namelist found in ',NLFilename
64 |           end if
65 |           close( unitn )
66 |        else
67 |           write(logunit,*) 'shr_carma_readnl:  no file ',NLFilename, ' found'
68 |        end if
69 |        if (len_trim(carma_fields) > 0) tmp(1)=1
70 |     end if
71 |     call ESMF_VMBroadcast(vm, tmp, 1, 0, rc=rc)
72 |     if(tmp(1) == 1) then
73 |        call ESMF_VMBroadcast(vm, carma_fields, CX, 0, rc=rc)
74 |     endif
75 | 
76 |   end subroutine shr_carma_readnl
77 | 
78 | endmodule shr_carma_mod
79 | 


--------------------------------------------------------------------------------
/ufs/glc_elevclass_mod.F90:
--------------------------------------------------------------------------------
 1 | module glc_elevclass_mod
 2 | 
 3 |   !---------------------------------------------------------------------
 4 |   ! This module contains the interfaces needed by mediator code - but
 5 |   ! is not used by the UFS system
 6 |   !---------------------------------------------------------------------
 7 | 
 8 |   use ufs_kind_mod , only : r8=>shr_kind_r8
 9 | 
10 |   implicit none
11 |   private
12 | 
13 |   !--------------------------------------------------------------------------
14 |   ! Public interfaces
15 |   !--------------------------------------------------------------------------
16 | 
17 |   public :: glc_get_num_elevation_classes ! get the number of elevation classes
18 |   public :: glc_get_elevation_classes     ! get elevation class of each grid cell on the glc grid.
19 |   public :: glc_mean_elevation_virtual    ! get the mean elevation of a virtual elevation class
20 |   public :: glc_get_fractional_icecov     ! get the fractional ice cover for each glc elevation class
21 | 
22 |   interface glc_get_elevation_classes
23 |      module procedure glc_get_elevation_classes_with_bareland
24 |      module procedure glc_get_elevation_classes_without_bareland
25 |   end interface glc_get_elevation_classes
26 | 
27 | contains
28 | 
29 |   !-----------------------------------------------------------------------
30 |   function glc_get_num_elevation_classes() result(num_elevation_classes)
31 |     integer :: num_elevation_classes  ! function result
32 |     num_elevation_classes = 0
33 |   end function glc_get_num_elevation_classes
34 | 
35 |   !-----------------------------------------------------------------------
36 |   subroutine glc_get_elevation_classes_without_bareland(glc_topo, glc_elevclass, logunit)
37 |     real(r8), intent(in)  :: glc_topo(:)      ! topographic height
38 |     integer , intent(out) :: glc_elevclass(:) ! elevation class
39 |     integer , intent(in)  :: logunit
40 |     glc_elevclass = 0
41 |   end subroutine glc_get_elevation_classes_without_bareland
42 | 
43 |   !-----------------------------------------------------------------------
44 |   subroutine glc_get_elevation_classes_with_bareland(glc_ice_covered, glc_topo, glc_elevclass, logunit)
45 |     real(r8), intent(in)  :: glc_ice_covered(:) ! ice-covered (1) vs. ice-free (0)
46 |     real(r8), intent(in)  :: glc_topo(:)        ! ice topographic height
47 |     integer , intent(out) :: glc_elevclass(:)   ! elevation class
48 |     integer , intent(in)  :: logunit
49 |     glc_elevclass = 0
50 |   end subroutine glc_get_elevation_classes_with_bareland
51 | 
52 |   !-----------------------------------------------------------------------
53 |   function glc_mean_elevation_virtual(elevation_class, logunit) result(mean_elevation)
54 |     real(r8) :: mean_elevation  ! function result
55 |     integer, intent(in) :: elevation_class
56 |     integer, optional, intent(in) :: logunit
57 |     mean_elevation = 0.0_r8
58 |   end function glc_mean_elevation_virtual
59 | 
60 |   !-----------------------------------------------------------------------
61 |   subroutine glc_get_fractional_icecov(nec, glc_topo, glc_icefrac, glc_icefrac_ec, logunit)
62 |     integer , intent(in)  :: nec              ! number of elevation classes
63 |     real(r8), intent(in)  :: glc_topo(:)      ! topographic height
64 |     real(r8), intent(in)  :: glc_icefrac(:)
65 |     real(r8), intent(out) :: glc_icefrac_ec(:,:)
66 |     integer , intent(in)  :: logunit
67 |     glc_icefrac_ec = 0.0_r8
68 |   end subroutine glc_get_fractional_icecov
69 | 
70 | end module glc_elevclass_mod
71 | 


--------------------------------------------------------------------------------
/cime_config/config_compsets.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0"?>
  2 | 
  3 | <compsets version="2.0">
  4 | 
  5 |   <help>
  6 |     =========================================
  7 |     compset naming convention
  8 |     =========================================
  9 |     The compset longname below has the specified order
 10 |     atm, lnd, ice, ocn, river, glc wave esp cesm-options
 11 | 
 12 |     The notation for the compset longname below is
 13 |     TIME_ATM[%phys]_LND[%phys]_ICE[%phys]_OCN[%phys]_ROF[%phys]_GLC[%phys]_WAV[%phys][_ESP][_BGC%phys]
 14 | 
 15 |     The following compsets are those that can be tested in CIME stand-alone configurations
 16 |     without any prognostic components.
 17 |     For the compsets below the following are the only allowable values of the components.
 18 | 
 19 |     TIME = Time period (e.g. 2000, HIST, RCP8...)
 20 |     ATM  = [DATM, SATM, XATM]
 21 |     LND  = [DLND, SLND, XLND]
 22 |     ICE  = [DICE, SICE, XICE]
 23 |     OCN  = [DOCN, SOCN, XOCN]
 24 |     ROF  = [DROF, SROF, XROF]
 25 |     GLC  = [      SGLC      ]
 26 |     WAV  = [DWAV, SWAV      ]
 27 |     ESP  = [DESP, SESP      ]
 28 | 
 29 |     The OPTIONAL %phys attributes specify submodes of the given system
 30 |     For example DOCN%DOM is the data ocean model for DOCN
 31 |     ALL data models must have a %phys option that corresponds to the data  model mode
 32 | 
 33 |     Each compset node is associated with the following elements
 34 |     - lname
 35 |     - alias
 36 |     - support  (optional description of the support level for this compset)
 37 |     Each compset node can also have the following attributes
 38 |     - grid  (optional regular expression match for grid to work with the compset)
 39 |   </help>
 40 | 
 41 |   <compset>
 42 |     <alias>AA</alias>
 43 |     <lname>2000_DATM%NYF_DLND%LCPL_DICE%SSMI_DOCN%DOM_DROF%NYF_SGLC_DWAV</lname>
 44 |   </compset>
 45 | 
 46 |   <compset>
 47 |     <alias>A</alias>
 48 |     <lname>2000_DATM%NYF_SLND_DICE%SSMI_DOCN%DOM_DROF%NYF_SGLC_SWAV</lname>
 49 |   </compset>
 50 | 
 51 |   <compset>
 52 |     <alias>ADSOM</alias>
 53 |     <lname>2000_DATM%NYF_SLND_DICE%SSMI_DOCN%SOM_DROF%NYF_SGLC_SWAV_TEST</lname>
 54 |   </compset>
 55 | 
 56 |   <compset>
 57 |     <alias>ADSOMAQP</alias>
 58 |     <lname>2000_DATM%NYF_SLND_SICE_DOCN%SOMAQP_SROF_SGLC_SWAV</lname>
 59 |   </compset>
 60 | 
 61 |   <compset>
 62 |     <alias>ADAQP3</alias>
 63 |     <lname>2000_DATM%NYF_SLND_SICE_DOCN%AQP3_SROF_SGLC_SWAV</lname>
 64 |   </compset>
 65 | 
 66 |   <compset>
 67 |     <alias>ADAQPFILE</alias>
 68 |     <lname>2000_DATM%NYF_SLND_SICE_DOCN%AQPFILE_SROF_SGLC_SWAV</lname>
 69 |   </compset>
 70 | 
 71 |   <compset>
 72 |     <alias>A1850DLND</alias>
 73 |     <lname>1850_SATM_DLND%SCPL_SICE_SOCN_SROF_SGLC_SWAV</lname>
 74 |   </compset>
 75 | 
 76 |   <compset>
 77 |     <alias>ADWAV</alias>
 78 |     <lname>2000_SATM_SLND_SICE_SOCN_SROF_SGLC_DWAV%CLIMO</lname>
 79 |   </compset>
 80 | 
 81 |   <compset>
 82 |     <alias>ADESP</alias>
 83 |     <lname>2000_DATM%NYF_SLND_SICE_DOCN%SOMAQP_SROF_SGLC_SWAV_DESP%NOOP</lname>
 84 |   </compset>
 85 | 
 86 |   <compset>
 87 |     <alias>ADESP_TEST</alias>
 88 |     <lname>2000_DATM%NYF_SLND_SICE_DOCN%SOMAQP_SROF_SGLC_SWAV_DESP%TEST</lname>
 89 |   </compset>
 90 | 
 91 |   <compset>
 92 |     <alias>AIAF</alias>
 93 |     <lname>2000_DATM%IAF_SLND_DICE%IAF_DOCN%IAF_DROF%IAF_SGLC_SWAV</lname>
 94 |   </compset>
 95 | 
 96 |   <compset>
 97 |     <alias>S</alias>
 98 |     <lname>2000_SATM_SLND_SICE_SOCN_SROF_SGLC_SWAV_SESP</lname>
 99 |   </compset>
100 | 
101 |   <compset>
102 |     <alias>X</alias>
103 |     <lname>2000_XATM_XLND_XICE_XOCN_XROF_XGLC_XWAV</lname>
104 |   </compset>
105 | 
106 | </compsets>
107 | 


--------------------------------------------------------------------------------
/cesm/driver/t_driver_timers_mod.F90:
--------------------------------------------------------------------------------
  1 | module t_drv_timers_mod
  2 | 
  3 |   implicit none
  4 |   public :: t_drvstopf, t_drvstartf
  5 |   integer, private :: cpl_run_hash=0, cpl_comm_hash=0, cpl_budget_hash=0
  6 |   character(len=*),parameter :: strcpl = 'CPL:RUN'
  7 |   character(len=*),parameter :: strcom = 'CPL:COMM'
  8 |   character(len=*),parameter :: strbud = 'CPL:BUDGET'
  9 | 
 10 | contains
 11 | 
 12 |   !===============================================================================
 13 | 
 14 |   subroutine t_drvstartf(string,cplrun,cplcom,budget,barrier, hashint)
 15 |     use perf_mod, only : t_barrierf, t_startf, t_adj_detailf
 16 |     implicit none
 17 | 
 18 |     character(len=*),intent(in) :: string
 19 |     logical,intent(in),optional :: cplrun
 20 |     logical,intent(in),optional :: cplcom
 21 |     logical,intent(in),optional :: budget
 22 |     integer,intent(in),optional :: barrier
 23 |     integer,intent(inout), optional :: hashint
 24 | 
 25 |     character(len=128) :: strbar
 26 | 
 27 |     logical :: lcplrun,lcplcom,lbudget
 28 |     !-------------------------------------------------------------------------------
 29 | 
 30 |     lcplrun  = .false.
 31 |     lcplcom  = .false.
 32 |     lbudget  = .false.
 33 |     if (present(cplrun)) then
 34 |        lcplrun = cplrun
 35 |     endif
 36 |     if (present(cplcom)) then
 37 |        lcplcom = cplcom
 38 |     endif
 39 |     if (present(budget)) then
 40 |        lbudget = budget
 41 |     endif
 42 | 
 43 |     if (present(barrier)) then
 44 |        strbar = trim(string)//'_BARRIER'
 45 |        call t_barrierf (trim(strbar), barrier)
 46 |     endif
 47 | 
 48 |     if (lcplrun) then
 49 |        call t_startf   (trim(strcpl), cpl_run_hash)
 50 |        call t_adj_detailf(+1)
 51 |     endif
 52 | 
 53 |     if (lcplcom) then
 54 |        call t_startf   (trim(strcom), cpl_comm_hash)
 55 |        call t_adj_detailf(+1)
 56 |     endif
 57 | 
 58 |     if (lbudget) then
 59 |        call t_startf   (trim(strbud), cpl_budget_hash)
 60 |        call t_adj_detailf(+1)
 61 |     endif
 62 | 
 63 |     call t_startf   (trim(string),hashint)
 64 |     call t_adj_detailf(+1)
 65 | 
 66 |   end subroutine t_drvstartf
 67 | 
 68 |   !===============================================================================
 69 | 
 70 |   subroutine t_drvstopf(string,cplrun,cplcom,budget,hashint)
 71 |     use perf_mod, only : t_stopf, t_adj_detailf
 72 |     implicit none
 73 | 
 74 |     character(len=*),intent(in) :: string
 75 |     logical,intent(in),optional :: cplrun
 76 |     logical,intent(in),optional :: cplcom
 77 |     logical,intent(in),optional :: budget
 78 |     integer, intent(in), optional :: hashint
 79 |     logical :: lcplrun,lcplcom,lbudget
 80 | 
 81 |     !-------------------------------------------------------------------------------
 82 | 
 83 |     lcplrun = .false.
 84 |     lcplcom = .false.
 85 |     lbudget = .false.
 86 |     if (present(cplrun)) then
 87 |        lcplrun = cplrun
 88 |     endif
 89 |     if (present(cplcom)) then
 90 |        lcplcom = cplcom
 91 |     endif
 92 |     if (present(budget)) then
 93 |        lbudget = budget
 94 |     endif
 95 | 
 96 |     call t_adj_detailf(-1)
 97 |     call t_stopf   (trim(string), hashint)
 98 | 
 99 |     if (lbudget) then
100 |        call t_adj_detailf(-1)
101 |        call t_stopf   (trim(strbud), cpl_budget_hash)
102 |     endif
103 | 
104 |     if (lcplrun) then
105 |        call t_adj_detailf(-1)
106 |        call t_stopf   (trim(strcpl), cpl_run_hash)
107 |     endif
108 | 
109 |     if (lcplcom) then
110 |        call t_adj_detailf(-1)
111 |        call t_stopf   (trim(strcom),cpl_comm_hash)
112 |     endif
113 | 
114 |   end subroutine t_drvstopf
115 | 
116 | end module t_drv_timers_mod
117 | 


--------------------------------------------------------------------------------
/mediator/med_utils_mod.F90:
--------------------------------------------------------------------------------
  1 | module med_utils_mod
  2 | 
  3 |   use med_kind_mod, only : CX=>SHR_KIND_CX, CS=>SHR_KIND_CS, CL=>SHR_KIND_CL, R8=>SHR_KIND_R8
  4 | 
  5 |   implicit none
  6 |   private
  7 | 
  8 |   public :: med_memcheck
  9 |   public :: med_utils_ChkErr
 10 |   public :: med_log_clock_advance
 11 | 
 12 |   integer     , parameter :: memdebug_level=1
 13 |   character(*), parameter :: u_FILE_u = &
 14 |        __FILE__
 15 | 
 16 | !===============================================================================
 17 | contains
 18 | !===============================================================================
 19 | 
 20 |   subroutine med_memcheck(string, level, maintask)
 21 |     character(len=*), intent(in) :: string
 22 |     integer, intent(in) :: level
 23 |     logical, intent(in) :: maintask
 24 | #ifdef CESMCOUPLED
 25 |     integer :: ierr
 26 |     integer, external :: GPTLprint_memusage
 27 |     if((maintask .and. memdebug_level > level) .or. memdebug_level > level+1) then
 28 |        ierr = GPTLprint_memusage(string)
 29 |     endif
 30 | #endif
 31 |   end subroutine med_memcheck
 32 | 
 33 | !===============================================================================
 34 | 
 35 |   logical function med_utils_ChkErr(rc, line, file, mpierr)
 36 | #ifndef NO_MPI2
 37 |     use mpi , only : MPI_ERROR_STRING, MPI_MAX_ERROR_STRING, MPI_SUCCESS
 38 | #else
 39 |     use mpi, only : MPI_SUCCESS
 40 | #endif
 41 |     use ESMF, only : ESMF_LogFoundError, ESMF_LOGERR_PASSTHRU, ESMF_LOGMSG_INFO
 42 |     use ESMF, only : ESMF_FAILURE, ESMF_LogWrite
 43 | 
 44 |     integer, intent(in) :: rc
 45 |     integer, intent(in) :: line
 46 | 
 47 |     character(len=*), intent(in) :: file
 48 |     logical, optional, intent(in) :: mpierr
 49 | #ifdef NO_MPI2
 50 |     integer, parameter :: MPI_MAX_ERROR_STRING=80
 51 | #else
 52 |     integer :: ierr, len
 53 | #endif
 54 |     character(MPI_MAX_ERROR_STRING) :: lstring
 55 |     integer :: lrc
 56 | 
 57 |     med_utils_ChkErr = .false.
 58 |     lrc = rc
 59 |     if (present(mpierr)) then
 60 |        if(mpierr) then
 61 |           if (rc == MPI_SUCCESS) return
 62 | #ifdef NO_MPI2
 63 |           write(lstring,*) "ERROR in mct mpi-serial library rc=",rc
 64 | #else
 65 |           call MPI_ERROR_STRING(rc, lstring, len, ierr)
 66 | #endif
 67 |           call ESMF_LogWrite("ERROR: "//trim(lstring), ESMF_LOGMSG_INFO, line=line, file=file)
 68 |           lrc = ESMF_FAILURE
 69 |        endif
 70 |     endif
 71 | 
 72 |     if (ESMF_LogFoundError(rcToCheck=lrc, msg=ESMF_LOGERR_PASSTHRU, line=line, file=file)) then
 73 |       med_utils_ChkErr = .true.
 74 |     endif
 75 | 
 76 |   end function med_utils_ChkErr
 77 | 
 78 | !===============================================================================
 79 | 
 80 |   subroutine med_log_clock_advance(clock, component, logunit)
 81 |     use ESMF, only : ESMF_Clock, ESMF_ClockPrint
 82 | 
 83 |     type(ESMF_Clock) :: clock
 84 |     character(len=*), intent(in) :: component
 85 |     integer, intent(in) :: logunit
 86 | 
 87 |     character(len=CL) :: cvalue, prestring
 88 |     integer :: rc
 89 | 
 90 |     write(prestring, *) "------>Advancing ",trim(component)," from: "
 91 |     call ESMF_ClockPrint(clock, options="currTime", unit=cvalue, &
 92 |          preString=trim(prestring), rc=rc)
 93 |     if (med_utils_ChkErr(rc,__LINE__,u_FILE_u)) return
 94 |     write(logunit, *) trim(cvalue)
 95 | 
 96 |     call ESMF_ClockPrint(clock, options="stopTime", unit=cvalue, &
 97 |          preString="--------------------------------> to: ", rc=rc)
 98 |     if (med_utils_ChkErr(rc,__LINE__,u_FILE_u)) return
 99 |     write(logunit, *) trim(cvalue)
100 | 
101 |   end subroutine med_log_clock_advance
102 | 
103 | end module med_utils_mod
104 | 


--------------------------------------------------------------------------------
/doc/source/prep.rst:
--------------------------------------------------------------------------------
 1 | .. _prep_modules:
 2 | 
 3 | ======================
 4 |  CMEPS `prep` modules
 5 | ======================
 6 | 
 7 | The following modules comprise the "prep phase" CMEPS code:
 8 | 
 9 | **med_phases_prep_atm_mod.F90**: prepares the mediator export state to the atmosphere component
10 | 
11 | **med_phases_prep_ice_mod.F90**: prepares the mediator export state to the sea-ice component
12 | 
13 | **med_phases_prep_glc_mod.F90**: prepares the mediator export state to the land-ice component
14 | 
15 | **med_phases_prep_lnd_mod.F90**: prepares the mediator export state to the land component
16 | 
17 | **med_phases_prep_ocn_mod.F90**: prepares the mediator export state to the ocean component
18 | 
19 | **med_phases_prep_rof_mod.F90**: prepares the mediator export state to the river component
20 | 
21 | **med_phases_prep_wav_mod.F90**: prepares the mediator export state to the wave component
22 | 
23 | 
24 | Each prep phase module has several sections:
25 | 
26 | 1. Mapping each source field that needs to be mapped to the destination mesh.
27 |    This is obtained from the ``addmap`` calls in the application specific ``esmFldsExchange_xxxx_mod.F90``.
28 |    Each `prep` module will call the generic routine  ``med_map_FB_Regrid_Norm`` to do this mapping.
29 | 
30 | 2. Merging the set of source fields that have been mapped to the destination mesh.
31 |    This is obtained from the ``addmrg`` calls in the application specific ``esmFldsExchange_xxxx_mod.F90``.
32 | 
33 | 3. Carrying out optional custom calculations that cannot be specified
34 |    via ``addmap`` or ``addmrg`` calls. Custom calculations are the
35 |    only part of the CMEPS prep phases that can be can be application
36 |    specific. The attribute ``coupling_mode`` is utilized to by the
37 |    prep phases to determine if a particular customization is targeted
38 |    for only one application. Currently prep phase customization
39 |    encompasses the following:
40 | 
41 |    * ``med_phases_prep_atm``:
42 | 
43 |      * Calculation of ocean albedos and atmosphere/ocean fluxes (for CESM).
44 |      * Calculation of land, ice and ocean fractions to send to the atmosphere if those components are present.
45 |    * ``med_phases_prep_ice``:
46 | 
47 |      * Update the scalar data for the time of the next short wave calculation carried out by the atmosphere, used by the
48 |        ice component to determine the zenith angle (for CESM)
49 |      * applicate of precipitation factor received from the ocean component (for CESM)
50 | 
51 |    * ``med_phases_prep_glc``:
52 | 
53 |      * the land-ice component prep phase `ONLY` uses custom code. Land
54 |        import fields that are destined for the land-ice component are
55 |        in elevation classes, whereas the land-ice components requires
56 |        import data that is not in elevation classes. In addition, the
57 |        land-ice component couples at a much longer time scale than the
58 |        land component. The custom code in this module carries out the
59 |        mapping and merged to take data from the land component,
60 |        accumulate it and map the data both in resolution and in the
61 |        compression of elevation class input to non-elevation class
62 |        output. (for CESM)
63 | 
64 |    * ``med_phases_prep_lnd``:
65 | 
66 |      * carry out land-ice to land mapping if land-ice is present (for CESM)
67 |      * update the scalar data for the time of the next short
68 |        wave calculation caried out by the atmosphere (this is needed to the
69 |        land component to determine the zenith angle) (for CESM)
70 | 
71 |    * ``med_phases_prep_ocn``:
72 | 
73 |      * computation of net shortwave that is sent to the ocean.
74 |      * apply precipitation fractor to scale rain and snow sent to ocean
75 | 
76 |    * ``med_phases_prep_rof``:
77 | 
78 |      * reset the irrigation flux to the river model by pulling in
79 |        irrigation out of the rof cells that are proportial to the
80 |        river volume in each cell (for CESM).
81 | 
82 |    * ``med_phases_prep_wav``:
83 | 
84 |      * currently there are no custom calculations.
85 | 


--------------------------------------------------------------------------------
/cesm/flux_atmocn/shr_flux_mod.F90:
--------------------------------------------------------------------------------
 1 | module shr_flux_mod
 2 | 
 3 |   ! constants for atm/ocn/flux calculations
 4 | 
 5 |   use shr_kind_mod,  only : R8=>SHR_KIND_R8, IN=>SHR_KIND_IN ! shared kinds
 6 |   use shr_const_mod, only : shr_const_zvir, shr_const_cpdair, shr_const_cpvir, shr_const_karman, shr_const_g ! shared constants
 7 |   use shr_const_mod, only : shr_const_latvap, shr_const_latice, shr_const_stebol, shr_const_tkfrz
 8 |   use shr_const_mod, only : shr_const_ocn_ref_sal, shr_const_zsrflyr, shr_const_rgas
 9 |   use shr_sys_mod,   only : shr_sys_abort   ! shared system routines
10 | 
11 |   implicit none
12 |   public
13 | 
14 |   public :: shr_flux_adjust_constants ! adjust constant values used in flux calculations. (used by CAM as well)
15 | 
16 |   integer, parameter :: debug = 0 ! internal debug level
17 | 
18 |   ! The follow variables are not declared as parameters so that they can be
19 |   ! adjusted to support aquaplanet and potentially other simple model modes.
20 |   ! The flux_adjust_constants subroutine is called to set the desired
21 |   ! values.  The default values are from shr_const_mod.  Currently they are
22 |   ! only used by the flux_atmocn routine.
23 | 
24 |   real(R8) :: loc_zvir   = shr_const_zvir
25 |   real(R8) :: loc_cpdair = shr_const_cpdair
26 |   real(R8) :: loc_cpvir  = shr_const_cpvir
27 |   real(R8) :: loc_karman = shr_const_karman
28 |   real(R8) :: loc_g      = shr_const_g
29 |   real(R8) :: loc_latvap = shr_const_latvap
30 |   real(R8) :: loc_latice = shr_const_latice
31 |   real(R8) :: loc_stebol = shr_const_stebol
32 |   real(R8) :: loc_tkfrz  = shr_const_tkfrz
33 | 
34 |   ! These control convergence of the iterative flux calculation
35 |   ! (For Large and Pond scheme only; not UA or COARE).
36 |   real(r8) :: flux_con_tol = 0.0_R8
37 |   integer  :: flux_con_max_iter = 2
38 | 
39 |   !--- cold air outbreak parameters  (Mahrt & Sun 1995,MWR) -------------
40 |   logical :: use_coldair_outbreak_mod = .false.
41 | 
42 |   real(R8),parameter    :: alpha = 1.4_R8
43 |   real(R8),parameter    :: maxscl =2._R8  ! maximum wind scaling for flux
44 |   real(R8),parameter    :: td0 = -10._R8  ! start t-ts for scaling
45 | 
46 | !===============================================================================
47 | contains
48 | !===============================================================================
49 | 
50 |   subroutine shr_flux_adjust_constants( &
51 |        zvir, cpair, cpvir, karman, gravit, &
52 |        latvap, latice, stebol, &
53 |        flux_convergence_tolerance, &
54 |        flux_convergence_max_iteration, &
55 |        coldair_outbreak_mod)
56 | 
57 |     ! Adjust local constants.  Used to support simple models.
58 | 
59 |     real(R8)    , optional, intent(in) :: zvir
60 |     real(R8)    , optional, intent(in) :: cpair
61 |     real(R8)    , optional, intent(in) :: cpvir
62 |     real(R8)    , optional, intent(in) :: karman
63 |     real(R8)    , optional, intent(in) :: gravit
64 |     real(R8)    , optional, intent(in) :: latvap
65 |     real(R8)    , optional, intent(in) :: latice
66 |     real(R8)    , optional, intent(in) :: stebol
67 |     real(r8)    , optional, intent(in) :: flux_convergence_tolerance
68 |     integer(in) , optional, intent(in) :: flux_convergence_max_iteration
69 |     logical     , optional, intent(in) :: coldair_outbreak_mod
70 |     !----------------------------------------------------------------------------
71 | 
72 |     if (present(zvir))   loc_zvir   = zvir
73 |     if (present(cpair))  loc_cpdair = cpair
74 |     if (present(cpvir))  loc_cpvir  = cpvir
75 |     if (present(karman)) loc_karman = karman
76 |     if (present(gravit)) loc_g      = gravit
77 |     if (present(latvap)) loc_latvap = latvap
78 |     if (present(latice)) loc_latice = latice
79 |     if (present(stebol)) loc_stebol = stebol
80 |     if (present(flux_convergence_tolerance)) flux_con_tol = flux_convergence_tolerance
81 |     if (present(flux_convergence_max_iteration)) flux_con_max_iter = flux_convergence_max_iteration
82 |     if (present(coldair_outbreak_mod)) use_coldair_outbreak_mod = coldair_outbreak_mod
83 | 
84 |   end subroutine shr_flux_adjust_constants
85 | 
86 | end module shr_flux_mod
87 | 


--------------------------------------------------------------------------------
/cmake/FindPIO.cmake:
--------------------------------------------------------------------------------
  1 | # - Try to find PIO
  2 | #
  3 | # This can be controled by setting PIO_PATH or PIO_<lang>_PATH Cmake variables,
  4 | # where <lang> is the COMPONENT language one needs.
  5 | #
  6 | # Once done, this will define:
  7 | #
  8 | #  PIO_<lang>_FOUND   (BOOL) - system has PIO
  9 | #  PIO_<lang>_IS_SHARED (BOOL) - whether the library is shared/dynamic
 10 | #  PIO_<lang>_INCLUDE_DIR (PATH) - Location of the header files and modules
 11 | #  PIO_<lang>_LIBRARY     (File) - Path to the <lang> library files
 12 | #  PIO_<lang>_LIBRARIES   (List) - link these to use PIO
 13 | #
 14 | # Available COMPONENTS are: C Fortran
 15 | # If no components are specified only C is assumed
 16 | include (LibFind)
 17 | include (LibCheck)
 18 | 
 19 | # Define PIO C Component
 20 | define_package_component(PIO DEFAULT
 21 |                          COMPONENT C
 22 |                          INCLUDE_NAMES pio.h
 23 |                          LIBRARY_NAMES pioc)
 24 | 
 25 | # Define PIO Fortran Component
 26 | define_package_component(PIO
 27 |                          COMPONENT Fortran
 28 |                          INCLUDE_NAMES pio.mod pio.inc
 29 |                          LIBRARY_NAMES piof)
 30 | 
 31 | # Search for list of valid components requested
 32 | find_valid_components(PIO)
 33 | 
 34 | #==============================================================================
 35 | # SEARCH FOR VALIDATED COMPONENTS
 36 | foreach (pcomp IN LISTS PIO_FIND_VALID_COMPONENTS)
 37 | 
 38 |     # If not found already, search...
 39 |     if (NOT PIO_${pcomp}_FOUND)
 40 | 
 41 |         # Manually add the MPI include and library dirs to search paths
 42 |         # and search for the package component
 43 |         if (MPI_${pcomp}_FOUND)
 44 |             initialize_paths (PIO_${pcomp}_PATHS
 45 |                               INCLUDE_DIRECTORIES ${MPI_${pcomp}_INCLUDE_PATH}
 46 |                               LIBRARIES ${MPI_${pcomp}_LIBRARIES})
 47 |             find_package_component(PIO COMPONENT ${pcomp}
 48 |                                    PATHS ${PIO_${pcomp}_PATHS})
 49 |         else ()
 50 |             find_package_component(PIO COMPONENT ${pcomp} HINT PIO_${pcomp}_PATH=${PIO_PATH})
 51 |         endif ()
 52 | 
 53 |         # Continue only if component found
 54 |         if (PIO_${pcomp}_FOUND)
 55 | 
 56 |             # Checks
 57 |             if (pcomp STREQUAL C)
 58 | 
 59 |                 # Check version
 60 |                 check_version (PIO
 61 |                                NAME "pio_meta.h"
 62 |                                HINTS ${PIO_C_INCLUDE_DIRS}
 63 |                                MACRO_REGEX "PIO_VERSION_")
 64 | 
 65 |             endif ()
 66 | 
 67 |             # Dependencies
 68 |             if (pcomp STREQUAL C AND NOT PIO_C_IS_SHARED)
 69 | 
 70 |                 # DEPENDENCY: PnetCDF (if PnetCDF enabled)
 71 |                 check_macro (PIO_HAS_PNETCDF
 72 |                              NAME TryPIO_PNETCDF.c
 73 |                              HINTS ${CMAKE_MODULE_PATH}
 74 |                              DEFINITIONS -I${PIO_C_INCLUDE_DIR}
 75 |                              COMMENT "whether PIO has PnetCDF support")
 76 |                 if (PIO_HAS_PNETCDF)
 77 |                     find_package (PnetCDF COMPONENTS C)
 78 |                 endif ()
 79 | 
 80 | 
 81 |             elseif (pcomp STREQUAL Fortran AND NOT PIO_Fortran_IS_SHARED)
 82 | 
 83 |                 # DEPENDENCY: PIO
 84 |                 set (orig_comp ${pcomp})
 85 |                 set (orig_comps ${PIO_FIND_VALID_COMPONENTS})
 86 |                 find_package (PIO COMPONENTS C)
 87 |                 set (PIO_FIND_VALID_COMPONENTS ${orig_comps})
 88 |                 set (pcomp ${orig_comp})
 89 |                 if (PIO_C_FOUND)
 90 |                     list (APPEND PIO_Fortran_INCLUDE_DIRS ${PIO_C_INCLUDE_DIRS})
 91 |                     list (APPEND PIO_Fortran_LIBRARIES ${PIO_C_LIBRARIES})
 92 |                 endif ()
 93 | 
 94 |             endif ()
 95 | 
 96 |         endif ()
 97 | 
 98 |     endif ()
 99 | 
100 | endforeach ()
101 | message("PIO_C_FOUND ${PIO_C_FOUND}")
102 | message("PIO_Fortran_FOUND ${PIO_Fortran_FOUND}")
103 | message("PIO_Fortran_INCLUDE_DIR ${PIO_Fortran_INCLUDE_DIR}")
104 | 


--------------------------------------------------------------------------------
/cmake/LibCheck.cmake:
--------------------------------------------------------------------------------
  1 | include (CMakeParseArguments)
  2 | include (CheckFunctionExists)
  3 | #==============================================================================
  4 | #
  5 | #  FUNCTIONS TO HELP WITH Check* MODULES
  6 | #
  7 | #==============================================================================
  8 | 
  9 | #______________________________________________________________________________
 10 | # - Basic function to check a property of a package using a try_compile step
 11 | #
 12 | # SYNTAX:  check_macro (<return_variable>
 13 | #                          NAME <filename>
 14 | #                          HINTS <path> <path> ...
 15 | #                          DEFINITIONS <definition1> <definition> ...
 16 | #                          COMMENT <string_comment>)
 17 | #
 18 | function (check_macro VARIABLE)
 19 | 
 20 |     # Parse the input arguments
 21 |     set (oneValueArgs COMMENT NAME)
 22 |     set (multiValueArgs HINTS DEFINITIONS)
 23 |     cmake_parse_arguments (${VARIABLE} "" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
 24 | 
 25 |     # If the return variable is defined, already, don't continue
 26 |     if (NOT DEFINED ${VARIABLE})
 27 | 
 28 |         message (STATUS "Checking ${${VARIABLE}_COMMENT}")
 29 |         find_file (${VARIABLE}_TRY_FILE
 30 |                    NAMES ${${VARIABLE}_NAME}
 31 |                    HINTS ${${VARIABLE}_HINTS})
 32 |         if (${VARIABLE}_TRY_FILE)
 33 |             try_compile (COMPILE_RESULT
 34 |                          ${CMAKE_CURRENT_BINARY_DIR}/try${VARIABLE}
 35 |                          SOURCES ${${VARIABLE}_TRY_FILE}
 36 |                          COMPILE_DEFINITIONS ${${VARIABLE}_DEFINITIONS}
 37 |                          OUTPUT_VARIABLE TryOUT)
 38 |             if (COMPILE_RESULT)
 39 |                 message (STATUS "Checking ${${VARIABLE}_COMMENT} - yes")
 40 |             else ()
 41 |                 message (STATUS "Checking ${${VARIABLE}_COMMENT} - no")
 42 |             endif ()
 43 | 
 44 |             set (${VARIABLE} ${COMPILE_RESULT}
 45 |                  CACHE BOOL "${${VARIABLE}_COMMENT}")
 46 | 
 47 |         else ()
 48 |             message (STATUS "Checking ${${VARIABLE}_COMMENT} - failed")
 49 |         endif ()
 50 | 
 51 |         unset (${VARIABLE}_TRY_FILE CACHE)
 52 |     endif ()
 53 | 
 54 | endfunction ()
 55 | 
 56 | #______________________________________________________________________________
 57 | # - Basic function to check the version of a package using a try_run step
 58 | #
 59 | # SYNTAX:  check_version (<pkg>
 60 | #                         NAME <try_version_file>
 61 | #                         HINTS <path> <path> ...
 62 | #                         DEFINITIONS <definition1> <definition> ...)
 63 | #
 64 | function (check_version PKG)
 65 | 
 66 |     # Parse the input arguments
 67 |     set (oneValueArgs NAME MACRO_REGEX)
 68 |     set (multiValueArgs HINTS)
 69 |     cmake_parse_arguments (${PKG} "" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
 70 | 
 71 |     # If the return variable is defined, already, don't continue
 72 |     if (NOT DEFINED ${PKG}_VERSION)
 73 | 
 74 |         message (STATUS "Checking ${PKG} version")
 75 |         find_file (${PKG}_VERSION_HEADER
 76 |                    NAMES ${${PKG}_NAME}
 77 |                    HINTS ${${PKG}_HINTS})
 78 |         if (${PKG}_VERSION_HEADER)
 79 |             set (def)
 80 |             file (STRINGS ${${PKG}_VERSION_HEADER} deflines
 81 |                   REGEX "^#define[ \\t]+${${PKG}_MACRO_REGEX}")
 82 |             foreach (defline IN LISTS deflines)
 83 |                 string (REPLACE "\"" "" defline "${defline}")
 84 |                 string (REPLACE "." "" defline "${defline}")
 85 |                 string (REGEX REPLACE "[ \\t]+" ";" deflist "${defline}")
 86 |                 list (GET deflist 2 arg)
 87 |                 list (APPEND def ${arg})
 88 |             endforeach ()
 89 |             string (REPLACE ";" "." vers "${def}")
 90 |             message (STATUS "Checking ${PKG} version - ${vers}")
 91 |             set (${PKG}_VERSION ${vers}
 92 |                  CACHE STRING "${PKG} version string")
 93 |             if (${PKG}_VERSION VERSION_LESS ${PKG}_FIND_VERSION})
 94 |                 message (FATAL_ERROR "${PKG} version insufficient")
 95 |             endif ()
 96 |         else ()
 97 |             message (STATUS "Checking ${PKG} version - failed")
 98 |         endif ()
 99 | 
100 |         unset (${PKG}_VERSION_HEADER CACHE)
101 | 
102 |     endif ()
103 | 
104 | endfunction ()


--------------------------------------------------------------------------------
/.github/workflows/extbuild.yml:
--------------------------------------------------------------------------------
  1 | # This is a workflow to compile the cmeps source without cime
  2 | name: extbuild
  3 | 
  4 | # Controls when the action will run. Triggers the workflow on push or pull request
  5 | # events but only for the main branch
  6 | on:
  7 |   push:
  8 |     branches: [ main ]
  9 |   pull_request:
 10 |     branches: [ main ]
 11 | 
 12 | # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 13 | jobs:
 14 |   build-cmeps:
 15 |     runs-on: ubuntu-latest
 16 |     env:
 17 |       CC: mpicc
 18 |       FC: mpifort
 19 |       CXX: mpicxx
 20 |       CPPFLAGS: "-I/usr/include -I/usr/local/include"
 21 | 
 22 |       # Versions of all dependencies can be updated here
 23 |       ESMF_VERSION: v8.8.0
 24 |       PNETCDF_VERSION: checkpoint.1.14.0
 25 |       NETCDF_FORTRAN_VERSION: v4.6.1
 26 |       PIO_VERSION: pio2_6_5
 27 |       CDEPS_VERSION: cdeps1.0.80
 28 |     steps:
 29 |       - uses: actions/checkout@v4
 30 |         # Build the ESMF library, if the cache contains a previous build
 31 |         # it will be used instead
 32 |       - id: load-env
 33 |         run: |
 34 |           sudo apt-get update
 35 |           sudo apt-get update
 36 |           sudo apt-get install gfortran
 37 |           sudo apt-get install wget
 38 |           sudo apt-get install openmpi-bin libopenmpi-dev
 39 |           sudo apt-get install netcdf-bin libnetcdf-dev libnetcdff-dev
 40 |           sudo apt-get install pnetcdf-bin libpnetcdf-dev
 41 |           sudo apt-get install autotools-dev autoconf
 42 |       - id: cache-esmf
 43 |         uses: actions/cache@v4
 44 |         with:
 45 |           path: ~/ESMF
 46 |           key: ${{ runner.os }}-${{ env.ESMF_VERSION }}-ESMF
 47 |       - name: Cache ParallelIO
 48 |         id: cache-ParallelIO
 49 |         uses: actions/cache@v4
 50 |         with:
 51 |           path: ~/pio
 52 |           key: ${{ runner.os }}-${{ env.PIO_VERSION }}.pio
 53 |       - name: Build ParallelIO
 54 |         if: steps.cache-ParallelIO.outputs.cache-hit != 'true'
 55 |         uses: NCAR/ParallelIO/.github/actions/parallelio_cmake@pio2_6_0
 56 |         with:
 57 |           parallelio_version: ${{ env.ParallelIO_VERSION }}
 58 |           enable_fortran: True
 59 |           install_prefix: $HOME/pio
 60 |       - name: Build ESMF
 61 |         if: steps.cache-esmf.outputs.cache-hit != 'true'
 62 |         uses: ESCOMP/CDEPS/.github/actions/buildesmf@cdeps1.0.15
 63 |         with:
 64 |           esmf_version: ${{ env.ESMF_VERSION }}
 65 |           esmf_bopt: g
 66 |           esmf_comm: openmpi
 67 |           install_prefix: $HOME/ESMF
 68 |           netcdf_c_path: /usr
 69 |           netcdf_fortran_path: /usr
 70 |           pnetcdf_path: /usr
 71 |           parallelio_path: $HOME/pio
 72 |       - name: Cache CDEPS
 73 |         id: cache-cdeps
 74 |         uses: actions/cache@v4
 75 |         with:
 76 |           path: /homme/runner/work/CMEPS/CMEPS/build-cdeps
 77 |           key: ${{ runner.os }}-${{ env.CDEPS_VERSION }}.cdeps1
 78 | 
 79 |       - name: checkout CDEPS
 80 |         uses: actions/checkout@v4
 81 |         with:
 82 |           repository: ESCOMP/CDEPS
 83 |           path: cdeps-src
 84 |           ref: ${{ env.CDEPS_VERSION }}
 85 |       - name: get genf90
 86 |         run: |
 87 |           cd cdeps-src
 88 |           git submodule update --init
 89 |       - name: Build CDEPS
 90 |         if: steps.cache-cdeps.outputs.cache-hit != 'true'
 91 |         uses: ESCOMP/CDEPS/.github/actions/buildcdeps@cdeps1.0.26
 92 |         with:
 93 |           esmfmkfile: $HOME/ESMF/lib/libg/Linux.gfortran.64.openmpi.default/esmf.mk
 94 |           pio_path: $HOME/pio
 95 |           src_root: ${GITHUB_WORKSPACE}/cdeps-src
 96 |           cmake_flags: " -Wno-dev -DDISABLE_FoX=ON -DCMAKE_BUILD_TYPE=DEBUG -DWERROR=ON  -DCMAKE_Fortran_FLAGS=\"-DCPRGNU -g -Wall \
 97 |           -ffree-form -ffree-line-length-none -fallow-argument-mismatch \""
 98 | 
 99 |       - name: Build CMEPS
100 |         run: |
101 |           export PIO=$HOME/pio
102 |           export ESMFMKFILE=$HOME/ESMF/lib/libg/Linux.gfortran.64.openmpi.default/esmf.mk
103 |           mkdir build-cmeps
104 |           pushd build-cmeps
105 |           cmake -DCMAKE_BUILD_TYPE=DEBUG -DCMAKE_Fortran_FLAGS="-g -Wall -Werror -ffree-form -ffree-line-length-none  -Wno-unused-dummy-argument -I /home/runner/work/CMEPS/CMEPS/build-cdeps/share" ../
106 |           make VERBOSE=1
107 |           popd
108 | 
109 | #      - name: Setup tmate session
110 | #        if: ${{ failure() }}
111 | #        uses: mxschmitt/action-tmate@v3
112 | 


--------------------------------------------------------------------------------
/mediator/med_phases_post_wav_mod.F90:
--------------------------------------------------------------------------------
  1 | module med_phases_post_wav_mod
  2 | 
  3 |   implicit none
  4 |   private
  5 | 
  6 |   public :: med_phases_post_wav
  7 | 
  8 |   character(*), parameter :: u_FILE_u  = &
  9 |        __FILE__
 10 | 
 11 | !-----------------------------------------------------------------------------
 12 | contains
 13 | !-----------------------------------------------------------------------------
 14 | 
 15 |   subroutine med_phases_post_wav(gcomp, rc)
 16 | 
 17 |     use NUOPC_Mediator        , only : NUOPC_MediatorGet
 18 |     use ESMF                  , only : ESMF_Clock, ESMF_ClockIsCreated
 19 |     use ESMF                  , only : ESMF_LogWrite, ESMF_LOGMSG_INFO, ESMF_SUCCESS
 20 |     use ESMF                  , only : ESMF_GridComp
 21 |     use med_kind_mod          , only : CX=>SHR_KIND_CX, CS=>SHR_KIND_CS, CL=>SHR_KIND_CL, R8=>SHR_KIND_R8
 22 |     use med_constants_mod     , only : dbug_flag   => med_constants_dbug_flag
 23 |     use med_utils_mod         , only : chkerr      => med_utils_ChkErr
 24 |     use med_methods_mod       , only : FB_diagnose => med_methods_FB_diagnose
 25 |     use med_map_mod           , only : med_map_field_packed
 26 |     use med_internalstate_mod , only : InternalState
 27 |     use med_internalstate_mod , only : compwav, compatm, compocn, compice
 28 |     use med_phases_history_mod, only : med_phases_history_write_comp
 29 |     use perf_mod              , only : t_startf, t_stopf
 30 | 
 31 |     ! input/output variables
 32 |     type(ESMF_GridComp)  :: gcomp
 33 |     integer, intent(out) :: rc
 34 | 
 35 |     ! local variables
 36 |     type(InternalState) :: is_local
 37 |     type(ESMF_Clock)    :: dClock
 38 |     character(len=*),parameter :: subname='(med_phases_post_wav)'
 39 |     !-------------------------------------------------------------------------------
 40 | 
 41 |     call t_startf('MED:'//subname)
 42 |     rc = ESMF_SUCCESS
 43 | 
 44 |     if (dbug_flag > 5) then
 45 |        call ESMF_LogWrite(subname//' called', ESMF_LOGMSG_INFO)
 46 |     end if
 47 | 
 48 |     ! Get the internal state
 49 |     nullify(is_local%wrap)
 50 |     call ESMF_GridCompGetInternalState(gcomp, is_local, rc)
 51 |     if (ChkErr(rc,__LINE__,u_FILE_u)) return
 52 | 
 53 |     ! map wav to atm
 54 |     if (is_local%wrap%med_coupling_active(compwav,compatm)) then
 55 |        call med_map_field_packed( &
 56 |             FBSrc=is_local%wrap%FBImp(compwav,compwav), &
 57 |             FBDst=is_local%wrap%FBImp(compwav,compatm), &
 58 |             FBFracSrc=is_local%wrap%FBFrac(compwav), &
 59 |             field_NormOne=is_local%wrap%field_normOne(compwav,compatm,:), &
 60 |             packed_data=is_local%wrap%packed_data(compwav,compatm,:), &
 61 |             routehandles=is_local%wrap%RH(compwav,compatm,:), rc=rc)
 62 |        if (ChkErr(rc,__LINE__,u_FILE_u)) return
 63 |     end if
 64 |     ! map wav to ocn
 65 |     if (is_local%wrap%med_coupling_active(compwav,compocn)) then
 66 |        call med_map_field_packed( &
 67 |             FBSrc=is_local%wrap%FBImp(compwav,compwav), &
 68 |             FBDst=is_local%wrap%FBImp(compwav,compocn), &
 69 |             FBFracSrc=is_local%wrap%FBFrac(compwav), &
 70 |             field_NormOne=is_local%wrap%field_normOne(compwav,compocn,:), &
 71 |             packed_data=is_local%wrap%packed_data(compwav,compocn,:), &
 72 |             routehandles=is_local%wrap%RH(compwav,compocn,:), rc=rc)
 73 |        if (ChkErr(rc,__LINE__,u_FILE_u)) return
 74 |     end if
 75 |     ! map wav to ice
 76 |     if (is_local%wrap%med_coupling_active(compwav,compice)) then
 77 |        call med_map_field_packed( &
 78 |             FBSrc=is_local%wrap%FBImp(compwav,compwav), &
 79 |             FBDst=is_local%wrap%FBImp(compwav,compice), &
 80 |             FBFracSrc=is_local%wrap%FBFrac(compwav), &
 81 |             field_NormOne=is_local%wrap%field_normOne(compwav,compice,:), &
 82 |             packed_data=is_local%wrap%packed_data(compwav,compice,:), &
 83 |             routehandles=is_local%wrap%RH(compwav,compice,:), rc=rc)
 84 |        if (ChkErr(rc,__LINE__,u_FILE_u)) return
 85 |     end if
 86 | 
 87 |     ! Write atm inst, avg or aux if requested in mediator attributes
 88 |     call NUOPC_MediatorGet(gcomp, driverClock=dClock, rc=rc)
 89 |     if (ChkErr(rc,__LINE__,u_FILE_u)) return
 90 |     if (ESMF_ClockIsCreated(dclock)) then
 91 |        call med_phases_history_write_comp(gcomp, compwav, rc=rc)
 92 |        if (ChkErr(rc,__LINE__,u_FILE_u)) return
 93 |     end if
 94 | 
 95 |     call t_stopf('MED:'//subname)
 96 |     if (dbug_flag > 20) then
 97 |        call ESMF_LogWrite(subname//' done', ESMF_LOGMSG_INFO)
 98 |     end if
 99 | 
100 |   end subroutine med_phases_post_wav
101 | 
102 | end module med_phases_post_wav_mod
103 | 


--------------------------------------------------------------------------------
/mediator/med_phases_post_ice_mod.F90:
--------------------------------------------------------------------------------
  1 | module med_phases_post_ice_mod
  2 | 
  3 |   !-----------------------------------------------------------------------------
  4 |   ! Mediator phases updating fractions and mapping ice->atm and ice->ocn
  5 |   !-----------------------------------------------------------------------------
  6 | 
  7 |   implicit none
  8 |   private
  9 | 
 10 |   public :: med_phases_post_ice
 11 | 
 12 |   character(*), parameter :: u_FILE_u  = &
 13 |        __FILE__
 14 | 
 15 | !-----------------------------------------------------------------------------
 16 | contains
 17 | !-----------------------------------------------------------------------------
 18 | 
 19 |   subroutine med_phases_post_ice(gcomp, rc)
 20 | 
 21 |     use NUOPC_Mediator        , only : NUOPC_MediatorGet
 22 |     use ESMF                  , only : ESMF_Clock, ESMF_ClockIsCreated
 23 |     use ESMF                  , only : ESMF_LogWrite, ESMF_LOGMSG_INFO, ESMF_SUCCESS
 24 |     use ESMF                  , only : ESMF_GridComp
 25 |     use med_kind_mod          , only : CX=>SHR_KIND_CX, CS=>SHR_KIND_CS, CL=>SHR_KIND_CL, R8=>SHR_KIND_R8
 26 |     use med_constants_mod     , only : dbug_flag   => med_constants_dbug_flag
 27 |     use med_utils_mod         , only : chkerr      => med_utils_ChkErr
 28 |     use med_methods_mod       , only : FB_diagnose => med_methods_FB_diagnose
 29 |     use med_map_mod           , only : med_map_field_packed
 30 |     use med_fraction_mod      , only : med_fraction_set
 31 |     use med_internalstate_mod , only : InternalState
 32 |     use med_phases_history_mod, only : med_phases_history_write_comp
 33 |     use med_internalstate_mod , only : compice, compocn, compwav
 34 |     use perf_mod              , only : t_startf, t_stopf
 35 | 
 36 |     ! input/output variables
 37 |     type(ESMF_GridComp)  :: gcomp
 38 |     integer, intent(out) :: rc
 39 | 
 40 |     ! local variables
 41 |     type(InternalState) :: is_local
 42 |     type(ESMF_Clock)    :: dClock
 43 |     character(len=*),parameter :: subname='(med_phases_post_ice)'
 44 |     !-------------------------------------------------------------------------------
 45 | 
 46 |     call t_startf('MED:'//subname)
 47 |     rc = ESMF_SUCCESS
 48 | 
 49 |     if (dbug_flag > 20) then
 50 |        call ESMF_LogWrite(subname//' called', ESMF_LOGMSG_INFO)
 51 |     end if
 52 | 
 53 |     ! get the internal state
 54 |     nullify(is_local%wrap)
 55 |     call ESMF_GridCompGetInternalState(gcomp, is_local, rc)
 56 |     if (ChkErr(rc,__LINE__,u_FILE_u)) return
 57 | 
 58 |     ! update ice fraction
 59 |     call med_fraction_set(gcomp, rc)
 60 |     if (ChkErr(rc,__LINE__,u_FILE_u)) return
 61 | 
 62 |     ! map ice to ocn
 63 |     if (is_local%wrap%med_coupling_active(compice,compocn)) then
 64 |        call t_startf('MED:'//trim(subname)//' map_ice2ocn')
 65 |        call med_map_field_packed( &
 66 |             FBSrc=is_local%wrap%FBImp(compice,compice), &
 67 |             FBDst=is_local%wrap%FBImp(compice,compocn), &
 68 |             FBFracSrc=is_local%wrap%FBFrac(compice), &
 69 |             field_normOne=is_local%wrap%field_normOne(compice,compocn,:), &
 70 |             packed_data=is_local%wrap%packed_data(compice,compocn,:), &
 71 |             routehandles=is_local%wrap%RH(compice,compocn,:), rc=rc)
 72 |        if (ChkErr(rc,__LINE__,u_FILE_u)) return
 73 |        call t_stopf('MED:'//trim(subname)//' map_ice2ocn')
 74 |     end if
 75 |     ! map ice to wav
 76 |     if (is_local%wrap%med_coupling_active(compice,compwav)) then
 77 |        call t_startf('MED:'//trim(subname)//' map_ice2wav')
 78 |        call med_map_field_packed( &
 79 |             FBSrc=is_local%wrap%FBImp(compice,compice), &
 80 |             FBDst=is_local%wrap%FBImp(compice,compwav), &
 81 |             FBFracSrc=is_local%wrap%FBFrac(compice), &
 82 |             field_normOne=is_local%wrap%field_normOne(compice,compwav,:), &
 83 |             packed_data=is_local%wrap%packed_data(compice,compwav,:), &
 84 |             routehandles=is_local%wrap%RH(compice,compwav,:), rc=rc)
 85 |        if (ChkErr(rc,__LINE__,u_FILE_u)) return
 86 |        call t_stopf('MED:'//trim(subname)//' map_ice2wav')
 87 |     end if
 88 | 
 89 |     ! Write ice inst, avg or aux if requested in mediator attributes
 90 |     call NUOPC_MediatorGet(gcomp, driverClock=dClock, rc=rc)
 91 |     if (ChkErr(rc,__LINE__,u_FILE_u)) return
 92 |     if (ESMF_ClockIsCreated(dclock)) then
 93 |        call med_phases_history_write_comp(gcomp, compice, rc=rc)
 94 |        if (ChkErr(rc,__LINE__,u_FILE_u)) return
 95 |     end if
 96 | 
 97 |     call t_stopf('MED:'//subname)
 98 |     if (dbug_flag > 20) then
 99 |        call ESMF_LogWrite(subname//' done', ESMF_LOGMSG_INFO)
100 |     end if
101 | 
102 |   end subroutine med_phases_post_ice
103 | 
104 | end module med_phases_post_ice_mod
105 | 


--------------------------------------------------------------------------------
/cesm/nuopc_cap_share/shr_ndep_mod.F90:
--------------------------------------------------------------------------------
  1 | module shr_ndep_mod
  2 | 
  3 |   !========================================================================
  4 |   ! Module for handling nitrogen depostion of tracers.
  5 |   ! This module is shared by land and atmosphere models for the computations of
  6 |   ! dry deposition of tracers
  7 |   !========================================================================
  8 | 
  9 |   use ESMF         , only : ESMF_VMGetCurrent, ESMF_VM, ESMF_VMGet
 10 |   use ESMF         , only : ESMF_LogFoundError, ESMF_LOGERR_PASSTHRU, ESMF_SUCCESS
 11 |   use shr_sys_mod  , only : shr_sys_abort
 12 |   use shr_log_mod  , only : shr_log_getLogUnit
 13 |   use shr_kind_mod , only : r8 => shr_kind_r8
 14 |   use shr_nl_mod   , only : shr_nl_find_group_name
 15 |   use shr_mpi_mod  , only : shr_mpi_bcast
 16 | 
 17 |   implicit none
 18 |   private
 19 | 
 20 |   ! !PUBLIC MEMBER FUNCTIONS
 21 |   public :: shr_ndep_readnl       ! Read namelist
 22 | 
 23 |   character(len=*), parameter :: &
 24 |        u_FILE_u=__FILE__
 25 | 
 26 | !====================================================================================
 27 | CONTAINS
 28 | !====================================================================================
 29 | 
 30 |   subroutine shr_ndep_readnl(NLFilename, ndep_nflds)
 31 | 
 32 |     !========================================================================
 33 |     ! reads ndep_inparm namelist and sets up driver list of fields for
 34 |     ! atmosphere -> land and atmosphere -> ocn communications.
 35 |     !========================================================================
 36 | 
 37 |     ! input/output variables
 38 |     character(len=*), intent(in)  :: NLFilename ! Namelist filename
 39 |     integer         , intent(out) :: ndep_nflds
 40 | 
 41 |     !----- local -----
 42 |     type(ESMF_VM)      :: vm
 43 |     integer            :: i                      ! Indices
 44 |     integer            :: unitn                  ! namelist unit number
 45 |     integer            :: ierr                   ! error code
 46 |     logical            :: exists                 ! if file exists or not
 47 |     integer            :: rc
 48 |     integer, parameter :: maxspc = 100           ! Maximum number of species
 49 |     character(len=32)  :: ndep_list(maxspc) = '' ! List of ndep species
 50 |     integer            :: localpet
 51 |     integer            :: mpicom
 52 |     integer            :: logunit
 53 |     character(*),parameter :: subName = '(shr_ndep_readnl) '
 54 |     character(*),parameter :: F00   = "('(shr_ndep_readnl) ',8a)"
 55 |     ! ------------------------------------------------------------------
 56 | 
 57 |     namelist /ndep_inparm/ ndep_list
 58 | 
 59 |     !-----------------------------------------------------------------------------
 60 |     ! Read namelist and figure out the ndep field list to pass
 61 |     ! First check if file exists and if not, n_ndep will be zero
 62 |     !-----------------------------------------------------------------------------
 63 | 
 64 |     rc = ESMF_SUCCESS
 65 | 
 66 |     !--- Open and read namelist ---
 67 |     if ( len_trim(NLFilename) == 0 ) then
 68 |        call shr_sys_abort( subName//'ERROR: nlfilename not set' )
 69 |     end if
 70 |     call shr_log_getLogUnit(logunit)
 71 |     call ESMF_VMGetCurrent(vm, rc=rc)
 72 |     if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, line=__LINE__, file=__FILE__)) return 
 73 | 
 74 |     call ESMF_VMGet(vm, localPet=localPet, mpiCommunicator=mpicom, rc=rc)
 75 |     if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, line=__LINE__, file=__FILE__)) return 
 76 | 
 77 |     ! Note the following still needs to be called on all processors since the mpi_bcast is a collective 
 78 |     ! call on all the pes of mpicom
 79 |     if (localpet==0) then
 80 |        inquire( file=trim(NLFileName), exist=exists)
 81 |        if ( exists ) then
 82 |           open(newunit=unitn, file=trim(NLFilename), status='old' )
 83 |           write(logunit,F00) 'Read in ndep_inparm namelist from: ', trim(NLFilename)
 84 |           call shr_nl_find_group_name(unitn, 'ndep_inparm', ierr)
 85 |           if (ierr == 0) then
 86 |              ! Note that ierr /= 0, no namelist is present.
 87 |              read(unitn, ndep_inparm, iostat=ierr)
 88 |              if (ierr > 0) then
 89 |                 call shr_sys_abort(trim(subName) //'problem of read of ndep_inparm ')
 90 |              endif
 91 |           endif
 92 |           close( unitn )
 93 |        end if
 94 |     end if
 95 |     call shr_mpi_bcast( ndep_list, mpicom )
 96 | 
 97 |     ndep_nflds = 0
 98 |     do i=1,maxspc
 99 |        if (len_trim(ndep_list(i)) > 0) then
100 |           ndep_nflds = ndep_nflds+1
101 |        endif
102 |     enddo
103 | 
104 |   end subroutine shr_ndep_readnl
105 | 
106 | end module shr_ndep_mod
107 | 


--------------------------------------------------------------------------------
/mediator/med_phases_post_ocn_mod.F90:
--------------------------------------------------------------------------------
  1 | module med_phases_post_ocn_mod
  2 | 
  3 |   !-----------------------------------------------------------------------------
  4 |   ! Mediator post ocn phase - maps ocn->ice, accumulate glc input from ocn
  5 |   !-----------------------------------------------------------------------------
  6 | 
  7 |   implicit none
  8 |   private
  9 | 
 10 |   public  :: med_phases_post_ocn
 11 | 
 12 |   character(*), parameter :: u_FILE_u  = &
 13 |        __FILE__
 14 | 
 15 | !-----------------------------------------------------------------------------
 16 | contains
 17 | !-----------------------------------------------------------------------------
 18 | 
 19 |   subroutine med_phases_post_ocn(gcomp, rc)
 20 | 
 21 |     use NUOPC_Mediator          , only : NUOPC_MediatorGet
 22 |     use ESMF                    , only : ESMF_Clock, ESMF_ClockIsCreated
 23 |     use ESMF                    , only : ESMF_GridComp
 24 |     use ESMF                    , only : ESMF_LogWrite, ESMF_LOGMSG_INFO, ESMF_SUCCESS
 25 |     use med_kind_mod            , only : CX=>SHR_KIND_CX, CS=>SHR_KIND_CS, CL=>SHR_KIND_CL, R8=>SHR_KIND_R8
 26 |     use med_utils_mod           , only : chkerr      => med_utils_ChkErr
 27 |     use med_constants_mod       , only : dbug_flag   => med_constants_dbug_flag
 28 |     use med_map_mod             , only : med_map_field_packed
 29 |     use med_internalstate_mod   , only : InternalState
 30 |     use med_internalstate_mod   , only : compice, compocn, compwav
 31 |     use med_phases_history_mod  , only : med_phases_history_write_comp
 32 |     use med_phases_prep_glc_mod , only : med_phases_prep_glc_accum_ocn
 33 |     use perf_mod                , only : t_startf, t_stopf
 34 | 
 35 |     ! input/output variables
 36 |     type(ESMF_GridComp)  :: gcomp
 37 |     integer, intent(out) :: rc
 38 | 
 39 |     ! local variables
 40 |     type(InternalState) :: is_local
 41 |     type(ESMF_Clock)    :: dClock
 42 |     character(len=*),parameter :: subname='(med_phases_post_ocn)'
 43 |     !---------------------------------------
 44 | 
 45 |     rc = ESMF_SUCCESS
 46 | 
 47 |     call t_startf('MED:'//subname)
 48 |     if (dbug_flag > 20) then
 49 |        call ESMF_LogWrite(subname//' called', ESMF_LOGMSG_INFO)
 50 |     end if
 51 | 
 52 |     ! Get the internal state
 53 |     nullify(is_local%wrap)
 54 |     call ESMF_GridCompGetInternalState(gcomp, is_local, rc)
 55 |     if (ChkErr(rc,__LINE__,u_FILE_u)) return
 56 | 
 57 |     ! Map ocn->ice
 58 |     if (is_local%wrap%med_coupling_active(compocn,compice)) then
 59 |        call t_startf('MED:'//trim(subname)//' map_ocn2ice')
 60 |        call med_map_field_packed( &
 61 |             FBSrc=is_local%wrap%FBImp(compocn,compocn), &
 62 |             FBDst=is_local%wrap%FBImp(compocn,compice), &
 63 |             FBFracSrc=is_local%wrap%FBFrac(compocn), &
 64 |             field_normOne=is_local%wrap%field_normOne(compocn,compice,:), &
 65 |             packed_data=is_local%wrap%packed_data(compocn,compice,:), &
 66 |             routehandles=is_local%wrap%RH(compocn,compice,:), rc=rc)
 67 |        if (ChkErr(rc,__LINE__,u_FILE_u)) return
 68 |        call t_stopf('MED:'//trim(subname)//' map_ocn2ice')
 69 |     end if
 70 |     ! Map ocn->wav
 71 |     if (is_local%wrap%med_coupling_active(compocn,compwav)) then
 72 |        call t_startf('MED:'//trim(subname)//' map_ocn2wav')
 73 |        call med_map_field_packed( &
 74 |             FBSrc=is_local%wrap%FBImp(compocn,compocn), &
 75 |             FBDst=is_local%wrap%FBImp(compocn,compwav), &
 76 |             FBFracSrc=is_local%wrap%FBFrac(compocn), &
 77 |             field_normOne=is_local%wrap%field_normOne(compocn,compwav,:), &
 78 |             packed_data=is_local%wrap%packed_data(compocn,compwav,:), &
 79 |             routehandles=is_local%wrap%RH(compocn,compwav,:), rc=rc)
 80 |        if (ChkErr(rc,__LINE__,u_FILE_u)) return
 81 |        call t_stopf('MED:'//trim(subname)//' map_ocn2wav')
 82 |     end if
 83 | 
 84 |     ! Accumulate ocn input for glc if there is ocn->glc coupling
 85 |     if (is_local%wrap%ocn2glc_coupling) then
 86 |        call ESMF_LogWrite(subname//' DEBUG: calling med_phases_prep_glc_accum_ocn', ESMF_LOGMSG_INFO)
 87 |        call med_phases_prep_glc_accum_ocn(gcomp, rc)
 88 |        if (ChkErr(rc,__LINE__,u_FILE_u)) return
 89 |     end if
 90 | 
 91 |     ! Write ocn inst, avg or aux if requested in mediator attributes
 92 |     call NUOPC_MediatorGet(gcomp, driverClock=dClock, rc=rc)
 93 |     if (ChkErr(rc,__LINE__,u_FILE_u)) return
 94 |     if (ESMF_ClockIsCreated(dclock)) then
 95 |        call med_phases_history_write_comp(gcomp, compocn, rc=rc)
 96 |        if (ChkErr(rc,__LINE__,u_FILE_u)) return
 97 |     end if
 98 | 
 99 |     if (dbug_flag > 20) then
100 |        call ESMF_LogWrite(subname//' done', ESMF_LOGMSG_INFO)
101 |     end if
102 |     call t_stopf('MED:'//subname)
103 | 
104 |   end subroutine med_phases_post_ocn
105 | 
106 | end module med_phases_post_ocn_mod
107 | 


--------------------------------------------------------------------------------
/cime_config/buildexe:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python3
  2 | 
  3 | """
  4 | build model executable
  5 | """
  6 | 
  7 | import sys, os
  8 | 
  9 | _CIMEROOT = os.environ.get("CIMEROOT")
 10 | if _CIMEROOT is None:
 11 |     raise SystemExit("ERROR: must set CIMEROOT environment variable")
 12 | 
 13 | sys.path.append(os.path.join(_CIMEROOT, "scripts", "Tools"))
 14 | 
 15 | from standard_script_setup import *
 16 | from CIME.buildlib         import parse_input
 17 | from CIME.build            import get_standard_makefile_args
 18 | from CIME.case             import Case
 19 | from CIME.utils            import expect, run_cmd
 20 | 
 21 | #pylint: disable=undefined-variable
 22 | logger = logging.getLogger(__name__)
 23 | 
 24 | ###############################################################################
 25 | def _main_func():
 26 | ###############################################################################
 27 | 
 28 |     caseroot, _, _ = parse_input(sys.argv)
 29 | 
 30 |     logger.info("Building a single executable version of target coupled model")
 31 | 
 32 |     with Case(caseroot) as case:
 33 |         casetools = case.get_value("CASETOOLS")
 34 |         exeroot   = case.get_value("EXEROOT")
 35 |         gmake     = case.get_value("GMAKE")
 36 |         gmake_j   = case.get_value("GMAKE_J")
 37 |         cime_model = case.get_value("MODEL")
 38 |         num_esp   = case.get_value("NUM_COMP_INST_ESP")
 39 |         ocn_model = case.get_value("COMP_OCN")
 40 |         gmake_args = get_standard_makefile_args(case)
 41 |         link_libs = case.get_value("CAM_LINKED_LIBS", subgroup="build_component_cam")
 42 |         esmf_aware_threading = case.get_value("ESMF_AWARE_THREADING")
 43 | 
 44 |     # Determine valid components
 45 |     valid_comps = []
 46 |     comp_classes = case.get_values("COMP_CLASSES")
 47 |     for item in comp_classes:
 48 |         comp = case.get_value("COMP_" + item)
 49 |         valid = True
 50 |         if comp == 's' + item.lower():
 51 |             valid = False
 52 |         if valid:
 53 |             valid_comps.append(item)
 54 | 
 55 |     datamodel_in_compset = False
 56 |     for comp in comp_classes:
 57 |         dcompname = "d"+comp.lower()
 58 |         if dcompname in case.get_value("COMP_{}".format(comp)):
 59 |             datamodel_in_compset = True
 60 | 
 61 |     if len(valid_comps) == 2 and not datamodel_in_compset:
 62 |         skip_mediator = True
 63 |     else:
 64 |         skip_mediator = False
 65 | 
 66 |     if ocn_model == 'mom':
 67 |         gmake_args += "USE_FMS=TRUE"
 68 | 
 69 |     if link_libs is not None:
 70 |         gmake_args += 'USER_SLIBS="{}"'.format(link_libs)
 71 | 
 72 |     comp_classes = case.get_values("COMP_CLASSES")
 73 |     for comp in comp_classes:
 74 |         model = case.get_value("COMP_{}".format(comp))
 75 |         stubcomp = "s{}".format(comp.lower())
 76 |         if model == stubcomp:
 77 |             gmake_args += " {}_PRESENT=FALSE".format(comp)
 78 |     if skip_mediator:
 79 |         gmake_args += " MED_PRESENT=FALSE"
 80 |     if esmf_aware_threading:
 81 |         gmake_args += " USER_CPPDEFS=-DESMF_AWARE_THREADING"
 82 | 
 83 |     gmake_args += " IAC_PRESENT=FALSE"
 84 |     expect((num_esp is None) or (int(num_esp) == 1), "ESP component restricted to one instance")
 85 | 
 86 |     bld_root = os.path.join(exeroot,'cpl','obj')
 87 |     if not os.path.isdir(bld_root):
 88 |         os.makedirs(bld_root)
 89 | 
 90 |     with open(os.path.join(bld_root,'Filepath'), 'w', encoding="utf-8") as out:
 91 |         cmeps_dir = os.path.join(os.path.dirname(__file__), os.pardir)
 92 |         # SourceMods dir needs to be first listed
 93 |         out.write(os.path.join(caseroot, "SourceMods", "src.drv") + "\n")
 94 |         if not skip_mediator:
 95 |             out.write(os.path.join(cmeps_dir, "mediator") + "\n")
 96 |             out.write(os.path.join(cmeps_dir, "cesm", "flux_atmocn") + "\n")
 97 |         out.write(os.path.join(cmeps_dir, "cesm", "driver") + "\n")
 98 | 
 99 |     # build model executable
100 |     makefile = os.path.join(casetools, "Makefile")
101 |     exename = os.path.join(exeroot, cime_model + ".exe")
102 | 
103 |     # always rebuild file esm.F90 this is because cpp macros in that file may have changed
104 |     esm = os.path.join(bld_root,"esm.o")
105 |     if os.path.isfile(esm):
106 |         os.remove(esm)
107 | 
108 |     # always relink
109 |     if os.path.isfile(exename):
110 |         os.remove(exename)
111 |     exename = os.path.relpath(exename, bld_root)
112 |     cmd = "{} exec_se -j {} EXEC_SE={} COMP_NAME=driver {} -f {} "\
113 |         .format(gmake, gmake_j, exename, gmake_args, makefile)
114 |     pio = os.environ.get("PIO")
115 |     if pio:
116 |         os.environ["PIO_LIBDIR"] = os.path.join(pio,"lib")
117 | 
118 |     rc, out, err = run_cmd(cmd,from_dir=bld_root)
119 |     expect(rc==0,"Command {} failed rc={}\nout={}\nerr={}".format(cmd,rc,out,err))
120 |     if err:
121 |         logger.info(err)
122 |     logger.info(out)
123 | 
124 | ###############################################################################
125 | 
126 | if __name__ == "__main__":
127 |     _main_func()
128 | 


--------------------------------------------------------------------------------
/ufs/ccpp/config/ccpp_prebuild_config.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python
  2 | 
  3 | ###############################################################################
  4 | # Used modules                                                                #
  5 | ###############################################################################
  6 | 
  7 | import os
  8 | 
  9 | ###############################################################################
 10 | # Query required information/s                                                 #
 11 | ###############################################################################
 12 | 
 13 | fv3_path = os.environ['FV3_PATH']
 14 | 
 15 | ###############################################################################
 16 | # Definitions                                                                 #
 17 | ###############################################################################
 18 | 
 19 | HOST_MODEL_IDENTIFIER = "CMEPS"
 20 | 
 21 | # Add all files with metadata tables on the host model side and in CCPP,
 22 | # relative to basedir = top-level directory of host model. This includes
 23 | # kind and type definitions used in CCPP physics. Also add any internal
 24 | # dependencies of these files to the list.
 25 | VARIABLE_DEFINITION_FILES = [
 26 |     # actual variable definition files
 27 |     '{}/ccpp/framework/src/ccpp_types.F90'.format(fv3_path),
 28 |     '{}/ccpp/physics/physics/hooks/machine.F'.format(fv3_path),
 29 |     'CMEPS/ufs/ccpp/data/MED_typedefs.F90',
 30 |     'CMEPS/ufs/ccpp/data/MED_data.F90'
 31 |     ]
 32 | 
 33 | TYPEDEFS_NEW_METADATA = {
 34 |     'ccpp_types' : {
 35 |         'ccpp_t' : 'cdata',
 36 |         'ccpp_types' : '',
 37 |         },
 38 |     'machine' : {
 39 |         'machine' : '',
 40 |         },
 41 |     'MED_typedefs' : {
 42 |         'MED_init_type' : 'physics%init',
 43 |         'MED_statein_type' : 'physics%Statein',
 44 |         'MED_stateout_type' : 'physics%Stateout',
 45 |         'MED_interstitial_type' : 'physics%Interstitial',
 46 |         'MED_control_type' : 'physics%Model',
 47 |         'MED_coupling_type' : 'physics%Coupling',
 48 |         'MED_grid_type' : 'physics%Grid',
 49 |         'MED_sfcprop_type' : 'physics%Sfcprop',
 50 |         'MED_diag_type' : 'physics%Diag',
 51 |         'MED_typedefs' : '',
 52 |         },
 53 |     'MED_data' : {
 54 |         'MED_data' : '',
 55 |         'physics_type' : 'physics',
 56 |         }
 57 |     }
 58 | 
 59 | # Add all physics scheme files relative to basedir
 60 | SCHEME_FILES = [
 61 |     '{}/ccpp/physics/physics/SFC_Models/Ocean/UFS/sfc_ocean.F'.format(fv3_path),
 62 |     '{}/ccpp/physics/physics/SFC_Layer/UFS/sfc_diff.f'.format(fv3_path),
 63 |     '{}/ccpp/physics/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_surface_loop_control_part1.F90'.format(fv3_path),
 64 |     '{}/ccpp/physics/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_surface_loop_control_part2.F90'.format(fv3_path),
 65 |     '{}/ccpp/physics/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_surface_composites_pre.F90'.format(fv3_path),
 66 |     '{}/ccpp/physics/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_surface_composites_post.F90'.format(fv3_path),
 67 |     '{}/ccpp/physics/physics/SFC_Layer/UFS/sfc_diag.f'.format(fv3_path)
 68 |     ]
 69 | 
 70 | # Default build dir, relative to current working directory,
 71 | # if not specified as command-line argument
 72 | DEFAULT_BUILD_DIR = 'CMEPS'
 73 | 
 74 | # Auto-generated makefile/cmakefile snippets that contain all type definitions
 75 | TYPEDEFS_MAKEFILE   = '{build_dir}/physics/CCPP_TYPEDEFS.mk'
 76 | TYPEDEFS_CMAKEFILE  = '{build_dir}/physics/CCPP_TYPEDEFS.cmake'
 77 | TYPEDEFS_SOURCEFILE = '{build_dir}/physics/CCPP_TYPEDEFS.sh'
 78 | 
 79 | # Auto-generated makefile/cmakefile snippets that contain all schemes
 80 | SCHEMES_MAKEFILE   = '{build_dir}/physics/CCPP_SCHEMES.mk'
 81 | SCHEMES_CMAKEFILE  = '{build_dir}/physics/CCPP_SCHEMES.cmake'
 82 | SCHEMES_SOURCEFILE = '{build_dir}/physics/CCPP_SCHEMES.sh'
 83 | 
 84 | # Auto-generated makefile/cmakefile snippets that contain all caps
 85 | CAPS_MAKEFILE   = '{build_dir}/physics/CCPP_CAPS.mk'
 86 | CAPS_CMAKEFILE  = '{build_dir}/physics/CCPP_CAPS.cmake'
 87 | CAPS_SOURCEFILE = '{build_dir}/physics/CCPP_CAPS.sh'
 88 | 
 89 | # Directory where to put all auto-generated physics caps
 90 | CAPS_DIR = '{build_dir}/physics'
 91 | 
 92 | # Directory where the suite definition files are stored
 93 | SUITES_DIR = 'CMEPS/ufs/ccpp/suites'
 94 | 
 95 | # Directory where to write static API to
 96 | STATIC_API_DIR = '{build_dir}/physics'
 97 | STATIC_API_CMAKEFILE  = '{build_dir}/physics/CCPP_STATIC_API.cmake'
 98 | STATIC_API_SOURCEFILE = '{build_dir}/physics/CCPP_STATIC_API.sh'
 99 | 
100 | # Directory for writing HTML pages generated from metadata files
101 | METADATA_HTML_OUTPUT_DIR = '{build_dir}/physics/physics/docs'
102 | 
103 | # HTML document containing the model-defined CCPP variables
104 | HTML_VARTABLE_FILE = '{build_dir}/physics/CCPP_VARIABLES_CMEPS.html'
105 | 
106 | # LaTeX document containing the provided vs requested CCPP variables
107 | LATEX_VARTABLE_FILE = '{build_dir}/framework/doc/DevelopersGuide/CCPP_VARIABLES_CMEPS.tex'
108 | 


--------------------------------------------------------------------------------
/doc/source/fractions.rst:
--------------------------------------------------------------------------------
  1 | .. _fractions:
  2 | 
  3 | ==========================
  4 |  CMEPS `fractions` module
  5 | ==========================
  6 | 
  7 | The component fractions on their corresponding meshes are defined and
  8 | updated in ``med_fractions_mod.F90.`` 
  9 | 
 10 | CMEPS component fractions are defined as follows:
 11 | 
 12 | * An array of field bundles, ``Frac(:)`` is created, where the size of
 13 |   ``Frac`` corresponds to the number of active components.
 14 | 
 15 | * For each active component, a fraction field bundle is created, ``Frac(comp_index)``, where the fields in the field bundle are unique.
 16 |   Below, ``Frac(comp_index)[fieldname]`` refers to the field in the ``Frac(comp_index)`` field bundle that has the name ``fieldname``.
 17 | 
 18 | .. note:: comp_index can be any of [compatm, compice, compglc, complnd, compocn, comprof, compwav].
 19 | 
 20 | * The following are the field names for each component of FBFrac::
 21 | 
 22 |     Frac(compatm) = afrac,ifrac,ofrac,lfrac,lfrin
 23 |     Frac(compocn) = afrac,ifrac,ofrac,ifrad,ofrad
 24 |     Frac(compice) = afrac,ifrac,ofrac
 25 |     Frac(complnd) = afrac,lfrac,lfrin
 26 |     Frac(compglc) = gfrac,lfrac
 27 |     Frac(comprof) = lfrac,rfrac
 28 |     Frac(compwav) = wfrac
 29 | 
 30 | where::
 31 | 
 32 |     afrac = fraction of atm on a grid
 33 |     lfrac = fraction of lnd on a grid
 34 |     ifrac = fraction of ice on a grid
 35 |     ofrac = fraction of ocn on a grid
 36 |     lfrin = land fraction defined by the land model
 37 |     rfrac = fraction of rof on a grid
 38 |     wfrac = fraction of wav on a grid
 39 |     ifrad = fraction of ocn on a grid at last radiation time
 40 |     ofrad = fraction of ice on a grid at last radiation time
 41 | 
 42 |     As an example, ``Frac(compatm)[lfrac]`` is the land fraction on
 43 |     the atmosphere mesh.
 44 | 
 45 | * ``lfrin`` and ``lfrac`` can be different from ``lfrac`` when the
 46 |   atmosphere and land meshes are different.  ``lfrac`` is the land
 47 |   fraction consistent with the ocean mask where ``lfrin`` is the land
 48 |   fraction in the land component.
 49 | 
 50 | * ``ifrad`` and ``ofrad`` are fractions at the last radiation
 51 |   timestep.  These fractions preserve conservation of heat in the net
 52 |   shortwave calculation because the net shortwave calculation is one
 53 |   timestep behind the ice fraction evolution in the system.
 54 | 
 55 | The following assumptions are made regarding fractions:
 56 | 
 57 | * The ocean and ice are on the same meshes with same masks
 58 | * The ice fraction can evolve in time
 59 | * The land fraction does not evolve in time
 60 | * the ocean fraction is just the complement of the ice fraction over the region
 61 |   of the ocean/ice mask.
 62 | * The component fractions are always the relative fraction covered.
 63 |   For example, if an ice cell can be up to 50% covered in
 64 |   ice and 50% land, then the ice domain should have a fraction
 65 |   value of 0.5 at that grid cell. At run time though, the ice
 66 |   fraction will be between 0.0 and 1.0 meaning that grid cells
 67 |   is covered with between 0.0 and 0.5 by ice.  The "relative" fractions
 68 |   sent at run-time are corrected by the model to be total fractions
 69 |   such that in general, on every mesh cell:
 70 | 
 71 |   * ``Frac(:)[afrac]`` = 1.0
 72 |   * ``Frac(:)[ifrac]`` + ``Frac(:)[ofrac]`` + ``Frac(:)[lfrac]`` = 1.0
 73 | 
 74 | Initialization of the fractions occurs as follows (note that all mapping is first order conservative):
 75 | 
 76 | * ``Frac(compatm)[afrac]`` = 1.0
 77 | 
 78 | * ``Frac(compocn)[afrac]`` = map atm -> ocn ``Frac(compatm)[afrac]``
 79 | 
 80 | * ``Frac(compice)[afrac]`` = map atm -> ice ``Frac(compatm)[afrac]``
 81 | 
 82 | * ``Frac(complnd)[afrac]`` = map atm -> lnd ``Frac(compatm)[afrac]``
 83 | 
 84 | * ``FBfrac(:)[ifrac]``     = 0.0
 85 | 
 86 | * ``Frac(compocn)[ofrac]`` = ocean mask provided by ocean
 87 | 
 88 | * ``Frac(complnd)[lfrin]`` = land fraction provided by land
 89 | 
 90 | * ``Frac(compatm)[ofrac]`` = map ocn -> atm ``Frac(compocn)[ofrac]``
 91 | 
 92 | * ``Frac(compatm)[lfrin]`` = map lnd -> atm ``Frac(complnd)[lfrin]``
 93 | 
 94 | * ``Frac(compatm)[lfrac]`` = 1.0 - ``Frac(compatm)[ofrac]``
 95 |   (this is truncated to zero for very small values (< 0.001) to attempt to preserve non-land gridcells.)
 96 | 
 97 | * ``Frac(complnd)[lfrac]`` = map atm -> lnd ``Frac(compatm)[lfrac]``
 98 | 
 99 | * ``Frac(comprof)[lfrac]`` = map lnd -> rof ``Frac(complnd)[lfrac]``
100 | 
101 | * ``Frac(compglc)[lfrac]`` = map lnd -> glc ``Frac(complnd)[lfrac]``
102 | 
103 | Run time calculation of fractions is as follows:
104 | 
105 | * ``Frac(compice)[ofrac]`` = 1.0 - ``Frac(compice)[ifrac]``
106 |   (Note: the relative fractions are corrected to total fractions)
107 | 
108 | * ``Frac(compocn)[ifrac]`` = map ice -> ocn ``Frac(compice)[ifrac]``
109 | 
110 | * ``Frac(compocn)[ofrac]`` = map ice -> ocn ``Frac(compice)[ofrac]``
111 | 
112 | * ``Frac(compatm)[ifrac]`` = map ice -> atm ``Frac(compice)[ifrac]``
113 | 
114 | * ``Frac(compatm)[ofrac]`` = map ice -> atm ``Frac(compice)[ofrac]``
115 | 
116 | * ``Frac(compatm)[lfrac]`` + ``Frac(compatm)[ofrac]`` + ``Frac(compatm)[ifrac]`` ~ 1.0
117 |   (0.0-eps < Frac(:)[*] < 1.0+eps)
118 | 


--------------------------------------------------------------------------------
/cesm/nuopc_cap_share/shr_lightning_coupling_mod.F90:
--------------------------------------------------------------------------------
  1 | module shr_lightning_coupling_mod
  2 | 
  3 |   !========================================================================
  4 |   ! Module for handling namelist variables related to lightning coupling
  5 |   !========================================================================
  6 | 
  7 |   use ESMF         , only : ESMF_VMGetCurrent, ESMF_VM, ESMF_VMGet
  8 |   use ESMF         , only : ESMF_LOGERR_PASSTHRU, ESMF_SUCCESS
  9 |   use ESMF         , only : ESMF_VMBroadCast, ESMF_Logical, assignment(=)
 10 |   use shr_sys_mod  , only : shr_sys_abort
 11 |   use shr_log_mod  , only : shr_log_getLogUnit
 12 |   use shr_nl_mod   , only : shr_nl_find_group_name
 13 |   use nuopc_shr_methods, only : chkerr
 14 | 
 15 |   implicit none
 16 |   private
 17 | 
 18 |   ! !PUBLIC MEMBER FUNCTIONS
 19 |   public shr_lightning_coupling_readnl  ! Read namelist
 20 | 
 21 |   character(len=*), parameter :: &
 22 |        u_FILE_u=__FILE__
 23 | 
 24 |   !====================================================================================
 25 | CONTAINS
 26 |   !====================================================================================
 27 | 
 28 |   subroutine shr_lightning_coupling_readnl(NLFilename, atm_provides_lightning_out)
 29 | 
 30 |     !========================================================================
 31 |     ! reads lightning_coupling_nl namelist and returns a variable specifying
 32 |     ! if atmosphere model provides lightning flash frequency field to mediator
 33 |     !========================================================================
 34 | 
 35 |     ! input/output variables
 36 |     character(len=*), intent(in)  :: NLFilename ! Namelist filename
 37 |     logical, intent(out) :: atm_provides_lightning_out ! if TRUE atm will provide lightning flash frequency
 38 | 
 39 |     !----- local -----
 40 |     logical :: atm_provides_lightning
 41 |     type(ESMF_VM)     :: vm
 42 |     integer           :: unitn                  ! namelist unit number
 43 |     integer           :: ierr                   ! error code
 44 |     logical           :: exists                 ! if file exists or not
 45 |     type(ESMF_Logical):: ltmp(1)
 46 |     integer           :: rc
 47 |     integer           :: localpet
 48 |     integer           :: mpicom
 49 |     integer           :: s_logunit
 50 |     character(len=*), parameter :: atm_ozone_frequency_not_present = 'NOT_PRESENT'
 51 |     character(len=*), parameter :: subname = '(shr_lightning_coupling_readnl) '
 52 |     ! ------------------------------------------------------------------
 53 | 
 54 |     namelist /lightning_coupling_nl/ atm_provides_lightning
 55 | 
 56 |     rc = ESMF_SUCCESS
 57 | 
 58 |     atm_provides_lightning_out = .false.
 59 |     ltmp(1) = .false.
 60 | 
 61 |     !--- Open and read namelist ---
 62 |     if ( len_trim(NLFilename) == 0 ) then
 63 |        call shr_sys_abort( subname//'ERROR: nlfilename not set' )
 64 |     end if
 65 |     call shr_log_getLogUnit(s_logunit)
 66 |     call ESMF_VMGetCurrent(vm, rc=rc)
 67 |     if (chkerr(rc,__LINE__,u_FILE_u)) return
 68 | 
 69 |     call ESMF_VMGet(vm, localPet=localpet, mpiCommunicator=mpicom, rc=rc)
 70 |     if (chkerr(rc,__LINE__,u_FILE_u)) return
 71 | 
 72 |     if (localpet==0) then
 73 |        ! ------------------------------------------------------------------------
 74 |        ! Set default values in case namelist file doesn't exist, lightning_coupling_nl group
 75 |        ! doesn't exist within the file, or a given variable isn't present in the namelist
 76 |        ! group in the file.
 77 |        ! ------------------------------------------------------------------------
 78 |        atm_provides_lightning = .false.
 79 | 
 80 |        ! ------------------------------------------------------------------------
 81 |        ! Read namelist file
 82 |        ! ------------------------------------------------------------------------
 83 |        inquire( file=trim(NLFileName), exist=exists)
 84 |        if ( exists ) then
 85 |           open(newunit=unitn, file=trim(NLFilename), status='old' )
 86 |           write(s_logunit,'(a)') subname,'Read in lightning_coupling_nl namelist from: ', trim(NLFilename)
 87 |           call shr_nl_find_group_name(unitn, 'lightning_coupling_nl', ierr)
 88 |           if (ierr == 0) then
 89 |              ! Note that ierr /= 0 means no namelist is present.
 90 |              read(unitn, lightning_coupling_nl, iostat=ierr)
 91 |              if (ierr > 0) then
 92 |                 call shr_sys_abort(subname//'problem reading lightning_coupling_nl')
 93 |              end if
 94 |           end if
 95 |           close( unitn )
 96 |        end if
 97 | 
 98 |        ltmp(1) = atm_provides_lightning
 99 | 
100 |     end if
101 | 
102 |     ! ------------------------------------------------------------------------
103 |     ! Broadcast values to all tasks
104 |     ! ------------------------------------------------------------------------
105 |     call ESMF_VMBroadcast(vm,  ltmp, count=1, rootPet=0, rc=rc)
106 |     if (chkerr(rc,__LINE__,u_FILE_u)) return
107 | 
108 |     atm_provides_lightning_out = ltmp(1)
109 | 
110 |   end subroutine shr_lightning_coupling_readnl
111 | 
112 | end module shr_lightning_coupling_mod
113 | 


--------------------------------------------------------------------------------
/mediator/med_phases_post_lnd_mod.F90:
--------------------------------------------------------------------------------
  1 | module med_phases_post_lnd_mod
  2 | 
  3 |   implicit none
  4 |   private
  5 | 
  6 |   public :: med_phases_post_lnd
  7 | 
  8 |   character(*), parameter :: u_FILE_u  = &
  9 |        __FILE__
 10 | 
 11 | !-----------------------------------------------------------------------------
 12 | contains
 13 | !-----------------------------------------------------------------------------
 14 | 
 15 |   subroutine med_phases_post_lnd(gcomp, rc)
 16 | 
 17 |     use NUOPC_Mediator          , only : NUOPC_MediatorGet
 18 |     use ESMF                    , only : ESMF_Clock, ESMF_ClockIsCreated
 19 |     use ESMF                    , only : ESMF_LogWrite, ESMF_LOGMSG_INFO, ESMF_SUCCESS
 20 |     use ESMF                    , only : ESMF_GridComp
 21 |     use med_kind_mod            , only : CX=>SHR_KIND_CX, CS=>SHR_KIND_CS, CL=>SHR_KIND_CL, R8=>SHR_KIND_R8
 22 |     use med_constants_mod       , only : dbug_flag   => med_constants_dbug_flag
 23 |     use med_utils_mod           , only : chkerr      => med_utils_ChkErr
 24 |     use med_methods_mod         , only : FB_diagnose => med_methods_FB_diagnose
 25 |     use med_map_mod             , only : med_map_field_packed
 26 |     use med_internalstate_mod   , only : InternalState
 27 |     use med_phases_prep_rof_mod , only : med_phases_prep_rof_accum
 28 |     use med_phases_prep_glc_mod , only : med_phases_prep_glc_accum_lnd, med_phases_prep_glc_avg
 29 |     use med_phases_history_mod  , only : med_phases_history_write_comp
 30 |     use med_internalstate_mod   , only : complnd, compatm, comprof
 31 |     use perf_mod                , only : t_startf, t_stopf
 32 | 
 33 |     ! input/output variables
 34 |     type(ESMF_GridComp)  :: gcomp
 35 |     integer, intent(out) :: rc
 36 | 
 37 |     ! local variables
 38 |     type(InternalState) :: is_local
 39 |     type(ESMF_Clock)    :: dClock
 40 |     character(len=*),parameter :: subname='(med_phases_post_lnd)'
 41 |     !-------------------------------------------------------------------------------
 42 | 
 43 |     call t_startf('MED:'//subname)
 44 |     rc = ESMF_SUCCESS
 45 | 
 46 |     if (dbug_flag > 20) then
 47 |        call ESMF_LogWrite(subname//' called', ESMF_LOGMSG_INFO)
 48 |     end if
 49 | 
 50 |     ! Get the internal state
 51 |     nullify(is_local%wrap)
 52 |     call ESMF_GridCompGetInternalState(gcomp, is_local, rc)
 53 |     if (ChkErr(rc,__LINE__,u_FILE_u)) return
 54 | 
 55 |     call NUOPC_MediatorGet(gcomp, driverClock=dClock, rc=rc)
 56 |     if (ChkErr(rc,__LINE__,u_FILE_u)) return
 57 | 
 58 |     ! If driver clock is created then are in the run phase otherwise are in the initialization phase
 59 |     if (ESMF_ClockIsCreated(dclock)) then
 60 | 
 61 |        ! map lnd to atm
 62 |        if (is_local%wrap%med_coupling_active(complnd,compatm)) then
 63 |           call med_map_field_packed( &
 64 |                FBSrc=is_local%wrap%FBImp(complnd,complnd), &
 65 |                FBDst=is_local%wrap%FBImp(complnd,compatm), &
 66 |                FBFracSrc=is_local%wrap%FBFrac(complnd), &
 67 |                field_NormOne=is_local%wrap%field_normOne(complnd,compatm,:), &
 68 |                packed_data=is_local%wrap%packed_data(complnd,compatm,:), &
 69 |                routehandles=is_local%wrap%RH(complnd,compatm,:), rc=rc)
 70 |           if (ChkErr(rc,__LINE__,u_FILE_u)) return
 71 |        end if
 72 | 
 73 |        ! accumulate lnd input for rof
 74 |        if (is_local%wrap%med_coupling_active(complnd,comprof)) then
 75 |           call med_phases_prep_rof_accum(gcomp, rc)
 76 |           if (ChkErr(rc,__LINE__,u_FILE_u)) return
 77 |        end if
 78 | 
 79 |        ! accumulate lnd input for glc (note that lnd2glc_coupling and accum_lnd2glc is determined in med.F90)
 80 |        if (is_local%wrap%lnd2glc_coupling) then
 81 |           call med_phases_prep_glc_accum_lnd(gcomp, rc)
 82 |           if (ChkErr(rc,__LINE__,u_FILE_u)) return
 83 |           ! Note that in this case med_phases_prep_glc_avg is called
 84 |           ! from med_phases_prep_glc in the run sequence
 85 |        else if (is_local%wrap%accum_lnd2glc) then
 86 |           call med_phases_prep_glc_accum_lnd(gcomp, rc)
 87 |           if (ChkErr(rc,__LINE__,u_FILE_u)) return
 88 |           call med_phases_prep_glc_avg(gcomp, rc)
 89 |           if (ChkErr(rc,__LINE__,u_FILE_u)) return
 90 |        end if
 91 | 
 92 |        ! Write lnd inst, avg or aux if requested in mediator attributes
 93 |        call med_phases_history_write_comp(gcomp, complnd, rc=rc)
 94 |        if (ChkErr(rc,__LINE__,u_FILE_u)) return
 95 | 
 96 |     else
 97 | 
 98 |        ! initialization phase - map lnd to atm
 99 |        if (is_local%wrap%med_coupling_active(complnd,compatm)) then
100 |           call med_map_field_packed( &
101 |                FBSrc=is_local%wrap%FBImp(complnd,complnd), &
102 |                FBDst=is_local%wrap%FBImp(complnd,compatm), &
103 |                FBFracSrc=is_local%wrap%FBFrac(complnd), &
104 |                field_NormOne=is_local%wrap%field_normOne(complnd,compatm,:), &
105 |                packed_data=is_local%wrap%packed_data(complnd,compatm,:), &
106 |                routehandles=is_local%wrap%RH(complnd,compatm,:), rc=rc)
107 |           if (ChkErr(rc,__LINE__,u_FILE_u)) return
108 |        end if
109 | 
110 |     end if
111 | 
112 |     if (dbug_flag > 20) then
113 |        call ESMF_LogWrite(subname//' done', ESMF_LOGMSG_INFO)
114 |     end if
115 |     call t_stopf('MED:'//subname)
116 | 
117 |   end subroutine med_phases_post_lnd
118 | 
119 | end module med_phases_post_lnd_mod
120 | 


--------------------------------------------------------------------------------
/mediator/Makefile:
--------------------------------------------------------------------------------
 1 | ifneq ($(origin ESMFMKFILE), environment)
 2 | $(error Environment variable ESMFMKFILE was not set.)
 3 | endif
 4 | 
 5 | include $(ESMFMKFILE)
 6 | ESMF_VERSION_MAJOR ?= 0
 7 | ESMF_VERSION_MINOR ?= 0
 8 | CPPDEFS += -DESMF_VERSION_MAJOR=$(ESMF_VERSION_MAJOR) -DESMF_VERSION_MINOR=$(ESMF_VERSION_MINOR)
 9 | 
10 | ifndef PIO_INC
11 | $(error PIO_INC should point to PIO include directory.)
12 | endif
13 | 
14 | ifeq ($(INTERNAL_PIO_INIT),1)
15 | CPPDEFS += -DINTERNAL_PIO_INIT
16 | endif
17 | 
18 | LIBRARY := libcmeps.a
19 | 
20 | OBJ = $(patsubst %.F90, %.o, $(wildcard *.F90))
21 | 
22 | all default: $(LIBRARY)
23 | 
24 | $(LIBRARY): $(OBJ)
25 | 	$(AR) $(ARFLAGS) $@ $?
26 | 
27 | %.o: %.F90
28 | 	$(ESMF_F90COMPILER) -c $(ESMF_F90COMPILEOPTS) $(ESMF_F90COMPILEPATHS) $(CPPDEFS) -I${PIO_INC} -I../util $*.F90
29 | 
30 | clean:
31 | 	$(RM) -f $(LIBRARY) *.i90 *.o *.mod
32 | 
33 | med_kind_mod.o :
34 | med_constants_mod.o : med_kind_mod.o
35 | esmFlds.o : med_kind_mod.o
36 | esmFldsExchange_cesm_mod.o : med_kind_mod.o med_methods_mod.o esmFlds.o med_internalstate_mod.o med_utils_mod.o
37 | esmFldsExchange_ufs_mod.o : med_kind_mod.o med_methods_mod.o esmFlds.o med_internalstate_mod.o med_utils_mod.o
38 | esmFldsExchange_hafs_mod.o : med_kind_mod.o med_methods_mod.o esmFlds.o med_internalstate_mod.o med_utils_mod.o
39 | med.o : med_kind_mod.o med_phases_profile_mod.o med_utils_mod.o med_phases_prep_rof_mod.o med_phases_aofluxes_mod.o \
40 |    med_phases_prep_ice_mod.o med_fraction_mod.o med_map_mod.o med_constants_mod.o med_phases_prep_wav_mod.o \
41 |    med_phases_prep_lnd_mod.o med_phases_history_mod.o med_phases_ocnalb_mod.o med_phases_restart_mod.o \
42 |    med_internalstate_mod.o med_phases_prep_atm_mod.o esmFldsExchange_cesm_mod.o esmFldsExchange_ufs_mod.o \
43 |    esmFldsExchange_hafs_mod.o med_phases_prep_glc_mod.o esmFlds.o med_io_mod.o med_methods_mod.o med_phases_prep_ocn_mod.o \
44 |    med_phases_post_atm_mod.o med_phases_post_ice_mod.o med_phases_post_lnd_mod.o med_phases_post_glc_mod.o med_phases_post_rof_mod.o \
45 |    med_phases_post_wav_mod.o
46 | med_fraction_mod.o : med_kind_mod.o med_utils_mod.o med_internalstate_mod.o med_constants_mod.o med_map_mod.o med_methods_mod.o esmFlds.o
47 | med_internalstate_mod.o : med_kind_mod.o esmFlds.o
48 | med_io_mod.o : med_kind_mod.o med_methods_mod.o med_constants_mod.o med_internalstate_mod.o med_utils_mod.o
49 | med_map_mod.o : med_kind_mod.o med_internalstate_mod.o med_constants_mod.o med_methods_mod.o esmFlds.o med_utils_mod.o
50 | med_merge_mod.o : med_kind_mod.o med_constants_mod.o med_internalstate_mod.o esmFlds.o med_methods_mod.o med_utils_mod.o
51 | med_methods_mod.o : med_kind_mod.o med_utils_mod.o med_constants_mod.o
52 | med_phases_aofluxes_mod.o : med_kind_mod.o med_utils_mod.o med_map_mod.o med_constants_mod.o med_internalstate_mod.o esmFlds.o med_methods_mod.o
53 | med_phases_history_mod.o : med_kind_mod.o med_utils_mod.o med_internalstate_mod.o med_constants_mod.o med_map_mod.o med_methods_mod.o med_io_mod.o esmFlds.o
54 | med_phases_ocnalb_mod.o : med_kind_mod.o med_utils_mod.o med_map_mod.o med_constants_mod.o med_internalstate_mod.o esmFlds.o med_methods_mod.o
55 | med_phases_prep_atm_mod.o : med_kind_mod.o esmFlds.o med_methods_mod.o med_merge_mod.o med_map_mod.o med_constants_mod.o med_phases_ocnalb_mod.o med_internalstate_mod.o med_utils_mod.o
56 | med_phases_prep_glc_mod.o : med_kind_mod.o med_utils_mod.o med_internalstate_mod.o med_map_mod.o med_constants_mod.o med_methods_mod.o esmFlds.o
57 | med_phases_prep_ice_mod.o : med_kind_mod.o med_utils_mod.o med_methods_mod.o med_merge_mod.o esmFlds.o med_internalstate_mod.o med_constants_mod.o med_map_mod.o
58 | med_phases_prep_lnd_mod.o : med_kind_mod.o med_internalstate_mod.o med_map_mod.o med_constants_mod.o med_merge_mod.o med_methods_mod.o esmFlds.o med_utils_mod.o
59 | med_phases_prep_ocn_mod.o : med_kind_mod.o med_internalstate_mod.o med_constants_mod.o med_map_mod.o med_merge_mod.o med_methods_mod.o esmFlds.o med_utils_mod.o
60 | med_phases_prep_rof_mod.o : med_kind_mod.o med_internalstate_mod.o med_map_mod.o med_constants_mod.o med_merge_mod.o med_methods_mod.o esmFlds.o med_utils_mod.o
61 | med_phases_prep_wav_mod.o : med_kind_mod.o med_utils_mod.o med_internalstate_mod.o med_constants_mod.o med_map_mod.o med_methods_mod.o med_merge_mod.o esmFlds.o
62 | med_phases_post_atm_mod.o : med_kind_mod.o esmFlds.o med_methods_mod.o med_map_mod.o med_constants_mod.o med_internalstate_mod.o med_utils_mod.o
63 | med_phases_post_ice_mod.o : med_kind_mod.o esmFlds.o med_methods_mod.o med_map_mod.o med_constants_mod.o med_internalstate_mod.o med_utils_mod.o
64 | med_phases_post_lnd_mod.o : med_kind_mod.o esmFlds.o med_methods_mod.o med_map_mod.o med_constants_mod.o med_internalstate_mod.o med_utils_mod.o
65 | med_phases_post_glc_mod.o : med_kind_mod.o esmFlds.o med_methods_mod.o med_map_mod.o med_constants_mod.o med_internalstate_mod.o med_utils_mod.o
66 | med_phases_post_ocn_mod.o : med_kind_mod.o esmFlds.o med_methods_mod.o med_map_mod.o med_constants_mod.o med_internalstate_mod.o med_utils_mod.o
67 | med_phases_post_rof_mod.o : med_kind_mod.o esmFlds.o med_methods_mod.o med_map_mod.o med_constants_mod.o med_internalstate_mod.o med_utils_mod.o
68 | med_phases_post_wav_mod.o : med_kind_mod.o esmFlds.o med_methods_mod.o med_map_mod.o med_constants_mod.o med_internalstate_mod.o med_utils_mod.o
69 | med_phases_profile_mod.o : med_kind_mod.o med_utils_mod.o med_constants_mod.o med_internalstate_mod.o med_time_mod.o
70 | med_phases_restart_mod.o : med_kind_mod.o med_utils_mod.o med_constants_mod.o med_internalstate_mod.o esmFlds.o med_io_mod.o
71 | med_utils_mod.o : med_kind_mod.o
72 | med_diag_mod.o : med_kind_mod.o med_utils_mod.o med_methods_mod.o med_internalstate_mod.o
73 | 


--------------------------------------------------------------------------------
/doc/source/addendum/req_attributes_cesm.rst:
--------------------------------------------------------------------------------
  1 | .. _cesm-attributes:
  2 | 
  3 | =======================
  4 |  CMEPS CESM attributes
  5 | =======================
  6 | 
  7 | The following *additional* attributes are required for CESM model applications.
  8 | 
  9 | General
 10 | --------------
 11 | 
 12 | **diro**, **logfile**
 13 |   Specifies the full pathname of the directory and filename of the directory and file name for mediator log output.
 14 |   For CESM this is determine in the attribute group ``MED_modelio`` that is generated by the CIME case control system.
 15 | 
 16 | **flds_i2o_per_cat**
 17 |   if true, select per ice thickness category fields are passed to the ocean.
 18 | 
 19 | Toggle for active compoenents
 20 | -----------------------------
 21 | 
 22 | **ATM_model**, **GLC_model**, **ICE_model**, **LND_model**, **ROF_model**, **OCN_model**, **WAV_model**
 23 |   In CESM, stub components are still used. These attributes determine if the component is a stub component and sets the
 24 |   mediator present flag for that component to ``false``.
 25 | 
 26 | Mediator Mapping file attributes
 27 | --------------------------------
 28 | 
 29 |   If a mapping file value is set to ``unset``, then CMEPS will create an online route handle instead.
 30 | 
 31 | **ice2atm_fmapname**, **ice2atm_smapname**
 32 |   ice -> atm fluxes and state mapping files
 33 | **lnd2atm_fmapname**, **lnd2atm_smapname**
 34 |   land -> atm fluxes and state mapping files
 35 | **ocn2atm_smapname**, **ocn2atm_fmapname**
 36 |   ocean -> atm fluxes and state mapping files
 37 | **atm2lnd_fmapname**, **atm2lnd_smapname**
 38 |   atm -> land fluxes and state mapping files
 39 | **atm2ice_fmapname**, **atm2ice_smapname**, **atm2ice_vmapname**
 40 |   atmosphere -> sea-ice fluxes, state, and velocities
 41 | **atm2ocn_fmapname**, **atm2ocn_smapname**, **atm2ocn_vmapname**
 42 |   atmosphere -> ocean fluxes, state, and velocities
 43 | **rof2lnd_fmapname**
 44 |   river -> land flux mapping file
 45 | **glc2lnd_fmapname**, **glc2lnd_smapname**
 46 |   land-ice -> land fluxes and state mapping files
 47 | **glc2ice_rmapname**
 48 |   "smoothed" land-ice -> sea-ice liquid mapping file
 49 | **glc2ocn_liq_rmapname**, **glc2ocn_ice_rmapname**
 50 |   "smoothed" land-ice -> ocean liquid and ice mapping files
 51 | **rof2ocn_liq_rmapname**, **rof2ocn_ice_rmapname**
 52 |   "smoothed" river -> ocean liquid and ice mapping file
 53 | **wav2ocn_smapname**
 54 |   wave -> ocean state mapping file
 55 | **lnd2rof_fmapname**
 56 |   land -> river flux mapping file
 57 | **lnd2glc_fmapname**, **lnd2glc_smapname**
 58 |   land -> land-ice flux and state mapping file
 59 | **atm2wav_smapname**, **ice2wav_smapname**, **ocn2wav_smapname**
 60 |   atmosphere -> wave, ice -> wave and ocean -> wave state mapping files
 61 | 
 62 | **mapuv_with_cart3d**
 63 |   used for atm->ocn and atm-ice mapping of u and v
 64 |   if true, rotate u,v to 3d cartesian space, map from src->dest, then rotate back
 65 | 
 66 | Mediator ocean albedo attributes
 67 | --------------------------------
 68 | 
 69 |   The following are used by CMEPS to calculate ocean albedoes in used in ``med_phases_ocnalb_mod.F90``
 70 | 
 71 | **start_type**
 72 |   Determines if start type of the run. The currently supported values are ``startup``, ``continue`` and ``branch``.
 73 | **orb_mode**
 74 |   orbital model setting configured. The supported values are::
 75 | 
 76 |     fixed_year:  uses the orb_iyear and other orb inputs are ignored.  In
 77 |     this mode, the orbital parameters are constant and based on the year.
 78 | 
 79 |     variable_year: uses the orb_iyear and orb_iyear_align.  In this mode,
 80 |     the orbital parameters vary as the model year advances and the model
 81 |     year orb_iyear_align has the equivalent orbital year of orb_iyear.
 82 | 
 83 |     fixed_parameters: uses the orb_eccen, orb_mvelp, and orb_obliq to set
 84 |     the orbital parameters which then remain constant through the model integration
 85 | 
 86 | **orb_iyear**
 87 |   year of orbit, used when orb_mode is fixed_year or variable_year
 88 | **orb_iyear_align**
 89 |   model year associated with orb_iyear when orb_mode is variable_year
 90 | **orb_obliq**
 91 |   obliquity of orbit in degrees, used when orb_mode is fixed_parameters
 92 | **orb_eccen**
 93 |   eccentricity of orbit, used when orb_mode is fixed_parameters.
 94 | **orb_mvelp**
 95 |  location of vernal equinox in longitude degrees, used when orb_mode is fixed_parameters
 96 | 
 97 | Mediator land-ice component attribtes
 98 | -------------------------------------
 99 | 
100 | **glc_renormalize_smb**
101 |   Whether to renormalize the surface mass balance (smb) sent from lnd to glc so that the
102 |   global integral on the glc grid agrees with the global integral on the lnd grid.
103 | 
104 |   Unlike most fluxes, smb is remapped with bilinear rather than conservative mapping
105 |   weights, so this option is needed for conservation. However, this can be turned off in
106 |   non-fully-coupled configurations where conservation isn't important (e.g., glc-only
107 |   configurations - T compsets) to avoid the global correction that comes with this
108 |   renormalization.
109 | 
110 |   Allowable values are:
111 |   ``on``: do this renormalization
112 | 
113 |   ``off``: do not do this renormalization; note that this will break conservation so
114 |   typically should not be used in fully-coupled cases
115 | 
116 |   Only used if running with a GLC component.
117 | 
118 | **glc_avg_period**
119 |   Period at which coupler averages fields sent to GLC (the land-ice component).
120 |   This supports doing the averaging to GLC less frequently than GLC is called
121 |   (i.e., separating the averaging frequency from the calling frequency).
122 |   This is useful because there are benefits to only averaging the GLC inputs
123 |   as frequently as they are really needed (yearly for CISM), but GLC needs to
124 |   still be called more frequently than that in order to support mid-year restarts.
125 |   Setting glc_avg_period to 'glc_coupling_period' means that the averaging is
126 |   done exactly when the GLC is called (governed by GLC_NCPL).
127 | 
128 | **glc_cpl_dt**
129 |   glc coupling interval in seconds
130 | 


--------------------------------------------------------------------------------
/cesm/nuopc_cap_share/shr_ozone_coupling_mod.F90:
--------------------------------------------------------------------------------
  1 | module shr_ozone_coupling_mod
  2 | 
  3 |   !========================================================================
  4 |   ! Module for handling namelist variables related to ozone coupling
  5 |   !========================================================================
  6 | 
  7 |   use ESMF         , only : ESMF_VMGetCurrent, ESMF_VM, ESMF_VMGet
  8 |   use ESMF         , only : ESMF_LogFoundError, ESMF_LOGERR_PASSTHRU, ESMF_SUCCESS
  9 |   use shr_sys_mod  , only : shr_sys_abort
 10 |   use shr_log_mod  , only : shr_log_getLogUnit
 11 |   use shr_nl_mod   , only : shr_nl_find_group_name
 12 |   use shr_mpi_mod  , only : shr_mpi_bcast
 13 | 
 14 |   implicit none
 15 |   private
 16 | 
 17 |   ! !PUBLIC MEMBER FUNCTIONS
 18 |   public shr_ozone_coupling_readnl  ! Read namelist
 19 | 
 20 |   ! !PUBLIC DATA MEMBERS
 21 |   ! atm_ozone_frequency can be one of the following values
 22 |   integer, parameter, public :: atm_ozone_frequency_unset = 0
 23 |   integer, parameter, public :: atm_ozone_frequency_subdaily = 1
 24 |   integer, parameter, public :: atm_ozone_frequency_multiday_average = 2
 25 | 
 26 |   character(len=*), parameter :: &
 27 |        u_FILE_u=__FILE__
 28 | 
 29 |   !====================================================================================
 30 | CONTAINS
 31 |   !====================================================================================
 32 | 
 33 |   subroutine shr_ozone_coupling_readnl(NLFilename, atm_ozone_frequency_val)
 34 | 
 35 |     !========================================================================
 36 |     ! reads ozone_coupling_nl namelist and returns a variable specifying the frequency at
 37 |     ! which the atmosphere model computes surface ozone
 38 |     !========================================================================
 39 | 
 40 |     ! input/output variables
 41 |     character(len=*), intent(in)  :: NLFilename ! Namelist filename
 42 |     ! atm_ozone_frequency will be one of the above constants (atm_ozone_frequency_*),
 43 |     ! specifying the frequency at which the atmosphere model computes surface ozone
 44 |     integer         , intent(out) :: atm_ozone_frequency_val
 45 | 
 46 |     !----- local -----
 47 |     character(len=64) :: atm_ozone_frequency
 48 |     type(ESMF_VM)     :: vm
 49 |     integer           :: unitn                  ! namelist unit number
 50 |     integer           :: ierr                   ! error code
 51 |     logical           :: exists                 ! if file exists or not
 52 |     integer           :: rc
 53 |     integer           :: localpet
 54 |     integer           :: mpicom
 55 |     integer           :: s_logunit
 56 |     character(len=*), parameter :: atm_ozone_frequency_not_present = 'NOT_PRESENT'
 57 |     character(len=*), parameter :: subname = '(shr_ozone_coupling_readnl) '
 58 |     ! ------------------------------------------------------------------
 59 | 
 60 |     namelist /ozone_coupling_nl/ atm_ozone_frequency
 61 | 
 62 |     rc = ESMF_SUCCESS
 63 | 
 64 |     !--- Open and read namelist ---
 65 |     if ( len_trim(NLFilename) == 0 ) then
 66 |        call shr_sys_abort( subname//'ERROR: nlfilename not set' )
 67 |     end if
 68 |     call shr_log_getLogUnit(s_logunit)
 69 |     call ESMF_VMGetCurrent(vm, rc=rc)
 70 |     if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, line=__LINE__, file=__FILE__)) return
 71 | 
 72 |     call ESMF_VMGet(vm, localPet=localpet, mpiCommunicator=mpicom, rc=rc)
 73 |     if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, line=__LINE__, file=__FILE__)) return
 74 | 
 75 |     if (localpet==0) then
 76 |        ! ------------------------------------------------------------------------
 77 |        ! Set default values in case namelist file doesn't exist, ozone_coupling_nl group
 78 |        ! doesn't exist within the file, or a given variable isn't present in the namelist
 79 |        ! group in the file.
 80 |        ! ------------------------------------------------------------------------
 81 |        atm_ozone_frequency = atm_ozone_frequency_not_present
 82 | 
 83 |        ! ------------------------------------------------------------------------
 84 |        ! Read namelist file
 85 |        ! ------------------------------------------------------------------------
 86 |        inquire( file=trim(NLFileName), exist=exists)
 87 |        if ( exists ) then
 88 |           open(newunit=unitn, file=trim(NLFilename), status='old' )
 89 |           write(s_logunit,'(a)') '(shr_ozone_coupling_readnl) Read in ozone_coupling_nl namelist from: ', trim(NLFilename)
 90 |           call shr_nl_find_group_name(unitn, 'ozone_coupling_nl', ierr)
 91 |           if (ierr == 0) then
 92 |              ! Note that ierr /= 0 means no namelist is present.
 93 |              read(unitn, ozone_coupling_nl, iostat=ierr)
 94 |              if (ierr > 0) then
 95 |                 call shr_sys_abort(trim(subname)//'problem reading ozone_coupling_nl ')
 96 |              end if
 97 |           end if
 98 |           close( unitn )
 99 |        end if
100 | 
101 |        ! ------------------------------------------------------------------------
102 |        ! Translate read-in values to appropriate return values
103 |        ! ------------------------------------------------------------------------
104 |        select case(atm_ozone_frequency)
105 |        case(atm_ozone_frequency_not_present)
106 |           atm_ozone_frequency_val = atm_ozone_frequency_unset
107 |        case("subdaily")
108 |           atm_ozone_frequency_val = atm_ozone_frequency_subdaily
109 |        case("multiday_average")
110 |           atm_ozone_frequency_val = atm_ozone_frequency_multiday_average
111 |        case default
112 |           call shr_sys_abort(trim(subname)//'unknown value for atm_ozone_frequency: '// &
113 |                trim(atm_ozone_frequency))
114 |        end select
115 |     end if
116 | 
117 |     ! ------------------------------------------------------------------------
118 |     ! Broadcast values to all processors
119 |     ! ------------------------------------------------------------------------
120 |     call shr_mpi_bcast(atm_ozone_frequency_val, mpicom)
121 | 
122 |   end subroutine shr_ozone_coupling_readnl
123 | 
124 | end module shr_ozone_coupling_mod
125 | 


--------------------------------------------------------------------------------
/mediator/med_phases_post_atm_mod.F90:
--------------------------------------------------------------------------------
  1 | module med_phases_post_atm_mod
  2 | 
  3 |   !-----------------------------------------------------------------------------
  4 |   ! Mediator phase for post atm calculations, maps atm->ice, atm->lnd, atm->ocn
  5 |   ! and atm->wav
  6 |   !-----------------------------------------------------------------------------
  7 |  
  8 |   implicit none
  9 |   private
 10 | 
 11 |   public :: med_phases_post_atm
 12 | 
 13 |   character(*), parameter :: u_FILE_u  = &
 14 |        __FILE__
 15 | 
 16 | !-----------------------------------------------------------------------------
 17 | contains
 18 | !-----------------------------------------------------------------------------
 19 | 
 20 |   subroutine med_phases_post_atm(gcomp, rc)
 21 | 
 22 |     !---------------------------------------
 23 |     ! map atm to ocn and atm to ice and atm to land
 24 |     !---------------------------------------
 25 | 
 26 |     use NUOPC_Mediator        , only : NUOPC_MediatorGet
 27 |     use ESMF                  , only : ESMF_Clock, ESMF_ClockIsCreated
 28 |     use ESMF                  , only : ESMF_GridComp, ESMF_GridCompGet, ESMF_FieldBundleGet
 29 |     use ESMF                  , only : ESMF_LogWrite, ESMF_LOGMSG_INFO, ESMF_SUCCESS
 30 |     use med_kind_mod          , only : CX=>SHR_KIND_CX, CS=>SHR_KIND_CS, CL=>SHR_KIND_CL, R8=>SHR_KIND_R8
 31 |     use med_internalstate_mod , only : InternalState
 32 |     use med_phases_history_mod, only : med_phases_history_write_comp
 33 |     use med_map_mod           , only : med_map_field_packed
 34 |     use med_constants_mod     , only : dbug_flag => med_constants_dbug_flag
 35 |     use med_utils_mod         , only : chkerr    => med_utils_ChkErr
 36 |     use med_internalstate_mod , only : compocn, compatm, compice, complnd, compwav
 37 |     use perf_mod              , only : t_startf, t_stopf
 38 | 
 39 |     ! input/output variables
 40 |     type(ESMF_GridComp)  :: gcomp
 41 |     integer, intent(out) :: rc
 42 | 
 43 |     ! local variables
 44 |     type(InternalState) :: is_local
 45 |     type(ESMF_Clock)    :: dClock
 46 |     character(len=*), parameter :: subname='(med_phases_post_atm)'
 47 |     !-------------------------------------------------------------------------------
 48 | 
 49 |     rc = ESMF_SUCCESS
 50 | 
 51 |     call t_startf('MED:'//subname)
 52 |     if (dbug_flag > 20) then
 53 |        call ESMF_LogWrite(subname//' called', ESMF_LOGMSG_INFO)
 54 |     end if
 55 | 
 56 |     ! Get the internal state
 57 |     nullify(is_local%wrap)
 58 |     call ESMF_GridCompGetInternalState(gcomp, is_local, rc)
 59 |     if (ChkErr(rc,__LINE__,u_FILE_u)) return
 60 | 
 61 |     ! map atm to ocn
 62 |     if (is_local%wrap%med_coupling_active(compatm,compocn)) then
 63 |        call t_startf('MED:'//trim(subname)//' map_atm2ocn')
 64 |        call med_map_field_packed( &
 65 |             FBSrc=is_local%wrap%FBImp(compatm,compatm), &
 66 |             FBDst=is_local%wrap%FBImp(compatm,compocn), &
 67 |             FBFracSrc=is_local%wrap%FBFrac(compatm), &
 68 |             FBDat=is_local%wrap%FBData(compocn), &
 69 |             field_normOne=is_local%wrap%field_normOne(compatm,compocn,:), &
 70 |             packed_data=is_local%wrap%packed_data(compatm,compocn,:), &
 71 |             routehandles=is_local%wrap%RH(compatm,compocn,:), rc=rc)
 72 |        if (ChkErr(rc,__LINE__,u_FILE_u)) return
 73 |        call t_stopf('MED:'//trim(subname)//' map_atm2ocn')
 74 |     end if
 75 |     ! map atm->ice
 76 |     if (is_local%wrap%med_coupling_active(compatm,compice)) then
 77 |        call t_startf('MED:'//trim(subname)//' map_atm2ice')
 78 |        call med_map_field_packed( &
 79 |             FBSrc=is_local%wrap%FBImp(compatm,compatm), &
 80 |             FBDst=is_local%wrap%FBImp(compatm,compice), &
 81 |             FBFracSrc=is_local%wrap%FBFrac(compatm), &
 82 |             field_normOne=is_local%wrap%field_normOne(compatm,compice,:), &
 83 |             packed_data=is_local%wrap%packed_data(compatm,compice,:), &
 84 |             routehandles=is_local%wrap%RH(compatm,compice,:), rc=rc)
 85 |        if (ChkErr(rc,__LINE__,u_FILE_u)) return
 86 |        call t_stopf('MED:'//trim(subname)//' map_atm2ice')
 87 |     end if
 88 |     ! map atm->lnd
 89 |     if (is_local%wrap%med_coupling_active(compatm,complnd)) then
 90 |        call t_startf('MED:'//trim(subname)//' map_atm2lnd')
 91 |        call med_map_field_packed( &
 92 |             FBSrc=is_local%wrap%FBImp(compatm,compatm), &
 93 |             FBDst=is_local%wrap%FBImp(compatm,complnd), &
 94 |             FBFracSrc=is_local%wrap%FBFrac(compatm), &
 95 |             field_normOne=is_local%wrap%field_normOne(compatm,complnd,:), &
 96 |             packed_data=is_local%wrap%packed_data(compatm,complnd,:), &
 97 |             routehandles=is_local%wrap%RH(compatm,complnd,:), rc=rc)
 98 |        if (ChkErr(rc,__LINE__,u_FILE_u)) return
 99 |        call t_stopf('MED:'//trim(subname)//' map_atm2lnd')
100 |     end if
101 |     ! map atm->wav
102 |     if (is_local%wrap%med_coupling_active(compatm,compwav)) then
103 |        call t_startf('MED:'//trim(subname)//' map_atm2wav')
104 |        call med_map_field_packed( &
105 |             FBSrc=is_local%wrap%FBImp(compatm,compatm), &
106 |             FBDst=is_local%wrap%FBImp(compatm,compwav), &
107 |             FBFracSrc=is_local%wrap%FBFrac(compatm), &
108 |             FBDat=is_local%wrap%FBData(compwav), &
109 |             field_normOne=is_local%wrap%field_normOne(compatm,compwav,:), &
110 |             packed_data=is_local%wrap%packed_data(compatm,compwav,:), &
111 |             routehandles=is_local%wrap%RH(compatm,compwav,:), rc=rc)
112 |        if (ChkErr(rc,__LINE__,u_FILE_u)) return
113 |        call t_stopf('MED:'//trim(subname)//' map_atm2wav')
114 |     end if
115 | 
116 |     ! Write atm inst, avg or aux if requested in mediator attributes
117 |     call NUOPC_MediatorGet(gcomp, driverClock=dClock, rc=rc)
118 |     if (ChkErr(rc,__LINE__,u_FILE_u)) return
119 |     if (ESMF_ClockIsCreated(dclock)) then
120 |        call med_phases_history_write_comp(gcomp, compatm, rc=rc)
121 |        if (ChkErr(rc,__LINE__,u_FILE_u)) return
122 |     end if
123 | 
124 |     if (dbug_flag > 20) then
125 |        call ESMF_LogWrite(subname//' done', ESMF_LOGMSG_INFO)
126 |     end if
127 |     call t_stopf('MED:'//subname)
128 | 
129 |   end subroutine med_phases_post_atm
130 | 
131 | end module med_phases_post_atm_mod
132 | 


--------------------------------------------------------------------------------
/cime_config/config_pes.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0"?>
  2 | 
  3 | <config_pes>
  4 | 
  5 |   <grid name="any">
  6 |     <mach name="any">
  7 |       <pes pesize="any" compset="any">
  8 | 	<comment>none</comment>
  9 | 	<ntasks>
 10 | 	  <ntasks_atm>-1</ntasks_atm>
 11 | 	  <ntasks_rof>-1</ntasks_rof>
 12 | 	  <ntasks_ocn>-1</ntasks_ocn>
 13 | 	  <ntasks_ice>-1</ntasks_ice>
 14 | 	  <ntasks_cpl>-1</ntasks_cpl>
 15 | 	  <ntasks_lnd>-1</ntasks_lnd>
 16 | 	  <ntasks_glc>-1</ntasks_glc>
 17 | 	  <ntasks_wav>-1</ntasks_wav>
 18 | 	  <ntasks_esp>-1</ntasks_esp>
 19 | 	</ntasks>
 20 | 	<nthrds>
 21 | 	  <nthrds_atm>1</nthrds_atm>
 22 | 	  <nthrds_lnd>1</nthrds_lnd>
 23 | 	  <nthrds_rof>1</nthrds_rof>
 24 | 	  <nthrds_ice>1</nthrds_ice>
 25 | 	  <nthrds_ocn>1</nthrds_ocn>
 26 | 	  <nthrds_glc>1</nthrds_glc>
 27 | 	  <nthrds_wav>1</nthrds_wav>
 28 | 	  <nthrds_esp>1</nthrds_esp>
 29 | 	  <nthrds_cpl>1</nthrds_cpl>
 30 | 	</nthrds>
 31 | 	<rootpe>
 32 | 	  <rootpe_atm>0</rootpe_atm>
 33 | 	  <rootpe_rof>0</rootpe_rof>
 34 | 	  <rootpe_ice>0</rootpe_ice>
 35 | 	  <rootpe_ocn>0</rootpe_ocn>
 36 | 	  <rootpe_cpl>0</rootpe_cpl>
 37 | 	  <rootpe_lnd>0</rootpe_lnd>
 38 | 	  <rootpe_glc>0</rootpe_glc>
 39 | 	  <rootpe_wav>0</rootpe_wav>
 40 | 	  <rootpe_esp>0</rootpe_esp>
 41 | 	</rootpe>
 42 |       </pes>
 43 |     </mach>
 44 |   </grid>
 45 | 
 46 |   <grid name="a%T62">
 47 |     <mach name="yellowstone|pronghorn">
 48 |       <pes pesize="any" compset="DATM%IAF">
 49 | 	<comment>none</comment>
 50 | 	<ntasks>
 51 | 	  <ntasks_atm>60</ntasks_atm>
 52 | 	  <ntasks_rof>60</ntasks_rof>
 53 | 	  <ntasks_ocn>60</ntasks_ocn>
 54 | 	  <ntasks_ice>60</ntasks_ice>
 55 | 	  <ntasks_cpl>60</ntasks_cpl>
 56 | 	  <ntasks_lnd>60</ntasks_lnd>
 57 | 	  <ntasks_glc>60</ntasks_glc>
 58 | 	  <ntasks_wav>60</ntasks_wav>
 59 | 	  <ntasks_esp>60</ntasks_esp>
 60 | 	</ntasks>
 61 | 	<nthrds>
 62 | 	  <nthrds_atm>2</nthrds_atm>
 63 | 	  <nthrds_lnd>2</nthrds_lnd>
 64 | 	  <nthrds_rof>2</nthrds_rof>
 65 | 	  <nthrds_ice>2</nthrds_ice>
 66 | 	  <nthrds_ocn>2</nthrds_ocn>
 67 | 	  <nthrds_glc>2</nthrds_glc>
 68 | 	  <nthrds_wav>2</nthrds_wav>
 69 | 	  <nthrds_esp>2</nthrds_esp>
 70 | 	  <nthrds_cpl>2</nthrds_cpl>
 71 | 	</nthrds>
 72 | 	<rootpe>
 73 | 	  <rootpe_atm>0</rootpe_atm>
 74 | 	  <rootpe_rof>0</rootpe_rof>
 75 | 	  <rootpe_ice>0</rootpe_ice>
 76 | 	  <rootpe_ocn>0</rootpe_ocn>
 77 | 	  <rootpe_cpl>0</rootpe_cpl>
 78 | 	  <rootpe_lnd>0</rootpe_lnd>
 79 | 	  <rootpe_glc>0</rootpe_glc>
 80 | 	  <rootpe_wav>0</rootpe_wav>
 81 | 	  <rootpe_esp>0</rootpe_esp>
 82 | 	</rootpe>
 83 |       </pes>
 84 |     </mach>
 85 |   </grid>
 86 | 
 87 |   <grid name="a%T62">
 88 |     <mach name="yellowstone|pronghorn">
 89 |       <pes pesize="L" compset="DATM%IAF">
 90 | 	<comment>none</comment>
 91 | 	<ntasks>
 92 | 	  <ntasks_atm>-8</ntasks_atm>
 93 | 	  <ntasks_rof>-8</ntasks_rof>
 94 | 	  <ntasks_ocn>-8</ntasks_ocn>
 95 | 	  <ntasks_ice>-8</ntasks_ice>
 96 | 	  <ntasks_cpl>-8</ntasks_cpl>
 97 | 	  <ntasks_lnd>-8</ntasks_lnd>
 98 | 	  <ntasks_glc>-8</ntasks_glc>
 99 | 	  <ntasks_wav>-8</ntasks_wav>
100 | 	  <ntasks_esp>-8</ntasks_esp>
101 | 	</ntasks>
102 | 	<nthrds>
103 | 	  <nthrds_atm>2</nthrds_atm>
104 | 	  <nthrds_lnd>2</nthrds_lnd>
105 | 	  <nthrds_rof>2</nthrds_rof>
106 | 	  <nthrds_ice>2</nthrds_ice>
107 | 	  <nthrds_ocn>2</nthrds_ocn>
108 | 	  <nthrds_glc>2</nthrds_glc>
109 | 	  <nthrds_wav>2</nthrds_wav>
110 | 	  <nthrds_cpl>2</nthrds_cpl>
111 | 	  <nthrds_esp>1</nthrds_esp>
112 | 	</nthrds>
113 | 	<rootpe>
114 | 	  <rootpe_atm>0</rootpe_atm>
115 | 	  <rootpe_rof>0</rootpe_rof>
116 | 	  <rootpe_ice>0</rootpe_ice>
117 | 	  <rootpe_ocn>0</rootpe_ocn>
118 | 	  <rootpe_cpl>0</rootpe_cpl>
119 | 	  <rootpe_lnd>0</rootpe_lnd>
120 | 	  <rootpe_glc>0</rootpe_glc>
121 | 	  <rootpe_wav>0</rootpe_wav>
122 | 	  <rootpe_esp>0</rootpe_esp>
123 | 	</rootpe>
124 |       </pes>
125 |     </mach>
126 |   </grid>
127 | 
128 |   <grid name="any">
129 |     <mach name="mira">
130 |       <pes pesize="any" compset="[DX]ATM">
131 | 	<comment>none</comment>
132 | 	<ntasks>
133 | 	  <ntasks_atm>-1</ntasks_atm>
134 | 	  <ntasks_rof>-1</ntasks_rof>
135 | 	  <ntasks_ocn>-1</ntasks_ocn>
136 | 	  <ntasks_ice>-1</ntasks_ice>
137 | 	  <ntasks_cpl>-1</ntasks_cpl>
138 | 	  <ntasks_lnd>-1</ntasks_lnd>
139 | 	  <ntasks_glc>-1</ntasks_glc>
140 | 	  <ntasks_wav>-1</ntasks_wav>
141 | 	  <ntasks_esp>-1</ntasks_esp>
142 | 	</ntasks>
143 | 	<nthrds>
144 | 	  <nthrds_atm>8</nthrds_atm>
145 | 	  <nthrds_lnd>8</nthrds_lnd>
146 | 	  <nthrds_rof>8</nthrds_rof>
147 | 	  <nthrds_ice>8</nthrds_ice>
148 | 	  <nthrds_ocn>8</nthrds_ocn>
149 | 	  <nthrds_glc>8</nthrds_glc>
150 | 	  <nthrds_wav>8</nthrds_wav>
151 | 	  <nthrds_esp>8</nthrds_esp>
152 | 	  <nthrds_cpl>8</nthrds_cpl>
153 | 	</nthrds>
154 | 	<rootpe>
155 | 	  <rootpe_atm>0</rootpe_atm>
156 | 	  <rootpe_rof>0</rootpe_rof>
157 | 	  <rootpe_ice>0</rootpe_ice>
158 | 	  <rootpe_ocn>0</rootpe_ocn>
159 | 	  <rootpe_cpl>0</rootpe_cpl>
160 | 	  <rootpe_lnd>0</rootpe_lnd>
161 | 	  <rootpe_glc>0</rootpe_glc>
162 | 	  <rootpe_wav>0</rootpe_wav>
163 | 	  <rootpe_esp>0</rootpe_esp>
164 | 	</rootpe>
165 |       </pes>
166 |     </mach>
167 |   </grid>
168 | 
169 |   <grid name="any">
170 |     <mach name="cetus">
171 |       <pes pesize="any" compset="any">
172 |         <comment>PE layout for tests</comment>
173 |         <ntasks>
174 |           <ntasks_atm>64</ntasks_atm>
175 |           <ntasks_rof>64</ntasks_rof>
176 |           <ntasks_ocn>64</ntasks_ocn>
177 |           <ntasks_ice>64</ntasks_ice>
178 |           <ntasks_cpl>64</ntasks_cpl>
179 |           <ntasks_lnd>64</ntasks_lnd>
180 |           <ntasks_glc>64</ntasks_glc>
181 |           <ntasks_wav>64</ntasks_wav>
182 |           <ntasks_esp>64</ntasks_esp>
183 |         </ntasks>
184 |         <nthrds>
185 |           <nthrds_atm>16</nthrds_atm>
186 |           <nthrds_lnd>16</nthrds_lnd>
187 |           <nthrds_rof>16</nthrds_rof>
188 |           <nthrds_ice>16</nthrds_ice>
189 |           <nthrds_ocn>16</nthrds_ocn>
190 |           <nthrds_glc>16</nthrds_glc>
191 |           <nthrds_wav>16</nthrds_wav>
192 |           <nthrds_esp>16</nthrds_esp>
193 |           <nthrds_cpl>16</nthrds_cpl>
194 |         </nthrds>
195 |         <rootpe>
196 |           <rootpe_atm>0</rootpe_atm>
197 |           <rootpe_rof>0</rootpe_rof>
198 |           <rootpe_ice>0</rootpe_ice>
199 |           <rootpe_ocn>0</rootpe_ocn>
200 |           <rootpe_cpl>0</rootpe_cpl>
201 |           <rootpe_lnd>0</rootpe_lnd>
202 |           <rootpe_glc>0</rootpe_glc>
203 |           <rootpe_wav>0</rootpe_wav>
204 |           <rootpe_esp>0</rootpe_esp>
205 |         </rootpe>
206 |       </pes>
207 |     </mach>
208 |   </grid>
209 | </config_pes>
210 | 


--------------------------------------------------------------------------------
/doc/source/conf.py:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | #
  3 | # on documentation build configuration file, created by
  4 | # sphinx-quickstart on Tue Jan 31 19:46:36 2017.
  5 | #
  6 | # This file is execfile()d with the current directory set to its
  7 | # containing dir.
  8 | #
  9 | # Note that not all possible configuration values are present in this
 10 | # autogenerated file.
 11 | #
 12 | # All configuration values have a default; values that are commented out
 13 | # serve to show the default.
 14 | 
 15 | # If extensions (or modules to document with autodoc) are in another directory,
 16 | # add these directories to sys.path here. If the directory is relative to the
 17 | # documentation root, use os.path.abspath to make it absolute, like shown here.
 18 | #
 19 | import os
 20 | import sys
 21 | # Note that we need a specific version of sphinx_rtd_theme. This can be obtained with:
 22 | # pip install git+https://github.com/esmci/sphinx_rtd_theme.git@version-dropdown-with-fixes
 23 | import sphinx_rtd_theme
 24 | 
 25 | # -- General configuration ------------------------------------------------
 26 | 
 27 | # If your documentation needs a minimal Sphinx version, state it here.
 28 | #
 29 | # needs_sphinx = '1.0'
 30 | 
 31 | # Add any Sphinx extension module names here, as strings. They can be
 32 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 33 | # ones.
 34 | extensions = [
 35 |     'sphinx.ext.todo',
 36 |     'sphinx.ext.coverage',
 37 |     'sphinx.ext.githubpages',
 38 |     'sphinx.ext.autodoc',
 39 |     'sphinx.ext.autosummary',
 40 |     'sphinx.ext.viewcode',
 41 |     'sphinx.ext.todo',
 42 | ]
 43 | todo_include_todos=True
 44 | 
 45 | # Add any paths that contain templates here, relative to this directory.
 46 | templates_path = ['_templates']
 47 | 
 48 | # The suffix(es) of source filenames.
 49 | # You can specify multiple suffix as a list of string:
 50 | #
 51 | # source_suffix = ['.rst', '.md']
 52 | source_suffix = '.rst'
 53 | 
 54 | # The main toctree document.
 55 | main_doc = 'index'
 56 | 
 57 | # General information about the project.
 58 | project = u'CMEPS'
 59 | copyright = u'2020, U.S. National Science Foundation'
 60 | author = u'Staff of the NSF/CESM project and NOAA/EMC'
 61 | 
 62 | # The version info for the project you're documenting, acts as replacement for
 63 | # |version| and |release|, also used in various other places throughout the
 64 | # built documents.
 65 | #
 66 | # The short X.Y version.
 67 | version = u'main'
 68 | # The full version, including alpha/beta/rc tags.
 69 | release = u'main'
 70 | 
 71 | # The language for content autogenerated by Sphinx. Refer to documentation
 72 | # for a list of supported languages.
 73 | #
 74 | # This is also used if you do content translation via gettext catalogs.
 75 | # Usually you set "language" from the command line for these cases.
 76 | language = None
 77 | 
 78 | # List of patterns, relative to source directory, that match files and
 79 | # directories to ignore when looking for source files.
 80 | # This patterns also effect to html_static_path and html_extra_path
 81 | exclude_patterns = []
 82 | 
 83 | # The name of the Pygments (syntax highlighting) style to use.
 84 | pygments_style = 'sphinx'
 85 | 
 86 | # If true, `todo` and `todoList` produce output, else they produce nothing.
 87 | todo_include_todos = True
 88 | 
 89 | # -- Options for HTML output ----------------------------------------------
 90 | 
 91 | # The theme to use for HTML and HTML Help pages.  See the documentation for
 92 | # a list of builtin themes.
 93 | #
 94 | html_theme = 'sphinx_rtd_theme'
 95 | 
 96 | # Theme options are theme-specific and customize the look and feel of a theme
 97 | # further.  For a list of options available for each theme, see the
 98 | # documentation.
 99 | #
100 | #html_theme_options = {"stickysidebar": "true"}
101 | 
102 | # The 'versions' option needs to have at least two versions to work, but it doesn't need
103 | # to have all versions: others will be added dynamically. Note that this maps from version
104 | # names to html links. The current version can link to the current location (i.e., do
105 | # nothing). For the other version, we just add a place-holder; its name and value are
106 | # unimportant because these versions will get replaced dynamically.
107 | html_theme_options = {}
108 | html_theme_options['versions'] = {version: ''}
109 | html_theme_options['versions']['[placeholder]'] = ''
110 | 
111 | # Add any paths that contain custom static files (such as style sheets) here,
112 | # relative to this directory. They are copied after the builtin static files,
113 | # so a file named "default.css" will overwrite the builtin "default.css".
114 | html_static_path = ['_static']
115 | 
116 | # -- Options for HTMLHelp output ------------------------------------------
117 | 
118 | # Output file base name for HTML help builder.
119 | htmlhelp_basename = 'ondoc'
120 | 
121 | 
122 | # -- Options for LaTeX output ---------------------------------------------
123 | 
124 | latex_elements = {
125 |     # The paper size ('letterpaper' or 'a4paper').
126 |     #
127 |     # 'papersize': 'letterpaper',
128 | 
129 |     # The font size ('10pt', '11pt' or '12pt').
130 |     #
131 |     # 'pointsize': '10pt',
132 | 
133 |     # Additional stuff for the LaTeX preamble.
134 |     #
135 |     # 'preamble': '',
136 | 
137 |     # Latex figure (float) alignment
138 |     #
139 |     # 'figure_align': 'htbp',
140 | }
141 | 
142 | # Grouping the document tree into LaTeX files. List of tuples
143 | # (source start file, target name, title,
144 | #  author, documentclass [howto, manual, or own class]).
145 | latex_documents = [
146 |     (main_doc, 'on.tex', u'on Documentation',
147 |      u'Staff of the NCAR and NOAA/EMC', 'manual'),
148 | ]
149 | 
150 | 
151 | # -- Options for manual page output ---------------------------------------
152 | 
153 | # One entry per manual page. List of tuples
154 | # (source start file, name, description, authors, manual section).
155 | man_pages = [
156 |     (main_doc, 'on', u'on Documentation',
157 |      [author], 1)
158 | ]
159 | 
160 | 
161 | # -- Options for Texinfo output -------------------------------------------
162 | 
163 | # Grouping the document tree into Texinfo files. List of tuples
164 | # (source start file, target name, title, author,
165 | #  dir menu entry, description, category)
166 | texinfo_documents = [
167 |     (main_doc, 'on', u'on Documentation',
168 |      author, 'on', 'One line description of project.',
169 |      'Miscellaneous'),
170 | ]
171 | 
172 | # -- Options for pdf output -------------------------------------------------
173 | 
174 | pdf_documents = [
175 |     (main_doc,
176 |      u'CMEPS_Users_Guide',
177 |      u'CMEPS Users Guide (PDF)',)
178 | ]
179 | 


--------------------------------------------------------------------------------
/doc/source/addendum/fieldnames.rst:
--------------------------------------------------------------------------------
  1 | .. _field_naming_convention:
  2 | 
  3 | CMEPS field names
  4 | =================
  5 | 
  6 | The following state names are currently supported. Note that each application might only use a subset of these fields.
  7 | 
  8 | .. csv-table:: "Atmospheric State Names (import to mediator)"
  9 |    :header: "stat name", "description"
 10 |    :widths: 20, 60
 11 | 
 12 |    "Sa_co2diag", "diagnostic CO2 at the lowest model level"
 13 |    "Sa_co2prog", "prognostic CO2 at the lowest model level"
 14 |    "Sa_dens", "air density at lowest model layer"
 15 |    "Sa_pbot", "air pressure at lowest model layer"
 16 |    "Sa_pslv", "air pressure at land and sea surface"
 17 |    "Sa_ptem", "potential temperature at lowest model layer"
 18 |    "Sa_shum", "air specific humidity at lowest model layer"
 19 |    "Sa_tbot", "air temperature at lowest model layer"
 20 |    "Sa_topo", "surface topographic height"
 21 |    "Sa_u", "air zonal wind at lowest model layer"
 22 |    "Sa_v", "air meridional wind at lowest model layer"
 23 |    "Sa_z", "air height wind at lowest model layer"
 24 | 
 25 | .. csv-table:: "Sea Ice State Names (import to mediator)"
 26 |    :header: "name", "description"
 27 |    :widths: 20, 60
 28 | 
 29 |    "Si_anidf", "sea ice near infrared diffuse albedo"
 30 |    "Si_anidr", "sea ice near infrared direct albedo"
 31 |    "Si_avsdf", "sea ice visible diffuse albedo"
 32 |    "Si_avsdr", "sea ice visible direct albedo"
 33 |    "Si_ifrac", "sea ice fraction"
 34 |    "Si_imask", "sea ice land mask"
 35 |    "Si_ifrac_n", "ice fraction by thickness category"
 36 |    "Si_qref", "reference height specific humidity"
 37 |    "Si_t", "sea ice surface temperature"
 38 |    "Si_tref", "reference height temperature"
 39 |    "Si_u10", "10m wind speed"
 40 |    "Si_vice", "volume of sea ice per unit area"
 41 |    "Si_snowh", "surface snow water equivalent"
 42 |    "Si_vsno", "volume of snow per unit area"
 43 | 
 44 | .. csv-table:: "Land State Names (import to mediator)"
 45 |    :header: "name", "description"
 46 |    :widths: 20, 60
 47 | 
 48 |    "Sl_anidf", ""
 49 |    "Sl_anidr", ""
 50 |    "Sl_avsdf", ""
 51 |    "Sl_avsdr", ""
 52 |    "Sl_ddvel", ""
 53 |    "Sl_fv", ""
 54 |    "Sl_fztop", ""
 55 |    "Sl_lfrac", ""
 56 |    "Sl_lfrin", ""
 57 |    "Sl_qref", ""
 58 |    "Sl_ram1", ""
 59 |    "Sl_snowh", ""
 60 |    "Sl_t", ""
 61 |    "Sl_topo_elev", ""
 62 |    "Sl_topo", ""
 63 |    "Sl_tsrf_elev", ""
 64 |    "Sl_tsrf", ""
 65 |    "Sl_tref", ""
 66 |    "Sl_u10", ""
 67 | 
 68 | .. csv-table:: "Ocean State Names (import to mediator)"
 69 |    :header: "name", "description"
 70 |    :widths: 20, 60
 71 | 
 72 |    "So_blddepth", "ocean boundary layer depth"
 73 |    "So_anidf", "ocean near infrared diffuse albedo"
 74 |    "So_anidr", "ocean near infrared direct albedo"
 75 |    "So_avsdf", "ocean visible diffuse albedo"
 76 |    "So_avsdr", "ocean visible direct albedo"
 77 |    "So_bldepth", "ocean mixed layer depth"
 78 |    "So_dhdx", "sea surface slope in meridional direction"
 79 |    "So_dhdy", "sea surface slope in zonal direction"
 80 |    "So_duu10n", "10m wind speed"
 81 |    "So_fswpen", "shortwave penetration through sea ice (all bands)"
 82 |    "So_ofrac", "ocean fraction"
 83 |    "So_omask", "ocean land mask"
 84 |    "So_qref", "reference specific humidity at 2 meters"
 85 |    "So_re", "square of exchange coefficient for tracers (mediator aoflux)"
 86 |    "So_s", "sea surface salinity"
 87 |    "So_ssq", "surface saturation specific humidity in ocean (mediator aoflux)"
 88 |    "So_t", "sea surface temperature"
 89 |    "So_tref", "reference temperature at 2 meters"
 90 |    "So_u", "ocean current in zonal direction"
 91 |    "So_u10", "10m wind speed"
 92 |    "So_ustar", "friction velocity (mediator aoflux)"
 93 |    "So_v", "ocean current in meridional direction"
 94 | 
 95 | .. csv-table:: "Land Ice State Names (import to mediator)"
 96 |    :header: "name", "description"
 97 |    :widths: 20, 60
 98 | 
 99 |    "Sg_ice_covered", ""
100 |    "Sg_ice_covered_elev", ""
101 |    "Sg_icemask", ""
102 |    "Sg_icemask_coupled_fluxes", ""
103 |    "Sg_topo", ""
104 |    "Sg_topo_elev", ""
105 | 
106 | .. csv-table:: "Wave State Names (import to mediator) "
107 |    :header: "name", "description"
108 |    :widths: 20, 60
109 | 
110 |    "Sw_hstokes", "Stokes drift depth"
111 |    "Sw_lamult", "Langmuir multiplier"
112 |    "Sw_ustokes", "Stokes drift u-component"
113 |    "Sw_vstokes", "Stokes drift v-component"
114 | 
115 | .. csv-table:: "Mediator State Names (export from mediator)"
116 |    :header: "name", "description"
117 |    :widths: 20, 60
118 | 
119 |    "Sx_anidf", ""
120 |    "Sx_anidr", ""
121 |    "Sx_avsdf", ""
122 |    "Sx_avsdr", ""
123 |    "Sx_qref", "merged reference specific humidity at 2 meters"
124 |    "Sx_t", "merged ice and ocean surface temperature"
125 |    "Sx_tref", "merged reference temperature at 2 meters"
126 |    "Sx_u10", "merged 10m wind speed"
127 | 
128 | State Variables
129 | ~~~~~~~~~~~~~~~
130 | 
131 | The following flux prefixes are used:
132 | 
133 | .. csv-table::
134 |    :header: "flux prefix", "description"
135 |    :widths: 20, 60
136 | 
137 |    "Faxa\_", "atm flux computed by atm"
138 |    "Fall\_", "lnd-atm flux computed by lnd"
139 |    "Fioi\_", "ice-ocn flux computed by ice"
140 |    "Faii\_", "ice_atm flux computed by ice"
141 |    "Flrr\_", "lnd-rof flux computed by rof"
142 |    "Firr\_", "rof-ice flux computed by rof"
143 |    "Faxx\_", "mediator merged fluxes sent to the atm"
144 |    "Foxx\_", "mediator merged fluxes sent to the ocn"
145 |    "Fixx\_", "mediator merged fluxes sent to the ice"
146 | 
147 | The following flux-names are used:
148 | 
149 | .. csv-table::
150 |    :header: "flux name", "description"
151 |    :widths: 20, 60
152 | 
153 |    "_evap", "air-ice evaporative water flux, positive downwards"
154 |    "_lat", "air-ice latent heat, positive downwards"
155 |    "_lwup", "air-ice surface longwave flux, positive downwards"
156 |    "_sen", "air-ice sensible heat, positive downwards"
157 |    "_swnet", "net short wave, positive downwards"
158 |    "_melth", "net heat flux to ocean from ice"
159 |    "_meltw", "fresh water flux to ocean from ice"
160 |    "_salt", "salt to ocean from ice"
161 |    "_swpen", "flux of shortwave through ice to ocean"
162 |    "_swpen_vdr", "flux of visible direct shortwave through ice to ocean"
163 |    "_swpen_vdf", "flux of visible diffuse shortwave through ice to ocean"
164 |    "_swpen_idr", "flux of near infrared direct through ice to ocean"
165 |    "_swpen_idf", "flux of near infrared diffuse through ice to ocean"
166 |    "_taux", "zonal stress, positive downwards"
167 |    "_tauy", "air-ice meridional stress, positive downwards"
168 |    "_q", "ice-ocn freezing melting potential"
169 | 


--------------------------------------------------------------------------------
/mediator/med_phases_prep_lnd_mod.F90:
--------------------------------------------------------------------------------
  1 | module med_phases_prep_lnd_mod
  2 | 
  3 |   !-----------------------------------------------------------------------------
  4 |   ! Mediator phases for preparing land export from mediator
  5 |   !-----------------------------------------------------------------------------
  6 | 
  7 |   use med_kind_mod,    only : CX=>SHR_KIND_CX, CS=>SHR_KIND_CS, CL=>SHR_KIND_CL, R8=>SHR_KIND_R8
  8 |   use med_methods_mod, only : fldchk => med_methods_FB_FldChk
  9 | 
 10 |   implicit none
 11 |   private
 12 | 
 13 |   public  :: med_phases_prep_lnd
 14 | 
 15 |   character(*) , parameter :: u_FILE_u = &
 16 |        __FILE__
 17 | 
 18 | !================================================================================================
 19 | contains
 20 | !================================================================================================
 21 | 
 22 |   subroutine med_phases_prep_lnd(gcomp, rc)
 23 | 
 24 |     use NUOPC                 , only : NUOPC_CompAttributeGet
 25 |     use ESMF                  , only : operator(/=), operator(==)
 26 |     use ESMF                  , only : ESMF_LogWrite, ESMF_LOGMSG_INFO, ESMF_SUCCESS
 27 |     use ESMF                  , only : ESMF_FieldBundle, ESMF_FieldBundleGet, ESMF_Field, ESMF_FieldGet
 28 |     use ESMF                  , only : ESMF_GridComp, ESMF_GridCompGet
 29 |     use ESMF                  , only : ESMF_StateGet, ESMF_StateItem_Flag, ESMF_STATEITEM_NOTFOUND
 30 |     use esmFlds               , only : med_fldList_GetFldListTo, med_fldList_type
 31 |     use med_methods_mod       , only : fldbun_diagnose  => med_methods_FB_diagnose
 32 |     use med_methods_mod       , only : FB_check_for_nans => med_methods_FB_check_for_nans
 33 |     use med_utils_mod         , only : chkerr           => med_utils_ChkErr
 34 |     use med_constants_mod     , only : dbug_flag        => med_constants_dbug_flag
 35 |     use med_internalstate_mod , only : complnd, compatm
 36 |     use med_internalstate_mod , only : InternalState, maintask, logunit
 37 |     use med_merge_mod         , only : med_merge_auto
 38 |     use perf_mod              , only : t_startf, t_stopf
 39 | 
 40 |     ! input/output variables
 41 |     type(ESMF_GridComp)  :: gcomp
 42 |     integer, intent(out) :: rc
 43 | 
 44 |     ! local variables
 45 |     type(ESMF_StateItem_Flag)   :: itemType
 46 |     type(InternalState)         :: is_local
 47 |     type(ESMF_Field)            :: lfield
 48 |     integer                     :: ncnt
 49 |     integer                     :: scalar_id
 50 |     logical                     :: first_call = .true.
 51 |     logical                     :: field_found
 52 |     type(med_fldlist_type), pointer :: fldList
 53 |     real(r8), pointer           :: dataptr_scalar_lnd(:,:)
 54 |     real(r8), pointer           :: dataptr_scalar_atm(:,:)
 55 |     character(len=*), parameter :: subname='(med_phases_prep_lnd)'
 56 |     !---------------------------------------
 57 | 
 58 |     rc = ESMF_SUCCESS
 59 | 
 60 |     call t_startf('MED:'//subname)
 61 |     if (dbug_flag > 5) then
 62 |        call ESMF_LogWrite(trim(subname)//": called", ESMF_LOGMSG_INFO)
 63 |     end if
 64 | 
 65 |     ! Get the internal state
 66 |     nullify(is_local%wrap)
 67 |     call ESMF_GridCompGetInternalState(gcomp, is_local, rc)
 68 |     if (ChkErr(rc,__LINE__,u_FILE_u)) return
 69 | 
 70 |     ! Count the number of fields outside of scalar data, if zero, then return
 71 |     ! Note - the scalar field has been removed from all mediator field bundles - so this is why we check if the
 72 |     ! fieldCount is 0 and not 1 here
 73 | 
 74 |     call ESMF_FieldBundleGet(is_local%wrap%FBExp(complnd), fieldCount=ncnt, rc=rc)
 75 |     if (ChkErr(rc,__LINE__,u_FILE_u)) return
 76 | 
 77 |     if (ncnt > 0) then
 78 | 
 79 |        ! atm2lnd is done in med_phases_post_atm
 80 |        ! rof2lnd is done in med_phases_post_rof
 81 |        ! glc2lnd is done in med_phases_post_glc
 82 | 
 83 |        ! auto merges to create FBExp(complnd) - other than glc->lnd
 84 |        ! The following will merge all fields in fldsSrc
 85 |        call t_startf('MED:'//trim(subname)//' merge')
 86 |        fldList => med_fldList_GetFldListTo(complnd)
 87 |        call med_merge_auto(&
 88 |             is_local%wrap%med_coupling_active(:,complnd), &
 89 |             is_local%wrap%FBExp(complnd), &
 90 |             is_local%wrap%FBFrac(complnd), &
 91 |             is_local%wrap%FBImp(:,complnd), &
 92 |             fldList, &
 93 |             rc=rc)
 94 |        if (ChkErr(rc,__LINE__,u_FILE_u)) return
 95 |        call t_stopf('MED:'//trim(subname)//' merge')
 96 | 
 97 |        ! check cpl_scalars is in the state or not? fix for land components that do not have cpl_scalars
 98 |        call ESMF_StateGet(is_local%wrap%NStateExp(complnd), trim(is_local%wrap%flds_scalar_name), itemType, rc=rc)
 99 |        if (chkerr(rc,__LINE__,u_FILE_u)) return
100 |        field_found = .true.
101 |        if (itemType == ESMF_STATEITEM_NOTFOUND) field_found = .false.
102 | 
103 |        ! obtain nextsw_cday from atm if it is in the import state and send it to lnd
104 |        scalar_id=is_local%wrap%flds_scalar_index_nextsw_cday
105 |        if (scalar_id > 0 .and. field_found .and. maintask) then
106 |           call ESMF_StateGet(is_local%wrap%NstateImp(compatm), &
107 |                itemName=trim(is_local%wrap%flds_scalar_name), field=lfield, rc=rc)
108 |           if (chkerr(rc,__LINE__,u_FILE_u)) return
109 |           call ESMF_FieldGet(lfield, farrayPtr=dataptr_scalar_atm, rc=rc)
110 |           if (chkerr(rc,__LINE__,u_FILE_u)) return
111 |           call ESMF_StateGet(is_local%wrap%NStateExp(complnd), &
112 |                trim(is_local%wrap%flds_scalar_name), field=lfield, rc=rc)
113 |           if (chkerr(rc,__LINE__,u_FILE_u)) return
114 |           call ESMF_FieldGet(lfield, farrayPtr=dataptr_scalar_lnd, rc=rc)
115 |           if (chkerr(rc,__LINE__,u_FILE_u)) return
116 |           scalar_id=is_local%wrap%flds_scalar_index_nextsw_cday
117 |           dataptr_scalar_lnd(scalar_id,1) = dataptr_scalar_atm(scalar_id,1)
118 |        end if
119 | 
120 |        ! diagnose
121 |        if (dbug_flag > 1) then
122 |           call fldbun_diagnose(is_local%wrap%FBExp(complnd), &
123 |                string=trim(subname)//' FBexp(complnd) ', rc=rc)
124 |           if (ChkErr(rc,__LINE__,u_FILE_u)) return
125 |        end if
126 |     end if
127 | 
128 |     ! Set first call logical to false
129 |     first_call = .false.
130 | 
131 |     ! Check for nans in fields export to lnd
132 |     call FB_check_for_nans(is_local%wrap%FBExp(complnd), maintask, logunit, rc=rc)
133 |     if (ChkErr(rc,__LINE__,u_FILE_u)) return
134 | 
135 |     if (dbug_flag > 5) then
136 |        call ESMF_LogWrite(trim(subname)//": done", ESMF_LOGMSG_INFO)
137 |     end if
138 |     call t_stopf('MED:'//subname)
139 | 
140 |   end subroutine med_phases_prep_lnd
141 | 
142 | end module med_phases_prep_lnd_mod
143 | 


--------------------------------------------------------------------------------
/cesm/flux_atmocn/flux_atmocn_driver_mod.F90:
--------------------------------------------------------------------------------
  1 | module flux_atmocn_driver_mod
  2 | 
  3 |   use shr_kind_mod,          only : R8=>SHR_KIND_R8, IN=>SHR_KIND_IN ! shared kinds
  4 |   use shr_const_mod,         only : shr_const_spval
  5 |   use shr_sys_mod,           only : shr_sys_abort
  6 |   use shr_strconvert_mod,    only : toString
  7 |   use flux_atmocn_Large_mod, only : flux_atmocn_Large
  8 |   use flux_atmocn_COARE_mod, only : flux_atmocn_COARE
  9 |   use flux_atmocn_UA_mod,    only : flux_atmocn_UA
 10 | 
 11 |   implicit none
 12 |   public
 13 | 
 14 |   integer, private, parameter :: ocn_flux_scheme_large_and_pond = 0
 15 |   integer, private, parameter :: ocn_flux_scheme_coare = 1
 16 |   integer, private, parameter :: ocn_flux_scheme_ua = 2
 17 | 
 18 | contains
 19 | 
 20 |   subroutine flux_atmOcn_driver(logunit, nMax, &
 21 |        zbot, ubot, vbot, thbot,                &
 22 |        qbot,  rainc, rbot,                     &
 23 |        tbot, us, vs, pslv,                     &
 24 |        ts, mask,  seq_flux_atmocn_minwind,     &
 25 |        sen, lat, lwup, evap,                   &
 26 |        taux, tauy, tref, qref,                 &
 27 |        ocn_surface_flux_scheme,                &
 28 |        add_gusts, duu10n, ugust_out, u10res,   &
 29 |        ustar_sv, re_sv, ssq_sv, missval)
 30 | 
 31 |     !--- input arguments --------------------------------
 32 |     integer  , intent(in) :: logunit
 33 |     integer  , intent(in) :: nMax        ! data vector length
 34 |     integer  , intent(in) :: mask (nMax) ! ocn domain mask       0 <=> out of domain
 35 |     logical  , intent(in) :: add_gusts
 36 |     real(R8) , intent(in) :: zbot (nMax) ! atm level height (m)
 37 |     real(R8) , intent(in) :: ubot (nMax) ! atm u wind (m/s)
 38 |     real(R8) , intent(in) :: vbot (nMax) ! atm v wind (m/s)
 39 |     real(R8) , intent(in) :: thbot(nMax) ! atm potential T (K)
 40 |     real(R8) , intent(in) :: qbot (nMax) ! atm specific humidity (kg/kg)
 41 |     real(R8) , intent(in) :: rainc(nMax) ! atm precip for convective gustiness (kg/m^3) - RBN 24Nov2008/MDF 31Jan2022
 42 |     real(R8) , intent(in) :: rbot (nMax) ! atm air density (kg/m^3)
 43 |     real(R8) , intent(in) :: tbot (nMax) ! atm T (K)
 44 |     real(R8) , intent(in) :: pslv (nMax) ! atm sea level pressure(Pa)
 45 |     real(R8) , intent(in) :: us   (nMax) ! ocn u-velocity (m/s)
 46 |     real(R8) , intent(in) :: vs   (nMax) ! ocn v-velocity (m/s)
 47 |     real(R8) , intent(in) :: ts   (nMax) ! ocn temperature (K)
 48 |     real(R8) , intent(in) :: seq_flux_atmocn_minwind        ! minimum wind speed for atmocn (m/s)
 49 |     integer  , intent(in) :: ocn_surface_flux_scheme
 50 | 
 51 |     !--- output arguments -------------------------------
 52 |     real(R8),intent(out)  ::  sen  (nMax)     ! heat flux: sensible (W/m^2)
 53 |     real(R8),intent(out)  ::  lat  (nMax)     ! heat flux: latent (W/m^2)
 54 |     real(R8),intent(out)  ::  lwup (nMax)     ! heat flux: lw upward (W/m^2)
 55 |     real(R8),intent(out)  ::  evap (nMax)     ! water flux: evap ((kg/s)/m^2)
 56 |     real(R8),intent(out)  ::  taux (nMax)     ! surface stress, zonal (N)
 57 |     real(R8),intent(out)  ::  tauy (nMax)     ! surface stress, meridional (N)
 58 |     real(R8),intent(out)  ::  tref (nMax)     ! diag:  2m ref height T (K)
 59 |     real(R8),intent(out)  ::  qref (nMax)     ! diag:  2m ref humidity (kg/kg)
 60 |     real(R8),intent(out)  :: duu10n(nMax)     ! diag: 10m wind speed squared (m/s)^2
 61 |     real(R8),intent(out)  :: ugust_out(nMax)  ! diag: gustiness addition to U10 (m/s)
 62 |     real(R8),intent(out)  :: u10res(nMax)     ! diag: gustiness addition to U10 (m/s)
 63 | 
 64 |     real(R8),intent(out),optional :: ustar_sv(nMax) ! diag: ustar
 65 |     real(R8),intent(out),optional :: re_sv   (nMax) ! diag: sqrt of exchange coefficient (water)
 66 |     real(R8),intent(out),optional :: ssq_sv  (nMax) ! diag: sea surface humidity (kg/kg)
 67 |     real(R8),intent(in) ,optional :: missval        ! masked value
 68 | 
 69 |     !--- local variables --------------------------------
 70 |     integer  :: n
 71 |     real(R8) :: spval  ! local missing value
 72 |     !--------------------------------------------------------------------------------
 73 | 
 74 |     if (present(missval)) then
 75 |        spval = missval
 76 |     else
 77 |        spval = shr_const_spval
 78 |     endif
 79 | 
 80 |     !!.................................................................
 81 |     !! ocn_surface_flux_scheme = 0 : Large and Pond
 82 |     !!                         = 1 : COARE algorithm
 83 |     !!                         = 2 : UA algorithm
 84 |     !!.................................................................
 85 | 
 86 |     ! Default flux scheme.
 87 |     if (ocn_surface_flux_scheme == ocn_flux_scheme_large_and_pond) then
 88 | 
 89 |        call flux_atmOcn_Large(                    &
 90 |             logunit, spval, nMax,                 &
 91 |             zbot, ubot, vbot, thbot,              &
 92 |             qbot,  rainc,  rbot,                  &
 93 |             tbot, us, vs,  pslv,                  &
 94 |             ts, mask,  seq_flux_atmocn_minwind,   &
 95 |             sen, lat, lwup,  evap,                &
 96 |             taux, tauy, tref, qref,               &
 97 |             add_gusts, duu10n, ugust_out, u10res, &
 98 |             ustar_sv=ustar_sv, re_sv=re_sv, ssq_sv=ssq_sv)
 99 | 
100 |     else if (ocn_surface_flux_scheme == ocn_flux_scheme_coare) then
101 | 
102 |        call flux_atmOcn_COARE(                  &
103 |             logunit, spval, nMax,               &
104 |             zbot, ubot, vbot, thbot,            &
105 |             qbot,  rainc, rbot,                 &
106 |             tbot, us, vs,  pslv,                &
107 |             ts, mask,  seq_flux_atmocn_minwind, &
108 |             sen, lat, lwup, evap,               &
109 |             taux, tauy, tref, qref,             &
110 |             duu10n, ugust_out, u10res,          &
111 |             ustar_sv=ustar_sv, re_sv=re_sv, ssq_sv=ssq_sv)
112 | 
113 |     else if (ocn_surface_flux_scheme == ocn_flux_scheme_ua) then
114 | 
115 |        call flux_atmOcn_UA(                 &
116 |             logunit, spval, nMax,           &
117 |             zbot, ubot, vbot, thbot,        &
118 |             qbot, rbot, tbot, us, vs, pslv, &
119 |             ts, mask, sen, lat, lwup, evap, &
120 |             taux, tauy, tref, qref,         &
121 |             duu10n, ustar_sv=ustar_sv, re_sv=re_sv, ssq_sv=ssq_sv)
122 | 
123 |        do n = 1,nMax
124 |           if (mask(n) /= 0) then
125 |              u10res(n) = sqrt(duu10n(n))
126 |              ugust_out(n) = 0._r8
127 |           else
128 |              u10res   (n) = spval
129 |              ugust_out(n) = spval
130 |           end if
131 |        end do
132 | 
133 |     else
134 | 
135 |        call shr_sys_abort("ocn_srfuace_flux_scheme = "// toString(ocn_surface_flux_scheme)//" is not supported")
136 | 
137 |     end if
138 | 
139 |   end subroutine flux_atmOcn_driver
140 | 
141 | end module flux_atmocn_driver_mod
142 | 


--------------------------------------------------------------------------------
/ufs/ufs_const_mod.F90:
--------------------------------------------------------------------------------
  1 | MODULE ufs_const_mod
  2 | 
  3 |    use ufs_kind_mod, only : R8 => shr_kind_r8
  4 | 
  5 |    !----------------------------------------------------------------------------
  6 |    ! physical constants (all data public)
  7 |    !----------------------------------------------------------------------------
  8 |    private :: R8
  9 |    public
 10 | 
 11 |    real(R8),parameter :: SHR_CONST_PI      = 3.14159265358979323846_R8  ! pi
 12 |    real(R8),parameter :: SHR_CONST_CDAY    = 86400.0_R8      ! sec in calendar day ~ sec
 13 |    real(R8),parameter :: SHR_CONST_SDAY    = 86164.0_R8      ! sec in siderial day ~ sec
 14 |    real(R8),parameter :: SHR_CONST_OMEGA   = 2.0_R8*SHR_CONST_PI/SHR_CONST_SDAY ! earth rot ~ rad/sec
 15 |    real(R8),parameter :: SHR_CONST_REARTH  = 6.37122e6_R8    ! radius of earth ~ m
 16 |    real(R8),parameter :: SHR_CONST_G       = 9.80616_R8      ! acceleration of gravity ~ m/s^2
 17 | 
 18 |    real(R8),parameter :: SHR_CONST_STEBOL  = 5.67e-8_R8      ! Stefan-Boltzmann constant ~ W/m^2/K^4
 19 |    real(R8),parameter :: SHR_CONST_BOLTZ   = 1.38065e-23_R8  ! Boltzmann's constant ~ J/K/molecule
 20 |    real(R8),parameter :: SHR_CONST_AVOGAD  = 6.02214e26_R8   ! Avogadro's number ~ molecules/kmole
 21 |    real(R8),parameter :: SHR_CONST_RGAS    = SHR_CONST_AVOGAD*SHR_CONST_BOLTZ       ! Universal gas constant ~ J/K/kmole
 22 |    real(R8),parameter :: SHR_CONST_MWDAIR  = 28.966_R8       ! molecular weight dry air ~ kg/kmole
 23 |    real(R8),parameter :: SHR_CONST_MWWV    = 18.016_R8       ! molecular weight water vapor
 24 |    real(R8),parameter :: SHR_CONST_RDAIR   = SHR_CONST_RGAS/SHR_CONST_MWDAIR        ! Dry air gas constant     ~ J/K/kg
 25 |    real(R8),parameter :: SHR_CONST_RWV     = SHR_CONST_RGAS/SHR_CONST_MWWV          ! Water vapor gas constant ~ J/K/kg
 26 |    real(R8),parameter :: SHR_CONST_ZVIR    = (SHR_CONST_RWV/SHR_CONST_RDAIR)-1.0_R8 ! RWV/RDAIR - 1.0
 27 |    real(R8),parameter :: SHR_CONST_KARMAN  = 0.4_R8          ! Von Karman constant
 28 |    real(R8),parameter :: SHR_CONST_PSTD    = 101325.0_R8     ! standard pressure ~ pascals
 29 |    real(R8),parameter :: SHR_CONST_PDB     = 0.0112372_R8    ! ratio of 13C/12C in Pee Dee Belemnite (C isotope standard)
 30 | 
 31 |    real(R8),parameter :: SHR_CONST_TKTRIP  = 273.16_R8       ! triple point of fresh water        ~ K
 32 |    real(R8),parameter :: SHR_CONST_TKFRZ   = 273.15_R8       ! freezing T of fresh water          ~ K
 33 |    real(R8),parameter :: SHR_CONST_TKFRZSW = SHR_CONST_TKFRZ - 1.8_R8 ! freezing T of salt water  ~ K
 34 |    real(R8),parameter :: SHR_CONST_ZSRFLYR = 3.0_R8          ! ocn surf layer depth for diurnal SST cal ~ m
 35 | 
 36 |    real(R8),parameter :: SHR_CONST_RHODAIR = &               ! density of dry air at STP  ~ kg/m^3
 37 |                          SHR_CONST_PSTD/(SHR_CONST_RDAIR*SHR_CONST_TKFRZ)
 38 |    real(R8),parameter :: SHR_CONST_RHOFW   = 1.000e3_R8      ! density of fresh water     ~ kg/m^3
 39 |    real(R8),parameter :: SHR_CONST_RHOSW   = 1.026e3_R8      ! density of sea water       ~ kg/m^3
 40 |    real(R8),parameter :: SHR_CONST_RHOICE  = 0.917e3_R8      ! density of ice             ~ kg/m^3
 41 |    real(R8),parameter :: SHR_CONST_CPDAIR  = 1.00464e3_R8    ! specific heat of dry air   ~ J/kg/K
 42 |    real(R8),parameter :: SHR_CONST_CPWV    = 1.810e3_R8      ! specific heat of water vap ~ J/kg/K
 43 |    real(R8),parameter :: SHR_CONST_CPVIR   = (SHR_CONST_CPWV/SHR_CONST_CPDAIR)-1.0_R8 ! CPWV/CPDAIR - 1.0
 44 |    real(R8),parameter :: SHR_CONST_CPFW    = 4.188e3_R8      ! specific heat of fresh h2o ~ J/kg/K
 45 |    real(R8),parameter :: SHR_CONST_CPSW    = 3.996e3_R8      ! specific heat of sea h2o   ~ J/kg/K
 46 |    real(R8),parameter :: SHR_CONST_CPICE   = 2.11727e3_R8    ! specific heat of fresh ice ~ J/kg/K
 47 |    real(R8),parameter :: SHR_CONST_LATICE  = 3.337e5_R8      ! latent heat of fusion      ~ J/kg
 48 |    real(R8),parameter :: SHR_CONST_LATVAP  = 2.501e6_R8      ! latent heat of evaporation ~ J/kg
 49 |    real(R8),parameter :: SHR_CONST_LATSUB  = &               ! latent heat of sublimation ~ J/kg
 50 |                          SHR_CONST_LATICE + SHR_CONST_LATVAP
 51 |    real(R8),parameter :: SHR_CONST_CONDICE = 2.1_R8          ! thermal conductivity of ice ~ W/m/K
 52 |    real(R8),parameter :: SHR_CONST_KAPPA_LAND_ICE = &        ! Diffusivity of heat in land ice ~
 53 |                          SHR_CONST_CONDICE / (SHR_CONST_RHOICE*SHR_CONST_CPICE)
 54 |    real(R8),parameter :: SHR_CONST_TF0    = 6.22e-2_R8       ! The freezing temperature at zero pressure in
 55 |    ! sub-ice-shelf ocean cavities ~ C
 56 |    real(R8),parameter :: SHR_CONST_DTF_DP = -7.43e-8_R8      ! The coefficient for the term proportional to the (limited)
 57 |    ! pressure in the freezing temperature in sub-ice-shelf ocean cavities. ~ C Pa^{-1}
 58 |    real(R8),parameter :: SHR_CONST_DTF_DS = -5.63e-2_R8      !The coefficient for the term proportional to salinity in
 59 |    ! the freezing temperature in sub-ice-ice ocean cavities ~ C PSU^{-1}
 60 |    real(R8),parameter :: SHR_CONST_DTF_DPDS = -1.74e-10_R8   ! The coefficient for the term proportional to salinity times
 61 |    ! pressure in the freezing temperature in sub-ice-shelf ocean cavities ~ C PSU^{-1} Pa^{-1}
 62 |    real(R8),parameter :: SHR_CONST_OCN_REF_SAL = 34.7_R8     ! ocn ref salinity (psu)
 63 |    real(R8),parameter :: SHR_CONST_ICE_REF_SAL =  4.0_R8     ! ice ref salinity (psu)
 64 | 
 65 |    real(R8),parameter :: SHR_CONST_SPVAL        = 1.0e30_R8                 ! special missing value
 66 |    real(R8),parameter :: SHR_CONST_SPVAL_TOLMIN = 0.99_R8 * SHR_CONST_SPVAL ! min spval tolerance
 67 |    real(R8),parameter :: SHR_CONST_SPVAL_TOLMAX = 1.01_R8 * SHR_CONST_SPVAL ! max spval tolerance
 68 |    real(R8),parameter :: SHR_CONST_SPVAL_AERODEP= 1.e29_r8                  ! special aerosol deposition
 69 | 
 70 |    !Water Isotope Ratios in Vienna Standard Mean Ocean Water (VSMOW):
 71 |    real(R8),parameter :: SHR_CONST_VSMOW_18O   = 2005.2e-6_R8   ! 18O/16O in VMSOW
 72 |    real(R8),parameter :: SHR_CONST_VSMOW_17O   = 379.e-6_R8   ! 18O/16O in VMSOW
 73 |    real(R8),parameter :: SHR_CONST_VSMOW_16O   = 0.997628_R8    ! 16O/Tot in VMSOW
 74 |    real(R8),parameter :: SHR_CONST_VSMOW_D   = 155.76e-6_R8   ! 2H/1H in VMSOW
 75 |    real(R8),parameter :: SHR_CONST_VSMOW_T   = 1.85e-6_R8  ! 3H/1H in VMSOW
 76 |    real(R8),parameter :: SHR_CONST_VSMOW_H   = 0.99984426_R8  ! 1H/Tot in VMSOW
 77 |    ! For best numerics in CAM5
 78 |    real(R8),parameter :: SHR_CONST_RSTD_H2ODEV   = 1.0_R8      ! Rstd Dev Use
 79 | 
 80 | contains
 81 | 
 82 | !-----------------------------------------------------------------------------
 83 | 
 84 |   elemental logical function shr_const_isspval(rval)
 85 | !$omp declare simd(shr_const_isspval)
 86 | 
 87 |      real(r8), intent(in) :: rval
 88 | 
 89 |      if (rval > SHR_CONST_SPVAL_TOLMIN .and. &
 90 |          rval < SHR_CONST_SPVAL_TOLMAX) then
 91 |         shr_const_isspval = .true.
 92 |      else
 93 |         shr_const_isspval = .false.
 94 |      endif
 95 | 
 96 |   end function shr_const_isspval
 97 | 
 98 | !-----------------------------------------------------------------------------
 99 | 
100 | END MODULE ufs_const_mod
101 | 


--------------------------------------------------------------------------------
/doc/source/generic.rst:
--------------------------------------------------------------------------------
  1 | .. _generic_modules:
  2 | 
  3 | =========================
  4 |  CMEPS `generic` modules
  5 | =========================
  6 | 
  7 | The following describes in some detail the CMEPS modules that are not
  8 | application specific and provide general functionality.
  9 | 
 10 | **med.F90**
 11 | 
 12 |   This module is initializes the CMEPS mediator functionality by performing the following functions:
 13 | 
 14 |   * adding a namespace (i.e. nested state) for each import and export
 15 |     component state in the mediator's InternalState
 16 | 
 17 |   * initializing the mediator component specific fields via a call to
 18 |     ``esmFldsExchange_xxx_`` (where currently xxx can be ``cesm``, ``ufs`` or ``hafs``).
 19 | 
 20 |   * determining which components are present
 21 | 
 22 |   * advertising the import and export mediator fields
 23 | 
 24 |   * creating import (``FBImp``), export (``FBExp``) and accumulation (``FBExpAccum``) field bundles
 25 | 
 26 |   * initializing the mediatory route handles and field bundles needed for normalization
 27 | 
 28 |   * initializing component ``FBFrac`` field bundles
 29 | 
 30 |   * reading mediator restarts
 31 | 
 32 |   * optionally carrying out initializations for atmosphere/ocean flux
 33 |     calculations and ocean albedo calculations (these are needed by CESM)
 34 | 
 35 |   * carrying out the NUOPC data initialization via the ``DataInitialize`` routine.
 36 | 
 37 |     .. note:: After the first DataInitialize() of CMEPS returns,
 38 | 	          NUOPC will note that its InitializeDataComplete is not yet true. The
 39 | 	          NUOPC Driver will then execute the Run() phase of all of the Connectors that
 40 | 	          fit the xxx-TO-MED pattern. After that, it will call CMEPS
 41 | 	          DataInitialize() again. Note that the time stamps are only set
 42 | 	          when the Run() phase of all the connectors are run and the
 43 | 	          Connectors Run() phase is called before the second call of the
 44 | 	          CMEPS DataInitialize phase. As a result, CMEPS will see the
 45 | 	          correct timestamps, which also indicates that the actual data has
 46 | 	          been transferred reliably, and CMEPS can safely use it.
 47 | 
 48 | **med_map_mod.F90**
 49 | 
 50 |   This module creates the required route handles that are needed for
 51 |   the model run.  The route handles are stored in the multi-dimensional array
 52 |   ``RH(ncomps,ncomps,nmappers)`` in the module ``med_internal_state_mod.F90``.
 53 | 
 54 |   ``nmappers`` is the total number of mapping types that CMEPS  supports (currently 8).
 55 |   These are described in :ref:`mapping types<addmap>`.
 56 | 
 57 |   ``ncomps,ncomps`` corresponds to the source and destination component indices.
 58 | 
 59 |   As an example ``RH(compatm,compocn,mapbilnr)`` is the atm->ocn bilinear route handle.
 60 | 
 61 |   **med_map_mod.F90** also initializes additional field bundles that
 62 |   are needed for mapping fractional normalization (see the
 63 |   :ref:`mapping normalization <normalization>`). Normalization is
 64 |   normally done using the relevant field from ``FBFrac(:)``.
 65 | 
 66 |   The default call to carry out mediator mapping is done in the
 67 |   :ref:`prep_modules<prep_modules>` by calling
 68 |   ``med_map_FB_Regrid_Norm``.  Mapping is done by using the
 69 |   ``fldListFr(:)`` data that was initialized in the
 70 |   ``esmFldsExchange_xxxx_mod.F90`` calls to ``addmap``.
 71 | 
 72 | **med_merge_mod.F90**
 73 | 
 74 |    This module carries out merging of one or more mapped source fields
 75 |    to the target destination field (see :ref:`merging
 76 |    types<addmrg>`). The :ref:`prep_modules<prep_modules>` carry out
 77 |    merging via the call to ``med_merge_auto`` Merging is done by using
 78 |    the ``fldListTo(:)`` data that was initialized in the
 79 |    ``esmFldsExchange_xxx_mod.F90`` calls to ``addmrg``.
 80 | 
 81 | **med_io_mod.F90**
 82 | 
 83 |    CMEPS uses the PIO2 parallel library to carry out all IO. PIO
 84 |    provides a netCDF-like API, and allows users to designate some
 85 |    subset of processors to perform IO. Computational code calls
 86 |    netCDF-like functions to read and write data, and PIO uses the IO
 87 |    processors to perform all necessary IO. This module contains
 88 |    wrapper layers to PIO for writing and reading mediator restart
 89 |    files and for writing mediator history files.
 90 | 
 91 | .. _history_writes:
 92 | 
 93 | **med_phases_history_mod.F90**
 94 | 
 95 |    This module writes mediator history files. The freqency of CMEPS
 96 |    history writes is controlled via the NUOPC attributes
 97 |    ``history_option`` and ``history_n``. These attributes control
 98 |    instantaneous mediator history output as follows:
 99 | 
100 |    ==============  =============================================================
101 |    history_option          description
102 |    ==============  =============================================================
103 |    none		   do not write any history files
104 |    never	   do not write any history files
105 |    nsteps	   write files every ``history_n`` mediator coupling intervals
106 |    nseconds	   write files every ``history_n`` seconds
107 |    nminutes	   write files every ``history_n`` minutes
108 |    nhours	   write files every ``history_n`` hours
109 |    ndays	   write files every ``history_n`` days
110 |    nmonths	   write files every ``history_n`` months
111 |    nyears	   write files every ``history_n`` years
112 |    monthly	   write files on the month boundary
113 |    yearly	   write files on the year boundary
114 |    ==============  =============================================================
115 | 
116 |    .. note:: It is assumed that the NUOPC attributes ``history_option`` and ``history_n``
117 | 	     are obtained by the model driver and passed down to the mediator.
118 | 
119 | .. _restart_writes:
120 | 
121 | **med_phases_restart_mod.F90**
122 | 
123 |    This module reads and writes mediator restart files. The freqency of CMEPS
124 |    restart writes is controlled via the NUOPC attributes
125 |    ``restart_option`` and ``restart_n``. These attributes control
126 |    instantaneous mediator history output as follows:
127 | 
128 |    ==============  =============================================================
129 |    restart_option          description
130 |    ==============  =============================================================
131 |    none		   do not write any restart files
132 |    never	   do not write any restart files
133 |    nsteps	   write files every ``restart_n`` mediator coupling intervals
134 |    nseconds	   write files every ``restart_n`` seconds
135 |    nminutes	   write files every ``restart_n`` minutes
136 |    nhours	   write files every ``restart_n`` hours
137 |    ndays	   write files every ``restart_n`` days
138 |    nmonths	   write files every ``restart_n`` months
139 |    nyears	   write files every ``restart_n`` years
140 |    monthly	   write files on the month boundary
141 |    yearly	   write files on the year boundary
142 |    ==============  =============================================================
143 | 
144 |    .. note:: It is assumed that the NUOPC attributes ``restart_option`` and ``restart_n``
145 | 	     are obtained by the model driver and passed down to the mediator.
146 | 


--------------------------------------------------------------------------------
/cesm/nuopc_cap_share/shr_expr_parser_mod.F90:
--------------------------------------------------------------------------------
  1 | !=============================================================================
  2 | ! expression parser utility --
  3 | !   for parsing simple linear mathematical expressions of the form
  4 | !   X = a*R + b*S + c*(X + Y + Z) ...
  5 | !
  6 | !=============================================================================
  7 | module shr_expr_parser_mod
  8 |   use shr_kind_mod,only : r8 => shr_kind_r8
  9 |   use shr_kind_mod,only : CXX => shr_kind_cxx
 10 | 
 11 |   implicit none
 12 |   private
 13 | 
 14 |   public :: shr_exp_parse     ! parses simple strings which contain expressions
 15 |   public :: shr_exp_item_t    ! user defined type which contains an expression component
 16 |   public :: shr_exp_list_destroy ! destroy the linked list returned by shr_exp_parse
 17 | 
 18 |   ! contains componets of expression
 19 |   type shr_exp_item_t
 20 |      character(len=64) :: name
 21 |      character(len=64),pointer :: vars(:) => null()
 22 |      real(r8)         ,pointer :: coeffs(:) => null()
 23 |      integer           :: n_terms = 0
 24 |      type(shr_exp_item_t), pointer :: next_item => null()
 25 |   end type shr_exp_item_t
 26 | 
 27 | contains
 28 | 
 29 |   ! -----------------------------------------------------------------
 30 |   ! parses expressions provided in array of strings
 31 |   ! -----------------------------------------------------------------
 32 |   function shr_exp_parse( exp_array, nitems ) result(exp_items_list)
 33 | 
 34 |     character(len=*), intent(in)   :: exp_array(:) ! contains a expressions
 35 |     integer, optional, intent(out) :: nitems       ! number of expressions parsed
 36 |     type(shr_exp_item_t), pointer  :: exp_items_list ! linked list of items returned
 37 | 
 38 |     integer :: i,j, n_exp_items
 39 |     type(shr_exp_item_t), pointer :: exp_item, list_item
 40 |     integer :: ndxs(512)
 41 |     integer :: nelem, j1,j2,k
 42 |     character(len=CXX) :: tmp_str, tmp_name
 43 |     character(len=8) :: xchr ! multipler
 44 |     real(r8) :: xdbl
 45 |     real(r8) :: coeff0
 46 |     logical :: more_to_come
 47 |     character(len=CXX), allocatable :: sums_grps(:)
 48 |     character(len=CXX) :: sum_string
 49 | 
 50 |     allocate(sums_grps(size(exp_array)))
 51 | 
 52 |     nullify( exp_items_list )
 53 |     nullify( exp_item )
 54 |     nullify( list_item )
 55 | 
 56 |     sums_grps(:) = ' '
 57 | 
 58 |     ! combine lines that have a trailing "+" with the next line
 59 |     i=1
 60 |     j=1
 61 |     loop1: do while( len_trim(exp_array(i)) > 0 )
 62 | 
 63 |        k = scan(exp_array(i), '+', back=.true. )
 64 |        more_to_come = k == len_trim(exp_array(i)) ! line ends with "+"
 65 | 
 66 |        if ( more_to_come ) then
 67 |           sums_grps(j) = trim(sums_grps(j)) // trim(adjustl(exp_array(i)))
 68 |        else
 69 |           sums_grps(j) = trim(sums_grps(j)) // trim(adjustl(exp_array(i)))
 70 |           j = j+1
 71 |        endif
 72 | 
 73 |        i = i+1
 74 |        if ( i > size(exp_array) ) exit loop1
 75 | 
 76 |     end do loop1
 77 | 
 78 |     n_exp_items = j-1
 79 | 
 80 |     ! a group is  a summation of terms
 81 | 
 82 |     ! parse the individual sum strings...  and form the groupings
 83 |     has_grps: if (n_exp_items>0) then
 84 | 
 85 |        ! from shr_megan_mod ... should be generalized and shared...
 86 |        grploop: do i = 1,n_exp_items
 87 | 
 88 |           ! parse out the term names
 89 |           ! from first parsing out the terms in the summation equation ("+" separates the terms)
 90 | 
 91 |           sum_string = sums_grps(i)
 92 |           j = scan( sum_string, '=' )
 93 |           nelem = 1
 94 |           ndxs(nelem) = j ! ndxs stores the index of each term of the equation
 95 | 
 96 |           ! find indices of all the terms in the equation
 97 |           tmp_str = trim( sum_string(j+1:) )
 98 |           j = scan( tmp_str, '+' )
 99 |           do while(j>0)
100 |              nelem = nelem+1
101 |              ndxs(nelem) = ndxs(nelem-1) + j
102 |              tmp_str = tmp_str(j+1:)
103 |              j = scan( tmp_str, '+' )
104 |           enddo
105 |           ndxs(nelem+1) = len(sum_string)+1
106 | 
107 |           allocate( exp_item )
108 | 
109 |           exp_item%n_terms = nelem ! number of terms
110 | 
111 |           exp_item%name = trim(adjustl( sum_string(:ndxs(1)-1))) ! thing to the left of the "=" is used as the name of the group
112 | 
113 |           ! now that we have the number of terms in the summation allocate memory for the terms
114 |           allocate( exp_item%vars(nelem) )
115 |           allocate( exp_item%coeffs(nelem) )
116 | 
117 |           coeff0 = 1._r8 ! default multiplier
118 | 
119 |           ! now parse out the multiplier from the terms
120 |           elmloop: do k = 1,nelem
121 | 
122 |              exp_item%coeffs(k) = coeff0
123 | 
124 |              ! get the term name which follows the '*' operator if the is one
125 |              tmp_name = adjustl(sum_string(ndxs(k)+1:ndxs(k+1)-1))
126 | 
127 |              j = scan( tmp_name, '*' )
128 |              if (j>0) then
129 | 
130 |                 xchr = tmp_name(1:j-1) ! get the multipler (left of the '*')
131 |                 read( xchr, * ) xdbl   ! convert the string to a real
132 |                 exp_item%coeffs(k) = xdbl ! store the multiplier
133 | 
134 |                 j1 = scan( tmp_name, '(' )
135 |                 if (j1>0) then
136 |                    coeff0 = xdbl
137 |                    tmp_name = trim(adjustl(tmp_name(j1+1:))) ! get the term name (right of the '*')
138 |                 else
139 |                    coeff0 = 1._r8
140 |                    tmp_name = trim(adjustl(tmp_name(j+1:))) ! get the term name (right of the '*')
141 |                 endif
142 | 
143 |              endif
144 | 
145 |              j2 = scan( tmp_name, ')' )
146 |              if (j2>0) then
147 |                 coeff0 = 1._r8
148 |                 tmp_name = tmp_name(1:j2-1)
149 |              endif
150 | 
151 |              exp_item%vars(k) = trim(tmp_name)
152 | 
153 |           enddo elmloop
154 | 
155 |           if (associated(exp_item)) then
156 |              if (associated(exp_items_list)) then
157 |                 list_item => exp_items_list
158 |                 do while(associated(list_item%next_item))
159 |                    list_item => list_item%next_item
160 |                 enddo
161 |                 list_item%next_item => exp_item
162 |              else
163 |                 exp_items_list => exp_item
164 |              endif
165 |           endif
166 | 
167 | 
168 |        enddo grploop
169 |     endif has_grps
170 | 
171 |     if ( present(nitems) ) then
172 |        nitems = n_exp_items
173 |     endif
174 | 
175 |     deallocate(sums_grps)
176 | 
177 |   end function shr_exp_parse
178 | 
179 |   ! -----------------------------------------------------------------
180 |   ! deallocates memory occupied by linked list
181 |   ! -----------------------------------------------------------------
182 |   subroutine  shr_exp_list_destroy( list )
183 |     type(shr_exp_item_t), pointer, intent(inout) :: list
184 | 
185 |     type(shr_exp_item_t), pointer :: item, next
186 | 
187 |     item => list
188 |     do while(associated(item))
189 |        next => item%next_item
190 |        if (associated(item%vars)) then
191 |           deallocate(item%vars)
192 |           nullify(item%vars)
193 |           deallocate(item%coeffs)
194 |           nullify(item%coeffs)
195 |        endif
196 |        deallocate(item)
197 |        nullify(item)
198 |        item => next
199 |     enddo
200 | 
201 |   end subroutine  shr_exp_list_destroy
202 | 
203 | end module shr_expr_parser_mod
204 | 


--------------------------------------------------------------------------------
/.github/workflows/srt.yml:
--------------------------------------------------------------------------------
  1 | # CIME scripts regression tests
  2 | 
  3 | name: scripts regression tests
  4 | 
  5 | # Controls when the action will run. Triggers the workflow on push or pull request
  6 | # events but only for the main branch
  7 | on:
  8 |   push:
  9 |     branches: [ main ]
 10 |   pull_request:
 11 |     branches: [ main ]
 12 | 
 13 | # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 14 | jobs:
 15 |   # This workflow contains a single job called "build"
 16 |   build:
 17 |     # The type of runner that the job will run on
 18 |     runs-on: ubuntu-latest
 19 |     strategy:
 20 |       fail-fast: false
 21 |       matrix:
 22 |         python-version: [ 3.8, 3.11, 3.x ]
 23 |     env:
 24 |       CC: mpicc
 25 |       FC: mpifort
 26 |       CXX: mpicxx
 27 |       CPPFLAGS: "-I/usr/include -I/usr/local/include "
 28 |       LDFLAGS: "-L/usr/lib/x86_64-linux-gnu -lnetcdf -lnetcdff -lpnetcdf"     
 29 |       # Versions of all dependencies can be updated here
 30 |       ESMF_VERSION: v8.8.0
 31 |       PARALLELIO_VERSION: pio2_6_6
 32 |       CIME_MODEL: cesm
 33 |       CIME_DRIVER: nuopc
 34 |       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 35 |     # Steps represent a sequence of tasks that will be executed as part of the job
 36 |     steps:
 37 |       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
 38 | 
 39 |       - name: Setup Ubuntu Environment
 40 |         id: load-env
 41 |         run: |
 42 |           set -x
 43 |           sudo apt-get update 
 44 |           sudo apt-get install libxml2-utils
 45 |           sudo apt-get install netcdf-bin 
 46 |           sudo apt-get install libnetcdf-dev
 47 |           sudo apt-get install libnetcdff-dev
 48 |           sudo apt-get install pnetcdf-bin
 49 |           sudo apt-get install libpnetcdf-dev
 50 |           sudo apt-get install doxygen
 51 |           sudo apt-get install graphviz
 52 |           sudo apt-get install wget
 53 |           sudo apt-get install gfortran
 54 |           sudo apt-get install libjpeg-dev
 55 |           sudo apt-get install libz-dev
 56 |           sudo apt-get install openmpi-bin
 57 |           sudo apt-get install libopenmpi-dev
 58 | 
 59 |       - name: Set up Python ${{ matrix.python-version }}
 60 |         uses: actions/setup-python@v4
 61 |         with:
 62 |           python-version: ${{ matrix.python-version }}
 63 |       - run: echo "PyYAML" > requirements.txt
 64 |       - name: Install PyYAML
 65 |         run: pip install -r requirements.txt
 66 |       # use the latest cesm main
 67 |       - name: cesm checkout
 68 |         uses: actions/checkout@v4
 69 |         with:
 70 |           repository: ESCOMP/CESM
 71 |           path: cesm
 72 |       # this cmeps commit
 73 |       - name: cmeps checkout
 74 |         uses: actions/checkout@v4
 75 |         with:
 76 |           path: cesm/components/cmeps
 77 |           
 78 |       # Checkout cesm datamodels and support
 79 |       # cpl7 is needed - i think that's a bug
 80 |       - name: checkout externals
 81 |         run: |
 82 |           git config --global user.name "${GITHUB_ACTOR}"
 83 |           git config --global user.email "${GITHUB_ACTOR_ID}+${GITHUB_ACTOR}@users.noreply.github.com"
 84 |           pushd cesm
 85 |           ./bin/git-fleximod update cime ccs_config cdeps share mct parallelio
 86 |           cd ccs_config
 87 |           git checkout main 
 88 |           cd ../cime
 89 |           git checkout master
 90 |           git status
 91 |           if [[ ! -e "${PWD}/.gitmodules.bak" ]]
 92 |              then
 93 |               echo "Converting git@github.com to https://github.com urls in ${PWD}/.gitmodules"
 94 | 
 95 |               sed -i".bak" "s/git@github.com:/https:\/\/github.com\//g" "${PWD}/.gitmodules"
 96 |           fi
 97 |           git submodule update --init
 98 |           cd ../components/cdeps
 99 |           git checkout main
100 |           git submodule update --init
101 |           cd ../../share
102 |           git checkout main
103 |           
104 |       - name: Cache ESMF
105 |         id: cache-esmf
106 |         uses: actions/cache@v4
107 |         with:
108 |           path: ~/ESMF
109 |           key: ${{ runner.os }}-${{ env.ESMF_VERSION }}
110 | 
111 |       - name: Cache ParallelIO
112 |         id: cache-ParallelIO
113 |         uses: actions/cache@v4
114 |         with:
115 |           path: ${GITHUB_WORKSPACE}/pio
116 |           key: ${{ runner.os }}-${{ env.PARALLELIO_VERSION }}.parallelio
117 | 
118 |       - name: Cache inputdata
119 |         id: cache-inputdata
120 |         uses: actions/cache@v4
121 |         with:
122 |           path: $HOME/cesm/inputdata
123 |           key: inputdata
124 | 
125 |       - name: Build ParallelIO
126 |         if: steps.cache-PARALLELIO.outputs.cache-hit != 'true'
127 |         uses: NCAR/ParallelIO/.github/actions/parallelio_cmake@b38e34eeb9b75ce81ac94daf7c5245931de00b9d
128 |         with:
129 |           parallelio_version: ${{ env.ParallelIO_VERSION }}
130 |           enable_fortran: True
131 |           install_prefix: ${GITHUB_WORKSPACE}/pio
132 |           
133 |       - name: Install ESMF
134 |         uses: esmf-org/install-esmf-action@v1
135 |         env:
136 |           ESMF_COMPILER: gfortran
137 |           ESMF_BOPT: g
138 |           ESMF_COMM: openmpi
139 |           ESMF_NETCDF: nc-config
140 |           ESMF_PNETCDF: pnetcdf-config
141 |           ESMF_INSTALL_PREFIX: ${GITHUB_WORKSPACE}/ESMF
142 |           ESMF_PIO: external
143 |           ESMF_PIO_INCLUDE: ${GITHUB_WORKSPACE}/pio/include
144 |           ESMF_PIO_LIBPATH: ${GITHUB_WORKSPACE}/pio/lib
145 |         with:
146 |           version: ${{ env.ESMF_VERSION }}
147 |           esmpy: false
148 |           cache: true
149 | 
150 | 
151 |       - name: PREP for scripts regression test
152 |         run: |
153 |           mkdir -p $HOME/cesm/scratch
154 |           mkdir -p $HOME/cesm/inputdata
155 |           pushd $GITHUB_WORKSPACE/cesm/cime/CIME/tests
156 |           export SRCROOT=$GITHUB_WORKSPACE/cesm/
157 |           export CIME_TEST_PLATFORM=ubuntu-latest
158 |           export PIO_INCDIR=$GITHUB_WORKSPACE/pio/include
159 |           export PIO_LIBDIR=$GITHUB_WORKSPACE/pio/lib
160 |           export PIO_VERSION_MAJOR=2
161 |           export PIO_TYPENAME_VALID_VALUES="netcdf,pnetcdf"
162 |           export NETCDF_PATH=/usr
163 |           export PNETCDF_PATH=/usr
164 |           export LD_LIBRARY_PATH=/usr/lib/libx86_64-linux-gnu/:$LD_LIBRARY_PATH
165 |           cat <<EOF >> $GITHUB_WORKSPACE/cesm/ccs_config/machines/cmake_macros/ubuntu-latest.cmake
166 |           set(NetCDF_Fortran_INCLUDE_DIR /usr/include)
167 |           set(NetCDF_Fortran_LIBRARY /usr/lib/x86_64-gnu-Linux/libnetcdff.so)
168 |           EOF
169 |           printenv >> $GITHUB_ENV
170 |           popd
171 |       - name: scripts regression tests
172 |         run: |
173 |           pushd $GITHUB_WORKSPACE/cesm/cime/CIME/tests
174 |           ./scripts_regression_tests.py  --no-fortran-run --compiler gnu --mpilib openmpi --machine ubuntu-latest --no-teardown
175 |           popd
176 | 
177 |       # How to download artifacts:
178 |       # https://docs.github.com/en/actions/managing-workflow-runs/downloading-workflow-artifacts
179 | 
180 | #      - name: Upload test logs
181 | #        if: ${{ failure() }}
182 | #        steps:
183 | #        - name: Tar test logs
184 | #          run: tar zcf scratch-${{ matrix.python-version }}.tar.gz /home/runner/cesm/scratch
185 | #        - name: save artifact
186 | #          uses: actions/upload-artifact@v4
187 | #          with:
188 | #            name: test-logs-${{ matrix.python-version }}
189 | #            path: scratch-${{ matrix.python-version }}.tar.gz
190 | #            retention-days: 4
191 | #     the following can be used by developers to login to the github server in case of errors
192 | #     see https://github.com/marketplace/actions/debugging-with-tmate for further details
193 |       - name: Setup tmate session
194 |         if: ${{ failure() }}
195 |         uses: mxschmitt/action-tmate@v3
196 | 


--------------------------------------------------------------------------------