[WIP] For testing add a framework to bypass parts of the code

bld/CLMBuildNamelist.pm

@@ -5290,6 +5290,7 @@ sub write_output_files {
   push @groups, "clm_canopy_inparm";
   push @groups, "prigentroughness";
   push @groups, "zendersoilerod";
+  push @groups, "for_testing_options";
   if (remove_leading_and_trailing_quotes($nl->get_value('snow_cover_fraction_method')) eq 'SwensonLawrence2012') {
      push @groups, "scf_swenson_lawrence_2012_inparm";
   }

bld/namelist_files/namelist_definition_ctsm.xml

@@ -1242,6 +1242,22 @@ Whether to use subgrid fluxes for snow
 Whether snow on the vegetation canopy affects the radiation/albedo calculations
 </entry>
 
+<!-- ========================================================================================  -->
+<!-- Namelist items for doing specific things for testing                                      -->
+<!-- for_testing section:                                                                      -->
+<!-- ========================================================================================  -->
+
+<entry id="for_testing_bypass_init" type="logical" category="default_settings"
+       group="for_testing_options" >
+For testing whether to bypass the rest of the initiatlization after the self test driver is run
+</entry>
+
+<entry id="for_testing_bypass_run" type="logical" category="default_settings"
+       group="for_testing_options" >
+For testing whether to bypass most of the run phase other than the clock advance
+</entry>
+
+
 <entry id="for_testing_run_ncdiopio_tests" type="logical" category="default_settings"
        group="clm_inparm" >
 Whether to run some tests of ncdio_pio as part of the model run. This is

cime_config/testdefs/testmods_dirs/clm/run_self_tests/user_nl_clm

@@ -1,3 +1,5 @@
+for_testing_bypass_init = .true.
+for_testing_bypass_run = .true.
 for_testing_run_ncdiopio_tests = .true.
 
 ! Turn off history, restarts, and output

src/main/clm_driver.F90

@@ -85,6 +85,7 @@ module clm_driver
   use clm_instMod
   use SoilMoistureStreamMod  , only : PrescribedSoilMoistureInterp, PrescribedSoilMoistureAdvance
   use SoilBiogeochemDecompCascadeConType , only : no_soil_decomp, decomp_method
+  use SelfTestDriver         , only : for_testing_bypass_run_except_clock_advance
   !
   ! !PUBLIC TYPES:
   implicit none
@@ -165,6 +166,7 @@ subroutine clm_drv(doalb, nextsw_cday, declinp1, declin, rstwr, nlend, rdate, ro
     ! CalcIrrigationNeeded. Simply declaring this variable makes the ICE go away.
     real(r8), allocatable :: dummy1_to_make_pgi_happy(:)
     !-----------------------------------------------------------------------
+    if ( for_testing_bypass_run_except_clock_advance() ) return
 
     ! Determine processor bounds and clumps for this processor
 
@@ -1576,6 +1578,8 @@ subroutine clm_drv_init(bounds, &
     integer :: fp, fc                  ! filter indices
     !-----------------------------------------------------------------------
 
+    if ( for_testing_bypass_run_except_clock_advance() ) return
+
     associate(                                                             &
          snl                => col%snl                                   , & ! Input:  [integer  (:)   ]  number of snow layers
 
@@ -1657,6 +1661,7 @@ subroutine clm_drv_patch2col (bounds, &
     ! !LOCAL VARIABLES:
     integer :: c,fc              ! indices
     ! -----------------------------------------------------------------
+    if ( for_testing_bypass_run_except_clock_advance() ) return
 
     ! Note: lake points are excluded from many of the following
     ! averages. For some fields, this is because the field doesn't
@@ -1752,6 +1757,8 @@ subroutine write_diagnostic (bounds, nstep, lnd2atm_inst)
     integer :: status(MPI_STATUS_SIZE) ! mpi status
     !------------------------------------------------------------------------
 
+    if ( for_testing_bypass_run_except_clock_advance() ) return
+
     call get_proc_global(ng=numg)
 
     if (masterproc) then

src/main/clm_initializeMod.F90

@@ -30,7 +30,7 @@ module clm_initializeMod
   use CLMFatesInterfaceMod  , only : CLMFatesGlobals1,CLMFatesGlobals2
   use CLMFatesInterfaceMod  , only : CLMFatesTimesteps
   use dynSubgridControlMod  , only : dynSubgridControl_init, get_reset_dynbal_baselines
-  use SelfTestDriver        , only : self_test_driver
+  use SelfTestDriver        , only : self_test_driver, for_testing_bypass_init_after_self_tests
   use SoilMoistureStreamMod , only : PrescribedSoilMoistureInit
   use clm_instMod
   !
@@ -67,6 +67,7 @@ subroutine initialize1(dtime)
     use SoilBiogeochemDecompCascadeConType , only : decomp_cascade_par_init
     use CropReprPoolsMod     , only: crop_repr_pools_init
     use HillslopeHydrologyMod, only: hillslope_properties_init
+    use SelfTestDriver       , only: self_test_readnml
     !
     ! !ARGUMENTS
     integer, intent(in) :: dtime    ! model time step (seconds)
@@ -104,6 +105,8 @@ subroutine initialize1(dtime)
     call surfrd_get_num_patches(fsurdat, actual_maxsoil_patches, actual_numpft, actual_numcft)
     call surfrd_get_nlevurb(fsurdat, actual_nlevurb)
 
+    call self_test_readnml( NLFilename )
+
     ! If fates is on, we override actual_maxsoil_patches. FATES dictates the
     ! number of patches per column.  We still use numcft from the surface
     ! file though...
@@ -185,6 +188,7 @@ subroutine initialize2(ni,nj, currtime)
     use FATESFireFactoryMod           , only : scalar_lightning
     use dynFATESLandUseChangeMod      , only : dynFatesLandUseInit
     use HillslopeHydrologyMod         , only : InitHillslope
+    use SelfTestDriver                , only : for_testing_bypass_init_after_self_tests
     !
     ! !ARGUMENTS
     integer, intent(in) :: ni, nj         ! global grid sizes
@@ -467,6 +471,7 @@ subroutine initialize2(ni,nj, currtime)
        call bgc_vegetation_inst%Init2(bounds_proc, NLFilename)
     end if
 
+    if ( .not. for_testing_bypass_init_after_self_tests() )then
     if (use_cn) then
 
        ! NOTE(wjs, 2016-02-23) Maybe the rest of the body of this conditional should also
@@ -510,6 +515,7 @@ subroutine initialize2(ni,nj, currtime)
     if (nsrest == nsrContinue ) then
        call htapes_fieldlist()
     end if
+    end if
 
     ! Read restart/initial info
     is_cold_start = .false.
@@ -684,6 +690,7 @@ subroutine initialize2(ni,nj, currtime)
        call hist_htapes_build()
     end if
 
+    if ( .not. for_testing_bypass_init_after_self_tests() )then
     ! Initialize variables that are associated with accumulated fields.
     ! The following is called for both initial and restart runs and must
     ! must be called after the restart file is read
@@ -767,6 +774,7 @@ subroutine initialize2(ni,nj, currtime)
             water_inst%waterdiagnosticbulk_inst, canopystate_inst, &
             soilstate_inst, soilbiogeochem_carbonflux_inst)
     end if
+    end if
 
     ! topo_glc_mec was allocated in initialize1, but needed to be kept around through
     ! initialize2 because it is used to initialize other variables; now it can be deallocated

src/main/clm_instMod.F90

@@ -208,6 +208,7 @@ subroutine clm_instInit(bounds)
     use HillslopeHydrologyMod              , only : SetHillslopeSoilThickness
     use initVerticalMod                    , only : setSoilLayerClass
     use DustEmisFactory                    , only : create_dust_emissions
+    use SelfTestDriver                     , only : for_testing_bypass_init_after_self_tests
     !
     ! !ARGUMENTS
     type(bounds_type), intent(in) :: bounds  ! processor bounds
@@ -269,7 +270,9 @@ subroutine clm_instInit(bounds)
     call humanindex_inst%Init(bounds)
 
     ! Initialize urban time varying data
-    call urbantv_inst%Init(bounds, NLFilename)
+    if ( .not. for_testing_bypass_init_after_self_tests() )then
+       call urbantv_inst%Init(bounds, NLFilename)
+    end if
 
     ! Initialize vertical data components
 

src/self_tests/SelfTestDriver.F90

@@ -9,14 +9,22 @@ module SelfTestDriver
   use clm_varctl, only : for_testing_run_ncdiopio_tests
   use decompMod, only : bounds_type
   use TestNcdioPio, only : test_ncdio_pio
+  use abortutils, only : endrun
 
   implicit none
   private
   save
 
   ! Public routines
 
-  public :: self_test_driver
+  public :: self_test_driver ! Run the self-tests asked for
+  public :: self_test_readnml  ! Read in the general self testing options for overall code flow
+  public :: for_testing_bypass_init_after_self_tests ! For testing bypass the rest of the initialization after the self test driver was run
+  public :: for_testing_bypass_run_except_clock_advance ! For testing bypass most of the run phase other than the clock advance
+
+  ! Private module data
+  logical :: for_testing_bypass_init ! For testing bypass the initialization phase after the self-test driver
+  logical :: for_testing_bypass_run ! For testing bypass most of the run phase except the time advance
 
   character(len=*), parameter, private :: sourcefile = &
        __FILE__
@@ -46,4 +54,85 @@ subroutine self_test_driver(bounds)
 
   end subroutine self_test_driver
 
+  !-----------------------------------------------------------------------
+  subroutine self_test_readnml(NLFileName)
+    !
+    ! !DESCRIPTION:
+    ! Namelist read for the self-test driver. This includes bypass options
+    ! that will be used in other parts of the code to bypass bits of the code
+    ! for testing purposes.
+    !
+    ! !USES:
+    use shr_nl_mod , only : shr_nl_find_group_name
+    use spmdMod, only : masterproc, mpicom
+    use shr_mpi_mod, only : shr_mpi_bcast
+    use clm_varctl, only : iulog
+    !
+    ! !ARGUMENTS:
+    character(len=*), intent(in) :: NLFilename  ! Namelist filename
+    !
+    ! !LOCAL VARIABLES:
+    integer :: ierr ! error code
+    integer :: unitn ! unit for namelist file
+
+    ! Namelist name: this has to be matched with the name in the read stqatement
+    character(len=*), parameter :: nmlname = 'for_testing_options'
+    !-----------------------------------------------------------------------
+
+    namelist /for_testing_options/ for_testing_bypass_init, for_testing_bypass_run
+
+    ! Initialize options to default values, in case they are not specified in
+    ! the namelist
+
+    if (masterproc) then
+       write(iulog,*) 'Read in '//nmlname//' namelist'
+       open(newunit=unitn, status='old', file=NLFilename)
+       call shr_nl_find_group_name(unitn, nmlname, status=ierr)
+       if (ierr == 0) then
+          read(unit=unitn, nml=for_testing_options, iostat=ierr)
+          if (ierr /= 0) then
+             call endrun(msg="ERROR reading "//nmlname//"namelist", file=sourcefile, line=__LINE__)
+          end if
+       else
+          call endrun(msg="ERROR finding "//nmlname//"namelist", file=sourcefile, line=__LINE__)
+       end if
+       close(unitn)
+    end if
+
+    call shr_mpi_bcast (for_testing_bypass_init, mpicom)
+    call shr_mpi_bcast (for_testing_bypass_run, mpicom)
+
+    if (masterproc) then
+       write(iulog,*) ' '
+       write(iulog,*) nmlname//' settings:'
+       write(iulog,nml=for_testing_options)
+       write(iulog,*) ' '
+    end if
+
+  end subroutine self_test_readnml
+
+  !-----------------------------------------------------------------------
+
+  logical function for_testing_bypass_init_after_self_tests()
+    ! Determine if should exit initialization early after having run the self tests
+    if ( for_testing_bypass_init ) then
+       for_testing_bypass_init_after_self_tests = .true.
+    else
+       for_testing_bypass_init_after_self_tests = .false.
+    end if
+  end function for_testing_bypass_init_after_self_tests
+
+  !-----------------------------------------------------------------------
+
+  logical function for_testing_bypass_run_except_clock_advance()
+    ! Determine if should skip most of the run phase other than the clock advance
+    if ( for_testing_bypass_init ) then
+       for_testing_bypass_run_except_clock_advance = .true.
+    else
+       for_testing_bypass_run_except_clock_advance = .false.
+    end if
+  end function for_testing_bypass_run_except_clock_advance
+
+  !-----------------------------------------------------------------------
+
 end module SelfTestDriver