/[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.54.2.1 by adcroft, Thu Jan 4 21:41:33 2001 UTC revision 1.161 by jmc, Mon Mar 5 18:21:12 2012 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    #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"
81  #include "DYNVARS.h"  #include "DYNVARS.h"
82    #ifdef ALLOW_CD_CODE
83    #include "CD_CODE_VARS.h"
84    #endif
85  #include "GRID.h"  #include "GRID.h"
   
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_FIELDS.h"
100    #  ifdef ALLOW_PTRACERS
101    #   include "OBCS_PTRACERS.h"
102    #  endif
103    # endif
104    # ifdef ALLOW_MOM_FLUXFORM
105    #  include "MOM_FLUXFORM.h"
106    # endif
107    #endif /* ALLOW_AUTODIFF_TAMC */
108    
109    C     !CALLING SEQUENCE:
110    C     DYNAMICS()
111    C      |
112    C      |-- CALC_EP_FORCING
113    C      |
114    C      |-- CALC_GRAD_PHI_SURF
115    C      |
116    C      |-- CALC_VISCOSITY
117    C      |
118    C      |-- CALC_PHI_HYD
119    C      |
120    C      |-- MOM_FLUXFORM
121    C      |
122    C      |-- MOM_VECINV
123    C      |
124    C      |-- TIMESTEP
125    C      |
126    C      |-- MOM_U_IMPLICIT_R
127    C      |-- MOM_V_IMPLICIT_R
128    C      |
129    C      |-- IMPLDIFF
130    C      |
131    C      |-- OBCS_APPLY_UV
132    C      |
133    C      |-- CALC_GW
134    C      |
135    C      |-- DIAGNOSTICS_FILL
136    C      |-- DEBUG_STATS_RL
137    
138    C     !INPUT/OUTPUT PARAMETERS:
139  C     == Routine arguments ==  C     == Routine arguments ==
140  C     myTime - Current time in simulation  C     myTime :: Current time in simulation
141  C     myIter - Current iteration number in simulation  C     myIter :: Current iteration number in simulation
142  C     myThid - Thread number for this instance of the routine.  C     myThid :: Thread number for this instance of the routine.
143        _RL myTime        _RL myTime
144        INTEGER myIter        INTEGER myIter
145        INTEGER myThid        INTEGER myThid
146    
147    C     !FUNCTIONS:
148    #ifdef ALLOW_DIAGNOSTICS
149          LOGICAL  DIAGNOSTICS_IS_ON
150          EXTERNAL DIAGNOSTICS_IS_ON
151    #endif
152    
153    C     !LOCAL VARIABLES:
154  C     == Local variables  C     == Local variables
155  C     xA, yA                 - Per block temporaries holding face areas  C     fVer[UV]               o fVer: Vertical flux term - note fVer
156  C     uTrans, vTrans, rTrans - Per block temporaries holding flow  C                                    is "pipelined" in the vertical
157  C                              transport  C                                    so we need an fVer for each
158  C     rVel                     o uTrans: Zonal transport  C                                    variable.
159  C                              o vTrans: Meridional transport  C     phiHydC    :: hydrostatic potential anomaly at cell center
160  C                              o rTrans: Vertical transport  C                   In z coords phiHyd is the hydrostatic potential
161  C                              o rVel:   Vertical velocity at upper and  C                      (=pressure/rho0) anomaly
162  C                                        lower cell faces.  C                   In p coords phiHyd is the geopotential height anomaly.
163  C     maskC,maskUp             o maskC: land/water mask for tracer cells  C     phiHydF    :: hydrostatic potential anomaly at middle between 2 centers
164  C                              o maskUp: land/water mask for W points  C     dPhiHydX,Y :: Gradient (X & Y directions) of hydrostatic potential anom.
165  C     aTerm, xTerm, cTerm    - Work arrays for holding separate terms in  C     phiSurfX,  ::  gradient of Surface potential (Pressure/rho, ocean)
166  C     mTerm, pTerm,            tendency equations.  C     phiSurfY             or geopotential (atmos) in X and Y direction
167  C     fZon, fMer, fVer[STUV]   o aTerm: Advection term  C     guDissip   :: dissipation tendency (all explicit terms), u component
168  C                              o xTerm: Mixing term  C     gvDissip   :: dissipation tendency (all explicit terms), v component
169  C                              o cTerm: Coriolis term  C     KappaRU    :: vertical viscosity
170  C                              o mTerm: Metric term  C     KappaRV    :: vertical viscosity
 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).  
171  C     iMin, iMax     - Ranges and sub-block indices on which calculations  C     iMin, iMax     - Ranges and sub-block indices on which calculations
172  C     jMin, jMax       are applied.  C     jMin, jMax       are applied.
173  C     bi, bj  C     bi, bj
174  C     k, kup,        - Index for layer above and below. kup and kDown  C     k, kup,        - Index for layer above and below. kup and kDown
175  C     kDown, km1       are switched with layer to be the appropriate  C     kDown, km1       are switched with layer to be the appropriate
176  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)  
177        _RL fVerU   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerU   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
178        _RL fVerV   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerV   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
179        _RL phiHyd  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL phiHydF (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
180        _RL rhokm1  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL phiHydC (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
181        _RL rhokp1  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL dPhiHydX(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
182        _RL rhok    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL dPhiHydY(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
183        _RL buoyKM1 (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL phiSurfX(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
184        _RL buoyK   (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL phiSurfY(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
185        _RL rhotmp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL guDissip(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
186        _RL etaSurfX(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL gvDissip(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
187        _RL etaSurfY(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL KappaRU (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
188        _RL KappaRT (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)        _RL KappaRV (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
       _RL KappaRS (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)  
       _RL KappaRU (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)  
       _RL KappaRV (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)  
       _RL sigmaX  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)  
       _RL sigmaY  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)  
       _RL sigmaR  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)  
   
 C This is currently also used by IVDC and Diagnostics  
 C #ifdef INCLUDE_CONVECT_CALL  
       _RL ConvectCount (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)  
 C #endif  
189    
190        INTEGER iMin, iMax        INTEGER iMin, iMax
191        INTEGER jMin, jMax        INTEGER jMin, jMax
192        INTEGER bi, bj        INTEGER bi, bj
193        INTEGER i, j        INTEGER i, j
194        INTEGER k, km1, kup, kDown        INTEGER k, km1, kp1, kup, kDown
       LOGICAL BOTTOM_LAYER  
195    
196  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_DIAGNOSTICS
197        INTEGER    isbyte        LOGICAL dPhiHydDiagIsOn
198        PARAMETER( isbyte = 4 )        _RL tmpFac
199    #endif /* ALLOW_DIAGNOSTICS */
200    
       INTEGER act1, act2, act3, act4  
       INTEGER max1, max2, max3  
       INTEGER iikey, kkey  
       INTEGER maximpl  
 #endif /* ALLOW_AUTODIFF_TAMC */  
201    
202  C---    The algorithm...  C---    The algorithm...
203  C  C
# Line 163  C       "Calculation of Gs" Line 213  C       "Calculation of Gs"
213  C       ===================  C       ===================
214  C       This is where all the accelerations and tendencies (ie.  C       This is where all the accelerations and tendencies (ie.
215  C       physics, parameterizations etc...) are calculated  C       physics, parameterizations etc...) are calculated
 C         rVel = sum_r ( div. u[n] )  
216  C         rho = rho ( theta[n], salt[n] )  C         rho = rho ( theta[n], salt[n] )
217  C         b   = b(rho, theta)  C         b   = b(rho, theta)
218  C         K31 = K31 ( rho )  C         K31 = K31 ( rho )
219  C         Gu[n] = Gu( u[n], v[n], rVel, b, ... )  C         Gu[n] = Gu( u[n], v[n], wVel, b, ... )
220  C         Gv[n] = Gv( u[n], v[n], rVel, b, ... )  C         Gv[n] = Gv( u[n], v[n], wVel, b, ... )
221  C         Gt[n] = Gt( theta[n], u[n], v[n], rVel, K31, ... )  C         Gt[n] = Gt( theta[n], u[n], v[n], wVel, K31, ... )
222  C         Gs[n] = Gs( salt[n], u[n], v[n], rVel, K31, ... )  C         Gs[n] = Gs( salt[n], u[n], v[n], wVel, K31, ... )
223  C  C
224  C       "Time-stepping" or "Prediction"  C       "Time-stepping" or "Prediction"
225  C       ================================  C       ================================
# Line 193  C         salt* = salt[n] + dt x ( 3/2 G Line 242  C         salt* = salt[n] + dt x ( 3/2 G
242  C         (1 + dt * K * d_zz) theta[n] = theta*  C         (1 + dt * K * d_zz) theta[n] = theta*
243  C         (1 + dt * K * d_zz) salt[n] = salt*  C         (1 + dt * K * d_zz) salt[n] = salt*
244  C---  C---
245    CEOP
246    
247  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_DEBUG
248  C--   dummy statement to end declaration part        IF (debugMode) CALL DEBUG_ENTER( 'DYNAMICS', myThid )
249        ikey = 1  #endif
 #endif /* ALLOW_AUTODIFF_TAMC */  
250    
251    #ifdef ALLOW_DIAGNOSTICS
252          dPhiHydDiagIsOn = .FALSE.
253          IF ( useDiagnostics )
254         &  dPhiHydDiagIsOn = DIAGNOSTICS_IS_ON( 'Um_dPHdx', myThid )
255         &               .OR. DIAGNOSTICS_IS_ON( 'Vm_dPHdy', myThid )
256    #endif
257    
258  C--   Set up work arrays with valid (i.e. not NaN) values  C-- Call to routine for calculation of
259  C     These inital values do not alter the numerical results. They  C   Eliassen-Palm-flux-forced U-tendency,
260  C     just ensure that all memory references are to valid floating  C   if desired:
261  C     point numbers. This prevents spurious hardware signals due to  #ifdef INCLUDE_EP_FORCING_CODE
262  C     uninitialised but inert locations.        CALL CALC_EP_FORCING(myThid)
263        DO j=1-OLy,sNy+OLy  #endif
        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  
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 246  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 257  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  
           phiHyd(i,j,1) = 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             KappaRU(i,j,k) = 0. _d 0
310             ConvectCount(i,j,k) = 0.             KappaRV(i,j,k) = 0. _d 0
311  #endif  cph(
312             KappaRT(i,j,k) = 0. _d 0  c--   need some re-initialisation here to break dependencies
313             KappaRS(i,j,k) = 0. _d 0  cph)
314               gU(i,j,k,bi,bj) = 0. _d 0
315               gV(i,j,k,bi,bj) = 0. _d 0
316            ENDDO            ENDDO
317           ENDDO           ENDDO
318          ENDDO          ENDDO
   
         iMin = 1-OLx+1  
         iMax = sNx+OLx  
         jMin = 1-OLy+1  
         jMax = sNy+OLy  
   
         k = 1  
         BOTTOM_LAYER = k .EQ. Nr  
   
 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  
319  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
320          CALL FIND_RHO(          DO j=1-OLy,sNy+OLy
321       I     bi, bj, iMin, iMax, jMin, jMax, k, k, eosType,           DO i=1-OLx,sNx+OLx
322       O     rhoKm1,            fVerU  (i,j,1) = 0. _d 0
323       I     myThid )            fVerU  (i,j,2) = 0. _d 0
324  #endif            fVerV  (i,j,1) = 0. _d 0
325              fVerV  (i,j,2) = 0. _d 0
326          IF (.NOT. BOTTOM_LAYER) THEN            phiHydF (i,j)  = 0. _d 0
327              phiHydC (i,j)  = 0. _d 0
328  C--      Check static stability with layer below  #ifndef INCLUDE_PHIHYD_CALCULATION_CODE
329  C--      and mix as needed.            dPhiHydX(i,j)  = 0. _d 0
330  #ifdef  INCLUDE_FIND_RHO_CALL            dPhiHydY(i,j)  = 0. _d 0
331  #ifdef ALLOW_AUTODIFF_TAMC  #endif
332  CADJ STORE theta(:,:,k+1,bi,bj) = comlev1_bibj            phiSurfX(i,j)  = 0. _d 0
333  CADJ &   , key = ikey, byte = isbyte            phiSurfY(i,j)  = 0. _d 0
334  CADJ STORE salt (:,:,k+1,bi,bj) = comlev1_bibj            guDissip(i,j)  = 0. _d 0
335  CADJ &   , key = ikey, byte = isbyte            gvDissip(i,j)  = 0. _d 0
336  #endif /* ALLOW_AUTODIFF_TAMC */  #ifdef ALLOW_AUTODIFF_TAMC
337           CALL FIND_RHO(            phiHydLow(i,j,bi,bj) = 0. _d 0
338       I      bi, bj, iMin, iMax, jMin, jMax, k+1, k, eosType,  # if (defined NONLIN_FRSURF) && (defined ALLOW_MOM_FLUXFORM)
339       O      rhoKp1,  #  ifndef DISABLE_RSTAR_CODE
340       I      myThid )            dWtransC(i,j,bi,bj) = 0. _d 0
341              dWtransU(i,j,bi,bj) = 0. _d 0
342              dWtransV(i,j,bi,bj) = 0. _d 0
343    #  endif
344    # endif
345  #endif  #endif
346             ENDDO
347            ENDDO
348    
349  #ifdef ALLOW_AUTODIFF_TAMC  C--     Start computation of dynamics
350  CADJ STORE rhoKm1(:,:)  = comlev1_bibj, key = ikey, byte = isbyte          iMin = 0
351  CADJ STORE rhoKp1(:,:)  = comlev1_bibj, key = ikey, byte = isbyte          iMax = sNx+1
352  #endif /* ALLOW_AUTODIFF_TAMC */          jMin = 0
353            jMax = sNy+1
354  C--      Implicit Vertical Diffusion for Convection  
355           IF (ivdc_kappa.NE.0.) THEN  #ifdef ALLOW_AUTODIFF_TAMC
356              CALL CALC_IVDC(  CADJ STORE wVel (:,:,:,bi,bj) =
357       I       bi,bj,iMin,iMax,jMin,jMax,k+1,rhoKm1,rhoKp1,  CADJ &     comlev1_bibj, key=idynkey, byte=isbyte
358       U       ConvectCount, KappaRT, KappaRS,  #endif /* ALLOW_AUTODIFF_TAMC */
359       I       myTime,myIter,myThid)  
360           ENDIF  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          ENDIF          IF (implicSurfPress.NE.1.) THEN
363              CALL CALC_GRAD_PHI_SURF(
364  C--     Calculate buoyancy       I         bi,bj,iMin,iMax,jMin,jMax,
365          CALL CALC_BUOYANCY(       I         etaN,
366       I      bi,bj,iMin,iMax,jMin,jMax,k,rhoKm1,       O         phiSurfX,phiSurfY,
367       O      buoyKm1,       I         myThid )
      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 )  
368          ENDIF          ENDIF
 #endif  
   
 C--     Start of downward loop  
         DO k=2,Nr  
369    
370  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
371           kkey = (ikey-1)*(Nr-2+1) + (k-2) + 1  CADJ STORE uVel (:,:,:,bi,bj) = comlev1_bibj, key=idynkey, byte=isbyte
372  #endif /* ALLOW_AUTODIFF_TAMC */  CADJ STORE vVel (:,:,:,bi,bj) = comlev1_bibj, key=idynkey, byte=isbyte
373    #ifdef ALLOW_KPP
374           BOTTOM_LAYER = k .EQ. Nr  CADJ STORE KPPviscAz (:,:,:,bi,bj)
375    CADJ &                 = comlev1_bibj, key=idynkey, byte=isbyte
376  #ifdef DO_PIPELINED_CORRECTION_STEP  #endif /* ALLOW_KPP */
          IF ( .NOT. BOTTOM_LAYER ) THEN  
 C--       Update fields in layer below according to tendency terms  
 #ifdef ALLOW_OBCS  
           IF (openBoundaries) THEN  
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE uvel (:,:,k,bi,bj) = comlev1_bibj_k  
 CADJ &   , key = kkey, byte = isbyte  
 CADJ STORE vvel (:,:,k,bi,bj) = comlev1_bibj_k  
 CADJ &   , key = kkey, byte = isbyte  
 CADJ STORE theta(:,:,k,bi,bj) = comlev1_bibj_k  
 CADJ &   , key = kkey, byte = isbyte  
 CADJ STORE salt (:,:,k,bi,bj) = comlev1_bibj_k  
 CADJ &   , key = kkey, byte = isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
           END IF  
 #endif  
          ENDIF  
 #endif /* DO_PIPELINED_CORRECTION_STEP */  
   
 C--      Density of k level (below W(k)) reference to k level  
 #ifdef  INCLUDE_FIND_RHO_CALL  
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE theta(:,:,k,bi,bj) = comlev1_bibj_k  
 CADJ &   , key = kkey, byte = isbyte  
 CADJ STORE salt (:,:,k,bi,bj) = comlev1_bibj_k  
 CADJ &   , key = kkey, byte = isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
          CALL FIND_RHO(  
      I      bi, bj, iMin, iMax, jMin, jMax,  k, k, eosType,  
      O      rhoK,  
      I      myThid )  
   
 #ifdef ALLOW_AUTODIFF_TAMC  
 cph(   storing not necessary  
 cphCADJ STORE rhoK(:,:)  = comlev1_bibj_k, key = kkey, byte = isbyte  
 cph)  
 #endif /* ALLOW_AUTODIFF_TAMC */  
 #endif  
   
          IF (.NOT. BOTTOM_LAYER) THEN  
   
 C--       Check static stability with layer below and mix as needed.  
 C--       Density of k+1 level (below W(k+1)) reference to k level.  
 #ifdef  INCLUDE_FIND_RHO_CALL  
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE theta(:,:,k+1,bi,bj) = comlev1_bibj_k  
 CADJ &   , key = kkey, byte = isbyte  
 CADJ STORE salt (:,:,k+1,bi,bj) = comlev1_bibj_k  
 CADJ &   , key = kkey, byte = isbyte  
 #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  
   
 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--            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  
377  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
378    
379           CALL FIND_RHO(  #ifdef  INCLUDE_CALC_DIFFUSIVITY_CALL
380       I        bi, bj, iMin, iMax, jMin, jMax, k-1, k, eosType,  C--     Calculate the total vertical viscosity
381       O        rhoTmp,          CALL CALC_VISCOSITY(
382       I        myThid )       I            bi,bj, iMin,iMax,jMin,jMax,
383  #endif       O            KappaRU, KappaRV,
384         I            myThid )
385    #else
386  #ifdef ALLOW_GMREDI          DO k=1,Nr
387           IF ( useGMRedi ) THEN           DO j=1-OLy,sNy+OLy
388           CALL GRAD_SIGMA(            DO i=1-OLx,sNx+OLx
389       I             bi, bj, iMin, iMax, jMin, jMax, k,             KappaRU(i,j,k) = 0. _d 0
390       I             rhoK, rhotmp, rhoK,             KappaRV(i,j,k) = 0. _d 0
      O             sigmaX, sigmaY, sigmaR,  
      I             myThid )  
          ENDIF  
 #endif  
   
          DO J=jMin,jMax  
           DO I=iMin,iMax  
 #ifdef  INCLUDE_FIND_RHO_CALL  
            rhoKm1 (I,J) = rhoK(I,J)  
 #endif  
            buoyKm1(I,J) = buoyK(I,J)  
391            ENDDO            ENDDO
392           ENDDO           ENDDO
   
 C--     end of k loop  
393          ENDDO          ENDDO
   
 C     Determines forcing terms based on external fields  
 C     relaxation terms, etc.  
       CALL EXTERNAL_FORCING_SURF(  
      I             bi, bj, iMin, iMax, jMin, jMax,  
      I             myThid )  
   
 #ifdef ALLOW_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  
         ENDIF  
394  #endif  #endif
395    
396  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
397  CADJ STORE KappaRT(:,:,:)     = comlev1_bibj, key = ikey, byte = isbyte  CADJ STORE KappaRU(:,:,:)
398  CADJ STORE KappaRS(:,:,:)     = comlev1_bibj, key = ikey, byte = isbyte  CADJ &     = comlev1_bibj, key=idynkey, byte=isbyte
399    CADJ STORE KappaRV(:,:,:)
400  CADJ STORE theta(:,:,:,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte  CADJ &     = comlev1_bibj, key=idynkey, byte=isbyte
 CADJ STORE salt (:,:,:,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte  
 CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte  
 CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte  
   
 C--     dummy initialization to break data flow because  
 C--     calc_div_ghat has a condition for initialization  
         DO J=jMin,jMax  
            DO I=iMin,iMax  
               cg2d_b(i,j,bi,bj) = 0.0  
            ENDDO  
         ENDDO  
401  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
402    
 #ifdef ALLOW_KPP  
 C--   Compute KPP mixing coefficients  
         IF (useKPP) THEN  
   
           CALL TIMER_START('KPP_CALC               [DYNAMICS]', myThid)  
           CALL KPP_CALC(  
      I                  bi, bj, myTime, myThid )  
           CALL TIMER_STOP ('KPP_CALC               [DYNAMICS]', myThid)  
   
 #ifdef ALLOW_AUTODIFF_TAMC  
         ELSE  
           DO j=1-OLy,sNy+OLy  
             DO i=1-OLx,sNx+OLx  
               KPPhbl (i,j,bi,bj) = 1.0  
               KPPfrac(i,j,bi,bj) = 0.0  
               DO k = 1,Nr  
                  KPPghat   (i,j,k,bi,bj) = 0.0  
                  KPPviscAz (i,j,k,bi,bj) = viscAz  
                  KPPdiffKzT(i,j,k,bi,bj) = diffKzT  
                  KPPdiffKzS(i,j,k,bi,bj) = diffKzS  
               ENDDO  
             ENDDO  
           ENDDO  
 #endif /* ALLOW_AUTODIFF_TAMC */  
         ENDIF  
   
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE KPPghat   (:,:,:,bi,bj)  
 CADJ &   , KPPviscAz (:,:,:,bi,bj)  
 CADJ &   , KPPdiffKzT(:,:,:,bi,bj)  
 CADJ &   , KPPdiffKzS(:,:,:,bi,bj)  
 CADJ &   , KPPfrac   (:,:  ,bi,bj)  
 CADJ &                 = comlev1_bibj, key = ikey, byte = isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
   
 #endif /* ALLOW_KPP */  
   
 C--     Start of upward loop  
         DO k = Nr, 1, -1  
   
 C--      km1    Points to level above k (=k-1)  
 C--      kup    Cycles through 1,2 to point to layer above  
 C--      kDown  Cycles through 2,1 to point to current layer  
   
          km1  =max(1,k-1)  
          kup  =1+MOD(k+1,2)  
          kDown=1+MOD(k,2)  
   
          iMin = 1-OLx+2  
          iMax = sNx+OLx-1  
          jMin = 1-OLy+2  
          jMax = sNy+OLy-1  
   
 #ifdef ALLOW_AUTODIFF_TAMC  
          kkey = (ikey-1)*(Nr-1+1) + (k-1) + 1  
   
 CADJ STORE rvel  (:,:,kDown) = comlev1_bibj_k, key = kkey, byte = isbyte  
 CADJ STORE rTrans(:,:)       = comlev1_bibj_k, key = kkey, byte = isbyte  
 CADJ STORE KappaRT(:,:,:)    = 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)  
   
403  #ifdef ALLOW_OBCS  #ifdef ALLOW_OBCS
404          IF (openBoundaries) THEN  C--   For Stevens boundary conditions velocities need to be extrapolated
405           CALL APPLY_OBCS3( bi, bj, k, kup, rTrans, rVel, myThid )  C     (copied) to a narrow strip outside the domain
406          ENDIF           IF ( useOBCS ) THEN
407  #endif            CALL OBCS_COPY_UV_N(
408         U         uVel(1-OLx,1-OLy,1,bi,bj),
409         U         vVel(1-OLx,1-OLy,1,bi,bj),
410         I         Nr, bi, bj, myThid )
411             ENDIF
412    #endif /* ALLOW_OBCS */
413    
414  #ifdef  INCLUDE_CALC_DIFFUSIVITY_CALL  C--     Start of dynamics loop
415  C--      Calculate the total vertical diffusivity          DO k=1,Nr
416           CALL CALC_DIFFUSIVITY(  
417    C--       km1    Points to level above k (=k-1)
418    C--       kup    Cycles through 1,2 to point to layer above
419    C--       kDown  Cycles through 2,1 to point to current layer
420    
421              km1  = MAX(1,k-1)
422              kp1  = MIN(k+1,Nr)
423              kup  = 1+MOD(k+1,2)
424              kDown= 1+MOD(k,2)
425    
426    #ifdef ALLOW_AUTODIFF_TAMC
427             kkey = (idynkey-1)*Nr + k
428    c
429    CADJ STORE totPhiHyd (:,:,k,bi,bj)
430    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
431    CADJ STORE phiHydLow (:,:,bi,bj)
432    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
433    CADJ STORE theta (:,:,k,bi,bj)
434    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
435    CADJ STORE salt  (:,:,k,bi,bj)
436    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
437    CADJ STORE gT(:,:,k,bi,bj)
438    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
439    CADJ STORE gS(:,:,k,bi,bj)
440    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
441    # ifdef NONLIN_FRSURF
442    cph-test
443    CADJ STORE  phiHydC (:,:)
444    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
445    CADJ STORE  phiHydF (:,:)
446    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
447    CADJ STORE  guDissip (:,:)
448    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
449    CADJ STORE  gvDissip (:,:)
450    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
451    CADJ STORE  fVerU (:,:,:)
452    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
453    CADJ STORE  fVerV (:,:,:)
454    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
455    CADJ STORE gU(:,:,k,bi,bj)
456    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
457    CADJ STORE gV(:,:,k,bi,bj)
458    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
459    #  ifndef ALLOW_ADAMSBASHFORTH_3
460    CADJ STORE guNm1(:,:,k,bi,bj)
461    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
462    CADJ STORE gvNm1(:,:,k,bi,bj)
463    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
464    #  else
465    CADJ STORE guNm(:,:,k,bi,bj,1)
466    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
467    CADJ STORE guNm(:,:,k,bi,bj,2)
468    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
469    CADJ STORE gvNm(:,:,k,bi,bj,1)
470    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
471    CADJ STORE gvNm(:,:,k,bi,bj,2)
472    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
473    #  endif
474    #  ifdef ALLOW_CD_CODE
475    CADJ STORE uNM1(:,:,k,bi,bj)
476    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
477    CADJ STORE vNM1(:,:,k,bi,bj)
478    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
479    CADJ STORE uVelD(:,:,k,bi,bj)
480    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
481    CADJ STORE vVelD(:,:,k,bi,bj)
482    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
483    #  endif
484    # endif
485    # ifdef ALLOW_DEPTH_CONTROL
486    CADJ STORE  fVerU (:,:,:)
487    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
488    CADJ STORE  fVerV (:,:,:)
489    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
490    # endif
491    #endif /* ALLOW_AUTODIFF_TAMC */
492    
493    C--      Integrate hydrostatic balance for phiHyd with BC of
494    C        phiHyd(z=0)=0
495             IF ( implicitIntGravWave ) THEN
496               CALL CALC_PHI_HYD(
497       I        bi,bj,iMin,iMax,jMin,jMax,k,       I        bi,bj,iMin,iMax,jMin,jMax,k,
498       I        maskC,maskUp,       I        gT, gS,
499       O        KappaRT,KappaRS,KappaRU,KappaRV,       U        phiHydF,
500       I        myThid)       O        phiHydC, dPhiHydX, dPhiHydY,
501  #endif       I        myTime, myIter, myThid )
 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  
502           ELSE           ELSE
503              DO j=1-OLy,sNy+OLy             CALL CALC_PHI_HYD(
504                 DO i=1-OLx,sNx+OLx       I        bi,bj,iMin,iMax,jMin,jMax,k,
505                    guCD(i,j,k,bi,bj) = 0.0       I        theta, salt,
506                    gvCD(i,j,k,bi,bj) = 0.0       U        phiHydF,
507                 END DO       O        phiHydC, dPhiHydX, dPhiHydY,
508              END DO       I        myTime, myIter, myThid )
 #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)  
509           ENDIF           ENDIF
510  #ifdef ALLOW_OBCS  #ifdef ALLOW_DIAGNOSTICS
511  C--      Calculate future values on open boundaries           IF ( dPhiHydDiagIsOn ) THEN
512           IF (openBoundaries) THEN             tmpFac = -1. _d 0
513  Caja      CALL CYCLE_OBCS( k, bi, bj, myThid )             CALL DIAGNOSTICS_SCALE_FILL( dPhiHydX, tmpFac, 1,
514            CALL SET_OBCS( k, bi, bj, myTime+deltaTclock, myThid )       &                           'Um_dPHdx', k, 1, 2, bi, bj, myThid )
515               CALL DIAGNOSTICS_SCALE_FILL( dPhiHydY, tmpFac, 1,
516         &                           'Vm_dPHdy', k, 1, 2, bi, bj, myThid )
517           ENDIF           ENDIF
518  #endif  #endif /* ALLOW_DIAGNOSTICS */
 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  
 CADJ &   , key = kkey, byte = isbyte  
 CADJ STORE gvnm1(:,:,k,bi,bj) = comlev1_bibj_k  
 CADJ &   , key = kkey, byte = isbyte  
 CADJ STORE gwnm1(:,:,k,bi,bj) = comlev1_bibj_k  
 CADJ &   , key = kkey, byte = isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
519    
520              CALL APPLY_OBCS2( bi, bj, k, myThid )  C--      Calculate accelerations in the momentum equations (gU, gV, ...)
521           END IF  C        and step forward storing the result in gU, gV, etc...
522  #endif           IF ( momStepping ) THEN
 C--      Freeze water  
          IF (allowFreezing) THEN  
523  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
524  CADJ STORE gTNm1(:,:,k,bi,bj) = comlev1_bibj_k  # if (defined NONLIN_FRSURF) && (defined ALLOW_MOM_FLUXFORM)
525  CADJ &   , key = kkey, byte = isbyte  #  ifndef DISABLE_RSTAR_CODE
526  #endif /* ALLOW_AUTODIFF_TAMC */  CADJ STORE dWtransC(:,:,bi,bj)
527              CALL FREEZE( bi, bj, iMin, iMax, jMin, jMax, k, myThid )  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
528           END IF  CADJ STORE dWtransU(:,:,bi,bj)
529    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
530  #ifdef DIVG_IN_DYNAMICS  CADJ STORE dWtransV(:,:,bi,bj)
531  C--      Diagnose barotropic divergence of predicted fields  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
532           CALL CALC_DIV_GHAT(  #  endif
533       I       bi,bj,iMin,iMax,jMin,jMax,k,  # endif
      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  
534  #endif  #endif
535               IF (.NOT. vectorInvariantMomentum) THEN
536    #ifdef ALLOW_MOM_FLUXFORM
537    C
538                  CALL MOM_FLUXFORM(
539         I         bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown,
540         I         KappaRU, KappaRV,
541         U         fVerU, fVerV,
542         O         guDissip, gvDissip,
543         I         myTime, myIter, myThid)
544    #endif
545               ELSE
546    #ifdef ALLOW_MOM_VECINV
547    C
548    # ifdef ALLOW_AUTODIFF_TAMC
549    #  ifdef NONLIN_FRSURF
550    CADJ STORE fVerU(:,:,:)
551    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
552    CADJ STORE fVerV(:,:,:)
553    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
554    #  endif
555    # endif /* ALLOW_AUTODIFF_TAMC */
556    C
557                 CALL MOM_VECINV(
558         I         bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown,
559         I         KappaRU, KappaRV,
560         U         fVerU, fVerV,
561         O         guDissip, gvDissip,
562         I         myTime, myIter, myThid)
563    #endif
564               ENDIF
565    C
566               CALL TIMESTEP(
567         I         bi,bj,iMin,iMax,jMin,jMax,k,
568         I         dPhiHydX,dPhiHydY, phiSurfX, phiSurfY,
569         I         guDissip, gvDissip,
570         I         myTime, myIter, myThid)
571    
572             ENDIF
573    
574  C--     k loop  C--     end of dynamics k loop (1:Nr)
575          ENDDO          ENDDO
576    
577  #ifdef ALLOW_AUTODIFF_TAMC  C--     Implicit Vertical advection & viscosity
578             maximpl = 6  #if (defined (INCLUDE_IMPLVERTADV_CODE) && \
579             iikey = (ikey-1)*maximpl       defined (ALLOW_MOM_COMMON) && !(defined ALLOW_AUTODIFF_TAMC))
580  #endif /* ALLOW_AUTODIFF_TAMC */          IF ( momImplVertAdv ) THEN
581              CALL MOM_U_IMPLICIT_R( kappaRU,
582  C--     Implicit diffusion       I                           bi, bj, myTime, myIter, myThid )
583          IF (implicitDiffusion) THEN            CALL MOM_V_IMPLICIT_R( kappaRV,
584         I                           bi, bj, myTime, myIter, myThid )
585           IF (tempStepping) THEN          ELSEIF ( implicitViscosity ) THEN
586  #ifdef ALLOW_AUTODIFF_TAMC  #else /* INCLUDE_IMPLVERTADV_CODE */
587              idkey = iikey + 1          IF     ( implicitViscosity ) THEN
588  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* INCLUDE_IMPLVERTADV_CODE */
589              CALL IMPLDIFF(  #ifdef    ALLOW_AUTODIFF_TAMC
590       I         bi, bj, iMin, iMax, jMin, jMax,  CADJ STORE KappaRU(:,:,:) = comlev1_bibj , key=idynkey, byte=isbyte
591       I         deltaTtracer, KappaRT,recip_HFacC,  CADJ STORE gU(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte
592       U         gTNm1,  #endif    /* ALLOW_AUTODIFF_TAMC */
      I         myThid )  
          END IF  
   
          IF (saltStepping) THEN  
 #ifdef ALLOW_AUTODIFF_TAMC  
          idkey = iikey + 2  
 #endif /* ALLOW_AUTODIFF_TAMC */  
             CALL IMPLDIFF(  
      I         bi, bj, iMin, iMax, jMin, jMax,  
      I         deltaTtracer, KappaRS,recip_HFacC,  
      U         gSNm1,  
      I         myThid )  
          END IF  
   
 C--     implicitDiffusion  
         ENDIF  
   
 C--     Implicit viscosity  
         IF (implicitViscosity) THEN  
   
          IF (momStepping) THEN  
 #ifdef ALLOW_AUTODIFF_TAMC  
          idkey = iikey + 3  
 #endif /* ALLOW_AUTODIFF_TAMC */  
593            CALL IMPLDIFF(            CALL IMPLDIFF(
594       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
595       I         deltaTmom, KappaRU,recip_HFacW,       I         -1, KappaRU, recip_hFacW(1-OLx,1-OLy,1,bi,bj),
596       U         gUNm1,       U         gU,
597       I         myThid )       I         myThid )
598  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef    ALLOW_AUTODIFF_TAMC
599           idkey = iikey + 4  CADJ STORE KappaRV(:,:,:) = comlev1_bibj , key=idynkey, byte=isbyte
600  #endif /* ALLOW_AUTODIFF_TAMC */  CADJ STORE gV(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte
601    #endif    /* ALLOW_AUTODIFF_TAMC */
602            CALL IMPLDIFF(            CALL IMPLDIFF(
603       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
604       I         deltaTmom, KappaRV,recip_HFacS,       I         -2, KappaRV, recip_hFacS(1-OLx,1-OLy,1,bi,bj),
605       U         gVNm1,       U         gV,
606       I         myThid )       I         myThid )
607            ENDIF
608    
609  #ifdef INCLUDE_CD_CODE  #ifdef ALLOW_OBCS
610    C--      Apply open boundary conditions
611            IF ( useOBCS ) THEN
612    C--      but first save intermediate velocities to be used in the
613    C        next time step for the Stevens boundary conditions
614              CALL OBCS_SAVE_UV_N(
615         I        bi, bj, iMin, iMax, jMin, jMax, 0,
616         I        gU, gV, myThid )
617              CALL OBCS_APPLY_UV( bi, bj, 0, gU, gV, myThid )
618            ENDIF
619    #endif /* ALLOW_OBCS */
620    
621  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef    ALLOW_CD_CODE
622           idkey = iikey + 5          IF (implicitViscosity.AND.useCDscheme) THEN
623  #endif /* ALLOW_AUTODIFF_TAMC */  #ifdef    ALLOW_AUTODIFF_TAMC
624    CADJ STORE vVelD(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte
625    #endif    /* ALLOW_AUTODIFF_TAMC */
626            CALL IMPLDIFF(            CALL IMPLDIFF(
627       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
628       I         deltaTmom, KappaRU,recip_HFacW,       I         0, KappaRU, recip_hFacW(1-OLx,1-OLy,1,bi,bj),
629       U         vVelD,       U         vVelD,
630       I         myThid )       I         myThid )
631  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef    ALLOW_AUTODIFF_TAMC
632          idkey = iikey + 6  CADJ STORE uVelD(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte
633  #endif /* ALLOW_AUTODIFF_TAMC */  #endif    /* ALLOW_AUTODIFF_TAMC */
634            CALL IMPLDIFF(            CALL IMPLDIFF(
635       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
636       I         deltaTmom, KappaRV,recip_HFacS,       I         0, KappaRV, recip_hFacS(1-OLx,1-OLy,1,bi,bj),
637       U         uVelD,       U         uVelD,
638       I         myThid )       I         myThid )
639            ENDIF
640    #endif    /* ALLOW_CD_CODE */
641    C--     End implicit Vertical advection & viscosity
642    
643    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
644    
645    #ifdef ALLOW_NONHYDROSTATIC
646    C--   Step forward W field in N-H algorithm
647            IF ( nonHydrostatic ) THEN
648    #ifdef ALLOW_DEBUG
649             IF (debugMode) CALL DEBUG_CALL('CALC_GW', myThid )
650    #endif
651             CALL TIMER_START('CALC_GW          [DYNAMICS]',myThid)
652             CALL CALC_GW(
653         I                 bi,bj, KappaRU, KappaRV,
654         I                 myTime, myIter, myThid )
655            ENDIF
656            IF ( nonHydrostatic.OR.implicitIntGravWave )
657         &   CALL TIMESTEP_WVEL( bi,bj, myTime, myIter, myThid )
658            IF ( nonHydrostatic )
659         &   CALL TIMER_STOP ('CALC_GW          [DYNAMICS]',myThid)
660  #endif  #endif
661    
662  C--      momStepping  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
          ENDIF  
663    
664  C--     implicitViscosity  C-    end of bi,bj loops
         ENDIF  
   
665         ENDDO         ENDDO
666        ENDDO        ENDDO
667    
668    #ifdef ALLOW_OBCS
669          IF (useOBCS) THEN
670            CALL OBCS_EXCHANGES( myThid )
671          ENDIF
672    #endif
673    
674    Cml(
675    C     In order to compare the variance of phiHydLow of a p/z-coordinate
676    C     run with etaH of a z/p-coordinate run the drift of phiHydLow
677    C     has to be removed by something like the following subroutine:
678    C      CALL REMOVE_MEAN_RL( 1, phiHydLow, maskInC, maskInC, rA, drF,
679    C     &                     'phiHydLow', myTime, myThid )
680    Cml)
681    
682    #ifdef ALLOW_DIAGNOSTICS
683          IF ( useDiagnostics ) THEN
684    
685           CALL DIAGNOSTICS_FILL(totPhihyd,'PHIHYD  ',0,Nr,0,1,1,myThid)
686           CALL DIAGNOSTICS_FILL(phiHydLow,'PHIBOT  ',0, 1,0,1,1,myThid)
687    
688           tmpFac = 1. _d 0
689           CALL DIAGNOSTICS_SCALE_FILL(totPhihyd,tmpFac,2,
690         &                                 'PHIHYDSQ',0,Nr,0,1,1,myThid)
691    
692           CALL DIAGNOSTICS_SCALE_FILL(phiHydLow,tmpFac,2,
693         &                                 'PHIBOTSQ',0, 1,0,1,1,myThid)
694    
695          ENDIF
696    #endif /* ALLOW_DIAGNOSTICS */
697    
698    #ifdef ALLOW_DEBUG
699          IF ( debugLevel .GE. debLevD ) THEN
700           CALL DEBUG_STATS_RL(1,EtaN,'EtaN (DYNAMICS)',myThid)
701           CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (DYNAMICS)',myThid)
702           CALL DEBUG_STATS_RL(Nr,vVel,'Vvel (DYNAMICS)',myThid)
703           CALL DEBUG_STATS_RL(Nr,wVel,'Wvel (DYNAMICS)',myThid)
704           CALL DEBUG_STATS_RL(Nr,theta,'Theta (DYNAMICS)',myThid)
705           CALL DEBUG_STATS_RL(Nr,salt,'Salt (DYNAMICS)',myThid)
706           CALL DEBUG_STATS_RL(Nr,gU,'Gu (DYNAMICS)',myThid)
707           CALL DEBUG_STATS_RL(Nr,gV,'Gv (DYNAMICS)',myThid)
708           CALL DEBUG_STATS_RL(Nr,gT,'Gt (DYNAMICS)',myThid)
709           CALL DEBUG_STATS_RL(Nr,gS,'Gs (DYNAMICS)',myThid)
710    #ifndef ALLOW_ADAMSBASHFORTH_3
711           CALL DEBUG_STATS_RL(Nr,guNm1,'GuNm1 (DYNAMICS)',myThid)
712           CALL DEBUG_STATS_RL(Nr,gvNm1,'GvNm1 (DYNAMICS)',myThid)
713           CALL DEBUG_STATS_RL(Nr,gtNm1,'GtNm1 (DYNAMICS)',myThid)
714           CALL DEBUG_STATS_RL(Nr,gsNm1,'GsNm1 (DYNAMICS)',myThid)
715    #endif
716          ENDIF
717    #endif
718    
719    #ifdef DYNAMICS_GUGV_EXCH_CHECK
720    C- jmc: For safety checking only: This Exchange here should not change
721    C       the solution. If solution changes, it means something is wrong,
722    C       but it does not mean that it is less wrong with this exchange.
723          IF ( debugLevel .GE. debLevE ) THEN
724           CALL EXCH_UV_XYZ_RL(gU,gV,.TRUE.,myThid)
725          ENDIF
726    #endif
727    
728    #ifdef ALLOW_DEBUG
729          IF (debugMode) CALL DEBUG_LEAVE( 'DYNAMICS', myThid )
730    #endif
731    
732        RETURN        RETURN
733        END        END
Legend:
Removed from v.1.54.2.1  
changed lines
  Added in v.1.161
  ViewVC Help
Powered by ViewVC 1.1.22