Bring external land component support to UFS

.gitmodules

@@ -42,3 +42,7 @@
   path = AQM
   url = https://github.com/NOAA-EMC/AQM
   branch = develop
+[submodule "NOAHMP"]
+  path = NOAHMP-interface/noahmp
+  url = https://github.com/NOAA-EMC/noahmp
+  branch = develop

CMakeLists.txt

@@ -16,7 +16,7 @@ list(APPEND CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/CMakeModules/Modules)
 ###############################################################################
 
 # Valid applications and choices
-list(APPEND VALID_APPS ATM ATMAERO ATMAQ ATMW S2S S2SA S2SW S2SWA HAFS HAFSW HAFS-ALL NG-GODAS)
+list(APPEND VALID_APPS ATM ATMAERO ATMAQ ATMW ATML LND S2S S2SA S2SW S2SWA S2SWAL HAFS HAFSW HAFS-ALL NG-GODAS)
 set(APP NONE CACHE BOOL "Application Name")
 if(NOT (APP IN_LIST VALID_APPS))
   message(FATAL_ERROR "${APP} is not a valid application.\nValid Applications are: ${VALID_APPS}")
@@ -33,6 +33,7 @@ set(WW3             OFF CACHE BOOL "Enable WW3")
 set(STOCH_PHYS      OFF CACHE BOOL "Enable Stochastic Physics")
 set(CMEPS           OFF CACHE BOOL "Enable CMEPS")
 set(CDEPS           OFF CACHE BOOL "Enable CDEPS")
+set(NOAHMP          OFF CACHE BOOL "Enable NOAHMP")
 
 # Configure selected application specific components
 message("")
@@ -50,6 +51,7 @@ message("WW3 .............. ${WW3}")
 message("STOCH_PHYS ....... ${STOCH_PHYS}")
 message("CDEPS ............ ${CDEPS}")
 message("CMEPS ............ ${CMEPS}")
+message("NOAHMP ........... ${NOAHMP}")
 
 ###############################################################################
 ### Build Options
@@ -211,6 +213,13 @@ if(CDEPS)
   add_subdirectory(CDEPS-interface)
 endif()
 
+###############################################################################
+### Land Components [NOAHMP]
+###############################################################################
+if(NOAHMP)
+  add_subdirectory(NOAHMP-interface)
+endif()
+
 ###############################################################################
 ### UFS Library
 ###############################################################################
@@ -283,6 +292,12 @@ if(CDEPS)
   target_link_libraries(ufs PUBLIC cdeps::cdeps)
 endif()
 
+if(NOAHMP)
+  add_dependencies(ufs noahmp)
+  list(APPEND _ufs_defs_private FRONT_NOAHMP=lnd_comp_nuopc)
+  list(APPEND _ufs_libs_public noahmp)
+endif()
+
 target_compile_definitions(ufs PRIVATE "${_ufs_defs_private}")
 target_link_libraries(ufs PUBLIC "${_ufs_libs_public}")
 

NOAHMP-interface/CMakeLists.txt

@@ -0,0 +1,83 @@
+#------------------------------------------------------------------------------
+# Add source files
+# NUOPC cap
+list(APPEND _noahmp_cap_files noahmp/drivers/nuopc/lnd_comp_kind.F90
+                              noahmp/drivers/nuopc/lnd_comp_types.F90
+                              noahmp/drivers/nuopc/lnd_comp_shr.F90
+                              noahmp/drivers/nuopc/lnd_comp_io.F90
+                              noahmp/drivers/nuopc/lnd_comp_domain.F90
+                              noahmp/drivers/nuopc/lnd_comp_import_export.F90
+                              noahmp/drivers/nuopc/lnd_comp_nuopc.F90
+                              noahmp/drivers/nuopc/lnd_comp_driver.F90)
+
+# CCPP interface 
+list(APPEND _noahmp_ccpp_files noahmp/drivers/ccpp/noahmpdrv.F90
+                               noahmp/drivers/ccpp/sfc_diff.f
+                               noahmp/drivers/ccpp/machine.F
+                               noahmp/drivers/ccpp/noahmp_tables.f90
+                               noahmp/drivers/ccpp/namelist_soilveg.f
+                               noahmp/drivers/ccpp/set_soilveg.f
+                               noahmp/drivers/ccpp/funcphys.f90
+                               noahmp/drivers/ccpp/physcons.F90)
+
+# NoahMP
+list(APPEND _noahmp_files noahmp/src/module_sf_noahmplsm.f90
+                          noahmp/src/module_sf_noahmp_glacier.f90)
+
+#------------------------------------------------------------------------------
+# Set CCPP flags for C/C++/Fortran preprocessor 
+add_definitions(-DCCPP)
+
+#------------------------------------------------------------------------------
+# Set MPI flags for C/C++/Fortran preprocessor
+if(MPI)
+  add_definitions(-DMPI)
+endif()
+
+#------------------------------------------------------------------------------
+# Set flag for 32bit dynamics build
+if(32BIT)
+  message(STATUS "Compile CCPP slow physics with 64-bit precision, fast physics with 32-bit precision")
+  add_definitions(-DOVERLOAD_R4)
+  if(CMAKE_Fortran_COMPILER_ID MATCHES "Intel")
+    set(CMAKE_Fortran_FLAGS_PHYSICS  "-real-size 64 -no-prec-div -no-prec-sqrt")
+  elseif(CMAKE_Fortran_COMPILER_ID MATCHES "GNU")
+    set(CMAKE_Fortran_FLAGS_PHYSICS  "-fdefault-real-8 -fdefault-double-8")
+  endif()
+  set(CMAKE_Fortran_FLAGS_DYNAMICS "")
+else()
+  message(STATUS "Compile CCPP physics with 64-bit precision")
+  remove_definitions(-DOVERLOAD_R8)
+  remove_definitions(-DOVERLOAD_R4)
+  set(CMAKE_Fortran_FLAGS_PHYSICS  "")
+  set(CMAKE_Fortran_FLAGS_DYNAMICS "")
+endif()
+
+#------------------------------------------------------------------------------
+# Add model-specific flags for C/C++/Fortran preprocessor
+add_definitions(-DMOIST_CAPPA -DUSE_COND -DNEMS_GSM)
+add_definitions(-DINTERNAL_FILE_NML)
+
+#------------------------------------------------------------------------------
+# NOAHMP
+add_library(noahmp STATIC ${_noahmp_cap_files} ${_noahmp_ccpp_files} ${_noahmp_files})
+set_target_properties(noahmp PROPERTIES Fortran_MODULE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/mod)
+target_include_directories(noahmp PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/mod>
+                                       $<INSTALL_INTERFACE:mod>)
+target_link_libraries(noahmp PUBLIC esmf fms)
+
+###############################################################################
+### Install
+###############################################################################
+
+install(
+  TARGETS noahmp
+  EXPORT  noahmp-config
+  LIBRARY DESTINATION lib
+  ARCHIVE DESTINATION lib
+  COMPONENT Library)
+
+install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/mod DESTINATION ${CMAKE_INSTALL_PREFIX}/NOAHMP)
+
+install(EXPORT      noahmp-config
+        DESTINATION lib/cmake)

cmake/configure_apps.cmake

@@ -13,7 +13,7 @@
 ###############################################################################
 ### Configure Application Components
 ###############################################################################
-if(APP MATCHES "^(ATM|ATMW|ATMAQ)$")
+if(APP MATCHES "^(ATM|ATMW|ATMAQ|ATML)$")
   set(FMS        ON  CACHE BOOL "Enable FMS"                 FORCE)
   set(FV3        ON  CACHE BOOL "Enable FV3"                 FORCE)
   set(STOCH_PHYS ON  CACHE BOOL "Enable Stochastic Physics"  FORCE)
@@ -23,6 +23,10 @@ if(APP MATCHES "^(ATM|ATMW|ATMAQ)$")
   elseif(APP MATCHES "ATMAQ")
     set(AQM      ON  CACHE BOOL "Enable AQM"                 FORCE)
     message("Configuring UFS app in Atmosphere with Air Quality mode")
+  elseif(APP MATCHES "ATML")
+    set(CMEPS    ON  CACHE BOOL "Enable CMEPS"               FORCE)
+    set(NOAHMP   ON  CACHE BOOL "Enable NOAHMP"              FORCE)
+    message("Configuring UFS app in Atmosphere with Air Quality mode")
   else()
     message("Configuring UFS app in Atmosphere Only mode")
   endif()
@@ -38,25 +42,24 @@ if(APP MATCHES "^(NG-GODAS)$")
   message("Configuring UFS app in (CDEPS) Data Atmosphere mode")
 endif()
 
-if(APP MATCHES "^(S2S|S2SA|S2SW|S2SWA)$")
+if(APP MATCHES "^(S2S|S2SA|S2SW|S2SWA|S2SWAL)$")
   set(APP_MSG "Configuring UFS app in S2S")
   set(CMEPS      ON  CACHE BOOL "Enable CMEPS"               FORCE)
   set(FMS        ON  CACHE BOOL "Enable FMS"                 FORCE)
   set(FV3        ON  CACHE BOOL "Enable FV3"                 FORCE)
   set(MOM6       ON  CACHE BOOL "Enable MOM6"                FORCE)
   set(CICE6      ON  CACHE BOOL "Enable CICE6"               FORCE)
   set(STOCH_PHYS ON  CACHE BOOL "Enable Stochastic Physics"  FORCE)
-  if(APP MATCHES "^S2SW")
+  if(APP MATCHES "^(S2SW|S2SWA|S2SWAL)")
     set(WW3      ON  CACHE BOOL "Enable WAVEWATCH III"       FORCE)
     string(CONCAT APP_MSG ${APP_MSG} " with Waves")
   endif()
-  if(APP MATCHES "A$")
+  if(APP MATCHES "^(S2SA|S2SWA)")
     set(UFS_GOCART ON  CACHE BOOL "Enable GOCART"            FORCE)
-    if(WW3)
-      string(CONCAT APP_MSG ${APP_MSG} " and Aerosols")
-    else()
-      string(CONCAT APP_MSG ${APP_MSG} " with Aerosols")
-    endif()
+    string(CONCAT APP_MSG ${APP_MSG} " with Aerosols")
+  endif()
+  if(APP MATCHES "^S2SWAL")
+    set(NOAHMP     ON  CACHE BOOL "Enable NOAHMP"            FORCE)
   endif()
   message("${APP_MSG} mode")
 endif()
@@ -84,3 +87,10 @@ if(APP MATCHES "^(ATMAERO)$")
   set(UFS_GOCART ON  CACHE BOOL "Enable GOCART"              FORCE)
   message("Configuring UFS app in Atmosphere with Aerosols mode")
 endif()
+
+if(APP MATCHES "^(LND)$")
+  set(CMEPS      ON  CACHE BOOL "Enable CMEPS"               FORCE)
+  set(CDEPS      ON  CACHE BOOL "Enable CDEPS"               FORCE)
+  set(NOAHMP     ON  CACHE BOOL "Enable NOAHMP"              FORCE)
+  set(FMS        ON  CACHE BOOL "Enable FMS"                 FORCE)
+endif()

driver/UFSDriver.F90

@@ -74,6 +74,9 @@ MODULE UFSDriver
 #ifdef FRONT_NOAH
       use FRONT_NOAH,       only: NOAH_SS  => SetServices
 #endif
+#ifdef FRONT_NOAHMP
+      use FRONT_NOAHMP,     only: NOAHMP_SS  => SetServices
+#endif
 #ifdef FRONT_LIS
       use FRONT_LIS,        only: LIS_SS   => SetServices
 #endif
@@ -447,6 +450,14 @@ subroutine SetModelServices(driver, rc)
             found_comp = .true.
           end if
 #endif
+#ifdef FRONT_NOAHMP
+          if (trim(model) == "noahmp") then
+            call NUOPC_DriverAddComp(driver, trim(prefix), NOAHMP_SS, &
+              petList=petList, comp=comp, rc=rc)
+            if (ChkErr(rc,__LINE__,u_FILE_u)) return
+            found_comp = .true.
+          end if
+#endif
 #ifdef FRONT_LIS
           if (trim(model) == "lis") then
             !TODO: Remove bail code and pass info and SetVM to DriverAddComp