pkg/mom_fluxform/mom_u_coriolis.F

C $Header: /u/gcmpack/MITgcm/pkg/mom_fluxform/mom_u_coriolis.F,v 1.6 2001/11/26 17:15:56 adcroft Exp $
C $Name:  $

#include "CPP_OPTIONS.h"

CBOP
C !ROUTINE: MOM_U_CORIOLIS

C !INTERFACE: ==========================================================
      SUBROUTINE MOM_U_CORIOLIS( 
     I        bi,bj,k,vFld,
     U        uCoriolisTerm,
     I        myThid)

C !DESCRIPTION:
C Calculates the horizontal Coriolis term in the zonal equation:
C \begin{equation*}
C \overline{f}^i \overline{v}^{ij}
C \end{equation*}

C !USES: ===============================================================
      IMPLICIT NONE
#include "SIZE.h"
#include "DYNVARS.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "GRID.h"
#include "SURFACE.h"

C !INPUT PARAMETERS: ===================================================
C  bi,bj                :: tile indices
C  k                    :: vertical level
C  vFld                 :: meridional flow
C  myThid               :: thread number
      INTEGER bi,bj,K
      _RL vFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      INTEGER myThid

C !OUTPUT PARAMETERS: ==================================================
C  uCoriolisTerm        :: Coriolis term
      _RL uCoriolisTerm(1-OLx:sNx+OLx,1-OLy:sNy+OLy)

C !LOCAL VARIABLES: ====================================================
C  i,j                  :: loop indices
      INTEGER I,J
      _RL one
      PARAMETER(one=1.d0)
CEOP

      IF (useEnergyConservingCoriolis) THEN
C Energy conserving discretization
       DO j=1-Oly,sNy+Oly-1
        DO i=1-Olx+1,sNx+Olx
         uCoriolisTerm(i,j) =
     &     0.5*( _fCori( i ,j,bi,bj)
     &          *0.5*( vFld( i ,j)+vFld( i ,j+1) )
     &         + _fCori(i-1,j,bi,bj)
     &          *0.5*( vFld(i-1,j)+vFld(i-1,j+1) ) )
        ENDDO
       ENDDO
      ELSE
C Original discretization
       DO j=1-Oly,sNy+Oly-1
        DO i=1-Olx+1,sNx+Olx
         uCoriolisTerm(i,j) =
     &     0.5*( _fCori( i ,j,bi,bj) +
     &           _fCori(i-1,j,bi,bj)  )
     &   *0.25*(
     &     vFld( i ,j)+vFld( i ,j+1)
     &    +vFld(i-1,j)+vFld(i-1,j+1)
     &         )
        ENDDO
       ENDDO
      ENDIF

      IF (useJamartWetPoints) THEN
C Scale term so that only "wet" points are used
C Due to: Jamart and Ozer, 1986, JGR 91 (C9), 10,621-10,631
C         "Numerical Boundary Layers and Spurious Residual Flows"
       DO j=1-Oly,sNy+Oly-1
        DO i=1-Olx+1,sNx+Olx
         uCoriolisTerm(i,j) = uCoriolisTerm(i,j)
     & *4.d0/max(one, maskS( i , j ,k,bi,bj)+maskS( i ,j+1,k,bi,bj)
     &               +maskS(i-1, j ,k,bi,bj)+maskS(i-1,j+1,k,bi,bj) )
        ENDDO
       ENDDO
      ENDIF

      RETURN
      END
1	C $Header: /u/gcmpack/MITgcm/pkg/mom_fluxform/mom_u_coriolis.F,v 1.6 2001/11/26 17:15:56 adcroft Exp $
2	C $Name: $
3
4	#include "CPP_OPTIONS.h"
5
6	CBOP
7	C !ROUTINE: MOM_U_CORIOLIS
8
9	C !INTERFACE: ==========================================================
10	SUBROUTINE MOM_U_CORIOLIS(
11	I bi,bj,k,vFld,
12	U uCoriolisTerm,
13	I myThid)
14
15	C !DESCRIPTION:
16	C Calculates the horizontal Coriolis term in the zonal equation:
17	C \begin{equation*}
18	C \overline{f}^i \overline{v}^{ij}
19	C \end{equation*}
20
21	C !USES: ===============================================================
22	IMPLICIT NONE
23	#include "SIZE.h"
24	#include "DYNVARS.h"
25	#include "EEPARAMS.h"
26	#include "PARAMS.h"
27	#include "GRID.h"
28	#include "SURFACE.h"
29
30	C !INPUT PARAMETERS: ===================================================
31	C bi,bj :: tile indices
32	C k :: vertical level
33	C vFld :: meridional flow
34	C myThid :: thread number
35	INTEGER bi,bj,K
36	_RL vFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
37	INTEGER myThid
38
39	C !OUTPUT PARAMETERS: ==================================================
40	C uCoriolisTerm :: Coriolis term
41	_RL uCoriolisTerm(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
42
43	C !LOCAL VARIABLES: ====================================================
44	C i,j :: loop indices
45	INTEGER I,J
46	_RL one
47	PARAMETER(one=1.d0)
48	CEOP
49
50	IF (useEnergyConservingCoriolis) THEN
51	C Energy conserving discretization
52	DO j=1-Oly,sNy+Oly-1
53	DO i=1-Olx+1,sNx+Olx
54	uCoriolisTerm(i,j) =
55	& 0.5*( _fCori( i ,j,bi,bj)
56	& 0.5( vFld( i ,j)+vFld( i ,j+1) )
57	& + _fCori(i-1,j,bi,bj)
58	& 0.5( vFld(i-1,j)+vFld(i-1,j+1) ) )
59	ENDDO
60	ENDDO
61	ELSE
62	C Original discretization
63	DO j=1-Oly,sNy+Oly-1
64	DO i=1-Olx+1,sNx+Olx
65	uCoriolisTerm(i,j) =
66	& 0.5*( _fCori( i ,j,bi,bj) +
67	& _fCori(i-1,j,bi,bj) )
68	& 0.25(
69	& vFld( i ,j)+vFld( i ,j+1)
70	& +vFld(i-1,j)+vFld(i-1,j+1)
71	& )
72	ENDDO
73	ENDDO
74	ENDIF
75
76	IF (useJamartWetPoints) THEN
77	C Scale term so that only "wet" points are used
78	C Due to: Jamart and Ozer, 1986, JGR 91 (C9), 10,621-10,631
79	C "Numerical Boundary Layers and Spurious Residual Flows"
80	DO j=1-Oly,sNy+Oly-1
81	DO i=1-Olx+1,sNx+Olx
82	uCoriolisTerm(i,j) = uCoriolisTerm(i,j)
83	& *4.d0/max(one, maskS( i , j ,k,bi,bj)+maskS( i ,j+1,k,bi,bj)
84	& +maskS(i-1, j ,k,bi,bj)+maskS(i-1,j+1,k,bi,bj) )
85	ENDDO
86	ENDDO
87	ENDIF
88
89	RETURN
90	END