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

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

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

revision 1.56 by heimbach, Mon Jan 29 20:05:46 2001 UTC revision 1.126 by heimbach, Thu Dec 8 15:44:33 2005 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2    C $Name$
3    
4    #include "PACKAGES_CONFIG.h"
5  #include "CPP_OPTIONS.h"  #include "CPP_OPTIONS.h"
6    #undef DYNAMICS_GUGV_EXCH_CHECK
7    
8    CBOP
9    C     !ROUTINE: DYNAMICS
10    C     !INTERFACE:
11        SUBROUTINE DYNAMICS(myTime, myIter, myThid)        SUBROUTINE DYNAMICS(myTime, myIter, myThid)
12  C     /==========================================================\  C     !DESCRIPTION: \bv
13  C     | SUBROUTINE DYNAMICS                                      |  C     *==========================================================*
14  C     | o Controlling routine for the explicit part of the model |  C     | SUBROUTINE DYNAMICS                                      
15  C     |   dynamics.                                              |  C     | o Controlling routine for the explicit part of the model  
16  C     |==========================================================|  C     |   dynamics.                                              
17  C     | This routine evaluates the "dynamics" terms for each     |  C     *==========================================================*
18  C     | block of ocean in turn. Because the blocks of ocean have |  C     | This routine evaluates the "dynamics" terms for each      
19  C     | overlap regions they are independent of one another.     |  C     | block of ocean in turn. Because the blocks of ocean have  
20  C     | If terms involving lateral integrals are needed in this  |  C     | overlap regions they are independent of one another.      
21  C     | routine care will be needed. Similarly finite-difference |  C     | If terms involving lateral integrals are needed in this  
22  C     | operations with stencils wider than the overlap region   |  C     | routine care will be needed. Similarly finite-difference  
23  C     | require special consideration.                           |  C     | operations with stencils wider than the overlap region    
24  C     | Notes                                                    |  C     | require special consideration.                            
25  C     | =====                                                    |  C     | The algorithm...
26  C     | C*P* comments indicating place holders for which code is |  C     |
27  C     |      presently being developed.                          |  C     | "Correction Step"
28  C     \==========================================================/  C     | =================
29    C     | Here we update the horizontal velocities with the surface
30    C     | pressure such that the resulting flow is either consistent
31    C     | with the free-surface evolution or the rigid-lid:
32    C     |   U[n] = U* + dt x d/dx P
33    C     |   V[n] = V* + dt x d/dy P
34    C     |   W[n] = W* + dt x d/dz P  (NH mode)
35    C     |
36    C     | "Calculation of Gs"
37    C     | ===================
38    C     | This is where all the accelerations and tendencies (ie.
39    C     | physics, parameterizations etc...) are calculated
40    C     |   rho = rho ( theta[n], salt[n] )
41    C     |   b   = b(rho, theta)
42    C     |   K31 = K31 ( rho )
43    C     |   Gu[n] = Gu( u[n], v[n], wVel, b, ... )
44    C     |   Gv[n] = Gv( u[n], v[n], wVel, b, ... )
45    C     |   Gt[n] = Gt( theta[n], u[n], v[n], wVel, K31, ... )
46    C     |   Gs[n] = Gs( salt[n], u[n], v[n], wVel, K31, ... )
47    C     |
48    C     | "Time-stepping" or "Prediction"
49    C     | ================================
50    C     | The models variables are stepped forward with the appropriate
51    C     | time-stepping scheme (currently we use Adams-Bashforth II)
52    C     | - For momentum, the result is always *only* a "prediction"
53    C     | in that the flow may be divergent and will be "corrected"
54    C     | later with a surface pressure gradient.
55    C     | - Normally for tracers the result is the new field at time
56    C     | level [n+1} *BUT* in the case of implicit diffusion the result
57    C     | is also *only* a prediction.
58    C     | - We denote "predictors" with an asterisk (*).
59    C     |   U* = U[n] + dt x ( 3/2 Gu[n] - 1/2 Gu[n-1] )
60    C     |   V* = V[n] + dt x ( 3/2 Gv[n] - 1/2 Gv[n-1] )
61    C     |   theta[n+1] = theta[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
62    C     |   salt[n+1] = salt[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
63    C     | With implicit diffusion:
64    C     |   theta* = theta[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
65    C     |   salt* = salt[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
66    C     |   (1 + dt * K * d_zz) theta[n] = theta*
67    C     |   (1 + dt * K * d_zz) salt[n] = salt*
68    C     |
69    C     *==========================================================*
70    C     \ev
71    C     !USES:
72        IMPLICIT NONE        IMPLICIT NONE
   
73  C     == Global variables ===  C     == Global variables ===
74  #include "SIZE.h"  #include "SIZE.h"
75  #include "EEPARAMS.h"  #include "EEPARAMS.h"
 #include "CG2D.h"  
76  #include "PARAMS.h"  #include "PARAMS.h"
77  #include "DYNVARS.h"  #include "DYNVARS.h"
78    #ifdef ALLOW_CD_CODE
79    #include "CD_CODE_VARS.h"
80    #endif
81  #include "GRID.h"  #include "GRID.h"
   
82  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
83  # include "tamc.h"  # include "tamc.h"
84  # include "tamc_keys.h"  # include "tamc_keys.h"
85  # include "FFIELDS.h"  # include "FFIELDS.h"
86    # include "EOS.h"
87  # ifdef ALLOW_KPP  # ifdef ALLOW_KPP
88  #  include "KPP.h"  #  include "KPP.h"
89  # endif  # endif
 # ifdef ALLOW_GMREDI  
 #  include "GMREDI.h"  
 # endif  
90  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
91    
92    C     !CALLING SEQUENCE:
93    C     DYNAMICS()
94    C      |
95    C      |-- CALC_EP_FORCING
96    C      |
97    C      |-- CALC_GRAD_PHI_SURF
98    C      |
99    C      |-- CALC_VISCOSITY
100    C      |
101    C      |-- CALC_PHI_HYD  
102    C      |
103    C      |-- MOM_FLUXFORM  
104    C      |
105    C      |-- MOM_VECINV    
106    C      |
107    C      |-- TIMESTEP      
108    C      |
109    C      |-- OBCS_APPLY_UV
110    C      |
111    C      |-- MOM_U_IMPLICIT_R      
112    C      |-- MOM_V_IMPLICIT_R      
113    C      |
114    C      |-- IMPLDIFF      
115    C      |
116    C      |-- OBCS_APPLY_UV
117    C      |
118    C      |-- CALC_GW
119    C      |
120    C      |-- DIAGNOSTICS_FILL
121    C      |-- DEBUG_STATS_RL
122    
123    C     !INPUT/OUTPUT PARAMETERS:
124  C     == Routine arguments ==  C     == Routine arguments ==
125  C     myTime - Current time in simulation  C     myTime - Current time in simulation
126  C     myIter - Current iteration number in simulation  C     myIter - Current iteration number in simulation
# Line 50  C     myThid - Thread number for this in Line 129  C     myThid - Thread number for this in
129        INTEGER myIter        INTEGER myIter
130        INTEGER myThid        INTEGER myThid
131    
132    C     !LOCAL VARIABLES:
133  C     == Local variables  C     == Local variables
134  C     xA, yA                 - Per block temporaries holding face areas  C     fVer[UV]               o fVer: Vertical flux term - note fVer
135  C     uTrans, vTrans, rTrans - Per block temporaries holding flow  C                                    is "pipelined" in the vertical
136  C                              transport  C                                    so we need an fVer for each
137  C     rVel                     o uTrans: Zonal transport  C                                    variable.
138  C                              o vTrans: Meridional transport  C     phiHydC    :: hydrostatic potential anomaly at cell center
139  C                              o rTrans: Vertical transport  C                   In z coords phiHyd is the hydrostatic potential
140  C                              o rVel:   Vertical velocity at upper and  C                      (=pressure/rho0) anomaly
141  C                                        lower cell faces.  C                   In p coords phiHyd is the geopotential height anomaly.
142  C     maskC,maskUp             o maskC: land/water mask for tracer cells  C     phiHydF    :: hydrostatic potential anomaly at middle between 2 centers
143  C                              o maskUp: land/water mask for W points  C     dPhiHydX,Y :: Gradient (X & Y directions) of hydrostatic potential anom.
144  C     aTerm, xTerm, cTerm    - Work arrays for holding separate terms in  C     phiSurfX,  ::  gradient of Surface potential (Pressure/rho, ocean)
145  C     mTerm, pTerm,            tendency equations.  C     phiSurfY             or geopotential (atmos) in X and Y direction
146  C     fZon, fMer, fVer[STUV]   o aTerm: Advection term  C     guDissip   :: dissipation tendency (all explicit terms), u component
147  C                              o xTerm: Mixing term  C     gvDissip   :: dissipation tendency (all explicit terms), v component
 C                              o cTerm: Coriolis term  
 C                              o mTerm: Metric term  
 C                              o pTerm: Pressure term  
 C                              o fZon: Zonal flux term  
 C                              o fMer: Meridional flux term  
 C                              o fVer: Vertical flux term - note fVer  
 C                                      is "pipelined" in the vertical  
 C                                      so we need an fVer for each  
 C                                      variable.  
 C     rhoK, rhoKM1   - Density at current level, level above and level  
 C                      below.  
 C     rhoKP1                                                                    
 C     buoyK, buoyKM1 - Buoyancy at current level and level above.  
 C     phiHyd         - Hydrostatic part of the potential phiHydi.  
 C                      In z coords phiHydiHyd is the hydrostatic  
 C                      pressure anomaly  
 C                      In p coords phiHydiHyd is the geopotential  
 C                      surface height  
 C                      anomaly.  
 C     etaSurfX,      - Holds surface elevation gradient in X and Y.  
 C     etaSurfY  
 C     KappaRT,       - Total diffusion in vertical for T and S.  
 C     KappaRS          (background + spatially varying, isopycnal term).  
148  C     iMin, iMax     - Ranges and sub-block indices on which calculations  C     iMin, iMax     - Ranges and sub-block indices on which calculations
149  C     jMin, jMax       are applied.  C     jMin, jMax       are applied.
150  C     bi, bj  C     bi, bj
151  C     k, kup,        - Index for layer above and below. kup and kDown  C     k, kup,        - Index for layer above and below. kup and kDown
152  C     kDown, km1       are switched with layer to be the appropriate  C     kDown, km1       are switched with layer to be the appropriate
153  C                      index into fVerTerm.  C                      index into fVerTerm.
       _RS xA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RS yA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL uTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL vTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL rTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL rVel    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)  
       _RS maskC   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RS maskUp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL aTerm   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL xTerm   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL cTerm   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL mTerm   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL pTerm   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL fZon    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL fMer    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL fVerT   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)  
       _RL fVerS   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)  
154        _RL fVerU   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerU   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
155        _RL fVerV   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerV   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
156        _RL phiHyd  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL phiHydF (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
157        _RL rhokm1  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL phiHydC (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
158        _RL rhokp1  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL dPhiHydX(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
159        _RL rhok    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL dPhiHydY(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
160        _RL buoyKM1 (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL phiSurfX(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
161        _RL buoyK   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL phiSurfY(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
162        _RL rhotmp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL guDissip(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
163        _RL etaSurfX(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL gvDissip(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
       _RL etaSurfY(1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL KappaRT (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)  
       _RL KappaRS (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)  
164        _RL KappaRU (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)        _RL KappaRU (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)
165        _RL KappaRV (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)        _RL KappaRV (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)
       _RL sigmaX  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)  
       _RL sigmaY  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)  
       _RL sigmaR  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)  
   
 C This is currently also used by IVDC and Diagnostics  
 C #ifdef INCLUDE_CONVECT_CALL  
       _RL ConvectCount (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)  
 C #endif  
166    
167        INTEGER iMin, iMax        INTEGER iMin, iMax
168        INTEGER jMin, jMax        INTEGER jMin, jMax
169        INTEGER bi, bj        INTEGER bi, bj
170        INTEGER i, j        INTEGER i, j
171        INTEGER k, km1, kup, kDown        INTEGER k, km1, kp1, kup, kDown
       LOGICAL BOTTOM_LAYER  
   
 #ifdef ALLOW_AUTODIFF_TAMC  
       INTEGER    isbyte  
       PARAMETER( isbyte = 4 )  
172    
173        INTEGER act1, act2, act3, act4  #ifdef ALLOW_DIAGNOSTICS
174        INTEGER max1, max2, max3        _RL tmpFac
175        INTEGER iikey, kkey  #endif /* ALLOW_DIAGNOSTICS */
       INTEGER maximpl  
 #endif /* ALLOW_AUTODIFF_TAMC */  
176    
177    
178  C---    The algorithm...  C---    The algorithm...
179  C  C
180  C       "Correction Step"  C       "Correction Step"
# Line 166  C       "Calculation of Gs" Line 189  C       "Calculation of Gs"
189  C       ===================  C       ===================
190  C       This is where all the accelerations and tendencies (ie.  C       This is where all the accelerations and tendencies (ie.
191  C       physics, parameterizations etc...) are calculated  C       physics, parameterizations etc...) are calculated
 C         rVel = sum_r ( div. u[n] )  
192  C         rho = rho ( theta[n], salt[n] )  C         rho = rho ( theta[n], salt[n] )
193  C         b   = b(rho, theta)  C         b   = b(rho, theta)
194  C         K31 = K31 ( rho )  C         K31 = K31 ( rho )
195  C         Gu[n] = Gu( u[n], v[n], rVel, b, ... )  C         Gu[n] = Gu( u[n], v[n], wVel, b, ... )
196  C         Gv[n] = Gv( u[n], v[n], rVel, b, ... )  C         Gv[n] = Gv( u[n], v[n], wVel, b, ... )
197  C         Gt[n] = Gt( theta[n], u[n], v[n], rVel, K31, ... )  C         Gt[n] = Gt( theta[n], u[n], v[n], wVel, K31, ... )
198  C         Gs[n] = Gs( salt[n], u[n], v[n], rVel, K31, ... )  C         Gs[n] = Gs( salt[n], u[n], v[n], wVel, K31, ... )
199  C  C
200  C       "Time-stepping" or "Prediction"  C       "Time-stepping" or "Prediction"
201  C       ================================  C       ================================
# Line 196  C         salt* = salt[n] + dt x ( 3/2 G Line 218  C         salt* = salt[n] + dt x ( 3/2 G
218  C         (1 + dt * K * d_zz) theta[n] = theta*  C         (1 + dt * K * d_zz) theta[n] = theta*
219  C         (1 + dt * K * d_zz) salt[n] = salt*  C         (1 + dt * K * d_zz) salt[n] = salt*
220  C---  C---
221    CEOP
222    
223  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_DEBUG
224  C--   dummy statement to end declaration part        IF ( debugLevel .GE. debLevB )
225        ikey = 1       &   CALL DEBUG_ENTER( 'DYNAMICS', myThid )
226  #endif /* ALLOW_AUTODIFF_TAMC */  #endif
   
   
 C--   Set up work arrays with valid (i.e. not NaN) values  
 C     These inital values do not alter the numerical results. They  
 C     just ensure that all memory references are to valid floating  
 C     point numbers. This prevents spurious hardware signals due to  
 C     uninitialised but inert locations.  
       DO j=1-OLy,sNy+OLy  
        DO i=1-OLx,sNx+OLx  
         xA(i,j)      = 0. _d 0  
         yA(i,j)      = 0. _d 0  
         uTrans(i,j)  = 0. _d 0  
         vTrans(i,j)  = 0. _d 0  
         aTerm(i,j)   = 0. _d 0  
         xTerm(i,j)   = 0. _d 0  
         cTerm(i,j)   = 0. _d 0  
         mTerm(i,j)   = 0. _d 0  
         pTerm(i,j)   = 0. _d 0  
         fZon(i,j)    = 0. _d 0  
         fMer(i,j)    = 0. _d 0  
         DO k=1,Nr  
          phiHyd (i,j,k)  = 0. _d 0  
          KappaRU(i,j,k) = 0. _d 0  
          KappaRV(i,j,k) = 0. _d 0  
          sigmaX(i,j,k) = 0. _d 0  
          sigmaY(i,j,k) = 0. _d 0  
          sigmaR(i,j,k) = 0. _d 0  
         ENDDO  
         rhoKM1 (i,j) = 0. _d 0  
         rhok   (i,j) = 0. _d 0  
         rhoKP1 (i,j) = 0. _d 0  
         rhoTMP (i,j) = 0. _d 0  
         buoyKM1(i,j) = 0. _d 0  
         buoyK  (i,j) = 0. _d 0  
         maskC  (i,j) = 0. _d 0  
        ENDDO  
       ENDDO  
227    
228    C-- Call to routine for calculation of
229    C   Eliassen-Palm-flux-forced U-tendency,
230    C   if desired:
231    #ifdef INCLUDE_EP_FORCING_CODE
232          CALL CALC_EP_FORCING(myThid)
233    #endif
234    
235  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
236  C--   HPF directive to help TAMC  C--   HPF directive to help TAMC
# Line 249  CHPF$ INDEPENDENT Line 241  CHPF$ INDEPENDENT
241    
242  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
243  C--    HPF directive to help TAMC  C--    HPF directive to help TAMC
244  CHPF$  INDEPENDENT, NEW (rTrans,rVel,fVerT,fVerS,fVerU,fVerV  CHPF$  INDEPENDENT, NEW (fVerU,fVerV
245  CHPF$&                  ,phiHyd,utrans,vtrans,maskc,xA,yA  CHPF$&                  ,phiHydF
246  CHPF$&                  ,KappaRT,KappaRS,KappaRU,KappaRV  CHPF$&                  ,KappaRU,KappaRV
247  CHPF$&                  )  CHPF$&                  )
248  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
249    
# Line 260  CHPF$&                  ) Line 252  CHPF$&                  )
252  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
253            act1 = bi - myBxLo(myThid)            act1 = bi - myBxLo(myThid)
254            max1 = myBxHi(myThid) - myBxLo(myThid) + 1            max1 = myBxHi(myThid) - myBxLo(myThid) + 1
   
255            act2 = bj - myByLo(myThid)            act2 = bj - myByLo(myThid)
256            max2 = myByHi(myThid) - myByLo(myThid) + 1            max2 = myByHi(myThid) - myByLo(myThid) + 1
   
257            act3 = myThid - 1            act3 = myThid - 1
258            max3 = nTx*nTy            max3 = nTx*nTy
   
259            act4 = ikey_dynamics - 1            act4 = ikey_dynamics - 1
260              idynkey = (act1 + 1) + act2*max1
           ikey = (act1 + 1) + act2*max1  
261       &                      + act3*max1*max2       &                      + act3*max1*max2
262       &                      + act4*max1*max2*max3       &                      + act4*max1*max2*max3
263  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
264    
265  C--     Set up work arrays that need valid initial values  C--   Set up work arrays with valid (i.e. not NaN) values
266          DO j=1-OLy,sNy+OLy  C     These inital values do not alter the numerical results. They
267           DO i=1-OLx,sNx+OLx  C     just ensure that all memory references are to valid floating
268            rTrans(i,j)   = 0. _d 0  C     point numbers. This prevents spurious hardware signals due to
269            rVel  (i,j,1) = 0. _d 0  C     uninitialised but inert locations.
           rVel  (i,j,2) = 0. _d 0  
           fVerT (i,j,1) = 0. _d 0  
           fVerT (i,j,2) = 0. _d 0  
           fVerS (i,j,1) = 0. _d 0  
           fVerS (i,j,2) = 0. _d 0  
           fVerU (i,j,1) = 0. _d 0  
           fVerU (i,j,2) = 0. _d 0  
           fVerV (i,j,1) = 0. _d 0  
           fVerV (i,j,2) = 0. _d 0  
           phiHyd(i,j,1) = 0. _d 0  
          ENDDO  
         ENDDO  
270    
271          DO k=1,Nr          DO k=1,Nr
272           DO j=1-OLy,sNy+OLy           DO j=1-OLy,sNy+OLy
273            DO i=1-OLx,sNx+OLx            DO i=1-OLx,sNx+OLx
274  #ifdef INCLUDE_CONVECT_CALL             KappaRU(i,j,k) = 0. _d 0
275             ConvectCount(i,j,k) = 0.             KappaRV(i,j,k) = 0. _d 0
 #endif  
            KappaRT(i,j,k) = 0. _d 0  
            KappaRS(i,j,k) = 0. _d 0  
           ENDDO  
          ENDDO  
         ENDDO  
   
         iMin = 1-OLx+1  
         iMax = sNx+OLx  
         jMin = 1-OLy+1  
         jMax = sNy+OLy  
   
         k = 1  
         BOTTOM_LAYER = k .EQ. Nr  
   
 #ifdef DO_PIPELINED_CORRECTION_STEP  
 C--     Calculate gradient of surface pressure  
         CALL CALC_GRAD_ETA_SURF(  
      I       bi,bj,iMin,iMax,jMin,jMax,  
      O       etaSurfX,etaSurfY,  
      I       myThid)  
 C--     Update fields in top level according to tendency terms  
         CALL CORRECTION_STEP(  
      I       bi,bj,iMin,iMax,jMin,jMax,k,  
      I       etaSurfX,etaSurfY,myTime,myThid)  
   
 #ifdef ALLOW_OBCS  
         IF (openBoundaries) THEN  
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE uvel (:,:,k,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte  
 CADJ STORE vvel (:,:,k,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte  
 CADJ STORE theta(:,:,k,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte  
 CADJ STORE salt (:,:,k,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
            CALL APPLY_OBCS1( bi, bj, k, myThid )  
         END IF  
 #endif  
   
         IF ( .NOT. BOTTOM_LAYER ) THEN  
 C--      Update fields in layer below according to tendency terms  
          CALL CORRECTION_STEP(  
      I        bi,bj,iMin,iMax,jMin,jMax,k+1,  
      I        etaSurfX,etaSurfY,myTime,myThid)  
 #ifdef ALLOW_OBCS  
          IF (openBoundaries) THEN  
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE uvel (:,:,k,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte  
 CADJ STORE vvel (:,:,k,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte  
 CADJ STORE theta(:,:,k,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte  
 CADJ STORE salt (:,:,k,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
             CALL APPLY_OBCS1( bi, bj, k+1, myThid )  
          END IF  
 #endif  
         ENDIF  
 #endif  
   
 C--     Density of 1st level (below W(1)) reference to level 1  
 #ifdef  INCLUDE_FIND_RHO_CALL  
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE theta(:,:,k,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte  
 CADJ STORE salt (:,:,k,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
         CALL FIND_RHO(  
      I     bi, bj, iMin, iMax, jMin, jMax, k, k, eosType,  
      O     rhoKm1,  
      I     myThid )  
 #endif  
   
         IF (.NOT. BOTTOM_LAYER) THEN  
   
 C--      Check static stability with layer below  
 C--      and mix as needed.  
 #ifdef  INCLUDE_FIND_RHO_CALL  
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE theta(:,:,k+1,bi,bj) = comlev1_bibj  
 CADJ &   , key = ikey, byte = isbyte  
 CADJ STORE salt (:,:,k+1,bi,bj) = comlev1_bibj  
 CADJ &   , key = ikey, byte = isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
          CALL FIND_RHO(  
      I      bi, bj, iMin, iMax, jMin, jMax, k+1, k, eosType,  
      O      rhoKp1,  
      I      myThid )  
 #endif  
   
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE rhoKm1(:,:)  = comlev1_bibj, key = ikey, byte = isbyte  
 CADJ STORE rhoKp1(:,:)  = comlev1_bibj, key = ikey, byte = isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
   
 #ifdef  INCLUDE_CONVECT_CALL  
   
          CALL CONVECT(  
      I       bi,bj,iMin,iMax,jMin,jMax,k+1,rhoKm1,rhoKp1,  
      U       ConvectCount,  
      I       myTime,myIter,myThid)  
   
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE theta(:,:,k+1,bi,bj),theta(:,:,k,bi,bj)  
 CADJ &     = comlev1_bibj, key = ikey, byte = isbyte  
 CADJ STORE salt (:,:,k+1,bi,bj),salt (:,:,k,bi,bj)  
 CADJ &     = comlev1_bibj, key = ikey, byte = isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
   
 #endif  
   
 C--      Implicit Vertical Diffusion for Convection  
          IF (ivdc_kappa.NE.0.) THEN  
             CALL CALC_IVDC(  
      I       bi,bj,iMin,iMax,jMin,jMax,k+1,rhoKm1,rhoKp1,  
      U       ConvectCount, KappaRT, KappaRS,  
      I       myTime,myIter,myThid)  
          ENDIF  
   
 C--      Recompute density after mixing  
 #ifdef  INCLUDE_FIND_RHO_CALL  
          CALL FIND_RHO(  
      I      bi, bj, iMin, iMax, jMin, jMax, k, k, eosType,  
      O      rhoKm1,  
      I      myThid )  
 #endif  
         ENDIF  
   
 C--     Calculate buoyancy  
         CALL CALC_BUOYANCY(  
      I      bi,bj,iMin,iMax,jMin,jMax,k,rhoKm1,  
      O      buoyKm1,  
      I      myThid )  
   
 C--     Integrate hydrostatic balance for phiHyd with BC of  
 C--     phiHyd(z=0)=0  
         CALL CALC_PHI_HYD(  
      I      bi,bj,iMin,iMax,jMin,jMax,k,buoyKm1,buoyKm1,  
      U      phiHyd,  
      I      myThid )  
   
 #ifdef ALLOW_GMREDI  
         IF ( useGMRedi ) THEN  
         CALL GRAD_SIGMA(  
      I            bi, bj, iMin, iMax, jMin, jMax, k,  
      I            rhoKm1, rhoKm1, rhoKm1,  
      O            sigmaX, sigmaY, sigmaR,  
      I            myThid )  
         ELSE  
          DO j=1-OLy,sNy+OLy  
           DO i=1-OLx,sNx+OLx  
            sigmaX(i,j,k) = 0. _d 0  
            sigmaY(i,j,k) = 0. _d 0  
            sigmaR(i,j,k) = 0. _d 0  
           ENDDO  
          ENDDO  
         ENDIF  
 #endif  
   
 C--     Start of downward loop  
         DO k=2,Nr  
   
 #ifdef ALLOW_AUTODIFF_TAMC  
          kkey = (ikey-1)*(Nr-2+1) + (k-2) + 1  
 #endif /* ALLOW_AUTODIFF_TAMC */  
   
          BOTTOM_LAYER = k .EQ. Nr  
   
 #ifdef DO_PIPELINED_CORRECTION_STEP  
          IF ( .NOT. BOTTOM_LAYER ) THEN  
 C--       Update fields in layer below according to tendency terms  
           CALL CORRECTION_STEP(  
      I         bi,bj,iMin,iMax,jMin,jMax,k+1,  
      I         etaSurfX,etaSurfY,myTime,myThid)  
 #ifdef ALLOW_OBCS  
           IF (openBoundaries) THEN  
276  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
277  CADJ STORE uvel (:,:,k,bi,bj) = comlev1_bibj_k  cph(
278  CADJ &   , key = kkey, byte = isbyte  c--   need some re-initialisation here to break dependencies
 CADJ STORE vvel (:,:,k,bi,bj) = comlev1_bibj_k  
 CADJ &   , key = kkey, byte = isbyte  
 CADJ STORE theta(:,:,k,bi,bj) = comlev1_bibj_k  
 CADJ &   , key = kkey, byte = isbyte  
 CADJ STORE salt (:,:,k,bi,bj) = comlev1_bibj_k  
 CADJ &   , key = kkey, byte = isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
              CALL APPLY_OBCS1( bi, bj, k+1, myThid )  
           END IF  
 #endif  
          ENDIF  
 #endif /* DO_PIPELINED_CORRECTION_STEP */  
   
 C--      Density of k level (below W(k)) reference to k level  
 #ifdef  INCLUDE_FIND_RHO_CALL  
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE theta(:,:,k,bi,bj) = comlev1_bibj_k  
 CADJ &   , key = kkey, byte = isbyte  
 CADJ STORE salt (:,:,k,bi,bj) = comlev1_bibj_k  
 CADJ &   , key = kkey, byte = isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
          CALL FIND_RHO(  
      I      bi, bj, iMin, iMax, jMin, jMax,  k, k, eosType,  
      O      rhoK,  
      I      myThid )  
   
 #ifdef ALLOW_AUTODIFF_TAMC  
 cph(   storing not necessary  
 cphCADJ STORE rhoK(:,:)  = comlev1_bibj_k, key = kkey, byte = isbyte  
279  cph)  cph)
280  #endif /* ALLOW_AUTODIFF_TAMC */             gU(i,j,k,bi,bj) = 0. _d 0
281  #endif             gV(i,j,k,bi,bj) = 0. _d 0
   
          IF (.NOT. BOTTOM_LAYER) THEN  
   
 C--       Check static stability with layer below and mix as needed.  
 C--       Density of k+1 level (below W(k+1)) reference to k level.  
 #ifdef  INCLUDE_FIND_RHO_CALL  
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE theta(:,:,k+1,bi,bj) = comlev1_bibj_k  
 CADJ &   , key = kkey, byte = isbyte  
 CADJ STORE salt (:,:,k+1,bi,bj) = comlev1_bibj_k  
 CADJ &   , key = kkey, byte = isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
           CALL FIND_RHO(  
      I       bi, bj, iMin, iMax, jMin, jMax,  k+1, k, eosType,  
      O       rhoKp1,  
      I       myThid )  
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE rhoKp1(:,:) = comlev1_bibj_k, key = kkey, byte = isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
 #endif  
   
 #ifdef  INCLUDE_CONVECT_CALL  
           CALL CONVECT(  
      I        bi,bj,iMin,iMax,jMin,jMax,k+1,rhoK,rhoKp1,  
      U        ConvectCount,  
      I        myTime,myIter,myThid)  
   
 #endif  
   
 C--      Implicit Vertical Diffusion for Convection  
          IF (ivdc_kappa.NE.0.) THEN  
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE rhoKm1(:,:) = comlev1_bibj_k, key = kkey, byte = isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
             CALL CALC_IVDC(  
      I       bi,bj,iMin,iMax,jMin,jMax,k+1,rhoKm1,rhoKp1,  
      U       ConvectCount, KappaRT, KappaRS,  
      I       myTime,myIter,myThid)  
          END IF  
   
 C--       Recompute density after mixing  
 #ifdef  INCLUDE_FIND_RHO_CALL  
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE theta(:,:,k,bi,bj) = comlev1_bibj_k  
 CADJ &   , key = kkey, byte = isbyte  
 CADJ STORE salt (:,:,k,bi,bj) = comlev1_bibj_k  
 CADJ &   , key = kkey, byte = isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
           CALL FIND_RHO(  
      I       bi, bj, iMin, iMax, jMin, jMax, k, k, eosType,  
      O       rhoK,  
      I       myThid )  
 #endif  
   
 C--            IF (.NOT. BOTTOM_LAYER) ends here  
          ENDIF  
   
 C--      Calculate buoyancy  
          CALL CALC_BUOYANCY(  
      I       bi,bj,iMin,iMax,jMin,jMax,k,rhoK,  
      O       buoyK,  
      I       myThid )  
   
 C--      Integrate hydrostatic balance for phiHyd with BC of  
 C--      phiHyd(z=0)=0  
          CALL CALC_PHI_HYD(  
      I        bi,bj,iMin,iMax,jMin,jMax,k,buoyKm1,buoyK,  
      U        phiHyd,  
      I        myThid )  
   
 #ifdef  INCLUDE_FIND_RHO_CALL  
 C--      Calculate iso-neutral slopes for the GM/Redi parameterisation  
   
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE theta(:,:,k-1,bi,bj) = comlev1_bibj_k  
 CADJ &   , key = kkey, byte = isbyte  
 CADJ STORE salt (:,:,k-1,bi,bj) = comlev1_bibj_k  
 CADJ &   , key = kkey, byte = isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
   
          CALL FIND_RHO(  
      I        bi, bj, iMin, iMax, jMin, jMax, k-1, k, eosType,  
      O        rhoTmp,  
      I        myThid )  
 #endif  
   
   
 #ifdef ALLOW_GMREDI  
          IF ( useGMRedi ) THEN  
          CALL GRAD_SIGMA(  
      I             bi, bj, iMin, iMax, jMin, jMax, k,  
      I             rhoK, rhotmp, rhoK,  
      O             sigmaX, sigmaY, sigmaR,  
      I             myThid )  
          ELSE  
           DO j=1-OLy,sNy+OLy  
            DO i=1-OLx,sNx+OLx  
             sigmaX(i,j,k) = 0. _d 0  
             sigmaY(i,j,k) = 0. _d 0  
             sigmaR(i,j,k) = 0. _d 0  
            ENDDO  
           ENDDO  
          ENDIF  
 #endif  
   
          DO J=jMin,jMax  
           DO I=iMin,iMax  
 #ifdef  INCLUDE_FIND_RHO_CALL  
            rhoKm1 (I,J) = rhoK(I,J)  
282  #endif  #endif
            buoyKm1(I,J) = buoyK(I,J)  
283            ENDDO            ENDDO
284           ENDDO           ENDDO
   
 C--     end of k loop  
285          ENDDO          ENDDO
286            DO j=1-OLy,sNy+OLy
287  C     Determines forcing terms based on external fields           DO i=1-OLx,sNx+OLx
288  C     relaxation terms, etc.            fVerU  (i,j,1) = 0. _d 0
289        CALL EXTERNAL_FORCING_SURF(            fVerU  (i,j,2) = 0. _d 0
290       I             bi, bj, iMin, iMax, jMin, jMax,            fVerV  (i,j,1) = 0. _d 0
291       I             myThid )            fVerV  (i,j,2) = 0. _d 0
292              phiHydF (i,j)  = 0. _d 0
293  #ifdef ALLOW_AUTODIFF_TAMC            phiHydC (i,j)  = 0. _d 0
294              dPhiHydX(i,j)  = 0. _d 0
295  CADJ STORE surfacetendencyu(:,:,bi,bj)            dPhiHydY(i,j)  = 0. _d 0
296  CADJ &   , surfacetendencyv(:,:,bi,bj)            phiSurfX(i,j)  = 0. _d 0
297  CADJ &   , surfacetendencys(:,:,bi,bj)            phiSurfY(i,j)  = 0. _d 0
298  CADJ &   , surfacetendencyt(:,:,bi,bj)            guDissip(i,j)  = 0. _d 0
299  CADJ &                        = comlev1_bibj, key=ikey, byte=isbyte            gvDissip(i,j)  = 0. _d 0
300             ENDDO
 # ifdef ALLOW_GMREDI  
 CADJ STORE sigmaX(:,:,:) = comlev1, key=ikey, byte=isbyte  
 CADJ STORE sigmaY(:,:,:) = comlev1, key=ikey, byte=isbyte  
 CADJ STORE sigmaR(:,:,:) = comlev1, key=ikey, byte=isbyte  
 # endif /* ALLOW_GMREDI */  
   
 #endif /* ALLOW_AUTODIFF_TAMC */  
   
 #ifdef ALLOW_GMREDI  
         IF (useGMRedi) THEN  
           DO k=1, Nr  
             CALL GMREDI_CALC_TENSOR(  
      I             bi, bj, iMin, iMax, jMin, jMax, k,  
      I             sigmaX, sigmaY, sigmaR,  
      I             myThid )  
           ENDDO  
 #ifdef ALLOW_AUTODIFF_TAMC  
         ELSE  
           DO k=1, Nr  
             CALL GMREDI_CALC_TENSOR_DUMMY(  
      I             bi, bj, iMin, iMax, jMin, jMax, k,  
      I             sigmaX, sigmaY, sigmaR,  
      I             myThid )  
           ENDDO  
 #endif /* ALLOW_AUTODIFF_TAMC */  
         ENDIF  
 #endif  
   
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE KappaRT(:,:,:)     = comlev1_bibj, key=ikey, byte=isbyte  
 CADJ STORE KappaRS(:,:,:)     = comlev1_bibj, key=ikey, byte=isbyte  
   
 #ifdef ALLOW_GMREDI  
 C-- R.G. We need to define a new tape since Kw use mythid instead of bi,bj  
 CADJ STORE Kwx(:,:,:,myThid)  = comlev1_bibj, key=ikey, byte=isbyte  
 CADJ STORE Kwy(:,:,:,myThid)  = comlev1_bibj, key=ikey, byte=isbyte  
 CADJ STORE Kwz(:,:,:,myThid)  = comlev1_bibj, key=ikey, byte=isbyte  
 #endif  
   
 CADJ STORE theta(:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte  
 CADJ STORE salt (:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte  
 CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte  
 CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte  
 =======  
 C-- R.G. We need to define a new tape since Kw use mythid instead of bi,bj  
 CADJ STORE Kwx(:,:,:,myThid)  = comlev1_bibj, key=ikey, byte=isbyte  
 CADJ STORE Kwy(:,:,:,myThid)  = comlev1_bibj, key=ikey, byte=isbyte  
 CADJ STORE Kwz(:,:,:,myThid)  = comlev1_bibj, key=ikey, byte=isbyte  
   
 CADJ STORE theta(:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte  
 CADJ STORE salt (:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte  
 CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte  
 CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte  
   
 C--     dummy initialization to break data flow because  
 C--     calc_div_ghat has a condition for initialization  
         DO J=jMin,jMax  
            DO I=iMin,iMax  
               cg2d_b(i,j,bi,bj) = 0.0  
            ENDDO  
301          ENDDO          ENDDO
 #endif /* ALLOW_AUTODIFF_TAMC */  
302    
303  #ifdef ALLOW_KPP  C--     Start computation of dynamics
304  C--   Compute KPP mixing coefficients          iMin = 0
305          IF (useKPP) THEN          iMax = sNx+1
306            jMin = 0
307            CALL TIMER_START('KPP_CALC               [DYNAMICS]', myThid)          jMax = sNy+1
308            CALL KPP_CALC(  
309       I                  bi, bj, myTime, myThid )  #ifdef ALLOW_AUTODIFF_TAMC
310            CALL TIMER_STOP ('KPP_CALC               [DYNAMICS]', myThid)  CADJ STORE wvel (:,:,:,bi,bj) =
311    CADJ &     comlev1_bibj, key = idynkey, byte = isbyte
312  #ifdef ALLOW_AUTODIFF_TAMC  #endif /* ALLOW_AUTODIFF_TAMC */
313          ELSE  
314            DO j=1-OLy,sNy+OLy  C--     Explicit part of the Surface Potentiel Gradient (add in TIMESTEP)
315              DO i=1-OLx,sNx+OLx  C       (note: this loop will be replaced by CALL CALC_GRAD_ETA)
316                KPPhbl (i,j,bi,bj) = 1.0          IF (implicSurfPress.NE.1.) THEN
317                KPPfrac(i,j,bi,bj) = 0.0            CALL CALC_GRAD_PHI_SURF(
318                DO k = 1,Nr       I         bi,bj,iMin,iMax,jMin,jMax,
319                   KPPghat   (i,j,k,bi,bj) = 0.0       I         etaN,
320                   KPPviscAz (i,j,k,bi,bj) = viscAz       O         phiSurfX,phiSurfY,
321                   KPPdiffKzT(i,j,k,bi,bj) = diffKzT       I         myThid )                        
                  KPPdiffKzS(i,j,k,bi,bj) = diffKzS  
               ENDDO  
             ENDDO  
           ENDDO  
 #endif /* ALLOW_AUTODIFF_TAMC */  
322          ENDIF          ENDIF
323    
324  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
325  CADJ STORE KPPghat   (:,:,:,bi,bj)  CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key=idynkey, byte=isbyte
326  CADJ &   , KPPviscAz (:,:,:,bi,bj)  CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key=idynkey, byte=isbyte
327  CADJ &   , KPPdiffKzT(:,:,:,bi,bj)  #ifdef ALLOW_KPP
328  CADJ &   , KPPdiffKzS(:,:,:,bi,bj)  CADJ STORE KPPviscAz (:,:,:,bi,bj)
329  CADJ &   , KPPfrac   (:,:  ,bi,bj)  CADJ &                 = comlev1_bibj, key=idynkey, byte=isbyte
 CADJ &                 = comlev1_bibj, key=ikey, byte=isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
   
330  #endif /* ALLOW_KPP */  #endif /* ALLOW_KPP */
   
 C--     Start of upward loop  
         DO k = Nr, 1, -1  
   
 C--      km1    Points to level above k (=k-1)  
 C--      kup    Cycles through 1,2 to point to layer above  
 C--      kDown  Cycles through 2,1 to point to current layer  
   
          km1  =max(1,k-1)  
          kup  =1+MOD(k+1,2)  
          kDown=1+MOD(k,2)  
   
          iMin = 1-OLx+2  
          iMax = sNx+OLx-1  
          jMin = 1-OLy+2  
          jMax = sNy+OLy-1  
   
 #ifdef ALLOW_AUTODIFF_TAMC  
          kkey = (ikey-1)*(Nr-1+1) + (k-1) + 1  
 CADJ STORE rvel  (:,:,kdown)  = comlev1_bibj_k, key=kkey, byte=isbyte  
 CADJ STORE rTrans(:,:)        = comlev1_bibj_k, key=kkey, byte=isbyte  
 CADJ STORE KappaRT(:,:,k)     = comlev1_bibj_k, key=kkey, byte=isbyte  
 CADJ STORE KappaRS(:,:,k)     = comlev1_bibj_k, key=kkey, byte=isbyte  
331  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
332    
 C--      Get temporary terms used by tendency routines  
          CALL CALC_COMMON_FACTORS (  
      I        bi,bj,iMin,iMax,jMin,jMax,k,km1,kup,kDown,  
      O        xA,yA,uTrans,vTrans,rTrans,rVel,maskC,maskUp,  
      I        myThid)  
   
 #ifdef ALLOW_OBCS  
         IF (openBoundaries) THEN  
          CALL APPLY_OBCS3( bi, bj, k, kup, rTrans, rVel, myThid )  
         ENDIF  
 #endif  
   
333  #ifdef  INCLUDE_CALC_DIFFUSIVITY_CALL  #ifdef  INCLUDE_CALC_DIFFUSIVITY_CALL
334  C--      Calculate the total vertical diffusivity  C--      Calculate the total vertical diffusivity
335           CALL CALC_DIFFUSIVITY(          DO k=1,Nr
336             CALL CALC_VISCOSITY(
337       I        bi,bj,iMin,iMax,jMin,jMax,k,       I        bi,bj,iMin,iMax,jMin,jMax,k,
338       I        maskC,maskUp,       O        KappaRU,KappaRV,
      O        KappaRT,KappaRS,KappaRU,KappaRV,  
339       I        myThid)       I        myThid)
340           ENDDO
341  #endif  #endif
 C--      Calculate accelerations in the momentum equations  
          IF ( momStepping ) THEN  
           CALL CALC_MOM_RHS(  
      I         bi,bj,iMin,iMax,jMin,jMax,k,km1,kup,kDown,  
      I         xA,yA,uTrans,vTrans,rTrans,rVel,maskC,  
      I         phiHyd,KappaRU,KappaRV,  
      U         aTerm,xTerm,cTerm,mTerm,pTerm,  
      U         fZon, fMer, fVerU, fVerV,  
      I         myTime, myThid)  
 #ifdef ALLOW_AUTODIFF_TAMC  
 #ifdef INCLUDE_CD_CODE  
          ELSE  
             DO j=1-OLy,sNy+OLy  
                DO i=1-OLx,sNx+OLx  
                   guCD(i,j,k,bi,bj) = 0.0  
                   gvCD(i,j,k,bi,bj) = 0.0  
                END DO  
             END DO  
 #endif  
 #endif /* ALLOW_AUTODIFF_TAMC */  
          ENDIF  
 C--      Calculate active tracer tendencies  
          IF ( tempStepping ) THEN  
           CALL CALC_GT(  
      I         bi,bj,iMin,iMax,jMin,jMax, k,km1,kup,kDown,  
      I         xA,yA,uTrans,vTrans,rTrans,maskUp,maskC,  
      I         KappaRT,  
      U         aTerm,xTerm,fZon,fMer,fVerT,  
      I         myTime, myThid)  
          ENDIF  
          IF ( saltStepping ) THEN  
           CALL CALC_GS(  
      I         bi,bj,iMin,iMax,jMin,jMax, k,km1,kup,kDown,  
      I         xA,yA,uTrans,vTrans,rTrans,maskUp,maskC,  
      I         KappaRS,  
      U         aTerm,xTerm,fZon,fMer,fVerS,  
      I         myTime, myThid)  
          ENDIF  
 #ifdef ALLOW_OBCS  
 C--      Calculate future values on open boundaries  
          IF (openBoundaries) THEN  
 Caja      CALL CYCLE_OBCS( k, bi, bj, myThid )  
           CALL SET_OBCS( k, bi, bj, myTime+deltaTclock, myThid )  
          ENDIF  
 #endif  
 C--      Prediction step (step forward all model variables)  
          CALL TIMESTEP(  
      I       bi,bj,iMin,iMax,jMin,jMax,k,  
      I       myIter, myThid)  
 #ifdef ALLOW_OBCS  
 C--      Apply open boundary conditions  
          IF (openBoundaries) THEN  
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE gunm1(:,:,k,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte  
 CADJ STORE gvnm1(:,:,k,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte  
 CADJ STORE gwnm1(:,:,k,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
342    
             CALL APPLY_OBCS2( bi, bj, k, myThid )  
          END IF  
 #endif  
 C--      Freeze water  
          IF (allowFreezing) THEN  
343  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
344  CADJ STORE gTNm1(:,:,k,bi,bj) = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ STORE KappaRU(:,:,:)
345    CADJ &                 = comlev1_bibj, key=idynkey, byte=isbyte
346    CADJ STORE KappaRV(:,:,:)
347    CADJ &                 = comlev1_bibj, key=idynkey, byte=isbyte
348  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
             CALL FREEZE( bi, bj, iMin, iMax, jMin, jMax, k, myThid )  
          END IF  
   
 #ifdef DIVG_IN_DYNAMICS  
 C--      Diagnose barotropic divergence of predicted fields  
          CALL CALC_DIV_GHAT(  
      I       bi,bj,iMin,iMax,jMin,jMax,k,  
      I       xA,yA,  
      I       myThid)  
 #endif /* DIVG_IN_DYNAMICS */  
   
 C--      Cumulative diagnostic calculations (ie. time-averaging)  
 #ifdef INCLUDE_DIAGNOSTICS_INTERFACE_CODE  
          IF (taveFreq.GT.0.) THEN  
           CALL DO_TIME_AVERAGES(  
      I                           myTime, myIter, bi, bj, k, kup, kDown,  
      I                           rVel, ConvectCount,  
      I                           myThid )  
          ENDIF  
 #endif  
349    
350    C--     Start of dynamics loop
351            DO k=1,Nr
352    
353  C--     k loop  C--       km1    Points to level above k (=k-1)
354          ENDDO  C--       kup    Cycles through 1,2 to point to layer above
355    C--       kDown  Cycles through 2,1 to point to current layer
356    
357              km1  = MAX(1,k-1)
358              kp1  = MIN(k+1,Nr)
359              kup  = 1+MOD(k+1,2)
360              kDown= 1+MOD(k,2)
361    
362  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
363             maximpl = 6           kkey = (idynkey-1)*Nr + k
364             iikey = (ikey-1)*maximpl  c
365    CADJ STORE totphihyd (:,:,k,bi,bj)
366    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
367    CADJ STORE theta (:,:,k,bi,bj)
368    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
369    CADJ STORE salt  (:,:,k,bi,bj)
370    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
371    # ifdef NONLIN_FRSURF
372    cph-test
373    CADJ STORE  phiHydC (:,:)
374    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
375    CADJ STORE  phiHydF (:,:)
376    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
377    CADJ STORE  gudissip (:,:)
378    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
379    CADJ STORE  gvdissip (:,:)
380    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
381    CADJ STORE  fVerU (:,:,:)
382    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
383    CADJ STORE  fVerV (:,:,:)
384    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
385    CADJ STORE gu(:,:,k,bi,bj)
386    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
387    CADJ STORE gv(:,:,k,bi,bj)
388    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
389    CADJ STORE gunm1(:,:,k,bi,bj)
390    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
391    CADJ STORE gvnm1(:,:,k,bi,bj)
392    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
393    #  ifdef ALLOW_CD_CODE
394    CADJ STORE unm1(:,:,k,bi,bj)
395    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
396    CADJ STORE vnm1(:,:,k,bi,bj)
397    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
398    CADJ STORE uVelD(:,:,k,bi,bj)
399    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
400    CADJ STORE vVelD(:,:,k,bi,bj)
401    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
402    #  endif
403    # endif
404  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
405    
406  C--     Implicit diffusion  C--      Integrate hydrostatic balance for phiHyd with BC of
407          IF (implicitDiffusion) THEN  C        phiHyd(z=0)=0
408             CALL CALC_PHI_HYD(
409         I        bi,bj,iMin,iMax,jMin,jMax,k,
410         I        theta, salt,
411         U        phiHydF,
412         O        phiHydC, dPhiHydX, dPhiHydY,
413         I        myTime, myIter, myThid )
414    
415           IF (tempStepping) THEN  C--      Calculate accelerations in the momentum equations (gU, gV, ...)
416  #ifdef ALLOW_AUTODIFF_TAMC  C        and step forward storing the result in gU, gV, etc...
417              idkey = iikey + 1           IF ( momStepping ) THEN
418  CADJ STORE gTNm1(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte  #ifdef ALLOW_MOM_FLUXFORM
419  #endif /* ALLOW_AUTODIFF_TAMC */             IF (.NOT. vectorInvariantMomentum) CALL MOM_FLUXFORM(
420              CALL IMPLDIFF(       I         bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown,
421       I         bi, bj, iMin, iMax, jMin, jMax,       I         KappaRU, KappaRV,
422       I         deltaTtracer, KappaRT,recip_HFacC,       U         fVerU, fVerV,
423       U         gTNm1,       O         guDissip, gvDissip,
424       I         myThid )       I         myTime, myIter, myThid)
425           END IF  #endif
426    #ifdef ALLOW_MOM_VECINV
427               IF (vectorInvariantMomentum) THEN
428    C
429    # ifdef ALLOW_AUTODIFF_TAMC
430    #  ifdef NONLIN_FRSURF
431    CADJ STORE fVerU(:,:,:)
432    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
433    CADJ STORE fVerV(:,:,:)
434    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
435    #  endif
436    # endif /* ALLOW_AUTODIFF_TAMC */
437    C
438                 CALL MOM_VECINV(
439         I         bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown,
440         I         KappaRU, KappaRV,
441         U         fVerU, fVerV,
442         O         guDissip, gvDissip,
443         I         myTime, myIter, myThid)
444               ENDIF
445    #endif
446               CALL TIMESTEP(
447         I         bi,bj,iMin,iMax,jMin,jMax,k,
448         I         dPhiHydX,dPhiHydY, phiSurfX, phiSurfY,
449         I         guDissip, gvDissip,
450         I         myTime, myIter, myThid)
451    
452           IF (saltStepping) THEN  #ifdef   ALLOW_OBCS
453  #ifdef ALLOW_AUTODIFF_TAMC  C--      Apply open boundary conditions
454           idkey = iikey + 2             IF (useOBCS) THEN
455  CADJ STORE gSNm1(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte               CALL OBCS_APPLY_UV( bi, bj, k, gU, gV, myThid )
456  #endif /* ALLOW_AUTODIFF_TAMC */             ENDIF
457              CALL IMPLDIFF(  #endif   /* ALLOW_OBCS */
      I         bi, bj, iMin, iMax, jMin, jMax,  
      I         deltaTtracer, KappaRS,recip_HFacC,  
      U         gSNm1,  
      I         myThid )  
          END IF  
458    
459  C--     implicitDiffusion           ENDIF
         ENDIF  
460    
 C--     Implicit viscosity  
         IF (implicitViscosity) THEN  
461    
462           IF (momStepping) THEN  C--     end of dynamics k loop (1:Nr)
463  #ifdef ALLOW_AUTODIFF_TAMC          ENDDO
464           idkey = iikey + 3  
465  CADJ STORE gUNm1(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte  C--     Implicit Vertical advection & viscosity
466  #endif /* ALLOW_AUTODIFF_TAMC */  #ifdef INCLUDE_IMPLVERTADV_CODE
467            IF ( momImplVertAdv ) THEN
468              CALL MOM_U_IMPLICIT_R( kappaRU,
469         I                           bi, bj, myTime, myIter, myThid )
470              CALL MOM_V_IMPLICIT_R( kappaRV,
471         I                           bi, bj, myTime, myIter, myThid )
472            ELSEIF ( implicitViscosity ) THEN
473    #else /* INCLUDE_IMPLVERTADV_CODE */
474            IF     ( implicitViscosity ) THEN
475    #endif /* INCLUDE_IMPLVERTADV_CODE */
476    #ifdef    ALLOW_AUTODIFF_TAMC
477    CADJ STORE KappaRU(:,:,:) = comlev1_bibj , key=idynkey, byte=isbyte
478    CADJ STORE gU(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte
479    #endif    /* ALLOW_AUTODIFF_TAMC */
480            CALL IMPLDIFF(            CALL IMPLDIFF(
481       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
482       I         deltaTmom, KappaRU,recip_HFacW,       I         -1, KappaRU,recip_HFacW,
483       U         gUNm1,       U         gU,
484       I         myThid )       I         myThid )
485  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef    ALLOW_AUTODIFF_TAMC
486           idkey = iikey + 4  CADJ STORE KappaRV(:,:,:) = comlev1_bibj , key=idynkey, byte=isbyte
487  CADJ STORE gVNm1(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte  CADJ STORE gV(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte
488  #endif /* ALLOW_AUTODIFF_TAMC */  #endif    /* ALLOW_AUTODIFF_TAMC */
489            CALL IMPLDIFF(            CALL IMPLDIFF(
490       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
491       I         deltaTmom, KappaRV,recip_HFacS,       I         -2, KappaRV,recip_HFacS,
492       U         gVNm1,       U         gV,
493       I         myThid )       I         myThid )
494            ENDIF
495    
496  #ifdef INCLUDE_CD_CODE  #ifdef   ALLOW_OBCS
497    C--      Apply open boundary conditions
498            IF ( useOBCS .AND.(implicitViscosity.OR.momImplVertAdv) ) THEN
499               DO K=1,Nr
500                 CALL OBCS_APPLY_UV( bi, bj, k, gU, gV, myThid )
501               ENDDO
502            ENDIF
503    #endif   /* ALLOW_OBCS */
504    
505  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef    ALLOW_CD_CODE
506           idkey = iikey + 5          IF (implicitViscosity.AND.useCDscheme) THEN
507  CADJ STORE vVelD(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte  #ifdef    ALLOW_AUTODIFF_TAMC
508  #endif /* ALLOW_AUTODIFF_TAMC */  CADJ STORE vVelD(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte
509    #endif    /* ALLOW_AUTODIFF_TAMC */
510            CALL IMPLDIFF(            CALL IMPLDIFF(
511       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
512       I         deltaTmom, KappaRU,recip_HFacW,       I         0, KappaRU,recip_HFacW,
513       U         vVelD,       U         vVelD,
514       I         myThid )       I         myThid )
515  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef    ALLOW_AUTODIFF_TAMC
516          idkey = iikey + 6  CADJ STORE uVelD(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte
517  CADJ STORE uVelD(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte  #endif    /* ALLOW_AUTODIFF_TAMC */
 #endif /* ALLOW_AUTODIFF_TAMC */  
518            CALL IMPLDIFF(            CALL IMPLDIFF(
519       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
520       I         deltaTmom, KappaRV,recip_HFacS,       I         0, KappaRV,recip_HFacS,
521       U         uVelD,       U         uVelD,
522       I         myThid )       I         myThid )
   
 #endif  
   
 C--      momStepping  
          ENDIF  
   
 C--     implicitViscosity  
523          ENDIF          ENDIF
524    #endif    /* ALLOW_CD_CODE */
525    C--     End implicit Vertical advection & viscosity
526    
527         ENDDO         ENDDO
528        ENDDO        ENDDO
529    
530    #ifdef ALLOW_OBCS
531          IF (useOBCS) THEN
532           CALL OBCS_PRESCRIBE_EXCHANGES(myThid)
533          ENDIF
534    #endif
535    
536    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
537    
538    #ifdef ALLOW_NONHYDROSTATIC
539    C--   Step forward W field in N-H algorithm
540          IF ( momStepping .AND. nonHydrostatic ) THEN
541    #ifdef ALLOW_DEBUG
542             IF ( debugLevel .GE. debLevB )
543         &     CALL DEBUG_CALL('CALC_GW', myThid )
544    #endif
545             CALL TIMER_START('CALC_GW          [DYNAMICS]',myThid)
546             CALL CALC_GW( myTime, myIter, myThid )
547             CALL TIMER_STOP ('CALC_GW          [DYNAMICS]',myThid)
548          ENDIF
549    #endif
550    
551    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
552    
553    Cml(
554    C     In order to compare the variance of phiHydLow of a p/z-coordinate
555    C     run with etaH of a z/p-coordinate run the drift of phiHydLow
556    C     has to be removed by something like the following subroutine:
557    C      CALL REMOVE_MEAN_RL( 1, phiHydLow, maskH, maskH, rA, drF,
558    C     &                'phiHydLow', myThid )
559    Cml)
560    
561    #ifdef ALLOW_DIAGNOSTICS
562          IF ( usediagnostics ) THEN
563    
564           CALL DIAGNOSTICS_FILL(totPhihyd,'PHIHYD  ',0,Nr,0,1,1,myThid)
565           CALL DIAGNOSTICS_FILL(phiHydLow,'PHIBOT  ',0, 1,0,1,1,myThid)
566    
567           tmpFac = 1. _d 0
568           CALL DIAGNOSTICS_SCALE_FILL(totPhihyd,tmpFac,2,
569         &                                 'PHIHYDSQ',0,Nr,0,1,1,myThid)
570    
571           CALL DIAGNOSTICS_SCALE_FILL(phiHydLow,tmpFac,2,
572         &                                 'PHIBOTSQ',0, 1,0,1,1,myThid)
573    
574          ENDIF
575    #endif /* ALLOW_DIAGNOSTICS */
576          
577    #ifdef ALLOW_DEBUG
578          If ( debugLevel .GE. debLevB ) THEN
579           CALL DEBUG_STATS_RL(1,EtaN,'EtaN (DYNAMICS)',myThid)
580           CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (DYNAMICS)',myThid)
581           CALL DEBUG_STATS_RL(Nr,vVel,'Vvel (DYNAMICS)',myThid)
582           CALL DEBUG_STATS_RL(Nr,wVel,'Wvel (DYNAMICS)',myThid)
583           CALL DEBUG_STATS_RL(Nr,theta,'Theta (DYNAMICS)',myThid)
584           CALL DEBUG_STATS_RL(Nr,salt,'Salt (DYNAMICS)',myThid)
585           CALL DEBUG_STATS_RL(Nr,gU,'Gu (DYNAMICS)',myThid)
586           CALL DEBUG_STATS_RL(Nr,gV,'Gv (DYNAMICS)',myThid)
587           CALL DEBUG_STATS_RL(Nr,gT,'Gt (DYNAMICS)',myThid)
588           CALL DEBUG_STATS_RL(Nr,gS,'Gs (DYNAMICS)',myThid)
589    #ifndef ALLOW_ADAMSBASHFORTH_3
590           CALL DEBUG_STATS_RL(Nr,guNm1,'GuNm1 (DYNAMICS)',myThid)
591           CALL DEBUG_STATS_RL(Nr,gvNm1,'GvNm1 (DYNAMICS)',myThid)
592           CALL DEBUG_STATS_RL(Nr,gtNm1,'GtNm1 (DYNAMICS)',myThid)
593           CALL DEBUG_STATS_RL(Nr,gsNm1,'GsNm1 (DYNAMICS)',myThid)
594    #endif
595          ENDIF
596    #endif
597    
598    #ifdef DYNAMICS_GUGV_EXCH_CHECK
599    C- jmc: For safety checking only: This Exchange here should not change
600    C       the solution. If solution changes, it means something is wrong,
601    C       but it does not mean that it is less wrong with this exchange.
602          IF ( debugLevel .GT. debLevB ) THEN
603           CALL EXCH_UV_XYZ_RL(gU,gV,.TRUE.,myThid)
604          ENDIF
605    #endif
606    
607    #ifdef ALLOW_DEBUG
608          IF ( debugLevel .GE. debLevB )
609         &   CALL DEBUG_LEAVE( 'DYNAMICS', myThid )
610    #endif
611    
612        RETURN        RETURN
613        END        END
Legend:
Removed from v.1.56  
changed lines
  Added in v.1.126
  ViewVC Help
Powered by ViewVC 1.1.22