model/src/calc_div_ghat.F

C $Header: /u/gcmpack/MITgcm/model/src/calc_div_ghat.F,v 1.17 2001/09/26 18:09:13 cnh Exp $
C $Name:  $

#include "CPP_OPTIONS.h"
CBOP
C     !ROUTINE: CALC_DIV_GHAT
C     !INTERFACE:
      SUBROUTINE CALC_DIV_GHAT(
     I        bi,bj,iMin,iMax,jMin,jMax,K,
     I        xA,yA,
     U        cg2d_b,
     I        myThid)
C     !DESCRIPTION: \bv
C     *==========================================================*
C     | S/R CALC_DIV_GHAT                                         
C     | o Form the right hand-side of the surface pressure eqn.   
C     *==========================================================*
C     | Right hand side of pressure equation is divergence
C     | of veclocity tendency (GHAT) term along with a relaxation
C     | term equal to the barotropic flow field divergence.
C     *==========================================================*
C     \ev

C     !USES:
      IMPLICIT NONE
C     == Global variables ==
#include "SIZE.h"
#include "DYNVARS.h"
#include "FFIELDS.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "GRID.h"
#include "SOLVE_FOR_PRESSURE3D.h"

C     !INPUT/OUTPUT PARAMETERS:
C     == Routine arguments ==
C     bi, bj, iMin, iMax, jMin, jMax - Range of points for which calculation
C                                      results will be set.
C     k                              - Index of layer.
C     xA, yA                         - Cell face areas
C     cg2d_b - Conjugate Gradient 2-D solver : Right-hand side vector 
C     myThid - Instance number for this call of CALC_DIV_GHAT
      INTEGER bi,bj,iMin,iMax,jMin,jMax
      INTEGER K
      _RS xA (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RS yA (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
      _RL cg2d_b(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      INTEGER myThid

C     !LOCAL VARIABLES:
C     == Local variables ==
C     i,j :: Loop counters
C     pf  :: Intermediate array for building RHS source term.
      INTEGER i,j
      _RL pf (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
CEOP

C--   Pressure equation source term
C     Term is the vertical integral of the divergence of the 
C     time tendency terms along with a relaxation term that
C     pulls div(U) + dh/dt back toward zero.

      IF (implicDiv2Dflow.EQ.1.) THEN
C     Fully Implicit treatment of the Barotropic Flow Divergence
        DO j=1,sNy
         DO i=1,sNx+1
          pf(i,j) = xA(i,j)*gU(i,j,k,bi,bj) / deltaTmom
         ENDDO
        ENDDO
      ELSEIF (exactConserv) THEN
c     ELSEIF (nonlinFreeSurf.GT.0) THEN
C     Implicit treatment of the Barotropic Flow Divergence
        DO j=1,sNy
         DO i=1,sNx+1
          pf(i,j) = implicDiv2Dflow 
     &             *xA(i,j)*gU(i,j,k,bi,bj) / deltaTmom
         ENDDO
        ENDDO
      ELSE
C     Explicit+Implicit part of the Barotropic Flow Divergence
C      => Filtering of uVel,vVel is necessary
C-- Now the filter are applied in the_correction_step().
C   We have left this code here to indicate where the filters used to be
C   in the algorithm before JMC moved them to after the pressure solver. 
C- 
C#ifdef ALLOW_ZONAL_FILT
C        IF (zonal_filt_lat.LT.90.) THEN 
C          CALL ZONAL_FILTER(
C     &      uVel, hFacW, 1-1, sNy+1, k, k, bi, bj, 1, myThid)
C          CALL ZONAL_FILTER(
C     &      vVel, hFacS, 1-1, sNy+1, k, k, bi, bj, 2, myThid)
C        ENDIF
C#endif
        DO j=1,sNy
         DO i=1,sNx+1
          pf(i,j) = ( implicDiv2Dflow * gU(i,j,k,bi,bj)
     &          + (1.-implicDiv2Dflow) * uVel(i,j,k,bi,bj)
     &               ) * xA(i,j) / deltaTmom
         ENDDO
        ENDDO
      ENDIF
      DO j=1,sNy
       DO i=1,sNx
        cg2d_b(i,j,bi,bj) = cg2d_b(i,j,bi,bj) +
     &   pf(i+1,j)-pf(i,j)
       ENDDO
      ENDDO

#ifdef ALLOW_NONHYDROSTATIC
      IF (nonHydrostatic) THEN
       DO j=1,sNy
        DO i=1,sNx
         cg3d_b(i,j,k,bi,bj) = pf(i+1,j)-pf(i,j)
        ENDDO
       ENDDO
      ENDIF
#endif

      IF (implicDiv2Dflow.EQ.1.) THEN
C     Fully Implicit treatment of the Barotropic Flow Divergence
        DO j=1,sNy+1
         DO i=1,sNx
          pf(i,j) = yA(i,j)*gV(i,j,k,bi,bj) / deltatmom
         ENDDO
        ENDDO
      ELSEIF (exactConserv) THEN
c     ELSEIF (nonlinFreeSurf.GT.0) THEN
C     Implicit treatment of the Barotropic Flow Divergence
        DO j=1,sNy+1
         DO i=1,sNx
          pf(i,j) = implicDiv2Dflow
     &             *yA(i,j)*gV(i,j,k,bi,bj) / deltatmom
         ENDDO
        ENDDO
      ELSE
C     Explicit+Implicit part of the Barotropic Flow Divergence
        DO j=1,sNy+1
         DO i=1,sNx
          pf(i,j) = ( implicDiv2Dflow * gV(i,j,k,bi,bj)
     &          + (1.-implicDiv2Dflow) * vVel(i,j,k,bi,bj)
     &               ) * yA(i,j) / deltaTmom
         ENDDO
        ENDDO
      ENDIF
      DO j=1,sNy
       DO i=1,sNx
        cg2d_b(i,j,bi,bj) = cg2d_b(i,j,bi,bj) +
     &   pf(i,j+1)-pf(i,j)
       ENDDO
      ENDDO

#ifdef ALLOW_NONHYDROSTATIC
      IF (nonHydrostatic) THEN
       DO j=1,sNy
        DO i=1,sNx
         cg3d_b(i,j,k,bi,bj) = cg3d_b(i,j,k,bi,bj) +
     &    pf(i,j+1)-pf(i,j)
        ENDDO
       ENDDO
      ENDIF
#endif

      RETURN
      END
1	jmc	1.18	C $Header: /u/gcmpack/MITgcm/model/src/calc_div_ghat.F,v 1.17 2001/09/26 18:09:13 cnh Exp $
2	jmc	1.12	C $Name: $
3	cnh	1.1
4	cnh	1.6	#include "CPP_OPTIONS.h"
5	cnh	1.17	CBOP
6			C !ROUTINE: CALC_DIV_GHAT
7			C !INTERFACE:
8			SUBROUTINE CALC_DIV_GHAT(
9	jmc	1.13	I bi,bj,iMin,iMax,jMin,jMax,K,
10	cnh	1.1	I xA,yA,
11	jmc	1.13	U cg2d_b,
12	cnh	1.1	I myThid)
13	cnh	1.17	C !DESCRIPTION: \bv
14			C ==========================================================
15			C \| S/R CALC_DIV_GHAT
16			C \| o Form the right hand-side of the surface pressure eqn.
17			C ==========================================================
18			C \| Right hand side of pressure equation is divergence
19			C \| of veclocity tendency (GHAT) term along with a relaxation
20			C \| term equal to the barotropic flow field divergence.
21			C ==========================================================
22			C \ev
23	cnh	1.1
24	cnh	1.17	C !USES:
25	cnh	1.1	IMPLICIT NONE
26			C == Global variables ==
27			#include "SIZE.h"
28			#include "DYNVARS.h"
29			#include "FFIELDS.h"
30			#include "EEPARAMS.h"
31			#include "PARAMS.h"
32			#include "GRID.h"
33	adcroft	1.15	#include "SOLVE_FOR_PRESSURE3D.h"
34	cnh	1.1
35	cnh	1.17	C !INPUT/OUTPUT PARAMETERS:
36	cnh	1.1	C == Routine arguments ==
37			C bi, bj, iMin, iMax, jMin, jMax - Range of points for which calculation
38			C results will be set.
39	adcroft	1.9	C k - Index of layer.
40			C xA, yA - Cell face areas
41	jmc	1.13	C cg2d_b - Conjugate Gradient 2-D solver : Right-hand side vector
42			C myThid - Instance number for this call of CALC_DIV_GHAT
43	cnh	1.1	INTEGER bi,bj,iMin,iMax,jMin,jMax
44			INTEGER K
45			_RS xA (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
46			_RS yA (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
47	jmc	1.13	_RL cg2d_b(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
48	cnh	1.1	INTEGER myThid
49
50	cnh	1.17	C !LOCAL VARIABLES:
51	cnh	1.1	C == Local variables ==
52	cnh	1.17	C i,j :: Loop counters
53			C pf :: Intermediate array for building RHS source term.
54	cnh	1.1	INTEGER i,j
55			_RL pf (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
56	cnh	1.17	CEOP
57	cnh	1.1
58			C-- Pressure equation source term
59			C Term is the vertical integral of the divergence of the
60			C time tendency terms along with a relaxation term that
61			C pulls div(U) + dh/dt back toward zero.
62
63	jmc	1.16	IF (implicDiv2Dflow.EQ.1.) THEN
64	jmc	1.12	C Fully Implicit treatment of the Barotropic Flow Divergence
65			DO j=1,sNy
66			DO i=1,sNx+1
67	jmc	1.18	pf(i,j) = xA(i,j)*gU(i,j,k,bi,bj) / deltaTmom
68	jmc	1.12	ENDDO
69			ENDDO
70	jmc	1.16	ELSEIF (exactConserv) THEN
71			c ELSEIF (nonlinFreeSurf.GT.0) THEN
72			C Implicit treatment of the Barotropic Flow Divergence
73			DO j=1,sNy
74			DO i=1,sNx+1
75			pf(i,j) = implicDiv2Dflow
76	jmc	1.18	& xA(i,j)gU(i,j,k,bi,bj) / deltaTmom
77	jmc	1.16	ENDDO
78			ENDDO
79	jmc	1.12	ELSE
80			C Explicit+Implicit part of the Barotropic Flow Divergence
81			C => Filtering of uVel,vVel is necessary
82	jmc	1.16	C-- Now the filter are applied in the_correction_step().
83			C We have left this code here to indicate where the filters used to be
84			C in the algorithm before JMC moved them to after the pressure solver.
85			C-
86			C#ifdef ALLOW_ZONAL_FILT
87			C IF (zonal_filt_lat.LT.90.) THEN
88			C CALL ZONAL_FILTER(
89			C & uVel, hFacW, 1-1, sNy+1, k, k, bi, bj, 1, myThid)
90			C CALL ZONAL_FILTER(
91			C & vVel, hFacS, 1-1, sNy+1, k, k, bi, bj, 2, myThid)
92			C ENDIF
93			C#endif
94	jmc	1.12	DO j=1,sNy
95			DO i=1,sNx+1
96	jmc	1.18	pf(i,j) = ( implicDiv2Dflow * gU(i,j,k,bi,bj)
97	jmc	1.12	& + (1.-implicDiv2Dflow) * uVel(i,j,k,bi,bj)
98			& ) * xA(i,j) / deltaTmom
99			ENDDO
100			ENDDO
101			ENDIF
102	cnh	1.1	DO j=1,sNy
103			DO i=1,sNx
104	adcroft	1.8	cg2d_b(i,j,bi,bj) = cg2d_b(i,j,bi,bj) +
105	cnh	1.1	& pf(i+1,j)-pf(i,j)
106			ENDDO
107			ENDDO
108
109	adcroft	1.8	#ifdef ALLOW_NONHYDROSTATIC
110			IF (nonHydrostatic) THEN
111			DO j=1,sNy
112			DO i=1,sNx
113			cg3d_b(i,j,k,bi,bj) = pf(i+1,j)-pf(i,j)
114			ENDDO
115			ENDDO
116			ENDIF
117			#endif
118
119	jmc	1.16	IF (implicDiv2Dflow.EQ.1.) THEN
120	jmc	1.12	C Fully Implicit treatment of the Barotropic Flow Divergence
121			DO j=1,sNy+1
122			DO i=1,sNx
123	jmc	1.18	pf(i,j) = yA(i,j)*gV(i,j,k,bi,bj) / deltatmom
124	jmc	1.16	ENDDO
125			ENDDO
126			ELSEIF (exactConserv) THEN
127			c ELSEIF (nonlinFreeSurf.GT.0) THEN
128			C Implicit treatment of the Barotropic Flow Divergence
129			DO j=1,sNy+1
130			DO i=1,sNx
131			pf(i,j) = implicDiv2Dflow
132	jmc	1.18	& yA(i,j)gV(i,j,k,bi,bj) / deltatmom
133	jmc	1.12	ENDDO
134			ENDDO
135			ELSE
136			C Explicit+Implicit part of the Barotropic Flow Divergence
137			DO j=1,sNy+1
138			DO i=1,sNx
139	jmc	1.18	pf(i,j) = ( implicDiv2Dflow * gV(i,j,k,bi,bj)
140	jmc	1.12	& + (1.-implicDiv2Dflow) * vVel(i,j,k,bi,bj)
141			& ) * yA(i,j) / deltaTmom
142			ENDDO
143			ENDDO
144			ENDIF
145	cnh	1.1	DO j=1,sNy
146			DO i=1,sNx
147	adcroft	1.8	cg2d_b(i,j,bi,bj) = cg2d_b(i,j,bi,bj) +
148	cnh	1.1	& pf(i,j+1)-pf(i,j)
149			ENDDO
150			ENDDO
151	cnh	1.4
152	adcroft	1.8	#ifdef ALLOW_NONHYDROSTATIC
153			IF (nonHydrostatic) THEN
154			DO j=1,sNy
155			DO i=1,sNx
156			cg3d_b(i,j,k,bi,bj) = cg3d_b(i,j,k,bi,bj) +
157			& pf(i,j+1)-pf(i,j)
158			ENDDO
159			ENDDO
160			ENDIF
161			#endif
162	cnh	1.1
163			RETURN
164			END