379 updated branch with all GW changes #580

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft

ccarouge wants to merge 26 commits into main from 379-updated-GW-branch

CMakeLists.txt

-Original file line number
+Diff line change
@@ Expand Up / @@ -120,6 +120,15 @@ if(CABLE_LIBRARY) @@
             src/util/cable_climate_type_mod.F90
             src/util/masks_cbl.F90
         )
+        target_compile_definitions(cable PRIVATE UM_CBL)
+        target_include_directories(cable PUBLIC "$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>")
+        install(TARGETS cable
+          EXPORT CABLEFortranTargets
+          LIBRARY DESTINATION lib
+          INCLUDES DESTINATION include)
+        install(DIRECTORY ${CMAKE_Fortran_MODULE_DIRECTORY}/ TYPE INCLUDE)
         if(CABLE_LIBRARY_TARGET STREQUAL "access-esm1.6")
             list(APPEND SOURCES
@@ Expand Down @@

build.bash

-Original file line number
+Diff line change
@@ Expand Up / @@ -64,7 +64,7 @@ while [ ${#} -gt 0 ]; do @@
                 cmake_args+=(-DCABLE_MPI="ON")
                 ;;
             -l|--library)
-                build_args+=(--target cable_science)
+                build_args+=(--target cable)
                 cmake_args+=(-DCABLE_LIBRARY="ON")
                 cmake_args+=(-DCABLE_LIBRARY_TARGET="${2}")
                 do_install=0 # Disable installation when only building the science library
@@ Expand Down @@

src/coupled/AM3/control/cable/CM3/cbl_canopy_type.F90

-Original file line number
+Diff line change
@@ Expand Up / @@ -63,7 +63,6 @@ MODULE cable_canopy_type_mod @@
       REAL, ALLOCATABLE, PUBLIC :: fwet(:)              ! fraction of canopy wet
       REAL, ALLOCATABLE, PUBLIC :: fns_cor(:)           ! correction to net rad avail to soil (W/m2)
       REAL, ALLOCATABLE, PUBLIC :: ga_cor(:)            ! correction to ground heat flux (W/m2)
-      REAL, ALLOCATABLE, PUBLIC :: evapfbl(:,:)         !
       REAL, ALLOCATABLE, PUBLIC :: gswx(:,:)            ! stom cond for water
       REAL, ALLOCATABLE, PUBLIC :: zetar(:,:)           ! stability parameter (ref height)
       REAL, ALLOCATABLE, PUBLIC :: zetash(:,:)          ! stability parameter (shear height)
@@ Expand Down Expand Up / @@ -144,7 +143,6 @@ MODULE cable_canopy_type_mod @@
       REAL, POINTER, PUBLIC :: fwet(:)              ! fraction of canopy wet
       REAL, POINTER, PUBLIC :: fns_cor(:)           ! correction to net rad avail to soil (W/m2)
       REAL, POINTER, PUBLIC :: ga_cor(:)            ! correction to ground heat flux (W/m2)
-      REAL, POINTER, PUBLIC :: evapfbl(:,:)         !
       REAL, POINTER, PUBLIC :: gswx(:,:)            ! stom cond for water
       REAL, POINTER, PUBLIC :: zetar(:,:)           ! stability parameter (ref height)
       REAL, POINTER, PUBLIC :: zetash(:,:)          ! stability parameter (shear height)
@@ Expand Down Expand Up / @@ -230,7 +228,6 @@ SUBROUTINE alloc_canopy_type(var, mp) @@
     ALLOCATE( var% fwet(mp) )
     ALLOCATE( var% fns_cor(mp) )    !REV_CORR variable
     ALLOCATE( var% ga_cor(mp) )     !REV_CORR variable
-    ALLOCATE( var % evapfbl(mp,nsl) )
     ALLOCATE( var% epot(mp) )
     ALLOCATE( var% fnpp(mp) )
     ALLOCATE( var% fevw_pot(mp) )
@@ Expand Down Expand Up / @@ -308,7 +305,6 @@ SUBROUTINE alloc_canopy_type(var, mp) @@
     var % fwet(:)        = 0.0
     var % fns_cor(:)     = 0.0
     var % ga_cor(:)      = 0.0
-    var % evapfbl(:,:)   = 0.0
     var % gswx(:,:)      = 0.0
     var % zetar(:,:)     = 0.0
     var % zetash(:,:)    = 0.0
@@ Expand Down Expand Up / @@ -382,7 +378,6 @@ SUBROUTINE dealloc_canopy_type(var) @@
        DEALLOCATE( var% fwet )
        DEALLOCATE( var% fns_cor )   !REV_CORR variable
        DEALLOCATE( var% ga_cor )    !REV_CORR variable
-       DEALLOCATE ( var % evapfbl )
        DEALLOCATE( var% epot )
        DEALLOCATE( var% fnpp )
        DEALLOCATE( var% fevw_pot )
@@ Expand Down Expand Up / @@ -473,7 +468,6 @@ SUBROUTINE assoc_canopy_type(canopy, canopy_data ) @@
     canopy% fwet        => canopy_data% fwet
     canopy% fns_cor     => canopy_data% fns_cor
     canopy% ga_cor      => canopy_data% ga_cor
-    canopy% evapfbl     => canopy_data% evapfbl
     canopy% gswx        => canopy_data% gswx
     canopy% zetar       => canopy_data% zetar
     canopy% zetash      => canopy_data% zetash
@@ Expand Down Expand Up / @@ -557,7 +551,6 @@ SUBROUTINE nullify_canopy_cbl( var ) @@
        NULLIFY( var% fwet )
        NULLIFY( var% fns_cor )   !REV_CORR variable
        NULLIFY( var% ga_cor )    !REV_CORR variable
-       NULLIFY( var % evapfbl )
        NULLIFY( var% epot )
        NULLIFY( var% fnpp )
        NULLIFY( var% fevw_pot )
@@ Expand Down @@

src/coupled/AM3/control/cable/CM3/ssnow_type.F90

-Original file line number
+Diff line change
@@ Expand Up / @@ -74,11 +74,11 @@ MODULE cable_soil_snow_type_mod @@
       REAL, ALLOCATABLE :: tggsn        (:,:) ! snow temperature in K
       REAL, ALLOCATABLE :: dtmlt        (:,:) ! water flux to the soil
       REAL, ALLOCATABLE :: albsoilsn    (:,:) ! soil + snow reflectance
-      REAL, ALLOCATABLE :: evapfbl      (:,:) !
       REAL, ALLOCATABLE :: tilefrac     (:,:) ! factor for latent heat
       REAL(r_2), ALLOCATABLE :: wbtot      (:) ! total soil water (mm)
+      REAL(r_2), ALLOCATABLE :: evapfbl     (:,:) !
       REAL(r_2), ALLOCATABLE :: gammzz      (:,:) ! heat capacity for each soil layer
       REAL(r_2), ALLOCATABLE :: wb          (:,:) ! volumetric soil moisture (solid+liq)
       REAL(r_2), ALLOCATABLE :: wbice       (:,:) ! soil ice
@@ Expand Down Expand Up / @@ -209,11 +209,11 @@ MODULE cable_soil_snow_type_mod @@
       REAL, POINTER :: tggsn        (:,:) ! snow temperature in K
       REAL, POINTER :: dtmlt        (:,:) ! water flux to the soil
       REAL, POINTER :: albsoilsn    (:,:) ! soil + snow reflectance
-      REAL, POINTER :: evapfbl      (:,:) !
       REAL, POINTER :: tilefrac     (:,:) ! factor for latent heat
       REAL(r_2), POINTER :: wbtot      (:) ! total soil water (mm)
+      REAL(r_2), POINTER :: evapfbl     (:,:) !
       REAL(r_2), POINTER :: gammzz      (:,:) ! heat capacity for each soil layer
       REAL(r_2), POINTER :: wb          (:,:) ! volumetric soil moisture (solid+liq)
       REAL(r_2), POINTER :: wbice       (:,:) ! soil ice
@@ Expand Down @@

src/coupled/shared/cable_canopy_type_mod.F90

-Original file line number
+Diff line change
@@ Expand Up / @@ -62,7 +62,6 @@ MODULE cable_canopy_type_mod @@
            ga_cor  ! correction to ground heat flux (W/m2)
       REAL, DIMENSION(:,:), POINTER ::                                            &
-           evapfbl,                                                               &
            gswx,    & ! stom cond for water
            zetar, &   ! stability parameter (ref height)
                                  ! vh_js !
@@ Expand Down Expand Up / @@ -158,7 +157,6 @@ SUBROUTINE alloc_canopy_type(var, mp) @@
     ALLOCATE( var% fwet(mp) )
     ALLOCATE( var% fns_cor(mp) )    !REV_CORR variable
     ALLOCATE( var% ga_cor(mp) )     !REV_CORR variable
-    ALLOCATE ( var % evapfbl(mp,ms) )
     ALLOCATE( var% epot(mp) )
     ALLOCATE( var% fnpp(mp) )
     ALLOCATE( var% fevw_pot(mp) )
@@ Expand Down @@

src/coupled/shared/cable_soilsnow_type_mod.F90

-Original file line number
+Diff line change
@@ Expand Up / @@ -72,14 +72,14 @@ MODULE cable_soil_snow_type_mod @@
            tggsn,      & ! snow temperature in K
            dtmlt,      & ! water flux to the soil
            albsoilsn,  & ! soil + snow reflectance
-           evapfbl,    & !
            tilefrac      ! factor for latent heat
       REAL(r_2), DIMENSION(:), POINTER ::                                         &
            wbtot   ! total soil water (mm)
       REAL(r_2), DIMENSION(:,:), POINTER ::                                       &
+           evapfbl,    & !
            gammzz,  & ! heat capacity for each soil layer
            wb,      & ! volumetric soil moisture (solid+liq)
            wbice,   & ! soil ice
@@ Expand Down @@

src/offline/cable_checks.F90

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -84,7 +84,8 @@ MODULE cable_checks_module
  
          ESoil = [-0.0015, 0.0015], &

          TVeg = [-0.0003, 0.0003], &

          ECanop = [-0.0003, 0.0003], &

          PotEvap = [-0.005, 0.005], &  !note should encompass Evap

          PotEvap = [-0.005, 0.005], &  !note should encompass Evap  ! I have PotEvap = [-0.0006, 0.0006] if it makes a difference - rk4417

          ACond = [0.0, 1.0], &

          SoilWet = [-0.4, 1.2], &

          Albedo = [0.0, 1.0], &

    @@ -133,12 +134,13 @@ MODULE cable_checks_module
  
          css = [700.0, 2200.0], &

          rhosoil = [300.0, 3000.0], &

          hyds = [5.0E-7, 8.5E-3], & ! vh_js ! sep14

    ! MMY 8.5E-3->8.5 since hyds uses m/s, but hyds_vec uses mm/s

          rs20 = [0.0, 10.0], &

          sand = [0.0, 1.0], &

          sfc = [0.1, 0.5], &

          silt = [0.0, 1.0], &

          ssat = [0.35, 0.5], &

          sucs = [-0.8, -0.03], &

          sucs = [-0.8, -0.03], &   ! MMY@23Apr2023 works for CABLE non-GW

          swilt = [0.05, 0.4], &

          froot = [0.0, 1.0], &

          zse = [0.0, 5.0], &

    @@ -498,7 +500,10 @@ SUBROUTINE mass_balance(dels,ktau, ssnow,soil,canopy,met,
  
        ! Local variables

        REAL(r_2), DIMENSION(:),POINTER, SAVE     :: owb         ! volumetric soil moisture 

                                                                 ! at previous time step

        REAL(r_2), DIMENSION(mp)                  :: delwb       ! change in soilmoisture

       ! To remove qrecharge or not from the mass balance

        REAL(r_2), DIMENSION(mp)                  :: qrecharge_opt

        ! b/w tsteps

        REAL, DIMENSION(mp)                       :: canopy_wbal !canopy water balance

        INTEGER                                   :: j, k        ! do loop counter

    @@ -521,9 +526,14 @@ SUBROUTINE mass_balance(dels,ktau, ssnow,soil,canopy,met,
  
        !      it's included in change in canopy storage calculation))

        ! rml 28/2/11 ! BP changed rnof1+rnof2 to ssnow%runoff which also included rnof5

        ! which is used when nglacier=2 in soilsnow routines (BP feb2011)

        qrecharge_opt = ssnow%qrecharge

        IF ( cable_user%GW_MODEL )  THEN

           qrecharge_opt = 0.0_r_2

        ENDIF

        bal%wbal = REAL(met%precip - canopy%delwc - ssnow%snowd+ssnow%osnowd        &

             - ssnow%runoff-(canopy%fevw+canopy%fevc                                &

             + canopy%fes/ssnow%cls)*dels/air%rlam - delwb - ssnow%qrecharge)

             + canopy%fes/ssnow%cls)*dels/air%rlam - delwb - qrecharge_opt)

        ! Canopy water balance: precip-change.can.storage-throughfall-evap+dew

        canopy_wbal = REAL(met%precip-canopy%delwc-canopy%through                   &

src/offline/cable_define_types.F90

-Original file line number
+Diff line change
@@ Expand Up / @@ -214,6 +214,9 @@ MODULE cable_def_types_mod @@
       TYPE soil_snow_type
          INTEGER, DIMENSION(:), POINTER :: isflag ! 0 => no snow 1 => snow
+              !* Flag (0/1) to indicate if snow is present
+              ! For isflag=1, if there is enough snow, it will use a 3 layer snowpack
+              ! If there isn't enough snow, it will use a single layer snowpack
          REAL, DIMENSION(:), POINTER ::                                           &
               iantrct, & ! pointer to Antarctic land points
@@ Expand Down Expand Up / @@ -278,14 +281,14 @@ MODULE cable_def_types_mod @@
               tggsn,      & ! snow temperature in K
               dtmlt,      & ! water flux to the soil
               albsoilsn,  & ! soil + snow reflectance
-              evapfbl,    & !
               tilefrac      ! factor for latent heat
          REAL(r_2), DIMENSION(:), POINTER ::                                      &
               wbtot   ! total soil water (mm)
          REAL(r_2), DIMENSION(:,:), POINTER ::                                    &
+              evapfbl,    & !
               gammzz,  & ! heat capacity for each soil layer
               wb,      & ! volumetric soil moisture (solid+liq)
               wbice,   & ! soil ice
@@ Expand Down Expand Up / @@ -493,7 +496,6 @@ MODULE cable_def_types_mod @@
               ga_cor  ! correction to ground heat flux (W/m2)
          REAL, DIMENSION(:,:), POINTER ::                                         &
-              evapfbl, &
               gswx,    & ! stom cond for water
               zetar, &   ! stability parameter (ref height)
                                     ! vh_js !
@@ Expand Down Expand Up / @@ -1149,7 +1151,6 @@ SUBROUTINE alloc_canopy_type(var, mp) @@
         ALLOCATE( var% fwet(mp) )
         ALLOCATE( var% fns_cor(mp) )    !REV_CORR variable
         ALLOCATE( var% ga_cor(mp) )     !REV_CORR variable
-        ALLOCATE ( var % evapfbl(mp,ms) )
         ALLOCATE( var% epot(mp) )
         ALLOCATE( var% fnpp(mp) )
         ALLOCATE( var% fevw_pot(mp) )
@@ Expand Down Expand Up / @@ -1783,7 +1784,6 @@ SUBROUTINE dealloc_canopy_type(var) @@
         DEALLOCATE( var% fwet )
         DEALLOCATE( var% fns_cor )   !REV_CORR variable
         DEALLOCATE( var% ga_cor )    !REV_CORR variable
-        DEALLOCATE ( var % evapfbl )
         DEALLOCATE( var% epot )
         DEALLOCATE( var% fnpp )
         DEALLOCATE( var% fevw_pot )
@@ Expand Down @@

src/offline/cable_initialise.F90

-Original file line number
+Diff line change
@@ Expand Up @@
         canopy%fhs     = 0.0   ! sensible heat flux from soil (W/m2)
         canopy%us = 0.1 ! friction velocity (needed in roughness before first call to canopy: should in be in restart?)
+    ! block below added by rk4417 - phase2
+    ! ccc - These need to be set elsewhere since this subroutine is deprecated
+    ! (it is never called) and should be removed.
+        canopy%sublayer_dz = 0.001
+        ssnow%rtevap_sat   = 0.0
+        ssnow%rtevap_unsat = 0.0
+        ssnow%satfrac    = 1.0e-12
+        ssnow%qhz        = 0.0
+        ssnow%wtd        = 1000.0
+        ssnow%wb_hys  = 0.99*soil%ssat_vec
+        ssnow%smp_hys = -0.99*soil%sucs_vec
+    !ccc To come back to it    ssnow%ssat_hys = gw_params%ssat_wet_factor*soil%ssat_vec
+        ssnow%watr_hys = soil%watr
+        ssnow%hys_fac = 1.0
       END SUBROUTINE get_default_inits
       !==============================================================================
@@ Expand Down Expand Up @@
         CALL readpar(ncid_rin,'runoff',dummy,ssnow%runoff,filename%restart_in,      &
              max_vegpatches,'def',from_restart,mp)
-        !MD
-        ok = NF90_INQ_VARID(ncid_rin,'GWwb',parID)
-        IF(ok == NF90_NOERR) THEN
-           CALL readpar(ncid_rin,'GWwb',dummy,ssnow%GWwb,filename%restart_in,            &
-                max_vegpatches,'def',from_restart,mp)
-        ELSE
-           ssnow%GWwb = 0.95*soil%ssat
+        IF (cable_user%gw_model) THEN   ! inserted by rk4417 - phase2
+          ok = NF90_INQ_VARID(ncid_rin,'GWwb',parID)
+          IF(ok == NF90_NOERR) THEN
+              CALL readpar(ncid_rin,'GWwb',dummy,ssnow%GWwb,filename%restart_in,   &
+                   max_vegpatches,'def',from_restart,mp)
+          ELSE
+              ssnow%GWwb = 0.95*soil%ssat
+          END IF
+    ! below part until END IF inserted by rk4417 - phase2
+          ok = NF90_INQ_VARID(ncid_rin,'wb_hys',parID)
+          IF(ok == NF90_NOERR) THEN
+              CALL readpar(ncid_rin,'wb_hys',dummy,ssnow%wb_hys,filename%restart_in,&
+                   max_vegpatches,'msd',from_restart,mp)
+          ELSE
+             ssnow%wb_hys = 0.99*soil%ssat_vec
+          END IF
+          ok = NF90_INQ_VARID(ncid_rin,'smp_hys',parID)
+          IF(ok == NF90_NOERR) THEN
+              CALL readpar(ncid_rin,'smp_hys',dummy,ssnow%smp_hys,filename%restart_in,&
+                   max_vegpatches,'msd',from_restart,mp)
+          ELSE
+             ssnow%smp_hys = -1.0*abs(soil%sucs_vec)*0.99
+          END IF
+          ok = NF90_INQ_VARID(ncid_rin,'ssat_hys',parID)
+          IF(ok == NF90_NOERR) THEN
+              CALL readpar(ncid_rin,'ssat_hys',dummy,ssnow%ssat_hys,filename%restart_in,&
+                   max_vegpatches,'msd',from_restart,mp)
+          ELSE
+              ssnow%ssat_hys = soil%ssat_vec
+          END IF
+          ok = NF90_INQ_VARID(ncid_rin,'watr_hys',parID)
+          IF(ok == NF90_NOERR) THEN
+              CALL readpar(ncid_rin,'watr_hys',dummy,ssnow%watr_hys,filename%restart_in,&
+                   max_vegpatches,'msd',from_restart,mp)
+          ELSE
+              ssnow%watr_hys = soil%watr
+          END IF
+          ok = NF90_INQ_VARID(ncid_rin,'hys_fac',parID)
+          IF(ok == NF90_NOERR) THEN
+              CALL readpar(ncid_rin,'hys_fac',dummy,ssnow%hys_fac,filename%restart_in,&
+                   max_vegpatches,'msd',from_restart,mp)
+          ELSE
+              ssnow%hys_fac = 1.0
+          END IF
         END IF
+        IF (cable_user%or_evap) THEN
+          ok = NF90_INQ_VARID(ncid_rin,'sublayer_dz',parID)
+          IF(ok == NF90_NOERR) THEN
+             CALL readpar(ncid_rin,'sublayer_dz',dummy,canopy%sublayer_dz,filename%restart_in,&
+                  max_vegpatches,'def',from_restart,mp)
+          ELSE
+             canopy%sublayer_dz(:) = 0.01
+          END IF
+          IF (ANY(canopy%sublayer_dz < 0.0) .OR. ANY(canopy%sublayer_dz > 0.5)) THEN
+             WRITE(*,*) 'problem with sublayer_dz and restart.  check restart values!'
+          END IF
+        END IF
     !$   IF(cable_user%SOIL_STRUC=='sli'.or.cable_user%FWSOIL_SWITCH=='Haverd2013') THEN
     !$      CALL readpar(ncid_rin,'gamma',dummy,veg%gamma,filename%restart_in,           &
     !$           max_vegpatches,'def',from_restart,mp)
@@ Expand Down @@

src/offline/cable_input.F90

-Original file line number
+Diff line change
@@ Expand Up @@
              sum_flux,veg,mp)
         WRITE(logn,*) ' CABLE variables allocated with ', mp, ' patch(es).'
+    ! call below inserted by rk4417 - phase2
+        !CALL for gw_model false and true sets constants when false
+        CALL GWspatialParameters(logn,soil,ssnow)    ! MMY gw_model = True read var from gridinfo
+        ! MMY gw_model = False use default values
         IF (icycle > 0 .OR. CABLE_USER%CASA_DUMP_WRITE ) &
              CALL alloc_casavariable(casabiome,casapool,casaflux, &
              casamet,casabal,mp)
@@ Expand Down @@

src/offline/cable_iovars.F90

-Original file line number
+Diff line change
@@ Expand Up / @@ -160,7 +160,9 @@ MODULE cable_IO_vars_module @@
               veg_class,soil_class,mvtype,mstype,patchfrac,                        &
               WatSat,GWWatSat,SoilMatPotSat,GWSoilMatPotSat,                       &
               HkSat,GWHkSat,FrcSand,FrcClay,Clappb,Watr,GWWatr,sfc_vec,forg,swilt_vec, &
-              slope,slope_std,GWdz,SatFracmax,Qhmax,QhmaxEfold,HKefold,HKdepth
+              slope,slope_std,GWdz,SatFracmax,Qhmax,QhmaxEfold,HKefold,HKdepth,   &
+              sand_vec,clay_vec,bch_vec,org_vec,elev,elev_std  ! inserted by rk4417 - phase2
          INTEGER :: ishorizon,nhorizons,clitt, &
               zeta,fsatmax, &
               gamma,ZR,F10
@@ Expand Down Expand Up / @@ -382,14 +384,23 @@ MODULE cable_IO_vars_module @@
               isoil  = .FALSE.,    & ! soil type from global index
               meth  = .FALSE.,     & ! method for solving turbulence in canopy scheme
               za  = .FALSE.,       & ! something to do with roughness ????
+              elev = .false.,&       !mean subgrid elev    ! inserted 2 lines - rk4417 - phase2
+              elev_std=.false.,&     !stddev of subgrid elev
               slope = .FALSE.,&      !mean subgrid slope
               slope_std=.FALSE.,&    !stddev of subgrid slope
               GWdz=.FALSE.,&         !aquifer thickness
               SatFracmax=.FALSE.,&
               Qhmax=.FALSE.,&
               QhmaxEfold=.FALSE.,&
               HKefold=.FALSE.,&
-              HKdepth
+    !          HKdepth ! commented out by rk4417 - phase2
+              HKdepth=.false.,&  ! added this block - rk4417 - phase2
+              SMP=.false.,&
+              SMP_hys=.false.,&
+              WB_hys=.false.,&
+              SSAT_hys=.false.,&
+              WATR_hys=.false.,&
+              hys_fac=.false.
       END TYPE output_inclusion_type
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

379 updated branch with all GW changes #580

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

379 updated branch with all GW changes #580

Are you sure you want to change the base?

Uh oh!

379 updated branch with all GW changes #580

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!