--- MITgcm/model/src/dynamics.F 2005/06/27 12:27:19 1.119 +++ MITgcm/model/src/dynamics.F 2010/01/16 22:55:53 1.144 @@ -1,8 +1,13 @@ -C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/src/dynamics.F,v 1.119 2005/06/27 12:27:19 jmc Exp $ +C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/src/dynamics.F,v 1.144 2010/01/16 22:55:53 jmc 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 @@ -10,17 +15,17 @@ SUBROUTINE DYNAMICS(myTime, myIter, myThid) C !DESCRIPTION: \bv C *==========================================================* -C | SUBROUTINE DYNAMICS -C | o Controlling routine for the explicit part of the model -C | dynamics. +C | SUBROUTINE DYNAMICS +C | o Controlling routine for the explicit part of the model +C | dynamics. C *==========================================================* -C | This routine evaluates the "dynamics" terms for each -C | block of ocean in turn. Because the blocks of ocean have -C | overlap regions they are independent of one another. -C | If terms involving lateral integrals are needed in this -C | routine care will be needed. Similarly finite-difference -C | operations with stencils wider than the overlap region -C | require special consideration. +C | This routine evaluates the "dynamics" terms for each +C | block of ocean in turn. Because the blocks of ocean have +C | overlap regions they are independent of one another. +C | If terms involving lateral integrals are needed in this +C | routine care will be needed. Similarly finite-difference +C | operations with stencils wider than the overlap region +C | require special consideration. C | The algorithm... C | C | "Correction Step" @@ -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,36 +91,57 @@ # ifdef ALLOW_KPP # include "KPP.h" # endif +# ifdef ALLOW_PTRACERS +# include "PTRACERS_SIZE.h" +# include "PTRACERS_FIELDS.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 DEBUG_STATS_RL +C |-- CALC_GW +C | +C |-- DIAGNOSTICS_FILL +C |-- DEBUG_STATS_RL C !INPUT/OUTPUT PARAMETERS: C == Routine arguments == -C myTime - Current time in simulation -C myIter - Current iteration number in simulation -C myThid - Thread number for this instance of the routine. +C myTime :: Current time in simulation +C myIter :: Current iteration number in simulation +C myThid :: Thread number for this instance of the routine. _RL myTime INTEGER myIter INTEGER myThid @@ -135,11 +162,13 @@ 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 C k, kup, - Index for layer above and below. kup and kDown -C kDown, km1 are switched with layer to be the appropriate +C kDown, km1 are switched with layer to be the appropriate C index into fVerTerm. _RL fVerU (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) _RL fVerV (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) @@ -161,12 +190,10 @@ INTEGER k, km1, kp1, kup, kDown #ifdef ALLOW_DIAGNOSTICS - _RL tmpFld (1-OLx:sNx+OLx,1-OLy:sNy+OLy) - LOGICAL DIAGNOSTICS_IS_ON - EXTERNAL DIAGNOSTICS_IS_ON + _RL tmpFac #endif /* ALLOW_DIAGNOSTICS */ - + C--- The algorithm... C C "Correction Step" @@ -212,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: @@ -255,35 +287,45 @@ C point numbers. This prevents spurious hardware signals due to C uninitialised but inert locations. +#ifdef ALLOW_AUTODIFF_TAMC DO k=1,Nr DO j=1-OLy,sNy+OLy DO i=1-OLx,sNx+OLx KappaRU(i,j,k) = 0. _d 0 KappaRV(i,j,k) = 0. _d 0 -#ifdef ALLOW_AUTODIFF_TAMC cph( c-- need some re-initialisation here to break dependencies cph) - gu(i,j,k,bi,bj) = 0. _d 0 - gv(i,j,k,bi,bj) = 0. _d 0 -#endif + gU(i,j,k,bi,bj) = 0. _d 0 + gV(i,j,k,bi,bj) = 0. _d 0 ENDDO ENDDO ENDDO +#endif /* ALLOW_AUTODIFF_TAMC */ DO j=1-OLy,sNy+OLy DO i=1-OLx,sNx+OLx fVerU (i,j,1) = 0. _d 0 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 + phiHydLow(i,j,bi,bj) = 0. _d 0 +# 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 @@ -295,7 +337,7 @@ #ifdef ALLOW_AUTODIFF_TAMC CADJ STORE wvel (:,:,:,bi,bj) = -CADJ & comlev1_bibj, key = idynkey, byte = isbyte +CADJ & comlev1_bibj, key=idynkey, byte=isbyte #endif /* ALLOW_AUTODIFF_TAMC */ C-- Explicit part of the Surface Potentiel Gradient (add in TIMESTEP) @@ -305,7 +347,7 @@ I bi,bj,iMin,iMax,jMin,jMax, I etaN, O phiSurfX,phiSurfY, - I myThid ) + I myThid ) ENDIF #ifdef ALLOW_AUTODIFF_TAMC @@ -318,20 +360,27 @@ #endif /* ALLOW_AUTODIFF_TAMC */ #ifdef INCLUDE_CALC_DIFFUSIVITY_CALL -C-- Calculate the total vertical diffusivity +C-- Calculate the total vertical viscosity + CALL CALC_VISCOSITY( + I bi,bj, iMin,iMax,jMin,jMax, + O KappaRU, KappaRV, + I myThid ) +#else DO k=1,Nr - CALL CALC_VISCOSITY( - I bi,bj,iMin,iMax,jMin,jMax,k, - O KappaRU,KappaRV, - I myThid) - ENDDO + DO j=1-OLy,sNy+OLy + DO i=1-OLx,sNx+OLx + KappaRU(i,j,k) = 0. _d 0 + KappaRV(i,j,k) = 0. _d 0 + ENDDO + ENDDO + ENDDO #endif #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 @@ -346,44 +395,126 @@ kup = 1+MOD(k+1,2) kDown= 1+MOD(k,2) -#ifdef ALLOW_AUTODIFF_TAMC +#ifdef ALLOW_AUTODIFF_TAMC kkey = (idynkey-1)*Nr + k c CADJ STORE totphihyd (:,:,k,bi,bj) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE phihydlow (:,:,bi,bj) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte CADJ STORE theta (:,:,k,bi,bj) 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-- 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, @@ -404,9 +535,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 ) @@ -420,7 +551,7 @@ #endif /* ALLOW_AUTODIFF_TAMC */ CALL IMPLDIFF( I bi, bj, iMin, iMax, jMin, jMax, - I 0, KappaRU,recip_HFacW, + I -1, KappaRU,recip_HFacW, U gU, I myThid ) #ifdef ALLOW_AUTODIFF_TAMC @@ -429,7 +560,7 @@ #endif /* ALLOW_AUTODIFF_TAMC */ CALL IMPLDIFF( I bi, bj, iMin, iMax, jMin, jMax, - I 0, KappaRV,recip_HFacS, + I -2, KappaRV,recip_HFacS, U gV, I myThid ) ENDIF @@ -464,7 +595,30 @@ 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 @@ -474,54 +628,30 @@ ENDIF #endif -C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| - 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 C has to be removed by something like the following subroutine: -C CALL REMOVE_MEAN_RL( 1, phiHydLow, maskH, maskH, rA, drF, -C & 'phiHydLow', myThid ) +C CALL REMOVE_MEAN_RL( 1, phiHydLow, maskInC, maskInC, rA, drF, +C & 'phiHydLow', myTime, myThid ) Cml) #ifdef ALLOW_DIAGNOSTICS - IF ( usediagnostics ) THEN + 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) - IF ( DIAGNOSTICS_IS_ON('PHIHYDSQ',myThid) ) THEN - DO bj = myByLo(myThid), myByHi(myThid) - DO bi = myBxLo(myThid), myBxHi(myThid) - DO k = 1,Nr - DO j = 1,sNy - DO i = 1,sNx - tmpFld(i,j) = totPhihyd(i,j,k,bi,bj)*totPhihyd(i,j,k,bi,bj) - ENDDO - ENDDO - CALL DIAGNOSTICS_FILL(tmpFld,'PHIHYDSQ',k,1,2,bi,bj,myThid) - ENDDO - ENDDO - ENDDO - ENDIF - - 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) - IF ( DIAGNOSTICS_IS_ON('PHIBOTSQ',myThid) ) THEN - DO bj = myByLo(myThid), myByHi(myThid) - DO bi = myBxLo(myThid), myBxHi(myThid) - DO j = 1,sNy - DO i = 1,sNx - tmpFld(i,j) = phiHydLow(i,j,bi,bj)*phiHydLow(i,j,bi,bj) - ENDDO - ENDDO - CALL DIAGNOSTICS_FILL(tmpFld,'PHIBOTSQ',0,1,2,bi,bj,myThid) - ENDDO - ENDDO - ENDIF + 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) @@ -543,5 +673,19 @@ 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