--- MITgcm/model/src/thermodynamics.F 2002/03/05 14:15:34 1.18 +++ MITgcm/model/src/thermodynamics.F 2004/10/19 02:39:58 1.79 @@ -1,8 +1,18 @@ -C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/src/thermodynamics.F,v 1.18 2002/03/05 14:15:34 adcroft Exp $ +C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/src/thermodynamics.F,v 1.79 2004/10/19 02:39:58 jmc Exp $ C $Name: $ +#include "PACKAGES_CONFIG.h" #include "CPP_OPTIONS.h" +#ifdef ALLOW_AUTODIFF_TAMC +# ifdef ALLOW_GMREDI +# include "GMREDI_OPTIONS.h" +# endif +# ifdef ALLOW_KPP +# include "KPP_OPTIONS.h" +# endif +#endif /* ALLOW_AUTODIFF_TAMC */ + CBOP C !ROUTINE: THERMODYNAMICS C !INTERFACE: @@ -68,23 +78,33 @@ #include "DYNVARS.h" #include "GRID.h" #include "GAD.h" -#ifdef ALLOW_PASSIVE_TRACER -#include "TR1.h" +#ifdef ALLOW_OFFLINE +#include "OFFLINE.h" +#endif +#ifdef ALLOW_PTRACERS +#include "PTRACERS_SIZE.h" +#include "PTRACERS.h" +#endif +#ifdef ALLOW_TIMEAVE +#include "TIMEAVE_STATV.h" #endif + #ifdef ALLOW_AUTODIFF_TAMC # include "tamc.h" # include "tamc_keys.h" # include "FFIELDS.h" +# include "EOS.h" # ifdef ALLOW_KPP # include "KPP.h" # endif # ifdef ALLOW_GMREDI # include "GMREDI.h" # endif +# ifdef ALLOW_EBM +# include "EBM.h" +# endif #endif /* ALLOW_AUTODIFF_TAMC */ -#ifdef ALLOW_TIMEAVE -#include "TIMEAVE_STATV.h" -#endif + C !INPUT/OUTPUT PARAMETERS: C == Routine arguments == @@ -103,21 +123,15 @@ C o uTrans: Zonal transport C o vTrans: Meridional transport C o rTrans: Vertical transport +C rTransKp1 o vertical volume transp. at interface k+1 C maskUp o maskUp: land/water mask for W points 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 rhoK, rhoKM1 - Density at current level, and level above -C phiHyd - Hydrostatic part of the potential phiHydi. -C In z coords phiHydiHyd is the hydrostatic -C Potential (=pressure/rho0) anomaly -C In p coords phiHydiHyd is the geopotential -C surface height anomaly. -C phiSurfX, - gradient of Surface potentiel (Pressure/rho, ocean) -C phiSurfY or geopotentiel (atmos) in X and Y direction C KappaRT, - Total diffusion in vertical for T and S. C KappaRS (background + spatially varying, isopycnal term). +C useVariableK = T when vertical diffusion is not constant C iMin, iMax - Ranges and sub-block indices on which calculations C jMin, jMax are applied. C bi, bj @@ -129,60 +143,40 @@ _RL uTrans (1-OLx:sNx+OLx,1-OLy:sNy+OLy) _RL vTrans (1-OLx:sNx+OLx,1-OLy:sNy+OLy) _RL rTrans (1-OLx:sNx+OLx,1-OLy:sNy+OLy) + _RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy) _RS maskUp (1-OLx:sNx+OLx,1-OLy:sNy+OLy) _RL fVerT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) _RL fVerS (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) - _RL fVerTr1 (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) - _RL phiHyd (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) - _RL rhokm1 (1-OLx:sNx+OLx,1-OLy:sNy+OLy) - _RL rhok (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) +#ifdef ALLOW_PTRACERS + _RL fVerP (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2,PTRACERS_num) +#endif _RL KappaRT (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr) _RL KappaRS (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr) _RL sigmaX (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) _RL sigmaY (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) _RL sigmaR (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) -C This is currently used by IVDC and Diagnostics - _RL ConvectCount (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) + _RL kp1Msk + LOGICAL useVariableK INTEGER iMin, iMax INTEGER jMin, jMax INTEGER bi, bj INTEGER i, j INTEGER k, km1, kup, kDown + INTEGER iTracer, ip CEOP + +#ifdef ALLOW_DEBUG + IF ( debugLevel .GE. debLevB ) + & CALL DEBUG_ENTER('THERMODYNAMICS',myThid) +#endif #ifdef ALLOW_AUTODIFF_TAMC C-- dummy statement to end declaration part ikey = 1 + itdkey = 1 #endif /* ALLOW_AUTODIFF_TAMC */ -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 - xA(i,j) = 0. _d 0 - yA(i,j) = 0. _d 0 - uTrans(i,j) = 0. _d 0 - vTrans(i,j) = 0. _d 0 - DO k=1,Nr - phiHyd(i,j,k) = 0. _d 0 - sigmaX(i,j,k) = 0. _d 0 - sigmaY(i,j,k) = 0. _d 0 - sigmaR(i,j,k) = 0. _d 0 - ENDDO - rhoKM1 (i,j) = 0. _d 0 - rhok (i,j) = 0. _d 0 - phiSurfX(i,j) = 0. _d 0 - phiSurfY(i,j) = 0. _d 0 - ENDDO - ENDDO - - #ifdef ALLOW_AUTODIFF_TAMC C-- HPF directive to help TAMC CHPF$ INDEPENDENT @@ -193,7 +187,7 @@ #ifdef ALLOW_AUTODIFF_TAMC C-- HPF directive to help TAMC CHPF$ INDEPENDENT, NEW (rTrans,fVerT,fVerS -CHPF$& ,phiHyd,utrans,vtrans,xA,yA +CHPF$& ,utrans,vtrans,xA,yA CHPF$& ,KappaRT,KappaRS CHPF$& ) #endif /* ALLOW_AUTODIFF_TAMC */ @@ -208,21 +202,35 @@ act3 = myThid - 1 max3 = nTx*nTy act4 = ikey_dynamics - 1 - ikey = (act1 + 1) + act2*max1 + itdkey = (act1 + 1) + act2*max1 & + act3*max1*max2 & + 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 j=1-OLy,sNy+OLy DO i=1-OLx,sNx+OLx + xA(i,j) = 0. _d 0 + yA(i,j) = 0. _d 0 + uTrans(i,j) = 0. _d 0 + vTrans(i,j) = 0. _d 0 rTrans (i,j) = 0. _d 0 + rTransKp1(i,j) = 0. _d 0 fVerT (i,j,1) = 0. _d 0 fVerT (i,j,2) = 0. _d 0 fVerS (i,j,1) = 0. _d 0 fVerS (i,j,2) = 0. _d 0 - fVerTr1(i,j,1) = 0. _d 0 - fVerTr1(i,j,2) = 0. _d 0 +#ifdef ALLOW_PTRACERS + DO ip=1,PTRACERS_num + fVerP (i,j,1,ip) = 0. _d 0 + fVerP (i,j,2,ip) = 0. _d 0 + ENDDO +#endif ENDDO ENDDO @@ -230,219 +238,47 @@ DO j=1-OLy,sNy+OLy DO i=1-OLx,sNx+OLx C This is currently also used by IVDC and Diagnostics - ConvectCount(i,j,k) = 0. - KappaRT(i,j,k) = 0. _d 0 - KappaRS(i,j,k) = 0. _d 0 -#ifdef ALLOW_AUTODIFF_TAMC - gT(i,j,k,bi,bj) = 0. _d 0 - gS(i,j,k,bi,bj) = 0. _d 0 -#ifdef ALLOW_PASSIVE_TRACER - gTr1(i,j,k,bi,bj) = 0. _d 0 -#endif -#endif + KappaRT(i,j,k) = 0. _d 0 + KappaRS(i,j,k) = 0. _d 0 +C- tracer tendency needs to be set to zero (moved here from gad_calc_rhs): + gT(i,j,k,bi,bj) = 0. _d 0 + gS(i,j,k,bi,bj) = 0. _d 0 +# ifdef ALLOW_PTRACERS +ceh3 this should have an IF ( usePTRACERS ) THEN + DO iTracer=1,PTRACERS_numInUse + gPTr(i,j,k,bi,bj,itracer) = 0. _d 0 + ENDDO +# endif ENDDO ENDDO ENDDO - iMin = 1-OLx+1 - iMax = sNx+OLx - jMin = 1-OLy+1 - jMax = sNy+OLy - - -#ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE theta(:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte -CADJ STORE salt (:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte -#ifdef ALLOW_KPP -CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte -CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte -#endif -#endif /* ALLOW_AUTODIFF_TAMC */ - -C-- Start of diagnostic loop - DO k=Nr,1,-1 - -#ifdef ALLOW_AUTODIFF_TAMC -C? Patrick, is this formula correct now that we change the loop range? -C? Do we still need this? -cph kkey formula corrected. -cph Needed for rhok, rhokm1, in the case useGMREDI. - kkey = (ikey-1)*Nr + k -CADJ STORE rhokm1(:,:) = comlev1_bibj_k , key=kkey, byte=isbyte -CADJ STORE rhok (:,:) = comlev1_bibj_k , key=kkey, byte=isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ - -C-- Integrate continuity vertically for vertical velocity - CALL INTEGRATE_FOR_W( - I bi, bj, k, uVel, vVel, - O wVel, - I myThid ) - -#ifdef ALLOW_OBCS -#ifdef ALLOW_NONHYDROSTATIC -C-- Apply OBC to W if in N-H mode - IF (useOBCS.AND.nonHydrostatic) THEN - CALL OBCS_APPLY_W( bi, bj, k, wVel, myThid ) - ENDIF -#endif /* ALLOW_NONHYDROSTATIC */ -#endif /* ALLOW_OBCS */ - -C-- Calculate gradients of potential density for isoneutral -C slope terms (e.g. GM/Redi tensor or IVDC diffusivity) -c IF ( k.GT.1 .AND. (useGMRedi.OR.ivdc_kappa.NE.0.) ) THEN - IF ( useGMRedi .OR. (k.GT.1 .AND. ivdc_kappa.NE.0.) ) THEN -#ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE theta(:,:,k,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE salt (:,:,k,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ - CALL FIND_RHO( - I bi, bj, iMin, iMax, jMin, jMax, k, k, eosType, - I theta, salt, - O rhoK, - I myThid ) - IF (k.GT.1) THEN -#ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE theta(:,:,k-1,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE salt (:,:,k-1,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ - CALL FIND_RHO( - I bi, bj, iMin, iMax, jMin, jMax, k-1, k, eosType, - I theta, salt, - O rhoKm1, - I myThid ) - ENDIF - CALL GRAD_SIGMA( - I bi, bj, iMin, iMax, jMin, jMax, k, - I rhoK, rhoKm1, rhoK, - O sigmaX, sigmaY, sigmaR, - I myThid ) - ENDIF - -C-- Implicit Vertical Diffusion for Convection -c ==> should use sigmaR !!! - IF (k.GT.1 .AND. ivdc_kappa.NE.0.) THEN - CALL CALC_IVDC( - I bi, bj, iMin, iMax, jMin, jMax, k, - I rhoKm1, rhoK, - U ConvectCount, KappaRT, KappaRS, - I myTime, myIter, myThid) - ENDIF - -C-- end of diagnostic k loop (Nr:1) - ENDDO +c iMin = 1-OLx +c iMax = sNx+OLx +c jMin = 1-OLy +c jMax = sNy+OLy #ifdef ALLOW_AUTODIFF_TAMC cph avoids recomputation of integrate_for_w -CADJ STORE wvel (:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte +CADJ STORE wvel (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte #endif /* ALLOW_AUTODIFF_TAMC */ -#ifdef ALLOW_OBCS -C-- Calculate future values on open boundaries - IF (useOBCS) THEN - CALL OBCS_CALC( bi, bj, myTime+deltaT, myIter+1, - I uVel, vVel, wVel, theta, salt, - I myThid ) - ENDIF -#endif /* ALLOW_OBCS */ - -C-- Determines forcing terms based on external fields -C relaxation terms, etc. - CALL EXTERNAL_FORCING_SURF( - I bi, bj, iMin, iMax, jMin, jMax, - I myThid ) -#ifdef ALLOW_AUTODIFF_TAMC -cph needed for KPP -CADJ STORE surfacetendencyU(:,:,bi,bj) -CADJ & = comlev1_bibj, key=ikey, byte=isbyte -CADJ STORE surfacetendencyV(:,:,bi,bj) -CADJ & = comlev1_bibj, key=ikey, byte=isbyte -CADJ STORE surfacetendencyS(:,:,bi,bj) -CADJ & = comlev1_bibj, key=ikey, byte=isbyte -CADJ STORE surfacetendencyT(:,:,bi,bj) -CADJ & = comlev1_bibj, key=ikey, byte=isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ - -#ifdef ALLOW_GMREDI - -#ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE sigmaX(:,:,:) = comlev1, key=ikey, byte=isbyte -CADJ STORE sigmaY(:,:,:) = comlev1, key=ikey, byte=isbyte -CADJ STORE sigmaR(:,:,:) = comlev1, key=ikey, byte=isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ -C-- Calculate iso-neutral slopes for the GM/Redi parameterisation - IF (useGMRedi) THEN - CALL GMREDI_CALC_TENSOR( - I bi, bj, iMin, iMax, jMin, jMax, - I sigmaX, sigmaY, sigmaR, - I myThid ) -#ifdef ALLOW_AUTODIFF_TAMC - ELSE - CALL GMREDI_CALC_TENSOR_DUMMY( - I bi, bj, iMin, iMax, jMin, jMax, - I sigmaX, sigmaY, sigmaR, - I myThid ) -#endif /* ALLOW_AUTODIFF_TAMC */ - ENDIF +C-- Attention: by defining "SINGLE_LAYER_MODE" in CPP_OPTIONS.h +C-- MOST of THERMODYNAMICS will be disabled +#ifndef SINGLE_LAYER_MODE #ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE Kwx(:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte -CADJ STORE Kwy(:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte -CADJ STORE Kwz(:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ - -#endif /* ALLOW_GMREDI */ - -#ifdef ALLOW_KPP -C-- Compute KPP mixing coefficients - IF (useKPP) THEN - CALL KPP_CALC( - I bi, bj, myTime, myThid ) -#ifdef ALLOW_AUTODIFF_TAMC - ELSE - CALL KPP_CALC_DUMMY( - I bi, bj, myTime, myThid ) -#endif /* ALLOW_AUTODIFF_TAMC */ - ENDIF - -#ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE KPPghat (:,:,:,bi,bj) -CADJ & , KPPdiffKzT(:,:,:,bi,bj) -CADJ & , KPPdiffKzS(:,:,:,bi,bj) -CADJ & , KPPfrac (:,: ,bi,bj) -CADJ & = comlev1_bibj, key=ikey, byte=isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ - -#endif /* ALLOW_KPP */ - -#ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE KappaRT(:,:,:) = comlev1_bibj, key=ikey, byte=isbyte -CADJ STORE KappaRS(:,:,:) = comlev1_bibj, key=ikey, byte=isbyte -CADJ STORE theta(:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte -CADJ STORE salt (:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte -CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte -CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte -#ifdef ALLOW_PASSIVE_TRACER -CADJ STORE tr1 (:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte +CADJ STORE theta(:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte +CADJ STORE salt (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte +CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte +CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte +#ifdef ALLOW_PTRACERS +cph-- moved to forward_step to avoid key computation +cphCADJ STORE ptracer(:,:,:,bi,bj,itracer) = comlev1_bibj, +cphCADJ & key=itdkey, byte=isbyte #endif #endif /* ALLOW_AUTODIFF_TAMC */ -#ifdef ALLOW_AIM -C AIM - atmospheric intermediate model, physics package code. -C note(jmc) : phiHyd=0 at this point but is not really used in Molteni Physics - IF ( useAIM ) THEN - CALL TIMER_START('AIM_DO_ATMOS_PHYS [DYNAMICS]', myThid) - CALL AIM_DO_ATMOS_PHYSICS( phiHyd, bi, bj, myTime, myThid ) - CALL TIMER_STOP ('AIM_DO_ATMOS_PHYS [DYNAMICS]', myThid) - ENDIF -#endif /* ALLOW_AIM */ - -#ifdef ALLOW_TIMEAVE - IF (taveFreq.GT.0. .AND. ivdc_kappa.NE.0.) THEN - CALL TIMEAVE_CUMULATE(ConvectCountTave, ConvectCount, Nr, - I deltaTclock, bi, bj, myThid) - ENDIF -#endif /* ALLOW_TIMEAVE */ - #ifndef DISABLE_MULTIDIM_ADVECTION C-- Some advection schemes are better calculated using a multi-dimensional C method in the absence of any other terms and, if used, is done here. @@ -454,41 +290,60 @@ C recomputation. It *is* differentiable, if you need it. C Edit GAD_OPTIONS.h and #define DISABLE_MULTIDIM_ADVECTION to C disable this section of code. - IF (multiDimAdvection) THEN - IF (tempStepping .AND. - & tempAdvScheme.NE.ENUM_CENTERED_2ND .AND. - & tempAdvScheme.NE.ENUM_UPWIND_3RD .AND. - & tempAdvScheme.NE.ENUM_CENTERED_4TH ) THEN - CALL GAD_ADVECTION(bi,bj,tempAdvScheme,GAD_TEMPERATURE, - U theta,gT, - I myTime,myIter,myThid) - ENDIF - IF (saltStepping .AND. - & saltAdvScheme.NE.ENUM_CENTERED_2ND .AND. - & saltAdvScheme.NE.ENUM_UPWIND_3RD .AND. - & saltAdvScheme.NE.ENUM_CENTERED_4TH ) THEN - CALL GAD_ADVECTION(bi,bj,saltAdvScheme,GAD_SALINITY, - U salt,gS, - I myTime,myIter,myThid) - ENDIF +#ifndef ALLOW_OFFLINE + IF (tempMultiDimAdvec) THEN +#ifdef ALLOW_DEBUG + IF ( debugLevel .GE. debLevB ) + & CALL DEBUG_CALL('GAD_ADVECTION',myThid) +#endif + CALL GAD_ADVECTION( + I tempImplVertAdv, tempAdvScheme, tempVertAdvScheme, + I GAD_TEMPERATURE, + I uVel, vVel, wVel, theta, + O gT, + I bi,bj,myTime,myIter,myThid) + ENDIF +#endif +#ifndef ALLOW_OFFLINE + IF (saltMultiDimAdvec) THEN +#ifdef ALLOW_DEBUG + IF ( debugLevel .GE. debLevB ) + & CALL DEBUG_CALL('GAD_ADVECTION',myThid) +#endif + CALL GAD_ADVECTION( + I saltImplVertAdv, saltAdvScheme, saltVertAdvScheme, + I GAD_SALINITY, + I uVel, vVel, wVel, salt, + O gS, + I bi,bj,myTime,myIter,myThid) ENDIF +#endif C Since passive tracers are configurable separately from T,S we C call the multi-dimensional method for PTRACERS regardless C of whether multiDimAdvection is set or not. #ifdef ALLOW_PTRACERS IF ( usePTRACERS ) THEN +#ifdef ALLOW_DEBUG + IF ( debugLevel .GE. debLevB ) + & CALL DEBUG_CALL('PTRACERS_ADVECTION',myThid) +#endif CALL PTRACERS_ADVECTION( bi,bj,myIter,myTime,myThid ) ENDIF #endif /* ALLOW_PTRACERS */ #endif /* DISABLE_MULTIDIM_ADVECTION */ +#ifdef ALLOW_DEBUG + IF ( debugLevel .GE. debLevB ) + & CALL DEBUG_MSG('ENTERING DOWNWARD K LOOP',myThid) +#endif + C-- Start of thermodynamics loop DO k=Nr,1,-1 #ifdef ALLOW_AUTODIFF_TAMC C? Patrick Is this formula correct? cph Yes, but I rewrote it. cph Also, the KappaR? need the index and subscript k! - kkey = (ikey-1)*Nr + k + kkey = (itdkey-1)*Nr + k #endif /* ALLOW_AUTODIFF_TAMC */ C-- km1 Points to level above k (=k-1) @@ -504,17 +359,59 @@ jMin = 1-OLy jMax = sNy+OLy + kp1Msk=1. + IF (k.EQ.Nr) kp1Msk=0. + DO j=1-Oly,sNy+Oly + DO i=1-Olx,sNx+Olx + rTransKp1(i,j) = kp1Msk*rTrans(i,j) + ENDDO + ENDDO +#ifdef ALLOW_AUTODIFF_TAMC +CADJ STORE rTransKp1(:,:) = comlev1_bibj_k, key=kkey, byte=isbyte +#endif + C-- Get temporary terms used by tendency routines CALL CALC_COMMON_FACTORS ( I bi,bj,iMin,iMax,jMin,jMax,k, O xA,yA,uTrans,vTrans,rTrans,maskUp, I myThid) -#ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE KappaRT(:,:,k) = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE KappaRS(:,:,k) = comlev1_bibj_k, key=kkey, byte=isbyte + IF (k.EQ.1) THEN +C- Surface interface : + DO j=1-Oly,sNy+Oly + DO i=1-Olx,sNx+Olx + rTrans(i,j) = 0. + ENDDO + ENDDO + ELSE +C- Interior interface : + DO j=1-Oly,sNy+Oly + DO i=1-Olx,sNx+Olx + rTrans(i,j) = rTrans(i,j)*maskC(i,j,k-1,bi,bj) + ENDDO + ENDDO + ENDIF + +#ifdef ALLOW_GMREDI + +C-- Residual transp = Bolus transp + Eulerian transp + IF (useGMRedi) THEN + CALL GMREDI_CALC_UVFLOW( + & uTrans, vTrans, bi, bj, k, myThid) + IF (K.GE.2) CALL GMREDI_CALC_WFLOW( + & rTrans, bi, bj, k, myThid) + ENDIF + +#ifdef ALLOW_AUTODIFF_TAMC +CADJ STORE rTrans(:,:) = comlev1_bibj_k, key=kkey, byte=isbyte +#ifdef GM_BOLUS_ADVEC +CADJ STORE uTrans(:,:) = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE vTrans(:,:) = comlev1_bibj_k, key=kkey, byte=isbyte +#endif #endif /* ALLOW_AUTODIFF_TAMC */ +#endif /* ALLOW_GMREDI */ + #ifdef INCLUDE_CALC_DIFFUSIVITY_CALL C-- Calculate the total vertical diffusivity CALL CALC_DIFFUSIVITY( @@ -522,6 +419,10 @@ I maskUp, O KappaRT,KappaRS, I myThid) +# ifdef ALLOW_AUTODIFF_TAMC +CADJ STORE KappaRT(:,:,k) = comlev1_bibj_k, key=kkey, byte=isbyte +CADJ STORE KappaRS(:,:,k) = comlev1_bibj_k, key=kkey, byte=isbyte +# endif /* ALLOW_AUTODIFF_TAMC */ #endif iMin = 1-OLx+2 @@ -531,10 +432,11 @@ C-- Calculate active tracer tendencies (gT,gS,...) C and step forward storing result in gTnm1, gSnm1, etc. +#ifndef ALLOW_OFFLINE IF ( tempStepping ) THEN CALL CALC_GT( I bi,bj,iMin,iMax,jMin,jMax, k,km1,kup,kDown, - I xA,yA,uTrans,vTrans,rTrans,maskUp, + I xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp, I KappaRT, U fVerT, I myTime,myIter,myThid) @@ -543,10 +445,13 @@ I theta, gT, I myIter, myThid) ENDIF +#endif + +#ifndef ALLOW_OFFLINE IF ( saltStepping ) THEN CALL CALC_GS( I bi,bj,iMin,iMax,jMin,jMax, k,km1,kup,kDown, - I xA,yA,uTrans,vTrans,rTrans,maskUp, + I xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp, I KappaRS, U fVerS, I myTime,myIter,myThid) @@ -555,26 +460,13 @@ I salt, gS, I myIter, myThid) ENDIF -#ifdef ALLOW_PASSIVE_TRACER - IF ( tr1Stepping ) THEN - CALL CALC_GTR1( - I bi,bj,iMin,iMax,jMin,jMax, k,km1,kup,kDown, - I xA,yA,uTrans,vTrans,rTrans,maskUp, - I KappaRT, - U fVerTr1, - I myTime,myIter,myThid) - CALL TIMESTEP_TRACER( - I bi,bj,iMin,iMax,jMin,jMax,k,tracerAdvScheme, - I Tr1, gTr1, - I myIter,myThid) - ENDIF #endif #ifdef ALLOW_PTRACERS IF ( usePTRACERS ) THEN - CALL PTRACERS_INTEGERATE( + CALL PTRACERS_INTEGRATE( I bi,bj,k, - I xA,yA,uTrans,vTrans,rTrans,maskUp, - X KappaRS, + I xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp, + X fVerP, KappaRS, I myIter,myTime,myThid) ENDIF #endif /* ALLOW_PTRACERS */ @@ -587,105 +479,125 @@ #endif /* ALLOW_OBCS */ C-- Freeze water - IF (allowFreezing) THEN +C this bit of code is left here for backward compatibility. +C freezing at surface level has been moved to FORWARD_STEP +#ifndef ALLOW_OFFLINE + IF ( useOldFreezing .AND. .NOT. useSEAICE + & .AND. .NOT.(useThSIce.AND.k.EQ.1) ) THEN #ifdef ALLOW_AUTODIFF_TAMC CADJ STORE gT(:,:,k,bi,bj) = comlev1_bibj_k CADJ & , key = kkey, byte = isbyte #endif /* ALLOW_AUTODIFF_TAMC */ CALL FREEZE( bi, bj, iMin, iMax, jMin, jMax, k, myThid ) - END IF + ENDIF +#endif C-- end of thermodynamic k loop (Nr:1) ENDDO +C-- Implicit vertical advection & diffusion +#ifndef ALLOW_OFFLINE +#ifdef INCLUDE_IMPLVERTADV_CODE + IF ( tempImplVertAdv ) THEN + CALL GAD_IMPLICIT_R( + I tempImplVertAdv, tempAdvScheme, GAD_TEMPERATURE, + I kappaRT, wVel, theta, + U gT, + I bi, bj, myTime, myIter, myThid ) + ELSEIF ( tempStepping .AND. implicitDiffusion ) THEN +#else /* INCLUDE_IMPLVERTADV_CODE */ + IF ( tempStepping .AND. implicitDiffusion ) THEN +#endif /* INCLUDE_IMPLVERTADV_CODE */ #ifdef ALLOW_AUTODIFF_TAMC -C? Patrick? What about this one? -cph Keys iikey and idkey dont seem to be needed -cph since storing occurs on different tape for each -cph impldiff call anyways. -cph Thus, common block comlev1_impl isnt needed either. -cph Storing below needed in the case useGMREDI. - iikey = (ikey-1)*maximpl -#endif /* ALLOW_AUTODIFF_TAMC */ - -C-- Implicit diffusion - IF (implicitDiffusion) THEN - - IF (tempStepping) THEN -#ifdef ALLOW_AUTODIFF_TAMC - idkey = iikey + 1 -CADJ STORE gT(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte +CADJ STORE KappaRT(:,:,:) = comlev1_bibj , key=itdkey, byte=isbyte +CADJ STORE gT(:,:,:,bi,bj) = comlev1_bibj , key=itdkey, byte=isbyte #endif /* ALLOW_AUTODIFF_TAMC */ - CALL IMPLDIFF( + CALL IMPLDIFF( I bi, bj, iMin, iMax, jMin, jMax, I deltaTtracer, KappaRT, recip_HFacC, U gT, I myThid ) - ENDIF + ENDIF +#endif - IF (saltStepping) THEN +#ifndef ALLOW_OFFLINE +#ifdef INCLUDE_IMPLVERTADV_CODE + IF ( saltImplVertAdv ) THEN + CALL GAD_IMPLICIT_R( + I saltImplVertAdv, saltAdvScheme, GAD_SALINITY, + I kappaRS, wVel, salt, + U gS, + I bi, bj, myTime, myIter, myThid ) + ELSEIF ( saltStepping .AND. implicitDiffusion ) THEN +#else /* INCLUDE_IMPLVERTADV_CODE */ + IF ( saltStepping .AND. implicitDiffusion ) THEN +#endif /* INCLUDE_IMPLVERTADV_CODE */ #ifdef ALLOW_AUTODIFF_TAMC - idkey = iikey + 2 -CADJ STORE gS(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte +CADJ STORE KappaRS(:,:,:) = comlev1_bibj , key=itdkey, byte=isbyte +CADJ STORE gS(:,:,:,bi,bj) = comlev1_bibj , key=itdkey, byte=isbyte #endif /* ALLOW_AUTODIFF_TAMC */ - CALL IMPLDIFF( + CALL IMPLDIFF( I bi, bj, iMin, iMax, jMin, jMax, I deltaTtracer, KappaRS, recip_HFacC, U gS, I myThid ) - ENDIF - -#ifdef ALLOW_PASSIVE_TRACER - IF (tr1Stepping) THEN -#ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE gTr1(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ - CALL IMPLDIFF( - I bi, bj, iMin, iMax, jMin, jMax, - I deltaTtracer, KappaRT, recip_HFacC, - U gTr1, - I myThid ) - ENDIF + ENDIF #endif #ifdef ALLOW_PTRACERS -C Vertical diffusion (implicit) for passive tracers - IF ( usePTRACERS ) THEN +c #ifdef INCLUDE_IMPLVERTADV_CODE +c IF ( usePTRACERS .AND. ptracerImplVertAdv ) THEN +c ELSEIF ( usePTRACERS .AND. implicitDiffusion ) THEN +c #else + IF ( usePTRACERS .AND. implicitDiffusion ) THEN +C-- Vertical diffusion (implicit) for passive tracers CALL PTRACERS_IMPLDIFF( bi,bj,KappaRS,myThid ) - ENDIF + ENDIF #endif /* ALLOW_PTRACERS */ #ifdef ALLOW_OBCS C-- Apply open boundary conditions - IF (useOBCS) THEN + IF ( ( implicitDiffusion + & .OR. tempImplVertAdv + & .OR. saltImplVertAdv + & ) .AND. useOBCS ) THEN DO K=1,Nr CALL OBCS_APPLY_TS( bi, bj, k, gT, gS, myThid ) ENDDO - END IF + ENDIF #endif /* ALLOW_OBCS */ -C-- End If implicitDiffusion +#ifdef ALLOW_TIMEAVE + IF ( taveFreq.GT. 0. _d 0 .AND. fluidIsWater ) THEN + CALL TIMEAVE_SURF_FLUX( bi, bj, myTime, myIter, myThid) + ENDIF +#ifndef HRCUBE + IF (taveFreq.GT.0. .AND. ivdc_kappa.NE.0.) THEN + CALL TIMEAVE_CUMULATE(ConvectCountTave, IVDConvCount, + I Nr, deltaTclock, bi, bj, myThid) ENDIF + useVariableK = useKPP .OR. usePP81 .OR. useMY82 .OR. useGGL90 + & .OR. useGMredi .OR. ivdc_kappa.NE.0. + IF (taveFreq.GT.0. .AND. useVariableK ) THEN + IF (implicitDiffusion) THEN + CALL TIMEAVE_CUMUL_DIF_1T(TdiffRtave, gT, kappaRT, + I Nr, 3, deltaTclock, bi, bj, myThid) + ELSE + CALL TIMEAVE_CUMUL_DIF_1T(TdiffRtave, theta, kappaRT, + I Nr, 3, deltaTclock, bi, bj, myThid) + ENDIF + ENDIF +#endif /* ndef HRCUBE */ +#endif /* ALLOW_TIMEAVE */ -Ccs- +#endif /* SINGLE_LAYER_MODE */ + +C-- end bi,bj loops. ENDDO ENDDO -#ifdef ALLOW_AIM - IF ( useAIM ) THEN - CALL AIM_AIM2DYN_EXCHANGES( myTime, myThid ) - ENDIF - _EXCH_XYZ_R8(gT,myThid) - _EXCH_XYZ_R8(gS,myThid) -#else - IF (staggerTimeStep.AND.useCubedSphereExchange) THEN - _EXCH_XYZ_R8(gT,myThid) - _EXCH_XYZ_R8(gS,myThid) - ENDIF -#endif /* ALLOW_AIM */ - -#ifndef DISABLE_DEBUGMODE +#ifdef ALLOW_DEBUG If (debugMode) THEN CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (THERMODYNAMICS)',myThid) CALL DEBUG_STATS_RL(Nr,vVel,'Vvel (THERMODYNAMICS)',myThid) @@ -704,5 +616,10 @@ ENDIF #endif +#ifdef ALLOW_DEBUG + IF ( debugLevel .GE. debLevB ) + & CALL DEBUG_LEAVE('THERMODYNAMICS',myThid) +#endif + RETURN END