--- MITgcm/model/src/dynamics.F 2007/11/05 18:52:21 1.139 +++ MITgcm/model/src/dynamics.F 2011/05/24 20:25:33 1.157 @@ -1,4 +1,4 @@ -C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/src/dynamics.F,v 1.139 2007/11/05 18:52:21 jmc Exp $ +C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/src/dynamics.F,v 1.157 2011/05/24 20:25:33 jmc Exp $ C $Name: $ #include "PACKAGES_CONFIG.h" @@ -15,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" @@ -96,7 +96,7 @@ # include "PTRACERS_FIELDS.h" # endif # ifdef ALLOW_OBCS -# include "OBCS.h" +# include "OBCS_FIELDS.h" # ifdef ALLOW_PTRACERS # include "OBCS_PTRACERS.h" # endif @@ -139,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 @@ -162,13 +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 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) @@ -190,6 +196,7 @@ INTEGER k, km1, kp1, kup, kDown #ifdef ALLOW_DIAGNOSTICS + LOGICAL dPhiHydDiagIsOn _RL tmpFac #endif /* ALLOW_DIAGNOSTICS */ @@ -240,8 +247,14 @@ CEOP #ifdef ALLOW_DEBUG - IF ( debugLevel .GE. debLevB ) - & CALL DEBUG_ENTER( 'DYNAMICS', myThid ) + IF (debugMode) 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 @@ -251,6 +264,10 @@ CALL CALC_EP_FORCING(myThid) #endif +#ifdef ALLOW_AUTODIFF_MONITOR_DIAG + CALL DUMMY_IN_DYNAMICS( mytime, myiter, myThid ) +#endif + #ifdef ALLOW_AUTODIFF_TAMC C-- HPF directive to help TAMC CHPF$ INDEPENDENT @@ -287,21 +304,21 @@ 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 @@ -310,14 +327,17 @@ fVerV (i,j,2) = 0. _d 0 phiHydF (i,j) = 0. _d 0 phiHydC (i,j) = 0. _d 0 +#ifndef INCLUDE_PHIHYD_CALCULATION_CODE dPhiHydX(i,j) = 0. _d 0 dPhiHydY(i,j) = 0. _d 0 +#endif 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 + phiHydLow(i,j,bi,bj) = 0. _d 0 +# if (defined NONLIN_FRSURF) && (defined ALLOW_MOM_FLUXFORM) # ifndef DISABLE_RSTAR_CODE dWtransC(i,j,bi,bj) = 0. _d 0 dWtransU(i,j,bi,bj) = 0. _d 0 @@ -335,8 +355,8 @@ jMax = sNy+1 #ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE wvel (:,:,:,bi,bj) = -CADJ & comlev1_bibj, key = idynkey, byte = isbyte +CADJ STORE wvel (:,:,:,bi,bj) = +CADJ & comlev1_bibj, key=idynkey, byte=isbyte #endif /* ALLOW_AUTODIFF_TAMC */ C-- Explicit part of the Surface Potentiel Gradient (add in TIMESTEP) @@ -353,25 +373,32 @@ CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key=idynkey, byte=isbyte CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key=idynkey, byte=isbyte #ifdef ALLOW_KPP -CADJ STORE KPPviscAz (:,:,:,bi,bj) +CADJ STORE KPPviscAz (:,:,:,bi,bj) CADJ & = comlev1_bibj, key=idynkey, byte=isbyte #endif /* ALLOW_KPP */ #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 STORE KappaRU(:,:,:) CADJ & = comlev1_bibj, key=idynkey, byte=isbyte -CADJ STORE KappaRV(:,:,:) +CADJ STORE KappaRV(:,:,:) CADJ & = comlev1_bibj, key=idynkey, byte=isbyte #endif /* ALLOW_AUTODIFF_TAMC */ @@ -387,61 +414,74 @@ 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 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 STORE theta (:,:,k,bi,bj) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE salt (:,:,k,bi,bj) +CADJ STORE salt (:,:,k,bi,bj) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE gt(:,:,k,bi,bj) +CADJ STORE gt(:,:,k,bi,bj) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE gs(:,:,k,bi,bj) +CADJ STORE gs(:,:,k,bi,bj) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte # ifdef NONLIN_FRSURF cph-test -CADJ STORE phiHydC (:,:) +CADJ STORE phiHydC (:,:) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE phiHydF (:,:) +CADJ STORE phiHydF (:,:) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE gudissip (:,:) +CADJ STORE gudissip (:,:) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE gvdissip (:,:) +CADJ STORE gvdissip (:,:) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE fVerU (:,:,:) +CADJ STORE fVerU (:,:,:) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE fVerV (:,:,:) +CADJ STORE fVerV (:,:,:) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE gu(:,:,k,bi,bj) +CADJ STORE gu(:,:,k,bi,bj) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE gv(:,:,k,bi,bj) +CADJ STORE gv(:,:,k,bi,bj) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE gunm1(:,:,k,bi,bj) +# ifndef ALLOW_ADAMSBASHFORTH_3 +CADJ STORE gunm1(:,:,k,bi,bj) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE gvnm1(:,:,k,bi,bj) +CADJ STORE gvnm1(:,:,k,bi,bj) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +# else +CADJ STORE gunm(:,:,k,bi,bj,1) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE gunm(:,:,k,bi,bj,2) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE gvnm(:,:,k,bi,bj,1) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE gvnm(:,:,k,bi,bj,2) +CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte +# endif # ifdef ALLOW_CD_CODE -CADJ STORE unm1(:,:,k,bi,bj) +CADJ STORE unm1(:,:,k,bi,bj) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE vnm1(:,:,k,bi,bj) +CADJ STORE vnm1(:,:,k,bi,bj) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE uVelD(:,:,k,bi,bj) +CADJ STORE uVelD(:,:,k,bi,bj) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE vVelD(:,:,k,bi,bj) +CADJ STORE vVelD(:,:,k,bi,bj) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte # endif # endif # ifdef ALLOW_DEPTH_CONTROL -CADJ STORE fVerU (:,:,:) +CADJ STORE fVerU (:,:,:) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE fVerV (:,:,:) +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( @@ -458,18 +498,27 @@ 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 +# if (defined NONLIN_FRSURF) && (defined ALLOW_MOM_FLUXFORM) # ifndef DISABLE_RSTAR_CODE -CADJ STORE dWtransC(:,:,bi,bj) +CADJ STORE dWtransC(:,:,bi,bj) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE dWtransU(:,:,bi,bj) +CADJ STORE dWtransU(:,:,bi,bj) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE dWtransV(:,:,bi,bj) +CADJ STORE dWtransV(:,:,bi,bj) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte # endif # endif @@ -487,11 +536,11 @@ ELSE #ifdef ALLOW_MOM_VECINV C -# ifdef ALLOW_AUTODIFF_TAMC +# ifdef ALLOW_AUTODIFF_TAMC # ifdef NONLIN_FRSURF -CADJ STORE fVerU(:,:,:) +CADJ STORE fVerU(:,:,:) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE fVerV(:,:,:) +CADJ STORE fVerV(:,:,:) CADJ & = comlev1_bibj_k, key=kkey, byte=isbyte # endif # endif /* ALLOW_AUTODIFF_TAMC */ @@ -511,21 +560,14 @@ I guDissip, gvDissip, I myTime, myIter, myThid) -#ifdef ALLOW_OBCS -C-- Apply open boundary conditions - IF (useOBCS) THEN - CALL OBCS_APPLY_UV( bi, bj, k, gU, gV, myThid ) - ENDIF -#endif /* ALLOW_OBCS */ - ENDIF - C-- end of dynamics k loop (1:Nr) ENDDO C-- Implicit Vertical advection & viscosity -#if (defined (INCLUDE_IMPLVERTADV_CODE) && defined (ALLOW_MOM_COMMON)) +#if (defined (INCLUDE_IMPLVERTADV_CODE) && \ + defined (ALLOW_MOM_COMMON) && !(defined ALLOW_AUTODIFF_TAMC)) IF ( momImplVertAdv ) THEN CALL MOM_U_IMPLICIT_R( kappaRU, I bi, bj, myTime, myIter, myThid ) @@ -557,10 +599,8 @@ #ifdef ALLOW_OBCS C-- Apply open boundary conditions - IF ( useOBCS .AND.(implicitViscosity.OR.momImplVertAdv) ) THEN - DO K=1,Nr - CALL OBCS_APPLY_UV( bi, bj, k, gU, gV, myThid ) - ENDDO + IF ( useOBCS ) THEN + CALL OBCS_APPLY_UV( bi, bj, 0, gU, gV, myThid ) ENDIF #endif /* ALLOW_OBCS */ @@ -592,8 +632,7 @@ 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 ) + IF (debugMode) CALL DEBUG_CALL('CALC_GW', myThid ) #endif CALL TIMER_START('CALC_GW [DYNAMICS]',myThid) CALL CALC_GW( @@ -614,7 +653,7 @@ #ifdef ALLOW_OBCS IF (useOBCS) THEN - CALL OBCS_PRESCRIBE_EXCHANGES(myThid) + CALL OBCS_EXCHANGES( myThid ) ENDIF #endif @@ -622,8 +661,8 @@ 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 @@ -643,7 +682,7 @@ #endif /* ALLOW_DIAGNOSTICS */ #ifdef ALLOW_DEBUG - If ( debugLevel .GE. debLevB ) THEN + IF ( debugLevel .GE. debLevB ) THEN CALL DEBUG_STATS_RL(1,EtaN,'EtaN (DYNAMICS)',myThid) CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (DYNAMICS)',myThid) CALL DEBUG_STATS_RL(Nr,vVel,'Vvel (DYNAMICS)',myThid) @@ -664,8 +703,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) @@ -673,8 +712,7 @@ #endif #ifdef ALLOW_DEBUG - IF ( debugLevel .GE. debLevB ) - & CALL DEBUG_LEAVE( 'DYNAMICS', myThid ) + IF (debugMode) CALL DEBUG_LEAVE( 'DYNAMICS', myThid ) #endif RETURN