Langmuir turbulence parameterization improvements

model/src/w3adatmd.F90

@@ -174,6 +174,8 @@ MODULE W3ADATMD
   !      US3D      R.A.  Public   3D Stokes drift.
   !      USSP      R.A.  Public   Partitioned Surface Stokes drift
   !
+  !      USSHX/Y   R.A.  Public   Surface layer averaged Stokes drift.
+  !
   !      ABA       R.A.  Public   Near-bottom rms wave ex. amplitude.
   !      ABD       R.A.  Public   Corresponding direction.
   !      UBA       R.A.  Public   Near-bottom rms wave velocity.
@@ -461,9 +463,7 @@ MODULE W3ADATMD
          XPRMS(:), XTPMS(:), XPHICE(:),       &
          XTAUICE(:,:)
     REAL, POINTER         :: XP2SMS(:,:), XUS3D(:,:), XUSSP(:,:)
-#ifdef W3_CESMCOUPLED
-    REAL, POINTER         ::  XLANGMT(:)
-#endif
+    REAL, POINTER         :: XUSSHX(:), XUSSHY(:)
     !
     ! Output fields group 7)
     !
@@ -492,12 +492,8 @@ MODULE W3ADATMD
     !
     REAL, POINTER         ::  USERO(:,:)
     REAL, POINTER         :: XUSERO(:,:)
-#ifdef W3_CESMCOUPLED
-    ! Output fileds for Langmuir mixing in group
-    REAL, POINTER         :: LANGMT(:), LAPROJ(:), LASL(:),       &
-         LASLPJ(:), LAMULT(:), ALPHAL(:),     &
-         ALPHALS(:), USSXH(:), USSYH(:)
-#endif
+    ! Output fileds for Langmuir mixing parameterization
+    REAL, POINTER         :: USSHX(:), USSHY(:)
     !
     ! Spatial derivatives
     !
@@ -578,11 +574,8 @@ MODULE W3ADATMD
   !/
   !/ Data aliases for structure WADAT(S)
   !/
-#ifdef W3_CESMCOUPLED
-  REAL, POINTER           :: LANGMT(:), LAPROJ(:), ALPHAL(:),      &
-       ALPHALS(:), LAMULT(:), LASL(:),       &
-       LASLPJ(:), USSXH(:), USSYH(:)
-#endif
+  REAL, POINTER :: USSHX(:), USSHY(:)
+  !
   REAL, POINTER           :: CG(:,:), WN(:,:)
   REAL, POINTER           :: IC3WN_R(:,:), IC3WN_I(:,:), IC3CG(:,:)
   !
@@ -1064,19 +1057,6 @@ SUBROUTINE W3DIMA  ( IMOD, NDSE, NDST, D_ONLY )
          STAT=ISTAT )
     CHECK_ALLOC_STATUS ( ISTAT )
 
-#ifdef W3_CESMCOUPLED
-    ALLOCATE ( WADATS(IMOD)%USSXH(NSEALM)   , &
-         WADATS(IMOD)%USSYH(NSEALM)   , &
-         WADATS(IMOD)%LANGMT(NSEALM)  , &
-         WADATS(IMOD)%LAPROJ(NSEALM)  , &
-         WADATS(IMOD)%LASL(NSEALM)    , &
-         WADATS(IMOD)%LASLPJ(NSEALM)  , &
-         WADATS(IMOD)%ALPHAL(NSEALM)  , &
-         WADATS(IMOD)%ALPHALS(NSEALM) , &
-         WADATS(IMOD)%LAMULT(NSEALM)  , &
-         STAT=ISTAT )
-    CHECK_ALLOC_STATUS ( ISTAT )
-#endif
     !
     WADATS(IMOD)%HS     = UNDEF
     WADATS(IMOD)%WLM    = UNDEF
@@ -1226,6 +1206,8 @@ SUBROUTINE W3DIMA  ( IMOD, NDSE, NDST, D_ONLY )
          WADATS(IMOD)%TPMS  (NSEALM) ,                        &
          WADATS(IMOD)%PHICE (NSEALM) ,                        &
          WADATS(IMOD)%TAUICE(NSEALM,2),                       &
+         WADATS(IMOD)%USSHX(NSEALM),                          &
+         WADATS(IMOD)%USSHY(NSEALM),                          &
          STAT=ISTAT )
     CHECK_ALLOC_STATUS ( ISTAT )
     !
@@ -1262,9 +1244,8 @@ SUBROUTINE W3DIMA  ( IMOD, NDSE, NDST, D_ONLY )
     WADATS(IMOD)%TPMS   = UNDEF
     WADATS(IMOD)%PHICE  = UNDEF
     WADATS(IMOD)%TAUICE = UNDEF
-#ifdef W3_CESMCOUPLED
-    WADATS(IMOD)%LANGMT = UNDEF
-#endif
+    WADATS(IMOD)%USSHX  = UNDEF
+    WADATS(IMOD)%USSHY  = UNDEF
     IF (  P2MSF(1).GT.0 ) WADATS(IMOD)%P2SMS  = UNDEF
     IF (  US3DF(1).GT.0 ) WADATS(IMOD)%US3D   = UNDEF
     IF (  USSPF(1).GT.0 ) WADATS(IMOD)%USSP   = UNDEF
@@ -2180,15 +2161,17 @@ SUBROUTINE W3XDMA  ( IMOD, NDSE, NDST, OUTFLAGS )
       ALLOCATE ( WADATS(IMOD)%XTAUOCY(1), STAT=ISTAT )
       CHECK_ALLOC_STATUS ( ISTAT )
     END IF
-#ifdef W3_CESMCOUPLED
     IF ( OUTFLAGS( 6, 14) ) THEN
-      ALLOCATE ( WADATS(IMOD)%XLANGMT(NXXX), STAT=ISTAT )
+      ALLOCATE ( WADATS(IMOD)%XUSSHX(NXXX), STAT=ISTAT )
+      CHECK_ALLOC_STATUS ( ISTAT )
+      ALLOCATE ( WADATS(IMOD)%XUSSHY(NXXX), STAT=ISTAT )
       CHECK_ALLOC_STATUS ( ISTAT )
     ELSE
-      ALLOCATE ( WADATS(IMOD)%XLANGMT(1), STAT=ISTAT )
+      ALLOCATE ( WADATS(IMOD)%XUSSHX(1), STAT=ISTAT )
+      CHECK_ALLOC_STATUS ( ISTAT )
+      ALLOCATE ( WADATS(IMOD)%XUSSHY(1), STAT=ISTAT )
       CHECK_ALLOC_STATUS ( ISTAT )
     END IF
-#endif
     !
     WADATS(IMOD)%XSXX    = UNDEF
     WADATS(IMOD)%XSYY    = UNDEF
@@ -2210,9 +2193,8 @@ SUBROUTINE W3XDMA  ( IMOD, NDSE, NDST, OUTFLAGS )
     WADATS(IMOD)%XUSSP   = UNDEF
     WADATS(IMOD)%XTAUOCX = UNDEF
     WADATS(IMOD)%XTAUOCY = UNDEF
-#ifdef W3_CESMCOUPLED
-    WADATS(IMOD)%XLANGMT = UNDEF
-#endif
+    WADATS(IMOD)%XUSSHX   = UNDEF
+    WADATS(IMOD)%XUSSHY   = UNDEF
     !
     IF ( OUTFLAGS( 7, 1) ) THEN
       ALLOCATE ( WADATS(IMOD)%XABA(NXXX), STAT=ISTAT )
@@ -2946,18 +2928,8 @@ SUBROUTINE W3SETA ( IMOD, NDSE, NDST )
       USERO  => WADATS(IMOD)%USERO
       !
       WN     => WADATS(IMOD)%WN
-#ifdef W3_CESMCOUPLED
-      ! USSX and USSY are already set
-      LANGMT => WADATS(IMOD)%LANGMT
-      LAPROJ => WADATS(IMOD)%LAPROJ
-      LASL   => WADATS(IMOD)%LASL
-      LASLPJ => WADATS(IMOD)%LASLPJ
-      ALPHAL => WADATS(IMOD)%ALPHAL
-      ALPHALS=> WADATS(IMOD)%ALPHALS
-      USSXH  => WADATS(IMOD)%USSXH
-      USSYH  => WADATS(IMOD)%USSYH
-      LAMULT => WADATS(IMOD)%LAMULT
-#endif
+      USSHX  => WADATS(IMOD)%USSHX
+      USSHY  => WADATS(IMOD)%USSHY
 #ifdef W3_IC3
       IC3WN_R=> WADATS(IMOD)%IC3WN_R
       IC3WN_I=> WADATS(IMOD)%IC3WN_I
@@ -3279,9 +3251,6 @@ SUBROUTINE W3XETA ( IMOD, NDSE, NDST )
       BEDFORMS=> WADATS(IMOD)%XBEDFORMS
       PHIBBL => WADATS(IMOD)%XPHIBBL
       TAUBBL => WADATS(IMOD)%XTAUBBL
-#ifdef W3_CESMCOUPLED
-      LANGMT => WADATS(IMOD)%XLANGMT
-#endif
       !
       MSSX   => WADATS(IMOD)%XMSSX
       MSSY   => WADATS(IMOD)%XMSSY
@@ -3298,6 +3267,9 @@ SUBROUTINE W3XETA ( IMOD, NDSE, NDST )
       !
       USERO  => WADATS(IMOD)%XUSERO
       !
+      USSHX   => WADATS(IMOD)%XUSSHX
+      USSHY   => WADATS(IMOD)%XUSSHY
+      !
     END IF
     !
     RETURN

model/src/w3gdatmd.F90

@@ -728,6 +728,9 @@ MODULE W3GDATMD
 #ifdef W3_IS2
     REAL,    POINTER      :: IS2PARS(:)
 #endif
+    LOGICAL               :: LMPENABLED ! flag to enable Li et al. Langmuir parameterization
+    LOGICAL               :: SDTAIL ! flag to enable high-freq tail in Li et al. Stokes Drift computations
+    REAL                  :: HSLMODE ! 0 for test (HSL=10m everywhere, 1 for coupler-based HSL)
     !
     ! unstructured data
     !
@@ -1084,6 +1087,10 @@ MODULE W3GDATMD
   INTEGER, POINTER        :: NBEDGE
   INTEGER, POINTER        :: EDGES(:,:), NEIGH(:,:)
   !
+  LOGICAL, POINTER        :: LMPENABLED
+  LOGICAL, POINTER        :: SDTAIL
+  REAL, POINTER           :: HSLMODE
+  !
   ! Variables for unstructured grids
   !
   INTEGER, POINTER        :: NTRI,COUNTRI,COUNTOT,NNZ
@@ -2274,6 +2281,10 @@ SUBROUTINE W3SETG ( IMOD, NDSE, NDST )
     USSPF  => GRIDS(IMOD)%USSPF
     USSP_WN => GRIDS(IMOD)%USSP_WN
     FFACBERG => GRIDS(IMOD)%FFACBERG
+    !
+    LMPENABLED => GRIDS(IMOD)%LMPENABLED
+    SDTAIL => GRIDS(IMOD)%SDTAIL
+    HSLMODE => GRIDS(IMOD)%HSLMODE
 #ifdef W3_REF1
     REFLC  => GRIDS(IMOD)%REFLC
     REFLD  => GRIDS(IMOD)%REFLD

model/src/w3gridmd.F90

@@ -1105,6 +1105,7 @@ MODULE W3GRIDMD
        STH1MF, I1STH1M, I2STH1M,                &
        TH2MF, I1TH2M, I2TH2M,                   &
        STH2MF, I1STH2M, I2STH2M
+  NAMELIST /LMPN/ LMPENABLED, SDTAIL, HSLMODE
 #ifdef W3_IS1
   NAMELIST /SIS1/ ISC1, ISC2
 #endif
@@ -2731,6 +2732,11 @@ SUBROUTINE W3GRID()
     I2STH2M=NK
     !
     FACBERG=1.
+    !
+    LMPENABLED = .false.
+    SDTAIL = .false.
+    HSLMODE = 0   ! 0 for test (HSL=10m everywhere, 1 for coupler-based HSL)
+    !
 #ifdef W3_IS0
     WRITE (NDSO,944)
 #endif
@@ -2882,6 +2888,10 @@ SUBROUTINE W3GRID()
          IC5MAXKI, IC5MINHW, IC5MAXITER, IC5RKICK, &
          IC5KFILTER, IC5MSTR(NINT(IC5VEMOD))
 #endif
+    !
+    CALL READNL ( NDSS, 'LMPN', STATUS )
+    WRITE (NDSO,4960) STATUS
+    WRITE (NDSO,4961) LMPENABLED, SDTAIL, HSLMODE
     !
     CALL READNL ( NDSS, 'OUTS', STATUS )
     WRITE (NDSO,4970) STATUS
@@ -6673,7 +6683,11 @@ SUBROUTINE W3GRID()
          /'         (0.0==> no reduction and 1.0==> no wind', &
          /'         input with 100% ice cover)')
     !
-    !
+!
+4960 FORMAT (/'  Langmuir Mixing Parameterization ',A/                   &
+              ' --------------------------------------------------')
+4961 FORMAT ('  &LMPN LMPENABLED = ',L, 'SDTAIL = ', L, ' HSLMODE = ', I2 '/' )
+!
 4970 FORMAT (/'  Spectral output on full grid ',A/                   &
          ' --------------------------------------------------')
 4971 FORMAT ( '       Second order pressure at K=0:',3I4)
@@ -7344,6 +7358,8 @@ SUBROUTINE READNL ( NDS, NAME, STATUS )
                 READ (NDS,NML=UNST,END=801,ERR=802,IOSTAT=J)
               CASE('OUTS')
                 READ (NDS,NML=OUTS,END=801,ERR=802,IOSTAT=J)
+              CASE('LMPN')
+                READ (NDS,NML=LMPN,END=801,ERR=802,IOSTAT=J)
               CASE('MISC')
                 READ (NDS,NML=MISC,END=801,ERR=802,IOSTAT=J)
               CASE DEFAULT

model/src/w3idatmd.F90

@@ -94,9 +94,8 @@ MODULE W3IDATMD
   !      FLCUR     Log.  Public   Flag for current input.
   !      FLWIND    Log.  Public   Flag for wind input.
   !      FLICE     Log.  Public   Flag for ice input.
-#ifdef W3_CESMCOUPLED
-  !      HML       R.A.  Public   Mixed layer depth
-#endif
+  !      HSL       R.A.  Public   Depth of a surface layer over which Stokes
+  !                               drift is averaged
   !      FLTAUA    Log.  Public   Flag for atmospheric momentum input
   !      FLRHOA    Log.  Public   Flag for air density input
   !      INFLAGS1  L.A.  Public   Array consolidating the above six
@@ -219,9 +218,7 @@ MODULE W3IDATMD
     REAL, POINTER         :: CYTIDE(:,:,:,:)
     REAL, POINTER         :: WLTIDE(:,:,:,:)
 #endif
-#ifdef W3_CESMCOUPLED
-    REAL, POINTER         :: HML(:,:)
-#endif
+    REAL, POINTER         :: HSL(:,:)
     LOGICAL               :: IINIT
 #ifdef W3_WRST
     LOGICAL               :: WRSTIINIT=.FALSE.
@@ -272,9 +269,7 @@ MODULE W3IDATMD
   LOGICAL, POINTER        ::  FLLEVTIDE, FLCURTIDE,  &
        FLLEVRESI, FLCURRESI
 #endif
-#ifdef W3_CESMCOUPLED
-  REAL   , POINTER        :: HML(:,:)
-#endif
+  REAL , POINTER :: HSL(:,:)
   !/
 CONTAINS
   !/ ------------------------------------------------------------------- /
@@ -743,10 +738,8 @@ SUBROUTINE W3DIMI  ( IMOD, NDSE, NDST, FLAGSTIDEIN )
       CHECK_ALLOC_STATUS ( ISTAT )
     END IF
     !
-#ifdef W3_CESMCOUPLED
-    ALLOCATE ( INPUTS(IMOD)%HML(NX,NY), STAT=ISTAT )
+    ALLOCATE ( INPUTS(IMOD)%HSL(NX,NY), STAT=ISTAT )
     CHECK_ALLOC_STATUS ( ISTAT )
-#endif
     !
     INPUTS(IMOD)%IINIT  = .TRUE.
     !
@@ -1061,9 +1054,7 @@ SUBROUTINE W3SETI ( IMOD, NDSE, NDST )
         ICEI   => INPUTS(IMOD)%ICEI
         BERGI  => INPUTS(IMOD)%BERGI
       END IF
-#ifdef W3_CESMCOUPLED
-      HML    => INPUTS(IMOD)%HML
-#endif
+      HSL => INPUTS(IMOD)%HSL
       !
       IF ( FLTAUA  ) THEN
         UX0    => INPUTS(IMOD)%UX0

model/src/w3initmd.F90

@@ -2152,10 +2152,7 @@ SUBROUTINE W3MPIO ( IMOD )
          TAUOCX, TAUOCY, WNMEAN
 #endif
 
-#ifdef W3_CESMCOUPLED
-    USE W3ADATMD, ONLY: LANGMT, LAPROJ, ALPHAL, LASL, LASLPJ,  &
-         ALPHALS, LAMULT
-#endif
+    USE W3ADATMD, ONLY: USSHX, USSHY
 
 #ifdef W3_MPI
     USE W3GDATMD, ONLY: NK
@@ -2248,7 +2245,7 @@ SUBROUTINE W3MPIO ( IMOD )
            0                 +    0  +    0  +  &  ! group 3 (extra contributions below)
            2+(NOGE(4)-2)*(NOSWLL+1) +    0  +    0  +  &  ! group 4
            11                +    3  +    1  +  &  ! group 5
-           12                +    7  +    1  +  &  ! group 6 (extra contributions below)
+           10                +    7  +    1  +  &  ! group 6 (extra contributions below)
            5                 +    4  +    1  +  &  ! group 7
            5                 +    2  +    0  +  &  ! group 8
            5                 +    0  +    0  +  &  ! group 9
@@ -2262,6 +2259,7 @@ SUBROUTINE W3MPIO ( IMOD )
       IF ( FLGRDALL( 6,9)) NRQMAX = NRQMAX + P2MSF(3) - P2MSF(2) + 1
       IF ( FLGRDALL( 6, 8) ) NRQMAX = NRQMAX + 2*NK
       IF ( FLGRDALL( 6,12) ) NRQMAX = NRQMAX + 2*NK
+      IF ( FLGRDALL( 6,14) ) NRQMAX = NRQMAX + 2
       !
       IF ( NRQMAX .GT. 0 ) THEN
         ALLOCATE ( OUTPTS(IMOD)%OUT1%IRQGO(NRQMAX) )
@@ -3218,17 +3216,22 @@ SUBROUTINE W3MPIO ( IMOD )
 #ifdef W3_MPI
         END IF
         !
-#ifdef W3_CESMCOUPLED
         IF ( FLGRDALL( 6, 14) ) THEN
           IH     = IH + 1
           IT     = IT + 1
-          CALL MPI_SEND_INIT (LANGMT(1),NSEALM , MPI_REAL, IROOT,   &
+          CALL MPI_SEND_INIT (USSHX (1),NSEALM , MPI_REAL, IROOT,   &
+               IT, MPI_COMM_WAVE, IRQGO(IH), IERR)
+#ifdef W3_MPIT
+          WRITE (NDST,9011) IH, ' 6/14', IROOT, IT, IRQGO(IH), IERR
+#endif
+          IH     = IH + 1
+          IT     = IT + 1
+          CALL MPI_SEND_INIT (USSHY (1),NSEALM , MPI_REAL, IROOT,   &
                IT, MPI_COMM_WAVE, IRQGO(IH), IERR)
 #ifdef W3_MPIT
           WRITE (NDST,9011) IH, ' 6/14', IROOT, IT, IRQGO(IH), IERR
 #endif
         END IF
-#endif !W3_CESMCOUPLED
         IF ( FLGRDALL( 7, 1) ) THEN
           IH     = IH + 1
           IT     = IT + 1
@@ -4462,17 +4465,23 @@ SUBROUTINE W3MPIO ( IMOD )
 #ifdef W3_MPI
           END IF
           !
-#ifdef W3_CESMCOUPLED
           IF ( FLGRDALL( 6, 14) ) THEN
             IH     = IH + 1
             IT     = IT + 1
-            CALL MPI_RECV_INIT (LANGMT(I0),1,WW3_FIELD_VEC, IFROM, IT,  &
-                 MPI_COMM_WAVE, IRQGO2(IH), IERR)
+            CALL MPI_RECV_INIT (USSHX (I0),1,WW3_FIELD_VEC, IFROM, IT,  &
+                 MPI_COMM_WAVE, IRQGO2(IH), IERR )
+#ifdef W3_MPIT
+            WRITE (NDST,9011) IH, ' 6/14', IFROM, IT, IRQGO2(IH), IERR
+#endif
+            IH     = IH + 1
+            IT     = IT + 1
+            CALL MPI_RECV_INIT (USSHY (I0),1,WW3_FIELD_VEC, IFROM, IT,  &
+                 MPI_COMM_WAVE, IRQGO2(IH), IERR )
 #ifdef W3_MPIT
             WRITE (NDST,9011) IH, ' 6/14', IFROM, IT, IRQGO2(IH), IERR
 #endif
           END IF
-#endif ! W3_CESMCOUPLED
+          !
           IF ( FLGRDALL( 7, 1) ) THEN
             IH     = IH + 1
             IT     = IT + 1