/[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.117 by molod, Mon May 23 20:49:37 2005 UTC revision 1.165 by jmc, Sat Aug 3 01:38:17 2013 UTC
# Line 3  C $Name$ Line 3  C $Name$
3    
4  #include "PACKAGES_CONFIG.h"  #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  CBOP
13  C     !ROUTINE: DYNAMICS  C     !ROUTINE: DYNAMICS
# Line 10  C     !INTERFACE: Line 15  C     !INTERFACE:
15        SUBROUTINE DYNAMICS(myTime, myIter, myThid)        SUBROUTINE DYNAMICS(myTime, myIter, myThid)
16  C     !DESCRIPTION: \bv  C     !DESCRIPTION: \bv
17  C     *==========================================================*  C     *==========================================================*
18  C     | SUBROUTINE DYNAMICS                                        C     | SUBROUTINE DYNAMICS
19  C     | o Controlling routine for the explicit part of the model    C     | o Controlling routine for the explicit part of the model
20  C     |   dynamics.                                                C     |   dynamics.
21  C     *==========================================================*  C     *==========================================================*
22  C     | This routine evaluates the "dynamics" terms for each        C     | This routine evaluates the "dynamics" terms for each
23  C     | block of ocean in turn. Because the blocks of ocean have    C     | block of ocean in turn. Because the blocks of ocean have
24  C     | overlap regions they are independent of one another.        C     | overlap regions they are independent of one another.
25  C     | If terms involving lateral integrals are needed in this    C     | If terms involving lateral integrals are needed in this
26  C     | routine care will be needed. Similarly finite-difference    C     | routine care will be needed. Similarly finite-difference
27  C     | operations with stencils wider than the overlap region      C     | operations with stencils wider than the overlap region
28  C     | require special consideration.                              C     | require special consideration.
29  C     | The algorithm...  C     | The algorithm...
30  C     |  C     |
31  C     | "Correction Step"  C     | "Correction Step"
# Line 30  C     | pressure such that the resulting Line 35  C     | pressure such that the resulting
35  C     | with the free-surface evolution or the rigid-lid:  C     | with the free-surface evolution or the rigid-lid:
36  C     |   U[n] = U* + dt x d/dx P  C     |   U[n] = U* + dt x d/dx P
37  C     |   V[n] = V* + dt x d/dy P  C     |   V[n] = V* + dt x d/dy P
38    C     |   W[n] = W* + dt x d/dz P  (NH mode)
39  C     |  C     |
40  C     | "Calculation of Gs"  C     | "Calculation of Gs"
41  C     | ===================  C     | ===================
# Line 72  C     == Global variables === Line 78  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 "GRID.h"
82  #include "DYNVARS.h"  #include "DYNVARS.h"
83  #ifdef ALLOW_CD_CODE  #ifdef ALLOW_CD_CODE
84  #include "CD_CODE_VARS.h"  # include "CD_CODE_VARS.h"
85  #endif  #endif
 #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"
# Line 85  C     == Global variables === Line 91  C     == Global variables ===
91  # ifdef ALLOW_KPP  # ifdef ALLOW_KPP
92  #  include "KPP.h"  #  include "KPP.h"
93  # endif  # endif
94    # ifdef ALLOW_PTRACERS
95    #  include "PTRACERS_SIZE.h"
96    #  include "PTRACERS_FIELDS.h"
97    # endif
98    # ifdef ALLOW_OBCS
99    #  include "OBCS_PARAMS.h"
100    #  include "OBCS_FIELDS.h"
101    #  ifdef ALLOW_PTRACERS
102    #   include "OBCS_PTRACERS.h"
103    #  endif
104    # endif
105    # ifdef ALLOW_MOM_FLUXFORM
106    #  include "MOM_FLUXFORM.h"
107    # endif
108  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
109    
110  C     !CALLING SEQUENCE:  C     !CALLING SEQUENCE:
111  C     DYNAMICS()  C     DYNAMICS()
112  C      |  C      |
113    C      |-- CALC_EP_FORCING
114    C      |
115  C      |-- CALC_GRAD_PHI_SURF  C      |-- CALC_GRAD_PHI_SURF
116  C      |  C      |
117  C      |-- CALC_VISCOSITY  C      |-- CALC_VISCOSITY
118  C      |  C      |
119  C      |-- CALC_PHI_HYD    C      |-- CALC_PHI_HYD
120  C      |  C      |
121  C      |-- MOM_FLUXFORM    C      |-- MOM_FLUXFORM
122  C      |  C      |
123  C      |-- MOM_VECINV      C      |-- MOM_VECINV
124  C      |  C      |
125  C      |-- TIMESTEP        C      |-- TIMESTEP
126  C      |  C      |
127  C      |-- OBCS_APPLY_UV  C      |-- MOM_U_IMPLICIT_R
128    C      |-- MOM_V_IMPLICIT_R
129  C      |  C      |
130  C      |-- IMPLDIFF        C      |-- IMPLDIFF
131  C      |  C      |
132  C      |-- OBCS_APPLY_UV  C      |-- OBCS_APPLY_UV
133  C      |  C      |
134  C      |-- CALL DEBUG_STATS_RL  C      |-- CALC_GW
135    C      |
136    C      |-- DIAGNOSTICS_FILL
137    C      |-- DEBUG_STATS_RL
138    
139  C     !INPUT/OUTPUT PARAMETERS:  C     !INPUT/OUTPUT PARAMETERS:
140  C     == Routine arguments ==  C     == Routine arguments ==
141  C     myTime - Current time in simulation  C     myTime :: Current time in simulation
142  C     myIter - Current iteration number in simulation  C     myIter :: Current iteration number in simulation
143  C     myThid - Thread number for this instance of the routine.  C     myThid :: Thread number for this instance of the routine.
144        _RL myTime        _RL myTime
145        INTEGER myIter        INTEGER myIter
146        INTEGER myThid        INTEGER myThid
147    
148    C     !FUNCTIONS:
149    #ifdef ALLOW_DIAGNOSTICS
150          LOGICAL  DIAGNOSTICS_IS_ON
151          EXTERNAL DIAGNOSTICS_IS_ON
152    #endif
153    
154  C     !LOCAL VARIABLES:  C     !LOCAL VARIABLES:
155  C     == Local variables  C     == Local variables
156  C     fVer[UV]               o fVer: Vertical flux term - note fVer  C     fVer[UV]               o fVer: Vertical flux term - note fVer
# Line 135  C     phiSurfX,  ::  gradient of Surface Line 167  C     phiSurfX,  ::  gradient of Surface
167  C     phiSurfY             or geopotential (atmos) in X and Y direction  C     phiSurfY             or geopotential (atmos) in X and Y direction
168  C     guDissip   :: dissipation tendency (all explicit terms), u component  C     guDissip   :: dissipation tendency (all explicit terms), u component
169  C     gvDissip   :: dissipation tendency (all explicit terms), v component  C     gvDissip   :: dissipation tendency (all explicit terms), v component
170  C     iMin, iMax     - Ranges and sub-block indices on which calculations  C     KappaRU    :: vertical viscosity for velocity U-component
171  C     jMin, jMax       are applied.  C     KappaRV    :: vertical viscosity for velocity V-component
172  C     bi, bj  C     iMin, iMax :: Ranges and sub-block indices on which calculations
173  C     k, kup,        - Index for layer above and below. kup and kDown  C     jMin, jMax    are applied.
174  C     kDown, km1       are switched with layer to be the appropriate  C     bi, bj     :: tile indices
175  C                      index into fVerTerm.  C     k          :: current level index
176    C     km1, kp1   :: index of level above (k-1) and below (k+1)
177    C     kUp, kDown :: Index for interface above and below. kUp and kDown are
178    C                   are switched with k to be the appropriate index into fVerU,V
179        _RL fVerU   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerU   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
180        _RL fVerV   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerV   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
181        _RL phiHydF (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL phiHydF (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
182        _RL phiHydC (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL phiHydC (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
183        _RL dPhiHydX(1-Olx:sNx+Olx,1-Oly:sNy+Oly)        _RL dPhiHydX(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
184        _RL dPhiHydY(1-Olx:sNx+Olx,1-Oly:sNy+Oly)        _RL dPhiHydY(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
185        _RL phiSurfX(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL phiSurfX(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
186        _RL phiSurfY(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL phiSurfY(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
187        _RL guDissip(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL guDissip(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
188        _RL gvDissip(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL gvDissip(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
189        _RL KappaRU (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)        _RL KappaRU (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
190        _RL KappaRV (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)        _RL KappaRV (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
191    
192        INTEGER iMin, iMax        INTEGER iMin, iMax
193        INTEGER jMin, jMax        INTEGER jMin, jMax
194        INTEGER bi, bj        INTEGER bi, bj
195        INTEGER i, j        INTEGER i, j
196        INTEGER k, km1, kp1, kup, kDown        INTEGER k, km1, kp1, kUp, kDown
197    
198  #ifdef ALLOW_DIAGNOSTICS  #ifdef ALLOW_DIAGNOSTICS
199        _RL tmpFld  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        LOGICAL dPhiHydDiagIsOn
200        LOGICAL  DIAGNOSTICS_IS_ON        _RL tmpFac
       EXTERNAL DIAGNOSTICS_IS_ON  
201  #endif /* ALLOW_DIAGNOSTICS */  #endif /* ALLOW_DIAGNOSTICS */
202    
   
203  C---    The algorithm...  C---    The algorithm...
204  C  C
205  C       "Correction Step"  C       "Correction Step"
# Line 212  C         (1 + dt * K * d_zz) salt[n] = Line 245  C         (1 + dt * K * d_zz) salt[n] =
245  C---  C---
246  CEOP  CEOP
247    
248  C-- Call to routine for calculation of  #ifdef ALLOW_DEBUG
249  C   Eliassen-Palm-flux-forced U-tendency,        IF (debugMode) CALL DEBUG_ENTER( 'DYNAMICS', myThid )
250  C   if desired:  #endif
251    
252    #ifdef ALLOW_DIAGNOSTICS
253          dPhiHydDiagIsOn = .FALSE.
254          IF ( useDiagnostics )
255         &  dPhiHydDiagIsOn = DIAGNOSTICS_IS_ON( 'Um_dPHdx', myThid )
256         &               .OR. DIAGNOSTICS_IS_ON( 'Vm_dPHdy', myThid )
257    #endif
258    
259    C-- Call to routine for calculation of Eliassen-Palm-flux-forced
260    C    U-tendency, if desired:
261  #ifdef INCLUDE_EP_FORCING_CODE  #ifdef INCLUDE_EP_FORCING_CODE
262        CALL CALC_EP_FORCING(myThid)        CALL CALC_EP_FORCING(myThid)
263  #endif  #endif
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
271  CHPF$ INDEPENDENT  CHPF$ INDEPENDENT
# Line 250  CHPF$&                  ) Line 297  CHPF$&                  )
297  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
298    
299  C--   Set up work arrays with valid (i.e. not NaN) values  C--   Set up work arrays with valid (i.e. not NaN) values
300  C     These inital values do not alter the numerical results. They  C     These initial values do not alter the numerical results. They
301  C     just ensure that all memory references are to valid floating  C     just ensure that all memory references are to valid floating
302  C     point numbers. This prevents spurious hardware signals due to  C     point numbers. This prevents spurious hardware signals due to
303  C     uninitialised but inert locations.  C     uninitialised but inert locations.
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
            KappaRU(i,j,k) = 0. _d 0  
            KappaRV(i,j,k) = 0. _d 0  
 #ifdef ALLOW_AUTODIFF_TAMC  
309  cph(  cph(
310  c--   need some re-initialisation here to break dependencies  c--   need some re-initialisation here to break dependencies
311  cph)  cph)
312             gu(i,j,k,bi,bj) = 0. _d 0             gU(i,j,k,bi,bj) = 0. _d 0
313             gv(i,j,k,bi,bj) = 0. _d 0             gV(i,j,k,bi,bj) = 0. _d 0
 #endif  
314            ENDDO            ENDDO
315           ENDDO           ENDDO
316          ENDDO          ENDDO
317    #endif /* ALLOW_AUTODIFF_TAMC */
318          DO j=1-OLy,sNy+OLy          DO j=1-OLy,sNy+OLy
319           DO i=1-OLx,sNx+OLx           DO i=1-OLx,sNx+OLx
320            fVerU  (i,j,1) = 0. _d 0            fVerU  (i,j,1) = 0. _d 0
321            fVerU  (i,j,2) = 0. _d 0            fVerU  (i,j,2) = 0. _d 0
322            fVerV  (i,j,1) = 0. _d 0            fVerV  (i,j,1) = 0. _d 0
323            fVerV  (i,j,2) = 0. _d 0            fVerV  (i,j,2) = 0. _d 0
324            phiHydF (i,j)  = 0. _d 0            phiHydF (i,j)  = 0. _d 0
325            phiHydC (i,j)  = 0. _d 0            phiHydC (i,j)  = 0. _d 0
326    #ifndef INCLUDE_PHIHYD_CALCULATION_CODE
327            dPhiHydX(i,j)  = 0. _d 0            dPhiHydX(i,j)  = 0. _d 0
328            dPhiHydY(i,j)  = 0. _d 0            dPhiHydY(i,j)  = 0. _d 0
329    #endif
330            phiSurfX(i,j)  = 0. _d 0            phiSurfX(i,j)  = 0. _d 0
331            phiSurfY(i,j)  = 0. _d 0            phiSurfY(i,j)  = 0. _d 0
332            guDissip(i,j)  = 0. _d 0            guDissip(i,j)  = 0. _d 0
333            gvDissip(i,j)  = 0. _d 0            gvDissip(i,j)  = 0. _d 0
334    #ifdef ALLOW_AUTODIFF_TAMC
335              phiHydLow(i,j,bi,bj) = 0. _d 0
336    # if (defined NONLIN_FRSURF) && (defined ALLOW_MOM_FLUXFORM)
337    #  ifndef DISABLE_RSTAR_CODE
338    #   ifndef ALLOW_AUTODIFF_OPENAD
339              dWtransC(i,j,bi,bj) = 0. _d 0
340              dWtransU(i,j,bi,bj) = 0. _d 0
341              dWtransV(i,j,bi,bj) = 0. _d 0
342    #   endif
343    #  endif
344    # endif
345    #endif
346           ENDDO           ENDDO
347          ENDDO          ENDDO
348    
# Line 294  C--     Start computation of dynamics Line 353  C--     Start computation of dynamics
353          jMax = sNy+1          jMax = sNy+1
354    
355  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
356  CADJ STORE wvel (:,:,:,bi,bj) =  CADJ STORE wVel (:,:,:,bi,bj) =
357  CADJ &     comlev1_bibj, key = idynkey, byte = isbyte  CADJ &     comlev1_bibj, key=idynkey, byte=isbyte
358  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
359    
360  C--     Explicit part of the Surface Potentiel Gradient (add in TIMESTEP)  C--     Explicit part of the Surface Potential Gradient (add in TIMESTEP)
361  C       (note: this loop will be replaced by CALL CALC_GRAD_ETA)  C       (note: this loop will be replaced by CALL CALC_GRAD_ETA)
362          IF (implicSurfPress.NE.1.) THEN          IF (implicSurfPress.NE.1.) THEN
363            CALL CALC_GRAD_PHI_SURF(            CALL CALC_GRAD_PHI_SURF(
364       I         bi,bj,iMin,iMax,jMin,jMax,       I         bi,bj,iMin,iMax,jMin,jMax,
365       I         etaN,       I         etaN,
366       O         phiSurfX,phiSurfY,       O         phiSurfX,phiSurfY,
367       I         myThid )                               I         myThid )
368          ENDIF          ENDIF
369    
370  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
371  CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key=idynkey, byte=isbyte  CADJ STORE uVel (:,:,:,bi,bj) = comlev1_bibj, key=idynkey, byte=isbyte
372  CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key=idynkey, byte=isbyte  CADJ STORE vVel (:,:,:,bi,bj) = comlev1_bibj, key=idynkey, byte=isbyte
373  #ifdef ALLOW_KPP  #ifdef ALLOW_KPP
374  CADJ STORE KPPviscAz (:,:,:,bi,bj)  CADJ STORE KPPviscAz (:,:,:,bi,bj)
375  CADJ &                 = comlev1_bibj, key=idynkey, byte=isbyte  CADJ &                 = comlev1_bibj, key=idynkey, byte=isbyte
376  #endif /* ALLOW_KPP */  #endif /* ALLOW_KPP */
377  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
378    
379  #ifdef  INCLUDE_CALC_DIFFUSIVITY_CALL  #if (defined INCLUDE_CALC_DIFFUSIVITY_CALL) && !(defined ALLOW_AUTODIFF)
380  C--      Calculate the total vertical diffusivity          IF ( .NOT.momViscosity ) THEN
381          DO k=1,Nr  #endif /* INCLUDE_CALC_DIFFUSIVITY_CALL and not ALLOW_AUTODIFF */
382           CALL CALC_VISCOSITY(            DO k=1,Nr
383       I        bi,bj,iMin,iMax,jMin,jMax,k,             DO j=1-OLy,sNy+OLy
384       O        KappaRU,KappaRV,              DO i=1-OLx,sNx+OLx
385       I        myThid)               KappaRU(i,j,k) = 0. _d 0
386         ENDDO               KappaRV(i,j,k) = 0. _d 0
387                ENDDO
388               ENDDO
389              ENDDO
390    #ifdef INCLUDE_CALC_DIFFUSIVITY_CALL
391    C--     Calculate the total vertical viscosity
392    #ifdef ALLOW_AUTODIFF
393            IF ( momViscosity ) THEN
394    #else
395            ELSE
396  #endif  #endif
397              CALL CALC_VISCOSITY(
398         I            bi,bj, iMin,iMax,jMin,jMax,
399         O            KappaRU, KappaRV,
400         I            myThid )
401            ENDIF
402    #endif /* INCLUDE_CALC_DIFFUSIVITY_CALL */
403    
404  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
405  CADJ STORE KappaRU(:,:,:)  CADJ STORE KappaRU(:,:,:)
406  CADJ &                 = comlev1_bibj, key=idynkey, byte=isbyte  CADJ &     = comlev1_bibj, key=idynkey, byte=isbyte
407  CADJ STORE KappaRV(:,:,:)  CADJ STORE KappaRV(:,:,:)
408  CADJ &                 = comlev1_bibj, key=idynkey, byte=isbyte  CADJ &     = comlev1_bibj, key=idynkey, byte=isbyte
409  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
410    
411    #ifdef ALLOW_OBCS
412    C--   For Stevens boundary conditions velocities need to be extrapolated
413    C     (copied) to a narrow strip outside the domain
414            IF ( useOBCS ) THEN
415              CALL OBCS_COPY_UV_N(
416         U         uVel(1-OLx,1-OLy,1,bi,bj),
417         U         vVel(1-OLx,1-OLy,1,bi,bj),
418         I         Nr, bi, bj, myThid )
419            ENDIF
420    #endif /* ALLOW_OBCS */
421    
422  C--     Start of dynamics loop  C--     Start of dynamics loop
423          DO k=1,Nr          DO k=1,Nr
424    
# Line 346  C--       kDown  Cycles through 2,1 to p Line 431  C--       kDown  Cycles through 2,1 to p
431            kup  = 1+MOD(k+1,2)            kup  = 1+MOD(k+1,2)
432            kDown= 1+MOD(k,2)            kDown= 1+MOD(k,2)
433    
434  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
435           kkey = (idynkey-1)*Nr + k           kkey = (idynkey-1)*Nr + k
436  c  c
437  CADJ STORE totphihyd (:,:,k,bi,bj)  CADJ STORE totPhiHyd (:,:,k,bi,bj)
438    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
439    CADJ STORE phiHydLow (:,:,bi,bj)
440    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
441    CADJ STORE theta (:,:,k,bi,bj)
442    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
443    CADJ STORE salt  (:,:,k,bi,bj)
444    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
445    CADJ STORE gT(:,:,k,bi,bj)
446    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
447    CADJ STORE gS(:,:,k,bi,bj)
448    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
449    # ifdef NONLIN_FRSURF
450    cph-test
451    CADJ STORE  phiHydC (:,:)
452    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
453    CADJ STORE  phiHydF (:,:)
454    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
455    CADJ STORE  guDissip (:,:)
456    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
457    CADJ STORE  gvDissip (:,:)
458    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
459    CADJ STORE  fVerU (:,:,:)
460    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
461    CADJ STORE  fVerV (:,:,:)
462    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
463    CADJ STORE gU(:,:,k,bi,bj)
464    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
465    CADJ STORE gV(:,:,k,bi,bj)
466    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
467    #  ifndef ALLOW_ADAMSBASHFORTH_3
468    CADJ STORE guNm1(:,:,k,bi,bj)
469    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
470    CADJ STORE gvNm1(:,:,k,bi,bj)
471    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
472    #  else
473    CADJ STORE guNm(:,:,k,bi,bj,1)
474  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
475  CADJ STORE theta (:,:,k,bi,bj)  CADJ STORE guNm(:,:,k,bi,bj,2)
476  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
477  CADJ STORE salt  (:,:,k,bi,bj)  CADJ STORE gvNm(:,:,k,bi,bj,1)
478  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
479    CADJ STORE gvNm(:,:,k,bi,bj,2)
480    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
481    #  endif
482    #  ifdef ALLOW_CD_CODE
483    CADJ STORE uNM1(:,:,k,bi,bj)
484    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
485    CADJ STORE vNM1(:,:,k,bi,bj)
486    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
487    CADJ STORE uVelD(:,:,k,bi,bj)
488    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
489    CADJ STORE vVelD(:,:,k,bi,bj)
490    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
491    #  endif
492    # endif
493    # ifdef ALLOW_DEPTH_CONTROL
494    CADJ STORE  fVerU (:,:,:)
495    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
496    CADJ STORE  fVerV (:,:,:)
497    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
498    # endif
499  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
500    
501  C--      Integrate hydrostatic balance for phiHyd with BC of  C--      Integrate hydrostatic balance for phiHyd with BC of phiHyd(z=0)=0
502  C        phiHyd(z=0)=0           IF ( implicitIntGravWave ) THEN
503           CALL CALC_PHI_HYD(             CALL CALC_PHI_HYD(
504         I        bi,bj,iMin,iMax,jMin,jMax,k,
505         I        gT, gS,
506         U        phiHydF,
507         O        phiHydC, dPhiHydX, dPhiHydY,
508         I        myTime, myIter, myThid )
509             ELSE
510               CALL CALC_PHI_HYD(
511       I        bi,bj,iMin,iMax,jMin,jMax,k,       I        bi,bj,iMin,iMax,jMin,jMax,k,
512       I        theta, salt,       I        theta, salt,
513       U        phiHydF,       U        phiHydF,
514       O        phiHydC, dPhiHydX, dPhiHydY,       O        phiHydC, dPhiHydX, dPhiHydY,
515       I        myTime, myIter, myThid )       I        myTime, myIter, myThid )
516             ENDIF
517    #ifdef ALLOW_DIAGNOSTICS
518             IF ( dPhiHydDiagIsOn ) THEN
519               tmpFac = -1. _d 0
520               CALL DIAGNOSTICS_SCALE_FILL( dPhiHydX, tmpFac, 1,
521         &                           'Um_dPHdx', k, 1, 2, bi, bj, myThid )
522               CALL DIAGNOSTICS_SCALE_FILL( dPhiHydY, tmpFac, 1,
523         &                           'Vm_dPHdy', k, 1, 2, bi, bj, myThid )
524             ENDIF
525    #endif /* ALLOW_DIAGNOSTICS */
526    
527  C--      Calculate accelerations in the momentum equations (gU, gV, ...)  C--      Calculate accelerations in the momentum equations (gU, gV, ...)
528  C        and step forward storing the result in gU, gV, etc...  C        and step forward storing the result in gU, gV, etc...
529           IF ( momStepping ) THEN           IF ( momStepping ) THEN
530    #ifdef ALLOW_AUTODIFF_TAMC
531    # ifdef NONLIN_FRSURF
532    #  if (defined ALLOW_MOM_FLUXFORM) && !(defined DISABLE_RSTAR_CODE)
533    CADJ STORE dWtransC(:,:,bi,bj)
534    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
535    CADJ STORE dWtransU(:,:,bi,bj)
536    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
537    CADJ STORE dWtransV(:,:,bi,bj)
538    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
539    #  endif
540    CADJ STORE fVerU(:,:,:)
541    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
542    CADJ STORE fVerV(:,:,:)
543    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
544    # endif /* NONLIN_FRSURF */
545    #endif /* ALLOW_AUTODIFF_TAMC */
546               IF (.NOT. vectorInvariantMomentum) THEN
547  #ifdef ALLOW_MOM_FLUXFORM  #ifdef ALLOW_MOM_FLUXFORM
548             IF (.NOT. vectorInvariantMomentum) CALL MOM_FLUXFORM(                CALL MOM_FLUXFORM(
549       I         bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown,       I         bi,bj,k,iMin,iMax,jMin,jMax,
550       I         dPhiHydX,dPhiHydY,KappaRU,KappaRV,       I         KappaRU, KappaRV,
551       U         fVerU, fVerV,       U         fVerU(1-OLx,1-OLy,kUp),   fVerV(1-OLx,1-OLy,kUp),
552         O         fVerU(1-OLx,1-OLy,kDown), fVerV(1-OLx,1-OLy,kDown),
553         O         guDissip, gvDissip,
554       I         myTime, myIter, myThid)       I         myTime, myIter, myThid)
555  #endif  #endif
556               ELSE
557  #ifdef ALLOW_MOM_VECINV  #ifdef ALLOW_MOM_VECINV
558             IF (vectorInvariantMomentum) CALL MOM_VECINV(               CALL MOM_VECINV(
559       I         bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown,       I         bi,bj,k,iMin,iMax,jMin,jMax,
560       I         dPhiHydX,dPhiHydY,KappaRU,KappaRV,       I         KappaRU, KappaRV,
561       U         fVerU, fVerV,       I         fVerU(1-OLx,1-OLy,kUp),   fVerV(1-OLx,1-OLy,kUp),
562         O         fVerU(1-OLx,1-OLy,kDown), fVerV(1-OLx,1-OLy,kDown),
563       O         guDissip, gvDissip,       O         guDissip, gvDissip,
564       I         myTime, myIter, myThid)       I         myTime, myIter, myThid)
565  #endif  #endif
566               ENDIF
567    
568             CALL TIMESTEP(             CALL TIMESTEP(
569       I         bi,bj,iMin,iMax,jMin,jMax,k,       I         bi,bj,iMin,iMax,jMin,jMax,k,
570       I         dPhiHydX,dPhiHydY, phiSurfX, phiSurfY,       I         dPhiHydX,dPhiHydY, phiSurfX, phiSurfY,
571       I         guDissip, gvDissip,       I         guDissip, gvDissip,
572       I         myTime, myIter, myThid)       I         myTime, myIter, myThid)
573    
 #ifdef   ALLOW_OBCS  
 C--      Apply open boundary conditions  
            IF (useOBCS) THEN  
              CALL OBCS_APPLY_UV( bi, bj, k, gU, gV, myThid )  
            ENDIF  
 #endif   /* ALLOW_OBCS */  
   
574           ENDIF           ENDIF
575    
   
576  C--     end of dynamics k loop (1:Nr)  C--     end of dynamics k loop (1:Nr)
577          ENDDO          ENDDO
578    
579  C--     Implicit Vertical advection & viscosity  C--     Implicit Vertical advection & viscosity
580  #ifdef INCLUDE_IMPLVERTADV_CODE  #if (defined (INCLUDE_IMPLVERTADV_CODE) && \
581         defined (ALLOW_MOM_COMMON) && !(defined ALLOW_AUTODIFF_TAMC))
582          IF ( momImplVertAdv ) THEN          IF ( momImplVertAdv ) THEN
583            CALL MOM_U_IMPLICIT_R( kappaRU,            CALL MOM_U_IMPLICIT_R( kappaRU,
584       I                           bi, bj, myTime, myIter, myThid )       I                           bi, bj, myTime, myIter, myThid )
585            CALL MOM_V_IMPLICIT_R( kappaRV,            CALL MOM_V_IMPLICIT_R( kappaRV,
586       I                           bi, bj, myTime, myIter, myThid )       I                           bi, bj, myTime, myIter, myThid )
# Line 420  CADJ STORE gU(:,:,:,bi,bj) = comlev1_bib Line 594  CADJ STORE gU(:,:,:,bi,bj) = comlev1_bib
594  #endif    /* ALLOW_AUTODIFF_TAMC */  #endif    /* ALLOW_AUTODIFF_TAMC */
595            CALL IMPLDIFF(            CALL IMPLDIFF(
596       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
597       I         0, KappaRU,recip_HFacW,       I         -1, KappaRU, recip_hFacW(1-OLx,1-OLy,1,bi,bj),
598       U         gU,       U         gU,
599       I         myThid )       I         myThid )
600  #ifdef    ALLOW_AUTODIFF_TAMC  #ifdef    ALLOW_AUTODIFF_TAMC
# Line 429  CADJ STORE gV(:,:,:,bi,bj) = comlev1_bib Line 603  CADJ STORE gV(:,:,:,bi,bj) = comlev1_bib
603  #endif    /* ALLOW_AUTODIFF_TAMC */  #endif    /* ALLOW_AUTODIFF_TAMC */
604            CALL IMPLDIFF(            CALL IMPLDIFF(
605       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
606       I         0, KappaRV,recip_HFacS,       I         -2, KappaRV, recip_hFacS(1-OLx,1-OLy,1,bi,bj),
607       U         gV,       U         gV,
608       I         myThid )       I         myThid )
609          ENDIF          ENDIF
610    
611  #ifdef   ALLOW_OBCS  #ifdef ALLOW_OBCS
612  C--      Apply open boundary conditions  C--      Apply open boundary conditions
613          IF ( useOBCS .AND.(implicitViscosity.OR.momImplVertAdv) ) THEN          IF ( useOBCS ) THEN
614             DO K=1,Nr  C--      but first save intermediate velocities to be used in the
615               CALL OBCS_APPLY_UV( bi, bj, k, gU, gV, myThid )  C        next time step for the Stevens boundary conditions
616             ENDDO            CALL OBCS_SAVE_UV_N(
617         I        bi, bj, iMin, iMax, jMin, jMax, 0,
618         I        gU, gV, myThid )
619              CALL OBCS_APPLY_UV( bi, bj, 0, gU, gV, myThid )
620          ENDIF          ENDIF
621  #endif   /* ALLOW_OBCS */  #endif /* ALLOW_OBCS */
622    
623  #ifdef    ALLOW_CD_CODE  #ifdef    ALLOW_CD_CODE
624          IF (implicitViscosity.AND.useCDscheme) THEN          IF (implicitViscosity.AND.useCDscheme) THEN
# Line 450  CADJ STORE vVelD(:,:,:,bi,bj) = comlev1_ Line 627  CADJ STORE vVelD(:,:,:,bi,bj) = comlev1_
627  #endif    /* ALLOW_AUTODIFF_TAMC */  #endif    /* ALLOW_AUTODIFF_TAMC */
628            CALL IMPLDIFF(            CALL IMPLDIFF(
629       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
630       I         0, KappaRU,recip_HFacW,       I         0, KappaRU, recip_hFacW(1-OLx,1-OLy,1,bi,bj),
631       U         vVelD,       U         vVelD,
632       I         myThid )       I         myThid )
633  #ifdef    ALLOW_AUTODIFF_TAMC  #ifdef    ALLOW_AUTODIFF_TAMC
# Line 458  CADJ STORE uVelD(:,:,:,bi,bj) = comlev1_ Line 635  CADJ STORE uVelD(:,:,:,bi,bj) = comlev1_
635  #endif    /* ALLOW_AUTODIFF_TAMC */  #endif    /* ALLOW_AUTODIFF_TAMC */
636            CALL IMPLDIFF(            CALL IMPLDIFF(
637       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
638       I         0, KappaRV,recip_HFacS,       I         0, KappaRV, recip_hFacS(1-OLx,1-OLy,1,bi,bj),
639       U         uVelD,       U         uVelD,
640       I         myThid )       I         myThid )
641          ENDIF          ENDIF
642  #endif    /* ALLOW_CD_CODE */  #endif    /* ALLOW_CD_CODE */
643  C--     End implicit Vertical advection & viscosity  C--     End implicit Vertical advection & viscosity
644    
645    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
646    
647    #ifdef ALLOW_NONHYDROSTATIC
648    C--   Step forward W field in N-H algorithm
649            IF ( nonHydrostatic ) THEN
650    #ifdef ALLOW_DEBUG
651             IF (debugMode) CALL DEBUG_CALL('CALC_GW', myThid )
652    #endif
653             CALL TIMER_START('CALC_GW          [DYNAMICS]',myThid)
654             CALL CALC_GW(
655         I                 bi,bj, KappaRU, KappaRV,
656         I                 myTime, myIter, myThid )
657            ENDIF
658            IF ( nonHydrostatic.OR.implicitIntGravWave )
659         &   CALL TIMESTEP_WVEL( bi,bj, myTime, myIter, myThid )
660            IF ( nonHydrostatic )
661         &   CALL TIMER_STOP ('CALC_GW          [DYNAMICS]',myThid)
662    #endif
663    
664    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
665    
666    C-    end of bi,bj loops
667         ENDDO         ENDDO
668        ENDDO        ENDDO
669    
670  #ifdef ALLOW_OBCS  #ifdef ALLOW_OBCS
671        IF (useOBCS) THEN        IF (useOBCS) THEN
672         CALL OBCS_PRESCRIBE_EXCHANGES(myThid)          CALL OBCS_EXCHANGES( myThid )
673        ENDIF        ENDIF
674  #endif  #endif
675    
 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|  
   
676  Cml(  Cml(
677  C     In order to compare the variance of phiHydLow of a p/z-coordinate  C     In order to compare the variance of phiHydLow of a p/z-coordinate
678  C     run with etaH of a z/p-coordinate run the drift of phiHydLow  C     run with etaH of a z/p-coordinate run the drift of phiHydLow
679  C     has to be removed by something like the following subroutine:  C     has to be removed by something like the following subroutine:
680  C      CALL REMOVE_MEAN_RL( 1, phiHydLow, maskH, maskH, rA, drF,  C      CALL REMOVE_MEAN_RL( 1, phiHydLow, maskInC, maskInC, rA, drF,
681  C     &                'phiHydLow', myThid )  C     &                     'phiHydLow', myTime, myThid )
682  Cml)  Cml)
683    
684  #ifdef ALLOW_DIAGNOSTICS  #ifdef ALLOW_DIAGNOSTICS
685        IF ( usediagnostics ) THEN        IF ( useDiagnostics ) THEN
686    
687         CALL DIAGNOSTICS_FILL(totPhihyd,'PHIHYD  ',0,Nr,0,1,1,myThid)         CALL DIAGNOSTICS_FILL(totPhihyd,'PHIHYD  ',0,Nr,0,1,1,myThid)
688           CALL DIAGNOSTICS_FILL(phiHydLow,'PHIBOT  ',0, 1,0,1,1,myThid)
689    
690         IF ( DIAGNOSTICS_IS_ON('PHIHYDSQ',myThid) ) THEN         tmpFac = 1. _d 0
691          DO bj = myByLo(myThid), myByHi(myThid)         CALL DIAGNOSTICS_SCALE_FILL(totPhihyd,tmpFac,2,
692          DO bi = myBxLo(myThid), myBxHi(myThid)       &                                 'PHIHYDSQ',0,Nr,0,1,1,myThid)
          DO k = 1,Nr  
           DO j = 1,sNy  
            DO i = 1,sNx  
              tmpFld(i,j) = totPhihyd(i,j,k,bi,bj)*totPhihyd(i,j,k,bi,bj)  
            ENDDO  
           ENDDO  
           CALL DIAGNOSTICS_FILL(tmpFld,'PHIHYDSQ',k,1,2,bi,bj,myThid)  
          ENDDO  
         ENDDO  
         ENDDO  
        ENDIF  
   
        CALL DIAGNOSTICS_FILL(phiHydLow,'PHIBOT  ',0,1,0,1,1,myThid)  
693    
694         IF ( DIAGNOSTICS_IS_ON('PHIBOTSQ',myThid) ) THEN         CALL DIAGNOSTICS_SCALE_FILL(phiHydLow,tmpFac,2,
695          DO bj = myByLo(myThid), myByHi(myThid)       &                                 'PHIBOTSQ',0, 1,0,1,1,myThid)
          DO bi = myBxLo(myThid), myBxHi(myThid)  
           DO j = 1,sNy  
            DO i = 1,sNx  
              tmpFld(i,j) = phiHydLow(i,j,bi,bj)*phiHydLow(i,j,bi,bj)  
            ENDDO  
           ENDDO  
           CALL DIAGNOSTICS_FILL(tmpFld,'PHIBOTSQ',0,1,2,bi,bj,myThid)  
          ENDDO  
         ENDDO  
        ENDIF  
696    
697        ENDIF        ENDIF
698  #endif /* ALLOW_DIAGNOSTICS */  #endif /* ALLOW_DIAGNOSTICS */
699          
700  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
701        If ( debugLevel .GE. debLevB ) THEN        IF ( debugLevel .GE. debLevD ) THEN
702         CALL DEBUG_STATS_RL(1,EtaN,'EtaN (DYNAMICS)',myThid)         CALL DEBUG_STATS_RL(1,EtaN,'EtaN (DYNAMICS)',myThid)
703         CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (DYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (DYNAMICS)',myThid)
704         CALL DEBUG_STATS_RL(Nr,vVel,'Vvel (DYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,vVel,'Vvel (DYNAMICS)',myThid)
# Line 543  Cml) Line 718  Cml)
718        ENDIF        ENDIF
719  #endif  #endif
720    
721    #ifdef DYNAMICS_GUGV_EXCH_CHECK
722    C- jmc: For safety checking only: This Exchange here should not change
723    C       the solution. If solution changes, it means something is wrong,
724    C       but it does not mean that it is less wrong with this exchange.
725          IF ( debugLevel .GE. debLevE ) THEN
726           CALL EXCH_UV_XYZ_RL(gU,gV,.TRUE.,myThid)
727          ENDIF
728    #endif
729    
730    #ifdef ALLOW_DEBUG
731          IF (debugMode) CALL DEBUG_LEAVE( 'DYNAMICS', myThid )
732    #endif
733    
734        RETURN        RETURN
735        END        END
Legend:
Removed from v.1.117  
changed lines
  Added in v.1.165
  ViewVC Help
Powered by ViewVC 1.1.22