move GEOSroute_GridComp one level up

Author: weiyuan-jiang

CMakeLists.txt

@@ -11,7 +11,7 @@ esma_add_library(${this}
   SRCS GEOS_LdasGridComp.F90
   SUBCOMPONENTS ${alldirs}
   SUBDIRS LDAS_Shared
-  DEPENDENCIES GEOSland_GridComp GEOSlandice_GridComp makebcs MAPL
+  DEPENDENCIES GEOSland_GridComp GEOSlandice_GridComp GEOSroute_GridComp makebcs MAPL
   INCLUDES ${INC_ESMF})
 
 esma_add_subdirectory(GEOSldas_App)

GEOS_LdasGridComp.F90

@@ -15,6 +15,7 @@ module GEOS_LdasGridCompMod
   use GEOS_EnsGridCompMod,       only: EnsSetServices       => SetServices
   use GEOS_LandAssimGridCompMod, only: LandAssimSetServices => SetServices
   use GEOS_LandiceGridCompMod,   only: LandiceSetServices   => SetServices
+  use GEOS_RouteGridCompMod,     only: RouteSetServices    => SetServices
 
   use LDAS_TileCoordType,     only: tile_coord_type , T_TILECOORD_STATE, TILECOORD_WRAP
   use LDAS_TileCoordType,     only: grid_def_type, io_grid_def_type, operator (==)
@@ -51,6 +52,7 @@ module GEOS_LdasGridCompMod
   ! All children
   integer,allocatable :: LAND(:)
   integer,allocatable :: LANDICE(:)
+  integer,allocatable :: ROUTE(:)
   integer,allocatable :: LANDPERT(:)
   integer,allocatable :: METFORCE(:)
   integer             :: ENSAVG, LANDASSIM
@@ -62,6 +64,7 @@ module GEOS_LdasGridCompMod
   logical :: ensemble_forcing   ! switch between deterministic and ensemble forcing
   logical :: with_landice       ! true if landice tiles requested by config
   logical :: with_land          ! true if land    tiles requested by config
+  integer :: RUN_ROUTE          ! 1 if run river-routine grid comp
 
 contains
 
@@ -147,6 +150,8 @@ subroutine SetServices(gc, rc)
     VERIFY_(STATUS)
     call MAPL_GetResource ( MAPL, ens_id_width, Label="ENS_ID_WIDTH:",      DEFAULT=0,       RC=STATUS)
     VERIFY_(STATUS)
+    call MAPL_GetResource ( MAPL, RUN_ROUTE, Label="RUN_ROUTE:",      DEFAULT=0,       RC=STATUS)
+    VERIFY_(STATUS)
     call MAPL_GetResource ( MAPL, FIRST_ENS_ID, Label="FIRST_ENS_ID:", DEFAULT=0, RC=STATUS)
     VERIFY_(STATUS)
     call MAPL_GetResource ( MAPL, ENS_FORCING_STR, Label="ENSEMBLE_FORCING:", DEFAULT="NO", RC=STATUS)
@@ -205,7 +210,10 @@ subroutine SetServices(gc, rc)
 
     if (with_land)    allocate(LAND(   NUM_ENSEMBLE),LANDPERT(NUM_ENSEMBLE))
     if (with_landice) allocate(LANDICE(NUM_ENSEMBLE))
-
+    if (RUN_ROUTE == 1) then
+       _ASSERT( with_land, "RUNOFF must be from the export of land_gridcomp for now.")
+       allocate(ROUTE(NUM_ENSEMBLE))
+    endif
     ! ens_id_with = 2 + number of digits = total number of chars in ensid_string ("_eXXXX")
     !
     ! Assert ens_id_width<=2+9 so number of digits remains single-digit and "I1" can be
@@ -253,6 +261,12 @@ subroutine SetServices(gc, rc)
           LANDICE(i) = MAPL_AddChild(gc, name=childname, ss=LandiceSetServices, rc=status)
           VERIFY_(status)
        endif
+
+      if (RUN_ROUTE == 1) then
+          childname='ROUTE'//trim(ensid_string)
+          ROUTE(i) = MAPL_AddChild(gc, name=childname, ss=RouteSetServices, rc=status)
+          VERIFY_(status)
+      endif
     enddo
 
     if (with_land) then
@@ -302,6 +316,17 @@ subroutine SetServices(gc, rc)
                rc = status                                                                            &
                )
           VERIFY_(status)
+
+          IF(RUN_ROUTE == 1) THEN
+             call MAPL_AddConnectivity (                              &
+                  GC                                                 ,&
+                  SHORT_NAME  = (/'RUNOFF  '/)                       ,&   ! RUNOFF = total runoff = surface runoff + baseflow
+                  SRC_ID =  LAND(I)                                  ,&
+                  DST_ID =  ROUTE(I)                                 ,&
+                  RC=STATUS )
+             VERIFY_(STATUS)
+          ENDIF
+
        enddo
 
        if(land_assim .or. mwRTM) then
@@ -788,6 +813,13 @@ subroutine Initialize(gc, import, export, clock, rc)
           call MAPL_Set(CHILD_MAPL, LocStream=landice_locstream, rc=status)
           VERIFY_(status)
        endif
+
+       if (RUN_ROUTE == 1) then
+          call MAPL_GetObjectFromGC(gcs(ROUTE(i)), CHILD_MAPL, rc=status)
+          VERIFY_(status) ! CHILD = ens_avg
+          call MAPL_Set(CHILD_MAPL, LocStream=land_locstream, rc=status)
+          VERIFY_(status)
+       endif
 
     enddo
 
@@ -1016,6 +1048,14 @@ subroutine Run(gc, import, export, clock, rc)
           call MAPL_TimerOff(MAPL, gcnames(igc))
        endif ! with_land_ice
 
+       if ( RUN_ROUTE == 1 ) then
+          igc = ROUTE(i)
+          call MAPL_TimerOn(MAPL, gcnames(igc))
+          call ESMF_GridCompRun(gcs(igc), importState=gim(igc), exportState=gex(igc), clock=clock, phase=1, userRC=status)
+          VERIFY_(status)
+          call MAPL_TimerOff(MAPL, gcnames(igc))
+       endif ! river-routine
+
        if (with_land) then
           ! ApplyPrognPert - moved: now before calculating ensemble average that is picked up by land analysis and HISTORY; reichle 28 May 2020 
           igc = LANDPERT(i)