/[MITgcm]/MITgcm/model/src/thermodynamics.F
ViewVC logotype

Diff of /MITgcm/model/src/thermodynamics.F

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.50 by jmc, Tue Oct 7 04:31:30 2003 UTC revision 1.97 by jmc, Wed Dec 14 22:49:22 2005 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  C $Name$
3    
4    #include "PACKAGES_CONFIG.h"
5  #include "CPP_OPTIONS.h"  #include "CPP_OPTIONS.h"
6    
7  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
8  # ifdef ALLOW_GMREDI  # ifdef ALLOW_GMREDI
9  #  include "GMREDI_OPTIONS.h"  #  include "GMREDI_OPTIONS.h"
# Line 9  C $Name$ Line 11  C $Name$
11  # ifdef ALLOW_KPP  # ifdef ALLOW_KPP
12  #  include "KPP_OPTIONS.h"  #  include "KPP_OPTIONS.h"
13  # endif  # endif
 #ifdef ALLOW_PTRACERS  
 # include "PTRACERS_OPTIONS.h"  
 #endif  
14  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
15    
16  CBOP  CBOP
# Line 78  C     == Global variables === Line 77  C     == Global variables ===
77  #include "PARAMS.h"  #include "PARAMS.h"
78  #include "DYNVARS.h"  #include "DYNVARS.h"
79  #include "GRID.h"  #include "GRID.h"
80    #ifdef ALLOW_GENERIC_ADVDIFF
81  #include "GAD.h"  #include "GAD.h"
82  #ifdef ALLOW_PASSIVE_TRACER  #endif
83  #include "TR1.h"  #ifdef ALLOW_OFFLINE
84    #include "OFFLINE.h"
85  #endif  #endif
86  #ifdef ALLOW_PTRACERS  #ifdef ALLOW_PTRACERS
87    #include "PTRACERS_SIZE.h"
88  #include "PTRACERS.h"  #include "PTRACERS.h"
89  #endif  #endif
90  #ifdef ALLOW_TIMEAVE  #ifdef ALLOW_TIMEAVE
# Line 100  C     == Global variables === Line 102  C     == Global variables ===
102  # ifdef ALLOW_GMREDI  # ifdef ALLOW_GMREDI
103  #  include "GMREDI.h"  #  include "GMREDI.h"
104  # endif  # endif
105    # ifdef ALLOW_EBM
106    #  include "EBM.h"
107    # endif
108  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
109    
110  C     !INPUT/OUTPUT PARAMETERS:  C     !INPUT/OUTPUT PARAMETERS:
# Line 111  C     myThid - Thread number for this in Line 116  C     myThid - Thread number for this in
116        INTEGER myIter        INTEGER myIter
117        INTEGER myThid        INTEGER myThid
118    
119    #ifdef ALLOW_GENERIC_ADVDIFF
120  C     !LOCAL VARIABLES:  C     !LOCAL VARIABLES:
121  C     == Local variables  C     == Local variables
122  C     xA, yA                 - Per block temporaries holding face areas  C     xA, yA                 - Per block temporaries holding face areas
# Line 119  C                              transport Line 125  C                              transport
125  C                              o uTrans: Zonal transport  C                              o uTrans: Zonal transport
126  C                              o vTrans: Meridional transport  C                              o vTrans: Meridional transport
127  C                              o rTrans: Vertical transport  C                              o rTrans: Vertical transport
128    C     rTransKp1                o vertical volume transp. at interface k+1
129  C     maskUp                   o maskUp: land/water mask for W points  C     maskUp                   o maskUp: land/water mask for W points
130  C     fVer[STUV]               o fVer: Vertical flux term - note fVer  C     fVer[STUV]               o fVer: Vertical flux term - note fVer
131  C                                      is "pipelined" in the vertical  C                                      is "pipelined" in the vertical
132  C                                      so we need an fVer for each  C                                      so we need an fVer for each
133  C                                      variable.  C                                      variable.
134  C     rhoK, rhoKM1   - Density at current level, and level above  C     kappaRT,       - Total diffusion in vertical at level k, for T and S
135  C     phiSurfX, - gradient of Surface potentiel (Pressure/rho, ocean)  C     kappaRS          (background + spatially varying, isopycnal term).
136  C     phiSurfY             or geopotentiel (atmos) in X and Y direction  C     kappaRTr       - Total diffusion in vertical at level k,
137  C     KappaRT,       - Total diffusion in vertical for T and S.  C                      for each passive Tracer
138  C     KappaRS          (background + spatially varying, isopycnal term).  C     kappaRk        - Total diffusion in vertical, all levels, 1 tracer  
139  C     useVariableK   = T when vertical diffusion is not constant  C     useVariableK   = T when vertical diffusion is not constant
140  C     iMin, iMax     - Ranges and sub-block indices on which calculations  C     iMin, iMax     - Ranges and sub-block indices on which calculations
141  C     jMin, jMax       are applied.  C     jMin, jMax       are applied.
# Line 141  C                      index into fVerTe Line 148  C                      index into fVerTe
148        _RL uTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL uTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
149        _RL vTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
150        _RL rTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL rTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
151          _RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
152        _RS maskUp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS maskUp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
153        _RL fVerT   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerT   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
154        _RL fVerS   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerS   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
155        _RL fVerTr1 (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL kappaRT (1-Olx:sNx+Olx,1-Oly:sNy+Oly)
156        _RL rhokm1  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL kappaRS (1-Olx:sNx+Olx,1-Oly:sNy+Oly)
157        _RL rhok    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  #ifdef ALLOW_PTRACERS
158        _RL phiSurfX(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL fVerP   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2,PTRACERS_num)
159        _RL phiSurfY(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL kappaRTr(1-Olx:sNx+Olx,1-Oly:sNy+Oly,PTRACERS_num)
160        _RL KappaRT (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)  #endif
161        _RL KappaRS (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)        _RL kappaRk (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)  
       LOGICAL useVariableK  
162        INTEGER iMin, iMax        INTEGER iMin, iMax
163        INTEGER jMin, jMax        INTEGER jMin, jMax
164        INTEGER bi, bj        INTEGER bi, bj
165        INTEGER i, j        INTEGER i, j
166        INTEGER k, km1, kup, kDown        INTEGER k, km1, kup, kDown
167        INTEGER iTracer  #ifdef ALLOW_ADAMSBASHFORTH_3
168          INTEGER iterNb, m1, m2
169    #endif
170    #ifdef ALLOW_TIMEAVE
171          LOGICAL useVariableK
172    #endif
173    #ifdef ALLOW_PTRACERS
174          INTEGER iTracer, ip
175    #endif
176    
177  CEOP  CEOP
178    
179  #ifndef DISABLE_DEBUGMODE  #ifdef ALLOW_DEBUG
180           IF ( debugLevel .GE. debLevB )           IF ( debugLevel .GE. debLevB )
181       &    CALL DEBUG_ENTER('FORWARD_STEP',myThid)       &    CALL DEBUG_ENTER('THERMODYNAMICS',myThid)
182  #endif  #endif
183    
184  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
# Line 188  CHPF$ INDEPENDENT Line 198  CHPF$ INDEPENDENT
198  C--    HPF directive to help TAMC  C--    HPF directive to help TAMC
199  CHPF$  INDEPENDENT, NEW (rTrans,fVerT,fVerS  CHPF$  INDEPENDENT, NEW (rTrans,fVerT,fVerS
200  CHPF$&                  ,utrans,vtrans,xA,yA  CHPF$&                  ,utrans,vtrans,xA,yA
201  CHPF$&                  ,KappaRT,KappaRS  CHPF$&                  ,kappaRT,kappaRS
202  CHPF$&                  )  CHPF$&                  )
203  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
204    
# Line 219  C     uninitialised but inert locations. Line 229  C     uninitialised but inert locations.
229            yA(i,j)        = 0. _d 0            yA(i,j)        = 0. _d 0
230            uTrans(i,j)    = 0. _d 0            uTrans(i,j)    = 0. _d 0
231            vTrans(i,j)    = 0. _d 0            vTrans(i,j)    = 0. _d 0
           rhok   (i,j)   = 0. _d 0  
           rhoKM1 (i,j)   = 0. _d 0  
           phiSurfX(i,j)  = 0. _d 0  
           phiSurfY(i,j)  = 0. _d 0  
232            rTrans (i,j)   = 0. _d 0            rTrans (i,j)   = 0. _d 0
233              rTransKp1(i,j) = 0. _d 0
234            fVerT  (i,j,1) = 0. _d 0            fVerT  (i,j,1) = 0. _d 0
235            fVerT  (i,j,2) = 0. _d 0            fVerT  (i,j,2) = 0. _d 0
236            fVerS  (i,j,1) = 0. _d 0            fVerS  (i,j,1) = 0. _d 0
237            fVerS  (i,j,2) = 0. _d 0            fVerS  (i,j,2) = 0. _d 0
238            fVerTr1(i,j,1) = 0. _d 0            kappaRT(i,j)   = 0. _d 0
239            fVerTr1(i,j,2) = 0. _d 0            kappaRS(i,j)   = 0. _d 0
240           ENDDO           ENDDO
241          ENDDO          ENDDO
242    
# Line 237  C     uninitialised but inert locations. Line 244  C     uninitialised but inert locations.
244           DO j=1-OLy,sNy+OLy           DO j=1-OLy,sNy+OLy
245            DO i=1-OLx,sNx+OLx            DO i=1-OLx,sNx+OLx
246  C This is currently also used by IVDC and Diagnostics  C This is currently also used by IVDC and Diagnostics
247             sigmaX(i,j,k) = 0. _d 0             kappaRk(i,j,k)    = 0. _d 0
            sigmaY(i,j,k) = 0. _d 0  
            sigmaR(i,j,k) = 0. _d 0  
            ConvectCount(i,j,k) = 0.  
            KappaRT(i,j,k)    = 0. _d 0  
            KappaRS(i,j,k)    = 0. _d 0  
248  C- tracer tendency needs to be set to zero (moved here from gad_calc_rhs):  C- tracer tendency needs to be set to zero (moved here from gad_calc_rhs):
249             gT(i,j,k,bi,bj)   = 0. _d 0             gT(i,j,k,bi,bj)   = 0. _d 0
250             gS(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  
 # ifdef ALLOW_PTRACERS  
            DO iTracer=1,PTRACERS_numInUse  
             gPTr(i,j,k,bi,bj,itracer) = 0. _d 0  
            ENDDO  
 # endif  
 #ifdef ALLOW_AUTODIFF_TAMC  
 cph all the following init. are necessary for TAF  
 cph although some of these are re-initialised later.  
 # ifdef ALLOW_GMREDI  
            Kwx(i,j,k,bi,bj)  = 0. _d 0  
            Kwy(i,j,k,bi,bj)  = 0. _d 0  
            Kwz(i,j,k,bi,bj)  = 0. _d 0  
 #  ifdef GM_NON_UNITY_DIAGONAL  
            Kux(i,j,k,bi,bj)  = 0. _d 0  
            Kvy(i,j,k,bi,bj)  = 0. _d 0  
 #  endif  
 #  ifdef GM_EXTRA_DIAGONAL  
            Kuz(i,j,k,bi,bj)  = 0. _d 0  
            Kvz(i,j,k,bi,bj)  = 0. _d 0  
 #  endif  
 #  ifdef GM_BOLUS_ADVEC  
            GM_PsiX(i,j,k,bi,bj)  = 0. _d 0  
            GM_PsiY(i,j,k,bi,bj)  = 0. _d 0  
 #  endif  
 #  ifdef GM_VISBECK_VARIABLE_K  
            VisbeckK(i,j,bi,bj)   = 0. _d 0  
 #  endif  
 # endif /* ALLOW_GMREDI */  
 #endif /* ALLOW_AUTODIFF_TAMC */  
251            ENDDO            ENDDO
252           ENDDO           ENDDO
253          ENDDO          ENDDO
254    
255          iMin = 1-OLx  #ifdef ALLOW_PTRACERS
256          iMax = sNx+OLx          IF ( usePTRACERS ) THEN
257          jMin = 1-OLy           DO ip=1,PTRACERS_num
258          jMax = sNy+OLy             DO j=1-OLy,sNy+OLy
259                DO i=1-OLx,sNx+OLx
260  #ifdef ALLOW_AUTODIFF_TAMC               fVerP  (i,j,1,ip) = 0. _d 0
261  CADJ STORE theta(:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte               fVerP  (i,j,2,ip) = 0. _d 0
262  CADJ STORE salt (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte               kappaRTr(i,j,ip)  = 0. _d 0
263  CADJ STORE totphihyd              ENDDO
264  CADJ &     = comlev1_bibj, key=itdkey, byte=isbyte             ENDDO
265  #ifdef ALLOW_KPP           ENDDO
266  CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte  C-      set tracer tendency to zero:
267  CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte           DO iTracer=1,PTRACERS_numInUse
268  #endif            DO k=1,Nr
269  #endif /* ALLOW_AUTODIFF_TAMC */             DO j=1-OLy,sNy+OLy
270                DO i=1-OLx,sNx+OLx
271  #ifndef DISABLE_DEBUGMODE               gPTr(i,j,k,bi,bj,itracer) = 0. _d 0
272          IF ( debugLevel .GE. debLevB )              ENDDO
273       &    CALL DEBUG_MSG('ENTERING UPWARD K LOOP',myThid)             ENDDO
274              ENDDO
275             ENDDO
276            ENDIF
277  #endif  #endif
278    
279  C--     Start of diagnostic loop  #ifdef ALLOW_ADAMSBASHFORTH_3
280          DO k=Nr,1,-1  C-      Apply AB on T,S :
281            iterNb = myIter
282  #ifdef ALLOW_AUTODIFF_TAMC          IF (staggerTimeStep) iterNb = myIter - 1
283  C? Patrick, is this formula correct now that we change the loop range?          m1 = 1 + MOD(iterNb+1,2)
284  C? Do we still need this?          m2 = 1 + MOD( iterNb ,2)
285  cph kkey formula corrected.  C       compute T^n+1/2 (stored in gtNm) extrapolating T forward in time
286  cph Needed for rhok, rhokm1, in the case useGMREDI.          IF ( AdamsBashforth_T ) CALL ADAMS_BASHFORTH3(
287           kkey = (itdkey-1)*Nr + k       I                                  bi, bj, 0,
288  #endif /* ALLOW_AUTODIFF_TAMC */       U                                  theta, gtNm,
289         I                                  tempStartAB, iterNb, myThid )
290  C--       Integrate continuity vertically for vertical velocity  C       compute S^n+1/2 (stored in gsNm) extrapolating S forward in time
291  c         CALL INTEGRATE_FOR_W(          IF ( AdamsBashforth_S ) CALL ADAMS_BASHFORTH3(
292  c    I                         bi, bj, k, uVel, vVel,       I                                  bi, bj, 0,
293  c    O                         wVel,       U                                  salt, gsNm,
294  c    I                         myThid )       I                                  saltStartAB, iterNb, myThid )
295    #endif /* ALLOW_ADAMSBASHFORTH_3 */
296  #ifdef    ALLOW_OBCS  
297  #ifdef    ALLOW_NONHYDROSTATIC  c       iMin = 1-OLx
298  C--       Apply OBC to W if in N-H mode  c       iMax = sNx+OLx
299  c         IF (useOBCS.AND.nonHydrostatic) THEN  c       jMin = 1-OLy
300  c           CALL OBCS_APPLY_W( bi, bj, k, wVel, myThid )  c       jMax = sNy+OLy
 c         ENDIF  
 #endif    /* ALLOW_NONHYDROSTATIC */  
 #endif    /* ALLOW_OBCS */  
   
 C--       Attention: by defining "SINGLE_LAYER_MODE" in CPP_OPTIONS.h  
 C--       MOST of THERMODYNAMICS will be disabled  
 #ifndef SINGLE_LAYER_MODE  
   
 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  
 #ifndef DISABLE_DEBUGMODE  
             IF ( debugLevel .GE. debLevB )  
      &       CALL DEBUG_CALL('FIND_RHO',myThid)  
 #endif  
 #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,  
      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,  
      I        theta, salt,  
      O        rhoKm1,  
      I        myThid )  
             ENDIF  
 #ifndef DISABLE_DEBUGMODE  
             IF ( debugLevel .GE. debLevB )  
      &       CALL DEBUG_CALL('GRAD_SIGMA',myThid)  
 #endif  
             CALL GRAD_SIGMA(  
      I             bi, bj, iMin, iMax, jMin, jMax, k,  
      I             rhoK, rhoKm1, rhoK,  
      O             sigmaX, sigmaY, sigmaR,  
      I             myThid )  
           ENDIF  
   
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE rhok   (:,:) = comlev1_bibj_k ,       key=kkey, byte=isbyte  
 CADJ STORE rhokm1 (:,:) = comlev1_bibj_k ,       key=kkey, byte=isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
 C--       Implicit Vertical Diffusion for Convection  
 c ==> should use sigmaR !!!  
           IF (k.GT.1 .AND. ivdc_kappa.NE.0.) THEN  
 #ifndef DISABLE_DEBUGMODE  
             IF ( debugLevel .GE. debLevB )  
      &       CALL DEBUG_CALL('CALC_IVDC',myThid)  
 #endif  
             CALL CALC_IVDC(  
      I        bi, bj, iMin, iMax, jMin, jMax, k,  
      I        rhoKm1, rhoK,  
      U        ConvectCount, KappaRT, KappaRS,  
      I        myTime, myIter, myThid)  
           ENDIF  
   
 #endif /* SINGLE_LAYER_MODE */  
   
 C--     end of diagnostic k loop (Nr:1)  
         ENDDO  
301    
302  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
303  cph avoids recomputation of integrate_for_w  cph avoids recomputation of integrate_for_w
304  CADJ STORE wvel (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte  CADJ STORE wvel (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte
305  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
306    
 #ifdef  ALLOW_OBCS  
 C--     Calculate future values on open boundaries  
         IF (useOBCS) THEN  
 #ifndef DISABLE_DEBUGMODE  
           IF ( debugLevel .GE. debLevB )  
      &     CALL DEBUG_CALL('OBCS_CALC',myThid)  
 #endif  
           CALL OBCS_CALC( bi, bj, myTime+deltaT, myIter+1,  
      I            uVel, vVel, wVel, theta, salt,  
      I            myThid )  
         ENDIF  
 #endif  /* ALLOW_OBCS */  
   
   
 #ifdef ALLOW_THERM_SEAICE  
        IF (useThermSeaIce) THEN  
 #ifndef DISABLE_DEBUGMODE  
         IF ( debugLevel .GE. debLevB )  
      &    CALL DEBUG_CALL('ICE_FORCING',myThid)  
 #endif  
 C--     Determines forcing terms based on external fields  
 C       including effects from ice  
         CALL ICE_FORCING(  
      I             bi, bj, iMin, iMax, jMin, jMax,  
      I             myThid )  
        ELSE  
 #endif /* ALLOW_THERM_SEAICE */  
   
 C--     Determines forcing terms based on external fields  
 C       relaxation terms, etc.  
 #ifndef DISABLE_DEBUGMODE  
         IF ( debugLevel .GE. debLevB )  
      &    CALL DEBUG_CALL('EXTERNAL_FORCING_SURF',myThid)  
 #endif  
         CALL EXTERNAL_FORCING_SURF(  
      I             bi, bj, iMin, iMax, jMin, jMax,  
      I             myTime, myIter, myThid )  
   
 #ifdef ALLOW_THERM_SEAICE  
 C--    end of if/else block useThermSeaIce --  
        ENDIF  
 #endif /* ALLOW_THERM_SEAICE */  
   
 #ifdef ALLOW_AUTODIFF_TAMC  
 cph needed for KPP  
 CADJ STORE surfacetendencyU(:,:,bi,bj)  
 CADJ &     = comlev1_bibj, key=itdkey, byte=isbyte  
 CADJ STORE surfacetendencyV(:,:,bi,bj)  
 CADJ &     = comlev1_bibj, key=itdkey, byte=isbyte  
 CADJ STORE surfacetendencyS(:,:,bi,bj)  
 CADJ &     = comlev1_bibj, key=itdkey, byte=isbyte  
 CADJ STORE surfacetendencyT(:,:,bi,bj)  
 CADJ &     = comlev1_bibj, key=itdkey, byte=isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
   
307  C--     Attention: by defining "SINGLE_LAYER_MODE" in CPP_OPTIONS.h  C--     Attention: by defining "SINGLE_LAYER_MODE" in CPP_OPTIONS.h
308  C--     MOST of THERMODYNAMICS will be disabled  C--     MOST of THERMODYNAMICS will be disabled
309  #ifndef SINGLE_LAYER_MODE  #ifndef SINGLE_LAYER_MODE
310    
 #ifdef  ALLOW_GMREDI  
   
 #ifdef ALLOW_AUTODIFF_TAMC  
 cph storing here is needed only for one GMREDI_OPTIONS:  
 cph define GM_BOLUS_ADVEC  
 cph but I've avoided the #ifdef for now, in case more things change  
 CADJ STORE sigmaX(:,:,:)        = comlev1_bibj, key=itdkey, byte=isbyte  
 CADJ STORE sigmaY(:,:,:)        = comlev1_bibj, key=itdkey, byte=isbyte  
 CADJ STORE sigmaR(:,:,:)        = comlev1_bibj, key=itdkey, byte=isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
   
 C--     Calculate iso-neutral slopes for the GM/Redi parameterisation  
         IF (useGMRedi) THEN  
 #ifndef DISABLE_DEBUGMODE  
           IF ( debugLevel .GE. debLevB )  
      &     CALL DEBUG_CALL('GMREDI_CALC_TENSOR',myThid)  
 #endif  
           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  
   
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE Kwx(:,:,:,bi,bj)   = comlev1_bibj, key=itdkey, byte=isbyte  
 CADJ STORE Kwy(:,:,:,bi,bj)   = comlev1_bibj, key=itdkey, byte=isbyte  
 CADJ STORE Kwz(:,:,:,bi,bj)   = comlev1_bibj, key=itdkey, byte=isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
   
 #endif  /* ALLOW_GMREDI */  
   
 #ifdef  ALLOW_KPP  
 C--     Compute KPP mixing coefficients  
         IF (useKPP) THEN  
 #ifndef DISABLE_DEBUGMODE  
           IF ( debugLevel .GE. debLevB )  
      &     CALL DEBUG_CALL('KPP_CALC',myThid)  
 #endif  
           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  
   
311  #ifdef ALLOW_AUTODIFF_TAMC  #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=itdkey, byte=isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
   
 #endif  /* ALLOW_KPP */  
   
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE KappaRT(:,:,:)     = comlev1_bibj, key=itdkey, byte=isbyte  
 CADJ STORE KappaRS(:,:,:)     = comlev1_bibj, key=itdkey, byte=isbyte  
312  CADJ STORE theta(:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte  CADJ STORE theta(:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte
313  CADJ STORE salt (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte  CADJ STORE salt (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte
314  CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte  CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte
315  CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte  CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte
316  #ifdef ALLOW_PASSIVE_TRACER  # ifdef NONLIN_FRSURF
317  CADJ STORE tr1  (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte  cph-test
318  #endif  CADJ STORE gtnm1(:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte
319    CADJ STORE gsnm1(:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte
320    # endif
321  #ifdef ALLOW_PTRACERS  #ifdef ALLOW_PTRACERS
322  cph-- moved to forward_step to avoid key computation  cph-- moved to forward_step to avoid key computation
323  cphCADJ STORE ptracer(:,:,:,bi,bj,itracer) = comlev1_bibj,  cphCADJ STORE ptracer(:,:,:,bi,bj,itracer) = comlev1_bibj,
# Line 541  cphCADJ &                              k Line 325  cphCADJ &                              k
325  #endif  #endif
326  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
327    
 #ifdef ALLOW_AIM  
 C       AIM - atmospheric intermediate model, physics package code.  
         IF ( useAIM ) THEN  
 #ifndef DISABLE_DEBUGMODE  
           IF ( debugLevel .GE. debLevB )  
      &     CALL DEBUG_CALL('AIM_DO_PHYSICS',myThid)  
 #endif  
          CALL TIMER_START('AIM_DO_PHYSICS   [THERMODYNAMICS]', myThid)  
          CALL AIM_DO_PHYSICS( bi, bj, myTime, myIter, myThid )  
          CALL TIMER_STOP( 'AIM_DO_PHYSICS   [THERMODYNAMICS]', myThid)  
         ENDIF  
 #endif /* ALLOW_AIM */  
   
328  #ifndef DISABLE_MULTIDIM_ADVECTION  #ifndef DISABLE_MULTIDIM_ADVECTION
329  C--     Some advection schemes are better calculated using a multi-dimensional  C--     Some advection schemes are better calculated using a multi-dimensional
330  C       method in the absence of any other terms and, if used, is done here.  C       method in the absence of any other terms and, if used, is done here.
# Line 565  C to be able to exclude this scheme to a Line 336  C to be able to exclude this scheme to a
336  C recomputation. It *is* differentiable, if you need it.  C recomputation. It *is* differentiable, if you need it.
337  C Edit GAD_OPTIONS.h and #define DISABLE_MULTIDIM_ADVECTION to  C Edit GAD_OPTIONS.h and #define DISABLE_MULTIDIM_ADVECTION to
338  C disable this section of code.  C disable this section of code.
339    #ifndef ALLOW_OFFLINE
340          IF (tempMultiDimAdvec) THEN          IF (tempMultiDimAdvec) THEN
341  #ifndef DISABLE_DEBUGMODE  #ifdef ALLOW_DEBUG
342            IF ( debugLevel .GE. debLevB )            IF ( debugLevel .GE. debLevB )
343       &     CALL DEBUG_CALL('GAD_ADVECTION',myThid)       &     CALL DEBUG_CALL('GAD_ADVECTION',myThid)
344  #endif  #endif
345            CALL GAD_ADVECTION(bi,bj,tempAdvScheme,GAD_TEMPERATURE,            CALL GAD_ADVECTION(
346       U                      theta,gT,       I             tempImplVertAdv, tempAdvScheme, tempVertAdvScheme,
347       I                      myTime,myIter,myThid)       I             GAD_TEMPERATURE,
348         I             uVel, vVel, wVel, theta,
349         O             gT,
350         I             bi,bj,myTime,myIter,myThid)
351          ENDIF          ENDIF
352    #endif
353    #ifndef ALLOW_OFFLINE
354          IF (saltMultiDimAdvec) THEN          IF (saltMultiDimAdvec) THEN
355  #ifndef DISABLE_DEBUGMODE  #ifdef ALLOW_DEBUG
356            IF ( debugLevel .GE. debLevB )            IF ( debugLevel .GE. debLevB )
357       &     CALL DEBUG_CALL('GAD_ADVECTION',myThid)       &     CALL DEBUG_CALL('GAD_ADVECTION',myThid)
358  #endif  #endif
359            CALL GAD_ADVECTION(bi,bj,saltAdvScheme,GAD_SALINITY,            CALL GAD_ADVECTION(
360       U                      salt,gS,       I             saltImplVertAdv, saltAdvScheme, saltVertAdvScheme,
361       I                      myTime,myIter,myThid)       I             GAD_SALINITY,
362         I             uVel, vVel, wVel, salt,
363         O             gS,
364         I             bi,bj,myTime,myIter,myThid)
365          ENDIF          ENDIF
366    #endif
367  C Since passive tracers are configurable separately from T,S we  C Since passive tracers are configurable separately from T,S we
368  C call the multi-dimensional method for PTRACERS regardless  C call the multi-dimensional method for PTRACERS regardless
369  C of whether multiDimAdvection is set or not.  C of whether multiDimAdvection is set or not.
370  #ifdef ALLOW_PTRACERS  #ifdef ALLOW_PTRACERS
371          IF ( usePTRACERS ) THEN          IF ( usePTRACERS ) THEN
372  #ifndef DISABLE_DEBUGMODE  #ifdef ALLOW_DEBUG
373            IF ( debugLevel .GE. debLevB )            IF ( debugLevel .GE. debLevB )
374       &     CALL DEBUG_CALL('PTRACERS_ADVECTION',myThid)       &     CALL DEBUG_CALL('PTRACERS_ADVECTION',myThid)
375  #endif  #endif
# Line 597  C of whether multiDimAdvection is set or Line 378  C of whether multiDimAdvection is set or
378  #endif /* ALLOW_PTRACERS */  #endif /* ALLOW_PTRACERS */
379  #endif /* DISABLE_MULTIDIM_ADVECTION */  #endif /* DISABLE_MULTIDIM_ADVECTION */
380    
381  #ifndef DISABLE_DEBUGMODE  #ifdef ALLOW_DEBUG
382         IF ( debugLevel .GE. debLevB )          IF ( debugLevel .GE. debLevB )
383       &    CALL DEBUG_MSG('ENTERING DOWNWARD K LOOP',myThid)       &    CALL DEBUG_MSG('ENTERING DOWNWARD K LOOP',myThid)
384  #endif  #endif
385    
# Line 607  C--     Start of thermodynamics loop Line 388  C--     Start of thermodynamics loop
388  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
389  C? Patrick Is this formula correct?  C? Patrick Is this formula correct?
390  cph Yes, but I rewrote it.  cph Yes, but I rewrote it.
391  cph Also, the KappaR? need the index and subscript k!  cph Also, the kappaR? need the index and subscript k!
392           kkey = (itdkey-1)*Nr + k           kkey = (itdkey-1)*Nr + k
393  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
394    
# Line 624  C--       kDown  Cycles through 2,1 to p Line 405  C--       kDown  Cycles through 2,1 to p
405            jMin = 1-OLy            jMin = 1-OLy
406            jMax = sNy+OLy            jMax = sNy+OLy
407    
408              IF (k.EQ.Nr) THEN
409               DO j=1-Oly,sNy+Oly
410                DO i=1-Olx,sNx+Olx
411                 rTransKp1(i,j) = 0. _d 0
412                ENDDO
413               ENDDO
414              ELSE
415               DO j=1-Oly,sNy+Oly
416                DO i=1-Olx,sNx+Olx
417                 rTransKp1(i,j) = rTrans(i,j)
418                ENDDO
419               ENDDO
420              ENDIF
421    #ifdef ALLOW_AUTODIFF_TAMC
422    CADJ STORE rTransKp1(:,:) = comlev1_bibj_k, key=kkey, byte=isbyte
423    #endif
424    
425  C--       Get temporary terms used by tendency routines  C--       Get temporary terms used by tendency routines
426            CALL CALC_COMMON_FACTORS (            CALL CALC_COMMON_FACTORS (
427       I         bi,bj,iMin,iMax,jMin,jMax,k,       I         bi,bj,iMin,iMax,jMin,jMax,k,
428       O         xA,yA,uTrans,vTrans,rTrans,maskUp,       O         xA,yA,uTrans,vTrans,rTrans,maskUp,
429       I         myThid)       I         myThid)
430    
431              IF (k.EQ.1) THEN
432    C- Surface interface :
433               DO j=1-Oly,sNy+Oly
434                DO i=1-Olx,sNx+Olx
435                 rTrans(i,j) = 0.
436                ENDDO
437               ENDDO
438              ELSE
439    C- Interior interface :
440               DO j=1-Oly,sNy+Oly
441                DO i=1-Olx,sNx+Olx
442                 rTrans(i,j) = rTrans(i,j)*maskC(i,j,k-1,bi,bj)
443                ENDDO
444               ENDDO
445              ENDIF
446    
447  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
448    
449  C--   Residual transp = Bolus transp + Eulerian transp  C--   Residual transp = Bolus transp + Eulerian transp
# Line 640  C--   Residual transp = Bolus transp + E Line 454  C--   Residual transp = Bolus transp + E
454       &                    rTrans, bi, bj, k, myThid)       &                    rTrans, bi, bj, k, myThid)
455            ENDIF            ENDIF
456    
457  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
458    CADJ STORE rTrans(:,:)    = comlev1_bibj_k, key=kkey, byte=isbyte
459  #ifdef GM_BOLUS_ADVEC  #ifdef GM_BOLUS_ADVEC
460  CADJ STORE uTrans(:,:)    = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ STORE uTrans(:,:)    = comlev1_bibj_k, key=kkey, byte=isbyte
461  CADJ STORE vTrans(:,:)    = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ STORE vTrans(:,:)    = comlev1_bibj_k, key=kkey, byte=isbyte
 CADJ STORE rTrans(:,:)    = comlev1_bibj_k, key=kkey, byte=isbyte  
462  #endif  #endif
463  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
464    
465  #endif /* ALLOW_GMREDI */  #endif /* ALLOW_GMREDI */
466    
 #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 */  
   
467  #ifdef  INCLUDE_CALC_DIFFUSIVITY_CALL  #ifdef  INCLUDE_CALC_DIFFUSIVITY_CALL
468  C--      Calculate the total vertical diffusivity  C--      Calculate the total vertical diffusivity
469           CALL CALC_DIFFUSIVITY(            IF ( .NOT.implicitDiffusion ) THEN
470       I        bi,bj,iMin,iMax,jMin,jMax,k,              CALL CALC_DIFFUSIVITY(
471       I        maskUp,       I          bi,bj,iMin,iMax,jMin,jMax,k,
472       O        KappaRT,KappaRS,       I          maskUp,
473       I        myThid)       O          kappaRT,kappaRS,
474         I          myThid)
475              ENDIF
476    # ifdef ALLOW_AUTODIFF_TAMC
477    CADJ STORE kappaRT(:,:)    = comlev1_bibj_k, key=kkey, byte=isbyte
478    CADJ STORE kappaRS(:,:)    = comlev1_bibj_k, key=kkey, byte=isbyte
479    # endif /* ALLOW_AUTODIFF_TAMC */
480  #endif  #endif
481    
482            iMin = 1-OLx+2            iMin = 1-OLx+2
# Line 670  C--      Calculate the total vertical di Line 485  C--      Calculate the total vertical di
485            jMax = sNy+OLy-1            jMax = sNy+OLy-1
486    
487  C--      Calculate active tracer tendencies (gT,gS,...)  C--      Calculate active tracer tendencies (gT,gS,...)
488  C        and step forward storing result in gTnm1, gSnm1, etc.  C        and step forward storing result in gT, gS, etc.
489    #ifndef ALLOW_OFFLINE
490           IF ( tempStepping ) THEN           IF ( tempStepping ) THEN
491    #ifdef NONLIN_FRSURF
492    # ifdef ALLOW_AUTODIFF_TAMC
493    cph-test
494    CADJ STORE gT(:,:,k,bi,bj)    = comlev1_bibj_k, key=kkey, byte=isbyte
495    # endif /* ALLOW_AUTODIFF_TAMC */
496    #endif
497             CALL CALC_GT(             CALL CALC_GT(
498       I         bi,bj,iMin,iMax,jMin,jMax, k,km1,kup,kDown,       I         bi,bj,iMin,iMax,jMin,jMax, k,km1,kup,kDown,
499       I         xA,yA,uTrans,vTrans,rTrans,maskUp,       I         xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp,
500       I         KappaRT,       I         kappaRT,
501       U         fVerT,       U         fVerT,
502       I         myTime,myIter,myThid)       I         myTime,myIter,myThid)
503    #ifdef ALLOW_ADAMSBASHFORTH_3
504              IF ( AdamsBashforth_T ) THEN
505             CALL TIMESTEP_TRACER(             CALL TIMESTEP_TRACER(
506       I         bi,bj,iMin,iMax,jMin,jMax,k,tempAdvScheme,       I         bi,bj,iMin,iMax,jMin,jMax,k,tempAdvScheme,
507       I         theta, gT,       I         gtNm(1-Olx,1-Oly,1,1,1,m2),
508         U         gT,
509       I         myIter, myThid)       I         myIter, myThid)
510           ENDIF            ELSE
511    #endif
512  #ifdef ALLOW_THERM_SEAICE             CALL TIMESTEP_TRACER(
513           IF (useThermSeaIce .AND. k.EQ.1) THEN       I         bi,bj,iMin,iMax,jMin,jMax,k,tempAdvScheme,
514             CALL ICE_FREEZE( bi,bj, iMin,iMax,jMin,jMax, myThid )       I         theta,
515         U         gT,
516         I         myIter, myThid)
517    #ifdef ALLOW_ADAMSBASHFORTH_3
518              ENDIF
519    #endif
520           ENDIF           ENDIF
521  #endif  #endif
522    
523    #ifndef ALLOW_OFFLINE
524           IF ( saltStepping ) THEN           IF ( saltStepping ) THEN
525    #ifdef NONLIN_FRSURF
526    # ifdef ALLOW_AUTODIFF_TAMC
527    cph-test
528    CADJ STORE gS(:,:,k,bi,bj)    = comlev1_bibj_k, key=kkey, byte=isbyte
529    # endif /* ALLOW_AUTODIFF_TAMC */
530    #endif
531             CALL CALC_GS(             CALL CALC_GS(
532       I         bi,bj,iMin,iMax,jMin,jMax, k,km1,kup,kDown,       I         bi,bj,iMin,iMax,jMin,jMax, k,km1,kup,kDown,
533       I         xA,yA,uTrans,vTrans,rTrans,maskUp,       I         xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp,
534       I         KappaRS,       I         kappaRS,
535       U         fVerS,       U         fVerS,
536       I         myTime,myIter,myThid)       I         myTime,myIter,myThid)
537    #ifdef ALLOW_ADAMSBASHFORTH_3
538              IF ( AdamsBashforth_S ) THEN
539             CALL TIMESTEP_TRACER(             CALL TIMESTEP_TRACER(
540       I         bi,bj,iMin,iMax,jMin,jMax,k,saltAdvScheme,       I         bi,bj,iMin,iMax,jMin,jMax,k,saltAdvScheme,
541       I         salt, gS,       I         gsNm(1-Olx,1-Oly,1,1,1,m2),
542         U         gS,
543       I         myIter, myThid)       I         myIter, myThid)
544           ENDIF            ELSE
545  #ifdef ALLOW_PASSIVE_TRACER  #endif
          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)  
546             CALL TIMESTEP_TRACER(             CALL TIMESTEP_TRACER(
547       I         bi,bj,iMin,iMax,jMin,jMax,k,tracerAdvScheme,       I         bi,bj,iMin,iMax,jMin,jMax,k,saltAdvScheme,
548       I         Tr1, gTr1,       I         salt,
549       I         myIter,myThid)       U         gS,
550         I         myIter, myThid)
551    #ifdef ALLOW_ADAMSBASHFORTH_3
552              ENDIF
553    #endif
554           ENDIF           ENDIF
555  #endif  #endif
556  #ifdef ALLOW_PTRACERS  #ifdef ALLOW_PTRACERS
557           IF ( usePTRACERS ) THEN           IF ( usePTRACERS ) THEN
558               IF ( .NOT.implicitDiffusion ) THEN
559                 CALL PTRACERS_CALC_DIFF(
560         I            bi,bj,iMin,iMax,jMin,jMax,k,
561         I            maskUp,
562         O            kappaRTr,
563         I            myThid)
564               ENDIF
565    # ifdef ALLOW_AUTODIFF_TAMC
566    CADJ STORE kappaRTr(:,:,:)    = comlev1_bibj_k, key=kkey, byte=isbyte
567    # endif /* ALLOW_AUTODIFF_TAMC */
568             CALL PTRACERS_INTEGRATE(             CALL PTRACERS_INTEGRATE(
569       I         bi,bj,k,       I         bi,bj,k,
570       I         xA,yA,uTrans,vTrans,rTrans,maskUp,       I         xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp,
571       X         KappaRS,       U         fVerP,
572         I         kappaRTr,
573       I         myIter,myTime,myThid)       I         myIter,myTime,myThid)
574           ENDIF           ENDIF
575  #endif /* ALLOW_PTRACERS */  #endif /* ALLOW_PTRACERS */
# Line 734  C--      Apply open boundary conditions Line 582  C--      Apply open boundary conditions
582  #endif   /* ALLOW_OBCS */  #endif   /* ALLOW_OBCS */
583    
584  C--      Freeze water  C--      Freeze water
585           IF ( allowFreezing .AND. .NOT. useSEAICE  C  this bit of code is left here for backward compatibility.
586       &       .AND. .NOT.(useThermSeaIce.AND.k.EQ.1) ) THEN  C  freezing at surface level has been moved to FORWARD_STEP
587    #ifndef ALLOW_OFFLINE
588             IF ( useOldFreezing .AND. .NOT. useSEAICE
589         &       .AND. .NOT.(useThSIce.AND.k.EQ.1) ) THEN
590  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
591  CADJ STORE gT(:,:,k,bi,bj) = comlev1_bibj_k  CADJ STORE gT(:,:,k,bi,bj) = comlev1_bibj_k
592  CADJ &   , key = kkey, byte = isbyte  CADJ &   , key = kkey, byte = isbyte
593  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
594              CALL FREEZE( bi, bj, iMin, iMax, jMin, jMax, k, myThid )              CALL FREEZE( bi, bj, iMin, iMax, jMin, jMax, k, myThid )
595           ENDIF           ENDIF
596    #endif
597    
598  C--     end of thermodynamic k loop (Nr:1)  C--     end of thermodynamic k loop (Nr:1)
599          ENDDO          ENDDO
600    
601  cswdice -- add ---  C       All explicit advection/diffusion/sources should now be
602  #ifdef ALLOW_THERM_SEAICE  C       done. The updated tracer field is in gPtr. Accumalate
603  c timeaveraging for ice model values  C       explicit tendency and also reset gPtr to initial tracer
604             CALL ICE_AVE(bi,bj,iMin,iMax,jMin,jMax,myThid )  C       field for implicit matrix calculation
605  #endif  
606  cswdice --- end add ---  #ifdef ALLOW_MATRIX
607            IF (useMATRIX)
608         &    CALL MATRIX_STORE_TENDENCY_EXP(bi,bj, myTime,myIter,myThid)
609    #endif
610    
611  C--     Implicit diffusion          iMin = 1
612          IF (implicitDiffusion) THEN          iMax = sNx
613            jMin = 1
614           IF (tempStepping) THEN          jMax = sNy
615    
616    C--     Implicit vertical advection & diffusion
617    #ifndef ALLOW_OFFLINE
618            IF ( tempStepping .AND. implicitDiffusion ) THEN
619              CALL CALC_3D_DIFFUSIVITY(
620         I         bi,bj,iMin,iMax,jMin,jMax,
621         I         GAD_TEMPERATURE, useGMredi, useKPP,
622         O         kappaRk,
623         I         myThid)
624            ENDIF
625    #ifdef INCLUDE_IMPLVERTADV_CODE
626            IF ( tempImplVertAdv ) THEN
627              CALL GAD_IMPLICIT_R(
628         I         tempImplVertAdv, tempAdvScheme, GAD_TEMPERATURE,
629         I         kappaRk, wVel, theta,
630         U         gT,
631         I         bi, bj, myTime, myIter, myThid )
632            ELSEIF ( tempStepping .AND. implicitDiffusion ) THEN
633    #else /* INCLUDE_IMPLVERTADV_CODE */
634            IF     ( tempStepping .AND. implicitDiffusion ) THEN
635    #endif /* INCLUDE_IMPLVERTADV_CODE */
636  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
637    CADJ STORE kappaRk(:,:,:) = comlev1_bibj , key=itdkey, byte=isbyte
638  CADJ STORE gT(:,:,:,bi,bj) = comlev1_bibj , key=itdkey, byte=isbyte  CADJ STORE gT(:,:,:,bi,bj) = comlev1_bibj , key=itdkey, byte=isbyte
639  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
640              CALL IMPLDIFF(            CALL IMPLDIFF(
641       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
642       I         deltaTtracer, KappaRT, recip_HFacC,       I         GAD_TEMPERATURE, kappaRk, recip_hFacC,
643       U         gT,       U         gT,
644       I         myThid )       I         myThid )
645            ENDIF
646    #endif /* ndef ALLOW_OFFLINE */
647    
648    #ifdef ALLOW_TIMEAVE
649            useVariableK = useKPP .OR. usePP81 .OR. useMY82 .OR. useGGL90
650         &       .OR. useGMredi .OR. ivdc_kappa.NE.0.
651            IF (taveFreq.GT.0. .AND. useVariableK ) THEN
652             IF (implicitDiffusion) THEN
653               CALL TIMEAVE_CUMUL_DIF_1T(TdiffRtave, gT, kappaRk,
654         I                        Nr, 3, deltaTclock, bi, bj, myThid)
655    c        ELSE
656    c          CALL TIMEAVE_CUMUL_DIF_1T(TdiffRtave, theta, kappaRT,
657    c    I                        Nr, 3, deltaTclock, bi, bj, myThid)
658           ENDIF           ENDIF
659            ENDIF
660    #endif /* ALLOW_TIMEAVE */
661    
662    #ifndef ALLOW_OFFLINE
663            IF ( saltStepping .AND. implicitDiffusion ) THEN
664              CALL CALC_3D_DIFFUSIVITY(
665         I         bi,bj,iMin,iMax,jMin,jMax,
666         I         GAD_SALINITY, useGMredi, useKPP,
667         O         kappaRk,
668         I         myThid)
669            ENDIF
670    
671           IF (saltStepping) THEN  #ifdef INCLUDE_IMPLVERTADV_CODE
672            IF ( saltImplVertAdv ) THEN
673              CALL GAD_IMPLICIT_R(
674         I         saltImplVertAdv, saltAdvScheme, GAD_SALINITY,
675         I         kappaRk, wVel, salt,
676         U         gS,
677         I         bi, bj, myTime, myIter, myThid )
678            ELSEIF ( saltStepping .AND. implicitDiffusion ) THEN
679    #else /* INCLUDE_IMPLVERTADV_CODE */
680            IF     ( saltStepping .AND. implicitDiffusion ) THEN
681    #endif /* INCLUDE_IMPLVERTADV_CODE */
682  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
683    CADJ STORE kappaRk(:,:,:) = comlev1_bibj , key=itdkey, byte=isbyte
684  CADJ STORE gS(:,:,:,bi,bj) = comlev1_bibj , key=itdkey, byte=isbyte  CADJ STORE gS(:,:,:,bi,bj) = comlev1_bibj , key=itdkey, byte=isbyte
685  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
686              CALL IMPLDIFF(            CALL IMPLDIFF(
687       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
688       I         deltaTtracer, KappaRS, recip_HFacC,       I         GAD_SALINITY, kappaRk, recip_hFacC,
689       U         gS,       U         gS,
690       I         myThid )       I         myThid )
691           ENDIF          ENDIF
   
 #ifdef ALLOW_PASSIVE_TRACER  
          IF (tr1Stepping) THEN  
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE gTr1(:,:,:,bi,bj) = comlev1_bibj , key=itdkey, 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  
692  #endif  #endif
693    
694  #ifdef ALLOW_PTRACERS  #ifdef ALLOW_PTRACERS
695  C Vertical diffusion (implicit) for passive tracers          IF     ( usePTRACERS ) THEN
696           IF ( usePTRACERS ) THEN  C--     Vertical advection/diffusion (implicit) for passive tracers
697             CALL PTRACERS_IMPLDIFF( bi,bj,KappaRS,myThid )             CALL PTRACERS_IMPLICIT(
698           ENDIF       U                             kappaRk,
699         I                             bi, bj, myTime, myIter, myThid )
700            ENDIF
701  #endif /* ALLOW_PTRACERS */  #endif /* ALLOW_PTRACERS */
702    
703  #ifdef   ALLOW_OBCS  #ifdef   ALLOW_OBCS
704  C--      Apply open boundary conditions  C--      Apply open boundary conditions
705           IF (useOBCS) THEN          IF ( ( implicitDiffusion
706         &    .OR. tempImplVertAdv
707         &    .OR. saltImplVertAdv
708         &       ) .AND. useOBCS     ) THEN
709             DO K=1,Nr             DO K=1,Nr
710               CALL OBCS_APPLY_TS( bi, bj, k, gT, gS, myThid )               CALL OBCS_APPLY_TS( bi, bj, k, gT, gS, myThid )
711             ENDDO             ENDDO
          END IF  
 #endif   /* ALLOW_OBCS */  
   
 C--     End If implicitDiffusion  
         ENDIF  
   
 #ifdef ALLOW_TIMEAVE  
         IF (taveFreq.GT.0. .AND. ivdc_kappa.NE.0.) THEN  
           CALL TIMEAVE_CUMUL_1T(ConvectCountTave, ConvectCount,  
      I                           Nr, deltaTclock, bi, bj, myThid)  
         ENDIF  
         useVariableK = useKPP .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  
712          ENDIF          ENDIF
713  #endif /* ALLOW_TIMEAVE */  #endif   /* ALLOW_OBCS */
714    
715  #endif /* SINGLE_LAYER_MODE */  #endif /* SINGLE_LAYER_MODE */
716    
# Line 836  C--   end bi,bj loops. Line 718  C--   end bi,bj loops.
718         ENDDO         ENDDO
719        ENDDO        ENDDO
720    
721  #ifndef DISABLE_DEBUGMODE  #ifdef ALLOW_DEBUG
722        If (debugMode) THEN        If (debugMode) THEN
723         CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (THERMODYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (THERMODYNAMICS)',myThid)
724         CALL DEBUG_STATS_RL(Nr,vVel,'Vvel (THERMODYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,vVel,'Vvel (THERMODYNAMICS)',myThid)
725         CALL DEBUG_STATS_RL(Nr,wVel,'Wvel (THERMODYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,wVel,'Wvel (THERMODYNAMICS)',myThid)
726         CALL DEBUG_STATS_RL(Nr,theta,'Theta (THERMODYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,theta,'Theta (THERMODYNAMICS)',myThid)
727         CALL DEBUG_STATS_RL(Nr,salt,'Salt (THERMODYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,salt,'Salt (THERMODYNAMICS)',myThid)
728         CALL DEBUG_STATS_RL(Nr,Gt,'Gt (THERMODYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,gT,'Gt (THERMODYNAMICS)',myThid)
729         CALL DEBUG_STATS_RL(Nr,Gs,'Gs (THERMODYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,gS,'Gs (THERMODYNAMICS)',myThid)
730         CALL DEBUG_STATS_RL(Nr,GtNm1,'GtNm1 (THERMODYNAMICS)',myThid)  #ifndef ALLOW_ADAMSBASHFORTH_3
731         CALL DEBUG_STATS_RL(Nr,GsNm1,'GsNm1 (THERMODYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,gtNm1,'GtNm1 (THERMODYNAMICS)',myThid)
732           CALL DEBUG_STATS_RL(Nr,gsNm1,'GsNm1 (THERMODYNAMICS)',myThid)
733    #endif
734  #ifdef ALLOW_PTRACERS  #ifdef ALLOW_PTRACERS
735         IF ( usePTRACERS ) THEN         IF ( usePTRACERS ) THEN
736           CALL PTRACERS_DEBUG(myThid)           CALL PTRACERS_DEBUG(myThid)
737         ENDIF         ENDIF
738  #endif /* ALLOW_PTRACERS */  #endif /* ALLOW_PTRACERS */
739        ENDIF        ENDIF
740  #endif  #endif /* ALLOW_DEBUG */
741    
742  #ifndef DISABLE_DEBUGMODE  #ifdef ALLOW_DEBUG
743           IF ( debugLevel .GE. debLevB )           IF ( debugLevel .GE. debLevB )
744       &    CALL DEBUG_LEAVE('FORWARD_STEP',myThid)       &    CALL DEBUG_LEAVE('THERMODYNAMICS',myThid)
745  #endif  #endif
746    
747    #endif /* ALLOW_GENERIC_ADVDIFF */
748    
749        RETURN        RETURN
750        END        END
Legend:
Removed from v.1.50  
changed lines
  Added in v.1.97
  ViewVC Help
Powered by ViewVC 1.1.22