cleaned up and improved documentation of outlet locations version (mk_runofftbl.F90, rmTinyCatchParaMod.F90)

Author: gmao-rreichle

GEOSagcm_GridComp/GEOSphysics_GridComp/GEOSsurface_GridComp/Utils/Raster/makebcs/mk_runofftbl.F90

@@ -14,18 +14,12 @@ program mk_runofftbl
 ! directing runoff to its ocean sink.  The inputs are (i) bcs geometry files associated with the Gridname 
 ! and (ii) a binary file ("Outlet_latlon.43200x21600") that provides the land raster grid cells where the 
 ! outlets are located.  The latter file is either created by [..]/Raster/preproc/routing/run_routing_raster.py 
-! or from Randy's ([email protected]) old file under {MAKE_BCS_INPUT_DIR}/land/route/v1.
+! or from Randy's ([email protected]) old file under {MAKE_BCS_INPUT_DIR}/land/route/v1.  The version
+! of the outlet file used by mk_runofftbl.x is determined via the LBCSV argument.
 ! The program first moves the outlet locations from the land raster grid cells to the nearest ocean pixels 
 ! by calling outlets_to_ocean() and then generates the runoff table files.
 ! The subroutine outlets_to_ocean() currently works only for the MOM5 and MOM6 tripolar ocean grids.
 !
-!Basically based on bcs version we would use have these 3 options:
-!=======================================================
-!bcs version    -->  Outlet lat/lon file version
-!---------------------------------------------------
-!v12            -->  (new)  v2  (produced with Yujin's pre-processing routines)
-!v11            -->  (old)  v1  (produced with Randy's old file) 
-!otherwise      -->  N/A  (do not run routing module of make_bcs)
 !=========================================================
 !  
 ! Yujin Zeng - June 17, 2024 
@@ -104,11 +98,11 @@ program mk_runofftbl
      call get_command_argument(nxt,arg)
   end do
 
-  if(trim(OUTLETV)=="v1".or.trim(OUTLETV)=="v2")then
-    fileLL=trim(MAKE_BCS_INPUT_DIR)//'/land/route/'//trim(OUTLETV)//'/Outlet_latlon.'
+  if (trim(OUTLETV)=="v1" .or. trim(OUTLETV)=="v2") then
+     fileLL=trim(MAKE_BCS_INPUT_DIR)//'/land/route/'//trim(OUTLETV)//'/Outlet_latlon.'
   else
-    print *, "Routing files will not be produced with the selected land BCs version"
-    stop
+     print *, "Routing files will not be produced with the selected land BCs version (too old)"
+     stop
   endif
 
   ! ------------------------------------------------------------------
@@ -730,9 +724,9 @@ subroutine read_oceanModel_mapl(res_MAPL,wetMask,nx,ny)
 
     ! read "mask" from netcdf file into "wetMask"
 
-    call check_ret(nf90_inq_varid(ncid,"mask",varid),subname)
-    call check_ret(nf90_get_var(ncid,varid,wetMask),subname)
-    call check_ret(nf90_close(ncid),subname)    
+    call check_ret( nf90_inq_varid(ncid,"mask",varid),  subname)
+    call check_ret( nf90_get_var(  ncid,varid,wetMask), subname)
+    call check_ret( nf90_close(    ncid),               subname)    
 
   end subroutine read_oceanModel_mapl
 

GEOSagcm_GridComp/GEOSphysics_GridComp/GEOSsurface_GridComp/Utils/Raster/makebcs/rmTinyCatchParaMod.F90

@@ -92,7 +92,13 @@ SUBROUTINE init_bcs_config (LBCSV)
     !   NGDC      : Soil parameters from Reynolds et al. 2000, doi:10.1029/2000WR900130 (MERRA-2, Fortuna, Ganymed, Icarus)
     !   HWSD      : Merged HWSDv1.21-STATSGO2 soil properties on 43200x21600 with Woesten et al. (1999) parameters   
     !   HWSD_b    : As in HWSD but with surgical fix of Argentina peatland issue (38S,60W)
-    
+    !
+    ! OUTLETV: Definition of outlet locations.  DEFAULT : N/A
+    !   N/A       : No information (do not create routing "TRN" files).
+    !   v1        : Outlet locations file produced manually by Randy Koster.
+    !   v2        : Outlet locations file produced by run_routing_raster.py using routing information encoded 
+    !               in SRTM-based Pfafstetter catchments and Greenland outlets info provided by Lauren Andrews.
+
     implicit none
 
     character(*), intent (in) :: LBCSV     ! land BCs version