From 73df9251b34a7c06ad7fd2e5798c4f9c01dec2e9 Mon Sep 17 00:00:00 2001
From: Michael Barlage <michael.barlage@noaa.gov>
Date: Thu, 15 Dec 2022 13:12:36 -0700
Subject: [PATCH] Add processing of soil color to sfc_climo_gen (#721)

Update the sfc_climo_gen source code and script to process
new CLM soil color data.

Update the associated 'readthedocs' documentation.

Fixes #720.
---
 docs/source/ufs_utils.rst               |  3 +++
 sorc/sfc_climo_gen.fd/driver.F90        | 10 ++++++++++
 sorc/sfc_climo_gen.fd/interp.F90        | 15 ++++++++++++---
 sorc/sfc_climo_gen.fd/output.f90        |  3 +++
 sorc/sfc_climo_gen.fd/program_setup.f90 |  3 ++-
 sorc/sfc_climo_gen.fd/search.f90        |  2 ++
 ush/sfc_climo_gen.sh                    |  1 +
 7 files changed, 33 insertions(+), 4 deletions(-)

diff --git a/docs/source/ufs_utils.rst b/docs/source/ufs_utils.rst
index 6ae0ae5ae..48515443d 100644
--- a/docs/source/ufs_utils.rst
+++ b/docs/source/ufs_utils.rst
@@ -502,6 +502,7 @@ Program execution is controlled via a namelist.  The namelist variables are:
       * input_snowfree_albedo_file - path/name of input snow-free albedo data
       * input_slope_type_file - path/name of input global slope type data
       * input_soil_type_file - path/name of input soil type data
+      * input_soil_color_file - path/name of input soil color data
       * input_vegetation_type_file - path/name of vegetation type data
       * input_vegetation_greenness_file - path/name of monthly vegetation greenness data
       * mosaic_file_mdl - path/name of the model mosaic file
@@ -524,6 +525,7 @@ The surface climatological data is located here `./fix/fix_sfc_climo <https://no
       * Global 2.6 x 1.5-degree soil substrate temperature - substrate_temperature.2.6x1.5.nc
       * Global 0.05-degree four component monthly snow-free albedo - snowfree_albedo.4comp.0.05.nc
       * Global 1.0-degree categorical slope type - slope_type.1.0.nc
+      * Global 0.05-degree CLM soil color (Lawrence and Chase, 2007 JGR) - soil_color.clm.0.05.nc
       * Categorical STATSGO soil type
              * Global 0.05-degree - soil_type.statsgo.0.05.nc
              * Global 0.03-degree - soil_type.statsgo.0.03.nc
@@ -562,6 +564,7 @@ All files with and without halo (all NetCDF).
       * Snow free albedo - CRES_snowfree_albedo.tile#.halo#.nc
       * Slope type - CRES_slope_type.tile#.halo#.nc
       * Soil type - CRES_soil_type.tile#.halo#.nc
+      * Soil color - CRES_soil_color.tile#.halo#.nc
       * Vegetation type - CRES_vegetation_type.tile#.halo#.nc
       * Vegetation greenness - CRES_vegetation_greenness.tile#.halo#.nc
 
diff --git a/sorc/sfc_climo_gen.fd/driver.F90 b/sorc/sfc_climo_gen.fd/driver.F90
index 4f05d974a..60014fda9 100644
--- a/sorc/sfc_climo_gen.fd/driver.F90
+++ b/sorc/sfc_climo_gen.fd/driver.F90
@@ -141,6 +141,16 @@ program driver
    call source_grid_cleanup
  endif
 
+! Soil color
+
+ if (trim(input_soil_color_file) /= "NULL") then
+   call define_source_grid(localpet, npets, input_soil_color_file)
+   method=ESMF_REGRIDMETHOD_NEAREST_STOD
+   call interp(localpet, method, input_soil_color_file)
+   call source_grid_cleanup
+ endif
+
+
 ! Vegetation greenness
 
  if (trim(input_vegetation_greenness_file) /= "NULL") then
diff --git a/sorc/sfc_climo_gen.fd/interp.F90 b/sorc/sfc_climo_gen.fd/interp.F90
index 628e67c66..af374478f 100644
--- a/sorc/sfc_climo_gen.fd/interp.F90
+++ b/sorc/sfc_climo_gen.fd/interp.F90
@@ -188,7 +188,7 @@ subroutine interp(localpet, method, input_file)
 ! These fields are adjusted at landice.
 
    select case (trim(field_names(n)))
-     case ('substrate_temperature','vegetation_greenness','leaf_area_index','slope_type','soil_type')
+     case ('substrate_temperature','vegetation_greenness','leaf_area_index','slope_type','soil_type','soil_color')
      if (localpet == 0) then
        allocate(vegt_mdl_one_tile(i_mdl,j_mdl))
      else
@@ -219,7 +219,7 @@ subroutine interp(localpet, method, input_file)
         call error_handler("IN FieldGather.", rc)
 
      select case (trim(field_names(n)))
-       case ('substrate_temperature','vegetation_greenness','leaf_area_index','slope_type','soil_type')
+       case ('substrate_temperature','vegetation_greenness','leaf_area_index','slope_type','soil_type','soil_color')
          print*,"- CALL FieldGather FOR MODEL GRID VEG TYPE."
          call ESMF_FieldGather(vegt_field_mdl, vegt_mdl_one_tile, rootPet=0, tile=tile, rc=rc)
          if(ESMF_logFoundError(rcToCheck=rc,msg=ESMF_LOGERR_PASSTHRU,line=__LINE__,file=__FILE__)) &
@@ -230,7 +230,7 @@ subroutine interp(localpet, method, input_file)
        print*,'- CALL SEARCH FOR TILE ',tile
        call search (data_mdl_one_tile, mask_mdl_one_tile, i_mdl, j_mdl, tile, field_names(n))
        select case (field_names(n))
-         case ('substrate_temperature','vegetation_greenness','leaf_area_index','slope_type','soil_type')
+         case ('substrate_temperature','vegetation_greenness','leaf_area_index','slope_type','soil_type','soil_color')
            call adjust_for_landice (data_mdl_one_tile, vegt_mdl_one_tile, i_mdl, j_mdl, field_names(n))
        end select
        where(mask_mdl_one_tile == 0) data_mdl_one_tile = missing
@@ -344,6 +344,15 @@ subroutine adjust_for_landice(field, vegt, idim, jdim, field_ch)
        endif
      enddo
      enddo
+   case ('soil_color') ! soil color
+     landice_value = 10.0
+     do j = 1, jdim
+     do i = 1, idim
+       if (nint(vegt(i,j)) == landice) then
+         field(i,j) = landice_value
+       endif
+     enddo
+     enddo
    case default
      print*,'- FATAL ERROR IN ROUTINE ADJUST_FOR_LANDICE.  UNIDENTIFIED FIELD : ', field_ch
      call mpi_abort(mpi_comm_world, 57, ierr)
diff --git a/sorc/sfc_climo_gen.fd/output.f90 b/sorc/sfc_climo_gen.fd/output.f90
index 7a61c9123..7df8c18b7 100644
--- a/sorc/sfc_climo_gen.fd/output.f90
+++ b/sorc/sfc_climo_gen.fd/output.f90
@@ -72,6 +72,9 @@ subroutine output(data_one_tile, lat_one_tile, lon_one_tile, i_mdl, j_mdl, &
    case ('soil_type')
      out_file = "./soil_type." // grid_tiles(tile) // ".nc"
      out_file_with_halo = "./soil_type." // grid_tiles(tile) // ".halo.nc"
+   case ('soil_color')
+     out_file = "./soil_color." // grid_tiles(tile) // ".nc"
+     out_file_with_halo = "./soil_color." // grid_tiles(tile) // ".halo.nc"
    case ('vegetation_type')
      out_file = "./vegetation_type." // grid_tiles(tile) // ".nc"
      out_file_with_halo = "./vegetation_type." // grid_tiles(tile) // ".halo.nc"
diff --git a/sorc/sfc_climo_gen.fd/program_setup.f90 b/sorc/sfc_climo_gen.fd/program_setup.f90
index a5c59b901..608befd03 100644
--- a/sorc/sfc_climo_gen.fd/program_setup.f90
+++ b/sorc/sfc_climo_gen.fd/program_setup.f90
@@ -29,6 +29,7 @@ module program_setup
  character(len=500), public   :: input_snowfree_albedo_file = "NULL" !< File containing input snow-free albedo data.
  character(len=500), public   :: input_slope_type_file = "NULL" !< File containing input slope type data.
  character(len=500), public   :: input_soil_type_file = "NULL" !< File containing input soil type data.
+ character(len=500), public   :: input_soil_color_file = "NULL" !< File containing input soil color data.
  character(len=500), public   :: input_vegetation_type_file = "NULL" !< File containing input vegetation type data.
  character(len=500), public   :: input_vegetation_greenness_file = "NULL" !< File containing input vegetation greenness data.
  character(len=500), public   :: mosaic_file_mdl = "NULL" !< Model grid mosaic file.
@@ -63,7 +64,7 @@ subroutine read_setup_namelist(localpet)
 
  namelist /config/ input_facsf_file, input_substrate_temperature_file, &
                    input_maximum_snow_albedo_file, input_snowfree_albedo_file, &
-                   input_slope_type_file, input_soil_type_file, &
+                   input_slope_type_file, input_soil_type_file, input_soil_color_file,&
                    input_leaf_area_index_file, input_vegetation_type_file, &
                    input_vegetation_greenness_file, mosaic_file_mdl, &
                    orog_dir_mdl, orog_files_mdl, halo, &
diff --git a/sorc/sfc_climo_gen.fd/search.f90 b/sorc/sfc_climo_gen.fd/search.f90
index ea3faef2a..d5b44ebe6 100644
--- a/sorc/sfc_climo_gen.fd/search.f90
+++ b/sorc/sfc_climo_gen.fd/search.f90
@@ -71,6 +71,8 @@ subroutine search (field, mask, idim, jdim, tile, field_name)
      default_value = float(1)
    case ('soil_type') ! soil type
      default_value = float(2)
+   case ('soil_color') ! soil color
+     default_value = float(4)
    case ('vegetation_type') ! vegetation type
      default_value = float(3)
    case default
diff --git a/ush/sfc_climo_gen.sh b/ush/sfc_climo_gen.sh
index f3113122f..43d601c32 100755
--- a/ush/sfc_climo_gen.sh
+++ b/ush/sfc_climo_gen.sh
@@ -70,6 +70,7 @@ input_maximum_snow_albedo_file="${input_sfc_climo_dir}/maximum_snow_albedo.0.05.
 input_snowfree_albedo_file="${input_sfc_climo_dir}/snowfree_albedo.4comp.0.05.nc"
 input_slope_type_file="${input_sfc_climo_dir}/slope_type.1.0.nc"
 input_soil_type_file="${SOIL_TYPE_FILE}"
+input_soil_color_file="${input_sfc_climo_dir}/soil_color.clm.0.05.nc"
 input_vegetation_type_file="${VEG_TYPE_FILE}"
 input_vegetation_greenness_file="${input_sfc_climo_dir}/vegetation_greenness.0.144.nc"
 mosaic_file_mdl="$mosaic_file"