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 phi_hyd,KappaRU,KappaRV, |
I dPhiHydX,dPhiHydY,KappaRU,KappaRV, |
9 |
U fVerU, fVerV, |
U fVerU, fVerV, |
10 |
I myCurrentTime, myIter, myThid) |
I myCurrentTime, myIter, myThid) |
11 |
C /==========================================================\ |
C /==========================================================\ |
31 |
#include "EEPARAMS.h" |
#include "EEPARAMS.h" |
32 |
#include "PARAMS.h" |
#include "PARAMS.h" |
33 |
#include "GRID.h" |
#include "GRID.h" |
34 |
|
#ifdef ALLOW_TIMEAVE |
35 |
|
#include "TIMEAVE_STATV.h" |
36 |
|
#endif |
37 |
|
|
38 |
C == Routine arguments == |
C == Routine arguments == |
39 |
C fVerU - Flux of momentum in the vertical |
C fVerU - Flux of momentum in the vertical |
40 |
C fVerV direction out of the upper face of a cell K |
C fVerV direction out of the upper face of a cell K |
41 |
C ( flux into the cell above ). |
C ( flux into the cell above ). |
42 |
C phi_hyd - Hydrostatic pressure |
C dPhiHydX,Y :: Gradient (X & Y dir.) of Hydrostatic Potential |
43 |
C bi, bj, iMin, iMax, jMin, jMax - Range of points for which calculation |
C bi, bj, iMin, iMax, jMin, jMax - Range of points for which calculation |
44 |
C results will be set. |
C results will be set. |
45 |
C kUp, kDown - Index for upper and lower layers. |
C kUp, kDown - Index for upper and lower layers. |
46 |
C myThid - Instance number for this innvocation of CALC_MOM_RHS |
C myThid - Instance number for this innvocation of CALC_MOM_RHS |
47 |
_RL phi_hyd(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
_RL dPhiHydX(1-Olx:sNx+Olx,1-Oly:sNy+Oly) |
48 |
|
_RL dPhiHydY(1-Olx:sNx+Olx,1-Oly:sNy+Oly) |
49 |
_RL KappaRU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
_RL KappaRU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
50 |
_RL KappaRV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
_RL KappaRV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) |
51 |
_RL fVerU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) |
_RL fVerU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) |
56 |
INTEGER myThid |
INTEGER myThid |
57 |
INTEGER bi,bj,iMin,iMax,jMin,jMax |
INTEGER bi,bj,iMin,iMax,jMin,jMax |
58 |
|
|
59 |
|
#ifndef DISABLE_MOM_VECINV |
60 |
|
|
61 |
C == Functions == |
C == Functions == |
62 |
LOGICAL DIFFERENT_MULTIPLE |
LOGICAL DIFFERENT_MULTIPLE |
63 |
EXTERNAL DIFFERENT_MULTIPLE |
EXTERNAL DIFFERENT_MULTIPLE |
72 |
_RL pF (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RL pF (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
73 |
_RL del2u(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RL del2u(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
74 |
_RL del2v(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RL del2v(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
75 |
|
_RL tension(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
76 |
|
_RL strain(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
77 |
_RS hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RS hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
78 |
_RS r_hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RS r_hFacZ(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
79 |
_RS xA(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RS xA(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
225 |
ENDDO |
ENDDO |
226 |
ENDDO |
ENDDO |
227 |
|
|
228 |
|
C note (jmc) : Dissipation and Vort3 advection do not necesary |
229 |
|
C use the same maskZ (and hFacZ) => needs 2 call(s) |
230 |
|
c CALL MOM_VI_HFACZ_DISS(bi,bj,k,hFacZ,r_hFacZ,myThid) |
231 |
|
|
232 |
CALL MOM_VI_CALC_KE(bi,bj,k,uFld,vFld,KE,myThid) |
CALL MOM_VI_CALC_KE(bi,bj,k,uFld,vFld,KE,myThid) |
233 |
|
|
234 |
CALL MOM_VI_CALC_HDIV(bi,bj,k,uFld,vFld,hDiv,myThid) |
CALL MOM_VI_CALC_HDIV(bi,bj,k,uFld,vFld,hDiv,myThid) |
235 |
|
|
236 |
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) |
237 |
|
|
238 |
CALL MOM_VI_CALC_ABSVORT3(bi,bj,k,vort3,omega3,myThid) |
c CALL MOM_VI_CALC_ABSVORT3(bi,bj,k,vort3,omega3,myThid) |
239 |
|
|
240 |
IF (momViscosity) THEN |
IF (momViscosity) THEN |
241 |
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 |
254 |
O uDiss,vDiss, |
O uDiss,vDiss, |
255 |
& myThid) |
& myThid) |
256 |
ENDIF |
ENDIF |
257 |
|
C or in terms of tension and strain |
258 |
|
IF (viscAstrain.NE.0. .OR. viscAtension.NE.0.) THEN |
259 |
|
CALL MOM_CALC_TENSION(bi,bj,k,uFld,vFld, |
260 |
|
O tension, |
261 |
|
I myThid) |
262 |
|
CALL MOM_CALC_STRAIN(bi,bj,k,uFld,vFld,hFacZ, |
263 |
|
O strain, |
264 |
|
I myThid) |
265 |
|
CALL MOM_HDISSIP(bi,bj,k, |
266 |
|
I tension,strain,hFacZ,viscAtension,viscAstrain, |
267 |
|
O uDiss,vDiss, |
268 |
|
I myThid) |
269 |
|
ENDIF |
270 |
ENDIF |
ENDIF |
271 |
|
|
272 |
|
C- Return to standard hfacZ (min-4) and mask vort3 accordingly: |
273 |
|
c CALL MOM_VI_MASK_VORT3(bi,bj,k,hFacZ,r_hFacZ,vort3,myThid) |
274 |
|
|
275 |
C---- Zonal momentum equation starts here |
C---- Zonal momentum equation starts here |
276 |
|
|
277 |
C-- Vertical flux (fVer is at upper face of "u" cell) |
C-- Vertical flux (fVer is at upper face of "u" cell) |
287 |
ENDDO |
ENDDO |
288 |
ENDDO |
ENDDO |
289 |
|
|
|
C--- Hydrostatic term ( -1/rhoConst . dphi/dx ) |
|
|
IF (momPressureForcing) THEN |
|
|
DO j=1-Olx,sNy+Oly |
|
|
DO i=2-Olx,sNx+Olx |
|
|
pf(i,j) = - _recip_dxC(i,j,bi,bj) |
|
|
& *(phi_hyd(i,j,k)-phi_hyd(i-1,j,k)) |
|
|
ENDDO |
|
|
ENDDO |
|
|
ENDIF |
|
|
|
|
290 |
C-- Tendency is minus divergence of the fluxes + coriolis + pressure term |
C-- Tendency is minus divergence of the fluxes + coriolis + pressure term |
291 |
DO j=2-Oly,sNy+Oly-1 |
DO j=2-Oly,sNy+Oly-1 |
292 |
DO i=2-Olx,sNx+Olx-1 |
DO i=2-Olx,sNx+Olx-1 |
296 |
& *( |
& *( |
297 |
& +fVerU(i,j,kUp)*rkFac - fVerU(i,j,kDown)*rkFac |
& +fVerU(i,j,kUp)*rkFac - fVerU(i,j,kDown)*rkFac |
298 |
& ) |
& ) |
299 |
& _PHM( +phxFac * pf(i,j) ) |
& - phxFac*dPhiHydX(i,j) |
300 |
ENDDO |
ENDDO |
301 |
ENDDO |
ENDDO |
302 |
|
|
320 |
ENDDO |
ENDDO |
321 |
ENDIF |
ENDIF |
322 |
|
|
|
C-- Forcing term |
|
|
IF (momForcing) |
|
|
& CALL EXTERNAL_FORCING_U( |
|
|
I iMin,iMax,jMin,jMax,bi,bj,k, |
|
|
I myCurrentTime,myThid) |
|
|
|
|
323 |
C-- Metric terms for curvilinear grid systems |
C-- Metric terms for curvilinear grid systems |
324 |
c IF (usingSphericalPolarMTerms) THEN |
c IF (usingSphericalPolarMTerms) THEN |
325 |
C o Spherical polar grid metric terms |
C o Spherical polar grid metric terms |
331 |
c ENDDO |
c ENDDO |
332 |
c ENDIF |
c ENDIF |
333 |
|
|
|
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 |
|
|
|
|
|
|
|
334 |
C---- Meridional momentum equation starts here |
C---- Meridional momentum equation starts here |
335 |
|
|
336 |
C-- Vertical flux (fVer is at upper face of "v" cell) |
C-- Vertical flux (fVer is at upper face of "v" cell) |
346 |
ENDDO |
ENDDO |
347 |
ENDDO |
ENDDO |
348 |
|
|
|
C--- Hydorstatic term (-1/rhoConst . dphi/dy ) |
|
|
IF (momPressureForcing) THEN |
|
|
DO j=jMin,jMax |
|
|
DO i=iMin,iMax |
|
|
pF(i,j) = -_recip_dyC(i,j,bi,bj) |
|
|
& *(phi_hyd(i,j,k)-phi_hyd(i,j-1,k)) |
|
|
ENDDO |
|
|
ENDDO |
|
|
ENDIF |
|
|
|
|
349 |
C-- Tendency is minus divergence of the fluxes + coriolis + pressure term |
C-- Tendency is minus divergence of the fluxes + coriolis + pressure term |
350 |
DO j=jMin,jMax |
DO j=jMin,jMax |
351 |
DO i=iMin,iMax |
DO i=iMin,iMax |
355 |
& *( |
& *( |
356 |
& +fVerV(i,j,kUp)*rkFac - fVerV(i,j,kDown)*rkFac |
& +fVerV(i,j,kUp)*rkFac - fVerV(i,j,kDown)*rkFac |
357 |
& ) |
& ) |
358 |
& _PHM( +phyFac*pf(i,j) ) |
& - phyFac*dPhiHydY(i,j) |
359 |
ENDDO |
ENDDO |
360 |
ENDDO |
ENDDO |
361 |
|
|
379 |
ENDDO |
ENDDO |
380 |
ENDIF |
ENDIF |
381 |
|
|
|
C-- Forcing term |
|
|
IF (momForcing) |
|
|
& CALL EXTERNAL_FORCING_V( |
|
|
I iMin,iMax,jMin,jMax,bi,bj,k, |
|
|
I myCurrentTime,myThid) |
|
|
|
|
382 |
C-- Metric terms for curvilinear grid systems |
C-- Metric terms for curvilinear grid systems |
383 |
c IF (usingSphericalPolarMTerms) THEN |
c IF (usingSphericalPolarMTerms) THEN |
384 |
C o Spherical polar grid metric terms |
C o Spherical polar grid metric terms |
390 |
c ENDDO |
c ENDDO |
391 |
c ENDIF |
c ENDIF |
392 |
|
|
|
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 |
|
|
|
|
393 |
C-- Horizontal Coriolis terms |
C-- Horizontal Coriolis terms |
394 |
CALL MOM_VI_CORIOLIS(bi,bj,K,uFld,vFld,omega3,r_hFacZ, |
IF (useCoriolis .AND. .NOT.useCDscheme) THEN |
395 |
& uCf,vCf,myThid) |
CALL MOM_VI_CORIOLIS(bi,bj,k,uFld,vFld,omega3,hFacZ,r_hFacZ, |
396 |
DO j=jMin,jMax |
& uCf,vCf,myThid) |
397 |
DO i=iMin,iMax |
DO j=jMin,jMax |
398 |
gU(i,j,k,bi,bj) = (gU(i,j,k,bi,bj)+uCf(i,j)) |
DO i=iMin,iMax |
399 |
& *_maskW(i,j,k,bi,bj) |
gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j) |
400 |
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) |
401 |
& *_maskS(i,j,k,bi,bj) |
ENDDO |
402 |
ENDDO |
ENDDO |
403 |
ENDDO |
ENDIF |
404 |
c CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,r_hFacZ,uCf,myThid) |
|
405 |
CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,vort3,r_hFacZ,uCf,myThid) |
IF (momAdvection) THEN |
406 |
c CALL MOM_VI_U_CORIOLIS_C4(bi,bj,K,vFld,vort3,r_hFacZ,uCf,myThid) |
C-- Horizontal advection of relative vorticity |
407 |
DO j=jMin,jMax |
c CALL MOM_VI_U_CORIOLIS(bi,bj,K,vFld,omega3,r_hFacZ,uCf,myThid) |
408 |
DO i=iMin,iMax |
CALL MOM_VI_U_CORIOLIS(bi,bj,k,vFld,vort3,hFacZ,r_hFacZ, |
409 |
gU(i,j,k,bi,bj) = (gU(i,j,k,bi,bj)+uCf(i,j)) |
& uCf,myThid) |
410 |
& *_maskW(i,j,k,bi,bj) |
c CALL MOM_VI_U_CORIOLIS_C4(bi,bj,K,vFld,vort3,r_hFacZ,uCf,myThid) |
411 |
|
DO j=jMin,jMax |
412 |
|
DO i=iMin,iMax |
413 |
|
gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j) |
414 |
|
ENDDO |
415 |
ENDDO |
ENDDO |
416 |
ENDDO |
c CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,omega3,r_hFacZ,vCf,myThid) |
417 |
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, |
418 |
CALL MOM_VI_V_CORIOLIS(bi,bj,K,uFld,vort3,r_hFacZ,vCf,myThid) |
& vCf,myThid) |
419 |
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) |
420 |
DO j=jMin,jMax |
DO j=jMin,jMax |
421 |
DO i=iMin,iMax |
DO i=iMin,iMax |
422 |
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) |
423 |
& *_maskS(i,j,k,bi,bj) |
ENDDO |
424 |
ENDDO |
ENDDO |
|
ENDDO |
|
425 |
|
|
426 |
IF (momAdvection) THEN |
#ifdef ALLOW_TIMEAVE |
427 |
C-- Vertical shear terms (Coriolis) |
IF (taveFreq.GT.0.) THEN |
428 |
CALL MOM_VI_U_VERTSHEAR(bi,bj,K,uVel,wVel,uCf,myThid) |
CALL TIMEAVE_CUMUL_1K1T(uZetatave,vCf,deltaTClock, |
429 |
DO j=jMin,jMax |
& Nr, k, bi, bj, myThid) |
430 |
DO i=iMin,iMax |
CALL TIMEAVE_CUMUL_1K1T(vZetatave,uCf,deltaTClock, |
431 |
gU(i,j,k,bi,bj) = (gU(i,j,k,bi,bj)+uCf(i,j)) |
& Nr, k, bi, bj, myThid) |
432 |
& *_maskW(i,j,k,bi,bj) |
ENDIF |
433 |
|
#endif |
434 |
|
|
435 |
|
C-- Vertical shear terms (-w*du/dr & -w*dv/dr) |
436 |
|
CALL MOM_VI_U_VERTSHEAR(bi,bj,K,uVel,wVel,uCf,myThid) |
437 |
|
DO j=jMin,jMax |
438 |
|
DO i=iMin,iMax |
439 |
|
gU(i,j,k,bi,bj) = gU(i,j,k,bi,bj)+uCf(i,j) |
440 |
|
ENDDO |
441 |
ENDDO |
ENDDO |
442 |
ENDDO |
CALL MOM_VI_V_VERTSHEAR(bi,bj,K,vVel,wVel,vCf,myThid) |
443 |
CALL MOM_VI_V_VERTSHEAR(bi,bj,K,vVel,wVel,vCf,myThid) |
DO j=jMin,jMax |
444 |
DO j=jMin,jMax |
DO i=iMin,iMax |
445 |
DO i=iMin,iMax |
gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j) |
446 |
gV(i,j,k,bi,bj) = (gV(i,j,k,bi,bj)+vCf(i,j)) |
ENDDO |
|
& *_maskS(i,j,k,bi,bj) |
|
447 |
ENDDO |
ENDDO |
|
ENDDO |
|
448 |
|
|
449 |
C-- Bernoulli term |
C-- Bernoulli term |
450 |
CALL MOM_VI_U_GRAD_KE(bi,bj,K,KE,uCf,myThid) |
CALL MOM_VI_U_GRAD_KE(bi,bj,K,KE,uCf,myThid) |
451 |
DO j=jMin,jMax |
DO j=jMin,jMax |
452 |
DO i=iMin,iMax |
DO i=iMin,iMax |
453 |
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) |
454 |
& *_maskW(i,j,k,bi,bj) |
ENDDO |
455 |
ENDDO |
ENDDO |
456 |
ENDDO |
CALL MOM_VI_V_GRAD_KE(bi,bj,K,KE,vCf,myThid) |
457 |
CALL MOM_VI_V_GRAD_KE(bi,bj,K,KE,vCf,myThid) |
DO j=jMin,jMax |
458 |
|
DO i=iMin,iMax |
459 |
|
gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)+vCf(i,j) |
460 |
|
ENDDO |
461 |
|
ENDDO |
462 |
|
C-- end if momAdvection |
463 |
|
ENDIF |
464 |
|
|
465 |
|
C-- Set du/dt & dv/dt on boundaries to zero |
466 |
DO j=jMin,jMax |
DO j=jMin,jMax |
467 |
DO i=iMin,iMax |
DO i=iMin,iMax |
468 |
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) |
469 |
& *_maskS(i,j,k,bi,bj) |
gV(i,j,k,bi,bj) = gV(i,j,k,bi,bj)*_maskS(i,j,k,bi,bj) |
470 |
ENDDO |
ENDDO |
471 |
ENDDO |
ENDDO |
472 |
ENDIF |
|
473 |
|
|
474 |
IF ( |
IF ( |
475 |
& DIFFERENT_MULTIPLE(diagFreq,myCurrentTime, |
& DIFFERENT_MULTIPLE(diagFreq,myCurrentTime, |
476 |
& myCurrentTime-deltaTClock) |
& myCurrentTime-deltaTClock) |
477 |
& ) THEN |
& ) THEN |
478 |
CALL WRITE_LOCAL_RL('Ph','I10',Nr,phi_hyd,bi,bj,1,myIter,myThid) |
CALL WRITE_LOCAL_RL('Ds','I10',1,strain,bi,bj,k,myIter,myThid) |
479 |
|
CALL WRITE_LOCAL_RL('Dt','I10',1,tension,bi,bj,k,myIter,myThid) |
480 |
CALL WRITE_LOCAL_RL('fV','I10',1,uCf,bi,bj,k,myIter,myThid) |
CALL WRITE_LOCAL_RL('fV','I10',1,uCf,bi,bj,k,myIter,myThid) |
481 |
CALL WRITE_LOCAL_RL('fU','I10',1,vCf,bi,bj,k,myIter,myThid) |
CALL WRITE_LOCAL_RL('fU','I10',1,vCf,bi,bj,k,myIter,myThid) |
482 |
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) |
483 |
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) |
484 |
|
CALL WRITE_LOCAL_RL('Z3','I10',1,vort3,bi,bj,k,myIter,myThid) |
485 |
|
c CALL WRITE_LOCAL_RL('W3','I10',1,omega3,bi,bj,k,myIter,myThid) |
486 |
|
CALL WRITE_LOCAL_RL('KE','I10',1,KE,bi,bj,k,myIter,myThid) |
487 |
|
CALL WRITE_LOCAL_RL('D','I10',1,hdiv,bi,bj,k,myIter,myThid) |
488 |
ENDIF |
ENDIF |
489 |
|
|
490 |
|
#endif /* DISABLE_MOM_VECINV */ |
491 |
|
|
492 |
RETURN |
RETURN |
493 |
END |
END |