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 |
CBOP |
CBOP |
73 |
#include "EEPARAMS.h" |
#include "EEPARAMS.h" |
74 |
#include "PARAMS.h" |
#include "PARAMS.h" |
75 |
#include "DYNVARS.h" |
#include "DYNVARS.h" |
76 |
#include "GRID.h" |
#ifdef ALLOW_CD_CODE |
77 |
#ifdef ALLOW_PASSIVE_TRACER |
#include "CD_CODE_VARS.h" |
|
#include "TR1.h" |
|
78 |
#endif |
#endif |
79 |
|
#include "GRID.h" |
80 |
#ifdef ALLOW_AUTODIFF_TAMC |
#ifdef ALLOW_AUTODIFF_TAMC |
81 |
# include "tamc.h" |
# include "tamc.h" |
82 |
# include "tamc_keys.h" |
# include "tamc_keys.h" |
108 |
C | |
C | |
109 |
C |-- OBCS_APPLY_UV |
C |-- OBCS_APPLY_UV |
110 |
C | |
C | |
|
C |-- CALL TIMEAVE_CUMUL_1T |
|
111 |
C |-- CALL DEBUG_STATS_RL |
C |-- CALL DEBUG_STATS_RL |
112 |
|
|
113 |
C !INPUT/OUTPUT PARAMETERS: |
C !INPUT/OUTPUT PARAMETERS: |
121 |
|
|
122 |
C !LOCAL VARIABLES: |
C !LOCAL VARIABLES: |
123 |
C == Local variables |
C == Local variables |
124 |
C fVer[STUV] o fVer: Vertical flux term - note fVer |
C fVer[UV] o fVer: Vertical flux term - note fVer |
125 |
C is "pipelined" in the vertical |
C is "pipelined" in the vertical |
126 |
C so we need an fVer for each |
C so we need an fVer for each |
127 |
C variable. |
C variable. |
128 |
C phiHydC :: hydrostatic potential anomaly at cell center |
C phiHydC :: hydrostatic potential anomaly at cell center |
129 |
C In z coords phiHyd is the hydrostatic potential |
C In z coords phiHyd is the hydrostatic potential |
130 |
C (=pressure/rho0) anomaly |
C (=pressure/rho0) anomaly |
133 |
C dPhiHydX,Y :: Gradient (X & Y directions) of hydrostatic potential anom. |
C dPhiHydX,Y :: Gradient (X & Y directions) of hydrostatic potential anom. |
134 |
C phiSurfX, :: gradient of Surface potential (Pressure/rho, ocean) |
C phiSurfX, :: gradient of Surface potential (Pressure/rho, ocean) |
135 |
C phiSurfY or geopotential (atmos) in X and Y direction |
C phiSurfY or geopotential (atmos) in X and Y direction |
136 |
|
C guDissip :: dissipation tendency (all explicit terms), u component |
137 |
|
C gvDissip :: dissipation tendency (all explicit terms), v component |
138 |
C iMin, iMax - Ranges and sub-block indices on which calculations |
C iMin, iMax - Ranges and sub-block indices on which calculations |
139 |
C jMin, jMax are applied. |
C jMin, jMax are applied. |
140 |
C bi, bj |
C bi, bj |
149 |
_RL dPhiHydY(1-Olx:sNx+Olx,1-Oly:sNy+Oly) |
_RL dPhiHydY(1-Olx:sNx+Olx,1-Oly:sNy+Oly) |
150 |
_RL phiSurfX(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RL phiSurfX(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
151 |
_RL phiSurfY(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
_RL phiSurfY(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
152 |
|
_RL guDissip(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
153 |
|
_RL gvDissip(1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
154 |
_RL KappaRU (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr) |
_RL KappaRU (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr) |
155 |
_RL KappaRV (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr) |
_RL KappaRV (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr) |
156 |
|
|
162 |
|
|
163 |
LOGICAL DIFFERENT_MULTIPLE |
LOGICAL DIFFERENT_MULTIPLE |
164 |
EXTERNAL DIFFERENT_MULTIPLE |
EXTERNAL DIFFERENT_MULTIPLE |
165 |
|
|
166 |
|
#ifdef ALLOW_DIAGNOSTICS |
167 |
|
_RL tmpFld (1-OLx:sNx+OLx,1-OLy:sNy+OLy) |
168 |
|
LOGICAL DIAGNOSTICS_IS_ON |
169 |
|
EXTERNAL DIAGNOSTICS_IS_ON |
170 |
|
#endif /* ALLOW_DIAGNOSTICS */ |
171 |
|
|
172 |
|
|
173 |
C--- The algorithm... |
C--- The algorithm... |
174 |
C |
C |
266 |
#ifdef ALLOW_AUTODIFF_TAMC |
#ifdef ALLOW_AUTODIFF_TAMC |
267 |
cph( |
cph( |
268 |
c-- need some re-initialisation here to break dependencies |
c-- need some re-initialisation here to break dependencies |
|
c-- totphihyd is assumed zero from ini_pressure, i.e. |
|
|
c-- avoiding iterate pressure p = integral of (g*rho(p)*dz) |
|
269 |
cph) |
cph) |
|
totPhiHyd(i,j,k,bi,bj) = 0. _d 0 |
|
270 |
gu(i,j,k,bi,bj) = 0. _d 0 |
gu(i,j,k,bi,bj) = 0. _d 0 |
271 |
gv(i,j,k,bi,bj) = 0. _d 0 |
gv(i,j,k,bi,bj) = 0. _d 0 |
272 |
#endif |
#endif |
285 |
dPhiHydY(i,j) = 0. _d 0 |
dPhiHydY(i,j) = 0. _d 0 |
286 |
phiSurfX(i,j) = 0. _d 0 |
phiSurfX(i,j) = 0. _d 0 |
287 |
phiSurfY(i,j) = 0. _d 0 |
phiSurfY(i,j) = 0. _d 0 |
288 |
|
guDissip(i,j) = 0. _d 0 |
289 |
|
gvDissip(i,j) = 0. _d 0 |
290 |
ENDDO |
ENDDO |
291 |
ENDDO |
ENDDO |
292 |
|
|
330 |
ENDDO |
ENDDO |
331 |
#endif |
#endif |
332 |
|
|
333 |
|
#ifdef ALLOW_AUTODIFF_TAMC |
334 |
|
CADJ STORE KappaRU(:,:,:) |
335 |
|
CADJ & = comlev1_bibj, key=idynkey, byte=isbyte |
336 |
|
CADJ STORE KappaRV(:,:,:) |
337 |
|
CADJ & = comlev1_bibj, key=idynkey, byte=isbyte |
338 |
|
#endif /* ALLOW_AUTODIFF_TAMC */ |
339 |
|
|
340 |
C-- Start of dynamics loop |
C-- Start of dynamics loop |
341 |
DO k=1,Nr |
DO k=1,Nr |
342 |
|
|
351 |
|
|
352 |
#ifdef ALLOW_AUTODIFF_TAMC |
#ifdef ALLOW_AUTODIFF_TAMC |
353 |
kkey = (idynkey-1)*Nr + k |
kkey = (idynkey-1)*Nr + k |
354 |
|
c |
355 |
CADJ STORE totphihyd (:,:,k,bi,bj) |
CADJ STORE totphihyd (:,:,k,bi,bj) |
356 |
CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte |
CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte |
357 |
|
CADJ STORE theta (:,:,k,bi,bj) |
358 |
|
CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte |
359 |
|
CADJ STORE salt (:,:,k,bi,bj) |
360 |
|
CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte |
361 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
#endif /* ALLOW_AUTODIFF_TAMC */ |
362 |
|
|
363 |
C-- Integrate hydrostatic balance for phiHyd with BC of |
C-- Integrate hydrostatic balance for phiHyd with BC of |
364 |
C phiHyd(z=0)=0 |
C phiHyd(z=0)=0 |
365 |
C distinguishe between Stagger and Non Stagger time stepping |
CALL CALC_PHI_HYD( |
|
IF (staggerTimeStep) THEN |
|
|
CALL CALC_PHI_HYD( |
|
|
I bi,bj,iMin,iMax,jMin,jMax,k, |
|
|
I gT, gS, |
|
|
U phiHydF, |
|
|
O phiHydC, dPhiHydX, dPhiHydY, |
|
|
I myTime, myIter, myThid ) |
|
|
ELSE |
|
|
CALL CALC_PHI_HYD( |
|
366 |
I bi,bj,iMin,iMax,jMin,jMax,k, |
I bi,bj,iMin,iMax,jMin,jMax,k, |
367 |
I theta, salt, |
I theta, salt, |
368 |
U phiHydF, |
U phiHydF, |
369 |
O phiHydC, dPhiHydX, dPhiHydY, |
O phiHydC, dPhiHydX, dPhiHydY, |
370 |
I myTime, myIter, myThid ) |
I myTime, myIter, myThid ) |
|
ENDIF |
|
371 |
|
|
372 |
C-- Calculate accelerations in the momentum equations (gU, gV, ...) |
C-- Calculate accelerations in the momentum equations (gU, gV, ...) |
373 |
C and step forward storing the result in gU, gV, etc... |
C and step forward storing the result in gU, gV, etc... |
374 |
IF ( momStepping ) THEN |
IF ( momStepping ) THEN |
375 |
#ifndef DISABLE_MOM_FLUXFORM |
#ifdef ALLOW_MOM_FLUXFORM |
376 |
IF (.NOT. vectorInvariantMomentum) CALL MOM_FLUXFORM( |
IF (.NOT. vectorInvariantMomentum) CALL MOM_FLUXFORM( |
377 |
I bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown, |
I bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown, |
378 |
I dPhiHydX,dPhiHydY,KappaRU,KappaRV, |
I dPhiHydX,dPhiHydY,KappaRU,KappaRV, |
379 |
U fVerU, fVerV, |
U fVerU, fVerV, |
380 |
I myTime, myIter, myThid) |
I myTime, myIter, myThid) |
381 |
#endif |
#endif |
382 |
#ifndef DISABLE_MOM_VECINV |
#ifdef ALLOW_MOM_VECINV |
383 |
IF (vectorInvariantMomentum) CALL MOM_VECINV( |
IF (vectorInvariantMomentum) CALL MOM_VECINV( |
384 |
I bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown, |
I bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown, |
385 |
I dPhiHydX,dPhiHydY,KappaRU,KappaRV, |
I dPhiHydX,dPhiHydY,KappaRU,KappaRV, |
386 |
U fVerU, fVerV, |
U fVerU, fVerV, |
387 |
|
O guDissip, gvDissip, |
388 |
I myTime, myIter, myThid) |
I myTime, myIter, myThid) |
389 |
#endif |
#endif |
390 |
CALL TIMESTEP( |
CALL TIMESTEP( |
391 |
I bi,bj,iMin,iMax,jMin,jMax,k, |
I bi,bj,iMin,iMax,jMin,jMax,k, |
392 |
I dPhiHydX,dPhiHydY, phiSurfX, phiSurfY, |
I dPhiHydX,dPhiHydY, phiSurfX, phiSurfY, |
393 |
|
I guDissip, gvDissip, |
394 |
I myTime, myIter, myThid) |
I myTime, myIter, myThid) |
395 |
|
|
396 |
#ifdef ALLOW_OBCS |
#ifdef ALLOW_OBCS |
406 |
C-- end of dynamics k loop (1:Nr) |
C-- end of dynamics k loop (1:Nr) |
407 |
ENDDO |
ENDDO |
408 |
|
|
409 |
C-- Implicit viscosity |
C-- Implicit Vertical advection & viscosity |
410 |
IF (implicitViscosity.AND.momStepping) THEN |
#ifdef INCLUDE_IMPLVERTADV_CODE |
411 |
|
IF ( momImplVertAdv ) THEN |
412 |
|
CALL MOM_U_IMPLICIT_R( kappaRU, |
413 |
|
I bi, bj, myTime, myIter, myThid ) |
414 |
|
CALL MOM_V_IMPLICIT_R( kappaRV, |
415 |
|
I bi, bj, myTime, myIter, myThid ) |
416 |
|
ELSEIF ( implicitViscosity ) THEN |
417 |
|
#else /* INCLUDE_IMPLVERTADV_CODE */ |
418 |
|
IF ( implicitViscosity ) THEN |
419 |
|
#endif /* INCLUDE_IMPLVERTADV_CODE */ |
420 |
#ifdef ALLOW_AUTODIFF_TAMC |
#ifdef ALLOW_AUTODIFF_TAMC |
421 |
|
CADJ STORE KappaRU(:,:,:) = comlev1_bibj , key=idynkey, byte=isbyte |
422 |
CADJ STORE gU(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte |
CADJ STORE gU(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte |
423 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
#endif /* ALLOW_AUTODIFF_TAMC */ |
424 |
CALL IMPLDIFF( |
CALL IMPLDIFF( |
425 |
I bi, bj, iMin, iMax, jMin, jMax, |
I bi, bj, iMin, iMax, jMin, jMax, |
426 |
I deltaTmom, KappaRU,recip_HFacW, |
I 0, KappaRU,recip_HFacW, |
427 |
U gU, |
U gU, |
428 |
I myThid ) |
I myThid ) |
429 |
#ifdef ALLOW_AUTODIFF_TAMC |
#ifdef ALLOW_AUTODIFF_TAMC |
430 |
|
CADJ STORE KappaRV(:,:,:) = comlev1_bibj , key=idynkey, byte=isbyte |
431 |
CADJ STORE gV(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte |
CADJ STORE gV(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte |
432 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
#endif /* ALLOW_AUTODIFF_TAMC */ |
433 |
CALL IMPLDIFF( |
CALL IMPLDIFF( |
434 |
I bi, bj, iMin, iMax, jMin, jMax, |
I bi, bj, iMin, iMax, jMin, jMax, |
435 |
I deltaTmom, KappaRV,recip_HFacS, |
I 0, KappaRV,recip_HFacS, |
436 |
U gV, |
U gV, |
437 |
I myThid ) |
I myThid ) |
438 |
|
ENDIF |
439 |
|
|
440 |
#ifdef ALLOW_OBCS |
#ifdef ALLOW_OBCS |
441 |
C-- Apply open boundary conditions |
C-- Apply open boundary conditions |
442 |
IF (useOBCS) THEN |
IF ( useOBCS .AND.(implicitViscosity.OR.momImplVertAdv) ) THEN |
443 |
DO K=1,Nr |
DO K=1,Nr |
444 |
CALL OBCS_APPLY_UV( bi, bj, k, gU, gV, myThid ) |
CALL OBCS_APPLY_UV( bi, bj, k, gU, gV, myThid ) |
445 |
ENDDO |
ENDDO |
446 |
END IF |
ENDIF |
447 |
#endif /* ALLOW_OBCS */ |
#endif /* ALLOW_OBCS */ |
448 |
|
|
449 |
#ifdef INCLUDE_CD_CODE |
#ifdef ALLOW_CD_CODE |
450 |
|
IF (implicitViscosity.AND.useCDscheme) THEN |
451 |
#ifdef ALLOW_AUTODIFF_TAMC |
#ifdef ALLOW_AUTODIFF_TAMC |
452 |
CADJ STORE vVelD(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte |
CADJ STORE vVelD(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte |
453 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
#endif /* ALLOW_AUTODIFF_TAMC */ |
454 |
CALL IMPLDIFF( |
CALL IMPLDIFF( |
455 |
I bi, bj, iMin, iMax, jMin, jMax, |
I bi, bj, iMin, iMax, jMin, jMax, |
456 |
I deltaTmom, KappaRU,recip_HFacW, |
I 0, KappaRU,recip_HFacW, |
457 |
U vVelD, |
U vVelD, |
458 |
I myThid ) |
I myThid ) |
459 |
#ifdef ALLOW_AUTODIFF_TAMC |
#ifdef ALLOW_AUTODIFF_TAMC |
461 |
#endif /* ALLOW_AUTODIFF_TAMC */ |
#endif /* ALLOW_AUTODIFF_TAMC */ |
462 |
CALL IMPLDIFF( |
CALL IMPLDIFF( |
463 |
I bi, bj, iMin, iMax, jMin, jMax, |
I bi, bj, iMin, iMax, jMin, jMax, |
464 |
I deltaTmom, KappaRV,recip_HFacS, |
I 0, KappaRV,recip_HFacS, |
465 |
U uVelD, |
U uVelD, |
466 |
I myThid ) |
I myThid ) |
|
#endif /* INCLUDE_CD_CODE */ |
|
|
C-- End If implicitViscosity.AND.momStepping |
|
467 |
ENDIF |
ENDIF |
468 |
|
#endif /* ALLOW_CD_CODE */ |
469 |
|
C-- End implicit Vertical advection & viscosity |
470 |
|
|
471 |
ENDDO |
ENDDO |
472 |
ENDDO |
ENDDO |
473 |
|
|
474 |
|
#ifdef ALLOW_OBCS |
475 |
|
IF (useOBCS) THEN |
476 |
|
CALL OBCS_PRESCRIBE_EXCHANGES(myThid) |
477 |
|
ENDIF |
478 |
|
#endif |
479 |
|
|
480 |
|
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
481 |
|
|
482 |
Cml( |
Cml( |
483 |
C In order to compare the variance of phiHydLow of a p/z-coordinate |
C In order to compare the variance of phiHydLow of a p/z-coordinate |
484 |
C run with etaH of a z/p-coordinate run the drift of phiHydLow |
C run with etaH of a z/p-coordinate run the drift of phiHydLow |
487 |
C & 'phiHydLow', myThid ) |
C & 'phiHydLow', myThid ) |
488 |
Cml) |
Cml) |
489 |
|
|
490 |
#ifndef DISABLE_DEBUGMODE |
#ifdef ALLOW_DIAGNOSTICS |
491 |
|
IF ( usediagnostics ) THEN |
492 |
|
|
493 |
|
CALL DIAGNOSTICS_FILL(totPhihyd,'PHIHYD ',0,Nr,0,1,1,myThid) |
494 |
|
CALL DIAGNOSTICS_FILL(phiHydLow,'PHIBOT ',0,1,0,1,1,myThid) |
495 |
|
|
496 |
|
IF ( DIAGNOSTICS_IS_ON('PHIBOTSQ',myThid) ) THEN |
497 |
|
DO bj = myByLo(myThid), myByHi(myThid) |
498 |
|
DO bi = myBxLo(myThid), myBxHi(myThid) |
499 |
|
DO j = 1,sNy |
500 |
|
DO i = 1,sNx |
501 |
|
tmpFld(i,j) = phiHydLow(i,j,bi,bj)*phiHydLow(i,j,bi,bj) |
502 |
|
ENDDO |
503 |
|
ENDDO |
504 |
|
CALL DIAGNOSTICS_FILL(tmpFld,'PHIBOTSQ',0,1,2,bi,bj,myThid) |
505 |
|
ENDDO |
506 |
|
ENDDO |
507 |
|
ENDIF |
508 |
|
|
509 |
|
ENDIF |
510 |
|
#endif /* ALLOW_DIAGNOSTICS */ |
511 |
|
|
512 |
|
#ifdef ALLOW_DEBUG |
513 |
If ( debugLevel .GE. debLevB ) THEN |
If ( debugLevel .GE. debLevB ) THEN |
514 |
CALL DEBUG_STATS_RL(1,EtaN,'EtaN (DYNAMICS)',myThid) |
CALL DEBUG_STATS_RL(1,EtaN,'EtaN (DYNAMICS)',myThid) |
515 |
CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (DYNAMICS)',myThid) |
CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (DYNAMICS)',myThid) |