--- MITgcm/model/src/dynamics.F 2001/01/29 20:05:46 1.56 +++ MITgcm/model/src/dynamics.F 2009/04/26 19:36:36 1.142 @@ -1,156 +1,198 @@ -C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/src/dynamics.F,v 1.56 2001/01/29 20:05:46 heimbach Exp $ +C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/src/dynamics.F,v 1.142 2009/04/26 19:36:36 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 +C !INTERFACE: SUBROUTINE DYNAMICS(myTime, myIter, myThid) -C /==========================================================\ -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 | Notes | -C | ===== | -C | C*P* comments indicating place holders for which code is | -C | presently being developed. | -C \==========================================================/ +C !DESCRIPTION: \bv +C *==========================================================* +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 | The algorithm... +C | +C | "Correction Step" +C | ================= +C | Here we update the horizontal velocities with the surface +C | pressure such that the resulting flow is either consistent +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 | =================== +C | This is where all the accelerations and tendencies (ie. +C | physics, parameterizations etc...) are calculated +C | rho = rho ( theta[n], salt[n] ) +C | b = b(rho, theta) +C | K31 = K31 ( rho ) +C | Gu[n] = Gu( u[n], v[n], wVel, b, ... ) +C | Gv[n] = Gv( u[n], v[n], wVel, b, ... ) +C | Gt[n] = Gt( theta[n], u[n], v[n], wVel, K31, ... ) +C | Gs[n] = Gs( salt[n], u[n], v[n], wVel, K31, ... ) +C | +C | "Time-stepping" or "Prediction" +C | ================================ +C | The models variables are stepped forward with the appropriate +C | time-stepping scheme (currently we use Adams-Bashforth II) +C | - For momentum, the result is always *only* a "prediction" +C | in that the flow may be divergent and will be "corrected" +C | later with a surface pressure gradient. +C | - Normally for tracers the result is the new field at time +C | level [n+1} *BUT* in the case of implicit diffusion the result +C | is also *only* a prediction. +C | - We denote "predictors" with an asterisk (*). +C | U* = U[n] + dt x ( 3/2 Gu[n] - 1/2 Gu[n-1] ) +C | V* = V[n] + dt x ( 3/2 Gv[n] - 1/2 Gv[n-1] ) +C | theta[n+1] = theta[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] ) +C | salt[n+1] = salt[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] ) +C | With implicit diffusion: +C | theta* = theta[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] ) +C | salt* = salt[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] ) +C | (1 + dt * K * d_zz) theta[n] = theta* +C | (1 + dt * K * d_zz) salt[n] = salt* +C | +C *==========================================================* +C \ev +C !USES: IMPLICIT NONE - C == Global variables === #include "SIZE.h" #include "EEPARAMS.h" -#include "CG2D.h" #include "PARAMS.h" #include "DYNVARS.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" # include "FFIELDS.h" +# include "EOS.h" # ifdef ALLOW_KPP # include "KPP.h" # endif -# ifdef ALLOW_GMREDI -# include "GMREDI.h" +# 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 | +C |-- MOM_FLUXFORM +C | +C |-- MOM_VECINV +C | +C |-- TIMESTEP +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 |-- 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 +C !LOCAL VARIABLES: C == Local variables -C xA, yA - Per block temporaries holding face areas -C uTrans, vTrans, rTrans - Per block temporaries holding flow -C transport -C rVel o uTrans: Zonal transport -C o vTrans: Meridional transport -C o rTrans: Vertical transport -C o rVel: Vertical velocity at upper and -C lower cell faces. -C maskC,maskUp o maskC: land/water mask for tracer cells -C o maskUp: land/water mask for W points -C aTerm, xTerm, cTerm - Work arrays for holding separate terms in -C mTerm, pTerm, tendency equations. -C fZon, fMer, fVer[STUV] o aTerm: Advection term -C o xTerm: Mixing term -C o cTerm: Coriolis term -C o mTerm: Metric term -C o pTerm: Pressure term -C o fZon: Zonal flux term -C o fMer: Meridional flux term -C 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, level above and level -C below. -C rhoKP1 -C buoyK, buoyKM1 - Buoyancy at current level and level above. -C phiHyd - Hydrostatic part of the potential phiHydi. -C In z coords phiHydiHyd is the hydrostatic -C pressure anomaly -C In p coords phiHydiHyd is the geopotential -C surface height -C anomaly. -C etaSurfX, - Holds surface elevation gradient in X and Y. -C etaSurfY -C KappaRT, - Total diffusion in vertical for T and S. -C KappaRS (background + spatially varying, isopycnal term). +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 +C In p coords phiHyd is the geopotential height anomaly. +C phiHydF :: hydrostatic potential anomaly at middle between 2 centers +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 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 index into fVerTerm. - _RS xA (1-OLx:sNx+OLx,1-OLy:sNy+OLy) - _RS yA (1-OLx:sNx+OLx,1-OLy:sNy+OLy) - _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 rVel (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) - _RS maskC (1-OLx:sNx+OLx,1-OLy:sNy+OLy) - _RS maskUp (1-OLx:sNx+OLx,1-OLy:sNy+OLy) - _RL aTerm (1-OLx:sNx+OLx,1-OLy:sNy+OLy) - _RL xTerm (1-OLx:sNx+OLx,1-OLy:sNy+OLy) - _RL cTerm (1-OLx:sNx+OLx,1-OLy:sNy+OLy) - _RL mTerm (1-OLx:sNx+OLx,1-OLy:sNy+OLy) - _RL pTerm (1-OLx:sNx+OLx,1-OLy:sNy+OLy) - _RL fZon (1-OLx:sNx+OLx,1-OLy:sNy+OLy) - _RL fMer (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 fVerU (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2) _RL fVerV (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 rhokp1 (1-OLx:sNx+OLx,1-OLy:sNy+OLy) - _RL rhok (1-OLx:sNx+OLx,1-OLy:sNy+OLy) - _RL buoyKM1 (1-OLx:sNx+OLx,1-OLy:sNy+OLy) - _RL buoyK (1-OLx:sNx+OLx,1-OLy:sNy+OLy) - _RL rhotmp (1-OLx:sNx+OLx,1-OLy:sNy+OLy) - _RL etaSurfX(1-OLx:sNx+OLx,1-OLy:sNy+OLy) - _RL etaSurfY(1-OLx:sNx+OLx,1-OLy:sNy+OLy) - _RL KappaRT (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr) - _RL KappaRS (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr) + _RL phiHydF (1-OLx:sNx+OLx,1-OLy:sNy+OLy) + _RL phiHydC (1-OLx:sNx+OLx,1-OLy:sNy+OLy) + _RL dPhiHydX(1-Olx:sNx+Olx,1-Oly:sNy+Oly) + _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) - _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 also used by IVDC and Diagnostics -C #ifdef INCLUDE_CONVECT_CALL - _RL ConvectCount (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr) -C #endif INTEGER iMin, iMax INTEGER jMin, jMax INTEGER bi, bj INTEGER i, j - INTEGER k, km1, kup, kDown - LOGICAL BOTTOM_LAYER + INTEGER k, km1, kp1, kup, kDown -#ifdef ALLOW_AUTODIFF_TAMC - INTEGER isbyte - PARAMETER( isbyte = 4 ) +#ifdef ALLOW_DIAGNOSTICS + _RL tmpFac +#endif /* ALLOW_DIAGNOSTICS */ - INTEGER act1, act2, act3, act4 - INTEGER max1, max2, max3 - INTEGER iikey, kkey - INTEGER maximpl -#endif /* ALLOW_AUTODIFF_TAMC */ C--- The algorithm... C @@ -166,14 +208,13 @@ C =================== C This is where all the accelerations and tendencies (ie. C physics, parameterizations etc...) are calculated -C rVel = sum_r ( div. u[n] ) C rho = rho ( theta[n], salt[n] ) C b = b(rho, theta) C K31 = K31 ( rho ) -C Gu[n] = Gu( u[n], v[n], rVel, b, ... ) -C Gv[n] = Gv( u[n], v[n], rVel, b, ... ) -C Gt[n] = Gt( theta[n], u[n], v[n], rVel, K31, ... ) -C Gs[n] = Gs( salt[n], u[n], v[n], rVel, K31, ... ) +C Gu[n] = Gu( u[n], v[n], wVel, b, ... ) +C Gv[n] = Gv( u[n], v[n], wVel, b, ... ) +C Gt[n] = Gt( theta[n], u[n], v[n], wVel, K31, ... ) +C Gs[n] = Gs( salt[n], u[n], v[n], wVel, K31, ... ) C C "Time-stepping" or "Prediction" C ================================ @@ -196,49 +237,19 @@ C (1 + dt * K * d_zz) theta[n] = theta* C (1 + dt * K * d_zz) salt[n] = salt* C--- +CEOP -#ifdef ALLOW_AUTODIFF_TAMC -C-- dummy statement to end declaration part - ikey = 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 - aTerm(i,j) = 0. _d 0 - xTerm(i,j) = 0. _d 0 - cTerm(i,j) = 0. _d 0 - mTerm(i,j) = 0. _d 0 - pTerm(i,j) = 0. _d 0 - fZon(i,j) = 0. _d 0 - fMer(i,j) = 0. _d 0 - DO k=1,Nr - phiHyd (i,j,k) = 0. _d 0 - KappaRU(i,j,k) = 0. _d 0 - KappaRV(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 - rhoKP1 (i,j) = 0. _d 0 - rhoTMP (i,j) = 0. _d 0 - buoyKM1(i,j) = 0. _d 0 - buoyK (i,j) = 0. _d 0 - maskC (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, +C if desired: +#ifdef INCLUDE_EP_FORCING_CODE + CALL CALC_EP_FORCING(myThid) +#endif #ifdef ALLOW_AUTODIFF_TAMC C-- HPF directive to help TAMC @@ -249,9 +260,9 @@ #ifdef ALLOW_AUTODIFF_TAMC C-- HPF directive to help TAMC -CHPF$ INDEPENDENT, NEW (rTrans,rVel,fVerT,fVerS,fVerU,fVerV -CHPF$& ,phiHyd,utrans,vtrans,maskc,xA,yA -CHPF$& ,KappaRT,KappaRS,KappaRU,KappaRV +CHPF$ INDEPENDENT, NEW (fVerU,fVerV +CHPF$& ,phiHydF +CHPF$& ,KappaRU,KappaRV CHPF$& ) #endif /* ALLOW_AUTODIFF_TAMC */ @@ -260,705 +271,418 @@ #ifdef ALLOW_AUTODIFF_TAMC act1 = bi - myBxLo(myThid) max1 = myBxHi(myThid) - myBxLo(myThid) + 1 - act2 = bj - myByLo(myThid) max2 = myByHi(myThid) - myByLo(myThid) + 1 - act3 = myThid - 1 max3 = nTx*nTy - act4 = ikey_dynamics - 1 - - ikey = (act1 + 1) + act2*max1 + idynkey = (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 - DO j=1-OLy,sNy+OLy - DO i=1-OLx,sNx+OLx - rTrans(i,j) = 0. _d 0 - rVel (i,j,1) = 0. _d 0 - rVel (i,j,2) = 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 - 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 - phiHyd(i,j,1) = 0. _d 0 - ENDDO - ENDDO +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. +#ifdef ALLOW_AUTODIFF_TAMC DO k=1,Nr DO j=1-OLy,sNy+OLy DO i=1-OLx,sNx+OLx -#ifdef INCLUDE_CONVECT_CALL - ConvectCount(i,j,k) = 0. -#endif - KappaRT(i,j,k) = 0. _d 0 - KappaRS(i,j,k) = 0. _d 0 + KappaRU(i,j,k) = 0. _d 0 + KappaRV(i,j,k) = 0. _d 0 +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 ENDDO ENDDO ENDDO - - iMin = 1-OLx+1 - iMax = sNx+OLx - jMin = 1-OLy+1 - jMax = sNy+OLy - - k = 1 - BOTTOM_LAYER = k .EQ. Nr - -#ifdef DO_PIPELINED_CORRECTION_STEP -C-- Calculate gradient of surface pressure - CALL CALC_GRAD_ETA_SURF( - I bi,bj,iMin,iMax,jMin,jMax, - O etaSurfX,etaSurfY, - I myThid) -C-- Update fields in top level according to tendency terms - CALL CORRECTION_STEP( - I bi,bj,iMin,iMax,jMin,jMax,k, - I etaSurfX,etaSurfY,myTime,myThid) - -#ifdef ALLOW_OBCS - IF (openBoundaries) THEN -#ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE uvel (:,:,k,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte -CADJ STORE vvel (:,:,k,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte -CADJ STORE theta(:,:,k,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte -CADJ STORE salt (:,:,k,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte #endif /* ALLOW_AUTODIFF_TAMC */ - CALL APPLY_OBCS1( bi, bj, k, myThid ) - END IF + 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 + 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 +#ifdef ALLOW_AUTODIFF_TAMC +# 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 - IF ( .NOT. BOTTOM_LAYER ) THEN -C-- Update fields in layer below according to tendency terms - CALL CORRECTION_STEP( - I bi,bj,iMin,iMax,jMin,jMax,k+1, - I etaSurfX,etaSurfY,myTime,myThid) -#ifdef ALLOW_OBCS - IF (openBoundaries) THEN -#ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE uvel (:,:,k,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte -CADJ STORE vvel (:,:,k,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte -CADJ STORE theta(:,:,k,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte -CADJ STORE salt (:,:,k,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ - CALL APPLY_OBCS1( bi, bj, k+1, myThid ) - END IF -#endif +C-- Start computation of dynamics + iMin = 0 + iMax = sNx+1 + jMin = 0 + jMax = sNy+1 + +#ifdef ALLOW_AUTODIFF_TAMC +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) +C (note: this loop will be replaced by CALL CALC_GRAD_ETA) + IF (implicSurfPress.NE.1.) THEN + CALL CALC_GRAD_PHI_SURF( + I bi,bj,iMin,iMax,jMin,jMax, + I etaN, + O phiSurfX,phiSurfY, + I myThid ) ENDIF -#endif - -C-- Density of 1st level (below W(1)) reference to level 1 -#ifdef INCLUDE_FIND_RHO_CALL -#ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE theta(:,:,k,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte -CADJ STORE salt (:,:,k,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ - CALL FIND_RHO( - I bi, bj, iMin, iMax, jMin, jMax, k, k, eosType, - O rhoKm1, - I myThid ) -#endif - - IF (.NOT. BOTTOM_LAYER) THEN - -C-- Check static stability with layer below -C-- and mix as needed. -#ifdef INCLUDE_FIND_RHO_CALL -#ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE theta(:,:,k+1,bi,bj) = comlev1_bibj -CADJ & , key = ikey, byte = isbyte -CADJ STORE salt (:,:,k+1,bi,bj) = comlev1_bibj -CADJ & , key = ikey, byte = isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ - CALL FIND_RHO( - I bi, bj, iMin, iMax, jMin, jMax, k+1, k, eosType, - O rhoKp1, - I myThid ) -#endif - -#ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE rhoKm1(:,:) = comlev1_bibj, key = ikey, byte = isbyte -CADJ STORE rhoKp1(:,:) = comlev1_bibj, key = ikey, byte = isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ - -#ifdef INCLUDE_CONVECT_CALL - - CALL CONVECT( - I bi,bj,iMin,iMax,jMin,jMax,k+1,rhoKm1,rhoKp1, - U ConvectCount, - I myTime,myIter,myThid) #ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE theta(:,:,k+1,bi,bj),theta(:,:,k,bi,bj) -CADJ & = comlev1_bibj, key = ikey, byte = isbyte -CADJ STORE salt (:,:,k+1,bi,bj),salt (:,:,k,bi,bj) -CADJ & = comlev1_bibj, key = ikey, byte = isbyte +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 & = comlev1_bibj, key=idynkey, byte=isbyte +#endif /* ALLOW_KPP */ #endif /* ALLOW_AUTODIFF_TAMC */ -#endif - -C-- Implicit Vertical Diffusion for Convection - IF (ivdc_kappa.NE.0.) THEN - CALL CALC_IVDC( - I bi,bj,iMin,iMax,jMin,jMax,k+1,rhoKm1,rhoKp1, - U ConvectCount, KappaRT, KappaRS, - I myTime,myIter,myThid) - ENDIF - -C-- Recompute density after mixing -#ifdef INCLUDE_FIND_RHO_CALL - CALL FIND_RHO( - I bi, bj, iMin, iMax, jMin, jMax, k, k, eosType, - O rhoKm1, - I myThid ) -#endif - ENDIF - -C-- Calculate buoyancy - CALL CALC_BUOYANCY( - I bi,bj,iMin,iMax,jMin,jMax,k,rhoKm1, - O buoyKm1, - I myThid ) - -C-- Integrate hydrostatic balance for phiHyd with BC of -C-- phiHyd(z=0)=0 - CALL CALC_PHI_HYD( - I bi,bj,iMin,iMax,jMin,jMax,k,buoyKm1,buoyKm1, - U phiHyd, - I myThid ) - -#ifdef ALLOW_GMREDI - IF ( useGMRedi ) THEN - CALL GRAD_SIGMA( - I bi, bj, iMin, iMax, jMin, jMax, k, - I rhoKm1, rhoKm1, rhoKm1, - O sigmaX, sigmaY, sigmaR, +#ifdef INCLUDE_CALC_DIFFUSIVITY_CALL +C-- Calculate the total vertical viscosity + CALL CALC_VISCOSITY( + I bi,bj, iMin,iMax,jMin,jMax, + O KappaRU, KappaRV, I myThid ) - ELSE +#else + DO k=1,Nr DO j=1-OLy,sNy+OLy DO i=1-OLx,sNx+OLx - sigmaX(i,j,k) = 0. _d 0 - sigmaY(i,j,k) = 0. _d 0 - sigmaR(i,j,k) = 0. _d 0 + KappaRU(i,j,k) = 0. _d 0 + KappaRV(i,j,k) = 0. _d 0 ENDDO ENDDO - ENDIF -#endif - -C-- Start of downward loop - DO k=2,Nr - -#ifdef ALLOW_AUTODIFF_TAMC - kkey = (ikey-1)*(Nr-2+1) + (k-2) + 1 -#endif /* ALLOW_AUTODIFF_TAMC */ - - BOTTOM_LAYER = k .EQ. Nr - -#ifdef DO_PIPELINED_CORRECTION_STEP - IF ( .NOT. BOTTOM_LAYER ) THEN -C-- Update fields in layer below according to tendency terms - CALL CORRECTION_STEP( - I bi,bj,iMin,iMax,jMin,jMax,k+1, - I etaSurfX,etaSurfY,myTime,myThid) -#ifdef ALLOW_OBCS - IF (openBoundaries) THEN -#ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE uvel (:,:,k,bi,bj) = comlev1_bibj_k -CADJ & , key = kkey, byte = isbyte -CADJ STORE vvel (:,:,k,bi,bj) = comlev1_bibj_k -CADJ & , key = kkey, byte = isbyte -CADJ STORE theta(:,:,k,bi,bj) = comlev1_bibj_k -CADJ & , key = kkey, byte = isbyte -CADJ STORE salt (:,:,k,bi,bj) = comlev1_bibj_k -CADJ & , key = kkey, byte = isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ - CALL APPLY_OBCS1( bi, bj, k+1, myThid ) - END IF -#endif - ENDIF -#endif /* DO_PIPELINED_CORRECTION_STEP */ - -C-- Density of k level (below W(k)) reference to k level -#ifdef INCLUDE_FIND_RHO_CALL -#ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE theta(:,:,k,bi,bj) = comlev1_bibj_k -CADJ & , key = kkey, byte = isbyte -CADJ STORE salt (:,:,k,bi,bj) = comlev1_bibj_k -CADJ & , key = kkey, byte = isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ - CALL FIND_RHO( - I bi, bj, iMin, iMax, jMin, jMax, k, k, eosType, - O rhoK, - I myThid ) - -#ifdef ALLOW_AUTODIFF_TAMC -cph( storing not necessary -cphCADJ STORE rhoK(:,:) = comlev1_bibj_k, key = kkey, byte = isbyte -cph) -#endif /* ALLOW_AUTODIFF_TAMC */ + ENDDO #endif - IF (.NOT. BOTTOM_LAYER) THEN - -C-- Check static stability with layer below and mix as needed. -C-- Density of k+1 level (below W(k+1)) reference to k level. -#ifdef INCLUDE_FIND_RHO_CALL #ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE theta(:,:,k+1,bi,bj) = comlev1_bibj_k -CADJ & , key = kkey, byte = isbyte -CADJ STORE salt (:,:,k+1,bi,bj) = comlev1_bibj_k -CADJ & , key = kkey, byte = isbyte +CADJ STORE KappaRU(:,:,:) +CADJ & = comlev1_bibj, key=idynkey, byte=isbyte +CADJ STORE KappaRV(:,:,:) +CADJ & = comlev1_bibj, key=idynkey, byte=isbyte #endif /* ALLOW_AUTODIFF_TAMC */ - CALL FIND_RHO( - I bi, bj, iMin, iMax, jMin, jMax, k+1, k, eosType, - O rhoKp1, - I myThid ) -#ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE rhoKp1(:,:) = comlev1_bibj_k, key = kkey, byte = isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ -#endif -#ifdef INCLUDE_CONVECT_CALL - CALL CONVECT( - I bi,bj,iMin,iMax,jMin,jMax,k+1,rhoK,rhoKp1, - U ConvectCount, - I myTime,myIter,myThid) - -#endif +C-- Start of dynamics loop + DO k=1,Nr -C-- Implicit Vertical Diffusion for Convection - IF (ivdc_kappa.NE.0.) THEN -#ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE rhoKm1(:,:) = comlev1_bibj_k, key = kkey, byte = isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ - CALL CALC_IVDC( - I bi,bj,iMin,iMax,jMin,jMax,k+1,rhoKm1,rhoKp1, - U ConvectCount, KappaRT, KappaRS, - I myTime,myIter,myThid) - END IF +C-- km1 Points to level above k (=k-1) +C-- kup Cycles through 1,2 to point to layer above +C-- kDown Cycles through 2,1 to point to current layer + + km1 = MAX(1,k-1) + kp1 = MIN(k+1,Nr) + kup = 1+MOD(k+1,2) + kDown= 1+MOD(k,2) -C-- Recompute density after mixing -#ifdef INCLUDE_FIND_RHO_CALL -#ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE theta(:,:,k,bi,bj) = comlev1_bibj_k -CADJ & , key = kkey, byte = isbyte -CADJ STORE salt (:,:,k,bi,bj) = comlev1_bibj_k -CADJ & , key = kkey, byte = isbyte +#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 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 */ - CALL FIND_RHO( - I bi, bj, iMin, iMax, jMin, jMax, k, k, eosType, - O rhoK, - I myThid ) -#endif - -C-- IF (.NOT. BOTTOM_LAYER) ends here - ENDIF - -C-- Calculate buoyancy - CALL CALC_BUOYANCY( - I bi,bj,iMin,iMax,jMin,jMax,k,rhoK, - O buoyK, - I myThid ) C-- Integrate hydrostatic balance for phiHyd with BC of -C-- phiHyd(z=0)=0 - CALL CALC_PHI_HYD( - I bi,bj,iMin,iMax,jMin,jMax,k,buoyKm1,buoyK, - U phiHyd, - I myThid ) - -#ifdef INCLUDE_FIND_RHO_CALL -C-- Calculate iso-neutral slopes for the GM/Redi parameterisation - -#ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE theta(:,:,k-1,bi,bj) = comlev1_bibj_k -CADJ & , key = kkey, byte = isbyte -CADJ STORE salt (:,:,k-1,bi,bj) = comlev1_bibj_k -CADJ & , key = kkey, byte = isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ - - CALL FIND_RHO( - I bi, bj, iMin, iMax, jMin, jMax, k-1, k, eosType, - O rhoTmp, - I myThid ) -#endif - - -#ifdef ALLOW_GMREDI - IF ( useGMRedi ) THEN - CALL GRAD_SIGMA( - I bi, bj, iMin, iMax, jMin, jMax, k, - I rhoK, rhotmp, rhoK, - O sigmaX, sigmaY, sigmaR, - I myThid ) +C phiHyd(z=0)=0 + 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 - DO j=1-OLy,sNy+OLy - DO i=1-OLx,sNx+OLx - sigmaX(i,j,k) = 0. _d 0 - sigmaY(i,j,k) = 0. _d 0 - sigmaR(i,j,k) = 0. _d 0 - ENDDO - ENDDO + 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 -#endif - - DO J=jMin,jMax - DO I=iMin,iMax -#ifdef INCLUDE_FIND_RHO_CALL - rhoKm1 (I,J) = rhoK(I,J) -#endif - buoyKm1(I,J) = buoyK(I,J) - ENDDO - ENDDO -C-- end of k loop - ENDDO - -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 - -CADJ STORE surfacetendencyu(:,:,bi,bj) -CADJ & , surfacetendencyv(:,:,bi,bj) -CADJ & , surfacetendencys(:,:,bi,bj) -CADJ & , surfacetendencyt(:,:,bi,bj) -CADJ & = comlev1_bibj, key=ikey, byte=isbyte - -# ifdef ALLOW_GMREDI -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_GMREDI */ - -#endif /* ALLOW_AUTODIFF_TAMC */ - -#ifdef ALLOW_GMREDI - IF (useGMRedi) THEN - DO k=1, Nr - CALL GMREDI_CALC_TENSOR( - I bi, bj, iMin, iMax, jMin, jMax, k, - I sigmaX, sigmaY, sigmaR, - I myThid ) - ENDDO -#ifdef ALLOW_AUTODIFF_TAMC - ELSE - DO k=1, Nr - CALL GMREDI_CALC_TENSOR_DUMMY( - I bi, bj, iMin, iMax, jMin, jMax, k, - I sigmaX, sigmaY, sigmaR, - I myThid ) - ENDDO -#endif /* ALLOW_AUTODIFF_TAMC */ - ENDIF -#endif - -#ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE KappaRT(:,:,:) = comlev1_bibj, key=ikey, byte=isbyte -CADJ STORE KappaRS(:,:,:) = comlev1_bibj, key=ikey, byte=isbyte - -#ifdef ALLOW_GMREDI -C-- R.G. We need to define a new tape since Kw use mythid instead of bi,bj -CADJ STORE Kwx(:,:,:,myThid) = comlev1_bibj, key=ikey, byte=isbyte -CADJ STORE Kwy(:,:,:,myThid) = comlev1_bibj, key=ikey, byte=isbyte -CADJ STORE Kwz(:,:,:,myThid) = comlev1_bibj, key=ikey, byte=isbyte -#endif - -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 -======= -C-- R.G. We need to define a new tape since Kw use mythid instead of bi,bj -CADJ STORE Kwx(:,:,:,myThid) = comlev1_bibj, key=ikey, byte=isbyte -CADJ STORE Kwy(:,:,:,myThid) = comlev1_bibj, key=ikey, byte=isbyte -CADJ STORE Kwz(:,:,:,myThid) = 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 - -C-- dummy initialization to break data flow because -C-- calc_div_ghat has a condition for initialization - DO J=jMin,jMax - DO I=iMin,iMax - cg2d_b(i,j,bi,bj) = 0.0 - ENDDO - ENDDO -#endif /* ALLOW_AUTODIFF_TAMC */ - -#ifdef ALLOW_KPP -C-- Compute KPP mixing coefficients - IF (useKPP) THEN - - CALL TIMER_START('KPP_CALC [DYNAMICS]', myThid) - CALL KPP_CALC( - I bi, bj, myTime, myThid ) - CALL TIMER_STOP ('KPP_CALC [DYNAMICS]', myThid) - -#ifdef ALLOW_AUTODIFF_TAMC - ELSE - DO j=1-OLy,sNy+OLy - DO i=1-OLx,sNx+OLx - KPPhbl (i,j,bi,bj) = 1.0 - KPPfrac(i,j,bi,bj) = 0.0 - DO k = 1,Nr - KPPghat (i,j,k,bi,bj) = 0.0 - KPPviscAz (i,j,k,bi,bj) = viscAz - KPPdiffKzT(i,j,k,bi,bj) = diffKzT - KPPdiffKzS(i,j,k,bi,bj) = diffKzS - ENDDO - ENDDO - ENDDO -#endif /* ALLOW_AUTODIFF_TAMC */ - ENDIF - -#ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE KPPghat (:,:,:,bi,bj) -CADJ & , KPPviscAz (:,:,:,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 */ - -C-- Start of upward loop - DO k = Nr, 1, -1 - -C-- km1 Points to level above k (=k-1) -C-- kup Cycles through 1,2 to point to layer above -C-- kDown Cycles through 2,1 to point to current layer - - km1 =max(1,k-1) - kup =1+MOD(k+1,2) - kDown=1+MOD(k,2) - - iMin = 1-OLx+2 - iMax = sNx+OLx-1 - jMin = 1-OLy+2 - jMax = sNy+OLy-1 - -#ifdef ALLOW_AUTODIFF_TAMC - kkey = (ikey-1)*(Nr-1+1) + (k-1) + 1 -CADJ STORE rvel (:,:,kdown) = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE rTrans(:,:) = comlev1_bibj_k, key=kkey, byte=isbyte -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 */ - -C-- Get temporary terms used by tendency routines - CALL CALC_COMMON_FACTORS ( - I bi,bj,iMin,iMax,jMin,jMax,k,km1,kup,kDown, - O xA,yA,uTrans,vTrans,rTrans,rVel,maskC,maskUp, - I myThid) - -#ifdef ALLOW_OBCS - IF (openBoundaries) THEN - CALL APPLY_OBCS3( bi, bj, k, kup, rTrans, rVel, myThid ) - ENDIF -#endif - -#ifdef INCLUDE_CALC_DIFFUSIVITY_CALL -C-- Calculate the total vertical diffusivity - CALL CALC_DIFFUSIVITY( - I bi,bj,iMin,iMax,jMin,jMax,k, - I maskC,maskUp, - O KappaRT,KappaRS,KappaRU,KappaRV, - I myThid) -#endif -C-- Calculate accelerations in the momentum equations +C-- Calculate accelerations in the momentum equations (gU, gV, ...) +C and step forward storing the result in gU, gV, etc... IF ( momStepping ) THEN - CALL CALC_MOM_RHS( - I bi,bj,iMin,iMax,jMin,jMax,k,km1,kup,kDown, - I xA,yA,uTrans,vTrans,rTrans,rVel,maskC, - I phiHyd,KappaRU,KappaRV, - U aTerm,xTerm,cTerm,mTerm,pTerm, - U fZon, fMer, fVerU, fVerV, - I myTime, myThid) #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 +# 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 -#endif /* ALLOW_AUTODIFF_TAMC */ - ENDIF -C-- Calculate active tracer tendencies - IF ( tempStepping ) THEN - CALL CALC_GT( - I bi,bj,iMin,iMax,jMin,jMax, k,km1,kup,kDown, - I xA,yA,uTrans,vTrans,rTrans,maskUp,maskC, - I KappaRT, - U aTerm,xTerm,fZon,fMer,fVerT, - I myTime, myThid) - ENDIF - IF ( saltStepping ) THEN - CALL CALC_GS( - I bi,bj,iMin,iMax,jMin,jMax, k,km1,kup,kDown, - I xA,yA,uTrans,vTrans,rTrans,maskUp,maskC, - I KappaRS, - U aTerm,xTerm,fZon,fMer,fVerS, - I myTime, myThid) - ENDIF -#ifdef ALLOW_OBCS -C-- Calculate future values on open boundaries - IF (openBoundaries) THEN -Caja CALL CYCLE_OBCS( k, bi, bj, myThid ) - CALL SET_OBCS( k, bi, bj, myTime+deltaTclock, myThid ) - ENDIF + IF (.NOT. vectorInvariantMomentum) THEN +#ifdef ALLOW_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 -C-- Prediction step (step forward all model variables) - CALL TIMESTEP( - I bi,bj,iMin,iMax,jMin,jMax,k, - I myIter, myThid) -#ifdef ALLOW_OBCS -C-- Apply open boundary conditions - IF (openBoundaries) THEN -#ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE gunm1(:,:,k,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE gvnm1(:,:,k,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte -CADJ STORE gwnm1(:,:,k,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ - - CALL APPLY_OBCS2( bi, bj, k, myThid ) - END IF + ELSE +#ifdef ALLOW_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 KappaRU, KappaRV, + U fVerU, fVerV, + O guDissip, gvDissip, + I myTime, myIter, myThid) #endif -C-- Freeze water - IF (allowFreezing) THEN -#ifdef ALLOW_AUTODIFF_TAMC -CADJ STORE gTNm1(:,:,k,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ - CALL FREEZE( bi, bj, iMin, iMax, jMin, jMax, k, myThid ) - END IF + ENDIF +C + CALL TIMESTEP( + I bi,bj,iMin,iMax,jMin,jMax,k, + I dPhiHydX,dPhiHydY, phiSurfX, phiSurfY, + 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 */ -#ifdef DIVG_IN_DYNAMICS -C-- Diagnose barotropic divergence of predicted fields - CALL CALC_DIV_GHAT( - I bi,bj,iMin,iMax,jMin,jMax,k, - I xA,yA, - I myThid) -#endif /* DIVG_IN_DYNAMICS */ - -C-- Cumulative diagnostic calculations (ie. time-averaging) -#ifdef INCLUDE_DIAGNOSTICS_INTERFACE_CODE - IF (taveFreq.GT.0.) THEN - CALL DO_TIME_AVERAGES( - I myTime, myIter, bi, bj, k, kup, kDown, - I rVel, ConvectCount, - I myThid ) ENDIF -#endif -C-- k loop +C-- end of dynamics k loop (1:Nr) ENDDO -#ifdef ALLOW_AUTODIFF_TAMC - maximpl = 6 - 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 gTNm1(:,:,:,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 gTNm1, - I myThid ) - END IF - - IF (saltStepping) THEN -#ifdef ALLOW_AUTODIFF_TAMC - idkey = iikey + 2 -CADJ STORE gSNm1(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ - CALL IMPLDIFF( - I bi, bj, iMin, iMax, jMin, jMax, - I deltaTtracer, KappaRS,recip_HFacC, - U gSNm1, - I myThid ) - END IF - -C-- implicitDiffusion - ENDIF - -C-- Implicit viscosity - IF (implicitViscosity) THEN - - IF (momStepping) THEN -#ifdef ALLOW_AUTODIFF_TAMC - idkey = iikey + 3 -CADJ STORE gUNm1(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ +C-- Implicit Vertical advection & viscosity +#if (defined (INCLUDE_IMPLVERTADV_CODE) && defined (ALLOW_MOM_COMMON)) + 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 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 - idkey = iikey + 4 -CADJ STORE gVNm1(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ +#ifdef ALLOW_AUTODIFF_TAMC +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 INCLUDE_CD_CODE +#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 + ENDIF +#endif /* ALLOW_OBCS */ -#ifdef ALLOW_AUTODIFF_TAMC - idkey = iikey + 5 -CADJ STORE vVelD(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ +#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 - idkey = iikey + 6 -CADJ STORE uVelD(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte -#endif /* ALLOW_AUTODIFF_TAMC */ +#ifdef ALLOW_AUTODIFF_TAMC +CADJ STORE uVelD(:,:,:,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, + I 0, KappaRV,recip_HFacS, U uVelD, I myThid ) + 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-- momStepping - ENDIF +C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| -C-- implicitViscosity - ENDIF - +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', myTime, myThid ) +Cml) + +#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) +#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