Add ISSM ice sheet model GridComp to Landice

GEOSagcm_GridComp/GEOSphysics_GridComp/GEOSsurface_GridComp/GEOSlandice_GridComp/CMakeLists.txt

@@ -1,6 +1,35 @@
 esma_set_this ()
 
+# First set alldirs to empty
+set(alldirs)
+# ... and srcs to the LandIceGridComp
+set (srcs GEOS_LandIceGridComp.F90)
+
+# Then try to find ISSM
+find_package (ISSM QUIET COMPONENTS Core)
+
+if(ISSM_FOUND)
+  # If ISSM is found, append the directory to alldirs
+  message(STATUS "ISSM found, building gridded component")
+  list (APPEND alldirs GEOSissm_GridComp)
+else()
+  # If ISSM is not found, append the stub component to srcs
+  message(STATUS "ISSM not found, using stub component")
+  # For esma_create_stub_component, we need the name of the *module*
+  # that the landice gc is expecting, minus the mod. Also we
+  # have to use the variable srcs but not the ${srcs} because
+  # esma_create_stub_component is expecting the list itself, not the
+  # contents of the list.
+  esma_create_stub_component(srcs GEOS_IssmGridComp)
+endif()
+
+# We have to do the above way because what esma_create_stub_component
+# does is to append the stub component it creates in the build tree to a
+# list of sources srcs.  So if ISSM is found, we go into the subdir and
+# build the real component, and if ISSM is not found, we create the stub
+# component and append it to srcs.
+
 esma_add_library (${this}
-  SRCS GEOS_LandIceGridComp.F90
-  DEPENDENCIES MAPL GEOS_Shared GEOS_SurfaceShared ESMF::ESMF NetCDF::NetCDF_Fortran
-  )
+  SRCS ${srcs}
+  SUBCOMPONENTS ${alldirs}
+  DEPENDENCIES MAPL GEOS_Shared GEOS_SurfaceShared ESMF::ESMF NetCDF::NetCDF_Fortran)

GEOSagcm_GridComp/GEOSphysics_GridComp/GEOSsurface_GridComp/GEOSlandice_GridComp/GEOS_LandIceGridComp.F90

@@ -43,6 +43,7 @@ module GEOS_LandiceGridCompMod
   use MAPL
   use GEOS_UtilsMod
   use DragCoefficientsMod
+  use GEOS_IssmGridCompMod,   only : IssmSetServices  => SetServices
 
   implicit none
   private
@@ -100,6 +101,8 @@ module GEOS_LandiceGridCompMod
 
   public SetServices
 
+  integer ::     ISSM
+
 ! !DESCRIPTION:
 ! 
 !   {\tt GEOS\_Landice} is a light-weight gridded component that updates
@@ -149,6 +152,7 @@ subroutine SetServices ( GC, RC )
 
     type(MAPL_MetaComp), pointer            :: MAPL
 
+    integer                                 :: DO_ISSM ! ISSM flag
 
 ! Begin...
 
@@ -159,20 +163,29 @@ subroutine SetServices ( GC, RC )
     VERIFY_(STATUS)
     Iam = trim(COMP_NAME) // 'SetServices'
 
+    ! Get my internal MAPL_Generic state
+!-----------------------------------
+
+    call MAPL_GetObjectFromGC ( GC, MAPL, RC=STATUS)
+    VERIFY_(STATUS)
+
 ! Set the Run entry point
 ! -----------------------
+   !add initialize method for child (ISSM)
+   call MAPL_GetResource (MAPL, DO_ISSM, label='DO_ISSM:', DEFAULT=0, __RC__ )
 
-    call MAPL_GridCompSetEntryPoint ( GC, ESMF_METHOD_RUN,  Run1, RC=STATUS )
-    VERIFY_(STATUS)
-    call MAPL_GridCompSetEntryPoint ( GC, ESMF_METHOD_RUN,  Run2, RC=STATUS )
-    VERIFY_(STATUS)
+
+   call MAPL_GridCompSetEntryPoint ( GC, ESMF_METHOD_INITIALIZE, Initialize, RC=STATUS ) 
+   VERIFY_(STATUS)
 
-! Get my internal MAPL_Generic state
-!-----------------------------------
 
-    call MAPL_GetObjectFromGC ( GC, MAPL, RC=STATUS)
-    VERIFY_(STATUS)
+   call MAPL_GridCompSetEntryPoint ( GC, ESMF_METHOD_RUN,  Run1, RC=STATUS )
+   VERIFY_(STATUS)
+   call MAPL_GridCompSetEntryPoint ( GC, ESMF_METHOD_RUN,  Run2, RC=STATUS )
+   VERIFY_(STATUS)
 
+ ! Get resource parameters
+ ! -----------------------
     call MAPL_GetResource (MAPL, SURFRC, label = 'SURFRC:', default = 'GEOS_SurfaceGridComp.rc', RC=STATUS) ; VERIFY_(STATUS)
     SCF = ESMF_ConfigCreate(rc=status) ; VERIFY_(STATUS)
     call ESMF_ConfigLoadFile(SCF,SURFRC,rc=status) ; VERIFY_(STATUS)
@@ -188,6 +201,15 @@ subroutine SetServices ( GC, RC )
 
 !  !Export state:
 
+     call MAPL_AddExportSpec(GC,                   &
+        SHORT_NAME = 'ICESMB',                     &
+        LONG_NAME  = 'ice_surface_mass_balance',   &
+        UNITS      = 'kg m-2 s-1',                 &
+        DIMS       = MAPL_DimsTileOnly,            &
+        VLOCATION  = MAPL_VLocationNone,           &
+        RC=STATUS  )
+     VERIFY_(STATUS)
+
      call MAPL_AddExportSpec(GC,                             &
         SHORT_NAME         = 'EMIS',                              &
         LONG_NAME          = 'surface_emissivity',                &
@@ -1618,6 +1640,16 @@ subroutine SetServices ( GC, RC )
     VERIFY_(STATUS)
 
 !EOS
+
+    if (DO_ISSM==1) then
+      ! Add ISSM child gridcomp    
+      ISSM  = MAPL_AddChild(GC, NAME='ISSM', SS=IssmSetServices, RC=STATUS)
+      VERIFY_(STATUS)   
+
+      ! ISSM imports will be satisfied by landice
+      call MAPL_TerminateImport(GC, CHILD = ISSM,   RC=STATUS)
+      VERIFY_(STATUS)
+    end if 
 
 ! Set the Profiling timers
 ! ------------------------
@@ -1641,6 +1673,88 @@ end subroutine SetServices
 
 !BOP
 
+
+  subroutine Initialize ( GC, IMPORT, EXPORT, CLOCK, RC )
+  ! this is for ISSM to have access to to the tile locstream 
+
+   ! !ARGUMENTS:
+
+       type(ESMF_GridComp), intent(inout) :: GC     ! Gridded component 
+       type(ESMF_State),    intent(inout) :: IMPORT ! Import state
+       type(ESMF_State),    intent(inout) :: EXPORT ! Export state
+       type(ESMF_Clock),    intent(inout) :: CLOCK  ! The clock
+       integer, optional,   intent(  out) :: RC     ! Error code
+
+   ! !DESCRIPTION: The Initialize method of the Landice Gridded Component.
+
+   !EOP
+
+   ! ErrLog Variables
+
+       character(len=ESMF_MAXSTR)           :: IAm 
+       integer                              :: STATUS
+       character(len=ESMF_MAXSTR)           :: COMP_NAME
+
+   ! Local derived type aliases
+
+       type (MAPL_MetaComp    ), pointer       :: MAPL
+       type (MAPL_MetaComp    ), pointer       :: CHILD_MAPL 
+       type (MAPL_LocStream       )            :: LOCSTREAM
+       type (ESMF_Config          )            :: CF
+       type (ESMF_GridComp        ), pointer   :: GCS(:)
+
+       integer                                 :: I
+
+   !=============================================================================
+
+   ! Begin... 
+
+   ! Get the target components name and set-up traceback handle.
+   ! -----------------------------------------------------------
+
+       call ESMF_GridCompGet ( GC, name=COMP_NAME, RC=STATUS )
+       VERIFY_(STATUS)
+       Iam = trim(COMP_NAME) // "Initialize"
+
+   ! Get my internal MAPL_Generic state
+   !-----------------------------------
+
+       call MAPL_GetObjectFromGC ( GC, MAPL, RC=STATUS)
+       VERIFY_(STATUS)
+
+       call MAPL_TimerOn(MAPL,"INITIALIZE", RC=STATUS ); VERIFY_(STATUS)
+       call MAPL_TimerOn(MAPL,"TOTAL", RC=STATUS ); VERIFY_(STATUS)
+
+   ! Get the landice tilegrid and the child components
+   !----------------------------------------------- 
+
+       call MAPL_Get (MAPL, LOCSTREAM=LOCSTREAM, GCS=GCS, RC=STATUS )
+       VERIFY_(STATUS)
+
+   ! Place the land tilegrid in the generic state of each child component
+   !---------------------------------------------------------------------
+
+       do I = 1, SIZE(GCS)
+          call MAPL_GetObjectFromGC( GCS(I), CHILD_MAPL, RC=STATUS )
+          VERIFY_(STATUS)
+          call MAPL_Set (CHILD_MAPL, LOCSTREAM=LOCSTREAM, RC=STATUS )
+          VERIFY_(STATUS)
+       end do
+
+       call MAPL_TimerOff(MAPL,"TOTAL", RC=STATUS ); VERIFY_(STATUS)
+
+   ! Call Initialize for every Child
+   !--------------------------------
+
+       call MAPL_GenericInitialize ( GC, IMPORT, EXPORT, CLOCK,  RC=STATUS)
+       VERIFY_(STATUS)
+
+       call MAPL_TimerOff(MAPL,"INITIALIZE", RC=STATUS ); VERIFY_(STATUS)
+
+       RETURN_(ESMF_SUCCESS)
+     end subroutine Initialize
+
+
 ! !IROUTINE: RUN1 -- First Run stage for the LandIce component
 
 !INTERFACE:
@@ -2135,6 +2249,8 @@ subroutine RUN2 ( GC, IMPORT, EXPORT, CLOCK, RC )
 
 !EOP
 
+   type (ESMF_State),     pointer  :: GIM(:)    ! Import state ISSM
+
 
 ! ErrLog Variables
 
@@ -2155,6 +2271,7 @@ subroutine RUN2 ( GC, IMPORT, EXPORT, CLOCK, RC )
   type(MAPL_SunOrbit)                 :: ORBIT
 
   integer                             :: LANDICE_OFFLINE
+  integer         :: DO_ISSM              ! ISSM flag
 !=============================================================================
 
 ! Begin... 
@@ -2172,6 +2289,13 @@ subroutine RUN2 ( GC, IMPORT, EXPORT, CLOCK, RC )
     call MAPL_GetObjectFromGC ( GC, MAPL, RC=STATUS)
     VERIFY_(STATUS)
 
+    call MAPL_GetResource (MAPL, DO_ISSM, label='DO_ISSM:', DEFAULT=0, __RC__ )
+
+    ! Get import state of child (ISSM)
+    if (DO_ISSM == 1) then
+      call MAPL_Get(MAPL, GIM=GIM, RC=STATUS )
+      VERIFY_(STATUS) 
+    end if 
 ! Start Total timer
 !------------------
 
@@ -2227,8 +2351,13 @@ subroutine LANDICECORE(RC)
    character(len=ESMF_MAXSTR)     :: IAm
    integer                        :: STATUS
 
-! pointers to export
 
+   ! pointer to child import (ISSM)
+   real, pointer, dimension(:  )  :: ICESMB_ISSM
+
+
+! pointers to export
+   real, pointer, dimension(:  )  :: ICESMB
    real, pointer, dimension(:  )  :: EMISS
    real, pointer, dimension(:  )  :: ALBVF 
    real, pointer, dimension(:  )  :: ALBVR 
@@ -2460,7 +2589,6 @@ subroutine LANDICECORE(RC)
    real, parameter :: LANDICEDEPTH_ = 0.07 ! water equiv depth of top layer
    real, parameter :: LANDICECOND_  = 1.2  ! ice conductivity divided by depth of bottom layer
    real, parameter :: LANDICETDEEP_ = 230. ! deep ice temperature
-
 !  Begin...
 !----------
 
@@ -2542,7 +2670,7 @@ subroutine LANDICECORE(RC)
 
 ! Pointers to outputs
 !--------------------
-
+   call MAPL_GetPointer(EXPORT,ICESMB  , 'ICESMB'   ,alloc=.true., RC=STATUS); VERIFY_(STATUS)
    call MAPL_GetPointer(EXPORT,EMISS  , 'EMIS'   , RC=STATUS); VERIFY_(STATUS)
    call MAPL_GetPointer(EXPORT,ALBVF  , 'ALBVF'  , RC=STATUS); VERIFY_(STATUS)
    call MAPL_GetPointer(EXPORT,ALBVR  , 'ALBVR'  , RC=STATUS); VERIFY_(STATUS)
@@ -3241,8 +3369,20 @@ subroutine LANDICECORE(RC)
     if(associated(ASNOW))    ASNOW    = FR(:,SNOW)
     if(associated(SMELT ))   SMELT    = PERC
     if(associated(RAINRFZ )) RAINRFZ  = FR(:,ICE)  * RAINRF
+
     if(associated(MELTWTR )) MELTWTR  = MELTWTR + MLT  
 
+
+    ! Calculate surface mass balance (SMB) for ISSM
+    if(associated(ICESMB)) ICESMB    = ACCUM - RUNOFF
+
+    ! Set child (ISSM) SMB import pointer to landice export values
+    if (DO_ISSM == 1) then
+      call MAPL_GetPointer(GIM(ISSM), ICESMB_ISSM, 'ICESMB'  , RC=STATUS)
+    end if 
+
+    if(associated(ICESMB_ISSM)) ICESMB_ISSM(:) = ICESMB(:)
+
 ! Update snow and landice albedos to anticipate
 !   next radiation calculation
 !-----------------------------------------------
@@ -3376,6 +3516,12 @@ subroutine LANDICECORE(RC)
        WEBOT =  WESNBOT / DT
     end if
 
+    ! Run ISSM (checks if ISSM_ALARM is ringing)
+    if (DO_ISSM==1) then
+      call MAPL_GenericRunChildren(GC, IMPORT, EXPORT, CLOCK, RC=STATUS)
+      VERIFY_(STATUS)
+    end if 
+
     if(allocated (MLT)) deallocate(MLT , STAT=STATUS); VERIFY_(STATUS)              
     if(allocated (DTS)) deallocate(DTS , STAT=STATUS); VERIFY_(STATUS)              
     if(allocated (DQS)) deallocate(DQS , STAT=STATUS); VERIFY_(STATUS)              

GEOSagcm_GridComp/GEOSphysics_GridComp/GEOSsurface_GridComp/GEOSlandice_GridComp/GEOSissm_GridComp/CMakeLists.txt

@@ -0,0 +1,9 @@
+find_package (ISSM REQUIRED COMPONENTS Core)
+
+esma_set_this ()
+
+esma_add_library (${this}
+  SRCS GEOS_ISSMGridComp.F90
+  DEPENDENCIES MAPL GEOS_Shared GEOS_SurfaceShared ESMF::ESMF NetCDF::NetCDF_Fortran ISSM::Core
+  )
+