Test ESMF

Test ESMF with applications

Compared with the unit test cases, an ESMF application can better test ESMF. Here we are presenting two example ESMF cases. In addition to these examples, we also have two ESMF test cases in the coupler folder $SKRIPS_DIR/coupler/L1.C2.esmf_coupled_test and $SKRIPS_DIR/coupler/L1.C3.esmf_interpl_test.

Warning

The ESMF group starts to move their project to GitHub. Because of this, some links listed below may not work properly. Their GitHub page should have all documentation and technical support: https://github.com/esmf-org/esmf.

Case 1: ESMF coupled flow demonstration case

The demonstration cases can be found at:

https://www.earthsystemcog.org/projects/esmf/external_demos

The tutorial of the demonstration case can be found at:

Compile the demonstration case

The demonstration case in our git repository is slightly different from the original one. We have fixed the bug in the test case, modified the parameters in the simulations, and added a simple post-processing MATLAB code.

Open the demonstration case (current working directory: $HOME/scripps_kaust_model/esmf):

cd ../esmf_test_application/esmf_test_coupled_flow
# compile the case::
make

Run the demonstration case

To run the demonstration case in parallel:

mpirun -np 4 ESMF_CoupledFlow

The demonstration case generates a series of output files:

PET0.ESMF_LogFile - ESMF log file containing all error messages logged.
DE.nc             - NetCDF file containing decomposition element ids.
FLAG.nc           - NetCDF file containing flag of boundary conditions.
OMEGA.nc          - NetCDF file containing time series of vorticity.
SIE.nc            - NetCDF file containing time series of internal energy.
U_velocity.nc     - NetCDF file containing time series of U velocity component.
V_velocity.nc     - NetCDF file containing time series of V velocity component.

All output data files are removed by the “make dust”.
“make clean” removes all object, module and the executable file.
“make distclean” combines the “dust” and “clean” targets.

Note

Compared to the original version, the following lines in CouplerMod.F90 file are commented out:

          ! check isneeded flag here
          !! if (.not. isFieldNeeded(importState, datanames(i), rc=rc)) then
          !!     !print *, "skipping field ", trim(datanames(i)), " not needed"
          !!     cycle
          !! endif

Case 2: NUOPC prototype code

There are several NUOPC prototype code examples:

https://sourceforge.net/p/esmfcontrib/svn/HEAD/tree/NUOPC/ https://github.com/esmf-org/nuopc-app-prototypes

This is an example of ATM–CON–OCN model based on NUOPC:

https://sourceforge.net/p/esmfcontrib/svn/HEAD/tree/NUOPC/tags/ESMF_8_0_0/AtmOcnConProto/ https://github.com/esmf-org/nuopc-app-prototypes/tree/develop/AtmOcnProto

We have also added this example case to our repository. To compile and run this example:

cd $SKRIPS_DIR/esmf_test/esmf_test_atm_ocn/
make
mpirun -np 6 esmApp