Add documentation for version information in mk_runofftbl.f90 and add…

… version arg in make_bcs_latlon.py and make_bcs_cube.py
GEOS-ESM · Jun 21, 2024 · ecda649 · ecda649
1 parent 6b1395d
commit ecda649
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 5 deletions.
diff --git a/..._GridComp/GEOSphysics_GridComp/GEOSsurface_GridComp/Utils/Raster/makebcs/make_bcs_cube.py b/..._GridComp/GEOSphysics_GridComp/GEOSsurface_GridComp/Utils/Raster/makebcs/make_bcs_cube.py
@@ -53,7 +53,7 @@
       /bin/mv rst/Pfafstetter-M.rst rst/Pfafstetter.rst
       bin/CombineRasters.x -f 0 -t {NT} {OCEAN_VERSION}{DATENAME}{IMO}x{POLENAME}{JMO} Pfafstetter >/dev/null
       bin/CombineRasters.x -t {NT} CF{NC}x6C{SGNAME} {OCEAN_VERSION}{DATENAME}{IMO}x{POLENAME}{JMO}-Pfafstetter
-      bin/mk_runofftbl.x CF{NC}x6C{SGNAME}_{OCEAN_VERSION}{DATENAME}{IMO}x{POLENAME}{JMO}-Pfafstetter
+      bin/mk_runofftbl.x -g CF{NC}x6C{SGNAME}_{OCEAN_VERSION}{DATENAME}{IMO}x{POLENAME}{JMO}-Pfafstetter -v {lbcsv}
       setenv OMP_NUM_THREADS 1
       if ({SKIPLAND} != True) bin/mkCatchParam.x -x {NX} -y {NY} -g CF{NC}x6C{SGNAME}_{OCEAN_VERSION}{DATENAME}{IMO}x{POLENAME}{JMO}-Pfafstetter -v {lbcsv}
    endif

diff --git a/...ridComp/GEOSphysics_GridComp/GEOSsurface_GridComp/Utils/Raster/makebcs/make_bcs_latlon.py b/...ridComp/GEOSphysics_GridComp/GEOSsurface_GridComp/Utils/Raster/makebcs/make_bcs_latlon.py
@@ -41,7 +41,7 @@
     /bin/mv rst/Pfafstetter-M.rst rst/Pfafstetter.rst
     bin/CombineRasters.x -f 0 -t {NT} {DATENAME}{IMO}x{POLENAME}{JMO} Pfafstetter >/dev/null
     bin/CombineRasters.x -t {NT} DC{IM}xPC{JM} {DATENAME}{IMO}x{POLENAME}{JMO}-Pfafstetter
-    bin/mk_runofftbl.x DC{IM}xPC{JM}_{DATENAME}{IMO}x{POLENAME}{JMO}-Pfafstetter
+    bin/mk_runofftbl.x -g DC{IM}xPC{JM}_{DATENAME}{IMO}x{POLENAME}{JMO}-Pfafstetter -v {lbcsv}
     setenv OMP_NUM_THREADS 1
     if ( {SKIPLAND} != True ) bin/mkCatchParam.x -x {NX} -y {NY} -g DE{IMO}xPE{JMO}_DE{IMO}xPE{JMO}-Pfafstetter -v {lbcsv}
     setenv OMP_NUM_THREADS {NCPUS}

diff --git a/..._GridComp/GEOSphysics_GridComp/GEOSsurface_GridComp/Utils/Raster/makebcs/mk_runofftbl.F90 b/..._GridComp/GEOSphysics_GridComp/GEOSsurface_GridComp/Utils/Raster/makebcs/mk_runofftbl.F90
@@ -13,10 +13,20 @@ program mk_runofftbl
 ! This program generates the runoff table *.trn and *.TRN files that are used in the Catchment model for
 ! 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 created by [..]/Raster/preproc/routing/run_routing_raster.py.
+! outlets are located.  The latter file is either created by [..]/Raster/preproc/routing/run_routing_raster.py 
+! or from Randy's (Randal.d.koster@nasa.gov) old file under {MAKE_BCS_INPUT_DIR}/land/route/v1.
 ! 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 program currently works only for the MOM5 and MOM6 tripolar ocean grids.
+! by calling outlets_to_ocean() (only with bcs version v11, v12 or later) and then generates the runoff table files.
+! The program 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  (produced with Randy's old file, but do not move outlet locations to ocean)
+!=========================================================
 !  
 ! Yujin Zeng - June 17, 2024 
 ! Email: yujin.zeng@nasa.gov