Updated revised MM5 surface layer scheme with multiple options for similarity functions under stable and convective conditions

Registry/Registry.EM_COMMON

@@ -1050,6 +1050,10 @@ i1      real   PSIM           ij     misc        1         -     -         "PSIM
 i1      real   PSIH           ij     misc        1         -     -         "PSIH"                "SIMILARITY FUNCTION FOR HEAT"         ""
 state   real   FM             ij     misc        1         -     -         "FM"                  "INTEGRATED FUNCTION FOR MOMENTUM"     ""
 state   real   FH             ij     misc        1         -     -         "FH"                  "INTEGRATED FUNCTION FOR HEAT"         ""
+#$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$-Inserted by PN, MS, PS, and SKM-$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$     $$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
+state   real   FM_hat         ij     misc        1         -     -         "FM_HAT"              " "                                         ""
+state   real   FH_hat         ij     misc        1         -     -         "FH_HAT"               ""                                         ""
+#$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
 state   real   WSPD           ij     misc        1         -     -         "WSPD"                "Wind Speed At Lowest Model Level (may contain vconv)"           "m s-1"
 i1      real   GZ1OZ0         ij     misc        1         -     -         "GZ1OZ0"              "LOG OF Z1 over Z0"                     ""
 state   real   BR             ij     misc        1         -     -         "BR"                  "Bulk Richardson"                       ""
@@ -2656,6 +2660,10 @@ rconfig   integer isftcflx                namelist,physics      1            0
 rconfig   integer iz0tlnd                 namelist,physics      1            0         h     "iz0tlnd"    "switch to control land thermal roughness length"   ""
 rconfig   logical kim_tofd                namelist,physics      max_domains   .false.  rh    "kim_tofd"   "turbulent form drag (tofd) option for kim gravity wave drag"   ""
 rconfig   real    tofd_factor             namelist,physics      max_domains   .003     rh    "tofd_factor" "factor in  kim tofd scheme"   ""
+#!$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$-Inserted by PN, MS, PS, and SKM-$$$$$$$$$$$$$$$$$$$$$$$$$$$
+rconfig   integer psimh_stab_opt           namelist,physics      1            0         -     "psimh_stab_op     t"  "0: CB05, 1: GR07, 2: SR20, 3: GRY20, 4: H90, 5: BH91, 6: D91" ""
+rconfig   integer psimh_unstab_opt        namelist,physics      1             0        -     "psimh_unstab_o     pt"  "0: F96, 1: BD71, 2: CL73, 3: KY90 functions" "" 
+#$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
 rconfig   real    shadlen                 namelist,physics      1            25000.    -     "shadow_length" "maximum length of orographic shadow" "m"
 rconfig   integer slope_rad               namelist,physics      max_domains    0       -     "slope_rad"  "1: use slope-dependent radiation, 0:not" ""
 rconfig   integer topo_shading            namelist,physics      max_domains    0       -     "topo_shading" "1: apply topographic shading to radiation, 0:not" ""
@@ -3195,6 +3203,9 @@ package   gfssfcscheme       sf_sfclay_physics==3        -             -
 package   qnsesfcscheme      sf_sfclay_physics==4        -             state:u10e,v10e
 package   mynnsfcscheme      sf_sfclay_physics==5        -             -
 package   pxsfcscheme        sf_sfclay_physics==7        -             -
+#!$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$-Inserted by PN, MS, PS, and SKM-$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
+package   sfclayrev_IITD_scheme sf_sfclay_physics==8     -             -
+#$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
 package   temfsfcscheme      sf_sfclay_physics==10       -             state:wm_temf
 package   idealscmsfcscheme  sf_sfclay_physics==89       -             -
 package   sfclayscheme       sf_sfclay_physics==91       -             -

dyn_em/module_first_rk_step_part1.F

@@ -687,6 +687,10 @@ SUBROUTINE first_rk_step_part1 (   grid , config_flags              &
      &        ,USTM=grid%ustm          ,CK=grid%ck         ,CKA=grid%cka            &
      &                                 ,CD=grid%cd         ,CDA=grid%cda            &
      &        ,ISFTCFLX=config_flags%isftcflx, IZ0TLND=config_flags%iz0tlnd         &
+!$$$$$$$$$$$$$$$$$$$$-Inserted by PN, MS, PS, and SKM-$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
+     &        ,PSIMH_STAB_OPT=config_flags%psimh_stab_opt                           &
+     &        ,PSIMH_UNSTAB_OPT=config_flags%psimh_unstab_opt                       &
+!$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
      &        ,SF_OCEAN_PHYSICS=config_flags%sf_ocean_physics                       &
      &        ,OML_HML0=config_flags%oml_hml0 ,OML_GAMMA=config_flags%oml_gamma     &
      &        ,TML=grid%tml, T0ML=grid%t0ml, HML=grid%hml, H0ML=grid%h0ml           &
@@ -1128,6 +1132,9 @@ SUBROUTINE first_rk_step_part1 (   grid , config_flags              &
      &        ,spp_lsm=config_flags%spp_lsm,pattern_spp_lsm=grid%pattern_spp_lsm     & !SPP
      &        ,field_sf=grid%field_sf                                                & !SPP
      &        ,spp_pbl=config_flags%spp_pbl,pattern_spp_pbl=grid%pattern_spp_pbl     & !SPP
+!$$$$$$$$$$$$$$$$$$$$$$$$$$-Inserted by PN, MS, PS, and SKM-$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
+     &        ,FM_hat=grid%fm_hat, FH_hat=grid%fh_hat                                &
+!$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
   ! WRF-Solar EPS: Noah LSM
      &        ,multi_perturb=config_flags% multi_perturb                             & 
      &        ,pert_noah=config_flags%pert_noah                                      &

dyn_em/start_em.F

@@ -1296,6 +1296,10 @@ SUBROUTINE start_domain_em ( grid, allowed_to_read &
                       ,grid%NC_CU, grid%NI_CU, grid%NR_CU, grid%NS_CU,grid%CCN_CU                    &
                       ,grid%alevsiz_cu,grid%num_months,grid%no_src_types_cu,grid%aeromcu             &
                       ,grid%aeropcu,grid%EFCG,grid%EFCS,grid%EFIG,grid%EFIS,grid%EFSG,grid%EFSS      &
+!$$$$$$$$$$$$$$$$$$$$$$$$$$$$$-Inserted by PN, MS, PS, and SKM-$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
+                      ,grid%psimh_stab_opt                                                           &
+                      ,grid%psimh_unstab_opt                                                         &
+!$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
 #ifdef CDXWRF
                       ,grid%fracsoil10cm                                                             &
                       ,model_config_rec%londbg, model_config_rec%latdbg                              &

main/depend.common

@@ -2407,6 +2407,7 @@ module_physics_init.o: \
 	module_ra_flg.o \
 	module_sf_sfclay.o \
 	physics_mmm/sf_sfclayrev.o \
+        module_sf_sfclayrev_IITD.o \
 	module_sf_slab.o \
 	module_sf_myjsfc.o \
 	module_sf_mynnsfc_driver.o \
@@ -2696,6 +2697,7 @@ module_surface_driver.o: \
 	module_sf_noahlsm.o \
 	module_sf_sfclay.o \
 	module_sf_sfclayrev.o \
+        module_sf_sfclayrev_IITD.o \
 	module_sf_slab.o \
 	module_sf_myjsfc.o \
 	module_sf_qnsesfc.o \

phys/Makefile

@@ -148,6 +148,7 @@ MODULES = \
 	module_ra_farms.o  \
 	module_sf_sfclay.o \
 	module_sf_sfclayrev.o \
+        module_sf_sfclayrev_IITD.o \
 	module_sf_gfs.o \
 	module_sf_exchcoef.o \
 	module_sf_gfdl.o \

phys/module_fddagd_driver.F

@@ -508,7 +508,10 @@ SUBROUTINE fddagd_driver(itimestep,dt,xtime,                   &
            IF( config_flags%sf_sfclay_physics /= sfclayscheme &
          .AND. config_flags%sf_sfclay_physics /= mynnsfcscheme &
          .AND. config_flags%sf_sfclay_physics /= pxsfcscheme &
-         .AND. config_flags%sf_sfclay_physics /= sfclayrevscheme ) THEN
+         .AND. config_flags%sf_sfclay_physics /= sfclayrevscheme & 
+!$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$-Inserted by PN, MS, PS, and SKM-$$$$$$$$$$$$$$$$$$$$$$
+         .AND. config_flags%sf_sfclay_physics /= sfclayrev_IITD_scheme ) THEN
+!$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
              DO j=MAX(j_start(ij)-1,jds),j_end(ij)
              DO i=MAX(i_start(ij)-1,ids),i_end(ij)
                IF( pblh(i,j) > z_at_w(i,2,j)-ht(i,j) ) THEN

phys/module_fddaobs_driver.F

@@ -235,7 +235,10 @@ SUBROUTINE fddaobs_driver( inest, domid, parid, restart,         &
     IF( config_flags%sf_sfclay_physics /= sfclayscheme &
   .AND. config_flags%sf_sfclay_physics /= mynnsfcscheme &
   .AND. config_flags%sf_sfclay_physics /= pxsfcscheme &
-  .AND. config_flags%sf_sfclay_physics /= sfclayrevscheme ) THEN
+  .AND. config_flags%sf_sfclay_physics /= sfclayrevscheme &
+!$$$$$$$$$$$$$$$$$$$$$-Inserted by PN, MS, PS, and SKM-$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
+  .AND. config_flags%sf_sfclay_physics /= sfclayrev_IITD_scheme ) THEN
+!$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
       DO j = jts, jte
       DO i = its, ite
            IF( pblh(i,j) > z_at_w(i,2,j)-ht(i,j) ) THEN

phys/module_physics_init.F

@@ -280,6 +280,9 @@ SUBROUTINE phy_init ( id, config_flags, DT, restart, zfull, zhalf,     &
                          ,alevsiz_cu,num_months,no_src_types_cu,aeromcu,aeropcu   & ! PSH/TWG 06/10/16                         
                          ,EFCG,EFCS,EFIG,EFIS,EFSG,EFSS                           & ! TWG
 #endif
+!$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$-Inserted by PN, MS, PS, and SKM-$$$$$
+                         , psimh_stab_opt,psimh_unstab_opt                        &
+!$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
 #ifdef CDXWRF
                          ,fracsoil10cm                                            &
                          ,londbg, latdbg                                          &
@@ -442,6 +445,9 @@ SUBROUTINE phy_init ( id, config_flags, DT, restart, zfull, zhalf,     &
 
    INTEGER , INTENT(OUT) :: STEPRA, STEPBL, STEPCU
    INTEGER , INTENT(IN) :: JULYR, JULDAY
+!$$$$$$$$$$$$$$$$$$$$$$$$$$-Inserted by PN, MS, PS, and SKM-$$$$$$$$$$$$$$$
+   INTEGER , INTENT(IN) :: psimh_stab_opt, psimh_unstab_opt
+!$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
 
 ! cps
 
@@ -1664,6 +1670,9 @@ SUBROUTINE phy_init ( id, config_flags, DT, restart, zfull, zhalf,     &
                 ALBEDOsubgrid,LHsubgrid,HFXsubgrid,LWUPsubgrid,     &
                 Q2subgrid,SABVsubgrid,SABGsubgrid,NRAsubgrid,       &
                 SWUPsubgrid,lhsoi,lhveg,lhtran                      &
+!$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$-Inserted by PN, MS, PS, and SKM-$$$$$$$$$$$$$$$$$$$$
+                ,psimh_stab_opt,psimh_unstab_opt                    &
+!$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
 #if (WRF_USE_CLM == 1) && ( WRF_CHEM == 1)
                 ,megan_specifier, megan_factors_file                &
                 ,megan_mapped_emisfctrs                             &
@@ -2733,6 +2742,9 @@ SUBROUTINE bl_init(STEPBL,BLDT,DT,RUBLTEN,RVBLTEN,RTHBLTEN,  &
                 ALBEDOsubgrid,LHsubgrid,HFXsubgrid,LWUPsubgrid,     &
                 Q2subgrid,SABVsubgrid,SABGsubgrid,NRAsubgrid,       &
                 SWUPsubgrid,lhsoi,lhveg,lhtran                      &
+!$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$-Inserted by PN, MS, PS, and SKM-$$$$$$$$$$$$$$$$$$     $$$$$           
+                ,psimh_stab_opt, psimh_unstab_opt                   &
+!$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$     $$$$$
 #if (WRF_USE_CLM == 1) && ( WRF_CHEM == 1 )
                 ,megan_specifier, megan_factors_file     &
                 ,megan_mapped_emisfctrs                  &
@@ -2761,6 +2773,9 @@ SUBROUTINE bl_init(STEPBL,BLDT,DT,RUBLTEN,RVBLTEN,RTHBLTEN,  &
 !--------------------------------------------------------------------
    USE module_sf_sfclay
    USE sf_sfclayrev
+!$$$$$$$$$$$$$$$$$$$$$$$$-Inserted by PN, MS, PS, and SKM-$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
+   USE module_sf_sfclayrev_IITD
+!$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
    USE module_sf_slab
    USE module_sf_pxsfclay
    USE module_bl_ysu
@@ -3185,7 +3200,9 @@ SUBROUTINE bl_init(STEPBL,BLDT,DT,RUBLTEN,RVBLTEN,RTHBLTEN,  &
                                         TSK_SAVE
    LOGICAL,  INTENT(IN) :: start_of_simulation
    INTEGER :: i,j,patch
-
+!$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$-Inserted by PN, MS, PS, and SKM-$$$$$$$$$
+   INTEGER, INTENT(IN)  :: psimh_stab_opt, psimh_unstab_opt
+!$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
 ! CLM varaibles
    INTEGER , INTENT(IN)        ::     maxpatch
    REAL, OPTIONAL,    DIMENSION( ims:ime, jms:jme ), INTENT(IN)    ::  HT
@@ -3328,6 +3345,11 @@ SUBROUTINE bl_init(STEPBL,BLDT,DT,RUBLTEN,RVBLTEN,RTHBLTEN,  &
                         xland,LakeModel,lake_depth,lakemask   )
            END IF
            isfc = 1
+!$$$$$$$$$$$$$$$$$$$$$$$-Inserted PN, MS, PS, and SKM-$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
+      CASE (SFCLAYREV_IITD_SCHEME)
+           CALL sfclayrevinit_IITD(psimh_stab_opt,psimh_unstab_opt)
+           isfc = 1
+!$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$
       CASE (PXSFCSCHEME)
            CALL pxsfclayinit( allowed_to_read )
            isfc = 7