Add SPP to the SRW App

ush/config_defaults.sh

@@ -1505,6 +1505,7 @@ FIXgsm_FILES_TO_COPY_TO_FIXam=( \
 "global_zorclim.1x1.grb" \
 "global_sfc_emissivity_idx.txt" \
 "global_solarconstant_noaa_an.txt" \
+"global_albedo4.1x1.grb" \
 "geo_em.d01.lat-lon.2.5m.HGT_M.nc" \
 "HGT.Beljaars_filtered.lat-lon.30s_res.nc" \
 "replace_with_FIXgsm_ozone_prodloss_filename" \
@@ -1555,6 +1556,7 @@ CYCLEDIR_LINKS_TO_FIXam_FILES_MAPPING=( \
 "co2historicaldata_glob.txt | global_co2historicaldata_glob.txt" \
 "co2monthlycyc.txt          | co2monthlycyc.txt" \
 "global_h2oprdlos.f77       | global_h2o_pltc.f77" \
+"global_albedo4.1x1.grb     | global_albedo4.1x1.grb" \
 "global_zorclim.1x1.grb     | global_zorclim.1x1.grb" \
 "sfc_emissivity_idx.txt     | global_sfc_emissivity_idx.txt" \
 "solarconstant_noaa_an.txt  | global_solarconstant_noaa_an.txt" \
@@ -1808,27 +1810,63 @@ USE_ZMTNBLCK="FALSE"
 #
 #-----------------------------------------------------------------------
 #
-# Set default SPP stochastic physics options.
-# Each SPP option is an array, applicable (in order) to the scheme/parameter
-# listed in SPP_VAR_LIST. Enter each value of the array in config.sh as 
-# shown below without commas or single quotes (e.g., SPP_VAR_LIST=
-# ( "pbl" "lsm" "mp" ). Both commas and single quotes will be added by
-# Jinja when creating the namelist.
+# Set default SPP stochastic physics options. Each SPP option is an array, 
+# applicable (in order) to the scheme/parameter listed in SPP_VAR_LIST. 
+# Enter each value of the array in config.sh as shown below without commas
+# or single quotes (e.g., SPP_VAR_LIST=( "pbl" "sfc" "mp" "rad" "gwd" ). 
+# Both commas and single quotes will be added by Jinja when creating the
+# namelist.
 #
 # Note that SPP is currently only available for specific physics schemes 
 # used in the RAP/HRRR physics suite.  Users need to be aware of which SDF
 # is chosen when turning this option on. 
 #
+# Patterns evolve and are applied at each time step.
+#
 #-----------------------------------------------------------------------
 #
-DO_SPP="FALSE"
-SPP_VAR_LIST=( "pbl" )
-SPP_MAG_LIST=( "0.2" ) #Variable "spp_prt_list" in input.nml
-SPP_LSCALE=( "150000.0" )
-SPP_TSCALE=( "21600.0" ) #Variable "spp_tau" in input.nml
-SPP_SIGTOP1=( "0.1" )
-SPP_SIGTOP2=( "0.025" )
-SPP_STDDEV_CUTOFF=( "1.5" )
+DO_SPP="false"
+SPP_VAR_LIST=( "pbl" "sfc" "mp" "rad" "gwd" )
+SPP_MAG_LIST=( "0.2" "0.2" "0.75" "0.2" "0.2" ) #Variable "spp_prt_list" in input.nml
+SPP_LSCALE=( "150000.0" "150000.0" "150000.0" "150000.0" "150000.0" )
+SPP_TSCALE=( "21600.0" "21600.0" "21600.0" "21600.0" "21600.0" ) #Variable "spp_tau" in input.nml
+SPP_SIGTOP1=( "0.1" "0.1" "0.1" "0.1" "0.1")
+SPP_SIGTOP2=( "0.025" "0.025" "0.025" "0.025" "0.025" )
+SPP_STDDEV_CUTOFF=( "1.5" "1.5" "2.5" "1.5" "1.5" )
+ISEED_SPP=( "4" "4" "4" "4" "4" )
+#
+#-----------------------------------------------------------------------
+#
+# Turn on SPP in Noah or RUC LSM (support for Noah MP is in progress).
+# Please be aware of the SDF that you choose if you wish to turn on LSM
+# SPP.
+#
+# SPP in LSM schemes is handled in the &nam_sfcperts namelist block 
+# instead of in &nam_sppperts, where all other SPP is implemented.
+#
+# The default perturbation frequency is determined by the fhcyc namelist 
+# entry.  Since that parameter is set to zero in the SRW App, use 
+# LSM_SPP_EACH_STEP to perturb every time step. 
+#
+# Perturbations to soil moisture content (SMC) are only applied at the 
+# first time step.
+#
+# LSM perturbations include SMC - soil moisture content (volume fraction),
+# VGF - vegetation fraction, ALB - albedo, SAL - salinity, 
+# EMI - emissivity, ZOL - surface roughness (cm), and STC - soil temperature.
+#
+# Only six perturbations at a time can be applied currently, but all seven
+# are shown below.  In addition, only five unique iseed values are allowed 
+# at the moment.  Therefore, if the iseeds are set to unique values (instead of
+# a single value), only five perturbations can be applied.
+#
+DO_LSM_SPP="false" #If true, sets lndp_type=2
+LSM_SPP_TSCALE=( "21600" "21600" "21600" "21600" "21600" "21600" "21600" )
+LSM_SPP_LSCALE=( "150000" "150000" "150000" "150000" "150000" "150000" "150000" )
+ISEED_LSM_SPP=( "9" "9" "9" "9" "9" "9" "9" )
+LSM_SPP_VAR_LIST=( "smc" "vgf" "alb" "sal" "emi" "zol" "stc" )
+LSM_SPP_MAG_LIST=( "0.2" "0.001" "0.001" "0.001" "0.001" "0.001" "0.2" )
+LSM_SPP_EACH_STEP="true" #Sets lndp_each_step=.true.
 #
 #-----------------------------------------------------------------------
 # 
@@ -1936,3 +1974,6 @@ OMP_STACKSIZE_RUN_FCST="1024m"
 KMP_AFFINITY_RUN_POST="scatter"
 OMP_NUM_THREADS_RUN_POST="1"
 OMP_STACKSIZE_RUN_POST="1024m"
+#
+#-----------------------------------------------------------------------
+#

ush/generate_FV3LAM_wflow.sh

@@ -770,6 +770,12 @@ settings="\
     'do_shum': ${DO_SHUM},
     'do_sppt': ${DO_SPPT},
     'do_skeb': ${DO_SKEB},
+    'do_spp': ${DO_SPP},
+    'n_var_spp': ${N_VAR_SPP},
+    'n_var_lndp': ${N_VAR_LNDP},
+    'lndp_type': ${LNDP_TYPE},
+    'lndp_each_step': ${LSM_SPP_EACH_STEP},
+    'fhcyc': ${FHCYC_LSM_SPP_OR_NOT}, 
   }
 'nam_stochy': {
     'shum': ${SHUM_MAG},
@@ -841,7 +847,42 @@ done
 #
 settings="$settings
   }"
-
+#
+# Add the relevant SPP namelist variables to "settings" when running with 
+# SPP turned on.  Otherwise only include an empty "nam_sppperts" stanza.
+#
+settings="$settings
+'nam_sppperts': {"
+if [ "${DO_SPP}" = "TRUE" ]; then 
+settings="$settings
+    'iseed_spp': [ $( printf "%s, " "${ISEED_SPP[@]}" ) ],
+    'spp_lscale': [ $( printf "%s, " "${SPP_LSCALE[@]}" ) ],
+    'spp_prt_list': [ $( printf "%s, " "${SPP_MAG_LIST[@]}" ) ],
+    'spp_sigtop1': [ $( printf "%s, " "${SPP_SIGTOP1[@]}" ) ],
+    'spp_sigtop2': [ $( printf "%s, " "${SPP_SIGTOP2[@]}" ) ],
+    'spp_stddev_cutoff': [ $( printf "%s, " "${SPP_STDDEV_CUTOFF[@]}" ) ],
+    'spp_tau': [ $( printf "%s, " "${SPP_TSCALE[@]}" ) ],
+    'spp_var_list': [ $( printf "%s, " "${SPP_VAR_LIST[@]}" ) ],"
+fi
+settings="$settings
+  }"
+#
+# Add the relevant LSM SPP namelist variables to "settings" when running with 
+# LSM SPP turned on.
+#
+settings="$settings
+'nam_sfcperts': {"
+if [ "${DO_LSM_SPP}" = "TRUE" ]; then 
+settings="$settings
+    'lndp_type': ${LNDP_TYPE},
+    'lndp_tau': [ $( printf "%s, " "${LSM_SPP_TSCALE[@]}" ) ],
+    'lndp_lscale': [ $( printf "%s, " "${LSM_SPP_LSCALE[@]}" ) ],
+    'iseed_lndp': [ $( printf "%s, " "${ISEED_LSM_SPP[@]}" ) ],
+    'lndp_var_list': [ $( printf "%s, " "${LSM_SPP_VAR_LIST[@]}" ) ],
+    'lndp_prt_list': [ $( printf "%s, " "${LSM_SPP_MAG_LIST[@]}" ) ],"
+fi
+settings="$settings
+  }"
 print_info_msg $VERBOSE "
 The variable \"settings\" specifying values of the weather model's 
 namelist variables has been set as follows:

ush/set_FV3nml_stoch_params.sh

@@ -80,6 +80,9 @@ function set_FV3nml_stoch_params() {
         iseed_skeb \
         iseed_sppt \
         iseed_spp \
+        iseed_lsm_spp \
+        num_iseed_spp \
+        num_iseed_lsm_spp \
         settings
 #
 #-----------------------------------------------------------------------
@@ -98,16 +101,28 @@ function set_FV3nml_stoch_params() {
   iseed_shum=$(( cdate*1000 + ensmem_num*10 + 2 ))
   iseed_skeb=$(( cdate*1000 + ensmem_num*10 + 3 ))
   iseed_sppt=$(( cdate*1000 + ensmem_num*10 + 1 ))
-  iseed_spp=$(( cdate*1000 + ensmem_num*10 + 4 ))
+
+  num_iseed_spp=${#ISEED_SPP[@]}
+  for (( i=0; i<${num_iseed_spp}; i++ )); do
+    iseed_spp[$i]=$(( cdate*1000 + ensmem_num*10 + ${ISEED_SPP[$i]} ))
+  done
+
+  num_iseed_lsm_spp=${#ISEED_LSM_SPP[@]}
+  for (( i=0; i<${num_iseed_lsm_spp}; i++ )); do
+    iseed_lsm_spp[$i]=$(( cdate*1000 + ensmem_num*10 + ${ISEED_LSM_SPP[$i]} ))
+  done
 
   settings="\
 'nam_stochy': {
   'iseed_shum': ${iseed_shum},
   'iseed_skeb': ${iseed_skeb},
   'iseed_sppt': ${iseed_sppt},
   }
-'nam_spperts': {
-  'iseed_spp': ${iseed_spp},
+'nam_sppperts': {
+  'iseed_spp': [ $( printf "%s, " "${iseed_spp[@]}" ) ]
+  }
+'nam_sfcperts': {
+  'iseed_lndp': [ $( printf "%s, " "${iseed_lsm_spp[@]}" ) ]
   }"
 
   $USHDIR/set_namelist.py -q \

ush/setup.sh

@@ -204,6 +204,9 @@ DO_SKEB=$(boolify $DO_SKEB)
 
 check_var_valid_value "DO_SPP" "valid_vals_DO_SPP"
 DO_SPP=$(boolify $DO_SPP)
+
+check_var_valid_value "DO_LSM_SPP" "valid_vals_DO_LSM_SPP"
+DO_LSM_SPP=$(boolify $DO_LSM_SPP)
 #
 #-----------------------------------------------------------------------
 #
@@ -239,6 +242,71 @@ fi
 #
 #-----------------------------------------------------------------------
 #
+# If running with LSM SPP, count the number of entries in LSM_SPP_VAR_LIST
+# to correctly set N_VAR_LNDP, otherwise set it to zero.  Also set 
+# LNDP_TYPE to 2 for LSM SPP, otherwise set it to zero.  Finally, initialize
+# an "FHCYC_LSM_SPP" variable to 0 and set it to 999 if LSM SPP is turned
+# on.  This requirement is necessary since LSM SPP cannot run with 
+# FHCYC=0 at the moment, but FHCYC cannot be set to anything less than the
+# length of the forecast either.  A bug fix will be issued ufs-weather-model 
+# soon, at which point, this requirement can be removed from regional_workflow. 
+#
+#-----------------------------------------------------------------------
+#
+N_VAR_LNDP=0
+LNDP_TYPE=0
+FHCYC_LSM_SPP_OR_NOT=0
+if [ "${DO_LSM_SPP}" = "TRUE" ]; then
+  N_VAR_LNDP=${#LSM_SPP_VAR_LIST[@]}
+  LNDP_TYPE=2
+  FHCYC_LSM_SPP_OR_NOT=999
+fi
+#
+#-----------------------------------------------------------------------
+#
+# If running with SPP, confirm that each SPP-related namelist value 
+# contains the same number of entries as N_VAR_SPP (set above to be equal
+# to the number of entries in SPP_VAR_LIST).
+#
+#-----------------------------------------------------------------------
+#
+if [ "${DO_SPP}" = "TRUE" ]; then
+  if [ "${#SPP_MAG_LIST[@]}" != "${N_VAR_SPP}" ] || \
+     [ "${#SPP_LSCALE[@]}" != "${N_VAR_SPP}" ] || \
+     [ "${#SPP_TSCALE[@]}" != "${N_VAR_SPP}" ] || \
+     [ "${#SPP_SIGTOP1[@]}" != "${N_VAR_SPP}" ] || \
+     [ "${#SPP_SIGTOP2[@]}" != "${N_VAR_SPP}" ] || \
+     [ "${#SPP_STDDEV_CUTOFF[@]}" != "${N_VAR_SPP}" ] || \
+     [ "${#ISEED_SPP[@]}" != "${N_VAR_SPP}" ]; then
+  print_err_msg_exit "\
+All SPP-related namelist variables set in config.sh must be equal in number
+of entries to what is found in SPP_VAR_LIST:
+  Number of entries in SPP_VAR_LIST = \"${#SPP_VAR_LIST[@]}\""
+  fi
+fi
+#
+#-----------------------------------------------------------------------
+#
+# If running with LSM SPP, confirm that each LSM SPP-related namelist
+# value contains the same number of entries as N_VAR_LNDP (set above to
+# be equal to the number of entries in LSM_SPP_VAR_LIST).
+#
+#-----------------------------------------------------------------------
+#
+if [ "${DO_LSM_SPP}" = "TRUE" ]; then
+  if [ "${#LSM_SPP_MAG_LIST[@]}" != "${N_VAR_LNDP}" ] || \
+     [ "${#LSM_SPP_LSCALE[@]}" != "${N_VAR_LNDP}" ] || \
+     [ "${#LSM_SPP_TSCALE[@]}" != "${N_VAR_LNDP}" ] || \
+     [ "${#ISEED_LSM_SPP[@]}" != "${N_VAR_LNDP}" ]; then
+  print_err_msg_exit "\
+All SPP-related namelist variables set in config.sh must be equal in number
+of entries to what is found in SPP_VAR_LIST:
+  Number of entries in SPP_VAR_LIST = \"${#SPP_VAR_LIST[@]}\""
+  fi
+fi
+#
+#-----------------------------------------------------------------------
+#
 check_var_valid_value "SUB_HOURLY_POST" "valid_vals_SUB_HOURLY_POST"
 SUB_HOURLY_POST=$(boolify $SUB_HOURLY_POST)
 #

ush/templates/diag_table.FV3_CPT_v0

@@ -275,7 +275,6 @@
 "gfs_phys",    "sppt_wts",      "sppt_wts",      "fv3_history",  "all", .false., "none", 2
 "gfs_phys",    "skebu_wts",     "skebu_wts",     "fv3_history",  "all", .false., "none", 2
 "gfs_phys",    "skebv_wts",     "skebv_wts",     "fv3_history",  "all", .false., "none", 2
-"dynamics",    "diss_est",      "diss_est",      "fv3_history",  "all", .false., "none", 2
 "gfs_phys",    "shum_wts",      "shum_wts",      "fv3_history",  "all", .false., "none", 2
 #=============================================================================================
 #

ush/templates/diag_table.FV3_GFS_2017_gfdlmp

@@ -274,7 +274,6 @@
 "gfs_phys",    "sppt_wts",      "sppt_wts",      "fv3_history",  "all", .false., "none", 2
 "gfs_phys",    "skebu_wts",     "skebu_wts",     "fv3_history",  "all", .false., "none", 2
 "gfs_phys",    "skebv_wts",     "skebv_wts",     "fv3_history",  "all", .false., "none", 2
-"dynamics",    "diss_est",      "diss_est",      "fv3_history",  "all", .false., "none", 2
 "gfs_phys",    "shum_wts",      "shum_wts",      "fv3_history",  "all", .false., "none", 2
 #=============================================================================================
 #

ush/templates/diag_table.FV3_GFS_v15p2

@@ -274,7 +274,6 @@
 "gfs_phys",    "sppt_wts",      "sppt_wts",      "fv3_history",  "all", .false., "none", 2
 "gfs_phys",    "skebu_wts",     "skebu_wts",     "fv3_history",  "all", .false., "none", 2
 "gfs_phys",    "skebv_wts",     "skebv_wts",     "fv3_history",  "all", .false., "none", 2
-"dynamics",    "diss_est",      "diss_est",      "fv3_history",  "all", .false., "none", 2
 "gfs_phys",    "shum_wts",      "shum_wts",      "fv3_history",  "all", .false., "none", 2
 
 #=============================================================================================

ush/templates/diag_table.FV3_GFS_v16

@@ -274,7 +274,6 @@
 "gfs_phys",    "sppt_wts",      "sppt_wts",      "fv3_history",  "all", .false., "none", 2
 "gfs_phys",    "skebu_wts",     "skebu_wts",     "fv3_history",  "all", .false., "none", 2
 "gfs_phys",    "skebv_wts",     "skebv_wts",     "fv3_history",  "all", .false., "none", 2
-"dynamics",    "diss_est",      "diss_est",      "fv3_history",  "all", .false., "none", 2
 "gfs_phys",    "shum_wts",      "shum_wts",      "fv3_history",  "all", .false., "none", 2
 
 #=============================================================================================

ush/templates/diag_table.FV3_HRRR

@@ -324,8 +324,12 @@
 "gfs_phys",    "sppt_wts",      "sppt_wts",      "fv3_history",  "all", .false., "none", 2
 "gfs_phys",    "skebu_wts",     "skebu_wts",     "fv3_history",  "all", .false., "none", 2
 "gfs_phys",    "skebv_wts",     "skebv_wts",     "fv3_history",  "all", .false., "none", 2
-"dynamics",    "diss_est",      "diss_est",      "fv3_history",  "all", .false., "none", 2
 "gfs_phys",    "shum_wts",      "shum_wts",      "fv3_history",  "all", .false., "none", 2
+"gfs_phys",    "spp_wts_pbl",   "spp_wts_pbl",   "fv3_history",  "all", .false., "none", 2
+"gfs_phys",    "spp_wts_sfc",   "spp_wts_sfc",   "fv3_history",  "all", .false., "none", 2
+"gfs_phys",    "spp_wts_mp",    "spp_wts_mp",    "fv3_history",  "all", .false., "none", 2
+"gfs_phys",    "spp_wts_rad",   "spp_wts_rad",   "fv3_history",  "all", .false., "none", 2
+"gfs_phys",    "spp_wts_gwd",   "spp_wts_gwd",   "fv3_history",  "all", .false., "none", 2
 
 #=============================================================================================
 #

ush/templates/diag_table.FV3_RRFS_v1alpha

@@ -305,6 +305,14 @@
 # Prognostic/diagnostic variables from RUC LSM
 "gfs_sfc",     "snowfall_acc",     "snowfall_acc",     "fv3_history2d",  "all",  .false.,  "none",  2
 "gfs_sfc",     "swe_snowfall_acc", "swe_snowfall_acc", "fv3_history2d",  "all",  .false.,  "none",  2
+# Stochastic physics
+"gfs_phys",    "sppt_wts",      "sppt_wts",      "fv3_history",  "all", .false., "none", 2
+"gfs_phys",    "skebu_wts",     "skebu_wts",     "fv3_history",  "all", .false., "none", 2
+"gfs_phys",    "skebv_wts",     "skebv_wts",     "fv3_history",  "all", .false., "none", 2
+"gfs_phys",    "shum_wts",      "shum_wts",      "fv3_history",  "all", .false., "none", 2
+"gfs_phys",    "spp_wts_pbl",   "spp_wts_pbl",   "fv3_history",  "all", .false., "none", 2
+"gfs_phys",    "spp_wts_mp",    "spp_wts_mp",    "fv3_history",  "all", .false., "none", 2
+"gfs_phys",    "spp_wts_rad",   "spp_wts_rad",   "fv3_history",  "all", .false., "none", 2
 
 #=============================================================================================
 #

ush/templates/diag_table.FV3_RRFS_v1beta

@@ -305,6 +305,15 @@
 # Prognostic/diagnostic variables from RUC LSM
 "gfs_sfc",     "snowfall_acc",     "snowfall_acc",     "fv3_history2d",  "all",  .false.,  "none",  2
 "gfs_sfc",     "swe_snowfall_acc", "swe_snowfall_acc", "fv3_history2d",  "all",  .false.,  "none",  2
+# Stochastic physics
+"gfs_phys",    "sppt_wts",      "sppt_wts",      "fv3_history",  "all", .false., "none", 2
+"gfs_phys",    "skebu_wts",     "skebu_wts",     "fv3_history",  "all", .false., "none", 2
+"gfs_phys",    "skebv_wts",     "skebv_wts",     "fv3_history",  "all", .false., "none", 2
+"gfs_phys",    "shum_wts",      "shum_wts",      "fv3_history",  "all", .false., "none", 2
+"gfs_phys",    "spp_wts_pbl",   "spp_wts_pbl",   "fv3_history",  "all", .false., "none", 2
+"gfs_phys",    "spp_wts_sfc",   "spp_wts_sfc",   "fv3_history",  "all", .false., "none", 2
+"gfs_phys",    "spp_wts_mp",    "spp_wts_mp",    "fv3_history",  "all", .false., "none", 2
+"gfs_phys",    "spp_wts_rad",   "spp_wts_rad",   "fv3_history",  "all", .false., "none", 2
 
 #=============================================================================================
 #

ush/templates/field_table.FV3_HRRR

@@ -33,7 +33,7 @@
  "TRACER", "atmos_mod", "water_nc"
            "longname",     "cloud liquid water number concentration"
            "units",        "/kg"
-       "profile_type", "fixed", "surface_value=1.e30" /
+       "profile_type", "fixed", "surface_value=0.0" /
 # prognostic cloud ice number concentration
  "TRACER", "atmos_mod", "ice_nc"
            "longname",     "cloud ice water number concentration"