/[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.76 by heimbach, Mon Aug 13 18:05:26 2001 UTC revision 1.134 by heimbach, Wed Jun 7 01:55:12 2006 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  C $Name$
3    
4    #include "PACKAGES_CONFIG.h"
5  #include "CPP_OPTIONS.h"  #include "CPP_OPTIONS.h"
6    #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"
80  #include "PARAMS.h"  #include "PARAMS.h"
81  #include "DYNVARS.h"  #include "DYNVARS.h"
82  #include "GRID.h"  #ifdef ALLOW_CD_CODE
83  #ifdef ALLOW_PASSIVE_TRACER  #include "CD_CODE_VARS.h"
 #include "TR1.h"  
84  #endif  #endif
85    #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  # include "FFIELDS.h"  # 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_GMREDI  # ifdef ALLOW_PTRACERS
95  #  include "GMREDI.h"  #  include "PTRACERS_SIZE.h"
96    #  include "PTRACERS.h"
97    # endif
98    # ifdef ALLOW_OBCS
99    #  include "OBCS.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  # endif
107  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
108    
109  #ifdef ALLOW_TIMEAVE  C     !CALLING SEQUENCE:
110  #include "TIMEAVE_STATV.h"  C     DYNAMICS()
111  #endif  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      |-- OBCS_APPLY_UV
127    C      |
128    C      |-- MOM_U_IMPLICIT_R      
129    C      |-- MOM_V_IMPLICIT_R      
130    C      |
131    C      |-- IMPLDIFF      
132    C      |
133    C      |-- OBCS_APPLY_UV
134    C      |
135    C      |-- CALC_GW
136    C      |
137    C      |-- DIAGNOSTICS_FILL
138    C      |-- DEBUG_STATS_RL
139    
140    C     !INPUT/OUTPUT PARAMETERS:
141  C     == Routine arguments ==  C     == Routine arguments ==
142  C     myTime - Current time in simulation  C     myTime - Current time in simulation
143  C     myIter - Current iteration number in simulation  C     myIter - Current iteration number in simulation
# Line 57  C     myThid - Thread number for this in Line 146  C     myThid - Thread number for this in
146        INTEGER myIter        INTEGER myIter
147        INTEGER myThid        INTEGER myThid
148    
149    C     !LOCAL VARIABLES:
150  C     == Local variables  C     == Local variables
151  C     maskUp                   o maskUp: land/water mask for W points  C     fVer[UV]               o fVer: Vertical flux term - note fVer
152  C     fVer[STUV]               o fVer: Vertical flux term - note fVer  C                                    is "pipelined" in the vertical
153  C                                      is "pipelined" in the vertical  C                                    so we need an fVer for each
154  C                                      so we need an fVer for each  C                                    variable.
155  C                                      variable.  C     phiHydC    :: hydrostatic potential anomaly at cell center
156  C     rhoK, rhoKM1   - Density at current level, and level above  C                   In z coords phiHyd is the hydrostatic potential
157  C     phiHyd         - Hydrostatic part of the potential phiHydi.  C                      (=pressure/rho0) anomaly
158  C                      In z coords phiHydiHyd is the hydrostatic  C                   In p coords phiHyd is the geopotential height anomaly.
159  C                      Potential (=pressure/rho0) anomaly  C     phiHydF    :: hydrostatic potential anomaly at middle between 2 centers
160  C                      In p coords phiHydiHyd is the geopotential  C     dPhiHydX,Y :: Gradient (X & Y directions) of hydrostatic potential anom.
161  C                      surface height anomaly.  C     phiSurfX,  ::  gradient of Surface potential (Pressure/rho, ocean)
162  C     phiSurfX, - gradient of Surface potentiel (Pressure/rho, ocean)  C     phiSurfY             or geopotential (atmos) in X and Y direction
163  C     phiSurfY             or geopotentiel (atmos) in X and Y direction  C     guDissip   :: dissipation tendency (all explicit terms), u component
164    C     gvDissip   :: dissipation tendency (all explicit terms), v component
165  C     iMin, iMax     - Ranges and sub-block indices on which calculations  C     iMin, iMax     - Ranges and sub-block indices on which calculations
166  C     jMin, jMax       are applied.  C     jMin, jMax       are applied.
167  C     bi, bj  C     bi, bj
168  C     k, kup,        - Index for layer above and below. kup and kDown  C     k, kup,        - Index for layer above and below. kup and kDown
169  C     kDown, km1       are switched with layer to be the appropriate  C     kDown, km1       are switched with layer to be the appropriate
170  C                      index into fVerTerm.  C                      index into fVerTerm.
 C     tauAB - Adams-Bashforth timestepping weight: 0=forward ; 1/2=Adams-Bashf.  
       _RS maskUp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
171        _RL fVerU   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerU   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
172        _RL fVerV   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerV   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
173        _RL phiHyd  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL phiHydF (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
174        _RL rhokm1  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL phiHydC (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
175        _RL rhok    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL dPhiHydX(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
176          _RL dPhiHydY(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
177        _RL phiSurfX(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL phiSurfX(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
178        _RL phiSurfY(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL phiSurfY(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
179          _RL guDissip(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
180          _RL gvDissip(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
181        _RL KappaRU (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)        _RL KappaRU (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)
182        _RL KappaRV (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)        _RL KappaRV (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)
       _RL sigmaX  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)  
       _RL sigmaY  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)  
       _RL sigmaR  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)  
       _RL tauAB  
   
 C This is currently used by IVDC and Diagnostics  
       _RL ConvectCount (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)  
183    
184        INTEGER iMin, iMax        INTEGER iMin, iMax
185        INTEGER jMin, jMax        INTEGER jMin, jMax
186        INTEGER bi, bj        INTEGER bi, bj
187        INTEGER i, j        INTEGER i, j
188        INTEGER k, km1, kup, kDown        INTEGER k, km1, kp1, kup, kDown
189    
190    #ifdef ALLOW_DIAGNOSTICS
191          _RL tmpFac
192    #endif /* ALLOW_DIAGNOSTICS */
193    
 Cjmc : add for phiHyd output <- but not working if multi tile per CPU  
 c     CHARACTER*(MAX_LEN_MBUF) suff  
 c     LOGICAL  DIFFERENT_MULTIPLE  
 c     EXTERNAL DIFFERENT_MULTIPLE  
 Cjmc(end)  
194    
195  C---    The algorithm...  C---    The algorithm...
196  C  C
# Line 151  C         salt* = salt[n] + dt x ( 3/2 G Line 235  C         salt* = salt[n] + dt x ( 3/2 G
235  C         (1 + dt * K * d_zz) theta[n] = theta*  C         (1 + dt * K * d_zz) theta[n] = theta*
236  C         (1 + dt * K * d_zz) salt[n] = salt*  C         (1 + dt * K * d_zz) salt[n] = salt*
237  C---  C---
238    CEOP
239    
240  C--   Set up work arrays with valid (i.e. not NaN) values  #ifdef ALLOW_DEBUG
241  C     These inital values do not alter the numerical results. They        IF ( debugLevel .GE. debLevB )
242  C     just ensure that all memory references are to valid floating       &   CALL DEBUG_ENTER( 'DYNAMICS', myThid )
243  C     point numbers. This prevents spurious hardware signals due to  #endif
244  C     uninitialised but inert locations.  
245        DO j=1-OLy,sNy+OLy  C-- Call to routine for calculation of
246         DO i=1-OLx,sNx+OLx  C   Eliassen-Palm-flux-forced U-tendency,
247          DO k=1,Nr  C   if desired:
248           phiHyd(i,j,k)  = 0. _d 0  #ifdef INCLUDE_EP_FORCING_CODE
249           KappaRU(i,j,k) = 0. _d 0        CALL CALC_EP_FORCING(myThid)
250           KappaRV(i,j,k) = 0. _d 0  #endif
          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  
         phiSurfX(i,j) = 0. _d 0  
         phiSurfY(i,j) = 0. _d 0  
        ENDDO  
       ENDDO  
251    
252  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
253  C--   HPF directive to help TAMC  C--   HPF directive to help TAMC
# Line 184  CHPF$ INDEPENDENT Line 259  CHPF$ INDEPENDENT
259  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
260  C--    HPF directive to help TAMC  C--    HPF directive to help TAMC
261  CHPF$  INDEPENDENT, NEW (fVerU,fVerV  CHPF$  INDEPENDENT, NEW (fVerU,fVerV
262  CHPF$&                  ,phiHyd  CHPF$&                  ,phiHydF
263  CHPF$&                  ,KappaRU,KappaRV  CHPF$&                  ,KappaRU,KappaRV
264  CHPF$&                  )  CHPF$&                  )
265  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
# Line 194  CHPF$&                  ) Line 269  CHPF$&                  )
269  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
270            act1 = bi - myBxLo(myThid)            act1 = bi - myBxLo(myThid)
271            max1 = myBxHi(myThid) - myBxLo(myThid) + 1            max1 = myBxHi(myThid) - myBxLo(myThid) + 1
   
272            act2 = bj - myByLo(myThid)            act2 = bj - myByLo(myThid)
273            max2 = myByHi(myThid) - myByLo(myThid) + 1            max2 = myByHi(myThid) - myByLo(myThid) + 1
   
274            act3 = myThid - 1            act3 = myThid - 1
275            max3 = nTx*nTy            max3 = nTx*nTy
   
276            act4 = ikey_dynamics - 1            act4 = ikey_dynamics - 1
277              idynkey = (act1 + 1) + act2*max1
           ikey = (act1 + 1) + act2*max1  
278       &                      + act3*max1*max2       &                      + act3*max1*max2
279       &                      + act4*max1*max2*max3       &                      + act4*max1*max2*max3
280  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
281    
282  C--     Set up work arrays that need valid initial values  C--   Set up work arrays with valid (i.e. not NaN) values
283    C     These inital values do not alter the numerical results. They
284    C     just ensure that all memory references are to valid floating
285    C     point numbers. This prevents spurious hardware signals due to
286    C     uninitialised but inert locations.
287    
288            DO k=1,Nr
289             DO j=1-OLy,sNy+OLy
290              DO i=1-OLx,sNx+OLx
291               KappaRU(i,j,k) = 0. _d 0
292               KappaRV(i,j,k) = 0. _d 0
293    #ifdef ALLOW_AUTODIFF_TAMC
294    cph(
295    c--   need some re-initialisation here to break dependencies
296    cph)
297               gU(i,j,k,bi,bj) = 0. _d 0
298               gV(i,j,k,bi,bj) = 0. _d 0
299    #endif
300              ENDDO
301             ENDDO
302            ENDDO
303          DO j=1-OLy,sNy+OLy          DO j=1-OLy,sNy+OLy
304           DO i=1-OLx,sNx+OLx           DO i=1-OLx,sNx+OLx
305            fVerU  (i,j,1) = 0. _d 0            fVerU  (i,j,1) = 0. _d 0
306            fVerU  (i,j,2) = 0. _d 0            fVerU  (i,j,2) = 0. _d 0
307            fVerV  (i,j,1) = 0. _d 0            fVerV  (i,j,1) = 0. _d 0
308            fVerV  (i,j,2) = 0. _d 0            fVerV  (i,j,2) = 0. _d 0
309              phiHydF (i,j)  = 0. _d 0
310              phiHydC (i,j)  = 0. _d 0
311              dPhiHydX(i,j)  = 0. _d 0
312              dPhiHydY(i,j)  = 0. _d 0
313              phiSurfX(i,j)  = 0. _d 0
314              phiSurfY(i,j)  = 0. _d 0
315              guDissip(i,j)  = 0. _d 0
316              gvDissip(i,j)  = 0. _d 0
317    #ifdef ALLOW_AUTODIFF_TAMC
318    cph(
319    c--   need some re-initialisation here to break dependencies
320    cph)
321    # ifdef NONLIN_FRSURF
322    #  ifndef DISABLE_RSTAR_CODE
323              dWtransC(i,j,bi,bj)  = 0. _d 0
324              dWtransU(i,j,bi,bj)  = 0. _d 0
325              dWtransV(i,j,bi,bj)  = 0. _d 0
326    #  endif
327    # endif /* NONLIN_FRSURF */
328    #endif /* ALLOW_AUTODIFF_TAMC */
329           ENDDO           ENDDO
330          ENDDO          ENDDO
331    
332  C--     Start computation of dynamics  C--     Start computation of dynamics
333          iMin = 1-OLx+2          iMin = 0
334          iMax = sNx+OLx-1          iMax = sNx+1
335          jMin = 1-OLy+2          jMin = 0
336          jMax = sNy+OLy-1          jMax = sNy+1
337    
338  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
339  CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte  CADJ STORE wvel (:,:,:,bi,bj) =
340  CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte  CADJ &     comlev1_bibj, key = idynkey, byte = isbyte
 CADJ STORE wvel (:,:,:,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte  
341  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
342    
343  C--     Explicit part of the Surface Potentiel Gradient (add in TIMESTEP)  C--     Explicit part of the Surface Potentiel Gradient (add in TIMESTEP)
# Line 240  C       (note: this loop will be replace Line 350  C       (note: this loop will be replace
350       I         myThid )                               I         myThid )                        
351          ENDIF          ENDIF
352    
353    #ifdef ALLOW_AUTODIFF_TAMC
354    CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key=idynkey, byte=isbyte
355    CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key=idynkey, byte=isbyte
356    #ifdef ALLOW_KPP
357    CADJ STORE KPPviscAz (:,:,:,bi,bj)
358    CADJ &                 = comlev1_bibj, key=idynkey, byte=isbyte
359    #endif /* ALLOW_KPP */
360    #endif /* ALLOW_AUTODIFF_TAMC */
361    
362    #ifdef  INCLUDE_CALC_DIFFUSIVITY_CALL
363    C--      Calculate the total vertical diffusivity
364            DO k=1,Nr
365             CALL CALC_VISCOSITY(
366         I        bi,bj,iMin,iMax,jMin,jMax,k,
367         O        KappaRU,KappaRV,
368         I        myThid)
369           ENDDO
370    #endif
371    
372    #ifdef ALLOW_AUTODIFF_TAMC
373    CADJ STORE KappaRU(:,:,:)
374    CADJ &     = comlev1_bibj, key=idynkey, byte=isbyte
375    CADJ STORE KappaRV(:,:,:)
376    CADJ &     = comlev1_bibj, key=idynkey, byte=isbyte
377    #endif /* ALLOW_AUTODIFF_TAMC */
378    
379  C--     Start of dynamics loop  C--     Start of dynamics loop
380          DO k=1,Nr          DO k=1,Nr
381    
# Line 248  C--       kup    Cycles through 1,2 to p Line 384  C--       kup    Cycles through 1,2 to p
384  C--       kDown  Cycles through 2,1 to point to current layer  C--       kDown  Cycles through 2,1 to point to current layer
385    
386            km1  = MAX(1,k-1)            km1  = MAX(1,k-1)
387              kp1  = MIN(k+1,Nr)
388            kup  = 1+MOD(k+1,2)            kup  = 1+MOD(k+1,2)
389            kDown= 1+MOD(k,2)            kDown= 1+MOD(k,2)
390    
391  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
392           kkey = (ikey-1)*Nr + k           kkey = (idynkey-1)*Nr + k
393    c
394    CADJ STORE totphihyd (:,:,k,bi,bj)
395    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
396    CADJ STORE theta (:,:,k,bi,bj)
397    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
398    CADJ STORE salt  (:,:,k,bi,bj)
399    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
400    CADJ STORE gt(:,:,k,bi,bj)
401    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
402    CADJ STORE gs(:,:,k,bi,bj)
403    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
404    # ifdef NONLIN_FRSURF
405    cph-test
406    CADJ STORE  phiHydC (:,:)
407    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
408    CADJ STORE  phiHydF (:,:)
409    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
410    CADJ STORE  gudissip (:,:)
411    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
412    CADJ STORE  gvdissip (:,:)
413    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
414    CADJ STORE  fVerU (:,:,:)
415    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
416    CADJ STORE  fVerV (:,:,:)
417    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
418    CADJ STORE gu(:,:,k,bi,bj)
419    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
420    CADJ STORE gv(:,:,k,bi,bj)
421    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
422    CADJ STORE gunm1(:,:,k,bi,bj)
423    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
424    CADJ STORE gvnm1(:,:,k,bi,bj)
425    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
426    #  ifndef DISABLE_RSTAR_CODE
427    CADJ STORE dwtransc(:,:,bi,bj)
428    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
429    CADJ STORE dwtransu(:,:,bi,bj)
430    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
431    CADJ STORE dwtransv(:,:,bi,bj)
432    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
433    #  endif
434    #  ifdef ALLOW_CD_CODE
435    CADJ STORE unm1(:,:,k,bi,bj)
436    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
437    CADJ STORE vnm1(:,:,k,bi,bj)
438    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
439    CADJ STORE uVelD(:,:,k,bi,bj)
440    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
441    CADJ STORE vVelD(:,:,k,bi,bj)
442    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
443    #  endif
444    # endif
445    # ifdef ALLOW_DEPTH_CONTROL
446    CADJ STORE  fVerU (:,:,:)
447    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
448    CADJ STORE  fVerV (:,:,:)
449    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
450    # endif
451  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
452    
453  C--      Integrate hydrostatic balance for phiHyd with BC of  C--      Integrate hydrostatic balance for phiHyd with BC of
454  C        phiHyd(z=0)=0  C        phiHyd(z=0)=0
455  C        distinguishe between Stagger and Non Stagger time stepping           IF ( implicitIntGravWave ) THEN
          IF (staggerTimeStep) THEN  
456             CALL CALC_PHI_HYD(             CALL CALC_PHI_HYD(
457       I        bi,bj,iMin,iMax,jMin,jMax,k,       I        bi,bj,iMin,iMax,jMin,jMax,k,
458       I        gTnm1, gSnm1,       I        gT, gS,
459       U        phiHyd,       U        phiHydF,
460       I        myThid )       O        phiHydC, dPhiHydX, dPhiHydY,
461         I        myTime, myIter, myThid )
462           ELSE           ELSE
463             CALL CALC_PHI_HYD(             CALL CALC_PHI_HYD(
464       I        bi,bj,iMin,iMax,jMin,jMax,k,       I        bi,bj,iMin,iMax,jMin,jMax,k,
465       I        theta, salt,       I        theta, salt,
466       U        phiHyd,       U        phiHydF,
467       I        myThid )       O        phiHydC, dPhiHydX, dPhiHydY,
468         I        myTime, myIter, myThid )
469           ENDIF           ENDIF
470    
 #ifdef  INCLUDE_CALC_DIFFUSIVITY_CALL  
 C--      Calculate the total vertical diffusivity  
          CALL CALC_VISCOSITY(  
      I        bi,bj,iMin,iMax,jMin,jMax,k,  
      I        maskUp,  
      O        KappaRU,KappaRV,  
      I        myThid)  
 #endif  
   
471  C--      Calculate accelerations in the momentum equations (gU, gV, ...)  C--      Calculate accelerations in the momentum equations (gU, gV, ...)
472  C        and step forward storing the result in gUnm1, gVnm1, etc...  C        and step forward storing the result in gU, gV, etc...
473           IF ( momStepping ) THEN           IF ( momStepping ) THEN
474             CALL CALC_MOM_RHS(             IF (.NOT. vectorInvariantMomentum) THEN
475    #ifdef ALLOW_MOM_FLUXFORM
476    C
477    # ifdef ALLOW_AUTODIFF_TAMC
478    #  ifdef NONLIN_FRSURF
479    #   ifndef DISABLE_RSTAR_CODE
480    CADJ STORE dwtransc(:,:,bi,bj)
481    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
482    CADJ STORE dwtransu(:,:,bi,bj)
483    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
484    CADJ STORE dwtransv(:,:,bi,bj)
485    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
486    #   endif
487    #  endif
488    # endif /* ALLOW_AUTODIFF_TAMC */
489    C
490                  CALL MOM_FLUXFORM(
491         I         bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown,
492         I         KappaRU, KappaRV,
493         U         fVerU, fVerV,
494         O         guDissip, gvDissip,
495         I         myTime, myIter, myThid)
496    #endif
497               ELSE
498    #ifdef ALLOW_MOM_VECINV
499    C
500    # ifdef ALLOW_AUTODIFF_TAMC
501    #  ifdef NONLIN_FRSURF
502    CADJ STORE fVerU(:,:,:)
503    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
504    CADJ STORE fVerV(:,:,:)
505    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
506    #  endif
507    # endif /* ALLOW_AUTODIFF_TAMC */
508    C
509                 CALL MOM_VECINV(
510       I         bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown,       I         bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown,
511       I         phiHyd,KappaRU,KappaRV,       I         KappaRU, KappaRV,
512       U         fVerU, fVerV,       U         fVerU, fVerV,
513       I         myTime, myThid)       O         guDissip, gvDissip,
514         I         myTime, myIter, myThid)
515    #endif
516               ENDIF
517    C
518             CALL TIMESTEP(             CALL TIMESTEP(
519       I         bi,bj,iMin,iMax,jMin,jMax,k,       I         bi,bj,iMin,iMax,jMin,jMax,k,
520       I         phiHyd, phiSurfX, phiSurfY,       I         dPhiHydX,dPhiHydY, phiSurfX, phiSurfY,
521       I         myIter, myThid)       I         guDissip, gvDissip,
522         I         myTime, myIter, myThid)
523    
524  #ifdef   ALLOW_OBCS  #ifdef   ALLOW_OBCS
525  C--      Apply open boundary conditions  C--      Apply open boundary conditions
526           IF (useOBCS) THEN             IF (useOBCS) THEN
527             CALL OBCS_APPLY_UV( bi, bj, k, gUnm1, gVnm1, myThid )               CALL OBCS_APPLY_UV( bi, bj, k, gU, gV, myThid )
528           END IF             ENDIF
529  #endif   /* ALLOW_OBCS */  #endif   /* ALLOW_OBCS */
530    
 #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 */  
531           ENDIF           ENDIF
532    
533    
534  C--     end of dynamics k loop (1:Nr)  C--     end of dynamics k loop (1:Nr)
535          ENDDO          ENDDO
536    
537    C--     Implicit Vertical advection & viscosity
538    #if (defined (INCLUDE_IMPLVERTADV_CODE) && defined (ALLOW_MOM_COMMON))
539  C--     Implicit viscosity          IF ( momImplVertAdv ) THEN
540          IF (implicitViscosity.AND.momStepping) THEN            CALL MOM_U_IMPLICIT_R( kappaRU,
541         I                           bi, bj, myTime, myIter, myThid )
542              CALL MOM_V_IMPLICIT_R( kappaRV,
543         I                           bi, bj, myTime, myIter, myThid )
544            ELSEIF ( implicitViscosity ) THEN
545    #else /* INCLUDE_IMPLVERTADV_CODE */
546            IF     ( implicitViscosity ) THEN
547    #endif /* INCLUDE_IMPLVERTADV_CODE */
548  #ifdef    ALLOW_AUTODIFF_TAMC  #ifdef    ALLOW_AUTODIFF_TAMC
549            idkey = iikey + 3  CADJ STORE KappaRU(:,:,:) = comlev1_bibj , key=idynkey, byte=isbyte
550  CADJ STORE gUNm1(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte  CADJ STORE gU(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte
551  #endif    /* ALLOW_AUTODIFF_TAMC */  #endif    /* ALLOW_AUTODIFF_TAMC */
552            CALL IMPLDIFF(            CALL IMPLDIFF(
553       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
554       I         deltaTmom, KappaRU,recip_HFacW,       I         -1, KappaRU,recip_HFacW,
555       U         gUNm1,       U         gU,
556       I         myThid )       I         myThid )
557  #ifdef    ALLOW_AUTODIFF_TAMC  #ifdef    ALLOW_AUTODIFF_TAMC
558            idkey = iikey + 4  CADJ STORE KappaRV(:,:,:) = comlev1_bibj , key=idynkey, byte=isbyte
559  CADJ STORE gVNm1(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte  CADJ STORE gV(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte
560  #endif    /* ALLOW_AUTODIFF_TAMC */  #endif    /* ALLOW_AUTODIFF_TAMC */
561            CALL IMPLDIFF(            CALL IMPLDIFF(
562       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
563       I         deltaTmom, KappaRV,recip_HFacS,       I         -2, KappaRV,recip_HFacS,
564       U         gVNm1,       U         gV,
565       I         myThid )       I         myThid )
566            ENDIF
567    
568  #ifdef   ALLOW_OBCS  #ifdef   ALLOW_OBCS
569  C--      Apply open boundary conditions  C--      Apply open boundary conditions
570           IF (useOBCS) THEN          IF ( useOBCS .AND.(implicitViscosity.OR.momImplVertAdv) ) THEN
571             DO K=1,Nr             DO K=1,Nr
572               CALL OBCS_APPLY_UV( bi, bj, k, gUnm1, gVnm1, myThid )               CALL OBCS_APPLY_UV( bi, bj, k, gU, gV, myThid )
573             ENDDO             ENDDO
574           END IF          ENDIF
575  #endif   /* ALLOW_OBCS */  #endif   /* ALLOW_OBCS */
576    
577  #ifdef    INCLUDE_CD_CODE  #ifdef    ALLOW_CD_CODE
578            IF (implicitViscosity.AND.useCDscheme) THEN
579  #ifdef    ALLOW_AUTODIFF_TAMC  #ifdef    ALLOW_AUTODIFF_TAMC
580            idkey = iikey + 5  CADJ STORE vVelD(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte
 CADJ STORE vVelD(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte  
581  #endif    /* ALLOW_AUTODIFF_TAMC */  #endif    /* ALLOW_AUTODIFF_TAMC */
582            CALL IMPLDIFF(            CALL IMPLDIFF(
583       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
584       I         deltaTmom, KappaRU,recip_HFacW,       I         0, KappaRU,recip_HFacW,
585       U         vVelD,       U         vVelD,
586       I         myThid )       I         myThid )
587  #ifdef    ALLOW_AUTODIFF_TAMC  #ifdef    ALLOW_AUTODIFF_TAMC
588            idkey = iikey + 6  CADJ STORE uVelD(:,:,:,bi,bj) = comlev1_bibj , key=idynkey, byte=isbyte
 CADJ STORE uVelD(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte  
589  #endif    /* ALLOW_AUTODIFF_TAMC */  #endif    /* ALLOW_AUTODIFF_TAMC */
590            CALL IMPLDIFF(            CALL IMPLDIFF(
591       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
592       I         deltaTmom, KappaRV,recip_HFacS,       I         0, KappaRV,recip_HFacS,
593       U         uVelD,       U         uVelD,
594       I         myThid )       I         myThid )
 #endif    /* INCLUDE_CD_CODE */  
 C--     End If implicitViscosity.AND.momStepping  
595          ENDIF          ENDIF
596    #endif    /* ALLOW_CD_CODE */
597    C--     End implicit Vertical advection & viscosity
598    
 Cjmc : add for phiHyd output <- but not working if multi tile per CPU  
 c       IF ( DIFFERENT_MULTIPLE(dumpFreq,myTime+deltaTClock,myTime)  
 c    &  .AND. buoyancyRelation .eq. 'ATMOSPHERIC' ) THEN  
 c         WRITE(suff,'(I10.10)') myIter+1  
 c         CALL WRITE_FLD_XYZ_RL('PH.',suff,phiHyd,myIter+1,myThid)  
 c       ENDIF  
 Cjmc(end)  
   
 #ifdef ALLOW_TIMEAVE  
         IF (taveFreq.GT.0.) THEN  
           CALL TIMEAVE_CUMUL_1T(phiHydtave, phiHyd, Nr,  
      I                              deltaTclock, bi, bj, myThid)  
           IF (ivdc_kappa.NE.0.) THEN  
             CALL TIMEAVE_CUMULATE(ConvectCountTave, ConvectCount, Nr,  
      I                              deltaTclock, bi, bj, myThid)  
           ENDIF  
         ENDIF  
 #endif /* ALLOW_TIMEAVE */  
   
599         ENDDO         ENDDO
600        ENDDO        ENDDO
601    
602  #ifndef EXCLUDE_DEBUGMODE  #ifdef ALLOW_OBCS
603        If (debugMode) THEN        IF (useOBCS) THEN
604           CALL OBCS_PRESCRIBE_EXCHANGES(myThid)
605          ENDIF
606    #endif
607    
608    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
609    
610    #ifdef ALLOW_NONHYDROSTATIC
611    C--   Step forward W field in N-H algorithm
612          IF ( nonHydrostatic ) THEN
613    #ifdef ALLOW_DEBUG
614             IF ( debugLevel .GE. debLevB )
615         &     CALL DEBUG_CALL('CALC_GW', myThid )
616    #endif
617             CALL TIMER_START('CALC_GW          [DYNAMICS]',myThid)
618             CALL CALC_GW( myTime, myIter, myThid )
619          ENDIF
620          IF ( nonHydrostatic.OR.implicitIntGravWave )
621         &   CALL TIMESTEP_WVEL( myTime, myIter, myThid )
622          IF ( nonHydrostatic )
623         &   CALL TIMER_STOP ('CALC_GW          [DYNAMICS]',myThid)
624    #endif
625    
626    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
627    
628    Cml(
629    C     In order to compare the variance of phiHydLow of a p/z-coordinate
630    C     run with etaH of a z/p-coordinate run the drift of phiHydLow
631    C     has to be removed by something like the following subroutine:
632    C      CALL REMOVE_MEAN_RL( 1, phiHydLow, maskH, maskH, rA, drF,
633    C     &                'phiHydLow', myThid )
634    Cml)
635    
636    #ifdef ALLOW_DIAGNOSTICS
637          IF ( useDiagnostics ) THEN
638    
639           CALL DIAGNOSTICS_FILL(totPhihyd,'PHIHYD  ',0,Nr,0,1,1,myThid)
640           CALL DIAGNOSTICS_FILL(phiHydLow,'PHIBOT  ',0, 1,0,1,1,myThid)
641    
642           tmpFac = 1. _d 0
643           CALL DIAGNOSTICS_SCALE_FILL(totPhihyd,tmpFac,2,
644         &                                 'PHIHYDSQ',0,Nr,0,1,1,myThid)
645    
646           CALL DIAGNOSTICS_SCALE_FILL(phiHydLow,tmpFac,2,
647         &                                 'PHIBOTSQ',0, 1,0,1,1,myThid)
648    
649          ENDIF
650    #endif /* ALLOW_DIAGNOSTICS */
651          
652    #ifdef ALLOW_DEBUG
653          If ( debugLevel .GE. debLevB ) THEN
654         CALL DEBUG_STATS_RL(1,EtaN,'EtaN (DYNAMICS)',myThid)         CALL DEBUG_STATS_RL(1,EtaN,'EtaN (DYNAMICS)',myThid)
655         CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (DYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (DYNAMICS)',myThid)
656         CALL DEBUG_STATS_RL(Nr,vVel,'Vvel (DYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,vVel,'Vvel (DYNAMICS)',myThid)
657         CALL DEBUG_STATS_RL(Nr,wVel,'Wvel (DYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,wVel,'Wvel (DYNAMICS)',myThid)
658         CALL DEBUG_STATS_RL(Nr,theta,'Theta (DYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,theta,'Theta (DYNAMICS)',myThid)
659         CALL DEBUG_STATS_RL(Nr,salt,'Salt (DYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,salt,'Salt (DYNAMICS)',myThid)
660         CALL DEBUG_STATS_RL(Nr,Gu,'Gu (DYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,gU,'Gu (DYNAMICS)',myThid)
661         CALL DEBUG_STATS_RL(Nr,Gv,'Gv (DYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,gV,'Gv (DYNAMICS)',myThid)
662         CALL DEBUG_STATS_RL(Nr,Gt,'Gt (DYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,gT,'Gt (DYNAMICS)',myThid)
663         CALL DEBUG_STATS_RL(Nr,Gs,'Gs (DYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,gS,'Gs (DYNAMICS)',myThid)
664         CALL DEBUG_STATS_RL(Nr,GuNm1,'GuNm1 (DYNAMICS)',myThid)  #ifndef ALLOW_ADAMSBASHFORTH_3
665         CALL DEBUG_STATS_RL(Nr,GvNm1,'GvNm1 (DYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,guNm1,'GuNm1 (DYNAMICS)',myThid)
666         CALL DEBUG_STATS_RL(Nr,GtNm1,'GtNm1 (DYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,gvNm1,'GvNm1 (DYNAMICS)',myThid)
667         CALL DEBUG_STATS_RL(Nr,GsNm1,'GsNm1 (DYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,gtNm1,'GtNm1 (DYNAMICS)',myThid)
668           CALL DEBUG_STATS_RL(Nr,gsNm1,'GsNm1 (DYNAMICS)',myThid)
669    #endif
670          ENDIF
671    #endif
672    
673    #ifdef DYNAMICS_GUGV_EXCH_CHECK
674    C- jmc: For safety checking only: This Exchange here should not change
675    C       the solution. If solution changes, it means something is wrong,
676    C       but it does not mean that it is less wrong with this exchange.
677          IF ( debugLevel .GT. debLevB ) THEN
678           CALL EXCH_UV_XYZ_RL(gU,gV,.TRUE.,myThid)
679        ENDIF        ENDIF
680  #endif  #endif
681    
682    #ifdef ALLOW_DEBUG
683          IF ( debugLevel .GE. debLevB )
684         &   CALL DEBUG_LEAVE( 'DYNAMICS', myThid )
685    #endif
686    
687        RETURN        RETURN
688        END        END
Legend:
Removed from v.1.76  
changed lines
  Added in v.1.134
  ViewVC Help
Powered by ViewVC 1.1.22