/[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.13 by dimitri, Sun Jan 25 00:31:52 2004 UTC revision 1.27 by edhill, Wed Oct 13 04:37:37 2004 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  C $Name$
3    
4  #include "PACKAGES_CONFIG.h"  #include "MOM_VECINV_OPTIONS.h"
 #include "CPP_OPTIONS.h"  
5    
6        SUBROUTINE MOM_VECINV(        SUBROUTINE MOM_VECINV(
7       I        bi,bj,iMin,iMax,jMin,jMax,k,kUp,kDown,       I        bi,bj,iMin,iMax,jMin,jMax,k,kUp,kDown,
8       I        dPhiHydX,dPhiHydY,KappaRU,KappaRV,       I        dPhiHydX,dPhiHydY,KappaRU,KappaRV,
9       U        fVerU, fVerV,       U        fVerU, fVerV,
10       I        myCurrentTime, myIter, myThid)       I        myTime, myIter, myThid)
11  C     /==========================================================\  C     /==========================================================\
12  C     | S/R MOM_VECINV                                           |  C     | S/R MOM_VECINV                                           |
13  C     | o Form the right hand-side of the momentum equation.     |  C     | o Form the right hand-side of the momentum equation.     |
# Line 31  C     == Global variables == Line 30  C     == Global variables ==
30  #include "DYNVARS.h"  #include "DYNVARS.h"
31  #include "EEPARAMS.h"  #include "EEPARAMS.h"
32  #include "PARAMS.h"  #include "PARAMS.h"
33    #ifdef ALLOW_MNC
34    #include "MNC_PARAMS.h"
35    #endif
36  #include "GRID.h"  #include "GRID.h"
37  #ifdef ALLOW_TIMEAVE  #ifdef ALLOW_TIMEAVE
38  #include "TIMEAVE_STATV.h"  #include "TIMEAVE_STATV.h"
# Line 52  C     myThid - Instance number for this Line 54  C     myThid - Instance number for this
54        _RL fVerU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
55        _RL fVerV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
56        INTEGER kUp,kDown        INTEGER kUp,kDown
57        _RL     myCurrentTime        _RL     myTime
58        INTEGER myIter        INTEGER myIter
59        INTEGER myThid        INTEGER myThid
60        INTEGER bi,bj,iMin,iMax,jMin,jMax        INTEGER bi,bj,iMin,iMax,jMin,jMax
# Line 118  C     xxxFac - On-off tracer parameters Line 120  C     xxxFac - On-off tracer parameters
120        _RL  mtFacV        _RL  mtFacV
121        _RL wVelBottomOverride        _RL wVelBottomOverride
122        LOGICAL bottomDragTerms        LOGICAL bottomDragTerms
123          LOGICAL writeDiag
124        _RL KE(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL KE(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
125        _RL omega3(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL omega3(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
126        _RL vort3(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vort3(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
127        _RL hDiv(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL hDiv(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
128    
129    #ifdef ALLOW_MNC
130          INTEGER offsets(9)
131    #endif
132    
133  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
134  C--   only the kDown part of fverU/V is set in this subroutine  C--   only the kDown part of fverU/V is set in this subroutine
135  C--   the kUp is still required  C--   the kUp is still required
# Line 136  C--   (at least in part) Line 143  C--   (at least in part)
143        IF ( k .EQ. 1 ) rVelMaskOverride=freeSurfFac        IF ( k .EQ. 1 ) rVelMaskOverride=freeSurfFac
144        wVelBottomOverride=1.        wVelBottomOverride=1.
145        IF (k.EQ.Nr) wVelBottomOverride=0.        IF (k.EQ.Nr) wVelBottomOverride=0.
146          writeDiag = DIFFERENT_MULTIPLE(diagFreq, myTime,
147         &                                         myTime-deltaTClock)
148    
149    #ifdef ALLOW_MNC
150          IF (useMNC .AND. snapshot_mnc .AND. writeDiag) THEN
151            IF ((bi .EQ. 1).AND.(bj .EQ. 1).AND.(k .EQ. 1)) THEN
152              CALL MNC_CW_SET_UDIM('mom_vi', -1, myThid)
153              CALL MNC_CW_I_W_S('I','mom_vi',0,0,'iter',myIter,myThid)
154              CALL MNC_CW_SET_UDIM('mom_vi', 0, myThid)
155            ENDIF
156            DO i = 1,9
157              offsets(i) = 0
158            ENDDO
159            offsets(3) = k
160    C       write(*,*) 'offsets = ',(offsets(i),i=1,9)
161          ENDIF
162    #endif /*  ALLOW_MNC  */
163    
164  C     Initialise intermediate terms  C     Initialise intermediate terms
165        DO J=1-OLy,sNy+OLy        DO J=1-OLy,sNy+OLy
# Line 230  C note (jmc) : Dissipation and Vort3 adv Line 254  C note (jmc) : Dissipation and Vort3 adv
254  C              use the same maskZ (and hFacZ)  => needs 2 call(s)  C              use the same maskZ (and hFacZ)  => needs 2 call(s)
255  c     CALL MOM_VI_HFACZ_DISS(bi,bj,k,hFacZ,r_hFacZ,myThid)  c     CALL MOM_VI_HFACZ_DISS(bi,bj,k,hFacZ,r_hFacZ,myThid)
256    
257        CALL MOM_VI_CALC_KE(bi,bj,k,uFld,vFld,KE,myThid)        CALL MOM_CALC_KE(bi,bj,k,2,uFld,vFld,KE,myThid)
258    
259        CALL MOM_VI_CALC_HDIV(bi,bj,k,uFld,vFld,hDiv,myThid)        CALL MOM_CALC_HDIV(bi,bj,k,2,uFld,vFld,hDiv,myThid)
260    
261        CALL MOM_VI_CALC_RELVORT3(bi,bj,k,uFld,vFld,hFacZ,vort3,myThid)        CALL MOM_CALC_RELVORT3(bi,bj,k,uFld,vFld,hFacZ,vort3,myThid)
262    
263  c     CALL MOM_VI_CALC_ABSVORT3(bi,bj,k,vort3,omega3,myThid)        IF (useAbsVorticity)
264         & CALL MOM_CALC_ABSVORT3(bi,bj,k,vort3,omega3,myThid)
265    
266        IF (momViscosity) THEN        IF (momViscosity) THEN
267  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
268         IF (viscA4.NE.0.) THEN         IF (viscA4.NE.0.
269         &     .OR. viscA4Grid.NE.0.
270         &     .OR. viscC4leith.NE.0.
271         &    ) THEN
272           CALL MOM_VI_DEL2UV(bi,bj,k,hDiv,vort3,hFacZ,           CALL MOM_VI_DEL2UV(bi,bj,k,hDiv,vort3,hFacZ,
273       O                      del2u,del2v,       O                      del2u,del2v,
274       &                      myThid)       &                      myThid)
275           CALL MOM_VI_CALC_HDIV(bi,bj,k,del2u,del2v,dStar,myThid)           CALL MOM_CALC_HDIV(bi,bj,k,2,del2u,del2v,dStar,myThid)
276           CALL MOM_VI_CALC_RELVORT3(           CALL MOM_CALC_RELVORT3(
277       &                         bi,bj,k,del2u,del2v,hFacZ,zStar,myThid)       &                         bi,bj,k,del2u,del2v,hFacZ,zStar,myThid)
278         ENDIF         ENDIF
279  C      Calculate dissipation terms for U and V equations  C      Calculate dissipation terms for U and V equations
280  C      in terms of vorticity and divergence  C      in terms of vorticity and divergence
281         IF (viscAh.NE.0. .OR. viscA4.NE.0.) THEN         IF (viscAh.NE.0. .OR. viscA4.NE.0.
282         &    .OR.  viscAhGrid.NE.0. .OR. viscA4Grid.NE.0.
283         &    .OR.  viscC2leith.NE.0. .OR. viscC4leith.NE.0.
284         &    ) THEN
285           CALL MOM_VI_HDISSIP(bi,bj,k,hDiv,vort3,hFacZ,dStar,zStar,           CALL MOM_VI_HDISSIP(bi,bj,k,hDiv,vort3,hFacZ,dStar,zStar,
286       O                       uDiss,vDiss,       O                       uDiss,vDiss,
287       &                       myThid)       &                       myThid)
# Line 393  c      ENDDO Line 424  c      ENDDO
424  c     ENDIF  c     ENDIF
425    
426  C--   Horizontal Coriolis terms  C--   Horizontal Coriolis terms
427        IF (useCoriolis .AND. .NOT.useCDscheme) THEN        IF (useCoriolis .AND. .NOT.useCDscheme
428         CALL MOM_VI_CORIOLIS(bi,bj,k,uFld,vFld,omega3,hFacZ,r_hFacZ,       &    .AND. .NOT. useAbsVorticity) THEN
429           CALL MOM_VI_CORIOLIS(bi,bj,k,uFld,vFld,hFacZ,r_hFacZ,
430       &                      uCf,vCf,myThid)       &                      uCf,vCf,myThid)
431         DO j=jMin,jMax         DO j=jMin,jMax
432          DO i=iMin,iMax          DO i=iMin,iMax
# Line 402  C--   Horizontal Coriolis terms Line 434  C--   Horizontal Coriolis terms
434           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)
435          ENDDO          ENDDO
436         ENDDO         ENDDO
437           IF ( writeDiag ) THEN
438             IF (snapshot_mdsio) THEN
439               CALL WRITE_LOCAL_RL('fV','I10',1,uCf,bi,bj,k,myIter,myThid)
440               CALL WRITE_LOCAL_RL('fU','I10',1,vCf,bi,bj,k,myIter,myThid)
441             ENDIF
442    #ifdef ALLOW_MNC
443             IF (useMNC .AND. snapshot_mnc) THEN
444               CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj, 'fV', uCf,
445         &          offsets, myThid)
446               CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj, 'fU', vCf,
447         &          offsets, myThid)
448             ENDIF
449    #endif /*  ALLOW_MNC  */
450           ENDIF
451        ENDIF        ENDIF
452    
453        IF (momAdvection) THEN        IF (momAdvection) THEN
454  C--   Horizontal advection of relative vorticity  C--   Horizontal advection of relative vorticity
455  c      CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,r_hFacZ,uCf,myThid)         IF (useAbsVorticity) THEN
456         CALL MOM_VI_U_CORIOLIS(bi,bj,k,vFld,vort3,hFacZ,r_hFacZ,          CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,hFacZ,r_hFacZ,
457       &                        uCf,myThid)       &                         uCf,myThid)
458           ELSE
459            CALL MOM_VI_U_CORIOLIS(bi,bj,k,vFld,vort3,hFacZ,r_hFacZ,
460         &                         uCf,myThid)
461           ENDIF
462  c      CALL MOM_VI_U_CORIOLIS_C4(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)
463         DO j=jMin,jMax         DO j=jMin,jMax
464          DO i=iMin,iMax          DO i=iMin,iMax
465           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)
466          ENDDO          ENDDO
467         ENDDO         ENDDO
468  c      CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,r_hFacZ,vCf,myThid)         IF (useAbsVorticity) THEN
469         CALL MOM_VI_V_CORIOLIS(bi,bj,k,uFld,vort3,hFacZ,r_hFacZ,          CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,hFacZ,r_hFacZ,
470       &                        vCf,myThid)       &                         vCf,myThid)
471           ELSE
472            CALL MOM_VI_V_CORIOLIS(bi,bj,k,uFld,vort3,hFacZ,r_hFacZ,
473         &                         vCf,myThid)
474           ENDIF
475  c      CALL MOM_VI_V_CORIOLIS_C4(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)
476         DO j=jMin,jMax         DO j=jMin,jMax
477          DO i=iMin,iMax          DO i=iMin,iMax
# Line 425  c      CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K Line 479  c      CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K
479          ENDDO          ENDDO
480         ENDDO         ENDDO
481    
482           IF ( writeDiag ) THEN
483             IF (snapshot_mdsio) THEN
484               CALL WRITE_LOCAL_RL('zV','I10',1,uCf,bi,bj,k,myIter,myThid)
485               CALL WRITE_LOCAL_RL('zU','I10',1,vCf,bi,bj,k,myIter,myThid)
486             ENDIF
487    #ifdef ALLOW_MNC
488             IF (useMNC .AND. snapshot_mnc) THEN
489               CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj, 'zV', uCf,
490         &          offsets, myThid)
491               CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj, 'zU', vCf,
492         &          offsets, myThid)
493             ENDIF
494    #endif /*  ALLOW_MNC  */
495           ENDIF
496    
497  #ifdef ALLOW_TIMEAVE  #ifdef ALLOW_TIMEAVE
498  #ifndef HRCUBE  #ifndef HRCUBE
499         IF (taveFreq.GT.0.) THEN         IF (taveFreq.GT.0.) THEN
# Line 433  c      CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K Line 502  c      CALL MOM_VI_V_CORIOLIS_C4(bi,bj,K
502           CALL TIMEAVE_CUMUL_1K1T(vZetatave,uCf,deltaTClock,           CALL TIMEAVE_CUMUL_1K1T(vZetatave,uCf,deltaTClock,
503       &                           Nr, k, bi, bj, myThid)       &                           Nr, k, bi, bj, myThid)
504         ENDIF         ENDIF
 #endif /* ALLOW_TIMEAVE */  
505  #endif /* ndef HRCUBE */  #endif /* ndef HRCUBE */
506    #endif /* ALLOW_TIMEAVE */
507    
508  C--   Vertical shear terms (-w*du/dr & -w*dv/dr)  C--   Vertical shear terms (-w*du/dr & -w*dv/dr)
509         IF ( .NOT. momImplVertAdv ) THEN         IF ( .NOT. momImplVertAdv ) THEN
# Line 465  C--   Bernoulli term Line 534  C--   Bernoulli term
534           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)
535          ENDDO          ENDDO
536         ENDDO         ENDDO
537           IF ( writeDiag ) THEN
538             IF (snapshot_mdsio) THEN
539               CALL WRITE_LOCAL_RL('KEx','I10',1,uCf,bi,bj,k,myIter,myThid)
540               CALL WRITE_LOCAL_RL('KEy','I10',1,vCf,bi,bj,k,myIter,myThid)
541             ENDIF
542    #ifdef ALLOW_MNC
543             IF (useMNC .AND. snapshot_mnc) THEN
544               CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj, 'KEx', uCf,
545         &          offsets, myThid)
546               CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj, 'KEy', vCf,
547         &          offsets, myThid)
548            ENDIF
549    #endif /*  ALLOW_MNC  */
550           ENDIF
551    
552  C--   end if momAdvection  C--   end if momAdvection
553        ENDIF        ENDIF
554    
# Line 476  C--   Set du/dt & dv/dt on boundaries to Line 560  C--   Set du/dt & dv/dt on boundaries to
560         ENDDO         ENDDO
561        ENDDO        ENDDO
562    
563    #ifdef ALLOW_DEBUG
564        IF (        IF ( debugLevel .GE. debLevB
565       &  DIFFERENT_MULTIPLE(diagFreq,myCurrentTime,       &   .AND. k.EQ.4 .AND. myIter.EQ.nIter0
566       &                     myCurrentTime-deltaTClock)       &   .AND. nPx.EQ.1 .AND. nPy.EQ.1
567       & ) THEN       &   .AND. useCubedSphereExchange ) THEN
568         CALL WRITE_LOCAL_RL('Ds','I10',1,strain,bi,bj,k,myIter,myThid)          CALL DEBUG_CS_CORNER_UV( ' uDiss,vDiss from MOM_VECINV',
569         CALL WRITE_LOCAL_RL('Dt','I10',1,tension,bi,bj,k,myIter,myThid)       &             uDiss,vDiss, k, standardMessageUnit,bi,bj,myThid )
        CALL WRITE_LOCAL_RL('fV','I10',1,uCf,bi,bj,k,myIter,myThid)  
        CALL WRITE_LOCAL_RL('fU','I10',1,vCf,bi,bj,k,myIter,myThid)  
        CALL WRITE_LOCAL_RL('Du','I10',1,uDiss,bi,bj,k,myIter,myThid)  
        CALL WRITE_LOCAL_RL('Dv','I10',1,vDiss,bi,bj,k,myIter,myThid)  
        CALL WRITE_LOCAL_RL('Z3','I10',1,vort3,bi,bj,k,myIter,myThid)  
 c      CALL WRITE_LOCAL_RL('W3','I10',1,omega3,bi,bj,k,myIter,myThid)  
        CALL WRITE_LOCAL_RL('KE','I10',1,KE,bi,bj,k,myIter,myThid)  
        CALL WRITE_LOCAL_RL('D','I10',1,hdiv,bi,bj,k,myIter,myThid)  
570        ENDIF        ENDIF
571    #endif /* ALLOW_DEBUG */
572    
573          IF ( writeDiag ) THEN
574            IF (snapshot_mdsio) THEN
575              CALL WRITE_LOCAL_RL('Ds','I10',1,strain,bi,bj,k,myIter,myThid)
576              CALL WRITE_LOCAL_RL('Dt','I10',1,tension,bi,bj,k,myIter,
577         &         myThid)
578              CALL WRITE_LOCAL_RL('Du','I10',1,uDiss,bi,bj,k,myIter,myThid)
579              CALL WRITE_LOCAL_RL('Dv','I10',1,vDiss,bi,bj,k,myIter,myThid)
580              CALL WRITE_LOCAL_RL('Z3','I10',1,vort3,bi,bj,k,myIter,myThid)
581              CALL WRITE_LOCAL_RL('W3','I10',1,omega3,bi,bj,k,myIter,myThid)
582              CALL WRITE_LOCAL_RL('KE','I10',1,KE,bi,bj,k,myIter,myThid)
583              CALL WRITE_LOCAL_RL('D','I10',1,hdiv,bi,bj,k,myIter,myThid)
584            ENDIF
585    #ifdef ALLOW_MNC
586            IF (useMNC .AND. snapshot_mnc) THEN
587              CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj,'Ds',strain,
588         &          offsets, myThid)
589              CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj,'Dt',tension,
590         &          offsets, myThid)
591              CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj,'Du',uDiss,
592         &          offsets, myThid)
593              CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj,'Dv',vDiss,
594         &          offsets, myThid)
595              CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj,'Z3',vort3,
596         &          offsets, myThid)
597              CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj,'W3',omega3,
598         &          offsets, myThid)
599              CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj,'KE',KE,
600         &          offsets, myThid)
601              CALL MNC_CW_RL_W_OFFSET('D','mom_vi',bi,bj,'D', hdiv,
602         &          offsets, myThid)
603            ENDIF
604    #endif /*  ALLOW_MNC  */
605          ENDIF
606          
607  #endif /* ALLOW_MOM_VECINV */  #endif /* ALLOW_MOM_VECINV */
608    
609        RETURN        RETURN
Legend:
Removed from v.1.13  
changed lines
  Added in v.1.27
  ViewVC Help
Powered by ViewVC 1.1.22