/[MITgcm]/MITgcm/pkg/mom_vecinv/mom_vecinv.F
ViewVC logotype

Diff of /MITgcm/pkg/mom_vecinv/mom_vecinv.F

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.60 by jmc, Thu Nov 23 00:45:21 2006 UTC revision 1.72 by jmc, Tue Feb 11 20:24:06 2014 UTC
# Line 2  C $Header$ Line 2  C $Header$
2  C $Name$  C $Name$
3    
4  #include "MOM_VECINV_OPTIONS.h"  #include "MOM_VECINV_OPTIONS.h"
5    #ifdef ALLOW_MOM_COMMON
6    # include "MOM_COMMON_OPTIONS.h"
7    #endif
8    
9        SUBROUTINE MOM_VECINV(        SUBROUTINE MOM_VECINV(
10       I        bi,bj,iMin,iMax,jMin,jMax,k,kUp,kDown,       I        bi,bj,k,iMin,iMax,jMin,jMax,
11       I        KappaRU, KappaRV,       I        KappaRU, KappaRV,
12       U        fVerU, fVerV,       I        fVerUkm, fVerVkm,
13         O        fVerUkp, fVerVkp,
14       O        guDiss, gvDiss,       O        guDiss, gvDiss,
15       I        myTime, myIter, myThid)       I        myTime, myIter, myThid )
16  C     /==========================================================\  C     *==========================================================*
17  C     | S/R MOM_VECINV                                           |  C     | S/R MOM_VECINV                                           |
18  C     | o Form the right hand-side of the momentum equation.     |  C     | o Form the right hand-side of the momentum equation.     |
19  C     |==========================================================|  C     *==========================================================*
20  C     | Terms are evaluated one layer at a time working from     |  C     | Terms are evaluated one layer at a time working from     |
21  C     | the bottom to the top. The vertically integrated         |  C     | the bottom to the top. The vertically integrated         |
22  C     | barotropic flow tendency term is evluated by summing the |  C     | barotropic flow tendency term is evluated by summing the |
# Line 23  C     | for the diffusion equation bc wi Line 27  C     | for the diffusion equation bc wi
27  C     | form produces a diffusive flux that does not scale with  |  C     | form produces a diffusive flux that does not scale with  |
28  C     | open-area. Need to do something to solidfy this and to   |  C     | open-area. Need to do something to solidfy this and to   |
29  C     | deal "properly" with thin walls.                         |  C     | deal "properly" with thin walls.                         |
30  C     \==========================================================/  C     *==========================================================*
31        IMPLICIT NONE        IMPLICIT NONE
32    
33  C     == Global variables ==  C     == Global variables ==
34  #include "SIZE.h"  #include "SIZE.h"
 #include "DYNVARS.h"  
35  #include "EEPARAMS.h"  #include "EEPARAMS.h"
36  #include "PARAMS.h"  #include "PARAMS.h"
 #ifdef ALLOW_MNC  
 #include "MNC_PARAMS.h"  
 #endif  
37  #include "GRID.h"  #include "GRID.h"
38    #include "SURFACE.h"
39    #include "DYNVARS.h"
40    #ifdef ALLOW_MOM_COMMON
41    # include "MOM_VISC.h"
42    #endif
43  #ifdef ALLOW_TIMEAVE  #ifdef ALLOW_TIMEAVE
44  #include "TIMEAVE_STATV.h"  # include "TIMEAVE_STATV.h"
45    #endif
46    #ifdef ALLOW_MNC
47    # include "MNC_PARAMS.h"
48  #endif  #endif
49  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
50  # include "tamc.h"  # include "tamc.h"
# Line 44  C     == Global variables == Line 52  C     == Global variables ==
52  #endif  #endif
53    
54  C     == Routine arguments ==  C     == Routine arguments ==
55  C     fVerU  :: Flux of momentum in the vertical direction, out of the upper  C     bi,bj   :: current tile indices
56  C     fVerV  :: face of a cell K ( flux into the cell above ).  C     k       :: current vertical level
57  C     guDiss :: dissipation tendency (all explicit terms), u component  C     iMin,iMax,jMin,jMax :: loop ranges
58  C     gvDiss :: dissipation tendency (all explicit terms), v component  C     fVerU   :: Flux of momentum in the vertical direction, out of the upper
59  C     bi, bj, iMin, iMax, jMin, jMax - Range of points for which calculation  C     fVerV   :: face of a cell K ( flux into the cell above ).
60  C                                      results will be set.  C     fVerUkm :: vertical viscous flux of U, interface above (k-1/2)
61  C     kUp, kDown                     - Index for upper and lower layers.  C     fVerVkm :: vertical viscous flux of V, interface above (k-1/2)
62  C     myThid :: my Thread Id number  C     fVerUkp :: vertical viscous flux of U, interface below (k+1/2)
63    C     fVerVkp :: vertical viscous flux of V, interface below (k+1/2)
64    
65    C     guDiss  :: dissipation tendency (all explicit terms), u component
66    C     gvDiss  :: dissipation tendency (all explicit terms), v component
67    C     myTime  :: current time
68    C     myIter  :: current time-step number
69    C     myThid  :: my Thread Id number
70          INTEGER bi,bj,k
71          INTEGER iMin,iMax,jMin,jMax
72        _RL KappaRU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL KappaRU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
73        _RL KappaRV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL KappaRV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
74        _RL fVerU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerUkm(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
75        _RL fVerV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerVkm(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
76          _RL fVerUkp(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
77          _RL fVerVkp(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
78        _RL guDiss(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL guDiss(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
79        _RL gvDiss(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL gvDiss(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
       INTEGER kUp,kDown  
80        _RL     myTime        _RL     myTime
81        INTEGER myIter        INTEGER myIter
82        INTEGER myThid        INTEGER myThid
       INTEGER bi,bj,iMin,iMax,jMin,jMax  
83    
84  #ifdef ALLOW_MOM_VECINV  #ifdef ALLOW_MOM_VECINV
85    
# Line 71  C     == Functions == Line 88  C     == Functions ==
88        EXTERNAL DIFFERENT_MULTIPLE        EXTERNAL DIFFERENT_MULTIPLE
89    
90  C     == Local variables ==  C     == Local variables ==
91    C     strainBC :: same as strain but account for no-slip BC
92    C     vort3BC  :: same as vort3  but account for no-slip BC
93        _RL      vF (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL      vF (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
94        _RL      vrF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL      vrF(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
95        _RL      uCf(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL      uCf(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
96        _RL      vCf(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL      vCf(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
97        _RS hFacZ   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS hFacZ   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
98          _RS h0FacZ  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
99        _RS r_hFacZ (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS r_hFacZ (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
100        _RL uFld    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL uFld    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
101        _RL vFld    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vFld    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
# Line 85  C     == Local variables == Line 105  C     == Local variables ==
105        _RL zStar   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL zStar   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
106        _RL tension (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL tension (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
107        _RL strain  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL strain  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
108          _RL strainBC(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
109        _RL KE      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL KE      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
110        _RL omega3  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL omega3  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
111        _RL vort3   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vort3   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
112          _RL vort3BC (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
113        _RL hDiv    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL hDiv    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
114        _RL viscAh_Z(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL viscAh_Z(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
115        _RL viscAh_D(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL viscAh_D(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
116        _RL viscA4_Z(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL viscA4_Z(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
117        _RL viscA4_D(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL viscA4_D(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
118  C     i,j,k  :: Loop counters  C     i,j    :: Loop counters
119        INTEGER i,j,k        INTEGER i,j
120  C     xxxFac - On-off tracer parameters used for switching terms off.  C     xxxFac :: On-off tracer parameters used for switching terms off.
121        _RL  ArDudrFac        _RL  ArDudrFac
122        _RL  ArDvdrFac        _RL  ArDvdrFac
123        _RL  sideMaskFac        _RL  sideMaskFac
124        LOGICAL bottomDragTerms        LOGICAL bottomDragTerms
125        LOGICAL writeDiag        LOGICAL writeDiag
       LOGICAL harmonic,biharmonic,useVariableViscosity  
126  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
127        INTEGER imomkey        INTEGER imomkey
128  #endif  #endif
# Line 116  C--   only the kDown part of fverU/V is Line 137  C--   only the kDown part of fverU/V is
137  C--   the kUp is still required  C--   the kUp is still required
138  C--   In the case of mom_fluxform Kup is set as well  C--   In the case of mom_fluxform Kup is set as well
139  C--   (at least in part)  C--   (at least in part)
140        fVerU(1,1,kUp) = fVerU(1,1,kUp)        fVerUkm(1,1) = fVerUkm(1,1)
141        fVerV(1,1,kUp) = fVerV(1,1,kUp)        fVerVkm(1,1) = fVerVkm(1,1)
142  #endif  #endif
143    
144  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
# Line 156  C--   (at least in part) Line 177  C--   (at least in part)
177            offsets(i) = 0            offsets(i) = 0
178          ENDDO          ENDDO
179          offsets(3) = k          offsets(3) = k
180  C       write(*,*) 'offsets = ',(offsets(i),i=1,9)  c       write(*,*) 'offsets = ',(offsets(i),i=1,9)
181        ENDIF        ENDIF
182  #endif /*  ALLOW_MNC  */  #endif /*  ALLOW_MNC  */
183    
184  C     Initialise intermediate terms  C--   Initialise intermediate terms
185        DO J=1-OLy,sNy+OLy        DO j=1-OLy,sNy+OLy
186         DO I=1-OLx,sNx+OLx         DO i=1-OLx,sNx+OLx
187          vF(i,j)    = 0.          vF(i,j)    = 0.
188          vrF(i,j)   = 0.          vrF(i,j)   = 0.
189          uCf(i,j)   = 0.          uCf(i,j)   = 0.
# Line 176  C     Initialise intermediate terms Line 197  C     Initialise intermediate terms
197          vort3(i,j) = 0.          vort3(i,j) = 0.
198          omega3(i,j)= 0.          omega3(i,j)= 0.
199          KE(i,j)    = 0.          KE(i,j)    = 0.
200  c       hDiv(i,j)  = 0.  C-    need to initialise hDiv for MOM_VI_DEL2UV(call FILL_CS_CORNER_TR_RL)
201          viscAh_Z(i,j) = 0.          hDiv(i,j)  = 0.
202          viscAh_D(i,j) = 0.  c       viscAh_Z(i,j) = 0.
203          viscA4_Z(i,j) = 0.  c       viscAh_D(i,j) = 0.
204          viscA4_D(i,j) = 0.  c       viscA4_Z(i,j) = 0.
205    c       viscA4_D(i,j) = 0.
206          strain(i,j)  = 0. _d 0          strain(i,j)  = 0. _d 0
207            strainBC(i,j)= 0. _d 0
208          tension(i,j) = 0. _d 0          tension(i,j) = 0. _d 0
209  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
210          hFacZ(i,j)   = 0. _d 0          hFacZ(i,j)   = 0. _d 0
# Line 231  c     CALL MOM_VI_HFACZ_DISS(bi,bj,k,hFa Line 253  c     CALL MOM_VI_HFACZ_DISS(bi,bj,k,hFa
253    
254        CALL MOM_CALC_RELVORT3(bi,bj,k,uFld,vFld,hFacZ,vort3,myThid)        CALL MOM_CALC_RELVORT3(bi,bj,k,uFld,vFld,hFacZ,vort3,myThid)
255    
256    C-    mask vort3 and account for no-slip / free-slip BC in vort3BC:
257          DO j=1-OLy,sNy+OLy
258           DO i=1-OLx,sNx+OLx
259             vort3BC(i,j) = vort3(i,j)
260             IF ( hFacZ(i,j).EQ.zeroRS ) THEN
261               vort3BC(i,j) = sideMaskFac*vort3BC(i,j)
262               vort3(i,j)   = 0.
263             ENDIF
264           ENDDO
265          ENDDO
266    
267        IF (momViscosity) THEN        IF (momViscosity) THEN
268  C--    For viscous term, compute horizontal divergence, tension & strain  C--    For viscous term, compute horizontal divergence, tension & strain
269  C      and mask relative vorticity (free-slip case):  C      and mask relative vorticity (free-slip case):
270    
271  #ifdef ALLOW_AUTODIFF_TAMC         DO j=1-OLy,sNy+OLy
272  CADJ STORE vort3(:,:) =          DO i=1-OLx,sNx+OLx
273  CADJ &     comlev1_bibj_k, key = imomkey, byte = isbyte            h0FacZ(i,j) = hFacZ(i,j)
274  #endif          ENDDO
275           ENDDO
276    #ifdef NONLIN_FRSURF
277           IF ( no_slip_sides .AND. nonlinFreeSurf.GT.0 ) THEN
278            DO j=2-OLy,sNy+OLy
279             DO i=2-OLx,sNx+OLx
280              h0FacZ(i,j) = MIN(
281         &       MIN( h0FacW(i,j,k,bi,bj), h0FacW(i,j-1,k,bi,bj) ),
282         &       MIN( h0FacS(i,j,k,bi,bj), h0FacS(i-1,j,k,bi,bj) ) )
283             ENDDO
284            ENDDO
285           ENDIF
286    #endif /* NONLIN_FRSURF */
287    
288         CALL MOM_CALC_HDIV(bi,bj,k,2,uFld,vFld,hDiv,myThid)         CALL MOM_CALC_HDIV(bi,bj,k,2,uFld,vFld,hDiv,myThid)
289    
290         CALL MOM_CALC_TENSION(bi,bj,k,uFld,vFld,tension,myThid)         IF ( useVariableVisc .OR. useStrainTensionVisc ) THEN
291            CALL MOM_CALC_TENSION( bi,bj,k,uFld,vFld,tension,myThid )
292         CALL MOM_CALC_STRAIN(bi,bj,k,uFld,vFld,hFacZ,strain,myThid)          CALL MOM_CALC_STRAIN( bi,bj,k,uFld,vFld,hFacZ,strain,myThid )
293    C-    mask strain and account for no-slip / free-slip BC in strainBC:
294            DO j=1-OLy,sNy+OLy
295             DO i=1-OLx,sNx+OLx
296               strainBC(i,j) = strain(i,j)
297               IF ( hFacZ(i,j).EQ.zeroRS ) THEN
298                 strainBC(i,j) = sideMaskFac*strainBC(i,j)
299                 strain(i,j)   = 0.
300               ENDIF
301             ENDDO
302            ENDDO
303           ENDIF
304    
305  C-     account for no-slip / free-slip BC:  C--    Calculate Lateral Viscosities
306         DO j=1-Oly,sNy+Oly         DO j=1-OLy,sNy+OLy
307          DO i=1-Olx,sNx+Olx          DO i=1-OLx,sNx+OLx
308            IF ( hFacZ(i,j).EQ.0. ) THEN           viscAh_D(i,j) = viscAhD
309              vort3(i,j)  = sideMaskFac*vort3(i,j)           viscAh_Z(i,j) = viscAhZ
310              strain(i,j) = sideMaskFac*strain(i,j)           viscA4_D(i,j) = viscA4D
311            ENDIF           viscA4_Z(i,j) = viscA4Z
312          ENDDO          ENDDO
313         ENDDO         ENDDO
314           IF ( useVariableVisc ) THEN
315  C--    Calculate Viscosities  C-     uses vort3BC & strainBC which account for no-slip / free-slip BC
316         CALL MOM_CALC_VISC(           CALL MOM_CALC_VISC( bi, bj, k,
317       I        bi,bj,k,       O            viscAh_Z, viscAh_D, viscA4_Z, viscA4_D,
318       O        viscAh_Z,viscAh_D,viscA4_Z,viscA4_D,       I            hDiv, vort3BC, tension, strainBC, KE, hfacZ,
319       O        harmonic,biharmonic,useVariableViscosity,       I            myThid )
320       I        hDiv,vort3,tension,strain,KE,hfacZ,         ENDIF
      I        myThid)  
321    
322  C      Calculate del^2 u and del^2 v for bi-harmonic term  C      Calculate del^2 u and del^2 v for bi-harmonic term
323         IF (biharmonic) THEN         IF (useBiharmonicVisc) THEN
324           CALL MOM_VI_DEL2UV(bi,bj,k,hDiv,vort3,hFacZ,           CALL MOM_VI_DEL2UV(bi,bj,k,hDiv,vort3,hFacZ,
325       O                      del2u,del2v,       O                      del2u,del2v,
326       &                      myThid)       I                      myThid)
327           CALL MOM_CALC_HDIV(bi,bj,k,2,del2u,del2v,dStar,myThid)           CALL MOM_CALC_HDIV(bi,bj,k,2,del2u,del2v,dStar,myThid)
328           CALL MOM_CALC_RELVORT3(bi,bj,k,           CALL MOM_CALC_RELVORT3(bi,bj,k,
329       &                          del2u,del2v,hFacZ,zStar,myThid)       &                          del2u,del2v,hFacZ,zStar,myThid)
330         ENDIF         ENDIF
331    
 C-    Strain diagnostics:  
        IF ( writeDiag ) THEN  
         IF (snapshot_mdsio) THEN  
           CALL WRITE_LOCAL_RL('Ds','I10',1,strain,bi,bj,k,myIter,myThid)  
         ENDIF  
 #ifdef ALLOW_MNC  
         IF (useMNC .AND. snapshot_mnc) THEN  
           CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Ds',strain,  
      &          offsets, myThid)  
         ENDIF  
 #endif /*  ALLOW_MNC  */  
        ENDIF  
 #ifdef ALLOW_DIAGNOSTICS  
        IF ( useDiagnostics ) THEN  
         CALL DIAGNOSTICS_FILL(strain, 'Strain  ',k,1,2,bi,bj,myThid)  
        ENDIF  
 #endif /* ALLOW_DIAGNOSTICS */  
   
332  C---   Calculate dissipation terms for U and V equations  C---   Calculate dissipation terms for U and V equations
333    
334  C      in terms of tension and strain  C-     in terms of tension and strain
335         IF (useStrainTensionVisc) THEN         IF (useStrainTensionVisc) THEN
336  C        mask strain as if free-slip since side-drag is computed separately  C      use masked strain as if free-slip since side-drag is computed separately
337           DO j=1-Oly,sNy+Oly           CALL MOM_HDISSIP( bi, bj, k,
338            DO i=1-Olx,sNx+Olx       I            tension, strain, hFacZ,
339              IF ( hFacZ(i,j).EQ.0. ) strain(i,j) = 0. _d 0       I            viscAh_Z, viscAh_D, viscA4_Z, viscA4_D,
340            ENDDO       I            useHarmonicVisc, useBiharmonicVisc, useVariableVisc,
341           ENDDO       O            guDiss, gvDiss,
342           CALL MOM_HDISSIP(bi,bj,k,hDiv,vort3,tension,strain,KE,       I            myThid )
      I                    hFacZ,  
      I                    viscAh_Z,viscAh_D,viscA4_Z,viscA4_D,  
      I                    harmonic,biharmonic,useVariableViscosity,  
      O                    guDiss,gvDiss,  
      I                    myThid)  
343         ELSE         ELSE
344  C      in terms of vorticity and divergence  C-     in terms of vorticity and divergence
345           CALL MOM_VI_HDISSIP(bi,bj,k,hDiv,vort3,tension,strain,KE,           CALL MOM_VI_HDISSIP( bi, bj, k,
346       I                       hFacZ,dStar,zStar,       I            hDiv, vort3, dStar, zStar, hFacZ,
347       I                       viscAh_Z,viscAh_D,viscA4_Z,viscA4_D,       I            viscAh_Z, viscAh_D, viscA4_Z, viscA4_D,
348       I                       harmonic,biharmonic,useVariableViscosity,       I            useHarmonicVisc, useBiharmonicVisc, useVariableVisc,
349       O                       guDiss,gvDiss,       O            guDiss, gvDiss,
350       &                       myThid)       I            myThid )
351         ENDIF         ENDIF
 C--   if (momViscosity) end of block.  
       ENDIF  
   
 C-    Return to standard hfacZ (min-4) and mask vort3 accordingly:  
 c     CALL MOM_VI_MASK_VORT3(bi,bj,k,hFacZ,r_hFacZ,vort3,myThid)  
352    
353  C---  Other dissipation terms in Zonal momentum equation  C---  Other dissipation terms in Zonal momentum equation
354    
355  C--   Vertical flux (fVer is at upper face of "u" cell)  C--   Vertical flux (fVer is at upper face of "u" cell)
   
356  C     Eddy component of vertical flux (interior component only) -> vrF  C     Eddy component of vertical flux (interior component only) -> vrF
357        IF (momViscosity.AND..NOT.implicitViscosity) THEN        IF ( .NOT.implicitViscosity ) THEN
358         CALL MOM_U_RVISCFLUX(bi,bj,k+1,uVel,KappaRU,vrF,myThid)         CALL MOM_U_RVISCFLUX(bi,bj,k+1,uVel,KappaRU,vrF,myThid)
   
359  C     Combine fluxes  C     Combine fluxes
360         DO j=jMin,jMax         DO j=jMin,jMax
361          DO i=iMin,iMax          DO i=iMin,iMax
362           fVerU(i,j,kDown) = ArDudrFac*vrF(i,j)           fVerUkp(i,j) = ArDudrFac*vrF(i,j)
363          ENDDO          ENDDO
364         ENDDO         ENDDO
   
365  C--   Tendency is minus divergence of the fluxes  C--   Tendency is minus divergence of the fluxes
366         DO j=2-Oly,sNy+Oly-1         DO j=jMin,jMax
367          DO i=2-Olx,sNx+Olx-1          DO i=iMin,iMax
368           guDiss(i,j) = guDiss(i,j)           guDiss(i,j) = guDiss(i,j)
369       &   -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)       &   -_recip_hFacW(i,j,k,bi,bj)*recip_drF(k)
370       &   *recip_rAw(i,j,bi,bj)       &   *recip_rAw(i,j,bi,bj)
371       &  *(       &   *( fVerUkp(i,j) - fVerUkm(i,j) )*rkSign
      &    fVerU(i,j,kDown) - fVerU(i,j,kUp)  
      &   )*rkSign  
372          ENDDO          ENDDO
373         ENDDO         ENDDO
374        ENDIF        ENDIF
375    
376  C-- No-slip and drag BCs appear as body forces in cell abutting topography  C-- No-slip and drag BCs appear as body forces in cell abutting topography
377        IF (momViscosity.AND.no_slip_sides) THEN        IF ( no_slip_sides ) THEN
378  C-     No-slip BCs impose a drag at walls...  C-     No-slip BCs impose a drag at walls...
379         CALL MOM_U_SIDEDRAG(         CALL MOM_U_SIDEDRAG( bi, bj, k,
380       I        bi,bj,k,       I          uFld, del2u, h0FacZ,
381       I        uFld, del2u, hFacZ,       I          viscAh_Z, viscA4_Z,
382       I        viscAh_Z,viscA4_Z,       I          useHarmonicVisc, useBiharmonicVisc, useVariableVisc,
383       I        harmonic,biharmonic,useVariableViscosity,       O          vF,
384       O        vF,       I          myThid )
      I        myThid)  
385         DO j=jMin,jMax         DO j=jMin,jMax
386          DO i=iMin,iMax          DO i=iMin,iMax
387           guDiss(i,j) = guDiss(i,j)+vF(i,j)           guDiss(i,j) = guDiss(i,j)+vF(i,j)
388          ENDDO          ENDDO
389         ENDDO         ENDDO
390        ENDIF        ENDIF
391    
392  C-    No-slip BCs impose a drag at bottom  C-    No-slip BCs impose a drag at bottom
393        IF (momViscosity.AND.bottomDragTerms) THEN        IF ( bottomDragTerms ) THEN
394         CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)         CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)
395         DO j=jMin,jMax         DO j=jMin,jMax
396          DO i=iMin,iMax          DO i=iMin,iMax
# Line 377  C-    No-slip BCs impose a drag at botto Line 399  C-    No-slip BCs impose a drag at botto
399         ENDDO         ENDDO
400        ENDIF        ENDIF
401  #ifdef ALLOW_SHELFICE  #ifdef ALLOW_SHELFICE
402        IF (useShelfIce.AND.momViscosity.AND.bottomDragTerms) THEN        IF ( useShelfIce.AND.bottomDragTerms ) THEN
403         CALL SHELFICE_U_DRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)         CALL SHELFICE_U_DRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)
404         DO j=jMin,jMax         DO j=jMin,jMax
405          DO i=iMin,iMax          DO i=iMin,iMax
# Line 387  C-    No-slip BCs impose a drag at botto Line 409  C-    No-slip BCs impose a drag at botto
409        ENDIF        ENDIF
410  #endif /* ALLOW_SHELFICE */  #endif /* ALLOW_SHELFICE */
411    
   
412  C---  Other dissipation terms in Meridional momentum equation  C---  Other dissipation terms in Meridional momentum equation
413    
414  C--   Vertical flux (fVer is at upper face of "v" cell)  C--   Vertical flux (fVer is at upper face of "v" cell)
   
415  C     Eddy component of vertical flux (interior component only) -> vrF  C     Eddy component of vertical flux (interior component only) -> vrF
416        IF (momViscosity.AND..NOT.implicitViscosity) THEN        IF ( .NOT.implicitViscosity ) THEN
417         CALL MOM_V_RVISCFLUX(bi,bj,k+1,vVel,KappaRV,vrF,myThid)         CALL MOM_V_RVISCFLUX(bi,bj,k+1,vVel,KappaRV,vrF,myThid)
   
418  C     Combine fluxes -> fVerV  C     Combine fluxes -> fVerV
419         DO j=jMin,jMax         DO j=jMin,jMax
420          DO i=iMin,iMax          DO i=iMin,iMax
421           fVerV(i,j,kDown) = ArDvdrFac*vrF(i,j)           fVerVkp(i,j) = ArDvdrFac*vrF(i,j)
422          ENDDO          ENDDO
423         ENDDO         ENDDO
   
424  C--   Tendency is minus divergence of the fluxes  C--   Tendency is minus divergence of the fluxes
425         DO j=jMin,jMax         DO j=jMin,jMax
426          DO i=iMin,iMax          DO i=iMin,iMax
427           gvDiss(i,j) = gvDiss(i,j)           gvDiss(i,j) = gvDiss(i,j)
428       &   -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)       &   -_recip_hFacS(i,j,k,bi,bj)*recip_drF(k)
429       &    *recip_rAs(i,j,bi,bj)       &   *recip_rAs(i,j,bi,bj)
430       &  *(       &   *( fVerVkp(i,j) - fVerVkm(i,j) )*rkSign
      &    fVerV(i,j,kDown) - fVerV(i,j,kUp)  
      &   )*rkSign  
431          ENDDO          ENDDO
432         ENDDO         ENDDO
433        ENDIF        ENDIF
434    
435  C-- No-slip and drag BCs appear as body forces in cell abutting topography  C-- No-slip and drag BCs appear as body forces in cell abutting topography
436        IF (momViscosity.AND.no_slip_sides) THEN        IF ( no_slip_sides ) THEN
437  C-     No-slip BCs impose a drag at walls...  C-     No-slip BCs impose a drag at walls...
438         CALL MOM_V_SIDEDRAG(         CALL MOM_V_SIDEDRAG( bi, bj, k,
439       I        bi,bj,k,       I          vFld, del2v, h0FacZ,
440       I        vFld, del2v, hFacZ,       I          viscAh_Z, viscA4_Z,
441       I        viscAh_Z,viscA4_Z,       I          useHarmonicVisc, useBiharmonicVisc, useVariableVisc,
442       I        harmonic,biharmonic,useVariableViscosity,       O          vF,
443       O        vF,       I          myThid )
      I        myThid)  
444         DO j=jMin,jMax         DO j=jMin,jMax
445          DO i=iMin,iMax          DO i=iMin,iMax
446           gvDiss(i,j) = gvDiss(i,j)+vF(i,j)           gvDiss(i,j) = gvDiss(i,j)+vF(i,j)
447          ENDDO          ENDDO
448         ENDDO         ENDDO
449        ENDIF        ENDIF
450    
451  C-    No-slip BCs impose a drag at bottom  C-    No-slip BCs impose a drag at bottom
452        IF (momViscosity.AND.bottomDragTerms) THEN        IF ( bottomDragTerms ) THEN
453         CALL MOM_V_BOTTOMDRAG(bi,bj,k,vFld,KE,KappaRV,vF,myThid)         CALL MOM_V_BOTTOMDRAG(bi,bj,k,vFld,KE,KappaRV,vF,myThid)
454         DO j=jMin,jMax         DO j=jMin,jMax
455          DO i=iMin,iMax          DO i=iMin,iMax
# Line 442  C-    No-slip BCs impose a drag at botto Line 458  C-    No-slip BCs impose a drag at botto
458         ENDDO         ENDDO
459        ENDIF        ENDIF
460  #ifdef ALLOW_SHELFICE  #ifdef ALLOW_SHELFICE
461        IF (useShelfIce.AND.momViscosity.AND.bottomDragTerms) THEN        IF  (useShelfIce.AND.bottomDragTerms ) THEN
462           CALL SHELFICE_V_DRAG(bi,bj,k,vFld,KE,KappaRU,vF,myThid)           CALL SHELFICE_V_DRAG(bi,bj,k,vFld,KE,KappaRV,vF,myThid)
463           DO j=jMin,jMax           DO j=jMin,jMax
464            DO i=iMin,iMax            DO i=iMin,iMax
465             gvDiss(i,j) = gvDiss(i,j) + vF(i,j)             gvDiss(i,j) = gvDiss(i,j) + vF(i,j)
# Line 452  C-    No-slip BCs impose a drag at botto Line 468  C-    No-slip BCs impose a drag at botto
468          ENDIF          ENDIF
469  #endif /* ALLOW_SHELFICE */  #endif /* ALLOW_SHELFICE */
470    
471    C--   if (momViscosity) end of block.
 C-    Vorticity diagnostics:  
       IF ( writeDiag ) THEN  
         IF (snapshot_mdsio) THEN  
           CALL WRITE_LOCAL_RL('Z3','I10',1,vort3, bi,bj,k,myIter,myThid)  
         ENDIF  
 #ifdef ALLOW_MNC  
         IF (useMNC .AND. snapshot_mnc) THEN  
           CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Z3',vort3,  
      &          offsets, myThid)  
         ENDIF  
 #endif /*  ALLOW_MNC  */  
       ENDIF  
 #ifdef ALLOW_DIAGNOSTICS  
       IF ( useDiagnostics ) THEN  
         CALL DIAGNOSTICS_FILL(vort3,  'momVort3',k,1,2,bi,bj,myThid)  
472        ENDIF        ENDIF
473  #endif /* ALLOW_DIAGNOSTICS */  
474    C-    Return to standard hfacZ (min-4) and mask vort3 accordingly:
475    c     CALL MOM_VI_MASK_VORT3(bi,bj,k,hFacZ,r_hFacZ,vort3,myThid)
476    
477  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
478    
479  C---  Prepare for Advection & Coriolis terms:  C---  Prepare for Advection & Coriolis terms:
480  C-    Mask relative vorticity and calculate absolute vorticity  C-    calculate absolute vorticity
       DO j=1-Oly,sNy+Oly  
        DO i=1-Olx,sNx+Olx  
          IF ( hFacZ(i,j).EQ.0. ) vort3(i,j) = 0.  
        ENDDO  
       ENDDO  
481        IF (useAbsVorticity)        IF (useAbsVorticity)
482       &  CALL MOM_CALC_ABSVORT3(bi,bj,k,vort3,omega3,myThid)       &  CALL MOM_CALC_ABSVORT3(bi,bj,k,vort3,omega3,myThid)
483    
# Line 536  C- jmc: change it to keep the Coriolis t Line 534  C- jmc: change it to keep the Coriolis t
534    
535        IF (momAdvection) THEN        IF (momAdvection) THEN
536  C--   Horizontal advection of relative (or absolute) vorticity  C--   Horizontal advection of relative (or absolute) vorticity
537         IF (highOrderVorticity.AND.useAbsVorticity) THEN         IF ( (highOrderVorticity.OR.upwindVorticity)
538         &     .AND.useAbsVorticity ) THEN
539          CALL MOM_VI_U_CORIOLIS_C4(bi,bj,k,vFld,omega3,r_hFacZ,          CALL MOM_VI_U_CORIOLIS_C4(bi,bj,k,vFld,omega3,r_hFacZ,
540       &                         uCf,myThid)       &                         uCf,myThid)
541         ELSEIF (highOrderVorticity) THEN         ELSEIF ( (highOrderVorticity.OR.upwindVorticity) ) THEN
542          CALL MOM_VI_U_CORIOLIS_C4(bi,bj,k,vFld,vort3, r_hFacZ,          CALL MOM_VI_U_CORIOLIS_C4(bi,bj,k,vFld,vort3, r_hFacZ,
543       &                         uCf,myThid)       &                         uCf,myThid)
544         ELSEIF (useAbsVorticity) THEN         ELSEIF ( useAbsVorticity ) THEN
545          CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,hFacZ,r_hFacZ,          CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,hFacZ,r_hFacZ,
546       &                         uCf,myThid)       &                         uCf,myThid)
547         ELSE         ELSE
# Line 554  C--   Horizontal advection of relative ( Line 553  C--   Horizontal advection of relative (
553           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j)           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j)
554          ENDDO          ENDDO
555         ENDDO         ENDDO
556         IF (highOrderVorticity.AND.useAbsVorticity) THEN         IF ( (highOrderVorticity.OR.upwindVorticity)
557         &     .AND.useAbsVorticity ) THEN
558          CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K,uFld,omega3,r_hFacZ,          CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K,uFld,omega3,r_hFacZ,
559       &                         vCf,myThid)       &                         vCf,myThid)
560         ELSEIF (highOrderVorticity) THEN         ELSEIF ( (highOrderVorticity.OR.upwindVorticity) ) THEN
561          CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K,uFld,vort3, r_hFacZ,          CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K,uFld,vort3, r_hFacZ,
562       &                         vCf,myThid)       &                         vCf,myThid)
563         ELSEIF (useAbsVorticity) THEN         ELSEIF ( useAbsVorticity ) THEN
564          CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,hFacZ,r_hFacZ,          CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,hFacZ,r_hFacZ,
565       &                         vCf,myThid)       &                         vCf,myThid)
566         ELSE         ELSE
# Line 656  C--   Bernoulli term Line 656  C--   Bernoulli term
656  C--   end if momAdvection  C--   end if momAdvection
657        ENDIF        ENDIF
658    
659  C--   3.D Coriolis term (horizontal momentum, Eastward component: -f'*w)  C--   3.D Coriolis term (horizontal momentum, Eastward component: -fprime*w)
660        IF ( use3dCoriolis ) THEN        IF ( use3dCoriolis ) THEN
661          CALL MOM_U_CORIOLIS_NH(bi,bj,k,wVel,uCf,myThid)          CALL MOM_U_CORIOLIS_NH(bi,bj,k,wVel,uCf,myThid)
662          DO j=jMin,jMax          DO j=jMin,jMax
# Line 700  C--   Set du/dt & dv/dt on boundaries to Line 700  C--   Set du/dt & dv/dt on boundaries to
700        ENDDO        ENDDO
701    
702  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
703        IF ( debugLevel .GE. debLevB        IF ( debugLevel .GE. debLevC
704       &   .AND. k.EQ.4 .AND. myIter.EQ.nIter0       &   .AND. k.EQ.4 .AND. myIter.EQ.nIter0
705       &   .AND. nPx.EQ.1 .AND. nPy.EQ.1       &   .AND. nPx.EQ.1 .AND. nPy.EQ.1
706       &   .AND. useCubedSphereExchange ) THEN       &   .AND. useCubedSphereExchange ) THEN
# Line 710  C--   Set du/dt & dv/dt on boundaries to Line 710  C--   Set du/dt & dv/dt on boundaries to
710  #endif /* ALLOW_DEBUG */  #endif /* ALLOW_DEBUG */
711    
712        IF ( writeDiag ) THEN        IF ( writeDiag ) THEN
713            IF (useBiharmonicVisc) THEN
714             CALL WRITE_LOCAL_RL( 'del2u', 'I10', 1, del2u,
715         &                        bi,bj,k, myIter, myThid )
716             CALL WRITE_LOCAL_RL( 'del2v', 'I10', 1, del2v,
717         &                        bi,bj,k, myIter, myThid )
718             CALL WRITE_LOCAL_RL( 'dStar', 'I10', 1, dStar,
719         &                        bi,bj,k, myIter, myThid )
720             CALL WRITE_LOCAL_RL( 'zStar', 'I10', 1, zStar,
721         &                        bi,bj,k, myIter, myThid )
722            ENDIF
723          IF (snapshot_mdsio) THEN          IF (snapshot_mdsio) THEN
724           CALL WRITE_LOCAL_RL('W3','I10',1,omega3, bi,bj,k,myIter,myThid)           CALL WRITE_LOCAL_RL('W3','I10',1,omega3, bi,bj,k,myIter,myThid)
725             CALL WRITE_LOCAL_RL('Z3','I10',1,vort3BC,bi,bj,k,myIter,myThid)
726           CALL WRITE_LOCAL_RL('KE','I10',1,KE,     bi,bj,k,myIter,myThid)           CALL WRITE_LOCAL_RL('KE','I10',1,KE,     bi,bj,k,myIter,myThid)
727           CALL WRITE_LOCAL_RL('D', 'I10',1,hDiv,   bi,bj,k,myIter,myThid)           CALL WRITE_LOCAL_RL('D', 'I10',1,hDiv,   bi,bj,k,myIter,myThid)
728           CALL WRITE_LOCAL_RL('Dt','I10',1,tension,bi,bj,k,myIter,myThid)           CALL WRITE_LOCAL_RL('Dt','I10',1,tension,bi,bj,k,myIter,myThid)
729             CALL WRITE_LOCAL_RL( 'Ds', 'I10', 1, strainBC,
730         &                        bi,bj,k, myIter, myThid )
731           CALL WRITE_LOCAL_RL('Du','I10',1,guDiss, bi,bj,k,myIter,myThid)           CALL WRITE_LOCAL_RL('Du','I10',1,guDiss, bi,bj,k,myIter,myThid)
732           CALL WRITE_LOCAL_RL('Dv','I10',1,gvDiss, bi,bj,k,myIter,myThid)           CALL WRITE_LOCAL_RL('Dv','I10',1,gvDiss, bi,bj,k,myIter,myThid)
733          ENDIF          ENDIF
# Line 722  C--   Set du/dt & dv/dt on boundaries to Line 735  C--   Set du/dt & dv/dt on boundaries to
735          IF (useMNC .AND. snapshot_mnc) THEN          IF (useMNC .AND. snapshot_mnc) THEN
736            CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'W3',omega3,            CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'W3',omega3,
737       &          offsets, myThid)       &          offsets, myThid)
738              CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Z3',vort3BC,
739         &          offsets, myThid)
740            CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'KE',KE,            CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'KE',KE,
741       &          offsets, myThid)       &          offsets, myThid)
742            CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'D', hDiv,            CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'D', hDiv,
743       &          offsets, myThid)       &          offsets, myThid)
744            CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Dt',tension,            CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Dt',tension,
745       &          offsets, myThid)       &          offsets, myThid)
746              CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Ds',strainBC,
747         &          offsets, myThid)
748            CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Du',guDiss,            CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Du',guDiss,
749       &          offsets, myThid)       &          offsets, myThid)
750            CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Dv',gvDiss,            CALL MNC_CW_RL_W_OFFSET(pf,'mom_vi',bi,bj,'Dv',gvDiss,
# Line 738  C--   Set du/dt & dv/dt on boundaries to Line 755  C--   Set du/dt & dv/dt on boundaries to
755    
756  #ifdef ALLOW_DIAGNOSTICS  #ifdef ALLOW_DIAGNOSTICS
757        IF ( useDiagnostics ) THEN        IF ( useDiagnostics ) THEN
758            CALL DIAGNOSTICS_FILL(vort3BC,'momVort3',k,1,2,bi,bj,myThid)
759          CALL DIAGNOSTICS_FILL(KE,     'momKE   ',k,1,2,bi,bj,myThid)          CALL DIAGNOSTICS_FILL(KE,     'momKE   ',k,1,2,bi,bj,myThid)
760         IF (momViscosity) THEN         IF (momViscosity) THEN
761          CALL DIAGNOSTICS_FILL(hDiv,   'momHDiv ',k,1,2,bi,bj,myThid)          CALL DIAGNOSTICS_FILL(hDiv,   'momHDiv ',k,1,2,bi,bj,myThid)
         CALL DIAGNOSTICS_FILL(tension,'Tension ',k,1,2,bi,bj,myThid)  
762          CALL DIAGNOSTICS_FILL(guDiss, 'Um_Diss ',k,1,2,bi,bj,myThid)          CALL DIAGNOSTICS_FILL(guDiss, 'Um_Diss ',k,1,2,bi,bj,myThid)
763          CALL DIAGNOSTICS_FILL(gvDiss, 'Vm_Diss ',k,1,2,bi,bj,myThid)          CALL DIAGNOSTICS_FILL(gvDiss, 'Vm_Diss ',k,1,2,bi,bj,myThid)
764         ENDIF         ENDIF
765          CALL DIAGNOSTICS_FILL(gU(1-Olx,1-Oly,k,bi,bj),         IF ( useVariableVisc .OR. useStrainTensionVisc ) THEN
766            CALL DIAGNOSTICS_FILL(tension, 'Tension ',k,1,2,bi,bj,myThid)
767            CALL DIAGNOSTICS_FILL(strainBC,'Strain  ',k,1,2,bi,bj,myThid)
768           ENDIF
769            CALL DIAGNOSTICS_FILL(gU(1-OLx,1-OLy,k,bi,bj),
770       &                                'Um_Advec',k,1,2,bi,bj,myThid)       &                                'Um_Advec',k,1,2,bi,bj,myThid)
771          CALL DIAGNOSTICS_FILL(gV(1-Olx,1-Oly,k,bi,bj),          CALL DIAGNOSTICS_FILL(gV(1-OLx,1-OLy,k,bi,bj),
772       &                                'Vm_Advec',k,1,2,bi,bj,myThid)       &                                'Vm_Advec',k,1,2,bi,bj,myThid)
773        ENDIF        ENDIF
774  #endif /* ALLOW_DIAGNOSTICS */  #endif /* ALLOW_DIAGNOSTICS */
Legend:
Removed from v.1.60  
changed lines
  Added in v.1.72
  ViewVC Help
Powered by ViewVC 1.1.22