/[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.4 by jmc, Sat Feb 8 02:10:57 2003 UTC revision 1.12 by jmc, Sat Jan 3 00:51:42 2004 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  C $Name$
3    
4    #include "PACKAGES_CONFIG.h"
5  #include "CPP_OPTIONS.h"  #include "CPP_OPTIONS.h"
6    
7        SUBROUTINE MOM_VECINV(        SUBROUTINE MOM_VECINV(
# Line 31  C     == Global variables == Line 32  C     == Global variables ==
32  #include "EEPARAMS.h"  #include "EEPARAMS.h"
33  #include "PARAMS.h"  #include "PARAMS.h"
34  #include "GRID.h"  #include "GRID.h"
35    #ifdef ALLOW_TIMEAVE
36    #include "TIMEAVE_STATV.h"
37    #endif
38    
39  C     == Routine arguments ==  C     == Routine arguments ==
40  C     fVerU   - Flux of momentum in the vertical  C     fVerU   - Flux of momentum in the vertical
# Line 53  C     myThid - Instance number for this Line 57  C     myThid - Instance number for this
57        INTEGER myThid        INTEGER myThid
58        INTEGER bi,bj,iMin,iMax,jMin,jMax        INTEGER bi,bj,iMin,iMax,jMin,jMax
59    
60    #ifdef ALLOW_MOM_VECINV
61    
62  C     == Functions ==  C     == Functions ==
63        LOGICAL  DIFFERENT_MULTIPLE        LOGICAL  DIFFERENT_MULTIPLE
64        EXTERNAL DIFFERENT_MULTIPLE        EXTERNAL DIFFERENT_MULTIPLE
# Line 73  C     == Local variables == Line 79  C     == Local variables ==
79        _RS r_hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS r_hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
80        _RS xA(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS xA(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
81        _RS yA(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS yA(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
       _RL uTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL vTrans(1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
82        _RL uFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL uFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
83        _RL vFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vFld(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
84        _RL dStar(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL dStar(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
# Line 112  C     xxxFac - On-off tracer parameters Line 116  C     xxxFac - On-off tracer parameters
116        _RL  phyFac        _RL  phyFac
117        _RL  vForcFac        _RL  vForcFac
118        _RL  mtFacV        _RL  mtFacV
       INTEGER km1,kp1  
119        _RL wVelBottomOverride        _RL wVelBottomOverride
120        LOGICAL bottomDragTerms        LOGICAL bottomDragTerms
121        _RL KE(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL KE(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
# Line 120  C     xxxFac - On-off tracer parameters Line 123  C     xxxFac - On-off tracer parameters
123        _RL vort3(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vort3(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
124        _RL hDiv(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL hDiv(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
125    
126        km1=MAX(1,k-1)  #ifdef ALLOW_AUTODIFF_TAMC
127        kp1=MIN(Nr,k+1)  C--   only the kDown part of fverU/V is set in this subroutine
128    C--   the kUp is still required
129    C--   In the case of mom_fluxform Kup is set as well
130    C--   (at least in part)
131          fVerU(1,1,kUp) = fVerU(1,1,kUp)
132          fVerV(1,1,kUp) = fVerV(1,1,kUp)
133    #endif
134    
135        rVelMaskOverride=1.        rVelMaskOverride=1.
136        IF ( k .EQ. 1 ) rVelMaskOverride=freeSurfFac        IF ( k .EQ. 1 ) rVelMaskOverride=freeSurfFac
137        wVelBottomOverride=1.        wVelBottomOverride=1.
# Line 146  C     Initialise intermediate terms Line 156  C     Initialise intermediate terms
156          vort3(i,j) = 0.          vort3(i,j) = 0.
157          omega3(i,j) = 0.          omega3(i,j) = 0.
158          ke(i,j) = 0.          ke(i,j) = 0.
159    #ifdef ALLOW_AUTODIFF_TAMC
160            strain(i,j)  = 0. _d 0
161            tension(i,j) = 0. _d 0
162    #endif
163         ENDDO         ENDDO
164        ENDDO        ENDDO
165    
# Line 212  C     Make local copies of horizontal fl Line 226  C     Make local copies of horizontal fl
226         ENDDO         ENDDO
227        ENDDO        ENDDO
228    
229  C     Calculate velocity field "volume transports" through tracer cell faces.  C note (jmc) : Dissipation and Vort3 advection do not necesary
230        DO j=1-OLy,sNy+OLy  C              use the same maskZ (and hFacZ)  => needs 2 call(s)
231         DO i=1-OLx,sNx+OLx  c     CALL MOM_VI_HFACZ_DISS(bi,bj,k,hFacZ,r_hFacZ,myThid)
         uTrans(i,j) = uFld(i,j)*xA(i,j)  
         vTrans(i,j) = vFld(i,j)*yA(i,j)  
        ENDDO  
       ENDDO  
232    
233        CALL MOM_VI_CALC_KE(bi,bj,k,uFld,vFld,KE,myThid)        CALL MOM_VI_CALC_KE(bi,bj,k,uFld,vFld,KE,myThid)
234    
# Line 226  C     Calculate velocity field "volume t Line 236  C     Calculate velocity field "volume t
236    
237        CALL MOM_VI_CALC_RELVORT3(bi,bj,k,uFld,vFld,hFacZ,vort3,myThid)        CALL MOM_VI_CALC_RELVORT3(bi,bj,k,uFld,vFld,hFacZ,vort3,myThid)
238    
239        CALL MOM_VI_CALC_ABSVORT3(bi,bj,k,vort3,omega3,myThid)  c     CALL MOM_VI_CALC_ABSVORT3(bi,bj,k,vort3,omega3,myThid)
240    
241        IF (momViscosity) THEN        IF (momViscosity) THEN
242  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
# Line 260  C      or in terms of tension and strain Line 270  C      or in terms of tension and strain
270         ENDIF         ENDIF
271        ENDIF        ENDIF
272    
273    C-    Return to standard hfacZ (min-4) and mask vort3 accordingly:
274    c     CALL MOM_VI_MASK_VORT3(bi,bj,k,hFacZ,r_hFacZ,vort3,myThid)
275    
276  C---- Zonal momentum equation starts here  C---- Zonal momentum equation starts here
277    
278  C--   Vertical flux (fVer is at upper face of "u" cell)  C--   Vertical flux (fVer is at upper face of "u" cell)
# Line 298  C-     No-slip BCs impose a drag at wall Line 311  C-     No-slip BCs impose a drag at wall
311          ENDDO          ENDDO
312         ENDDO         ENDDO
313        ENDIF        ENDIF
314    
315  C-    No-slip BCs impose a drag at bottom  C-    No-slip BCs impose a drag at bottom
316        IF (momViscosity.AND.bottomDragTerms) THEN        IF (momViscosity.AND.bottomDragTerms) THEN
317         CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)         CALL MOM_U_BOTTOMDRAG(bi,bj,k,uFld,KE,KappaRU,vF,myThid)
# Line 308  C-    No-slip BCs impose a drag at botto Line 322  C-    No-slip BCs impose a drag at botto
322         ENDDO         ENDDO
323        ENDIF        ENDIF
324    
 C--   Forcing term  
       IF (momForcing)  
      &  CALL EXTERNAL_FORCING_U(  
      I     iMin,iMax,jMin,jMax,bi,bj,k,  
      I     myCurrentTime,myThid)  
   
325  C--   Metric terms for curvilinear grid systems  C--   Metric terms for curvilinear grid systems
326  c     IF (usingSphericalPolarMTerms) THEN  c     IF (usingSphericalPolarMTerms) THEN
327  C      o Spherical polar grid metric terms  C      o Spherical polar grid metric terms
# Line 325  c       ENDDO Line 333  c       ENDDO
333  c      ENDDO  c      ENDDO
334  c     ENDIF  c     ENDIF
335    
 C--   Set du/dt on boundaries to zero  
       DO j=jMin,jMax  
        DO i=iMin,iMax  
         gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)*_maskW(i,j,k,bi,bj)  
        ENDDO  
       ENDDO  
   
   
336  C---- Meridional momentum equation starts here  C---- Meridional momentum equation starts here
337    
338  C--   Vertical flux (fVer is at upper face of "v" cell)  C--   Vertical flux (fVer is at upper face of "v" cell)
# Line 381  C-    No-slip BCs impose a drag at botto Line 381  C-    No-slip BCs impose a drag at botto
381         ENDDO         ENDDO
382        ENDIF        ENDIF
383    
 C--   Forcing term  
       IF (momForcing)  
      & CALL EXTERNAL_FORCING_V(  
      I     iMin,iMax,jMin,jMax,bi,bj,k,  
      I     myCurrentTime,myThid)  
   
384  C--   Metric terms for curvilinear grid systems  C--   Metric terms for curvilinear grid systems
385  c     IF (usingSphericalPolarMTerms) THEN  c     IF (usingSphericalPolarMTerms) THEN
386  C      o Spherical polar grid metric terms  C      o Spherical polar grid metric terms
# Line 398  c       ENDDO Line 392  c       ENDDO
392  c      ENDDO  c      ENDDO
393  c     ENDIF  c     ENDIF
394    
 C--   Set dv/dt on boundaries to zero  
       DO j=jMin,jMax  
        DO i=iMin,iMax  
         gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)*_maskS(i,j,k,bi,bj)  
        ENDDO  
       ENDDO  
   
395  C--   Horizontal Coriolis terms  C--   Horizontal Coriolis terms
396        CALL MOM_VI_CORIOLIS(bi,bj,K,uFld,vFld,omega3,r_hFacZ,        IF (useCoriolis .AND. .NOT.useCDscheme) THEN
397       &                     uCf,vCf,myThid)         CALL MOM_VI_CORIOLIS(bi,bj,k,uFld,vFld,omega3,hFacZ,r_hFacZ,
398        DO j=jMin,jMax       &                      uCf,vCf,myThid)
399         DO i=iMin,iMax         DO j=jMin,jMax
400          gU(i,j,k,bi,bj) = (gU(i,j,k,bi,bj)+uCf(i,j))          DO i=iMin,iMax
401       &                    *_maskW(i,j,k,bi,bj)           gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j)
402          gV(i,j,k,bi,bj) = (gV(i,j,k,bi,bj)+vCf(i,j))           gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)
403       &                    *_maskS(i,j,k,bi,bj)          ENDDO
        ENDDO  
       ENDDO  
 c     CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,r_hFacZ,uCf,myThid)  
       CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,vort3,r_hFacZ,uCf,myThid)  
 c     CALL MOM_VI_U_CORIOLIS_C4(bi,bj,K,vFld,vort3,r_hFacZ,uCf,myThid)  
       DO j=jMin,jMax  
        DO i=iMin,iMax  
         gU(i,j,k,bi,bj) = (gU(i,j,k,bi,bj)+uCf(i,j))  
      &                    *_maskW(i,j,k,bi,bj)  
        ENDDO  
       ENDDO  
 c     CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,r_hFacZ,vCf,myThid)  
       CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,vort3,r_hFacZ,vCf,myThid)  
 c     CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K,uFld,vort3,r_hFacZ,vCf,myThid)  
       DO j=jMin,jMax  
        DO i=iMin,iMax  
         gV(i,j,k,bi,bj) = (gV(i,j,k,bi,bj)+vCf(i,j))  
      &                    *_maskS(i,j,k,bi,bj)  
404         ENDDO         ENDDO
405        ENDDO        ENDIF
406    
407        IF (momAdvection) THEN        IF (momAdvection) THEN
408  C--   Vertical shear terms (Coriolis)  C--   Horizontal advection of relative vorticity
409        CALL MOM_VI_U_VERTSHEAR(bi,bj,K,uVel,wVel,uCf,myThid)  c      CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,r_hFacZ,uCf,myThid)
410        DO j=jMin,jMax         CALL MOM_VI_U_CORIOLIS(bi,bj,k,vFld,vort3,hFacZ,r_hFacZ,
411         DO i=iMin,iMax       &                        uCf,myThid)
412          gU(i,j,k,bi,bj) = (gU(i,j,k,bi,bj)+uCf(i,j))  c      CALL MOM_VI_U_CORIOLIS_C4(bi,bj,K,vFld,vort3,r_hFacZ,uCf,myThid)
413       &                    *_maskW(i,j,k,bi,bj)         DO j=jMin,jMax
414            DO i=iMin,iMax
415             gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j)
416            ENDDO
417         ENDDO         ENDDO
418        ENDDO  c      CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,r_hFacZ,vCf,myThid)
419        CALL MOM_VI_V_VERTSHEAR(bi,bj,K,vVel,wVel,vCf,myThid)         CALL MOM_VI_V_CORIOLIS(bi,bj,k,uFld,vort3,hFacZ,r_hFacZ,
420        DO j=jMin,jMax       &                        vCf,myThid)
421         DO i=iMin,iMax  c      CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K,uFld,vort3,r_hFacZ,vCf,myThid)
422          gV(i,j,k,bi,bj) = (gV(i,j,k,bi,bj)+vCf(i,j))         DO j=jMin,jMax
423       &                    *_maskS(i,j,k,bi,bj)          DO i=iMin,iMax
424             gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)
425            ENDDO
426         ENDDO         ENDDO
427        ENDDO  
428    #ifdef ALLOW_TIMEAVE
429           IF (taveFreq.GT.0.) THEN
430             CALL TIMEAVE_CUMUL_1K1T(uZetatave,vCf,deltaTClock,
431         &                           Nr, k, bi, bj, myThid)
432             CALL TIMEAVE_CUMUL_1K1T(vZetatave,uCf,deltaTClock,
433         &                           Nr, k, bi, bj, myThid)
434           ENDIF
435    #endif
436    
437    C--   Vertical shear terms (-w*du/dr & -w*dv/dr)
438           IF ( .NOT. momImplVertAdv ) THEN
439            CALL MOM_VI_U_VERTSHEAR(bi,bj,K,uVel,wVel,uCf,myThid)
440            DO j=jMin,jMax
441             DO i=iMin,iMax
442              gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j)
443             ENDDO
444            ENDDO
445            CALL MOM_VI_V_VERTSHEAR(bi,bj,K,vVel,wVel,vCf,myThid)
446            DO j=jMin,jMax
447             DO i=iMin,iMax
448              gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)
449             ENDDO
450            ENDDO
451           ENDIF
452    
453  C--   Bernoulli term  C--   Bernoulli term
454        CALL MOM_VI_U_GRAD_KE(bi,bj,K,KE,uCf,myThid)         CALL MOM_VI_U_GRAD_KE(bi,bj,K,KE,uCf,myThid)
455        DO j=jMin,jMax         DO j=jMin,jMax
456         DO i=iMin,iMax          DO i=iMin,iMax
457          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)
458       &                    *_maskW(i,j,k,bi,bj)          ENDDO
459         ENDDO         ENDDO
460        ENDDO         CALL MOM_VI_V_GRAD_KE(bi,bj,K,KE,vCf,myThid)
461        CALL MOM_VI_V_GRAD_KE(bi,bj,K,KE,vCf,myThid)         DO j=jMin,jMax
462            DO i=iMin,iMax
463             gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j)
464            ENDDO
465           ENDDO
466    C--   end if momAdvection
467          ENDIF
468    
469    C--   Set du/dt & dv/dt on boundaries to zero
470        DO j=jMin,jMax        DO j=jMin,jMax
471         DO i=iMin,iMax         DO i=iMin,iMax
472          gV(i,j,k,bi,bj) = (gV(i,j,k,bi,bj)+vCf(i,j))          gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)*_maskW(i,j,k,bi,bj)
473       &                    *_maskS(i,j,k,bi,bj)          gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)*_maskS(i,j,k,bi,bj)
474         ENDDO         ENDDO
475        ENDDO        ENDDO
476        ENDIF  
477    
478        IF (        IF (
479       &  DIFFERENT_MULTIPLE(diagFreq,myCurrentTime,       &  DIFFERENT_MULTIPLE(diagFreq,myCurrentTime,
# Line 480  C--   Bernoulli term Line 486  C--   Bernoulli term
486         CALL WRITE_LOCAL_RL('Du','I10',1,uDiss,bi,bj,k,myIter,myThid)         CALL WRITE_LOCAL_RL('Du','I10',1,uDiss,bi,bj,k,myIter,myThid)
487         CALL WRITE_LOCAL_RL('Dv','I10',1,vDiss,bi,bj,k,myIter,myThid)         CALL WRITE_LOCAL_RL('Dv','I10',1,vDiss,bi,bj,k,myIter,myThid)
488         CALL WRITE_LOCAL_RL('Z3','I10',1,vort3,bi,bj,k,myIter,myThid)         CALL WRITE_LOCAL_RL('Z3','I10',1,vort3,bi,bj,k,myIter,myThid)
489         CALL WRITE_LOCAL_RL('W3','I10',1,omega3,bi,bj,k,myIter,myThid)  c      CALL WRITE_LOCAL_RL('W3','I10',1,omega3,bi,bj,k,myIter,myThid)
490         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)
491         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)
492        ENDIF        ENDIF
493    
494    #endif /* ALLOW_MOM_VECINV */
495    
496        RETURN        RETURN
497        END        END
Legend:
Removed from v.1.4  
changed lines
  Added in v.1.12
  ViewVC Help
Powered by ViewVC 1.1.22