Add MGBF-based localization (#700)

CMakeLists.txt

@@ -29,6 +29,7 @@ endif()
 option(OPENMP "Enable OpenMP Threading" OFF)
 option(ENABLE_MKL "Use MKL for LAPACK implementation (if available)" ON)
 option(BUILD_GSDCLOUD "Build GSD Cloud Analysis Library" OFF)
+option(BUILD_MGBF "Build MGBF Library" ON)
 option(BUILD_GSI "Build GSI" ON)
 option(BUILD_ENKF "Build EnKF" ON)
 option(BUILD_REG_TESTING "Build the Regression Testing Suite" OFF)
@@ -37,6 +38,7 @@ option(BUILD_REG_TESTING "Build the Regression Testing Suite" OFF)
 message(STATUS "OPENMP ................. ${OPENMP}")
 message(STATUS "ENABLE_MKL ............. ${ENABLE_MKL}")
 message(STATUS "BUILD_GSDCLOUD ......... ${BUILD_GSDCLOUD}")
+message(STATUS "BUILD_MGBF ............. ${BUILD_MGBF}")
 message(STATUS "BUILD_GSI .............. ${BUILD_GSI}")
 message(STATUS "BUILD_ENKF ............. ${BUILD_ENKF}")
 message(STATUS "BUILD_REG_TESTING ...... ${BUILD_REG_TESTING}")

INSTALL.md

@@ -79,6 +79,7 @@ CMake allows for various options that can be specified on the command line via `
 | `OPENMP`              | Enable OpenMP Threading (`OFF`)                      |
 | `ENABLE_MKL`          | Use MKL (`ON`), If not found use LAPACK              |
 | `BUILD_GSDCLOUD`      | Build GSD Cloud Library (`OFF`)                      |
+| `BUILD_MGBF`          | Build MGBF Library (`ON`)                            |
 | `BUILD_GSI`           | Build GSI library and executable (`ON`)              |
 | `BUILD_ENKF`          | Build EnKF library and executable (`ON`)             |
 | `BUILD_REG_TESTING`   | Enable Regression Testing (`ON`)                     |

src/CMakeLists.txt

@@ -3,6 +3,11 @@ if(BUILD_GSDCLOUD)
   add_subdirectory(GSD)
 endif()
 
+if(BUILD_MGBF)
+  message(STATUS "Building MGBF library")
+  add_subdirectory(mgbf)
+endif()
+
 if(BUILD_GSI)
   message(STATUS "Building GSI")
   add_subdirectory(gsi)

src/gsi/CMakeLists.txt

@@ -29,6 +29,7 @@ endif()
 option(OPENMP "Enable OpenMP Threading" OFF)
 option(ENABLE_MKL "Use MKL for LAPACK implementation (if available)" ON)
 option(USE_GSDCLOUD "Use GSD Cloud Analysis library" OFF)
+option(USE_MGBF "Use MGBF library" ON)
 
 set(GSI_VALID_MODES "GFS" "Regional")
 set(GSI_MODE "GFS" CACHE STRING "Choose the GSI Application.")
@@ -43,6 +44,7 @@ endif()
 message(STATUS "GSI: OPENMP ................. ${OPENMP}")
 message(STATUS "GSI: ENABLE_MKL ............. ${ENABLE_MKL}")
 message(STATUS "GSI: USE_GSDCLOUD ........... ${USE_GSDCLOUD}")
+message(STATUS "GSI: USE_MGBF ............... ${USE_MGBF}")
 message(STATUS "GSI: GSI_MODE ............... ${GSI_MODE}")
 
 # Dependencies
@@ -87,6 +89,13 @@ if(USE_GSDCLOUD)
   endif()
 endif()
 
+# MGBF library dependency
+if(USE_MGBF)
+  if(NOT TARGET mgbf)
+    find_package(mgbf REQUIRED)
+  endif()
+endif()
+
 # Get compiler flags for the GSI application
 include(gsiapp_compiler_flags)
 
@@ -158,6 +167,12 @@ if(USE_GSDCLOUD)
   endif()
   target_link_libraries(gsi_fortran_obj PUBLIC gsdcloud::gsdcloud)
 endif()
+if(USE_MGBF)
+  if(TARGET mgbf)
+    add_dependencies(gsi_fortran_obj mgbf)
+  endif()
+  target_link_libraries(gsi_fortran_obj PUBLIC mgbf::mgbf)
+endif()
 if(OpenMP_Fortran_FOUND)
   target_link_libraries(gsi_fortran_obj PRIVATE OpenMP::OpenMP_Fortran)
 endif()

src/gsi/gsimod.F90

@@ -161,7 +161,7 @@ module gsimod
                          ntotensgrp,nsclgrp,naensgrp,ngvarloc,ntlevs_ens,naensloc, &
                          r_ensloccov4tim,r_ensloccov4var,r_ensloccov4scl,l_timloc_opt,&
                          vdl_scale,vloc_varlist,&
-                         global_spectral_filter_sd,assign_vdl_nml,parallelization_over_ensmembers
+                         global_spectral_filter_sd,assign_vdl_nml,parallelization_over_ensmembers,l_mgbf_loc
   use hybrid_ensemble_parameters,only : l_both_fv3sar_gfs_ens,n_ens_gfs,n_ens_fv3sar,weight_ens_gfs,weight_ens_fv3sar
   use rapidrefresh_cldsurf_mod, only: init_rapidrefresh_cldsurf, &
                             dfi_radar_latent_heat_time_period,metar_impact_radius,&
@@ -529,6 +529,7 @@ module gsimod
 !                        - innov_use_model_fed=.true. :  Use FED from BG to calculate innovation.
 !                          this requires if_model_fed=.true. 
 !                          it works either an EnVar DA run or a GSI observer run.
+!  02-20-2024 yokota  - add MGBF-based localization
 !
 !EOP
 !-------------------------------------------------------------------------
@@ -1452,6 +1453,7 @@ module gsimod
 !                             ^     ^     ^    ^     ^ 
 !                 s_ens_h  = v1L1  v2L1  v3L1  v1L2 v2L2
 !                 Then localization lengths will be assigned as above.
+!     l_mgbf_loc - if true, multi-grid beta filter is used for localization instead of recursive filter
 !
   namelist/hybrid_ensemble/l_hyb_ens,uv_hyb_ens,q_hyb_ens,aniso_a_en,generate_ens,n_ens,&
                 l_both_fv3sar_gfs_ens,n_ens_gfs,n_ens_fv3sar,weight_ens_gfs,weight_ens_fv3sar,nlon_ens,nlat_ens,jcap_ens,&
@@ -1462,7 +1464,7 @@ module gsimod
                 i_en_perts_io,l_ens_in_diff_time,ensemble_path,ens_fast_read,sst_staticB,limqens, &
                 nsclgrp,l_timloc_opt,ngvarloc,naensloc,r_ensloccov4tim,r_ensloccov4var,r_ensloccov4scl,&
                 vdl_scale,vloc_varlist,&
-                global_spectral_filter_sd,assign_vdl_nml,parallelization_over_ensmembers
+                global_spectral_filter_sd,assign_vdl_nml,parallelization_over_ensmembers,l_mgbf_loc
 
 ! rapidrefresh_cldsurf (options for cloud analysis and surface 
 !                             enhancement for RR appilcation  ):
@@ -1985,6 +1987,18 @@ subroutine gsimain_initialize
   regional=wrf_nmm_regional.or.wrf_mass_regional.or.twodvar_regional.or.nems_nmmb_regional .or. cmaq_regional
   regional=regional.or.fv3_regional.or.fv3_cmaq_regional
 
+! Force turn off MGBF-based localization except for regional application
+  if(.not.regional.and.l_mgbf_loc) then
+     l_mgbf_loc=.false.
+     if(mype==0) write(6,*)'GSIMOD: for global app, l_mgbf_loc is not applicable, reset l_mgbf_loc=',l_mgbf_loc
+  end if
+
+! Force turn off MGBF-based localization for lsqrtb=.true.
+  if(lsqrtb.and.l_mgbf_loc) then
+     l_mgbf_loc=.false.
+     if(mype==0) write(6,*)'GSIMOD: for lsqrtb=.true., l_mgbf_loc is not applicable, reset l_mgbf_loc=',l_mgbf_loc
+  end if
+
 ! Currently only able to have use_gfs_stratosphere=.true. for nems_nmmb_regional=.true.
   use_gfs_stratosphere=use_gfs_stratosphere.and.(nems_nmmb_regional.or.wrf_nmm_regional)   
   if(mype==0) write(6,*) 'in gsimod: use_gfs_stratosphere,nems_nmmb_regional,wrf_nmm_regional= ', &