--- MITgcm/model/src/dynamics.F 2004/09/17 23:02:00 1.108 +++ MITgcm/model/src/dynamics.F 2007/08/18 21:34:01 1.138 @@ -1,8 +1,13 @@ -C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/src/dynamics.F,v 1.108 2004/09/17 23:02:00 heimbach Exp $ +C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/src/dynamics.F,v 1.138 2007/08/18 21:34:01 heimbach Exp $ C $Name: $ #include "PACKAGES_CONFIG.h" #include "CPP_OPTIONS.h" +#ifdef ALLOW_OBCS +# include "OBCS_OPTIONS.h" +#endif + +#undef DYNAMICS_GUGV_EXCH_CHECK CBOP C !ROUTINE: DYNAMICS @@ -30,6 +35,7 @@ C | with the free-surface evolution or the rigid-lid: C | U[n] = U* + dt x d/dx P C | V[n] = V* + dt x d/dy P +C | W[n] = W* + dt x d/dz P (NH mode) C | C | "Calculation of Gs" C | =================== @@ -85,31 +91,51 @@ # ifdef ALLOW_KPP # include "KPP.h" # endif +# ifdef ALLOW_PTRACERS +# include "PTRACERS_SIZE.h" +# include "PTRACERS.h" +# endif +# ifdef ALLOW_OBCS +# include "OBCS.h" +# ifdef ALLOW_PTRACERS +# include "OBCS_PTRACERS.h" +# endif +# endif +# ifdef ALLOW_MOM_FLUXFORM +# include "MOM_FLUXFORM.h" +# endif #endif /* ALLOW_AUTODIFF_TAMC */ C !CALLING SEQUENCE: C DYNAMICS() C | +C |-- CALC_EP_FORCING +C | C |-- CALC_GRAD_PHI_SURF C | C |-- CALC_VISCOSITY C | -C |-- CALC_PHI_HYD +C |-- CALC_PHI_HYD C | -C |-- MOM_FLUXFORM +C |-- MOM_FLUXFORM C | -C |-- MOM_VECINV +C |-- MOM_VECINV C | -C |-- TIMESTEP +C |-- TIMESTEP C | -C |-- OBCS_APPLY_UV +C |-- OBCS_APPLY_UV +C | +C |-- MOM_U_IMPLICIT_R +C |-- MOM_V_IMPLICIT_R C | -C |-- IMPLDIFF +C |-- IMPLDIFF C | C |-- OBCS_APPLY_UV C | -C |-- CALL TIMEAVE_CUMUL_1T -C |-- CALL DEBUG_STATS_RL +C |-- CALC_GW +C | +C |-- DIAGNOSTICS_FILL +C |-- DEBUG_STATS_RL C !INPUT/OUTPUT PARAMETERS: C == Routine arguments == @@ -122,10 +148,10 @@ C !LOCAL VARIABLES: C == Local variables -C fVer[STUV] o fVer: Vertical flux term - note fVer -C is "pipelined" in the vertical -C so we need an fVer for each -C variable. +C fVer[UV] o fVer: Vertical flux term - note fVer +C is "pipelined" in the vertical +C so we need an fVer for each +C variable. C phiHydC :: hydrostatic potential anomaly at cell center C In z coords phiHyd is the hydrostatic potential C (=pressure/rho0) anomaly @@ -134,6 +160,10 @@ C dPhiHydX,Y :: Gradient (X & Y directions) of hydrostatic potential anom. C phiSurfX, :: gradient of Surface potential (Pressure/rho, ocean) C phiSurfY or geopotential (atmos) in X and Y direction +C guDissip :: dissipation tendency (all explicit terms), u component +C gvDissip :: dissipation tendency (all explicit terms), v component +C KappaRU:: vertical viscosity +C KappaRV:: vertical viscosity C iMin, iMax - Ranges and sub-block indices on which calculations C jMin, jMax are applied. C bi, bj @@ -148,6 +178,8 @@ _RL dPhiHydY(1-Olx:sNx+Olx,1-Oly:sNy+Oly) _RL phiSurfX(1-OLx:sNx+OLx,1-OLy:sNy+OLy) _RL phiSurfY(1-OLx:sNx+OLx,1-OLy:sNy+OLy) + _RL guDissip(1-OLx:sNx+OLx,1-OLy:sNy+OLy) + _RL gvDissip(1-OLx:sNx+OLx,1-OLy:sNy+OLy) _RL KappaRU (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr) _RL KappaRV (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr) @@ -157,9 +189,11 @@ INTEGER i, j INTEGER k, km1, kp1, kup, kDown - LOGICAL DIFFERENT_MULTIPLE - EXTERNAL DIFFERENT_MULTIPLE - +#ifdef ALLOW_DIAGNOSTICS + _RL tmpFac +#endif /* ALLOW_DIAGNOSTICS */ + + C--- The algorithm... C C "Correction Step" @@ -205,6 +239,11 @@ C--- CEOP +#ifdef ALLOW_DEBUG + IF ( debugLevel .GE. debLevB ) + & CALL DEBUG_ENTER( 'DYNAMICS', myThid ) +#endif + C-- Call to routine for calculation of C Eliassen-Palm-flux-forced U-tendency, C if desired: @@ -256,12 +295,9 @@ #ifdef ALLOW_AUTODIFF_TAMC cph( 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) cph) - totPhiHyd(i,j,k,bi,bj) = 0. _d 0 - gu(i,j,k,bi,bj) = 0. _d 0 - gv(i,j,k,bi,bj) = 0. _d 0 + gU(i,j,k,bi,bj) = 0. _d 0 + gV(i,j,k,bi,bj) = 0. _d 0 #endif ENDDO ENDDO @@ -272,12 +308,23 @@ fVerU (i,j,2) = 0. _d 0 fVerV (i,j,1) = 0. _d 0 fVerV (i,j,2) = 0. _d 0 - phiHydF (i,j) = 0. _d 0 - phiHydC (i,j) = 0. _d 0 + phiHydF (i,j) = 0. _d 0 + phiHydC (i,j) = 0. _d 0 dPhiHydX(i,j) = 0. _d 0 - dPhiHydY(i,j) = 0. _d 0 + dPhiHydY(i,j) = 0. _d 0 phiSurfX(i,j) = 0. _d 0 phiSurfY(i,j) = 0. _d 0 + guDissip(i,j) = 0. _d 0 + gvDissip(i,j) = 0. _d 0 +#ifdef ALLOW_AUTODIFF_TAMC +# ifdef NONLIN_FRSURF +# ifndef DISABLE_RSTAR_CODE + dWtransC(i,j,bi,bj) = 0. _d 0 + dWtransU(i,j,bi,bj) = 0. _d 0 + dWtransV(i,j,bi,bj) = 0. _d 0 +# endif +# endif +#endif ENDDO ENDDO @@ -299,7 +346,7 @@ I bi,bj,iMin,iMax,jMin,jMax, I etaN, O phiSurfX,phiSurfY, - I myThid ) + I myThid ) ENDIF #ifdef ALLOW_AUTODIFF_TAMC @@ -323,9 +370,9 @@ #ifdef ALLOW_AUTODIFF_TAMC CADJ STORE KappaRU(:,:,:) -CADJ & = comlev1_bibj, key=idynkey, byte=isbyte +CADJ & = comlev1_bibj, key=idynkey, byte=isbyte CADJ STORE KappaRV(:,:,:) -CADJ & = comlev1_bibj, key=idynkey, byte=isbyte +CADJ & = comlev1_bibj, key=idynkey, byte=isbyte #endif /* ALLOW_AUTODIFF_TAMC */ C-- Start of dynamics loop @@ -349,37 +396,119 @@ CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte CADJ STORE salt (:,:,k,bi,bj) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE gt(:,:,k,bi,bj) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE gs(:,:,k,bi,bj) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +# ifdef NONLIN_FRSURF +cph-test +CADJ STORE phiHydC (:,:) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE phiHydF (:,:) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE gudissip (:,:) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE gvdissip (:,:) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE fVerU (:,:,:) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE fVerV (:,:,:) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE gu(:,:,k,bi,bj) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE gv(:,:,k,bi,bj) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE gunm1(:,:,k,bi,bj) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE gvnm1(:,:,k,bi,bj) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +# ifdef ALLOW_CD_CODE +CADJ STORE unm1(:,:,k,bi,bj) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE vnm1(:,:,k,bi,bj) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE uVelD(:,:,k,bi,bj) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE vVelD(:,:,k,bi,bj) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +# endif +# endif +# ifdef ALLOW_DEPTH_CONTROL +CADJ STORE fVerU (:,:,:) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE fVerV (:,:,:) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +# endif #endif /* ALLOW_AUTODIFF_TAMC */ C-- Integrate hydrostatic balance for phiHyd with BC of C phiHyd(z=0)=0 - CALL CALC_PHI_HYD( + IF ( implicitIntGravWave ) 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( I bi,bj,iMin,iMax,jMin,jMax,k, I theta, salt, U phiHydF, O phiHydC, dPhiHydX, dPhiHydY, I myTime, myIter, myThid ) + ENDIF C-- Calculate accelerations in the momentum equations (gU, gV, ...) C and step forward storing the result in gU, gV, etc... IF ( momStepping ) THEN +#ifdef ALLOW_AUTODIFF_TAMC +# ifdef NONLIN_FRSURF +# ifndef DISABLE_RSTAR_CODE +CADJ STORE dWtransC(:,:,bi,bj) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE dWtransU(:,:,bi,bj) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE dWtransV(:,:,bi,bj) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +# endif +# endif +#endif + IF (.NOT. vectorInvariantMomentum) THEN #ifdef ALLOW_MOM_FLUXFORM - IF (.NOT. vectorInvariantMomentum) CALL MOM_FLUXFORM( +C + CALL MOM_FLUXFORM( I bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown, - I dPhiHydX,dPhiHydY,KappaRU,KappaRV, + I KappaRU, KappaRV, U fVerU, fVerV, + O guDissip, gvDissip, I myTime, myIter, myThid) #endif + ELSE #ifdef ALLOW_MOM_VECINV - IF (vectorInvariantMomentum) CALL MOM_VECINV( +C +# ifdef ALLOW_AUTODIFF_TAMC +# ifdef NONLIN_FRSURF +CADJ STORE fVerU(:,:,:) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE fVerV(:,:,:) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +# endif +# endif /* ALLOW_AUTODIFF_TAMC */ +C + CALL MOM_VECINV( I bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown, - I dPhiHydX,dPhiHydY,KappaRU,KappaRV, + I KappaRU, KappaRV, U fVerU, fVerV, + O guDissip, gvDissip, I myTime, myIter, myThid) #endif + ENDIF +C CALL TIMESTEP( I bi,bj,iMin,iMax,jMin,jMax,k, I dPhiHydX,dPhiHydY, phiSurfX, phiSurfY, + I guDissip, gvDissip, I myTime, myIter, myThid) #ifdef ALLOW_OBCS @@ -396,9 +525,9 @@ ENDDO C-- Implicit Vertical advection & viscosity -#ifdef INCLUDE_IMPLVERTADV_CODE +#if (defined (INCLUDE_IMPLVERTADV_CODE) && defined (ALLOW_MOM_COMMON)) IF ( momImplVertAdv ) THEN - CALL MOM_U_IMPLICIT_R( kappaRU, + CALL MOM_U_IMPLICIT_R( kappaRU, I bi, bj, myTime, myIter, myThid ) CALL MOM_V_IMPLICIT_R( kappaRV, I bi, bj, myTime, myIter, myThid ) @@ -412,7 +541,7 @@ #endif /* ALLOW_AUTODIFF_TAMC */ CALL IMPLDIFF( I bi, bj, iMin, iMax, jMin, jMax, - I deltaTmom, KappaRU,recip_HFacW, + I -1, KappaRU,recip_HFacW, U gU, I myThid ) #ifdef ALLOW_AUTODIFF_TAMC @@ -421,7 +550,7 @@ #endif /* ALLOW_AUTODIFF_TAMC */ CALL IMPLDIFF( I bi, bj, iMin, iMax, jMin, jMax, - I deltaTmom, KappaRV,recip_HFacS, + I -2, KappaRV,recip_HFacS, U gV, I myThid ) ENDIF @@ -442,7 +571,7 @@ #endif /* ALLOW_AUTODIFF_TAMC */ CALL IMPLDIFF( I bi, bj, iMin, iMax, jMin, jMax, - I deltaTmom, KappaRU,recip_HFacW, + I 0, KappaRU,recip_HFacW, U vVelD, I myThid ) #ifdef ALLOW_AUTODIFF_TAMC @@ -450,16 +579,45 @@ #endif /* ALLOW_AUTODIFF_TAMC */ CALL IMPLDIFF( I bi, bj, iMin, iMax, jMin, jMax, - I deltaTmom, KappaRV,recip_HFacS, + I 0, KappaRV,recip_HFacS, U uVelD, I myThid ) ENDIF #endif /* ALLOW_CD_CODE */ C-- End implicit Vertical advection & viscosity - + +C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| + +#ifdef ALLOW_NONHYDROSTATIC +C-- Step forward W field in N-H algorithm + IF ( nonHydrostatic ) THEN +#ifdef ALLOW_DEBUG + IF ( debugLevel .GE. debLevB ) + & CALL DEBUG_CALL('CALC_GW', myThid ) +#endif + CALL TIMER_START('CALC_GW [DYNAMICS]',myThid) + CALL CALC_GW( + I bi,bj, KappaRU, KappaRV, + I myTime, myIter, myThid ) + ENDIF + IF ( nonHydrostatic.OR.implicitIntGravWave ) + & CALL TIMESTEP_WVEL( bi,bj, myTime, myIter, myThid ) + IF ( nonHydrostatic ) + & CALL TIMER_STOP ('CALC_GW [DYNAMICS]',myThid) +#endif + +C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| + +C- end of bi,bj loops ENDDO ENDDO +#ifdef ALLOW_OBCS + IF (useOBCS) THEN + CALL OBCS_PRESCRIBE_EXCHANGES(myThid) + ENDIF +#endif + Cml( C In order to compare the variance of phiHydLow of a p/z-coordinate C run with etaH of a z/p-coordinate run the drift of phiHydLow @@ -468,6 +626,22 @@ C & 'phiHydLow', myThid ) Cml) +#ifdef ALLOW_DIAGNOSTICS + IF ( useDiagnostics ) THEN + + CALL DIAGNOSTICS_FILL(totPhihyd,'PHIHYD ',0,Nr,0,1,1,myThid) + CALL DIAGNOSTICS_FILL(phiHydLow,'PHIBOT ',0, 1,0,1,1,myThid) + + tmpFac = 1. _d 0 + CALL DIAGNOSTICS_SCALE_FILL(totPhihyd,tmpFac,2, + & 'PHIHYDSQ',0,Nr,0,1,1,myThid) + + CALL DIAGNOSTICS_SCALE_FILL(phiHydLow,tmpFac,2, + & 'PHIBOTSQ',0, 1,0,1,1,myThid) + + ENDIF +#endif /* ALLOW_DIAGNOSTICS */ + #ifdef ALLOW_DEBUG If ( debugLevel .GE. debLevB ) THEN CALL DEBUG_STATS_RL(1,EtaN,'EtaN (DYNAMICS)',myThid) @@ -476,16 +650,32 @@ CALL DEBUG_STATS_RL(Nr,wVel,'Wvel (DYNAMICS)',myThid) CALL DEBUG_STATS_RL(Nr,theta,'Theta (DYNAMICS)',myThid) CALL DEBUG_STATS_RL(Nr,salt,'Salt (DYNAMICS)',myThid) - CALL DEBUG_STATS_RL(Nr,Gu,'Gu (DYNAMICS)',myThid) - CALL DEBUG_STATS_RL(Nr,Gv,'Gv (DYNAMICS)',myThid) - CALL DEBUG_STATS_RL(Nr,Gt,'Gt (DYNAMICS)',myThid) - CALL DEBUG_STATS_RL(Nr,Gs,'Gs (DYNAMICS)',myThid) - CALL DEBUG_STATS_RL(Nr,GuNm1,'GuNm1 (DYNAMICS)',myThid) - CALL DEBUG_STATS_RL(Nr,GvNm1,'GvNm1 (DYNAMICS)',myThid) - CALL DEBUG_STATS_RL(Nr,GtNm1,'GtNm1 (DYNAMICS)',myThid) - CALL DEBUG_STATS_RL(Nr,GsNm1,'GsNm1 (DYNAMICS)',myThid) + CALL DEBUG_STATS_RL(Nr,gU,'Gu (DYNAMICS)',myThid) + CALL DEBUG_STATS_RL(Nr,gV,'Gv (DYNAMICS)',myThid) + CALL DEBUG_STATS_RL(Nr,gT,'Gt (DYNAMICS)',myThid) + CALL DEBUG_STATS_RL(Nr,gS,'Gs (DYNAMICS)',myThid) +#ifndef ALLOW_ADAMSBASHFORTH_3 + CALL DEBUG_STATS_RL(Nr,guNm1,'GuNm1 (DYNAMICS)',myThid) + CALL DEBUG_STATS_RL(Nr,gvNm1,'GvNm1 (DYNAMICS)',myThid) + CALL DEBUG_STATS_RL(Nr,gtNm1,'GtNm1 (DYNAMICS)',myThid) + CALL DEBUG_STATS_RL(Nr,gsNm1,'GsNm1 (DYNAMICS)',myThid) +#endif + ENDIF +#endif + +#ifdef DYNAMICS_GUGV_EXCH_CHECK +C- jmc: For safety checking only: This Exchange here should not change +C the solution. If solution changes, it means something is wrong, +C but it does not mean that it is less wrong with this exchange. + IF ( debugLevel .GT. debLevB ) THEN + CALL EXCH_UV_XYZ_RL(gU,gV,.TRUE.,myThid) ENDIF #endif +#ifdef ALLOW_DEBUG + IF ( debugLevel .GE. debLevB ) + & CALL DEBUG_LEAVE( 'DYNAMICS', myThid ) +#endif + RETURN END