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. | |
51 |
_RL fVerU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) |
_RL fVerU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) |
52 |
_RL fVerV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) |
_RL fVerV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) |
53 |
INTEGER kUp,kDown |
INTEGER kUp,kDown |
54 |
_RL myCurrentTime |
_RL myTime |
55 |
INTEGER myIter |
INTEGER myIter |
56 |
INTEGER myThid |
INTEGER myThid |
57 |
INTEGER bi,bj,iMin,iMax,jMin,jMax |
INTEGER bi,bj,iMin,iMax,jMin,jMax |
117 |
_RL mtFacV |
_RL mtFacV |
118 |
_RL wVelBottomOverride |
_RL wVelBottomOverride |
119 |
LOGICAL bottomDragTerms |
LOGICAL bottomDragTerms |
120 |
|
LOGICAL writeDiag |
121 |
_RL KE(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RL KE(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
122 |
_RL omega3(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RL omega3(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
123 |
_RL vort3(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RL vort3(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
136 |
IF ( k .EQ. 1 ) rVelMaskOverride=freeSurfFac |
IF ( k .EQ. 1 ) rVelMaskOverride=freeSurfFac |
137 |
wVelBottomOverride=1. |
wVelBottomOverride=1. |
138 |
IF (k.EQ.Nr) wVelBottomOverride=0. |
IF (k.EQ.Nr) wVelBottomOverride=0. |
139 |
|
writeDiag = DIFFERENT_MULTIPLE(diagFreq, myTime, |
140 |
|
& myTime-deltaTClock) |
141 |
|
|
142 |
C Initialise intermediate terms |
C Initialise intermediate terms |
143 |
DO J=1-OLy,sNy+OLy |
DO J=1-OLy,sNy+OLy |
232 |
C use the same maskZ (and hFacZ) => needs 2 call(s) |
C use the same maskZ (and hFacZ) => needs 2 call(s) |
233 |
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) |
234 |
|
|
235 |
CALL MOM_VI_CALC_KE(bi,bj,k,uFld,vFld,KE,myThid) |
CALL MOM_CALC_KE(bi,bj,k,2,uFld,vFld,KE,myThid) |
236 |
|
|
237 |
CALL MOM_VI_CALC_HDIV(bi,bj,k,uFld,vFld,hDiv,myThid) |
CALL MOM_CALC_HDIV(bi,bj,k,2,uFld,vFld,hDiv,myThid) |
238 |
|
|
239 |
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) |
240 |
|
|
241 |
c CALL MOM_VI_CALC_ABSVORT3(bi,bj,k,vort3,omega3,myThid) |
IF (useAbsVorticity) |
242 |
|
& CALL MOM_CALC_ABSVORT3(bi,bj,k,vort3,omega3,myThid) |
243 |
|
|
244 |
IF (momViscosity) THEN |
IF (momViscosity) THEN |
245 |
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 |
246 |
IF (viscA4.NE.0.) THEN |
IF (viscA4.NE.0. |
247 |
|
& .OR. viscA4Grid.NE.0. |
248 |
|
& .OR. viscC4leith.NE.0. |
249 |
|
& ) THEN |
250 |
CALL MOM_VI_DEL2UV(bi,bj,k,hDiv,vort3,hFacZ, |
CALL MOM_VI_DEL2UV(bi,bj,k,hDiv,vort3,hFacZ, |
251 |
O del2u,del2v, |
O del2u,del2v, |
252 |
& myThid) |
& myThid) |
253 |
CALL MOM_VI_CALC_HDIV(bi,bj,k,del2u,del2v,dStar,myThid) |
CALL MOM_CALC_HDIV(bi,bj,k,2,del2u,del2v,dStar,myThid) |
254 |
CALL MOM_VI_CALC_RELVORT3( |
CALL MOM_CALC_RELVORT3( |
255 |
& bi,bj,k,del2u,del2v,hFacZ,zStar,myThid) |
& bi,bj,k,del2u,del2v,hFacZ,zStar,myThid) |
256 |
ENDIF |
ENDIF |
257 |
C Calculate dissipation terms for U and V equations |
C Calculate dissipation terms for U and V equations |
258 |
C in terms of vorticity and divergence |
C in terms of vorticity and divergence |
259 |
IF (viscAh.NE.0. .OR. viscA4.NE.0.) THEN |
IF (viscAh.NE.0. .OR. viscA4.NE.0. |
260 |
|
& .OR. viscAhGrid.NE.0. .OR. viscA4Grid.NE.0. |
261 |
|
& .OR. viscC2leith.NE.0. .OR. viscC4leith.NE.0. |
262 |
|
& ) THEN |
263 |
CALL MOM_VI_HDISSIP(bi,bj,k,hDiv,vort3,hFacZ,dStar,zStar, |
CALL MOM_VI_HDISSIP(bi,bj,k,hDiv,vort3,hFacZ,dStar,zStar, |
264 |
O uDiss,vDiss, |
O uDiss,vDiss, |
265 |
& myThid) |
& myThid) |
402 |
c ENDIF |
c ENDIF |
403 |
|
|
404 |
C-- Horizontal Coriolis terms |
C-- Horizontal Coriolis terms |
405 |
IF (useCoriolis .AND. .NOT.useCDscheme) THEN |
IF (useCoriolis .AND. .NOT.useCDscheme |
406 |
CALL MOM_VI_CORIOLIS(bi,bj,k,uFld,vFld,omega3,hFacZ,r_hFacZ, |
& .AND. .NOT. useAbsVorticity) THEN |
407 |
|
CALL MOM_VI_CORIOLIS(bi,bj,k,uFld,vFld,hFacZ,r_hFacZ, |
408 |
& uCf,vCf,myThid) |
& uCf,vCf,myThid) |
409 |
DO j=jMin,jMax |
DO j=jMin,jMax |
410 |
DO i=iMin,iMax |
DO i=iMin,iMax |
412 |
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) |
413 |
ENDDO |
ENDDO |
414 |
ENDDO |
ENDDO |
415 |
|
IF ( writeDiag ) THEN |
416 |
|
CALL WRITE_LOCAL_RL('fV','I10',1,uCf,bi,bj,k,myIter,myThid) |
417 |
|
CALL WRITE_LOCAL_RL('fU','I10',1,vCf,bi,bj,k,myIter,myThid) |
418 |
|
ENDIF |
419 |
ENDIF |
ENDIF |
420 |
|
|
421 |
IF (momAdvection) THEN |
IF (momAdvection) THEN |
422 |
C-- Horizontal advection of relative vorticity |
C-- Horizontal advection of relative vorticity |
423 |
c CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,r_hFacZ,uCf,myThid) |
IF (useAbsVorticity) THEN |
424 |
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, |
425 |
& uCf,myThid) |
& uCf,myThid) |
426 |
|
ELSE |
427 |
|
CALL MOM_VI_U_CORIOLIS(bi,bj,k,vFld,vort3,hFacZ,r_hFacZ, |
428 |
|
& uCf,myThid) |
429 |
|
ENDIF |
430 |
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) |
431 |
DO j=jMin,jMax |
DO j=jMin,jMax |
432 |
DO i=iMin,iMax |
DO i=iMin,iMax |
433 |
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) |
434 |
ENDDO |
ENDDO |
435 |
ENDDO |
ENDDO |
436 |
c CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,r_hFacZ,vCf,myThid) |
IF (useAbsVorticity) THEN |
437 |
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, |
438 |
& vCf,myThid) |
& vCf,myThid) |
439 |
|
ELSE |
440 |
|
CALL MOM_VI_V_CORIOLIS(bi,bj,k,uFld,vort3,hFacZ,r_hFacZ, |
441 |
|
& vCf,myThid) |
442 |
|
ENDIF |
443 |
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) |
444 |
DO j=jMin,jMax |
DO j=jMin,jMax |
445 |
DO i=iMin,iMax |
DO i=iMin,iMax |
447 |
ENDDO |
ENDDO |
448 |
ENDDO |
ENDDO |
449 |
|
|
450 |
|
IF ( writeDiag ) THEN |
451 |
|
CALL WRITE_LOCAL_RL('zV','I10',1,uCf,bi,bj,k,myIter,myThid) |
452 |
|
CALL WRITE_LOCAL_RL('zU','I10',1,vCf,bi,bj,k,myIter,myThid) |
453 |
|
ENDIF |
454 |
#ifdef ALLOW_TIMEAVE |
#ifdef ALLOW_TIMEAVE |
455 |
|
#ifndef HRCUBE |
456 |
IF (taveFreq.GT.0.) THEN |
IF (taveFreq.GT.0.) THEN |
457 |
CALL TIMEAVE_CUMUL_1K1T(uZetatave,vCf,deltaTClock, |
CALL TIMEAVE_CUMUL_1K1T(uZetatave,vCf,deltaTClock, |
458 |
& Nr, k, bi, bj, myThid) |
& Nr, k, bi, bj, myThid) |
459 |
CALL TIMEAVE_CUMUL_1K1T(vZetatave,uCf,deltaTClock, |
CALL TIMEAVE_CUMUL_1K1T(vZetatave,uCf,deltaTClock, |
460 |
& Nr, k, bi, bj, myThid) |
& Nr, k, bi, bj, myThid) |
461 |
ENDIF |
ENDIF |
462 |
#endif |
#endif /* ALLOW_TIMEAVE */ |
463 |
|
#endif /* ndef HRCUBE */ |
464 |
|
|
465 |
C-- Vertical shear terms (-w*du/dr & -w*dv/dr) |
C-- Vertical shear terms (-w*du/dr & -w*dv/dr) |
466 |
CALL MOM_VI_U_VERTSHEAR(bi,bj,K,uVel,wVel,uCf,myThid) |
IF ( .NOT. momImplVertAdv ) THEN |
467 |
DO j=jMin,jMax |
CALL MOM_VI_U_VERTSHEAR(bi,bj,K,uVel,wVel,uCf,myThid) |
468 |
DO i=iMin,iMax |
DO j=jMin,jMax |
469 |
gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j) |
DO i=iMin,iMax |
470 |
|
gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j) |
471 |
|
ENDDO |
472 |
|
ENDDO |
473 |
|
CALL MOM_VI_V_VERTSHEAR(bi,bj,K,vVel,wVel,vCf,myThid) |
474 |
|
DO j=jMin,jMax |
475 |
|
DO i=iMin,iMax |
476 |
|
gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j) |
477 |
|
ENDDO |
478 |
ENDDO |
ENDDO |
479 |
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 |
|
480 |
|
|
481 |
C-- Bernoulli term |
C-- Bernoulli term |
482 |
CALL MOM_VI_U_GRAD_KE(bi,bj,K,KE,uCf,myThid) |
CALL MOM_VI_U_GRAD_KE(bi,bj,K,KE,uCf,myThid) |
491 |
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) |
492 |
ENDDO |
ENDDO |
493 |
ENDDO |
ENDDO |
494 |
|
IF ( writeDiag ) THEN |
495 |
|
CALL WRITE_LOCAL_RL('KEx','I10',1,uCf,bi,bj,k,myIter,myThid) |
496 |
|
CALL WRITE_LOCAL_RL('KEy','I10',1,vCf,bi,bj,k,myIter,myThid) |
497 |
|
ENDIF |
498 |
|
|
499 |
C-- end if momAdvection |
C-- end if momAdvection |
500 |
ENDIF |
ENDIF |
501 |
|
|
508 |
ENDDO |
ENDDO |
509 |
|
|
510 |
|
|
511 |
IF ( |
IF ( writeDiag ) THEN |
|
& DIFFERENT_MULTIPLE(diagFreq,myCurrentTime, |
|
|
& myCurrentTime-deltaTClock) |
|
|
& ) THEN |
|
512 |
CALL WRITE_LOCAL_RL('Ds','I10',1,strain,bi,bj,k,myIter,myThid) |
CALL WRITE_LOCAL_RL('Ds','I10',1,strain,bi,bj,k,myIter,myThid) |
513 |
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) |
|
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) |
|
514 |
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) |
515 |
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) |
516 |
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) |
517 |
c 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) |
518 |
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) |
519 |
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) |
520 |
ENDIF |
ENDIF |