pkg/mom_vecinv/mom_vi_u_vertshear.F

C $Header: /u/gcmpack/MITgcm/pkg/mom_vecinv/mom_vi_u_vertshear.F,v 1.5 2004/07/20 17:46:38 adcroft Exp $
C $Name:  $

#include "MOM_VECINV_OPTIONS.h"

      SUBROUTINE MOM_VI_U_VERTSHEAR(
     I        bi,bj,K,
     I        uFld,wFld,
     U        uShearTerm,
     I        myThid)
      IMPLICIT NONE
C     /==========================================================\
C     | S/R MOM_U_VERTSHEAR                                      |
C     |==========================================================|
C     \==========================================================/

C     == Global variables ==
#include "SIZE.h"
#include "EEPARAMS.h"
#include "GRID.h"
#include "PARAMS.h"

C     == Routine arguments ==
      INTEGER bi,bj,K
      _RL uFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL wFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL uShearTerm(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      INTEGER myThid

C     == Local variables ==
      INTEGER I,J,Kp1,Km1
      _RL  mask_Kp1,mask_Km1,wBarXm,wBarXp
      _RL  uZm,uZp
c     _RL  umask_Kp1,umask_K,umask_Km1
c     LOGICAL freeslipK,noslipK
c     PARAMETER(freeslipK=.TRUE.)
c     PARAMETER(noslipK=.NOT.freeslipK)
c     LOGICAL freeslip1,noslip1
c     PARAMETER(freeslip1=.TRUE.)
c     PARAMETER(noslip1=.NOT.freeslip1)
c1    _RL  wBarXZ,uZbarZ

      Kp1=min(K+1,Nr)
      mask_Kp1=1.
      IF (K.EQ.Nr) mask_Kp1=0.
      Km1=max(K-1,1)
      mask_Km1=1.
      IF (K.EQ.1) mask_Km1=0.

      DO J=1-Oly,sNy+Oly
       DO I=2-Olx,sNx+Olx

c       umask_K=_maskW(i,j,k,bi,bj)

C barZ( barX( W ) )
c       wBarXm=0.5*(wFld(I,J,K,bi,bj)+wFld(I-1,J,K,bi,bj))
c       wBarXp=0.5*(wFld(I,J,Kp1,bi,bj)+wFld(I-1,J,Kp1,bi,bj))
c    &         *mask_Kp1

C       Transport at interface k
        wBarXm=0.5*(
     &    wFld(I,J,K,bi,bj)*rA(i,j,bi,bj)*maskC(I,J,Km1,bi,bj)
     &   +wFld(I-1,J,K,bi,bj)*rA(i-1,j,bi,bj)*maskC(I-1,J,Km1,bi,bj)
     &             )*mask_Km1

C       Transport at interface k+1 (here wFld is already masked)
        wBarXp=0.5*(
     &    wFld(I,J,Kp1,bi,bj)*rA(i,j,bi,bj)
     &   +wFld(I-1,J,Kp1,bi,bj)*rA(i-1,j,bi,bj)
     &             )*mask_Kp1

C delta_Z( U )  @ interface k
c       umask_Km1=mask_Km1*maskW(i,j,Km1,bi,bj)
        uZm=(mask_Km1*uFld(I,J,Km1,bi,bj)-uFld(I,J,K,bi,bj))
c    &      *rkFac
c2   &      *recip_dRC(K)
c       IF (freeslip1) uZm=uZm*umask_Km1
c       IF (noslip1.AND.umask_Km1.EQ.0.) uZm=uZm*2.

C delta_Z( U )  @ interface k+1
c       umask_Kp1=mask_Kp1*maskW(i,j,Kp1,bi,bj)
        uZp=(uFld(I,J,K,bi,bj)-mask_Kp1*uFld(I,J,Kp1,bi,bj))
c    &      *rkFac
c2   &      *recip_dRC(Kp1)
c       IF (freeslipK) uZp=uZp*umask_Kp1
c       IF (noslipK.AND.umask_Kp1.EQ.0.) uZp=uZp*2.

c1      IF (upwindShear) THEN
c1       wBarXZ=0.5*( wBarXm + wBarXp )
c1       IF (wBarXZ.GT.0.) THEN
c1        uZbarZ=uZp
c1       ELSE
c1        uZbarZ=uZm
c1       ENDIF
c1      ELSE
c1       uZbarZ=0.5*(uZm+uZp)
c1      ENDIF
c1      uShearTerm(I,J)=-wBarXZ*uZbarZ*_maskW(I,J,K,bi,bj)

c2      uShearTerm(I,J)=-0.5*(wBarXp*uZp+wBarXm*uZm)
c2   &                  *_maskW(I,J,K,bi,bj)
        IF (upwindShear) THEN
          uShearTerm(I,J)=-0.5*
     &                   (     (wBarXp*uZp+wBarXm*uZm)
     &                        +(ABS(wBarXp)*uZp-ABS(wBarXm)*uZm)
     &                   )*recip_rAw(i,j,bi,bj)
     &                    *recip_hFacW(i,j,k,bi,bj)
     &                    *recip_drF(K)
        ELSE
          uShearTerm(I,J)=-0.5*(wBarXp*uZp+wBarXm*uZm)
     &                    *recip_rAw(i,j,bi,bj)
     &                    *recip_hFacW(i,j,k,bi,bj)
     &                    *recip_drF(K)
        ENDIF
       ENDDO
      ENDDO

      RETURN
      END
1	jmc	1.6	C $Header: /u/gcmpack/MITgcm/pkg/mom_vecinv/mom_vi_u_vertshear.F,v 1.5 2004/07/20 17:46:38 adcroft Exp $
2	jmc	1.3	C $Name: $
3	adcroft	1.2
4	adcroft	1.5	#include "MOM_VECINV_OPTIONS.h"
5	adcroft	1.2
6			SUBROUTINE MOM_VI_U_VERTSHEAR(
7			I bi,bj,K,
8			I uFld,wFld,
9			U uShearTerm,
10			I myThid)
11			IMPLICIT NONE
12			C /==========================================================\
13			C \| S/R MOM_U_VERTSHEAR \|
14			C \|==========================================================\|
15			C \==========================================================/
16
17			C == Global variables ==
18			#include "SIZE.h"
19			#include "EEPARAMS.h"
20			#include "GRID.h"
21			#include "PARAMS.h"
22
23			C == Routine arguments ==
24			INTEGER bi,bj,K
25			_RL uFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
26			_RL wFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
27			_RL uShearTerm(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
28			INTEGER myThid
29
30			C == Local variables ==
31			INTEGER I,J,Kp1,Km1
32			_RL mask_Kp1,mask_Km1,wBarXm,wBarXp
33	jmc	1.6	_RL uZm,uZp
34			c _RL umask_Kp1,umask_K,umask_Km1
35			c LOGICAL freeslipK,noslipK
36			c PARAMETER(freeslipK=.TRUE.)
37			c PARAMETER(noslipK=.NOT.freeslipK)
38			c LOGICAL freeslip1,noslip1
39			c PARAMETER(freeslip1=.TRUE.)
40			c PARAMETER(noslip1=.NOT.freeslip1)
41	adcroft	1.2	c1 _RL wBarXZ,uZbarZ
42
43			Kp1=min(K+1,Nr)
44			mask_Kp1=1.
45			IF (K.EQ.Nr) mask_Kp1=0.
46			Km1=max(K-1,1)
47			mask_Km1=1.
48			IF (K.EQ.1) mask_Km1=0.
49
50	jmc	1.3	DO J=1-Oly,sNy+Oly
51			DO I=2-Olx,sNx+Olx
52	adcroft	1.2
53	jmc	1.3	c umask_K=_maskW(i,j,k,bi,bj)
54	adcroft	1.2
55			C barZ( barX( W ) )
56			c wBarXm=0.5*(wFld(I,J,K,bi,bj)+wFld(I-1,J,K,bi,bj))
57			c wBarXp=0.5*(wFld(I,J,Kp1,bi,bj)+wFld(I-1,J,Kp1,bi,bj))
58			c & *mask_Kp1
59
60			C Transport at interface k
61	jmc	1.4	wBarXm=0.5*(
62			& wFld(I,J,K,bi,bj)rA(i,j,bi,bj)maskC(I,J,Km1,bi,bj)
63			& +wFld(I-1,J,K,bi,bj)rA(i-1,j,bi,bj)maskC(I-1,J,Km1,bi,bj)
64			& )*mask_Km1
65
66			C Transport at interface k+1 (here wFld is already masked)
67			wBarXp=0.5*(
68			& wFld(I,J,Kp1,bi,bj)*rA(i,j,bi,bj)
69			& +wFld(I-1,J,Kp1,bi,bj)*rA(i-1,j,bi,bj)
70			& )*mask_Kp1
71	adcroft	1.2
72			C delta_Z( U ) @ interface k
73	jmc	1.4	c umask_Km1=mask_Km1*maskW(i,j,Km1,bi,bj)
74			uZm=(mask_Km1*uFld(I,J,Km1,bi,bj)-uFld(I,J,K,bi,bj))
75	jmc	1.6	c & *rkFac
76	adcroft	1.2	c2 & *recip_dRC(K)
77	jmc	1.4	c IF (freeslip1) uZm=uZm*umask_Km1
78			c IF (noslip1.AND.umask_Km1.EQ.0.) uZm=uZm*2.
79	adcroft	1.2
80			C delta_Z( U ) @ interface k+1
81	jmc	1.4	c umask_Kp1=mask_Kp1*maskW(i,j,Kp1,bi,bj)
82			uZp=(uFld(I,J,K,bi,bj)-mask_Kp1*uFld(I,J,Kp1,bi,bj))
83	jmc	1.6	c & *rkFac
84	adcroft	1.2	c2 & *recip_dRC(Kp1)
85	jmc	1.4	c IF (freeslipK) uZp=uZp*umask_Kp1
86			c IF (noslipK.AND.umask_Kp1.EQ.0.) uZp=uZp*2.
87	adcroft	1.2
88			c1 IF (upwindShear) THEN
89			c1 wBarXZ=0.5*( wBarXm + wBarXp )
90			c1 IF (wBarXZ.GT.0.) THEN
91			c1 uZbarZ=uZp
92			c1 ELSE
93			c1 uZbarZ=uZm
94			c1 ENDIF
95			c1 ELSE
96			c1 uZbarZ=0.5*(uZm+uZp)
97			c1 ENDIF
98			c1 uShearTerm(I,J)=-wBarXZuZbarZ_maskW(I,J,K,bi,bj)
99
100			c2 uShearTerm(I,J)=-0.5(wBarXpuZp+wBarXm*uZm)
101			c2 & *_maskW(I,J,K,bi,bj)
102	jmc	1.6	IF (upwindShear) THEN
103			uShearTerm(I,J)=-0.5*
104			& ( (wBarXpuZp+wBarXmuZm)
105			& +(ABS(wBarXp)uZp-ABS(wBarXm)uZm)
106			& )*recip_rAw(i,j,bi,bj)
107			& *recip_hFacW(i,j,k,bi,bj)
108			& *recip_drF(K)
109			ELSE
110			uShearTerm(I,J)=-0.5(wBarXpuZp+wBarXm*uZm)
111			& *recip_rAw(i,j,bi,bj)
112			& *recip_hFacW(i,j,k,bi,bj)
113			& *recip_drF(K)
114			ENDIF
115	adcroft	1.2	ENDDO
116			ENDDO
117
118			RETURN
119			END