/[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.59 by cnh, Sun Feb 4 14:38:47 2001 UTC revision 1.165 by jmc, Sat Aug 3 01:38:17 2013 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    #ifdef ALLOW_OBCS
7    # include "OBCS_OPTIONS.h"
8    #endif
9    
10    #undef DYNAMICS_GUGV_EXCH_CHECK
11    
12    CBOP
13    C     !ROUTINE: DYNAMICS
14    C     !INTERFACE:
15        SUBROUTINE DYNAMICS(myTime, myIter, myThid)        SUBROUTINE DYNAMICS(myTime, myIter, myThid)
16  C     /==========================================================\  C     !DESCRIPTION: \bv
17  C     | SUBROUTINE DYNAMICS                                      |  C     *==========================================================*
18  C     | o Controlling routine for the explicit part of the model |  C     | SUBROUTINE DYNAMICS
19  C     |   dynamics.                                              |  C     | o Controlling routine for the explicit part of the model
20  C     |==========================================================|  C     |   dynamics.
21  C     | This routine evaluates the "dynamics" terms for each     |  C     *==========================================================*
22  C     | block of ocean in turn. Because the blocks of ocean have |  C     | This routine evaluates the "dynamics" terms for each
23  C     | overlap regions they are independent of one another.     |  C     | block of ocean in turn. Because the blocks of ocean have
24  C     | If terms involving lateral integrals are needed in this  |  C     | overlap regions they are independent of one another.
25  C     | routine care will be needed. Similarly finite-difference |  C     | If terms involving lateral integrals are needed in this
26  C     | operations with stencils wider than the overlap region   |  C     | routine care will be needed. Similarly finite-difference
27  C     | require special consideration.                           |  C     | operations with stencils wider than the overlap region
28  C     | Notes                                                    |  C     | require special consideration.
29  C     | =====                                                    |  C     | The algorithm...
30  C     | C*P* comments indicating place holders for which code is |  C     |
31  C     |      presently being developed.                          |  C     | "Correction Step"
32  C     \==========================================================/  C     | =================
33    C     | Here we update the horizontal velocities with the surface
34    C     | pressure such that the resulting flow is either consistent
35    C     | with the free-surface evolution or the rigid-lid:
36    C     |   U[n] = U* + dt x d/dx P
37    C     |   V[n] = V* + dt x d/dy P
38    C     |   W[n] = W* + dt x d/dz P  (NH mode)
39    C     |
40    C     | "Calculation of Gs"
41    C     | ===================
42    C     | This is where all the accelerations and tendencies (ie.
43    C     | physics, parameterizations etc...) are calculated
44    C     |   rho = rho ( theta[n], salt[n] )
45    C     |   b   = b(rho, theta)
46    C     |   K31 = K31 ( rho )
47    C     |   Gu[n] = Gu( u[n], v[n], wVel, b, ... )
48    C     |   Gv[n] = Gv( u[n], v[n], wVel, b, ... )
49    C     |   Gt[n] = Gt( theta[n], u[n], v[n], wVel, K31, ... )
50    C     |   Gs[n] = Gs( salt[n], u[n], v[n], wVel, K31, ... )
51    C     |
52    C     | "Time-stepping" or "Prediction"
53    C     | ================================
54    C     | The models variables are stepped forward with the appropriate
55    C     | time-stepping scheme (currently we use Adams-Bashforth II)
56    C     | - For momentum, the result is always *only* a "prediction"
57    C     | in that the flow may be divergent and will be "corrected"
58    C     | later with a surface pressure gradient.
59    C     | - Normally for tracers the result is the new field at time
60    C     | level [n+1} *BUT* in the case of implicit diffusion the result
61    C     | is also *only* a prediction.
62    C     | - We denote "predictors" with an asterisk (*).
63    C     |   U* = U[n] + dt x ( 3/2 Gu[n] - 1/2 Gu[n-1] )
64    C     |   V* = V[n] + dt x ( 3/2 Gv[n] - 1/2 Gv[n-1] )
65    C     |   theta[n+1] = theta[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
66    C     |   salt[n+1] = salt[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
67    C     | With implicit diffusion:
68    C     |   theta* = theta[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
69    C     |   salt* = salt[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
70    C     |   (1 + dt * K * d_zz) theta[n] = theta*
71    C     |   (1 + dt * K * d_zz) salt[n] = salt*
72    C     |
73    C     *==========================================================*
74    C     \ev
75    C     !USES:
76        IMPLICIT NONE        IMPLICIT NONE
   
77  C     == Global variables ===  C     == Global variables ===
78  #include "SIZE.h"  #include "SIZE.h"
79  #include "EEPARAMS.h"  #include "EEPARAMS.h"
 #include "CG2D.h"  
80  #include "PARAMS.h"  #include "PARAMS.h"
 #include "DYNVARS.h"  
81  #include "GRID.h"  #include "GRID.h"
82    #include "DYNVARS.h"
83    #ifdef ALLOW_CD_CODE
84    # include "CD_CODE_VARS.h"
85    #endif
86  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
87  # include "tamc.h"  # include "tamc.h"
88  # include "tamc_keys.h"  # include "tamc_keys.h"
89  #endif /* ALLOW_AUTODIFF_TAMC */  # include "FFIELDS.h"
90    # include "EOS.h"
91  #ifdef ALLOW_KPP  # ifdef ALLOW_KPP
92  # include "KPP.h"  #  include "KPP.h"
93  #endif  # endif
94    # ifdef ALLOW_PTRACERS
95    #  include "PTRACERS_SIZE.h"
96    #  include "PTRACERS_FIELDS.h"
97    # endif
98    # ifdef ALLOW_OBCS
99    #  include "OBCS_PARAMS.h"
100    #  include "OBCS_FIELDS.h"
101    #  ifdef ALLOW_PTRACERS
102    #   include "OBCS_PTRACERS.h"
103    #  endif
104    # endif
105    # ifdef ALLOW_MOM_FLUXFORM
106    #  include "MOM_FLUXFORM.h"
107    # endif
108    #endif /* ALLOW_AUTODIFF_TAMC */
109    
110    C     !CALLING SEQUENCE:
111    C     DYNAMICS()
112    C      |
113    C      |-- CALC_EP_FORCING
114    C      |
115    C      |-- CALC_GRAD_PHI_SURF
116    C      |
117    C      |-- CALC_VISCOSITY
118    C      |
119    C      |-- CALC_PHI_HYD
120    C      |
121    C      |-- MOM_FLUXFORM
122    C      |
123    C      |-- MOM_VECINV
124    C      |
125    C      |-- TIMESTEP
126    C      |
127    C      |-- MOM_U_IMPLICIT_R
128    C      |-- MOM_V_IMPLICIT_R
129    C      |
130    C      |-- IMPLDIFF
131    C      |
132    C      |-- OBCS_APPLY_UV
133    C      |
134    C      |-- CALC_GW
135    C      |
136    C      |-- DIAGNOSTICS_FILL
137    C      |-- DEBUG_STATS_RL
138    
139    C     !INPUT/OUTPUT PARAMETERS:
140  C     == Routine arguments ==  C     == Routine arguments ==
141  C     myTime - Current time in simulation  C     myTime :: Current time in simulation
142  C     myIter - Current iteration number in simulation  C     myIter :: Current iteration number in simulation
143  C     myThid - Thread number for this instance of the routine.  C     myThid :: Thread number for this instance of the routine.
144        _RL myTime        _RL myTime
145        INTEGER myIter        INTEGER myIter
146        INTEGER myThid        INTEGER myThid
147    
148    C     !FUNCTIONS:
149    #ifdef ALLOW_DIAGNOSTICS
150          LOGICAL  DIAGNOSTICS_IS_ON
151          EXTERNAL DIAGNOSTICS_IS_ON
152    #endif
153    
154    C     !LOCAL VARIABLES:
155  C     == Local variables  C     == Local variables
156  C     xA, yA                 - Per block temporaries holding face areas  C     fVer[UV]               o fVer: Vertical flux term - note fVer
157  C     uTrans, vTrans, rTrans - Per block temporaries holding flow  C                                    is "pipelined" in the vertical
158  C                              transport  C                                    so we need an fVer for each
159  C     rVel                     o uTrans: Zonal transport  C                                    variable.
160  C                              o vTrans: Meridional transport  C     phiHydC    :: hydrostatic potential anomaly at cell center
161  C                              o rTrans: Vertical transport  C                   In z coords phiHyd is the hydrostatic potential
162  C                              o rVel:   Vertical velocity at upper and  C                      (=pressure/rho0) anomaly
163  C                                        lower cell faces.  C                   In p coords phiHyd is the geopotential height anomaly.
164  C     maskC,maskUp             o maskC: land/water mask for tracer cells  C     phiHydF    :: hydrostatic potential anomaly at middle between 2 centers
165  C                              o maskUp: land/water mask for W points  C     dPhiHydX,Y :: Gradient (X & Y directions) of hydrostatic potential anom.
166  C     fVer[STUV]               o fVer: Vertical flux term - note fVer  C     phiSurfX,  ::  gradient of Surface potential (Pressure/rho, ocean)
167  C                                      is "pipelined" in the vertical  C     phiSurfY             or geopotential (atmos) in X and Y direction
168  C                                      so we need an fVer for each  C     guDissip   :: dissipation tendency (all explicit terms), u component
169  C                                      variable.  C     gvDissip   :: dissipation tendency (all explicit terms), v component
170  C     rhoK, rhoKM1   - Density at current level, and level above  C     KappaRU    :: vertical viscosity for velocity U-component
171  C     phiHyd         - Hydrostatic part of the potential phiHydi.  C     KappaRV    :: vertical viscosity for velocity V-component
172  C                      In z coords phiHydiHyd is the hydrostatic  C     iMin, iMax :: Ranges and sub-block indices on which calculations
173  C                      pressure anomaly  C     jMin, jMax    are applied.
174  C                      In p coords phiHydiHyd is the geopotential  C     bi, bj     :: tile indices
175  C                      surface height  C     k          :: current level index
176  C                      anomaly.  C     km1, kp1   :: index of level above (k-1) and below (k+1)
177  C     etaSurfX,      - Holds surface elevation gradient in X and Y.  C     kUp, kDown :: Index for interface above and below. kUp and kDown are
178  C     etaSurfY  C                   are switched with k to be the appropriate index into fVerU,V
 C     KappaRT,       - Total diffusion in vertical for T and S.  
 C     KappaRS          (background + spatially varying, isopycnal term).  
 C     iMin, iMax     - Ranges and sub-block indices on which calculations  
 C     jMin, jMax       are applied.  
 C     bi, bj  
 C     k, kup,        - Index for layer above and below. kup and kDown  
 C     kDown, km1       are switched with layer to be the appropriate  
 C                      index into fVerTerm.  
       _RS xA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RS yA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL uTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL vTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL rTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL rVel    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)  
       _RS maskC   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RS maskUp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL fVerT   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)  
       _RL fVerS   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)  
179        _RL fVerU   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerU   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
180        _RL fVerV   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerV   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
181        _RL phiHyd  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL phiHydF (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
182        _RL rhokm1  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL phiHydC (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
183        _RL rhok    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL dPhiHydX(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
184        _RL KappaRT (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)        _RL dPhiHydY(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
185        _RL KappaRS (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)        _RL phiSurfX(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
186        _RL KappaRU (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)        _RL phiSurfY(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
187        _RL KappaRV (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)        _RL guDissip(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
188        _RL sigmaX  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL gvDissip(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
189        _RL sigmaY  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL KappaRU (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
190        _RL sigmaR  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL KappaRV (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  
191    
192        INTEGER iMin, iMax        INTEGER iMin, iMax
193        INTEGER jMin, jMax        INTEGER jMin, jMax
194        INTEGER bi, bj        INTEGER bi, bj
195        INTEGER i, j        INTEGER i, j
196        INTEGER k, km1, kup, kDown        INTEGER k, km1, kp1, kUp, kDown
   
 #ifdef ALLOW_AUTODIFF_TAMC  
       INTEGER    isbyte  
       PARAMETER( isbyte = 4 )  
197    
198        INTEGER act1, act2, act3, act4  #ifdef ALLOW_DIAGNOSTICS
199        INTEGER max1, max2, max3        LOGICAL dPhiHydDiagIsOn
200        INTEGER iikey, kkey        _RL tmpFac
201        INTEGER maximpl  #endif /* ALLOW_DIAGNOSTICS */
 #endif /* ALLOW_AUTODIFF_TAMC */  
202    
203  C---    The algorithm...  C---    The algorithm...
204  C  C
# Line 138  C       "Calculation of Gs" Line 214  C       "Calculation of Gs"
214  C       ===================  C       ===================
215  C       This is where all the accelerations and tendencies (ie.  C       This is where all the accelerations and tendencies (ie.
216  C       physics, parameterizations etc...) are calculated  C       physics, parameterizations etc...) are calculated
 C         rVel = sum_r ( div. u[n] )  
217  C         rho = rho ( theta[n], salt[n] )  C         rho = rho ( theta[n], salt[n] )
218  C         b   = b(rho, theta)  C         b   = b(rho, theta)
219  C         K31 = K31 ( rho )  C         K31 = K31 ( rho )
220  C         Gu[n] = Gu( u[n], v[n], rVel, b, ... )  C         Gu[n] = Gu( u[n], v[n], wVel, b, ... )
221  C         Gv[n] = Gv( u[n], v[n], rVel, b, ... )  C         Gv[n] = Gv( u[n], v[n], wVel, b, ... )
222  C         Gt[n] = Gt( theta[n], u[n], v[n], rVel, K31, ... )  C         Gt[n] = Gt( theta[n], u[n], v[n], wVel, K31, ... )
223  C         Gs[n] = Gs( salt[n], u[n], v[n], rVel, K31, ... )  C         Gs[n] = Gs( salt[n], u[n], v[n], wVel, K31, ... )
224  C  C
225  C       "Time-stepping" or "Prediction"  C       "Time-stepping" or "Prediction"
226  C       ================================  C       ================================
# Line 168  C         salt* = salt[n] + dt x ( 3/2 G Line 243  C         salt* = salt[n] + dt x ( 3/2 G
243  C         (1 + dt * K * d_zz) theta[n] = theta*  C         (1 + dt * K * d_zz) theta[n] = theta*
244  C         (1 + dt * K * d_zz) salt[n] = salt*  C         (1 + dt * K * d_zz) salt[n] = salt*
245  C---  C---
246    CEOP
247    
248  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_DEBUG
249  C--   dummy statement to end declaration part        IF (debugMode) CALL DEBUG_ENTER( 'DYNAMICS', myThid )
250        ikey = 1  #endif
 #endif /* ALLOW_AUTODIFF_TAMC */  
251    
252  C--   Set up work arrays with valid (i.e. not NaN) values  #ifdef ALLOW_DIAGNOSTICS
253  C     These inital values do not alter the numerical results. They        dPhiHydDiagIsOn = .FALSE.
254  C     just ensure that all memory references are to valid floating        IF ( useDiagnostics )
255  C     point numbers. This prevents spurious hardware signals due to       &  dPhiHydDiagIsOn = DIAGNOSTICS_IS_ON( 'Um_dPHdx', myThid )
256  C     uninitialised but inert locations.       &               .OR. DIAGNOSTICS_IS_ON( 'Vm_dPHdy', myThid )
257        DO j=1-OLy,sNy+OLy  #endif
258         DO i=1-OLx,sNx+OLx  
259          xA(i,j)      = 0. _d 0  C-- Call to routine for calculation of Eliassen-Palm-flux-forced
260          yA(i,j)      = 0. _d 0  C    U-tendency, if desired:
261          uTrans(i,j)  = 0. _d 0  #ifdef INCLUDE_EP_FORCING_CODE
262          vTrans(i,j)  = 0. _d 0        CALL CALC_EP_FORCING(myThid)
263          DO k=1,Nr  #endif
          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  
         maskC  (i,j) = 0. _d 0  
        ENDDO  
       ENDDO  
264    
265    #ifdef ALLOW_AUTODIFF_MONITOR_DIAG
266          CALL DUMMY_IN_DYNAMICS( myTime, myIter, myThid )
267    #endif
268    
269  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
270  C--   HPF directive to help TAMC  C--   HPF directive to help TAMC
# Line 209  CHPF$ INDEPENDENT Line 275  CHPF$ INDEPENDENT
275    
276  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
277  C--    HPF directive to help TAMC  C--    HPF directive to help TAMC
278  CHPF$  INDEPENDENT, NEW (rTrans,rVel,fVerT,fVerS,fVerU,fVerV  CHPF$  INDEPENDENT, NEW (fVerU,fVerV
279  CHPF$&                  ,phiHyd,utrans,vtrans,maskc,xA,yA  CHPF$&                  ,phiHydF
280  CHPF$&                  ,KappaRT,KappaRS,KappaRU,KappaRV  CHPF$&                  ,KappaRU,KappaRV
281  CHPF$&                  )  CHPF$&                  )
282  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
283    
# Line 220  CHPF$&                  ) Line 286  CHPF$&                  )
286  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
287            act1 = bi - myBxLo(myThid)            act1 = bi - myBxLo(myThid)
288            max1 = myBxHi(myThid) - myBxLo(myThid) + 1            max1 = myBxHi(myThid) - myBxLo(myThid) + 1
   
289            act2 = bj - myByLo(myThid)            act2 = bj - myByLo(myThid)
290            max2 = myByHi(myThid) - myByLo(myThid) + 1            max2 = myByHi(myThid) - myByLo(myThid) + 1
   
291            act3 = myThid - 1            act3 = myThid - 1
292            max3 = nTx*nTy            max3 = nTx*nTy
   
293            act4 = ikey_dynamics - 1            act4 = ikey_dynamics - 1
294              idynkey = (act1 + 1) + act2*max1
           ikey = (act1 + 1) + act2*max1  
295       &                      + act3*max1*max2       &                      + act3*max1*max2
296       &                      + act4*max1*max2*max3       &                      + act4*max1*max2*max3
297  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
298    
299  C--     Set up work arrays that need valid initial values  C--   Set up work arrays with valid (i.e. not NaN) values
300          DO j=1-OLy,sNy+OLy  C     These initial values do not alter the numerical results. They
301           DO i=1-OLx,sNx+OLx  C     just ensure that all memory references are to valid floating
302            rTrans(i,j)   = 0. _d 0  C     point numbers. This prevents spurious hardware signals due to
303            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  
          ENDDO  
         ENDDO  
304    
305    #ifdef ALLOW_AUTODIFF_TAMC
306          DO k=1,Nr          DO k=1,Nr
307           DO j=1-OLy,sNy+OLy           DO j=1-OLy,sNy+OLy
308            DO i=1-OLx,sNx+OLx            DO i=1-OLx,sNx+OLx
309  #ifdef INCLUDE_CONVECT_CALL  cph(
310             ConvectCount(i,j,k) = 0.  c--   need some re-initialisation here to break dependencies
311  #endif  cph)
312             KappaRT(i,j,k) = 0. _d 0             gU(i,j,k,bi,bj) = 0. _d 0
313             KappaRS(i,j,k) = 0. _d 0             gV(i,j,k,bi,bj) = 0. _d 0
314            ENDDO            ENDDO
315           ENDDO           ENDDO
316          ENDDO          ENDDO
   
         iMin = 1-OLx+1  
         iMax = sNx+OLx  
         jMin = 1-OLy+1  
         jMax = sNy+OLy  
   
   
 C--     Start of diagnostic loop  
         DO k=Nr,1,-1  
   
 #ifdef ALLOW_AUTODIFF_TAMC  
 C? Patrick, is this formula correct now that we change the loop range?  
 C? Do we still need this?  
          kkey = (ikey-1)*(Nr-2+1) + (k-2) + 1  
317  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
318            DO j=1-OLy,sNy+OLy
319  C--       Integrate continuity vertically for vertical velocity           DO i=1-OLx,sNx+OLx
320            CALL INTEGRATE_FOR_W(            fVerU  (i,j,1) = 0. _d 0
321       I                         bi, bj, k, uVel, vVel,            fVerU  (i,j,2) = 0. _d 0
322       O                         wVel,            fVerV  (i,j,1) = 0. _d 0
323       I                         myThid )            fVerV  (i,j,2) = 0. _d 0
324              phiHydF (i,j)  = 0. _d 0
325  #ifdef    ALLOW_OBCS            phiHydC (i,j)  = 0. _d 0
326  #ifdef    ALLOW_NONHYDROSTATIC  #ifndef INCLUDE_PHIHYD_CALCULATION_CODE
327  C--       Calculate future values on open boundaries            dPhiHydX(i,j)  = 0. _d 0
328            IF (useOBCS.AND.nonHydrostatic) THEN            dPhiHydY(i,j)  = 0. _d 0
329              CALL OBCS_APPLY_W( bi, bj, k, wVel, myThid )  #endif
330            ENDIF            phiSurfX(i,j)  = 0. _d 0
331  #endif    /* ALLOW_NONHYDROSTATIC */            phiSurfY(i,j)  = 0. _d 0
332  #endif    /* ALLOW_OBCS */            guDissip(i,j)  = 0. _d 0
333              gvDissip(i,j)  = 0. _d 0
334  C--       Calculate gradients of potential density for isoneutral  #ifdef ALLOW_AUTODIFF_TAMC
335  C         slope terms (e.g. GM/Redi tensor or IVDC diffusivity)            phiHydLow(i,j,bi,bj) = 0. _d 0
336  c         IF ( k.GT.1 .AND. (useGMRedi.OR.ivdc_kappa.NE.0.) ) THEN  # if (defined NONLIN_FRSURF) && (defined ALLOW_MOM_FLUXFORM)
337            IF ( useGMRedi .OR. (k.GT.1 .AND. ivdc_kappa.NE.0.) ) THEN  #  ifndef DISABLE_RSTAR_CODE
338              CALL FIND_RHO(  #   ifndef ALLOW_AUTODIFF_OPENAD
339       I        bi, bj, iMin, iMax, jMin, jMax, k, k, eosType,            dWtransC(i,j,bi,bj) = 0. _d 0
340       I        theta, salt,            dWtransU(i,j,bi,bj) = 0. _d 0
341       O        rhoK,            dWtransV(i,j,bi,bj) = 0. _d 0
342       I        myThid )  #   endif
343              IF (k.GT.1) CALL FIND_RHO(  #  endif
344       I        bi, bj, iMin, iMax, jMin, jMax, k-1, k, eosType,  # endif
345       I        theta, salt,  #endif
346       O        rhoKm1,           ENDDO
      I        myThid )  
             CALL GRAD_SIGMA(  
      I             bi, bj, iMin, iMax, jMin, jMax, k,  
      I             rhoK, rhoKm1, rhoK,  
      O             sigmaX, sigmaY, sigmaR,  
      I             myThid )  
           ENDIF  
   
 C--       Implicit Vertical Diffusion for Convection  
 c ==> should use sigmaR !!!  
           IF (k.GT.1 .AND. ivdc_kappa.NE.0.) THEN  
             CALL CALC_IVDC(  
      I        bi, bj, iMin, iMax, jMin, jMax, k,  
      I        rhoKm1, rhoK,  
      U        ConvectCount, KappaRT, KappaRS,  
      I        myTime, myIter, myThid)  
           END IF  
   
 C--     end of diagnostic k loop (Nr:1)  
347          ENDDO          ENDDO
348    
349  #ifdef  ALLOW_OBCS  C--     Start computation of dynamics
350  C--     Calculate future values on open boundaries          iMin = 0
351          IF (useOBCS) THEN          iMax = sNx+1
352            CALL OBCS_CALC( bi, bj, myTime+deltaT,          jMin = 0
353       I            uVel, vVel, wVel, theta, salt,          jMax = sNy+1
354       I            myThid )  
355    #ifdef ALLOW_AUTODIFF_TAMC
356    CADJ STORE wVel (:,:,:,bi,bj) =
357    CADJ &     comlev1_bibj, key=idynkey, byte=isbyte
358    #endif /* ALLOW_AUTODIFF_TAMC */
359    
360    C--     Explicit part of the Surface Potential Gradient (add in TIMESTEP)
361    C       (note: this loop will be replaced by CALL CALC_GRAD_ETA)
362            IF (implicSurfPress.NE.1.) THEN
363              CALL CALC_GRAD_PHI_SURF(
364         I         bi,bj,iMin,iMax,jMin,jMax,
365         I         etaN,
366         O         phiSurfX,phiSurfY,
367         I         myThid )
368          ENDIF          ENDIF
 #endif  /* ALLOW_OBCS */  
369    
 C--     Determines forcing terms based on external fields  
 C       relaxation terms, etc.  
         CALL EXTERNAL_FORCING_SURF(  
      I             bi, bj, iMin, iMax, jMin, jMax,  
      I             myThid )  
   
 #ifdef  ALLOW_GMREDI  
 C--     Calculate iso-neutral slopes for the GM/Redi parameterisation  
         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  
370  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
371          ELSE  CADJ STORE uVel (:,:,:,bi,bj) = comlev1_bibj, key=idynkey, byte=isbyte
372            DO k=1, Nr  CADJ STORE vVel (:,:,:,bi,bj) = comlev1_bibj, key=idynkey, byte=isbyte
373              CALL GMREDI_CALC_TENSOR_DUMMY(  #ifdef ALLOW_KPP
374       I             bi, bj, iMin, iMax, jMin, jMax, k,  CADJ STORE KPPviscAz (:,:,:,bi,bj)
375       I             sigmaX, sigmaY, sigmaR,  CADJ &                 = comlev1_bibj, key=idynkey, byte=isbyte
376       I             myThid )  #endif /* ALLOW_KPP */
           ENDDO  
377  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
         ENDIF  
 #endif  /* ALLOW_GMREDI */  
378    
379  #ifdef  ALLOW_KPP  #if (defined INCLUDE_CALC_DIFFUSIVITY_CALL) && !(defined ALLOW_AUTODIFF)
380  C--     Compute KPP mixing coefficients          IF ( .NOT.momViscosity ) THEN
381          IF (useKPP) THEN  #endif /* INCLUDE_CALC_DIFFUSIVITY_CALL and not ALLOW_AUTODIFF */
382            CALL KPP_CALC(            DO k=1,Nr
383       I                  bi, bj, myTime, myThid )             DO j=1-OLy,sNy+OLy
384                DO i=1-OLx,sNx+OLx
385                 KappaRU(i,j,k) = 0. _d 0
386                 KappaRV(i,j,k) = 0. _d 0
387                ENDDO
388               ENDDO
389              ENDDO
390    #ifdef INCLUDE_CALC_DIFFUSIVITY_CALL
391    C--     Calculate the total vertical viscosity
392    #ifdef ALLOW_AUTODIFF
393            IF ( momViscosity ) THEN
394    #else
395            ELSE
396    #endif
397              CALL CALC_VISCOSITY(
398         I            bi,bj, iMin,iMax,jMin,jMax,
399         O            KappaRU, KappaRV,
400         I            myThid )
401          ENDIF          ENDIF
402  #endif  /* ALLOW_KPP */  #endif /* INCLUDE_CALC_DIFFUSIVITY_CALL */
403    
404  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
405  CADJ STORE KappaRT(:,:,:)     = comlev1_bibj, key = ikey, byte = isbyte  CADJ STORE KappaRU(:,:,:)
406  CADJ STORE KappaRS(:,:,:)     = comlev1_bibj, key = ikey, byte = isbyte  CADJ &     = comlev1_bibj, key=idynkey, byte=isbyte
407  CADJ STORE theta(:,:,:,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte  CADJ STORE KappaRV(:,:,:)
408  CADJ STORE salt (:,:,:,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte  CADJ &     = comlev1_bibj, key=idynkey, byte=isbyte
409  CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte  #endif /* ALLOW_AUTODIFF_TAMC */
410  CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte  
411  #endif /* ALLOW_AUTODIFF_TAMC */  #ifdef ALLOW_OBCS
412    C--   For Stevens boundary conditions velocities need to be extrapolated
413  #ifdef ALLOW_AIM  C     (copied) to a narrow strip outside the domain
414  C       AIM - atmospheric intermediate model, physics package code.          IF ( useOBCS ) THEN
415  C note(jmc) : phiHyd=0 at this point but is not really used in Molteni Physics            CALL OBCS_COPY_UV_N(
416          IF ( useAIM ) THEN       U         uVel(1-OLx,1-OLy,1,bi,bj),
417           CALL TIMER_START('AIM_DO_ATMOS_PHYS      [DYNAMICS]', myThid)       U         vVel(1-OLx,1-OLy,1,bi,bj),
418           CALL AIM_DO_ATMOS_PHYSICS( phiHyd, myTime, myThid )       I         Nr, bi, bj, myThid )
          CALL TIMER_STOP ('AIM_DO_ATMOS_PHYS      [DYNAMICS]', myThid)  
419          ENDIF          ENDIF
420  #endif /* ALLOW_AIM */  #endif /* ALLOW_OBCS */
   
421    
422  C--     Start of thermodynamics loop  C--     Start of dynamics loop
423          DO k=Nr,1,-1          DO k=1,Nr
424    
425  C--       km1    Points to level above k (=k-1)  C--       km1    Points to level above k (=k-1)
426  C--       kup    Cycles through 1,2 to point to layer above  C--       kup    Cycles through 1,2 to point to layer above
427  C--       kDown  Cycles through 2,1 to point to current layer  C--       kDown  Cycles through 2,1 to point to current layer
428    
429            km1  = MAX(1,k-1)            km1  = MAX(1,k-1)
430              kp1  = MIN(k+1,Nr)
431            kup  = 1+MOD(k+1,2)            kup  = 1+MOD(k+1,2)
432            kDown= 1+MOD(k,2)            kDown= 1+MOD(k,2)
433    
           iMin = 1-OLx+2  
           iMax = sNx+OLx-1  
           jMin = 1-OLy+2  
           jMax = sNy+OLy-1  
   
 #ifdef ALLOW_AUTODIFF_TAMC  
 CPatrick Is this formula correct?  
          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(:,:,:)    = comlev1_bibj_k, key = kkey, byte = isbyte  
 CADJ STORE KappaRS(:,:,:)    = comlev1_bibj_k, key = kkey, byte = isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
   
 C--      Get temporary terms used by tendency routines  
          CALL CALC_COMMON_FACTORS (  
      I        bi,bj,iMin,iMax,jMin,jMax,k,km1,kup,kDown,  
      O        xA,yA,uTrans,vTrans,rTrans,rVel,maskC,maskUp,  
      I        myThid)  
   
 #ifdef  INCLUDE_CALC_DIFFUSIVITY_CALL  
 C--      Calculate the total vertical diffusivity  
          CALL CALC_DIFFUSIVITY(  
      I        bi,bj,iMin,iMax,jMin,jMax,k,  
      I        maskC,maskup,  
      O        KappaRT,KappaRS,KappaRU,KappaRV,  
      I        myThid)  
 #endif  
   
 C--      Calculate active tracer tendencies (gT,gS,...)  
 C        and step forward storing result in gTnm1, gSnm1, etc.  
          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         fVerT,  
      I         myTime, myThid)  
            CALL TIMESTEP_TRACER(  
      I         bi,bj,iMin,iMax,jMin,jMax,k,  
      I         theta, gT,  
      U         gTnm1,  
      I         myIter, 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         fVerS,  
      I         myTime, myThid)  
            CALL TIMESTEP_TRACER(  
      I         bi,bj,iMin,iMax,jMin,jMax,k,  
      I         salt, gS,  
      U         gSnm1,  
      I         myIter, myThid)  
          ENDIF  
   
 #ifdef   ALLOW_OBCS  
 C--      Apply open boundary conditions  
          IF (useOBCS) THEN  
            CALL OBCS_APPLY_TS( bi, bj, k, gTnm1, gSnm1, myThid )  
          END IF  
 #endif   /* ALLOW_OBCS */  
   
 C--      Freeze water  
          IF (allowFreezing) THEN  
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE gTNm1(:,:,k,bi,bj) = comlev1_bibj_k  
 CADJ &   , key = kkey, byte = isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
             CALL FREEZE( bi, bj, iMin, iMax, jMin, jMax, k, myThid )  
          END IF  
   
 C--     end of thermodynamic k loop (Nr:1)  
         ENDDO  
   
   
 #ifdef ALLOW_AUTODIFF_TAMC  
 CPatrick? What about this one?  
            maximpl = 6  
            iikey = (ikey-1)*maximpl  
 #endif /* ALLOW_AUTODIFF_TAMC */  
   
 C--     Implicit diffusion  
         IF (implicitDiffusion) THEN  
   
           IF (tempStepping) THEN  
 #ifdef ALLOW_AUTODIFF_TAMC  
             idkey = iikey + 1  
 #endif /* ALLOW_AUTODIFF_TAMC */  
             CALL IMPLDIFF(  
      I         bi, bj, iMin, iMax, jMin, jMax,  
      I         deltaTtracer, KappaRT, recip_HFacC,  
      U         gTNm1,  
      I         myThid )  
          ENDIF  
   
          IF (saltStepping) THEN  
434  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
435           idkey = iikey + 2           kkey = (idynkey-1)*Nr + k
436    c
437    CADJ STORE totPhiHyd (:,:,k,bi,bj)
438    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
439    CADJ STORE phiHydLow (:,:,bi,bj)
440    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
441    CADJ STORE theta (:,:,k,bi,bj)
442    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
443    CADJ STORE salt  (:,:,k,bi,bj)
444    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
445    CADJ STORE gT(:,:,k,bi,bj)
446    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
447    CADJ STORE gS(:,:,k,bi,bj)
448    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
449    # ifdef NONLIN_FRSURF
450    cph-test
451    CADJ STORE  phiHydC (:,:)
452    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
453    CADJ STORE  phiHydF (:,:)
454    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
455    CADJ STORE  guDissip (:,:)
456    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
457    CADJ STORE  gvDissip (:,:)
458    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
459    CADJ STORE  fVerU (:,:,:)
460    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
461    CADJ STORE  fVerV (:,:,:)
462    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
463    CADJ STORE gU(:,:,k,bi,bj)
464    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
465    CADJ STORE gV(:,:,k,bi,bj)
466    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
467    #  ifndef ALLOW_ADAMSBASHFORTH_3
468    CADJ STORE guNm1(:,:,k,bi,bj)
469    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
470    CADJ STORE gvNm1(:,:,k,bi,bj)
471    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
472    #  else
473    CADJ STORE guNm(:,:,k,bi,bj,1)
474    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
475    CADJ STORE guNm(:,:,k,bi,bj,2)
476    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
477    CADJ STORE gvNm(:,:,k,bi,bj,1)
478    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
479    CADJ STORE gvNm(:,:,k,bi,bj,2)
480    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
481    #  endif
482    #  ifdef ALLOW_CD_CODE
483    CADJ STORE uNM1(:,:,k,bi,bj)
484    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
485    CADJ STORE vNM1(:,:,k,bi,bj)
486    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
487    CADJ STORE uVelD(:,:,k,bi,bj)
488    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
489    CADJ STORE vVelD(:,:,k,bi,bj)
490    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
491    #  endif
492    # endif
493    # ifdef ALLOW_DEPTH_CONTROL
494    CADJ STORE  fVerU (:,:,:)
495    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
496    CADJ STORE  fVerV (:,:,:)
497    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
498    # endif
499  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
             CALL IMPLDIFF(  
      I         bi, bj, iMin, iMax, jMin, jMax,  
      I         deltaTtracer, KappaRS, recip_HFacC,  
      U         gSNm1,  
      I         myThid )  
          ENDIF  
   
 #ifdef   ALLOW_OBCS  
 C--      Apply open boundary conditions  
          IF (useOBCS) THEN  
            DO K=1,Nr  
              CALL OBCS_APPLY_TS( bi, bj, k, gTnm1, gSnm1, myThid )  
            ENDDO  
          END IF  
 #endif   /* ALLOW_OBCS */  
   
 C--     End If implicitDiffusion  
         ENDIF  
   
   
   
 C--     Start of dynamics loop  
         DO k=1,Nr  
500    
501  C--       km1    Points to level above k (=k-1)  C--      Integrate hydrostatic balance for phiHyd with BC of phiHyd(z=0)=0
502  C--       kup    Cycles through 1,2 to point to layer above           IF ( implicitIntGravWave ) THEN
 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  
   
 C--      Integrate hydrostatic balance for phiHyd with BC of  
 C        phiHyd(z=0)=0  
 C        distinguishe between Stagger and Non Stagger time stepping  
          IF (staggerTimeStep) THEN  
503             CALL CALC_PHI_HYD(             CALL CALC_PHI_HYD(
504       I        bi,bj,iMin,iMax,jMin,jMax,k,       I        bi,bj,iMin,iMax,jMin,jMax,k,
505       I        gTnm1, gSnm1,       I        gT, gS,
506       U        phiHyd,       U        phiHydF,
507       I        myThid )       O        phiHydC, dPhiHydX, dPhiHydY,
508         I        myTime, myIter, myThid )
509           ELSE           ELSE
510             CALL CALC_PHI_HYD(             CALL CALC_PHI_HYD(
511       I        bi,bj,iMin,iMax,jMin,jMax,k,       I        bi,bj,iMin,iMax,jMin,jMax,k,
512       I        theta, salt,       I        theta, salt,
513       U        phiHyd,       U        phiHydF,
514       I        myThid )       O        phiHydC, dPhiHydX, dPhiHydY,
515         I        myTime, myIter, myThid )
516           ENDIF           ENDIF
517    #ifdef ALLOW_DIAGNOSTICS
518             IF ( dPhiHydDiagIsOn ) THEN
519               tmpFac = -1. _d 0
520               CALL DIAGNOSTICS_SCALE_FILL( dPhiHydX, tmpFac, 1,
521         &                           'Um_dPHdx', k, 1, 2, bi, bj, myThid )
522               CALL DIAGNOSTICS_SCALE_FILL( dPhiHydY, tmpFac, 1,
523         &                           'Vm_dPHdy', k, 1, 2, bi, bj, myThid )
524             ENDIF
525    #endif /* ALLOW_DIAGNOSTICS */
526    
527  C--      Calculate accelerations in the momentum equations (gU, gV, ...)  C--      Calculate accelerations in the momentum equations (gU, gV, ...)
528  C        and step forward storing the result in gUnm1, gVnm1, etc...  C        and step forward storing the result in gU, gV, etc...
529           IF ( momStepping ) THEN           IF ( momStepping ) THEN
530             CALL CALC_MOM_RHS(  #ifdef ALLOW_AUTODIFF_TAMC
531       I         bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown,  # ifdef NONLIN_FRSURF
532       I         phiHyd,KappaRU,KappaRV,  #  if (defined ALLOW_MOM_FLUXFORM) && !(defined DISABLE_RSTAR_CODE)
533       U         fVerU, fVerV,  CADJ STORE dWtransC(:,:,bi,bj)
534       I         myTime, myThid)  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
535             CALL TIMESTEP(  CADJ STORE dWtransU(:,:,bi,bj)
536       I         bi,bj,iMin,iMax,jMin,jMax,k,phiHyd,  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
537       I         myIter, myThid)  CADJ STORE dWtransV(:,:,bi,bj)
538    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
539    #  endif
540    CADJ STORE fVerU(:,:,:)
541    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
542    CADJ STORE fVerV(:,:,:)
543    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
544    # endif /* NONLIN_FRSURF */
545    #endif /* ALLOW_AUTODIFF_TAMC */
546               IF (.NOT. vectorInvariantMomentum) THEN
547    #ifdef ALLOW_MOM_FLUXFORM
548                  CALL MOM_FLUXFORM(
549         I         bi,bj,k,iMin,iMax,jMin,jMax,
550         I         KappaRU, KappaRV,
551         U         fVerU(1-OLx,1-OLy,kUp),   fVerV(1-OLx,1-OLy,kUp),
552         O         fVerU(1-OLx,1-OLy,kDown), fVerV(1-OLx,1-OLy,kDown),
553         O         guDissip, gvDissip,
554         I         myTime, myIter, myThid)
555    #endif
556               ELSE
557    #ifdef ALLOW_MOM_VECINV
558                 CALL MOM_VECINV(
559         I         bi,bj,k,iMin,iMax,jMin,jMax,
560         I         KappaRU, KappaRV,
561         I         fVerU(1-OLx,1-OLy,kUp),   fVerV(1-OLx,1-OLy,kUp),
562         O         fVerU(1-OLx,1-OLy,kDown), fVerV(1-OLx,1-OLy,kDown),
563         O         guDissip, gvDissip,
564         I         myTime, myIter, myThid)
565    #endif
566               ENDIF
567    
568  #ifdef   ALLOW_OBCS             CALL TIMESTEP(
569  C--      Apply open boundary conditions       I         bi,bj,iMin,iMax,jMin,jMax,k,
570           IF (useOBCS) THEN       I         dPhiHydX,dPhiHydY, phiSurfX, phiSurfY,
571             CALL OBCS_APPLY_UV( bi, bj, k, gUnm1, gVnm1, myThid )       I         guDissip, gvDissip,
572           END IF       I         myTime, myIter, myThid)
 #endif   /* ALLOW_OBCS */  
573    
 #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   /* INCLUDE_CD_CODE */  
 #endif   /* ALLOW_AUTODIFF_TAMC */  
574           ENDIF           ENDIF
575    
   
576  C--     end of dynamics k loop (1:Nr)  C--     end of dynamics k loop (1:Nr)
577          ENDDO          ENDDO
578    
579    C--     Implicit Vertical advection & viscosity
580    #if (defined (INCLUDE_IMPLVERTADV_CODE) && \
581  C--     Implicit viscosity       defined (ALLOW_MOM_COMMON) && !(defined ALLOW_AUTODIFF_TAMC))
582          IF (implicitViscosity.AND.momStepping) THEN          IF ( momImplVertAdv ) THEN
583              CALL MOM_U_IMPLICIT_R( kappaRU,
584         I                           bi, bj, myTime, myIter, myThid )
585              CALL MOM_V_IMPLICIT_R( kappaRV,
586         I                           bi, bj, myTime, myIter, myThid )
587            ELSEIF ( implicitViscosity ) THEN
588    #else /* INCLUDE_IMPLVERTADV_CODE */
589            IF     ( implicitViscosity ) THEN
590    #endif /* INCLUDE_IMPLVERTADV_CODE */
591  #ifdef    ALLOW_AUTODIFF_TAMC  #ifdef    ALLOW_AUTODIFF_TAMC
592            idkey = iikey + 3  CADJ STORE KappaRU(:,:,:) = comlev1_bibj , key=idynkey, byte=isbyte
593    CADJ STORE gU(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte
594  #endif    /* ALLOW_AUTODIFF_TAMC */  #endif    /* ALLOW_AUTODIFF_TAMC */
595            CALL IMPLDIFF(            CALL IMPLDIFF(
596       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
597       I         deltaTmom, KappaRU,recip_HFacW,       I         -1, KappaRU, recip_hFacW(1-OLx,1-OLy,1,bi,bj),
598       U         gUNm1,       U         gU,
599       I         myThid )       I         myThid )
600  #ifdef    ALLOW_AUTODIFF_TAMC  #ifdef    ALLOW_AUTODIFF_TAMC
601            idkey = iikey + 4  CADJ STORE KappaRV(:,:,:) = comlev1_bibj , key=idynkey, byte=isbyte
602    CADJ STORE gV(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte
603  #endif    /* ALLOW_AUTODIFF_TAMC */  #endif    /* ALLOW_AUTODIFF_TAMC */
604            CALL IMPLDIFF(            CALL IMPLDIFF(
605       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
606       I         deltaTmom, KappaRV,recip_HFacS,       I         -2, KappaRV, recip_hFacS(1-OLx,1-OLy,1,bi,bj),
607       U         gVNm1,       U         gV,
608       I         myThid )       I         myThid )
609            ENDIF
610    
611  #ifdef   ALLOW_OBCS  #ifdef ALLOW_OBCS
612  C--      Apply open boundary conditions  C--      Apply open boundary conditions
613           IF (useOBCS) THEN          IF ( useOBCS ) THEN
614             DO K=1,Nr  C--      but first save intermediate velocities to be used in the
615               CALL OBCS_APPLY_UV( bi, bj, k, gUnm1, gVnm1, myThid )  C        next time step for the Stevens boundary conditions
616             ENDDO            CALL OBCS_SAVE_UV_N(
617           END IF       I        bi, bj, iMin, iMax, jMin, jMax, 0,
618  #endif   /* ALLOW_OBCS */       I        gU, gV, myThid )
619              CALL OBCS_APPLY_UV( bi, bj, 0, gU, gV, myThid )
620            ENDIF
621    #endif /* ALLOW_OBCS */
622    
623  #ifdef    INCLUDE_CD_CODE  #ifdef    ALLOW_CD_CODE
624            IF (implicitViscosity.AND.useCDscheme) THEN
625  #ifdef    ALLOW_AUTODIFF_TAMC  #ifdef    ALLOW_AUTODIFF_TAMC
626            idkey = iikey + 5  CADJ STORE vVelD(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte
627  #endif    /* ALLOW_AUTODIFF_TAMC */  #endif    /* ALLOW_AUTODIFF_TAMC */
628            CALL IMPLDIFF(            CALL IMPLDIFF(
629       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
630       I         deltaTmom, KappaRU,recip_HFacW,       I         0, KappaRU, recip_hFacW(1-OLx,1-OLy,1,bi,bj),
631       U         vVelD,       U         vVelD,
632       I         myThid )       I         myThid )
633  #ifdef    ALLOW_AUTODIFF_TAMC  #ifdef    ALLOW_AUTODIFF_TAMC
634            idkey = iikey + 6  CADJ STORE uVelD(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte
635  #endif    /* ALLOW_AUTODIFF_TAMC */  #endif    /* ALLOW_AUTODIFF_TAMC */
636            CALL IMPLDIFF(            CALL IMPLDIFF(
637       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
638       I         deltaTmom, KappaRV,recip_HFacS,       I         0, KappaRV, recip_hFacS(1-OLx,1-OLy,1,bi,bj),
639       U         uVelD,       U         uVelD,
640       I         myThid )       I         myThid )
 #endif    /* INCLUDE_CD_CODE */  
 C--     End If implicitViscosity.AND.momStepping  
641          ENDIF          ENDIF
642    #endif    /* ALLOW_CD_CODE */
643    C--     End implicit Vertical advection & viscosity
644    
645    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
646    
647    #ifdef ALLOW_NONHYDROSTATIC
648    C--   Step forward W field in N-H algorithm
649            IF ( nonHydrostatic ) THEN
650    #ifdef ALLOW_DEBUG
651             IF (debugMode) CALL DEBUG_CALL('CALC_GW', myThid )
652    #endif
653             CALL TIMER_START('CALC_GW          [DYNAMICS]',myThid)
654             CALL CALC_GW(
655         I                 bi,bj, KappaRU, KappaRV,
656         I                 myTime, myIter, myThid )
657            ENDIF
658            IF ( nonHydrostatic.OR.implicitIntGravWave )
659         &   CALL TIMESTEP_WVEL( bi,bj, myTime, myIter, myThid )
660            IF ( nonHydrostatic )
661         &   CALL TIMER_STOP ('CALC_GW          [DYNAMICS]',myThid)
662    #endif
663    
664    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
665    
666    C-    end of bi,bj loops
667         ENDDO         ENDDO
668        ENDDO        ENDDO
669    
670    #ifdef ALLOW_OBCS
671          IF (useOBCS) THEN
672            CALL OBCS_EXCHANGES( myThid )
673          ENDIF
674    #endif
675    
676    Cml(
677    C     In order to compare the variance of phiHydLow of a p/z-coordinate
678    C     run with etaH of a z/p-coordinate run the drift of phiHydLow
679    C     has to be removed by something like the following subroutine:
680    C      CALL REMOVE_MEAN_RL( 1, phiHydLow, maskInC, maskInC, rA, drF,
681    C     &                     'phiHydLow', myTime, myThid )
682    Cml)
683    
684    #ifdef ALLOW_DIAGNOSTICS
685          IF ( useDiagnostics ) THEN
686    
687           CALL DIAGNOSTICS_FILL(totPhihyd,'PHIHYD  ',0,Nr,0,1,1,myThid)
688           CALL DIAGNOSTICS_FILL(phiHydLow,'PHIBOT  ',0, 1,0,1,1,myThid)
689    
690           tmpFac = 1. _d 0
691           CALL DIAGNOSTICS_SCALE_FILL(totPhihyd,tmpFac,2,
692         &                                 'PHIHYDSQ',0,Nr,0,1,1,myThid)
693    
694           CALL DIAGNOSTICS_SCALE_FILL(phiHydLow,tmpFac,2,
695         &                                 'PHIBOTSQ',0, 1,0,1,1,myThid)
696    
697          ENDIF
698    #endif /* ALLOW_DIAGNOSTICS */
699    
700    #ifdef ALLOW_DEBUG
701          IF ( debugLevel .GE. debLevD ) THEN
702           CALL DEBUG_STATS_RL(1,EtaN,'EtaN (DYNAMICS)',myThid)
703           CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (DYNAMICS)',myThid)
704           CALL DEBUG_STATS_RL(Nr,vVel,'Vvel (DYNAMICS)',myThid)
705           CALL DEBUG_STATS_RL(Nr,wVel,'Wvel (DYNAMICS)',myThid)
706           CALL DEBUG_STATS_RL(Nr,theta,'Theta (DYNAMICS)',myThid)
707           CALL DEBUG_STATS_RL(Nr,salt,'Salt (DYNAMICS)',myThid)
708           CALL DEBUG_STATS_RL(Nr,gU,'Gu (DYNAMICS)',myThid)
709           CALL DEBUG_STATS_RL(Nr,gV,'Gv (DYNAMICS)',myThid)
710           CALL DEBUG_STATS_RL(Nr,gT,'Gt (DYNAMICS)',myThid)
711           CALL DEBUG_STATS_RL(Nr,gS,'Gs (DYNAMICS)',myThid)
712    #ifndef ALLOW_ADAMSBASHFORTH_3
713           CALL DEBUG_STATS_RL(Nr,guNm1,'GuNm1 (DYNAMICS)',myThid)
714           CALL DEBUG_STATS_RL(Nr,gvNm1,'GvNm1 (DYNAMICS)',myThid)
715           CALL DEBUG_STATS_RL(Nr,gtNm1,'GtNm1 (DYNAMICS)',myThid)
716           CALL DEBUG_STATS_RL(Nr,gsNm1,'GsNm1 (DYNAMICS)',myThid)
717    #endif
718          ENDIF
719    #endif
720    
721    #ifdef DYNAMICS_GUGV_EXCH_CHECK
722    C- jmc: For safety checking only: This Exchange here should not change
723    C       the solution. If solution changes, it means something is wrong,
724    C       but it does not mean that it is less wrong with this exchange.
725          IF ( debugLevel .GE. debLevE ) THEN
726           CALL EXCH_UV_XYZ_RL(gU,gV,.TRUE.,myThid)
727          ENDIF
728    #endif
729    
730    #ifdef ALLOW_DEBUG
731          IF (debugMode) CALL DEBUG_LEAVE( 'DYNAMICS', myThid )
732    #endif
733    
734        RETURN        RETURN
735        END        END
Legend:
Removed from v.1.59  
changed lines
  Added in v.1.165
  ViewVC Help
Powered by ViewVC 1.1.22