Auto PR - develop → MAPL-v3 - Merge branch 'develop' into feature/zhaobin74/improve-runoff-distribution

.circleci/config.yml

@@ -1,11 +1,11 @@
 version: 2.1
 
 # Anchors in case we need to override the defaults from the orb
-#baselibs_version: &baselibs_version v7.17.0
-#bcs_version: &bcs_version v11.4.0
+#baselibs_version: &baselibs_version v7.27.0
+#bcs_version: &bcs_version v11.6.0
 
 orbs:
-  ci: geos-esm/circleci-tools@2
+  ci: geos-esm/circleci-tools@4
 
 workflows:
   build-test:
@@ -45,7 +45,7 @@ workflows:
             - docker-hub-creds
           matrix:
             parameters:
-              compiler: [gfortran, ifort]
+              compiler: [ifort]
           requires:
             - build-GEOSgcm-on-<< matrix.compiler >>
           repo: GEOSgcm

.github/workflows/push-to-develop.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v3.3.0
+        uses: actions/checkout@v5
         with:
           fetch-depth: 0
       - name: Run the action

.github/workflows/workflow.yml

@@ -0,0 +1,36 @@
+name: Build Tests
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+    # Do not run if the only files changed cannot affect the build
+    paths-ignore:
+      - "**.md"
+      - "**.pro"
+      - "**.sh"
+      - "**.perl"
+      - ".github/CODEOWNERS"
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+
+jobs:
+  build_gcm:
+    strategy:
+      matrix:
+        compiler: [ifort, gfortran-14, gfortran-15]
+        build-type: [Debug]
+    uses: GEOS-ESM/CI-workflows/.github/workflows/geosgcm_build_tests.yml@project/geosgcm
+    with:
+      compiler: ${{ matrix.compiler }}
+      cmake-build-type: ${{ matrix.build-type }}
+      fixture-repo: GEOS-ESM/GEOSgcm
+
+  spack_build:
+    uses: GEOS-ESM/CI-workflows/.github/workflows/spack_gcc_build.yml@project/geosgcm
+    secrets:
+      BUILDCACHE_USERNAME: ${{ secrets.BUILDCACHE_USERNAME }}
+      BUILDCACHE_TOKEN: ${{ secrets.BUILDCACHE_TOKEN }}
+    with:
+      fixture-repo: GEOS-ESM/GEOSgcm

CMakeLists.txt

@@ -8,6 +8,11 @@ set (alldirs
   GEOSwgcm_GridComp
   )
 
+option(BUILD_WITH_GIGATRAJ "Build GEOSgcm with Gigatraj" OFF)
+
+if (BUILD_WITH_GIGATRAJ)
+  list(APPEND alldirs GEOSgigatraj_GridComp)
+endif()
 
 if (EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/GEOS_GcmGridComp.F90)
 
@@ -17,6 +22,8 @@ if (EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/GEOS_GcmGridComp.F90)
     SUBCOMPONENTS ${alldirs}
     DEPENDENCIES MAPL ESMF::ESMF)
 
+  target_compile_definitions (${this} PRIVATE $<$<BOOL:${BUILD_WITH_GIGATRAJ}>:HAS_GIGATRAJ>)
+
   ecbuild_install_project( NAME GEOSgcm_GridComp)
 
 else ()

GEOS_GcmGridComp.F90

@@ -20,6 +20,10 @@ module GEOS_GcmGridCompMod
    use GEOS_AgcmGridCompMod,     only:  AGCM_SetServices => SetServices
    use GEOS_mkiauGridCompMod,    only:  AIAU_SetServices => SetServices
    use DFI_GridCompMod,          only:  ADFI_SetServices => SetServices
+#ifdef HAS_GIGATRAJ
+   use GEOS_GigatrajGridCompMod, only:  GigaTraj_SetServices => SetServices
+#endif
+
    use GEOS_OgcmGridCompMod,     only:  OGCM_SetServices => SetServices
    use GEOS_WgcmGridCompMod,     only:  WGCM_SetServices => SetServices
    use MAPL_HistoryGridCompMod,  only:  Hist_SetServices => SetServices
@@ -58,6 +62,7 @@ module GEOS_GcmGridCompMod
 integer ::       ADFI
 integer ::       WGCM
 integer ::       hist
+integer ::       gigatraj
 
 integer :: bypass_ogcm
 integer ::       k
@@ -251,6 +256,10 @@ subroutine SetServices ( GC, RC )
     else
        AGCM = MAPL_AddChild(GC, NAME='AGCM', SS=Agcm_SetServices, RC=STATUS)
        VERIFY_(STATUS)
+#ifdef HAS_GIGATRAJ
+       gigatraj = MAPL_AddChild(GC, NAME='GIGATRAJ', SS=GigaTraj_SetServices, RC=STATUS)
+       VERIFY_(STATUS)
+#endif
        AIAU = MAPL_AddChild(GC, NAME='AIAU', SS=AIAU_SetServices, RC=STATUS)
        VERIFY_(STATUS)
        ADFI = MAPL_AddChild(GC, NAME='ADFI', SS=ADFI_SetServices, RC=STATUS)
@@ -955,6 +964,10 @@ subroutine Initialize ( GC, IMPORT, EXPORT, CLOCK, RC )
 ! Recursive setup of grids (should be disabled)
     call ESMF_GridCompSet(GCS(AGCM),  grid=agrid, rc=status)
     VERIFY_(STATUS)
+#ifdef HAS_GIGATRAJ
+    call ESMF_GridCompSet(GCS(gigatraj),  grid=agrid, rc=status)
+    VERIFY_(STATUS)
+#endif
     call ESMF_GridCompSet(GCS(OGCM),  grid=ogrid, rc=status)
     VERIFY_(STATUS)
     if(.not. DO_DATA_ATM4OCN) then
@@ -1308,15 +1321,17 @@ subroutine Initialize ( GC, IMPORT, EXPORT, CLOCK, RC )
          result=GCM_INTERNAL_STATE%SURF_IMP, rc=status)
     VERIFY_(STATUS)
 
-    !select TURBULENCE export
-    call MAPL_ExportStateGet(GEX, name='TURBULENCE', &
-         result=GCM_INTERNAL_STATE%TURB_EXP, rc=status)
-    VERIFY_(STATUS)
+    if(.not. DO_DATA_ATM4OCN) then
+      !select TURBULENCE export
+      call MAPL_ExportStateGet(GEX, name='TURBULENCE', &
+           result=GCM_INTERNAL_STATE%TURB_EXP, rc=status)
+      VERIFY_(STATUS)
 
-    !select SURFACE import 
-    call MAPL_ImportStateGet(GC, import=import, name='TURBULENCE', &
-         result=GCM_INTERNAL_STATE%TURB_IMP, rc=status)
-    VERIFY_(STATUS)
+      !select TURBULENCE import 
+      call MAPL_ImportStateGet(GC, import=import, name='TURBULENCE', &
+           result=GCM_INTERNAL_STATE%TURB_IMP, rc=status)
+      VERIFY_(STATUS)
+    endif
 
     !select OCEAN export
     call MAPL_ExportStateGet(GEX, name='OCEAN', &
@@ -2017,10 +2032,23 @@ subroutine Run ( GC, IMPORT, EXPORT, CLOCK, RC )
     else
       call MAPL_TimerOn(MAPL,"AGCM"        )
     endif
+
+#ifdef HAS_GIGATRAJ
+    ! use agcm export as gigatraj's import to get the initial state.
+    ! it only runs at the begining of the first time step
+    call ESMF_GridCompRun ( GCS(gigatraj), importState=GEX(AGCM), exportState=GEX(gigatraj), clock=clock, phase=1, userRC=status )
+    VERIFY_(STATUS)
+#endif
 
     call ESMF_GridCompRun ( GCS(AGCM), importState=GIM(AGCM), exportState=GEX(AGCM), clock=clock, userRC=status )
     VERIFY_(STATUS)
 
+#ifdef HAS_GIGATRAJ
+    ! use agcm export as gigatraj's import
+    call ESMF_GridCompRun ( GCS(gigatraj), importState=GEX(AGCM), exportState=GEX(gigatraj), clock=clock, phase=2, userRC=status )
+    VERIFY_(STATUS)
+#endif
+
     if(DO_DATA_ATM4OCN) then
       call MAPL_TimerOff(MAPL,"DATAATM"     )
     else

GEOSagcm_GridComp/CMakeLists.txt

@@ -20,6 +20,8 @@ elseif (EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/GEOS_AgcmGridComp.F90)
     SUBCOMPONENTS ${alldirs}
     DEPENDENCIES MAPL GEOS_Shared Chem_Shared ESMF::ESMF)
 
+  target_compile_definitions (${this} PRIVATE $<$<BOOL:${BUILD_WITH_GIGATRAJ}>:HAS_GIGATRAJ>)
+
 else ()
 
   esma_add_subdirectories (${alldirs})

GEOSagcm_GridComp/GEOS_AgcmGridComp.F90

@@ -790,6 +790,34 @@ subroutine SetServices ( GC, RC )
          RC = STATUS)
     VERIFY_(STATUS)
 
+#ifdef HAS_GIGATRAJ
+    call MAPL_AddExportSpec(GC, &
+         SHORT_NAME = 'PL', &
+         CHILD_ID = SDYN, &
+         RC = STATUS)
+    VERIFY_(STATUS)
+    call MAPL_AddExportSpec(GC, &
+         SHORT_NAME = 'OMEGA', &
+         CHILD_ID = SDYN, &
+         RC = STATUS)
+    VERIFY_(STATUS)
+    call MAPL_AddExportSpec(GC, &
+         SHORT_NAME = 'TH', &
+         CHILD_ID = SDYN, &
+         RC = STATUS)
+    VERIFY_(STATUS)
+    call MAPL_AddExportSpec(GC,  &
+         SHORT_NAME = 'DTDTDYN', &
+         CHILD_ID = SDYN, &
+         RC = STATUS)
+    VERIFY_(STATUS)
+    call MAPL_AddExportSpec(GC,  &
+         SHORT_NAME = 'ZL', &
+         CHILD_ID = SDYN, &
+         RC = STATUS)
+    VERIFY_(STATUS)
+#endif
+
     call MAPL_AddExportSpec( GC, &
          SHORT_NAME = 'PS', &
          CHILD_ID = SDYN, &
@@ -1158,7 +1186,7 @@ subroutine Initialize ( GC, IMPORT, EXPORT, CLOCK, RC )
    type (ESMF_Alarm)                   :: ALARM
    type (ESMF_Alarm)                   :: ALARM4D
    type (ESMF_Config)                  :: cf
-   integer                             :: I, NQ
+   integer                             :: I, NQ, IM, JM, LM
    real                                :: POFFSET, DT
    real, pointer, dimension(:,:)       :: PHIS,SGH,VARFLT,PTR
    real, pointer, dimension(:,:,:)     :: TEND!
@@ -1195,6 +1223,11 @@ subroutine Initialize ( GC, IMPORT, EXPORT, CLOCK, RC )
 
     call MAPL_TimerOn(STATE,"INITIALIZE")
 
+! Spin the MAPL python bridge with the atmospheric grid dimensions
+!--------------------------
+    call MAPL_Get ( STATE, IM=IM, JM=JM, LM=LM, RC=STATUS )
+    call initialize_python_bridge( IM, JM, LM )
+
 ! Call Initialize for every Child
 
     call MAPL_GenericInitialize ( GC, IMPORT, EXPORT, CLOCK,  RC=STATUS)

GEOSagcm_GridComp/GEOSphysics_GridComp/GEOS_PhysicsGridComp.F90

@@ -120,6 +120,10 @@ subroutine SetServices ( GC, RC )
     character(len=ESMF_MAXSTR)              :: SURFRC
     type(ESMF_Config)                       :: SCF
 
+    ! <<>> MSL DEV
+    character(len=ESMF_MAXSTR)              :: co2provider
+    real                                    :: co2_
+
 !=============================================================================
 
 ! Begin...
@@ -1114,6 +1118,27 @@ subroutine SetServices ( GC, RC )
                             'CFC11 ','CFC12 ','HCFC22'       /), &
                            DST_ID=RAD, SRC_ID=CHEM, RC=STATUS    )
       VERIFY_(STATUS)
+
+! <<>> MSL DEV
+! CO2 is not listed as a RAT, so add it here outside of the RATs code logic
+! It also doesn't appear in PCHEM, so we can't make it part of the RATs list
+  ! -- get info from AGCM.rc
+  call ESMF_ConfigGetAttribute(CF, co2provider, Default='None', &
+                               Label="CO2_PROVIDER:", __RC__ )
+  call ESMF_ConfigGetAttribute(CF, co2_, Default=-1.0, &
+                               Label="CO2:", __RC__ )
+  if (trim(co2provider) .eq. 'GOCART' .and. CO2_ .eq. -2.0) then
+     CALL MAPL_AddConnectivity( GC, &
+          SHORT_NAME  = (/'CO2'/), &
+          DST_ID=RAD, SRC_ID=CHEM, RC=STATUS    )
+     VERIFY_(STATUS)
+  endif
+  if (trim(co2provider) .eq. 'RRG' .and. CO2_ .eq. -2.0) then
+     CALL MAPL_AddConnectivity( GC, &
+          SHORT_NAME  = (/'CO2'/), &
+          DST_ID=RAD, SRC_ID=CHEM, RC=STATUS    )
+     VERIFY_(STATUS)
+  endif
 ! -----------------------------------------------------------------
 
      call MAPL_AddConnectivity ( GC,                               &
@@ -1215,8 +1240,8 @@ subroutine SetServices ( GC, RC )
      call MAPL_AddConnectivity ( GC,                                      &
         SHORT_NAME  = (/ 'RL      ',  'QL      ', 'QLTOT   ', 'DQLDT   ', &
                          'RI      ',  'QI      ', 'QITOT   ', 'DQIDT   ', &
-                         'QLCN    ',  'PFL_CN  ', 'PFL_LSAN',             &
-                         'QICN    ',  'PFI_CN  ', 'PFI_LSAN',             &
+                         'QLCN    ',  'PFL_CN  ', 'PFL_LSAN', 'ZLCL    ', &
+                         'QICN    ',  'PFI_CN  ', 'PFI_LSAN', 'ZLFC    ', &
                          'FCLD    ',  'QCTOT   ', 'CNV_QC  ',             &
                          'REV_LS  ',  'REV_AN  ', 'REV_CN  ', 'TPREC   ', &
                          'Q       ',  'DQDT    ', 'DQRL    ', 'DQRC    ', &

GEOSagcm_GridComp/GEOSphysics_GridComp/GEOSgwd_GridComp/CMakeLists.txt

@@ -19,16 +19,23 @@ set (srcs
   )
 
 set (resource_files
-   GWD_GridComp.rc
-   )
-
-
+  GWD_GridComp.rc
+  )
 
 install( FILES ${resource_files}
-   DESTINATION etc
-   )
+  DESTINATION etc
+  )
 
-esma_add_library (${this} SRCS ${srcs} DEPENDENCIES GEOS_Shared MAPL ESMF::ESMF NetCDF::NetCDF_Fortran)
+esma_add_library (
+  ${this}
+  SRCS ${srcs}
+  DEPENDENCIES GEOS_Shared MAPL ESMF::ESMF NetCDF::NetCDF_Fortran TYPE SHARED
+  )
+
+mapl_acg (
+  ${this} GWD_StateSpecs.rc
+  IMPORT_SPECS EXPORT_SPECS INTERNAL_SPECS GET_POINTERS DECLARE_POINTERS
+  )
 
 # CMake has an OpenMP issue with NAG Fortran: https://gitlab.kitware.com/cmake/cmake/-/issues/21280
 if (NOT CMAKE_Fortran_COMPILER_ID MATCHES "NAG")