Add a namelist flag controlling the removal of negative runoff

ESCOMP · Jun 22, 2024 · 8133bdc · 8133bdc
1 parent f3761e0
commit 8133bdc
Show file tree

Hide file tree

Showing 3 changed files with 84 additions and 12 deletions.
diff --git a/cime_config/namelist_definition_drv.xml b/cime_config/namelist_definition_drv.xml
@@ -872,6 +872,17 @@
       <value COMP_LND="xlnd">off</value>
     </values>
   </entry>
+  <entry id="remove_negative_runoff">
+    <type>logical</type>
+    <category>control</category>
+    <group>MED_attributes</group>
+    <desc>
+      If true, remove negative runoff by downweighting all positive runoff globally.
+    </desc>
+    <values>
+      <value>.true.</value>
+    </values>
+  </entry>
 
   <entry id="info_debug" modify_via_xml="INFO_DBUG">
     <type>integer</type>

diff --git a/mediator/med.F90 b/mediator/med.F90
@@ -1622,7 +1622,7 @@ subroutine DataInitialize(gcomp, rc)
     use med_phases_post_lnd_mod , only : med_phases_post_lnd
     use med_phases_post_glc_mod , only : med_phases_post_glc
     use med_phases_post_ocn_mod , only : med_phases_post_ocn
-    use med_phases_post_rof_mod , only : med_phases_post_rof
+    use med_phases_post_rof_mod , only : med_phases_post_rof_init, med_phases_post_rof
     use med_phases_post_wav_mod , only : med_phases_post_wav
     use med_phases_ocnalb_mod   , only : med_phases_ocnalb_run
     use med_phases_aofluxes_mod , only : med_phases_aofluxes_init_fldbuns
@@ -1924,6 +1924,10 @@ subroutine DataInitialize(gcomp, rc)
          call med_phases_prep_rof_init(gcomp, rc=rc)
          if (ChkErr(rc,__LINE__,u_FILE_u)) return
       end if
+      if (is_local%wrap%comp_present(comprof)) then
+         call med_phases_post_rof_init(gcomp, rc=rc)
+         if (ChkErr(rc,__LINE__,u_FILE_u)) return
+      end if
       !---------------------------------------
       ! Set the data initialize flag to false
       !---------------------------------------

diff --git a/mediator/med_phases_post_rof_mod.F90 b/mediator/med_phases_post_rof_mod.F90
@@ -3,12 +3,13 @@ module med_phases_post_rof_mod
   ! Post rof phase, if appropriate, map initial rof->lnd, rof->ocn, rof->ice
 
   use NUOPC_Mediator        , only : NUOPC_MediatorGet
+  use NUOPC                 , only : NUOPC_CompAttributeGet
   use ESMF                  , only : ESMF_Clock, ESMF_ClockIsCreated
   use ESMF                  , only : ESMF_LogWrite, ESMF_LOGMSG_INFO, ESMF_LOGMSG_ERROR, ESMF_SUCCESS, ESMF_FAILURE
   use ESMF                  , only : ESMF_GridComp, ESMF_GridCompGet
   use ESMF                  , only : ESMF_Mesh, ESMF_MESHLOC_ELEMENT, ESMF_TYPEKIND_R8
   use ESMF                  , only : ESMF_Field, ESMF_FieldCreate
-  use ESMF                  , only : ESMF_FieldBundle, ESMF_FieldBundleCreate, ESMF_FieldBundleIsCreated
+  use ESMF                  , only : ESMF_FieldBundle, ESMF_FieldBundleCreate
   use ESMF                  , only : ESMF_FieldBundleGet, ESMF_FieldBundleAdd
   use ESMF                  , only : ESMF_VM, ESMF_VMAllreduce, ESMF_REDUCE_SUM
   use med_kind_mod          , only : CX=>SHR_KIND_CX, CS=>SHR_KIND_CS, CL=>SHR_KIND_CL, R8=>SHR_KIND_R8
@@ -21,10 +22,12 @@ module med_phases_post_rof_mod
   use med_methods_mod       , only : fldbun_getdata1d => med_methods_FB_getdata1d
   use med_methods_mod       , only : fldbun_getmesh   => med_methods_FB_getmesh
   use perf_mod              , only : t_startf, t_stopf
+  use shr_sys_mod           , only : shr_sys_abort
 
   implicit none
   private
 
+  public  :: med_phases_post_rof_init
   public  :: med_phases_post_rof
   private :: med_phases_post_rof_create_rof_field_bundle
   private :: med_phases_post_rof_remove_negative_runoff
@@ -35,6 +38,8 @@ module med_phases_post_rof_mod
   integer :: num_rof_fields
   character(len=CS), allocatable :: rof_field_names(:)
 
+  logical :: remove_negative_runoff
+
   character(len=9), parameter :: fields_to_remove_negative_runoff(2) = &
        ['Forr_rofl', 'Forr_rofi']
 
@@ -45,6 +50,61 @@ module med_phases_post_rof_mod
 contains
 !================================================================================================
 
+  subroutine med_phases_post_rof_init(gcomp, rc)
+
+    ! input/output variables
+    type(ESMF_GridComp)  :: gcomp
+    integer, intent(out) :: rc
+
+    ! local variables
+    character(CL) :: cvalue
+    logical       :: isPresent, isSet
+    logical       :: flds_wiso
+
+    character(len=*), parameter :: subname='(med_phases_post_rof_init)'
+    !---------------------------------------
+
+    rc = ESMF_SUCCESS
+
+    call t_startf('MED:'//subname)
+    if (dbug_flag > 20) then
+       call ESMF_LogWrite(trim(subname)//": called", ESMF_LOGMSG_INFO)
+    end if
+
+    call med_phases_post_rof_create_rof_field_bundle(gcomp, rc)
+    if (ChkErr(rc,__LINE__,u_FILE_u)) return
+
+    call NUOPC_CompAttributeGet(gcomp, name='remove_negative_runoff', value=cvalue, isPresent=isPresent, isSet=isSet, rc=rc)
+    if (chkerr(rc,__LINE__,u_FILE_u)) return
+    if (isPresent .and. isSet) then
+      read(cvalue,*) remove_negative_runoff
+    else
+      remove_negative_runoff = .false.
+    end if
+
+    ! remove_negative_runoff isn't yet set up to handle isotope fields, so ensure that
+    ! this isn't set along with flds_wiso
+    call NUOPC_CompAttributeGet(gcomp, name='flds_wiso', value=cvalue, isPresent=isPresent, isSet=isSet, rc=rc)
+    if (chkerr(rc,__LINE__,u_FILE_u)) return
+    if (isPresent .and. isSet) then
+       read(cvalue,*) flds_wiso
+    else
+       flds_wiso = .false.
+    end if
+    if (remove_negative_runoff .and. flds_wiso) then
+      call shr_sys_abort('remove_negative_runoff must be set to false when flds_wiso is true')
+    end if
+
+    if (maintask) then
+      write(logunit,'(a,l7)') trim(subname)//' remove_negative_runoff = ', remove_negative_runoff
+    end if
+
+    if (dbug_flag > 20) then
+      call ESMF_LogWrite(trim(subname)//": done", ESMF_LOGMSG_INFO)
+    end if
+    call t_stopf('MED:'//subname)
+  end subroutine med_phases_post_rof_init
+
   subroutine med_phases_post_rof(gcomp, rc)
 
     ! input/output variables
@@ -71,11 +131,6 @@ subroutine med_phases_post_rof(gcomp, rc)
     call ESMF_GridCompGetInternalState(gcomp, is_local, rc)
     if (ChkErr(rc,__LINE__,u_FILE_u)) return
 
-    if (.not. ESMF_FieldBundleIsCreated(FBrof_r)) then
-      call med_phases_post_rof_create_rof_field_bundle(gcomp, rc)
-      if (ChkErr(rc,__LINE__,u_FILE_u)) return
-    end if
-
     do n = 1, num_rof_fields
       call fldbun_getdata1d(is_local%wrap%FBImp(comprof,comprof), trim(rof_field_names(n)), data_orig, rc=rc)
       if (ChkErr(rc,__LINE__,u_FILE_u)) return
@@ -84,10 +139,12 @@ subroutine med_phases_post_rof(gcomp, rc)
       data_copy(:) = data_orig(:)
     end do
 
-    do n = 1, size(fields_to_remove_negative_runoff)
-      call med_phases_post_rof_remove_negative_runoff(gcomp, fields_to_remove_negative_runoff(n), rc)
-      if (ChkErr(rc,__LINE__,u_FILE_u)) return
-    end do
+    if (remove_negative_runoff) then
+      do n = 1, size(fields_to_remove_negative_runoff)
+        call med_phases_post_rof_remove_negative_runoff(gcomp, fields_to_remove_negative_runoff(n), rc)
+        if (ChkErr(rc,__LINE__,u_FILE_u)) return
+      end do
+    end if
 
     ! map rof to lnd
     if (is_local%wrap%med_coupling_active(comprof,complnd)) then
@@ -174,7 +231,7 @@ subroutine med_phases_post_rof_create_rof_field_bundle(gcomp, rc)
 
     call fldbun_getmesh(is_local%wrap%FBImp(comprof,comprof), mesh, rc)
     if (chkerr(rc,__LINE__,u_FILE_u)) return
-    
+
     call ESMF_FieldBundleGet(is_local%wrap%FBImp(comprof,comprof), fieldCount=num_rof_fields, rc=rc)
     if (ChkErr(rc,__LINE__,u_FILE_u)) return
     allocate(rof_field_names(num_rof_fields))