/[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.49 by heimbach, Thu Oct 2 21:33:54 2003 UTC revision 1.102 by heimbach, Tue Apr 4 14:52:43 2006 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 20  C     !INTERFACE: Line 19  C     !INTERFACE:
19        SUBROUTINE THERMODYNAMICS(myTime, myIter, myThid)        SUBROUTINE THERMODYNAMICS(myTime, myIter, myThid)
20  C     !DESCRIPTION: \bv  C     !DESCRIPTION: \bv
21  C     *==========================================================*  C     *==========================================================*
22  C     | SUBROUTINE THERMODYNAMICS                                  C     | SUBROUTINE THERMODYNAMICS
23  C     | o Controlling routine for the prognostic part of the        C     | o Controlling routine for the prognostic part of the
24  C     |   thermo-dynamics.                                          C     |   thermo-dynamics.
25  C     *===========================================================  C     *===========================================================
26  C     | The algorithm...  C     | The algorithm...
27  C     |  C     |
# 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"
 #ifdef ALLOW_PASSIVE_TRACER  
 #include "TR1.h"  
82  #endif  #endif
83  #ifdef ALLOW_PTRACERS  #ifdef ALLOW_PTRACERS
84    #include "PTRACERS_SIZE.h"
85  #include "PTRACERS.h"  #include "PTRACERS.h"
86  #endif  #endif
87  #ifdef ALLOW_TIMEAVE  #ifdef ALLOW_TIMEAVE
# Line 100  C     == Global variables === Line 99  C     == Global variables ===
99  # ifdef ALLOW_GMREDI  # ifdef ALLOW_GMREDI
100  #  include "GMREDI.h"  #  include "GMREDI.h"
101  # endif  # endif
102    # ifdef ALLOW_EBM
103    #  include "EBM.h"
104    # endif
105  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
106    
107  C     !INPUT/OUTPUT PARAMETERS:  C     !INPUT/OUTPUT PARAMETERS:
# Line 111  C     myThid - Thread number for this in Line 113  C     myThid - Thread number for this in
113        INTEGER myIter        INTEGER myIter
114        INTEGER myThid        INTEGER myThid
115    
116    #ifdef ALLOW_GENERIC_ADVDIFF
117  C     !LOCAL VARIABLES:  C     !LOCAL VARIABLES:
118  C     == Local variables  C     == Local variables
119  C     xA, yA                 - Per block temporaries holding face areas  C     xA, yA                 - Per block temporaries holding face areas
# Line 119  C                              transport Line 122  C                              transport
122  C                              o uTrans: Zonal transport  C                              o uTrans: Zonal transport
123  C                              o vTrans: Meridional transport  C                              o vTrans: Meridional transport
124  C                              o rTrans: Vertical transport  C                              o rTrans: Vertical transport
125    C     rTransKp1                o vertical volume transp. at interface k+1
126  C     maskUp                   o maskUp: land/water mask for W points  C     maskUp                   o maskUp: land/water mask for W points
127  C     fVer[STUV]               o fVer: Vertical flux term - note fVer  C     fVer[STUV]               o fVer: Vertical flux term - note fVer
128  C                                      is "pipelined" in the vertical  C                                      is "pipelined" in the vertical
129  C                                      so we need an fVer for each  C                                      so we need an fVer for each
130  C                                      variable.  C                                      variable.
131  C     rhoK, rhoKM1   - Density at current level, and level above  C     kappaRT,       - Total diffusion in vertical at level k, for T and S
132  C     phiSurfX, - gradient of Surface potentiel (Pressure/rho, ocean)  C     kappaRS          (background + spatially varying, isopycnal term).
133  C     phiSurfY             or geopotentiel (atmos) in X and Y direction  C     kappaRTr       - Total diffusion in vertical at level k,
134  C     KappaRT,       - Total diffusion in vertical for T and S.  C                      for each passive Tracer
135  C     KappaRS          (background + spatially varying, isopycnal term).  C     kappaRk        - Total diffusion in vertical, all levels, 1 tracer  
136  C     useVariableK   = T when vertical diffusion is not constant  C     useVariableK   = T when vertical diffusion is not constant
137  C     iMin, iMax     - Ranges and sub-block indices on which calculations  C     iMin, iMax     - Ranges and sub-block indices on which calculations
138  C     jMin, jMax       are applied.  C     jMin, jMax       are applied.
# Line 141  C                      index into fVerTe Line 145  C                      index into fVerTe
145        _RL uTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL uTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
146        _RL vTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL vTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
147        _RL rTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL rTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
148          _RL rTransKp1(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
149        _RS maskUp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RS maskUp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
150        _RL fVerT   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerT   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
151        _RL fVerS   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerS   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
152        _RL fVerTr1 (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL kappaRT (1-Olx:sNx+Olx,1-Oly:sNy+Oly)
153        _RL rhokm1  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL kappaRS (1-Olx:sNx+Olx,1-Oly:sNy+Oly)
154        _RL rhok    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  #ifdef ALLOW_PTRACERS
155        _RL phiSurfX(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL fVerP   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2,PTRACERS_num)
156        _RL phiSurfY(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL kappaRTr(1-Olx:sNx+Olx,1-Oly:sNy+Oly,PTRACERS_num)
157        _RL KappaRT (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)  #endif
158        _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  
159        INTEGER iMin, iMax        INTEGER iMin, iMax
160        INTEGER jMin, jMax        INTEGER jMin, jMax
161        INTEGER bi, bj        INTEGER bi, bj
162        INTEGER i, j        INTEGER i, j
163        INTEGER k, km1, kup, kDown        INTEGER k, km1, kup, kDown
164        INTEGER iTracer  #ifdef ALLOW_ADAMSBASHFORTH_3
165          INTEGER iterNb, m1, m2
166    #endif
167    #ifdef ALLOW_TIMEAVE
168          LOGICAL useVariableK
169    #endif
170    #ifdef ALLOW_PTRACERS
171          INTEGER iTracer, ip
172    #endif
173    
174  CEOP  CEOP
175    
176  #ifndef DISABLE_DEBUGMODE  #ifdef ALLOW_DEBUG
177           IF ( debugLevel .GE. debLevB )           IF ( debugLevel .GE. debLevB )
178       &    CALL DEBUG_ENTER('FORWARD_STEP',myThid)       &    CALL DEBUG_ENTER('THERMODYNAMICS',myThid)
179  #endif  #endif
180    
181  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
182  C--   dummy statement to end declaration part  C--   dummy statement to end declaration part
183        ikey = 1        ikey = 1
# Line 188  CHPF$ INDEPENDENT Line 195  CHPF$ INDEPENDENT
195  C--    HPF directive to help TAMC  C--    HPF directive to help TAMC
196  CHPF$  INDEPENDENT, NEW (rTrans,fVerT,fVerS  CHPF$  INDEPENDENT, NEW (rTrans,fVerT,fVerS
197  CHPF$&                  ,utrans,vtrans,xA,yA  CHPF$&                  ,utrans,vtrans,xA,yA
198  CHPF$&                  ,KappaRT,KappaRS  CHPF$&                  ,kappaRT,kappaRS
199  CHPF$&                  )  CHPF$&                  )
200    # ifdef ALLOW_PTRACERS
201    CHPF$  INDEPENDENT, NEW (fVerP,kappaRTr)
202    # endif
203  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
204    
205         DO bi=myBxLo(myThid),myBxHi(myThid)         DO bi=myBxLo(myThid),myBxHi(myThid)
# 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_num
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 )  
        END IF  
 #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_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  
   
311  #ifdef ALLOW_AUTODIFF_TAMC  #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  
   
 #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  cph-test
317  CADJ STORE tr1  (:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte  cphCADJ STORE gtnm1(:,:,:,bi,bj) = comlev1_bibj, key=itdkey, byte=isbyte
318  #endif  cphCADJ STORE gsnm1(:,:,:,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  
319  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
320    
 #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 */  
   
321  #ifndef DISABLE_MULTIDIM_ADVECTION  #ifndef DISABLE_MULTIDIM_ADVECTION
322  C--     Some advection schemes are better calculated using a multi-dimensional  C--     Some advection schemes are better calculated using a multi-dimensional
323  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 561  C recomputation. It *is* differentiable, Line 330  C recomputation. It *is* differentiable,
330  C Edit GAD_OPTIONS.h and #define DISABLE_MULTIDIM_ADVECTION to  C Edit GAD_OPTIONS.h and #define DISABLE_MULTIDIM_ADVECTION to
331  C disable this section of code.  C disable this section of code.
332          IF (tempMultiDimAdvec) THEN          IF (tempMultiDimAdvec) THEN
333  #ifndef DISABLE_DEBUGMODE  #ifdef ALLOW_DEBUG
334            IF ( debugLevel .GE. debLevB )            IF ( debugLevel .GE. debLevB )
335       &     CALL DEBUG_CALL('GAD_ADVECTION',myThid)       &     CALL DEBUG_CALL('GAD_ADVECTION',myThid)
336  #endif  #endif
337            CALL GAD_ADVECTION(bi,bj,tempAdvScheme,GAD_TEMPERATURE,            CALL GAD_ADVECTION(
338       U                      theta,gT,       I             tempImplVertAdv, tempAdvScheme, tempVertAdvScheme,
339       I                      myTime,myIter,myThid)       I             GAD_TEMPERATURE,
340         I             uVel, vVel, wVel, theta,
341         O             gT,
342         I             bi,bj,myTime,myIter,myThid)
343          ENDIF          ENDIF
344          IF (saltMultiDimAdvec) THEN          IF (saltMultiDimAdvec) THEN
345  #ifndef DISABLE_DEBUGMODE  #ifdef ALLOW_DEBUG
346            IF ( debugLevel .GE. debLevB )            IF ( debugLevel .GE. debLevB )
347       &     CALL DEBUG_CALL('GAD_ADVECTION',myThid)       &     CALL DEBUG_CALL('GAD_ADVECTION',myThid)
348  #endif  #endif
349            CALL GAD_ADVECTION(bi,bj,saltAdvScheme,GAD_SALINITY,            CALL GAD_ADVECTION(
350       U                      salt,gS,       I             saltImplVertAdv, saltAdvScheme, saltVertAdvScheme,
351       I                      myTime,myIter,myThid)       I             GAD_SALINITY,
352         I             uVel, vVel, wVel, salt,
353         O             gS,
354         I             bi,bj,myTime,myIter,myThid)
355          ENDIF          ENDIF
356    
357  C Since passive tracers are configurable separately from T,S we  C Since passive tracers are configurable separately from T,S we
358  C call the multi-dimensional method for PTRACERS regardless  C call the multi-dimensional method for PTRACERS regardless
359  C of whether multiDimAdvection is set or not.  C of whether multiDimAdvection is set or not.
360  #ifdef ALLOW_PTRACERS  #ifdef ALLOW_PTRACERS
361          IF ( usePTRACERS ) THEN          IF ( usePTRACERS ) THEN
362  #ifndef DISABLE_DEBUGMODE  #ifdef ALLOW_DEBUG
363            IF ( debugLevel .GE. debLevB )            IF ( debugLevel .GE. debLevB )
364       &     CALL DEBUG_CALL('PTRACERS_ADVECTION',myThid)       &     CALL DEBUG_CALL('PTRACERS_ADVECTION',myThid)
365  #endif  #endif
# Line 592  C of whether multiDimAdvection is set or Line 368  C of whether multiDimAdvection is set or
368  #endif /* ALLOW_PTRACERS */  #endif /* ALLOW_PTRACERS */
369  #endif /* DISABLE_MULTIDIM_ADVECTION */  #endif /* DISABLE_MULTIDIM_ADVECTION */
370    
371  #ifndef DISABLE_DEBUGMODE  #ifdef ALLOW_DEBUG
372         IF ( debugLevel .GE. debLevB )          IF ( debugLevel .GE. debLevB )
373       &    CALL DEBUG_MSG('ENTERING DOWNWARD K LOOP',myThid)       &    CALL DEBUG_MSG('ENTERING DOWNWARD K LOOP',myThid)
374  #endif  #endif
375    
# Line 602  C--     Start of thermodynamics loop Line 378  C--     Start of thermodynamics loop
378  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
379  C? Patrick Is this formula correct?  C? Patrick Is this formula correct?
380  cph Yes, but I rewrote it.  cph Yes, but I rewrote it.
381  cph Also, the KappaR? need the index and subscript k!  cph Also, the kappaR? need the index and subscript k!
382           kkey = (itdkey-1)*Nr + k           kkey = (itdkey-1)*Nr + k
383  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
384    
# Line 619  C--       kDown  Cycles through 2,1 to p Line 395  C--       kDown  Cycles through 2,1 to p
395            jMin = 1-OLy            jMin = 1-OLy
396            jMax = sNy+OLy            jMax = sNy+OLy
397    
398              IF (k.EQ.Nr) THEN
399               DO j=1-Oly,sNy+Oly
400                DO i=1-Olx,sNx+Olx
401                 rTransKp1(i,j) = 0. _d 0
402                ENDDO
403               ENDDO
404              ELSE
405               DO j=1-Oly,sNy+Oly
406                DO i=1-Olx,sNx+Olx
407                 rTransKp1(i,j) = rTrans(i,j)
408                ENDDO
409               ENDDO
410              ENDIF
411    #ifdef ALLOW_AUTODIFF_TAMC
412    CADJ STORE rTransKp1(:,:) = comlev1_bibj_k, key=kkey, byte=isbyte
413    #endif
414    
415  C--       Get temporary terms used by tendency routines  C--       Get temporary terms used by tendency routines
416            CALL CALC_COMMON_FACTORS (            CALL CALC_COMMON_FACTORS (
417       I         bi,bj,iMin,iMax,jMin,jMax,k,       I         bi,bj,iMin,iMax,jMin,jMax,k,
418       O         xA,yA,uTrans,vTrans,rTrans,maskUp,       O         xA,yA,uTrans,vTrans,rTrans,maskUp,
419       I         myThid)       I         myThid)
420    
421              IF (k.EQ.1) THEN
422    C- Surface interface :
423               DO j=1-Oly,sNy+Oly
424                DO i=1-Olx,sNx+Olx
425                 rTrans(i,j) = 0.
426                ENDDO
427               ENDDO
428              ELSE
429    C- Interior interface :
430               DO j=1-Oly,sNy+Oly
431                DO i=1-Olx,sNx+Olx
432                 rTrans(i,j) = rTrans(i,j)*maskC(i,j,k-1,bi,bj)
433                ENDDO
434               ENDDO
435              ENDIF
436    
437  #ifdef ALLOW_GMREDI  #ifdef ALLOW_GMREDI
438    
439  C--   Residual transp = Bolus transp + Eulerian transp  C--   Residual transp = Bolus transp + Eulerian transp
# Line 635  C--   Residual transp = Bolus transp + E Line 444  C--   Residual transp = Bolus transp + E
444       &                    rTrans, bi, bj, k, myThid)       &                    rTrans, bi, bj, k, myThid)
445            ENDIF            ENDIF
446    
447  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
448    CADJ STORE rTrans(:,:)    = comlev1_bibj_k, key=kkey, byte=isbyte
449  #ifdef GM_BOLUS_ADVEC  #ifdef GM_BOLUS_ADVEC
450  CADJ STORE uTrans(:,:)    = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ STORE uTrans(:,:)    = comlev1_bibj_k, key=kkey, byte=isbyte
451  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  
452  #endif  #endif
453  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
454    
455  #endif /* ALLOW_GMREDI */  #endif /* ALLOW_GMREDI */
456    
 #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 */  
   
457  #ifdef  INCLUDE_CALC_DIFFUSIVITY_CALL  #ifdef  INCLUDE_CALC_DIFFUSIVITY_CALL
458  C--      Calculate the total vertical diffusivity  C--      Calculate the total vertical diffusivity
459           CALL CALC_DIFFUSIVITY(            IF ( .NOT.implicitDiffusion ) THEN
460       I        bi,bj,iMin,iMax,jMin,jMax,k,              CALL CALC_DIFFUSIVITY(
461       I        maskUp,       I          bi,bj,iMin,iMax,jMin,jMax,k,
462       O        KappaRT,KappaRS,       I          maskUp,
463       I        myThid)       O          kappaRT,kappaRS,
464         I          myThid)
465              ENDIF
466    # ifdef ALLOW_AUTODIFF_TAMC
467    CADJ STORE kappaRT(:,:)    = comlev1_bibj_k, key=kkey, byte=isbyte
468    CADJ STORE kappaRS(:,:)    = comlev1_bibj_k, key=kkey, byte=isbyte
469    # endif /* ALLOW_AUTODIFF_TAMC */
470  #endif  #endif
471    
472            iMin = 1-OLx+2            iMin = 1-OLx+2
# Line 665  C--      Calculate the total vertical di Line 475  C--      Calculate the total vertical di
475            jMax = sNy+OLy-1            jMax = sNy+OLy-1
476    
477  C--      Calculate active tracer tendencies (gT,gS,...)  C--      Calculate active tracer tendencies (gT,gS,...)
478  C        and step forward storing result in gTnm1, gSnm1, etc.  C        and step forward storing result in gT, gS, etc.
479    C--
480    # ifdef ALLOW_AUTODIFF_TAMC
481    #  if (defined (NONLIN_FRSURF) && defined (ALLOW_GMREDI))
482    CADJ STORE kux(:,:,k,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte
483    CADJ STORE kuz(:,:,k,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte
484    CADJ STORE kvy(:,:,k,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte
485    CADJ STORE kvz(:,:,k,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte
486    #  endif
487    # endif /* ALLOW_AUTODIFF_TAMC */
488           IF ( tempStepping ) THEN           IF ( tempStepping ) THEN
489    #ifdef ALLOW_AUTODIFF_TAMC
490    CADJ STORE gTnm1(:,:,k,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte
491    # ifdef NONLIN_FRSURF
492    CADJ STORE gT(:,:,k,bi,bj)    = comlev1_bibj_k, key=kkey, byte=isbyte
493    # endif
494    #endif /* ALLOW_AUTODIFF_TAMC */
495             CALL CALC_GT(             CALL CALC_GT(
496       I         bi,bj,iMin,iMax,jMin,jMax, k,km1,kup,kDown,       I         bi,bj,iMin,iMax,jMin,jMax, k,km1,kup,kDown,
497       I         xA,yA,uTrans,vTrans,rTrans,maskUp,       I         xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp,
498       I         KappaRT,       I         kappaRT,
499       U         fVerT,       U         fVerT,
500       I         myTime,myIter,myThid)       I         myTime,myIter,myThid)
501    #ifdef ALLOW_ADAMSBASHFORTH_3
502              IF ( AdamsBashforth_T ) THEN
503             CALL TIMESTEP_TRACER(             CALL TIMESTEP_TRACER(
504       I         bi,bj,iMin,iMax,jMin,jMax,k,tempAdvScheme,       I         bi,bj,iMin,iMax,jMin,jMax,k,tempAdvScheme,
505       I         theta, gT,       I         gtNm(1-Olx,1-Oly,1,1,1,m2),
506         U         gT,
507       I         myIter, myThid)       I         myIter, myThid)
508           ENDIF            ELSE
   
 #ifdef ALLOW_THERM_SEAICE  
          IF (useThermSeaIce .AND. k.EQ.1) THEN  
            CALL ICE_FREEZE( bi,bj, iMin,iMax,jMin,jMax, myThid )  
          ENDIF  
509  #endif  #endif
510               CALL TIMESTEP_TRACER(
511         I         bi,bj,iMin,iMax,jMin,jMax,k,tempAdvScheme,
512         I         theta,
513         U         gT,
514         I         myIter, myThid)
515    #ifdef ALLOW_ADAMSBASHFORTH_3
516              ENDIF
517    #endif
518             ENDIF
519    
520           IF ( saltStepping ) THEN           IF ( saltStepping ) THEN
521    #ifdef ALLOW_AUTODIFF_TAMC
522    CADJ STORE gSnm1(:,:,k,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte
523    # ifdef NONLIN_FRSURF
524    CADJ STORE gS(:,:,k,bi,bj)    = comlev1_bibj_k, key=kkey, byte=isbyte
525    # endif
526    #endif /* ALLOW_AUTODIFF_TAMC */
527             CALL CALC_GS(             CALL CALC_GS(
528       I         bi,bj,iMin,iMax,jMin,jMax, k,km1,kup,kDown,       I         bi,bj,iMin,iMax,jMin,jMax, k,km1,kup,kDown,
529       I         xA,yA,uTrans,vTrans,rTrans,maskUp,       I         xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp,
530       I         KappaRS,       I         kappaRS,
531       U         fVerS,       U         fVerS,
532       I         myTime,myIter,myThid)       I         myTime,myIter,myThid)
533    #ifdef ALLOW_ADAMSBASHFORTH_3
534              IF ( AdamsBashforth_S ) THEN
535             CALL TIMESTEP_TRACER(             CALL TIMESTEP_TRACER(
536       I         bi,bj,iMin,iMax,jMin,jMax,k,saltAdvScheme,       I         bi,bj,iMin,iMax,jMin,jMax,k,saltAdvScheme,
537       I         salt, gS,       I         gsNm(1-Olx,1-Oly,1,1,1,m2),
538         U         gS,
539       I         myIter, myThid)       I         myIter, myThid)
540           ENDIF            ELSE
541  #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)  
542             CALL TIMESTEP_TRACER(             CALL TIMESTEP_TRACER(
543       I         bi,bj,iMin,iMax,jMin,jMax,k,tracerAdvScheme,       I         bi,bj,iMin,iMax,jMin,jMax,k,saltAdvScheme,
544       I         Tr1, gTr1,       I         salt,
545       I         myIter,myThid)       U         gS,
546           ENDIF       I         myIter, myThid)
547    #ifdef ALLOW_ADAMSBASHFORTH_3
548              ENDIF
549  #endif  #endif
550             ENDIF
551    
552  #ifdef ALLOW_PTRACERS  #ifdef ALLOW_PTRACERS
553           IF ( usePTRACERS ) THEN           IF ( usePTRACERS ) THEN
554               IF ( .NOT.implicitDiffusion ) THEN
555                 CALL PTRACERS_CALC_DIFF(
556         I            bi,bj,iMin,iMax,jMin,jMax,k,
557         I            maskUp,
558         O            kappaRTr,
559         I            myThid)
560               ENDIF
561    # ifdef ALLOW_AUTODIFF_TAMC
562    CADJ STORE kappaRTr(:,:,:)    = comlev1_bibj_k, key=kkey, byte=isbyte
563    # endif /* ALLOW_AUTODIFF_TAMC */
564             CALL PTRACERS_INTEGRATE(             CALL PTRACERS_INTEGRATE(
565       I         bi,bj,k,       I         bi,bj,k,
566       I         xA,yA,uTrans,vTrans,rTrans,maskUp,       I         xA,yA,uTrans,vTrans,rTrans,rTransKp1,maskUp,
567       X         KappaRS,       U         fVerP,
568         I         kappaRTr,
569       I         myIter,myTime,myThid)       I         myIter,myTime,myThid)
570           ENDIF           ENDIF
571  #endif /* ALLOW_PTRACERS */  #endif /* ALLOW_PTRACERS */
# Line 729  C--      Apply open boundary conditions Line 578  C--      Apply open boundary conditions
578  #endif   /* ALLOW_OBCS */  #endif   /* ALLOW_OBCS */
579    
580  C--      Freeze water  C--      Freeze water
581           IF ( allowFreezing .AND. .NOT. useSEAICE  C  this bit of code is left here for backward compatibility.
582       &       .AND. .NOT.(useThermSeaIce.AND.k.EQ.1) ) THEN  C  freezing at surface level has been moved to FORWARD_STEP
583             IF ( useOldFreezing .AND. .NOT. useSEAICE
584         &       .AND. .NOT.(useThSIce.AND.k.EQ.1) ) THEN
585  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
586  CADJ STORE gT(:,:,k,bi,bj) = comlev1_bibj_k  CADJ STORE gT(:,:,k,bi,bj) = comlev1_bibj_k
587  CADJ &   , key = kkey, byte = isbyte  CADJ &   , key = kkey, byte = isbyte
# Line 741  CADJ &   , key = kkey, byte = isbyte Line 592  CADJ &   , key = kkey, byte = isbyte
592  C--     end of thermodynamic k loop (Nr:1)  C--     end of thermodynamic k loop (Nr:1)
593          ENDDO          ENDDO
594    
595  cswdice -- add ---  C       All explicit advection/diffusion/sources should now be
596  #ifdef ALLOW_THERM_SEAICE  C       done. The updated tracer field is in gPtr. Accumalate
597  c timeaveraging for ice model values  C       explicit tendency and also reset gPtr to initial tracer
598             CALL ICE_AVE(bi,bj,iMin,iMax,jMin,jMax,myThid )  C       field for implicit matrix calculation
599  #endif  
600  cswdice --- end add ---  #ifdef ALLOW_MATRIX
601            IF (useMATRIX)
602         &    CALL MATRIX_STORE_TENDENCY_EXP(bi,bj, myTime,myIter,myThid)
603    #endif
604    
605  C--     Implicit diffusion          iMin = 1
606          IF (implicitDiffusion) THEN          iMax = sNx
607            jMin = 1
608           IF (tempStepping) THEN          jMax = sNy
609    
610    C--     Implicit vertical advection & diffusion
611            IF ( tempStepping .AND. implicitDiffusion ) THEN
612              CALL CALC_3D_DIFFUSIVITY(
613         I         bi,bj,iMin,iMax,jMin,jMax,
614         I         GAD_TEMPERATURE, useGMredi, useKPP,
615         O         kappaRk,
616         I         myThid)
617            ENDIF
618    #ifdef INCLUDE_IMPLVERTADV_CODE
619            IF ( tempImplVertAdv ) THEN
620              CALL GAD_IMPLICIT_R(
621         I         tempImplVertAdv, tempAdvScheme, GAD_TEMPERATURE,
622         I         kappaRk, wVel, theta,
623         U         gT,
624         I         bi, bj, myTime, myIter, myThid )
625            ELSEIF ( tempStepping .AND. implicitDiffusion ) THEN
626    #else /* INCLUDE_IMPLVERTADV_CODE */
627            IF     ( tempStepping .AND. implicitDiffusion ) THEN
628    #endif /* INCLUDE_IMPLVERTADV_CODE */
629  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
630    CADJ STORE kappaRk(:,:,:) = comlev1_bibj , key=itdkey, byte=isbyte
631  CADJ STORE gT(:,:,:,bi,bj) = comlev1_bibj , key=itdkey, byte=isbyte  CADJ STORE gT(:,:,:,bi,bj) = comlev1_bibj , key=itdkey, byte=isbyte
632  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
633              CALL IMPLDIFF(            CALL IMPLDIFF(
634       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
635       I         deltaTtracer, KappaRT, recip_HFacC,       I         GAD_TEMPERATURE, kappaRk, recip_hFacC,
636       U         gT,       U         gT,
637       I         myThid )       I         myThid )
638            ENDIF
639    
640    #ifdef ALLOW_TIMEAVE
641            useVariableK = useKPP .OR. usePP81 .OR. useMY82 .OR. useGGL90
642         &       .OR. useGMredi .OR. ivdc_kappa.NE.0.
643            IF (taveFreq.GT.0. .AND. useVariableK ) THEN
644             IF (implicitDiffusion) THEN
645               CALL TIMEAVE_CUMUL_DIF_1T(TdiffRtave, gT, kappaRk,
646         I                        Nr, 3, deltaTclock, bi, bj, myThid)
647    c        ELSE
648    c          CALL TIMEAVE_CUMUL_DIF_1T(TdiffRtave, theta, kappaRT,
649    c    I                        Nr, 3, deltaTclock, bi, bj, myThid)
650           ENDIF           ENDIF
651            ENDIF
652    #endif /* ALLOW_TIMEAVE */
653    
654            IF ( saltStepping .AND. implicitDiffusion ) THEN
655              CALL CALC_3D_DIFFUSIVITY(
656         I         bi,bj,iMin,iMax,jMin,jMax,
657         I         GAD_SALINITY, useGMredi, useKPP,
658         O         kappaRk,
659         I         myThid)
660            ENDIF
661    
662           IF (saltStepping) THEN  #ifdef INCLUDE_IMPLVERTADV_CODE
663            IF ( saltImplVertAdv ) THEN
664              CALL GAD_IMPLICIT_R(
665         I         saltImplVertAdv, saltAdvScheme, GAD_SALINITY,
666         I         kappaRk, wVel, salt,
667         U         gS,
668         I         bi, bj, myTime, myIter, myThid )
669            ELSEIF ( saltStepping .AND. implicitDiffusion ) THEN
670    #else /* INCLUDE_IMPLVERTADV_CODE */
671            IF     ( saltStepping .AND. implicitDiffusion ) THEN
672    #endif /* INCLUDE_IMPLVERTADV_CODE */
673  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
674    CADJ STORE kappaRk(:,:,:) = comlev1_bibj , key=itdkey, byte=isbyte
675  CADJ STORE gS(:,:,:,bi,bj) = comlev1_bibj , key=itdkey, byte=isbyte  CADJ STORE gS(:,:,:,bi,bj) = comlev1_bibj , key=itdkey, byte=isbyte
676  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
677              CALL IMPLDIFF(            CALL IMPLDIFF(
678       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
679       I         deltaTtracer, KappaRS, recip_HFacC,       I         GAD_SALINITY, kappaRk, recip_hFacC,
680       U         gS,       U         gS,
681       I         myThid )       I         myThid )
682           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  
 #endif  
683    
684  #ifdef ALLOW_PTRACERS  #ifdef ALLOW_PTRACERS
685  C Vertical diffusion (implicit) for passive tracers          IF     ( usePTRACERS ) THEN
686           IF ( usePTRACERS ) THEN  C--     Vertical advection/diffusion (implicit) for passive tracers
687             CALL PTRACERS_IMPLDIFF( bi,bj,KappaRS,myThid )             CALL PTRACERS_IMPLICIT(
688           ENDIF       U                             kappaRk,
689         I                             bi, bj, myTime, myIter, myThid )
690            ENDIF
691  #endif /* ALLOW_PTRACERS */  #endif /* ALLOW_PTRACERS */
692    
693  #ifdef   ALLOW_OBCS  #ifdef   ALLOW_OBCS
694  C--      Apply open boundary conditions  C--      Apply open boundary conditions
695           IF (useOBCS) THEN          IF ( ( implicitDiffusion
696         &    .OR. tempImplVertAdv
697         &    .OR. saltImplVertAdv
698         &       ) .AND. useOBCS     ) THEN
699             DO K=1,Nr             DO K=1,Nr
700               CALL OBCS_APPLY_TS( bi, bj, k, gT, gS, myThid )               CALL OBCS_APPLY_TS( bi, bj, k, gT, gS, myThid )
701             ENDDO             ENDDO
          END IF  
 #endif   /* ALLOW_OBCS */  
   
 C--     End If implicitDiffusion  
702          ENDIF          ENDIF
703    #endif   /* ALLOW_OBCS */
 #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  
         ENDIF  
 #endif /* ALLOW_TIMEAVE */  
704    
705  #endif /* SINGLE_LAYER_MODE */  #endif /* SINGLE_LAYER_MODE */
706    
# Line 831  C--   end bi,bj loops. Line 708  C--   end bi,bj loops.
708         ENDDO         ENDDO
709        ENDDO        ENDDO
710    
711  #ifndef DISABLE_DEBUGMODE  #ifdef ALLOW_DEBUG
712        If (debugMode) THEN        If (debugMode) THEN
713         CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (THERMODYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (THERMODYNAMICS)',myThid)
714         CALL DEBUG_STATS_RL(Nr,vVel,'Vvel (THERMODYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,vVel,'Vvel (THERMODYNAMICS)',myThid)
715         CALL DEBUG_STATS_RL(Nr,wVel,'Wvel (THERMODYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,wVel,'Wvel (THERMODYNAMICS)',myThid)
716         CALL DEBUG_STATS_RL(Nr,theta,'Theta (THERMODYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,theta,'Theta (THERMODYNAMICS)',myThid)
717         CALL DEBUG_STATS_RL(Nr,salt,'Salt (THERMODYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,salt,'Salt (THERMODYNAMICS)',myThid)
718         CALL DEBUG_STATS_RL(Nr,Gt,'Gt (THERMODYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,gT,'Gt (THERMODYNAMICS)',myThid)
719         CALL DEBUG_STATS_RL(Nr,Gs,'Gs (THERMODYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,gS,'Gs (THERMODYNAMICS)',myThid)
720         CALL DEBUG_STATS_RL(Nr,GtNm1,'GtNm1 (THERMODYNAMICS)',myThid)  #ifndef ALLOW_ADAMSBASHFORTH_3
721         CALL DEBUG_STATS_RL(Nr,GsNm1,'GsNm1 (THERMODYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,gtNm1,'GtNm1 (THERMODYNAMICS)',myThid)
722           CALL DEBUG_STATS_RL(Nr,gsNm1,'GsNm1 (THERMODYNAMICS)',myThid)
723    #endif
724  #ifdef ALLOW_PTRACERS  #ifdef ALLOW_PTRACERS
725         IF ( usePTRACERS ) THEN         IF ( usePTRACERS ) THEN
726           CALL PTRACERS_DEBUG(myThid)           CALL PTRACERS_DEBUG(myThid)
727         ENDIF         ENDIF
728  #endif /* ALLOW_PTRACERS */  #endif /* ALLOW_PTRACERS */
729        ENDIF        ENDIF
730  #endif  #endif /* ALLOW_DEBUG */
731    
732  #ifndef DISABLE_DEBUGMODE  #ifdef ALLOW_DEBUG
733           IF ( debugLevel .GE. debLevB )           IF ( debugLevel .GE. debLevB )
734       &    CALL DEBUG_LEAVE('FORWARD_STEP',myThid)       &    CALL DEBUG_LEAVE('THERMODYNAMICS',myThid)
735  #endif  #endif
736    
737    #endif /* ALLOW_GENERIC_ADVDIFF */
738    
739        RETURN        RETURN
740        END        END
Legend:
Removed from v.1.49  
changed lines
  Added in v.1.102
  ViewVC Help
Powered by ViewVC 1.1.22