--- MITgcm/model/src/dynamics.F 2006/03/16 16:29:40 1.130 +++ MITgcm/model/src/dynamics.F 2010/01/20 03:50:56 1.145 @@ -1,8 +1,12 @@ -C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/src/dynamics.F,v 1.130 2006/03/16 16:29:40 jmc Exp $ +C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/src/dynamics.F,v 1.145 2010/01/20 03:50:56 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 @@ -11,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" @@ -87,6 +91,19 @@ # 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: @@ -98,20 +115,20 @@ 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 |-- MOM_U_IMPLICIT_R +C |-- MOM_V_IMPLICIT_R C | -C |-- IMPLDIFF +C |-- IMPLDIFF C | C |-- OBCS_APPLY_UV C | @@ -122,13 +139,19 @@ 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 +C !FUNCTIONS: +#ifdef ALLOW_DIAGNOSTICS + LOGICAL DIAGNOSTICS_IS_ON + EXTERNAL DIAGNOSTICS_IS_ON +#endif + C !LOCAL VARIABLES: C == Local variables C fVer[UV] o fVer: Vertical flux term - note fVer @@ -145,11 +168,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) @@ -171,10 +196,11 @@ INTEGER k, km1, kp1, kup, kDown #ifdef ALLOW_DIAGNOSTICS + LOGICAL dPhiHydDiagIsOn _RL tmpFac #endif /* ALLOW_DIAGNOSTICS */ - + C--- The algorithm... C C "Correction Step" @@ -225,6 +251,13 @@ & CALL DEBUG_ENTER( 'DYNAMICS', myThid ) #endif +#ifdef ALLOW_DIAGNOSTICS + dPhiHydDiagIsOn = .FALSE. + IF ( useDiagnostics ) + & dPhiHydDiagIsOn = DIAGNOSTICS_IS_ON( 'Um_dPHdx', myThid ) + & .OR. DIAGNOSTICS_IS_ON( 'Vm_dPHdy', myThid ) +#endif + C-- Call to routine for calculation of C Eliassen-Palm-flux-forced U-tendency, C if desired: @@ -268,35 +301,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 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 @@ -308,7 +351,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) @@ -318,7 +361,7 @@ I bi,bj,iMin,iMax,jMin,jMax, I etaN, O phiSurfX,phiSurfY, - I myThid ) + I myThid ) ENDIF #ifdef ALLOW_AUTODIFF_TAMC @@ -331,20 +374,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 @@ -359,11 +409,13 @@ 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) @@ -405,9 +457,15 @@ 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 IF ( implicitIntGravWave ) THEN CALL CALC_PHI_HYD( @@ -424,22 +482,45 @@ O phiHydC, dPhiHydX, dPhiHydY, I myTime, myIter, myThid ) ENDIF +#ifdef ALLOW_DIAGNOSTICS + IF ( dPhiHydDiagIsOn ) THEN + tmpFac = -1. _d 0 + CALL DIAGNOSTICS_SCALE_FILL( dPhiHydX, tmpFac, 1, + & 'Um_dPHdx', k, 1, 2, bi, bj, myThid ) + CALL DIAGNOSTICS_SCALE_FILL( dPhiHydY, tmpFac, 1, + & 'Vm_dPHdy', k, 1, 2, bi, bj, myThid ) + ENDIF +#endif /* ALLOW_DIAGNOSTICS */ 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 KappaRU, KappaRV, U fVerU, fVerV, O guDissip, gvDissip, I myTime, myIter, myThid) #endif + ELSE #ifdef ALLOW_MOM_VECINV - IF (vectorInvariantMomentum) THEN C -# ifdef ALLOW_AUTODIFF_TAMC +# ifdef ALLOW_AUTODIFF_TAMC # ifdef NONLIN_FRSURF CADJ STORE fVerU(:,:,:) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte @@ -454,8 +535,9 @@ U fVerU, fVerV, O guDissip, gvDissip, I myTime, myIter, myThid) - ENDIF #endif + ENDIF +C CALL TIMESTEP( I bi,bj,iMin,iMax,jMin,jMax,k, I dPhiHydX,dPhiHydY, phiSurfX, phiSurfY, @@ -478,7 +560,7 @@ C-- Implicit Vertical advection & viscosity #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 ) @@ -536,42 +618,45 @@ ENDIF #endif /* ALLOW_CD_CODE */ C-- End implicit Vertical advection & viscosity - - ENDDO - ENDDO - -#ifdef ALLOW_OBCS - IF (useOBCS) THEN - CALL OBCS_PRESCRIBE_EXCHANGES(myThid) - ENDIF -#endif C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| #ifdef ALLOW_NONHYDROSTATIC C-- Step forward W field in N-H algorithm - IF ( nonHydrostatic ) THEN + 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( myTime, myIter, myThid ) - ENDIF - IF ( nonHydrostatic.OR.implicitIntGravWave ) - & CALL TIMESTEP_WVEL( myTime, myIter, myThid ) - IF ( nonHydrostatic ) + 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 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 @@ -589,7 +674,7 @@ ENDIF #endif /* ALLOW_DIAGNOSTICS */ - + #ifdef ALLOW_DEBUG If ( debugLevel .GE. debLevB ) THEN CALL DEBUG_STATS_RL(1,EtaN,'EtaN (DYNAMICS)',myThid) @@ -612,8 +697,8 @@ #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- 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)