Complete the FATES-CLM nitrogen coupling

biogeochem/EDCohortDynamicsMod.F90

@@ -68,8 +68,8 @@ Module EDCohortDynamicsMod
   use FatesAllometryMod  , only : bstore_allom
   use FatesAllometryMod  , only : ForceDBH
   use FatesAllometryMod    , only : set_root_fraction
-  use PRTGenericMod,          only : prt_carbon_allom_hyp
-  use PRTGenericMod,          only : prt_cnp_flex_allom_hyp
+  use PRTGenericMod,          only : carbon_only
+  use PRTGenericMod,          only : carbon_nitrogen_phosphorus
   use PRTGenericMod,          only : prt_vartypes
   use PRTGenericMod,          only : carbon12_element
   use PRTGenericMod,          only : nitrogen_element
@@ -251,12 +251,12 @@ subroutine InitPRTObject(prt)
 
 
     select case(hlm_parteh_mode)
-    case (prt_carbon_allom_hyp)
+    case (carbon_only)
 
         allocate(c_allom_prt)
         prt => c_allom_prt
 
-    case (prt_cnp_flex_allom_hyp)
+    case (carbon_nitrogen_phosphorus)
 
        allocate(cnp_allom_prt)
        prt => cnp_allom_prt
@@ -1039,7 +1039,7 @@ subroutine fuse_cohorts(currentSite, currentPatch, bc_in)
                                       currentCohort%frmort = (currentCohort%n*currentCohort%frmort + nextc%n*nextc%frmort)/newn
 
                                       ! Nutrients
-                                      if(hlm_parteh_mode .eq. prt_cnp_flex_allom_hyp) then
+                                      if (hlm_parteh_mode == carbon_nitrogen_phosphorus) then
 
                                          currentCohort%l2fr = (currentCohort%n*currentCohort%l2fr &
                                               + nextc%n*nextc%l2fr)/newn

biogeochem/EDPatchDynamicsMod.F90

@@ -99,8 +99,6 @@ module EDPatchDynamicsMod
   use PRTGenericMod,          only : struct_organ
   use PRTLossFluxesMod,       only : PRTBurnLosses
   use FatesInterfaceTypesMod,      only : hlm_parteh_mode
-  use PRTGenericMod,          only : prt_carbon_allom_hyp   
-  use PRTGenericMod,          only : prt_cnp_flex_allom_hyp
   use SFParamsMod,            only : SF_VAL_CWD_FRAC
   use EDParamsMod,            only : logging_event_code
   use EDParamsMod,            only : logging_export_frac

biogeochem/EDPhysiologyMod.F90

@@ -115,8 +115,8 @@ module EDPhysiologyMod
   use FatesAllometryMod  , only : carea_allom
   use FatesAllometryMod  , only : CheckIntegratedAllometries
   use FatesAllometryMod, only : set_root_fraction
-  use PRTGenericMod, only : prt_carbon_allom_hyp
-  use PRTGenericMod, only : prt_cnp_flex_allom_hyp
+  use PRTGenericMod, only : carbon_only
+  use PRTGenericMod, only : carbon_nitrogen_phosphorus
   use PRTGenericMod, only : prt_vartypes
   use PRTGenericMod, only : leaf_organ
   use PRTGenericMod, only : sapw_organ, struct_organ
@@ -2732,7 +2732,7 @@ subroutine recruitment(currentSite, currentPatch, bc_in)
 
 
                   select case(hlm_parteh_mode)
-                  case (prt_carbon_allom_hyp, prt_cnp_flex_allom_hyp)
+                  case (carbon_only,carbon_nitrogen_phosphorus)
 
                      ! put all of the leaf mass into the first bin
                      call SetState(prt, leaf_organ, element_id, m_leaf, 1)
@@ -3330,7 +3330,7 @@ subroutine UpdateRecruitL2FR(csite)
 
     ! Difference in dbh (cm) to consider a plant was recruited fairly recently
 
-    if(hlm_parteh_mode .ne. prt_cnp_flex_allom_hyp) return
+    if (hlm_parteh_mode /= carbon_nitrogen_phosphorus) return
 
     rec_n(1:numpft,1:nclmax) = 0._r8
     rec_l2fr0(1:numpft,1:nclmax) = 0._r8
@@ -3392,7 +3392,7 @@ subroutine UpdateRecruitStoich(csite)
     ! Update the total plant stoichiometry of a new recruit, based on the updated
     ! L2FR values
 
-    if(hlm_parteh_mode .ne. prt_cnp_flex_allom_hyp) return
+    if (hlm_parteh_mode /= carbon_nitrogen_phosphorus) return
 
     cpatch => csite%youngest_patch
     do while(associated(cpatch))
@@ -3430,7 +3430,7 @@ subroutine SetRecruitL2FR(csite)
     type(fates_cohort_type), pointer :: ccohort
     integer :: ft,cl
 
-    if(hlm_parteh_mode .ne. prt_cnp_flex_allom_hyp) return
+    if (hlm_parteh_mode /= carbon_nitrogen_phosphorus) return
 
     cpatch => csite%youngest_patch
     do while(associated(cpatch))

biogeochem/FatesCohortMod.F90

@@ -12,8 +12,8 @@ module FatesCohortMod
   use FatesGlobals,               only : fates_log
   use PRTGenericMod,              only : max_nleafage
   use PRTGenericMod,              only : prt_vartypes
-  use PRTGenericMod,              only : prt_carbon_allom_hyp
-  use PRTGenericMod,              only : prt_cnp_flex_allom_hyp
+  use PRTGenericMod,              only : carbon_only
+  use PRTGenericMod,              only : carbon_nitrogen_phosphorus
   use PRTGenericMod,              only : leaf_organ, fnrt_organ, sapw_organ
   use PRTGenericMod,              only : repro_organ, store_organ, struct_organ
   use PRTGenericMod,              only : carbon12_element
@@ -625,7 +625,7 @@ subroutine Create(this, prt, pft, nn, height, coage, dbh, status,            &
       ! initialized with full stores, which match with minimum fineroot biomass
       this%l2fr = prt_params%allom_l2fr(pft)
 
-      if (hlm_parteh_mode .eq. prt_cnp_flex_allom_hyp) then
+      if (hlm_parteh_mode == carbon_nitrogen_phosphorus) then
         this%cx_int      = 0._r8  ! Assume balanced N,P/C stores ie log(1) = 0
         this%cx0         = 0._r8  ! Assume balanced N,P/C stores ie log(1) = 0
         this%ema_dcxdt   = 0._r8  ! Assume unchanged dCX/dt
@@ -743,7 +743,7 @@ subroutine Copy(this, copyCohort)
       copyCohort%year_net_uptake         = this%year_net_uptake
       copyCohort%cnp_limiter             = this%cnp_limiter
 
-      if (hlm_parteh_mode .eq. prt_cnp_flex_allom_hyp) then 
+      if (hlm_parteh_mode == carbon_nitrogen_phosphorus) then
         copyCohort%cx_int                  = this%cx_int
         copyCohort%ema_dcxdt               = this%ema_dcxdt
         copyCohort%cx0                     = this%cx0
@@ -873,7 +873,7 @@ subroutine InitPRTBoundaryConditions(this)
       class(fates_cohort_type), intent(inout), target :: this
 
       select case(hlm_parteh_mode)
-      case (prt_carbon_allom_hyp)
+      case (carbon_only)
 
         ! Register boundary conditions for the Carbon Only Allometric Hypothesis
 
@@ -887,7 +887,7 @@ subroutine InitPRTBoundaryConditions(this)
         call this%prt%RegisterBCIn(ac_bc_in_id_effnrt, bc_rval = this%effnrt_coh)
         call this%prt%RegisterBCIn(ac_bc_in_id_efstem, bc_rval = this%efstem_coh)
 
-      case (prt_cnp_flex_allom_hyp)
+      case (carbon_nitrogen_phosphorus)
 
         ! Register boundary conditions for the CNP Allometric Hypothesis
 

biogeochem/FatesSoilBGCFluxMod.F90

@@ -15,8 +15,8 @@ module FatesSoilBGCFluxMod
   use PRTGenericMod     , only : num_elements
   use PRTGenericMod     , only : element_list
   use PRTGenericMod     , only : element_pos
-  use PRTGenericMod     , only : prt_carbon_allom_hyp
-  use PRTGenericMod     , only : prt_cnp_flex_allom_hyp
+  use PRTGenericMod     , only : carbon_only
+  use PRTGenericMod     , only : carbon_nitrogen_phosphorus
   use PRTGenericMod     , only : prt_vartypes
   use PRTGenericMod     , only : leaf_organ
   use PRTGenericMod     , only : sapw_organ, struct_organ
@@ -153,7 +153,7 @@ subroutine UnPackNutrientAquisitionBCs(sites, bc_in, nitr_suppl, phos_suppl)
 
     ! We can exit if this is a c-only simulation
     select case (hlm_parteh_mode)
-    case (prt_carbon_allom_hyp)
+    case (carbon_only)
        ! These can now be zero'd
        do s = 1, nsites
           bc_in(s)%plant_nh4_uptake_flux(:,:) = 0._r8
@@ -289,7 +289,7 @@ subroutine PrepCH4BCs(csite,bc_in,bc_out)
 
 
     ! Exit if we need not communicate with the hlm's ch4 module
-   ! if(.not.(hlm_use_ch4==itrue) .and. .not.(hlm_parteh_mode==prt_cnp_flex_allom_hyp) ) return
+   ! if(.not.(hlm_use_ch4==itrue) .and. .not.(hlm_parteh_mode==carbon_nitrogen_phosphorus) ) return
 
     ! Initialize to zero
     bc_out%annavg_agnpp_pa(:) = 0._r8
@@ -302,7 +302,7 @@ subroutine PrepCH4BCs(csite,bc_in,bc_out)
     bc_out%ema_npp = 0._r8
 
     ! Process CH4 variables first
-    !if(.not.(hlm_use_ch4==itrue) .and. .not.(hlm_parteh_mode==prt_cnp_flex_allom_hyp) )
+    !if(.not.(hlm_use_ch4==itrue) .and. .not.(hlm_parteh_mode==carbon_nitrogen_phosphorus) )
 
     cpatch => csite%oldest_patch
     do while (associated(cpatch))

biogeophys/FatesPlantRespPhotosynthMod.F90

@@ -44,8 +44,8 @@ module FATESPlantRespPhotosynthMod
   use FatesCohortMod,    only : fates_cohort_type
   use FatesConstantsMod, only : lmrmodel_ryan_1991
   use FatesConstantsMod, only : lmrmodel_atkin_etal_2017
-  use PRTGenericMod,     only : prt_carbon_allom_hyp
-  use PRTGenericMod,     only : prt_cnp_flex_allom_hyp
+  use PRTGenericMod,     only : carbon_only
+  use PRTGenericMod,     only : carbon_nitrogen_phosphorus
   use PRTGenericMod,     only : carbon12_element
   use PRTGenericMod,     only : nitrogen_element
   use PRTGenericMod,     only : leaf_organ
@@ -497,7 +497,7 @@ subroutine FatesPlantRespPhotosynthDrive (nsites, sites,bc_in,bc_out,dtime)
                                    (hlm_use_planthydro.eq.itrue) .or. &
                                    (hlm_radiation_model .eq. twostr_solver ) .or. &
                                    (nleafage > 1) .or. &
-                                   (hlm_parteh_mode .ne. prt_carbon_allom_hyp )   ) then
+                                   (hlm_parteh_mode /= carbon_only)   ) then
 
 
                                  ! These values are incremented, therefore since
@@ -564,11 +564,11 @@ subroutine FatesPlantRespPhotosynthDrive (nsites, sites,bc_in,bc_out,dtime)
                                  ! Then scale this value at the top of the canopy for canopy depth
                                  ! Leaf nitrogen concentration at the top of the canopy (g N leaf / m**2 leaf)
                                  select case(hlm_parteh_mode)
-                                 case (prt_carbon_allom_hyp)
+                                 case (carbon_only)
 
                                     lnc_top  = prt_params%nitr_stoich_p1(ft,prt_params%organ_param_id(leaf_organ))/slatop(ft)
 
-                                 case (prt_cnp_flex_allom_hyp)
+                                 case (carbon_nitrogen_phosphorus)
 
                                     leaf_c  = currentCohort%prt%GetState(leaf_organ, carbon12_element)
                                     if( (leaf_c*slatop(ft)) > nearzero) then
@@ -920,15 +920,15 @@ subroutine FatesPlantRespPhotosynthDrive (nsites, sites,bc_in,bc_out,dtime)
 
 
                         select case(hlm_parteh_mode)
-                        case (prt_carbon_allom_hyp)
+                        case (carbon_only)
 
                            live_stem_n = sapw_c_agw * prt_params%nitr_stoich_p1(ft,prt_params%organ_param_id(sapw_organ))
 
                            live_croot_n = sapw_c_bgw * prt_params%nitr_stoich_p1(ft,prt_params%organ_param_id(sapw_organ))
 
                            fnrt_n = fnrt_c * prt_params%nitr_stoich_p1(ft,prt_params%organ_param_id(fnrt_organ))
 
-                        case(prt_cnp_flex_allom_hyp)
+                        case(carbon_nitrogen_phosphorus)
 
                            live_stem_n = prt_params%allom_agb_frac(currentCohort%pft) * &
                                 currentCohort%prt%GetState(sapw_organ, nitrogen_element)

functional_unit_testing/parteh/f90src/FatesCohortWrapMod.F90

@@ -35,8 +35,8 @@ module FatesCohortWrapMod
   use PRTGenericMod,          only : carbon12_element
   use PRTGenericMod,          only : SetState
   use PRTGenericMod,          only : prt_global
-  use PRTGenericMod,          only : prt_carbon_allom_hyp   
-  use PRTGenericMod,          only : prt_cnp_flex_allom_hyp
+  use PRTGenericMod,          only : carbon_only
+  use PRTGenericMod,          only : carbon_nitrogen_phosphorus
 
   use PRTAllometricCarbonMod, only : callom_prt_vartypes
   use PRTAllometricCarbonMod, only : ac_bc_inout_id_netdc
@@ -257,12 +257,12 @@ subroutine CohortPySet(ipft,hgt_min,canopy_trim)
     ! -----------------------------------------------------
 
     select case(ccohort%parteh_mode)
-    case (prt_carbon_allom_hyp)
+    case (fates_c_only)
        prt_global => prt_global_ac
        allocate(callom_prt)
        ccohort%prt => callom_prt
 
-    case(prt_cnp_flex_allom_hyp)
+    case(fates_cnp)
        prt_global => prt_global_acnp
        allocate(cnpallom_prt)
        ccohort%prt => cnpallom_prt
@@ -276,7 +276,7 @@ subroutine CohortPySet(ipft,hgt_min,canopy_trim)
     call ccohort%prt%InitPRTVartype()
 
     select case(ccohort%parteh_mode)
-    case (prt_carbon_allom_hyp)
+    case (fates_c_only)
 
        call SetState(ccohort%prt,leaf_organ, carbon12_element, leaf_c)
        call SetState(ccohort%prt,fnrt_organ, carbon12_element, fnrt_c)
@@ -291,7 +291,7 @@ subroutine CohortPySet(ipft,hgt_min,canopy_trim)
        call ccohort%prt%RegisterBCIn(ac_bc_in_id_pft,bc_ival = ccohort%pft)
        call ccohort%prt%RegisterBCIn(ac_bc_in_id_ctrim,bc_rval = ccohort%canopy_trim)
 
-    case (prt_cnp_flex_allom_hyp)
+    case (fates_cnp)
 
        ! Initializing with the target stoichiometric ratios
        ! (OR you can initialize with the minimum ratios too.... p2)
@@ -394,7 +394,7 @@ subroutine WrapDailyPRT(ipft,daily_carbon_gain,canopy_trim,flush_c,drop_frac_c,l
     call PRTMaintTurnover(ccohort%prt, ipft, is_drought)
 
     select case(ccohort%parteh_mode)
-    case (prt_carbon_allom_hyp)
+    case (fates_c_only)
        prt_global => prt_global_ac
        ccohort%daily_carbon_gain = daily_carbon_gain
 
@@ -403,7 +403,7 @@ subroutine WrapDailyPRT(ipft,daily_carbon_gain,canopy_trim,flush_c,drop_frac_c,l
        ccohort%daily_r_grow = 0.0_r8
        ccohort%carbon_root_efflux = 0.0_r8
 
-    case (prt_cnp_flex_allom_hyp)
+    case (fates_cnp)
 
        prt_global => prt_global_acnp
        ccohort%daily_carbon_gain     = daily_carbon_gain
@@ -457,9 +457,9 @@ subroutine WrapQueryVars(ipft,crowndamage, leaf_area,crown_area,agb,store_c,targ
     canopy_lai(:) = 0._r8
 
     select case(ccohort%parteh_mode)
-    case (prt_carbon_allom_hyp)
+    case (fates_c_only)
        prt_global => prt_global_ac
-    case (prt_cnp_flex_allom_hyp)
+    case (fates_cnp)
        prt_global => prt_global_acnp
     end select
 
@@ -547,9 +547,9 @@ subroutine WrapQueryDiagnostics(ipft, dbh, &
     ccohort => cohort_array(ipft)   
 
     select case(ccohort%parteh_mode)
-    case (prt_carbon_allom_hyp )
+    case (fates_c_only )
        prt_global => prt_global_ac
-    case (prt_cnp_flex_allom_hyp)
+    case (fates_cnp)
        prt_global => prt_global_acnp
     end select
 

main/EDInitMod.F90

@@ -79,8 +79,8 @@ module EDInitMod
   use FatesAllometryMod         , only : carea_allom
   use PRTGenericMod             , only : StorageNutrientTarget
   use FatesInterfaceTypesMod,      only : hlm_parteh_mode
-  use PRTGenericMod,          only : prt_carbon_allom_hyp
-  use PRTGenericMod,          only : prt_cnp_flex_allom_hyp
+  use PRTGenericMod,          only : carbon_only
+  use PRTGenericMod,          only : carbon_nitrogen_phosphorus
   use PRTGenericMod,          only : prt_vartypes
   use PRTGenericMod,          only : leaf_organ
   use PRTGenericMod,          only : fnrt_organ
@@ -1426,7 +1426,7 @@ subroutine init_cohorts(site_in, patch_in, bc_in)
                end select
 
                select case(hlm_parteh_mode)
-               case (prt_carbon_allom_hyp, prt_cnp_flex_allom_hyp )
+               case (carbon_only, carbon_nitrogen_phosphorus)
                   ! Put all of the leaf mass into the first bin
                   call SetState(prt, leaf_organ, element_id, m_leaf, 1)
                   do iage = 2,nleafage

main/EDMainMod.F90

@@ -28,8 +28,8 @@ module EDMainMod
   use FatesInterfaceTypesMod        , only : numpft
   use FatesInterfaceTypesMod        , only : hlm_use_nocomp
   use FatesInterfaceTypesMod        , only : ZeroBCOutCarbonFluxes
-  use PRTGenericMod            , only : prt_carbon_allom_hyp
-  use PRTGenericMod            , only : prt_cnp_flex_allom_hyp
+  use PRTGenericMod            , only : carbon_only
+  use PRTGenericMod            , only : carbon_nitrogen_phosphorus
   use PRTGenericMod            , only : nitrogen_element
   use PRTGenericMod            , only : phosphorus_element
   use EDCohortDynamicsMod      , only : terminate_cohorts
@@ -739,7 +739,7 @@ subroutine ed_integrate_state_variables(currentSite, bc_in, bc_out )
    ! Update history diagnostics related to Nutrients (if any)
    ! -----------------------------------------------------------------------------
    select case(hlm_parteh_mode)
-   case (prt_cnp_flex_allom_hyp)
+   case (carbon_nitrogen_phosphorus)
       call fates_hist%update_history_nutrflux(currentSite)
    end select
 

main/EDPftvarcon.F90

@@ -22,7 +22,7 @@ module EDPftvarcon
   use FatesLitterMod, only : ilabile,icellulose,ilignin
   use PRTGenericMod,  only : leaf_organ, fnrt_organ, store_organ
   use PRTGenericMod,  only : sapw_organ, struct_organ, repro_organ
-  use PRTGenericMod,  only : prt_cnp_flex_allom_hyp,prt_carbon_allom_hyp
+  use PRTGenericMod,  only : carbon_nitrogen_phosphorus,carbon_only
   use FatesInterfaceTypesMod, only : hlm_parteh_mode
   use FatesInterfaceTypesMod, only : hlm_nu_com
   use FatesConstantsMod   , only : ievergreen
@@ -978,7 +978,7 @@ subroutine FatesCheckParams(is_master)
      if(.not.is_master) return
 
      select case (hlm_parteh_mode)
-     case (prt_cnp_flex_allom_hyp)
+     case (carbon_nitrogen_phosphorus)
 
         ! Check to see if either RD/ECA/MIC is turned on
 
@@ -1049,7 +1049,7 @@ subroutine FatesCheckParams(is_master)
            end if
         end if
 
-     case (prt_carbon_allom_hyp)
+     case (carbon_only)
         ! No additional checks needed for now.
         continue
 

main/EDTypesMod.F90

@@ -15,8 +15,6 @@ module EDTypesMod
   use PRTGenericMod,         only : prt_vartypes
   use PRTGenericMod,         only : leaf_organ, fnrt_organ, sapw_organ
   use PRTGenericMod,         only : repro_organ, store_organ, struct_organ
-  use PRTGenericMod,         only : prt_carbon_allom_hyp
-  use PRTGenericMod,         only : prt_cnp_flex_allom_hyp
   use PRTGenericMod,         only : num_organ_types
   use PRTGenericMod,         only : num_elements
   use PRTGenericMod,         only : element_list