1 |
C $Header$ |
C $Header$ |
2 |
C $Name$ |
C $Name$ |
3 |
|
|
4 |
#include "CPP_OPTIONS.h" |
#include "MOM_VECINV_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. | |
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" |
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 |
61 |
|
|
62 |
#ifndef DISABLE_MOM_VECINV |
#ifdef ALLOW_MOM_VECINV |
63 |
|
|
64 |
C == Functions == |
C == Functions == |
65 |
LOGICAL DIFFERENT_MULTIPLE |
LOGICAL DIFFERENT_MULTIPLE |
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) |
139 |
IF ( k .EQ. 1 ) rVelMaskOverride=freeSurfFac |
IF ( k .EQ. 1 ) rVelMaskOverride=freeSurfFac |
140 |
wVelBottomOverride=1. |
wVelBottomOverride=1. |
141 |
IF (k.EQ.Nr) wVelBottomOverride=0. |
IF (k.EQ.Nr) wVelBottomOverride=0. |
142 |
|
writeDiag = DIFFERENT_MULTIPLE(diagFreq, myTime, |
143 |
|
& myTime-deltaTClock) |
144 |
|
|
145 |
|
#ifdef ALLOW_MNC |
146 |
|
IF (useMNC .AND. snapshot_mnc .AND. writeDiag) THEN |
147 |
|
CALL MNC_CW_SET_UDIM('mom_vi', -1, myThid) |
148 |
|
CALL MNC_CW_I_W_S('I','mom_vi',0,0,'iter',myIter,myThid) |
149 |
|
CALL MNC_CW_SET_UDIM('mom_vi', 0, myThid) |
150 |
|
ENDIF |
151 |
|
#endif /* ALLOW_MNC */ |
152 |
|
|
153 |
C Initialise intermediate terms |
C Initialise intermediate terms |
154 |
DO J=1-OLy,sNy+OLy |
DO J=1-OLy,sNy+OLy |
243 |
C use the same maskZ (and hFacZ) => needs 2 call(s) |
C use the same maskZ (and hFacZ) => needs 2 call(s) |
244 |
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) |
245 |
|
|
246 |
CALL MOM_VI_CALC_KE(bi,bj,k,uFld,vFld,KE,myThid) |
CALL MOM_CALC_KE(bi,bj,k,2,uFld,vFld,KE,myThid) |
247 |
|
|
248 |
CALL MOM_VI_CALC_HDIV(bi,bj,k,uFld,vFld,hDiv,myThid) |
CALL MOM_CALC_HDIV(bi,bj,k,2,uFld,vFld,hDiv,myThid) |
249 |
|
|
250 |
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) |
251 |
|
|
252 |
c CALL MOM_VI_CALC_ABSVORT3(bi,bj,k,vort3,omega3,myThid) |
IF (useAbsVorticity) |
253 |
|
& CALL MOM_CALC_ABSVORT3(bi,bj,k,vort3,omega3,myThid) |
254 |
|
|
255 |
IF (momViscosity) THEN |
IF (momViscosity) THEN |
256 |
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 |
257 |
IF (viscA4.NE.0.) THEN |
IF (viscA4.NE.0. |
258 |
|
& .OR. viscA4Grid.NE.0. |
259 |
|
& .OR. viscC4leith.NE.0. |
260 |
|
& ) THEN |
261 |
CALL MOM_VI_DEL2UV(bi,bj,k,hDiv,vort3,hFacZ, |
CALL MOM_VI_DEL2UV(bi,bj,k,hDiv,vort3,hFacZ, |
262 |
O del2u,del2v, |
O del2u,del2v, |
263 |
& myThid) |
& myThid) |
264 |
CALL MOM_VI_CALC_HDIV(bi,bj,k,del2u,del2v,dStar,myThid) |
CALL MOM_CALC_HDIV(bi,bj,k,2,del2u,del2v,dStar,myThid) |
265 |
CALL MOM_VI_CALC_RELVORT3( |
CALL MOM_CALC_RELVORT3( |
266 |
& bi,bj,k,del2u,del2v,hFacZ,zStar,myThid) |
& bi,bj,k,del2u,del2v,hFacZ,zStar,myThid) |
267 |
ENDIF |
ENDIF |
268 |
C Calculate dissipation terms for U and V equations |
C Calculate dissipation terms for U and V equations |
269 |
C in terms of vorticity and divergence |
C in terms of vorticity and divergence |
270 |
IF (viscAh.NE.0. .OR. viscA4.NE.0.) THEN |
IF (viscAh.NE.0. .OR. viscA4.NE.0. |
271 |
|
& .OR. viscAhGrid.NE.0. .OR. viscA4Grid.NE.0. |
272 |
|
& .OR. viscC2leith.NE.0. .OR. viscC4leith.NE.0. |
273 |
|
& ) THEN |
274 |
CALL MOM_VI_HDISSIP(bi,bj,k,hDiv,vort3,hFacZ,dStar,zStar, |
CALL MOM_VI_HDISSIP(bi,bj,k,hDiv,vort3,hFacZ,dStar,zStar, |
275 |
O uDiss,vDiss, |
O uDiss,vDiss, |
276 |
& myThid) |
& myThid) |
413 |
c ENDIF |
c ENDIF |
414 |
|
|
415 |
C-- Horizontal Coriolis terms |
C-- Horizontal Coriolis terms |
416 |
IF (useCoriolis .AND. .NOT.useCDscheme) THEN |
IF (useCoriolis .AND. .NOT.useCDscheme |
417 |
CALL MOM_VI_CORIOLIS(bi,bj,k,uFld,vFld,omega3,hFacZ,r_hFacZ, |
& .AND. .NOT. useAbsVorticity) THEN |
418 |
|
CALL MOM_VI_CORIOLIS(bi,bj,k,uFld,vFld,hFacZ,r_hFacZ, |
419 |
& uCf,vCf,myThid) |
& uCf,vCf,myThid) |
420 |
DO j=jMin,jMax |
DO j=jMin,jMax |
421 |
DO i=iMin,iMax |
DO i=iMin,iMax |
423 |
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) |
424 |
ENDDO |
ENDDO |
425 |
ENDDO |
ENDDO |
426 |
|
IF ( writeDiag ) THEN |
427 |
|
IF (snapshot_mdsio) THEN |
428 |
|
CALL WRITE_LOCAL_RL('fV','I10',1,uCf,bi,bj,k,myIter,myThid) |
429 |
|
CALL WRITE_LOCAL_RL('fU','I10',1,vCf,bi,bj,k,myIter,myThid) |
430 |
|
ENDIF |
431 |
|
#ifdef ALLOW_MNC |
432 |
|
IF (useMNC .AND. snapshot_mnc) THEN |
433 |
|
CALL MNC_CW_RL_W('D','mom_vi',0,0, 'fV', uCf, myThid) |
434 |
|
CALL MNC_CW_RL_W('D','mom_vi',0,0, 'fU', vCf, myThid) |
435 |
|
ENDIF |
436 |
|
#endif /* ALLOW_MNC */ |
437 |
|
ENDIF |
438 |
ENDIF |
ENDIF |
439 |
|
|
440 |
IF (momAdvection) THEN |
IF (momAdvection) THEN |
441 |
C-- Horizontal advection of relative vorticity |
C-- Horizontal advection of relative vorticity |
442 |
c CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,r_hFacZ,uCf,myThid) |
IF (useAbsVorticity) THEN |
443 |
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, |
444 |
& uCf,myThid) |
& uCf,myThid) |
445 |
|
ELSE |
446 |
|
CALL MOM_VI_U_CORIOLIS(bi,bj,k,vFld,vort3,hFacZ,r_hFacZ, |
447 |
|
& uCf,myThid) |
448 |
|
ENDIF |
449 |
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) |
450 |
DO j=jMin,jMax |
DO j=jMin,jMax |
451 |
DO i=iMin,iMax |
DO i=iMin,iMax |
452 |
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) |
453 |
ENDDO |
ENDDO |
454 |
ENDDO |
ENDDO |
455 |
c CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,r_hFacZ,vCf,myThid) |
IF (useAbsVorticity) THEN |
456 |
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, |
457 |
& vCf,myThid) |
& vCf,myThid) |
458 |
|
ELSE |
459 |
|
CALL MOM_VI_V_CORIOLIS(bi,bj,k,uFld,vort3,hFacZ,r_hFacZ, |
460 |
|
& vCf,myThid) |
461 |
|
ENDIF |
462 |
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) |
463 |
DO j=jMin,jMax |
DO j=jMin,jMax |
464 |
DO i=iMin,iMax |
DO i=iMin,iMax |
466 |
ENDDO |
ENDDO |
467 |
ENDDO |
ENDDO |
468 |
|
|
469 |
|
IF ( writeDiag ) THEN |
470 |
|
IF (snapshot_mdsio) THEN |
471 |
|
CALL WRITE_LOCAL_RL('zV','I10',1,uCf,bi,bj,k,myIter,myThid) |
472 |
|
CALL WRITE_LOCAL_RL('zU','I10',1,vCf,bi,bj,k,myIter,myThid) |
473 |
|
ENDIF |
474 |
|
#ifdef ALLOW_MNC |
475 |
|
IF (useMNC .AND. snapshot_mnc) THEN |
476 |
|
CALL MNC_CW_RL_W('D','mom_vi',0,0, 'zV', uCf, myThid) |
477 |
|
CALL MNC_CW_RL_W('D','mom_vi',0,0, 'zU', vCf, myThid) |
478 |
|
ENDIF |
479 |
|
#endif /* ALLOW_MNC */ |
480 |
|
ENDIF |
481 |
|
|
482 |
#ifdef ALLOW_TIMEAVE |
#ifdef ALLOW_TIMEAVE |
483 |
|
#ifndef HRCUBE |
484 |
IF (taveFreq.GT.0.) THEN |
IF (taveFreq.GT.0.) THEN |
485 |
CALL TIMEAVE_CUMUL_1K1T(uZetatave,vCf,deltaTClock, |
CALL TIMEAVE_CUMUL_1K1T(uZetatave,vCf,deltaTClock, |
486 |
& Nr, k, bi, bj, myThid) |
& Nr, k, bi, bj, myThid) |
487 |
CALL TIMEAVE_CUMUL_1K1T(vZetatave,uCf,deltaTClock, |
CALL TIMEAVE_CUMUL_1K1T(vZetatave,uCf,deltaTClock, |
488 |
& Nr, k, bi, bj, myThid) |
& Nr, k, bi, bj, myThid) |
489 |
ENDIF |
ENDIF |
490 |
#endif |
#endif /* ndef HRCUBE */ |
491 |
|
#endif /* ALLOW_TIMEAVE */ |
492 |
|
|
493 |
C-- Vertical shear terms (-w*du/dr & -w*dv/dr) |
C-- Vertical shear terms (-w*du/dr & -w*dv/dr) |
494 |
CALL MOM_VI_U_VERTSHEAR(bi,bj,K,uVel,wVel,uCf,myThid) |
IF ( .NOT. momImplVertAdv ) THEN |
495 |
DO j=jMin,jMax |
CALL MOM_VI_U_VERTSHEAR(bi,bj,K,uVel,wVel,uCf,myThid) |
496 |
DO i=iMin,iMax |
DO j=jMin,jMax |
497 |
gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j) |
DO i=iMin,iMax |
498 |
|
gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j) |
499 |
|
ENDDO |
500 |
|
ENDDO |
501 |
|
CALL MOM_VI_V_VERTSHEAR(bi,bj,K,vVel,wVel,vCf,myThid) |
502 |
|
DO j=jMin,jMax |
503 |
|
DO i=iMin,iMax |
504 |
|
gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j) |
505 |
|
ENDDO |
506 |
ENDDO |
ENDDO |
507 |
ENDDO |
ENDIF |
|
CALL MOM_VI_V_VERTSHEAR(bi,bj,K,vVel,wVel,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) |
|
|
ENDDO |
|
|
ENDDO |
|
508 |
|
|
509 |
C-- Bernoulli term |
C-- Bernoulli term |
510 |
CALL MOM_VI_U_GRAD_KE(bi,bj,K,KE,uCf,myThid) |
CALL MOM_VI_U_GRAD_KE(bi,bj,K,KE,uCf,myThid) |
519 |
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) |
520 |
ENDDO |
ENDDO |
521 |
ENDDO |
ENDDO |
522 |
|
IF ( writeDiag ) THEN |
523 |
|
IF (snapshot_mdsio) THEN |
524 |
|
CALL WRITE_LOCAL_RL('KEx','I10',1,uCf,bi,bj,k,myIter,myThid) |
525 |
|
CALL WRITE_LOCAL_RL('KEy','I10',1,vCf,bi,bj,k,myIter,myThid) |
526 |
|
ENDIF |
527 |
|
#ifdef ALLOW_MNC |
528 |
|
IF (useMNC .AND. snapshot_mnc) THEN |
529 |
|
CALL MNC_CW_RL_W('D','mom_vi',0,0, 'KEx', uCf, myThid) |
530 |
|
CALL MNC_CW_RL_W('D','mom_vi',0,0, 'KEy', vCf, myThid) |
531 |
|
ENDIF |
532 |
|
#endif /* ALLOW_MNC */ |
533 |
|
ENDIF |
534 |
|
|
535 |
C-- end if momAdvection |
C-- end if momAdvection |
536 |
ENDIF |
ENDIF |
537 |
|
|
543 |
ENDDO |
ENDDO |
544 |
ENDDO |
ENDDO |
545 |
|
|
546 |
|
#ifdef ALLOW_DEBUG |
547 |
IF ( |
IF ( debugLevel .GE. debLevB |
548 |
& DIFFERENT_MULTIPLE(diagFreq,myCurrentTime, |
& .AND. k.EQ.4 .AND. myIter.EQ.nIter0 |
549 |
& myCurrentTime-deltaTClock) |
& .AND. nPx.EQ.1 .AND. nPy.EQ.1 |
550 |
& ) THEN |
& .AND. useCubedSphereExchange ) THEN |
551 |
CALL WRITE_LOCAL_RL('Ds','I10',1,strain,bi,bj,k,myIter,myThid) |
CALL DEBUG_CS_CORNER_UV( ' uDiss,vDiss from MOM_VECINV', |
552 |
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) |
|
553 |
ENDIF |
ENDIF |
554 |
|
#endif /* ALLOW_DEBUG */ |
555 |
|
|
556 |
#endif /* DISABLE_MOM_VECINV */ |
IF ( writeDiag ) THEN |
557 |
|
IF (snapshot_mdsio) THEN |
558 |
|
CALL WRITE_LOCAL_RL('Ds','I10',1,strain,bi,bj,k,myIter,myThid) |
559 |
|
CALL WRITE_LOCAL_RL('Dt','I10',1,tension,bi,bj,k,myIter, |
560 |
|
& myThid) |
561 |
|
CALL WRITE_LOCAL_RL('Du','I10',1,uDiss,bi,bj,k,myIter,myThid) |
562 |
|
CALL WRITE_LOCAL_RL('Dv','I10',1,vDiss,bi,bj,k,myIter,myThid) |
563 |
|
CALL WRITE_LOCAL_RL('Z3','I10',1,vort3,bi,bj,k,myIter,myThid) |
564 |
|
CALL WRITE_LOCAL_RL('W3','I10',1,omega3,bi,bj,k,myIter,myThid) |
565 |
|
CALL WRITE_LOCAL_RL('KE','I10',1,KE,bi,bj,k,myIter,myThid) |
566 |
|
CALL WRITE_LOCAL_RL('D','I10',1,hdiv,bi,bj,k,myIter,myThid) |
567 |
|
ENDIF |
568 |
|
#ifdef ALLOW_MNC |
569 |
|
IF (useMNC .AND. snapshot_mnc) THEN |
570 |
|
CALL MNC_CW_RL_W('D','mom_vi',0,0,'Ds',strain, myThid) |
571 |
|
CALL MNC_CW_RL_W('D','mom_vi',0,0,'Dt',tension, myThid) |
572 |
|
CALL MNC_CW_RL_W('D','mom_vi',0,0,'Du',uDiss, myThid) |
573 |
|
CALL MNC_CW_RL_W('D','mom_vi',0,0,'Dv',vDiss, myThid) |
574 |
|
CALL MNC_CW_RL_W('D','mom_vi',0,0,'Z3',vort3, myThid) |
575 |
|
CALL MNC_CW_RL_W('D','mom_vi',0,0,'W3',omega3, myThid) |
576 |
|
CALL MNC_CW_RL_W('D','mom_vi',0,0,'KE',KE, myThid) |
577 |
|
CALL MNC_CW_RL_W('D','mom_vi',0,0,'D', hdiv, myThid) |
578 |
|
ENDIF |
579 |
|
#endif /* ALLOW_MNC */ |
580 |
|
ENDIF |
581 |
|
|
582 |
|
#endif /* ALLOW_MOM_VECINV */ |
583 |
|
|
584 |
RETURN |
RETURN |
585 |
END |
END |