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( |
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 |
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 |
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) |
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) |
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. |
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 |
|
|
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 |
|
|
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 |
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) |
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) |
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 |
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) |
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 |
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 |
404 |
ENDDO |
ENDDO |
405 |
ENDDO |
ENDIF |
406 |
c CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,r_hFacZ,uCf,myThid) |
|
407 |
CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,vort3,r_hFacZ,uCf,myThid) |
IF (momAdvection) THEN |
408 |
c CALL MOM_VI_U_CORIOLIS_C4(bi,bj,K,vFld,vort3,r_hFacZ,uCf,myThid) |
C-- Horizontal advection of relative vorticity |
409 |
DO j=jMin,jMax |
c CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,r_hFacZ,uCf,myThid) |
410 |
DO i=iMin,iMax |
CALL MOM_VI_U_CORIOLIS(bi,bj,k,vFld,vort3,hFacZ,r_hFacZ, |
411 |
gU(i,j,k,bi,bj) = (gU(i,j,k,bi,bj)+uCf(i,j)) |
& uCf,myThid) |
412 |
& *_maskW(i,j,k,bi,bj) |
c CALL MOM_VI_U_CORIOLIS_C4(bi,bj,K,vFld,vort3,r_hFacZ,uCf,myThid) |
413 |
|
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 |
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,hFacZ,r_hFacZ, |
420 |
CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,vort3,r_hFacZ,vCf,myThid) |
& vCf,myThid) |
421 |
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) |
422 |
DO j=jMin,jMax |
DO j=jMin,jMax |
423 |
DO i=iMin,iMax |
DO i=iMin,iMax |
424 |
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) |
425 |
& *_maskS(i,j,k,bi,bj) |
ENDDO |
426 |
ENDDO |
ENDDO |
|
ENDDO |
|
427 |
|
|
428 |
IF (momAdvection) THEN |
#ifdef ALLOW_TIMEAVE |
429 |
C-- Vertical shear terms (Coriolis) |
IF (taveFreq.GT.0.) THEN |
430 |
CALL MOM_VI_U_VERTSHEAR(bi,bj,K,uVel,wVel,uCf,myThid) |
CALL TIMEAVE_CUMUL_1K1T(uZetatave,vCf,deltaTClock, |
431 |
DO j=jMin,jMax |
& Nr, k, bi, bj, myThid) |
432 |
DO i=iMin,iMax |
CALL TIMEAVE_CUMUL_1K1T(vZetatave,uCf,deltaTClock, |
433 |
gU(i,j,k,bi,bj) = (gU(i,j,k,bi,bj)+uCf(i,j)) |
& Nr, k, bi, bj, myThid) |
434 |
& *_maskW(i,j,k,bi,bj) |
ENDIF |
435 |
|
#endif |
436 |
|
|
437 |
|
C-- Vertical shear terms (-w*du/dr & -w*dv/dr) |
438 |
|
CALL MOM_VI_U_VERTSHEAR(bi,bj,K,uVel,wVel,uCf,myThid) |
439 |
|
DO j=jMin,jMax |
440 |
|
DO i=iMin,iMax |
441 |
|
gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j) |
442 |
|
ENDDO |
443 |
ENDDO |
ENDDO |
444 |
ENDDO |
CALL MOM_VI_V_VERTSHEAR(bi,bj,K,vVel,wVel,vCf,myThid) |
445 |
CALL MOM_VI_V_VERTSHEAR(bi,bj,K,vVel,wVel,vCf,myThid) |
DO j=jMin,jMax |
446 |
DO j=jMin,jMax |
DO i=iMin,iMax |
447 |
DO i=iMin,iMax |
gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j) |
448 |
gV(i,j,k,bi,bj) = (gV(i,j,k,bi,bj)+vCf(i,j)) |
ENDDO |
|
& *_maskS(i,j,k,bi,bj) |
|
449 |
ENDDO |
ENDDO |
|
ENDDO |
|
450 |
|
|
451 |
C-- Bernoulli term |
C-- Bernoulli term |
452 |
CALL MOM_VI_U_GRAD_KE(bi,bj,K,KE,uCf,myThid) |
CALL MOM_VI_U_GRAD_KE(bi,bj,K,KE,uCf,myThid) |
453 |
DO j=jMin,jMax |
DO j=jMin,jMax |
454 |
DO i=iMin,iMax |
DO i=iMin,iMax |
455 |
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) |
456 |
& *_maskW(i,j,k,bi,bj) |
ENDDO |
457 |
ENDDO |
ENDDO |
458 |
ENDDO |
CALL MOM_VI_V_GRAD_KE(bi,bj,K,KE,vCf,myThid) |
459 |
CALL MOM_VI_V_GRAD_KE(bi,bj,K,KE,vCf,myThid) |
DO j=jMin,jMax |
460 |
|
DO i=iMin,iMax |
461 |
|
gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j) |
462 |
|
ENDDO |
463 |
|
ENDDO |
464 |
|
C-- end if momAdvection |
465 |
|
ENDIF |
466 |
|
|
467 |
|
C-- Set du/dt & dv/dt on boundaries to zero |
468 |
DO j=jMin,jMax |
DO j=jMin,jMax |
469 |
DO i=iMin,iMax |
DO i=iMin,iMax |
470 |
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) |
471 |
& *_maskS(i,j,k,bi,bj) |
gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)*_maskS(i,j,k,bi,bj) |
472 |
ENDDO |
ENDDO |
473 |
ENDDO |
ENDDO |
474 |
ENDIF |
|
475 |
|
|
476 |
IF ( |
IF ( |
477 |
& DIFFERENT_MULTIPLE(diagFreq,myCurrentTime, |
& DIFFERENT_MULTIPLE(diagFreq,myCurrentTime, |
484 |
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) |
485 |
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) |
486 |
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) |
487 |
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) |
488 |
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) |
489 |
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) |
490 |
ENDIF |
ENDIF |
491 |
|
|
492 |
|
#endif /* ALLOW_MOM_VECINV */ |
493 |
|
|
494 |
RETURN |
RETURN |
495 |
END |
END |