--- MITgcm/model/src/dynamics.F 2003/02/18 15:25:09 1.94 +++ MITgcm/model/src/dynamics.F 2005/12/15 21:09:00 1.127 @@ -1,7 +1,9 @@ -C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/src/dynamics.F,v 1.94 2003/02/18 15:25:09 jmc Exp $ +C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/src/dynamics.F,v 1.127 2005/12/15 21:09:00 jmc Exp $ C $Name: $ +#include "PACKAGES_CONFIG.h" #include "CPP_OPTIONS.h" +#undef DYNAMICS_GUGV_EXCH_CHECK CBOP C !ROUTINE: DYNAMICS @@ -29,6 +31,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 | =================== @@ -72,10 +75,10 @@ #include "EEPARAMS.h" #include "PARAMS.h" #include "DYNVARS.h" -#include "GRID.h" -#ifdef ALLOW_PASSIVE_TRACER -#include "TR1.h" +#ifdef ALLOW_CD_CODE +#include "CD_CODE_VARS.h" #endif +#include "GRID.h" #ifdef ALLOW_AUTODIFF_TAMC # include "tamc.h" # include "tamc_keys.h" @@ -89,6 +92,8 @@ C !CALLING SEQUENCE: C DYNAMICS() C | +C |-- CALC_EP_FORCING +C | C |-- CALC_GRAD_PHI_SURF C | C |-- CALC_VISCOSITY @@ -103,12 +108,17 @@ C | C |-- OBCS_APPLY_UV C | +C |-- MOM_U_IMPLICIT_R +C |-- MOM_V_IMPLICIT_R +C | 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 == @@ -121,10 +131,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 @@ -133,6 +143,8 @@ 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 iMin, iMax - Ranges and sub-block indices on which calculations C jMin, jMax are applied. C bi, bj @@ -147,6 +159,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) @@ -156,8 +170,10 @@ 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 @@ -204,17 +220,10 @@ C--- CEOP -C-- Set up work arrays with valid (i.e. not NaN) values -C These inital values do not alter the numerical results. They -C just ensure that all memory references are to valid floating -C point numbers. This prevents spurious hardware signals due to -C uninitialised but inert locations. - DO j=1-OLy,sNy+OLy - DO i=1-OLx,sNx+OLx - phiSurfX(i,j) = 0. _d 0 - phiSurfY(i,j) = 0. _d 0 - ENDDO - ENDDO +#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, @@ -253,12 +262,24 @@ & + act4*max1*max2*max3 #endif /* ALLOW_AUTODIFF_TAMC */ -C-- Set up work arrays that need valid initial values +C-- Set up work arrays with valid (i.e. not NaN) values +C These inital values do not alter the numerical results. They +C just ensure that all memory references are to valid floating +C point numbers. This prevents spurious hardware signals due to +C uninitialised but inert locations. + 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 @@ -272,6 +293,10 @@ phiHydC (i,j) = 0. _d 0 dPhiHydX(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 ENDDO ENDDO @@ -315,6 +340,13 @@ ENDDO #endif +#ifdef ALLOW_AUTODIFF_TAMC +CADJ STORE KappaRU(:,:,:) +CADJ & = comlev1_bibj, key=idynkey, byte=isbyte +CADJ STORE KappaRV(:,:,:) +CADJ & = comlev1_bibj, key=idynkey, byte=isbyte +#endif /* ALLOW_AUTODIFF_TAMC */ + C-- Start of dynamics loop DO k=1,Nr @@ -329,110 +361,155 @@ #ifdef ALLOW_AUTODIFF_TAMC kkey = (idynkey-1)*Nr + k -CADJ STORE pressure(:,:,k,bi,bj) = comlev1_bibj_k , -CADJ & key=kkey , byte=isbyte +c +CADJ STORE totphihyd (:,:,k,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 +# 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 #endif /* ALLOW_AUTODIFF_TAMC */ C-- Integrate hydrostatic balance for phiHyd with BC of C phiHyd(z=0)=0 -C distinguishe between Stagger and Non Stagger time stepping - 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( + 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 gUnm1, gVnm1, etc... +C and step forward storing the result in gU, gV, etc... IF ( momStepping ) THEN -#ifndef DISABLE_MOM_FLUXFORM +#ifdef ALLOW_MOM_FLUXFORM IF (.NOT. vectorInvariantMomentum) 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 -#ifndef DISABLE_MOM_VECINV - IF (vectorInvariantMomentum) CALL MOM_VECINV( +#ifdef ALLOW_MOM_VECINV + IF (vectorInvariantMomentum) THEN +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 CALL TIMESTEP( I bi,bj,iMin,iMax,jMin,jMax,k, I dPhiHydX,dPhiHydY, phiSurfX, phiSurfY, - I myIter, myThid) + 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, gUnm1, gVnm1, myThid ) - END IF + IF (useOBCS) THEN + CALL OBCS_APPLY_UV( bi, bj, k, gU, gV, myThid ) + ENDIF #endif /* ALLOW_OBCS */ -#ifdef ALLOW_AUTODIFF_TAMC -#ifdef INCLUDE_CD_CODE - ELSE - DO j=1-OLy,sNy+OLy - DO i=1-OLx,sNx+OLx - guCD(i,j,k,bi,bj) = 0.0 - gvCD(i,j,k,bi,bj) = 0.0 - END DO - END DO -#endif /* INCLUDE_CD_CODE */ -#endif /* ALLOW_AUTODIFF_TAMC */ ENDIF C-- end of dynamics k loop (1:Nr) ENDDO -C-- Implicit viscosity - IF (implicitViscosity.AND.momStepping) THEN +C-- Implicit Vertical advection & viscosity +#ifdef INCLUDE_IMPLVERTADV_CODE + IF ( momImplVertAdv ) THEN + CALL MOM_U_IMPLICIT_R( kappaRU, + I bi, bj, myTime, myIter, myThid ) + CALL MOM_V_IMPLICIT_R( kappaRV, + I bi, bj, myTime, myIter, myThid ) + ELSEIF ( implicitViscosity ) THEN +#else /* INCLUDE_IMPLVERTADV_CODE */ + IF ( implicitViscosity ) THEN +#endif /* INCLUDE_IMPLVERTADV_CODE */ #ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE gUNm1(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte +CADJ STORE KappaRU(:,:,:) = comlev1_bibj , key=idynkey, byte=isbyte +CADJ STORE gU(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte #endif /* ALLOW_AUTODIFF_TAMC */ CALL IMPLDIFF( I bi, bj, iMin, iMax, jMin, jMax, - I deltaTmom, KappaRU,recip_HFacW, - U gUNm1, + I -1, KappaRU,recip_HFacW, + U gU, I myThid ) #ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE gVNm1(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte +CADJ STORE KappaRV(:,:,:) = comlev1_bibj , key=idynkey, byte=isbyte +CADJ STORE gV(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte #endif /* ALLOW_AUTODIFF_TAMC */ CALL IMPLDIFF( I bi, bj, iMin, iMax, jMin, jMax, - I deltaTmom, KappaRV,recip_HFacS, - U gVNm1, + I -2, KappaRV,recip_HFacS, + U gV, I myThid ) + ENDIF #ifdef ALLOW_OBCS C-- Apply open boundary conditions - IF (useOBCS) THEN + IF ( useOBCS .AND.(implicitViscosity.OR.momImplVertAdv) ) THEN DO K=1,Nr - CALL OBCS_APPLY_UV( bi, bj, k, gUnm1, gVnm1, myThid ) + CALL OBCS_APPLY_UV( bi, bj, k, gU, gV, myThid ) ENDDO - END IF + ENDIF #endif /* ALLOW_OBCS */ -#ifdef INCLUDE_CD_CODE +#ifdef ALLOW_CD_CODE + IF (implicitViscosity.AND.useCDscheme) THEN #ifdef ALLOW_AUTODIFF_TAMC CADJ STORE vVelD(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte #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 @@ -440,16 +517,40 @@ #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 /* INCLUDE_CD_CODE */ -C-- End If implicitViscosity.AND.momStepping 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 ( momStepping .AND. 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 ) + CALL TIMESTEP_WVEL( myTime, myIter, myThid ) + CALL TIMER_STOP ('CALC_GW [DYNAMICS]',myThid) + 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 @@ -458,24 +559,56 @@ C & 'phiHydLow', myThid ) Cml) -#ifndef DISABLE_DEBUGMODE - If (debugMode) THEN +#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) CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (DYNAMICS)',myThid) CALL DEBUG_STATS_RL(Nr,vVel,'Vvel (DYNAMICS)',myThid) 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