Add module for designating patch/col/etc. as "debug"

src/main/debugMod.F90

@@ -0,0 +1,202 @@
+module debugMod
+
+  !-----------------------------------------------------------------------
+  ! !DESCRIPTION:
+  ! Provides a place to define gridcells, landunits, columns, and/or patches that we want debug
+  ! output for, as well as functions for checking whether a given g/l/c/p is being debugged.
+  !
+  ! !USES:
+#include "shr_assert.h"
+  use shr_kind_mod     , only : r8 => shr_kind_r8, CL=>shr_kind_CL
+  use decompMod        , only : bounds_type, get_proc_clumps, get_clump_bounds
+  use decompMod        , only : bounds_level_proc
+  use decompMod        , only : subgrid_level_gridcell, subgrid_level_landunit
+  use decompMod        , only : subgrid_level_column, subgrid_level_patch
+  use decompMod        , only : get_global_index
+  use spmdMod          , only : masterproc, mpicom
+  use abortutils       , only : endrun
+  use shr_log_mod      , only : errMsg => shr_log_errMsg
+  use clm_time_manager , only : timemgr_restart_io, get_nstep, get_curr_date
+  use clm_varctl       , only : iulog
+  use clm_varcon       , only : nameg, namel, namec, namep
+  !
+  ! !PUBLIC TYPES:
+  implicit none
+  private
+  !
+  ! !PUBLIC MEMBER FUNCTIONS:
+!   public :: do_debug_patch
+  public :: do_debug_column
+!   public :: do_debug_landunit
+!   public :: do_debug_gridcell
+  !
+  ! !PRIVATE TYPES:
+
+  ! Global indices for objects to debug.
+  ! When merging to a CTSM branch, these must always be < 1!!
+  integer, parameter :: debug_p = -999
+  integer, parameter :: debug_c = 2787
+  integer, parameter :: debug_l = -999
+  integer, parameter :: debug_g = -999
+
+  character(len=*), parameter, private :: sourcefile = __FILE__
+  !-----------------------------------------------------------------------
+
+contains
+
+  !-----------------------------------------------------------------------
+  function do_debug_patch(i_local, i_global) result(do_debug)
+    !
+    ! !DESCRIPTION:
+    ! Return .true. if the given global patch index is the one we're debugging; .false. otherwise.
+    ! Provide only i_local or i_global.
+    !
+    ! !ARGUMENTS:
+    integer, optional :: i_local   ! Local patch index
+    integer, optional :: i_global  ! Global patch index
+    !
+    ! !RESULT:
+    logical :: do_debug
+    integer :: i  ! Global patch index
+    !-----------------------------------------------------------------------
+
+    ! This makes it so that compilers should build this function as a simple boolean if we haven't
+    ! requested any patch to be debugged, which reduces performance cost in production runs.
+    if (debug_p < 1) then
+       do_debug = .false.
+       return
+    end if
+
+    if (present(i_global)) then
+       call shr_assert(.not. present(i_local), file=sourcefile, line=__LINE__)
+       call shr_assert(i_global >= 1, file=sourcefile, line=__LINE__)
+       i = i_global
+    else
+       call shr_assert(present(i_local), file=sourcefile, line=__LINE__)
+       i = get_global_index(subgrid_index=i_local, subgrid_level=subgrid_level_patch, &
+            donot_abort_on_badindex=.false.)
+    end if
+
+    do_debug = i == debug_p
+    return
+
+  end function do_debug_patch
+
+  !-----------------------------------------------------------------------
+  function do_debug_column(i_local, i_global) result(do_debug)
+    !
+    ! !DESCRIPTION:
+    ! Return .true. if the given global column index is the one we're debugging; .false. otherwise.
+    ! Provide only i_local or i_global.
+    !
+    ! !ARGUMENTS:
+    integer, optional :: i_local   ! Local column index
+    integer, optional :: i_global  ! Global column index
+    !
+    ! !RESULT:
+    logical :: do_debug
+    integer :: i  ! Global column index
+    !-----------------------------------------------------------------------
+
+    ! This makes it so that compilers should build this function as a simple boolean if we haven't
+    ! requested any column to be debugged, which reduces performance cost in production runs.
+    if (debug_c < 1) then
+       do_debug = .false.
+       return
+    end if
+
+    if (present(i_global)) then
+       call shr_assert(.not. present(i_local), file=sourcefile, line=__LINE__)
+       call shr_assert(i_global >= 1, file=sourcefile, line=__LINE__)
+       i = i_global
+    else
+       call shr_assert(present(i_local), file=sourcefile, line=__LINE__)
+       i = get_global_index(subgrid_index=i_local, subgrid_level=subgrid_level_column, &
+            donot_abort_on_badindex=.false.)
+    end if
+
+    do_debug = i == debug_c
+    return
+
+  end function do_debug_column
+
+  !-----------------------------------------------------------------------
+  function do_debug_landunit(i_local, i_global) result(do_debug)
+    !
+    ! !DESCRIPTION:
+    ! Return .true. if the given global landunit index is the one we're debugging; .false. otherwise.
+    ! Provide only i_local or i_global.
+    !
+    ! !ARGUMENTS:
+    integer, optional :: i_local   ! Local landunit index
+    integer, optional :: i_global  ! Global landunit index
+    !
+    ! !RESULT:
+    logical :: do_debug
+    integer :: i  ! Global landunit index
+    !-----------------------------------------------------------------------
+
+    ! This makes it so that compilers should build this function as a simple boolean if we haven't
+    ! requested any landunit to be debugged, which reduces performance cost in production runs.
+    if (debug_l < 1) then
+       do_debug = .false.
+       return
+    end if
+
+    if (present(i_global)) then
+       call shr_assert(.not. present(i_local), file=sourcefile, line=__LINE__)
+       call shr_assert(i_global >= 1, file=sourcefile, line=__LINE__)
+       i = i_global
+    else
+       call shr_assert(present(i_local), file=sourcefile, line=__LINE__)
+       i = get_global_index(subgrid_index=i_local, subgrid_level=subgrid_level_landunit, &
+            donot_abort_on_badindex=.false.)
+    end if
+
+    do_debug = i == debug_l
+    return
+
+  end function do_debug_landunit
+
+  !-----------------------------------------------------------------------
+  function do_debug_gridcell(i_local, i_global) result(do_debug)
+    !
+    ! !DESCRIPTION:
+    ! Return .true. if the given global gridcell index is the one we're debugging; .false. otherwise.
+    ! Provide only i_local or i_global.
+    !
+    ! !ARGUMENTS:
+    integer, optional :: i_local   ! Local gridcell index
+    integer, optional :: i_global  ! Global gridcell index
+    !
+    ! !RESULT:
+    logical :: do_debug
+    integer :: i  ! Global gridcell index
+    !-----------------------------------------------------------------------
+
+    ! This makes it so that compilers should build this function as a simple boolean if we haven't
+    ! requested any gridcell to be debugged, which reduces performance cost in production runs.
+    if (debug_g < 1) then
+       do_debug = .false.
+       return
+    end if
+
+    if (present(i_global)) then
+       call shr_assert(.not. present(i_local), file=sourcefile, line=__LINE__)
+       call shr_assert(i_global >= 1, file=sourcefile, line=__LINE__)
+       i = i_global
+    else
+       call shr_assert(present(i_local), file=sourcefile, line=__LINE__)
+       i = get_global_index(subgrid_index=i_local, subgrid_level=subgrid_level_gridcell, &
+            donot_abort_on_badindex=.false.)
+    end if
+
+    do_debug = i == debug_g
+    return
+
+  end function do_debug_gridcell
+
+end module debugMod
+
+
+