/[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.127 by jmc, Thu Dec 15 21:09:00 2005 UTC revision 1.166 by m_bates, Sun Sep 15 14:28:31 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  #undef DYNAMICS_GUGV_EXCH_CHECK
11    
12  CBOP  CBOP
# Line 11  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 74  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 87  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:
# Line 98  C      |-- CALC_GRAD_PHI_SURF Line 116  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_EDDY_STRESS
120  C      |  C      |
121  C      |-- MOM_FLUXFORM    C      |-- CALC_PHI_HYD
122  C      |  C      |
123  C      |-- MOM_VECINV      C      |-- MOM_FLUXFORM
124  C      |  C      |
125  C      |-- TIMESTEP        C      |-- MOM_VECINV
126  C      |  C      |
127  C      |-- OBCS_APPLY_UV  C      |-- TIMESTEP
128  C      |  C      |
129  C      |-- MOM_U_IMPLICIT_R        C      |-- MOM_U_IMPLICIT_R
130  C      |-- MOM_V_IMPLICIT_R        C      |-- MOM_V_IMPLICIT_R
131  C      |  C      |
132  C      |-- IMPLDIFF        C      |-- IMPLDIFF
133  C      |  C      |
134  C      |-- OBCS_APPLY_UV  C      |-- OBCS_APPLY_UV
135  C      |  C      |
# Line 122  C      |-- DEBUG_STATS_RL Line 140  C      |-- DEBUG_STATS_RL
140    
141  C     !INPUT/OUTPUT PARAMETERS:  C     !INPUT/OUTPUT PARAMETERS:
142  C     == Routine arguments ==  C     == Routine arguments ==
143  C     myTime - Current time in simulation  C     myTime :: Current time in simulation
144  C     myIter - Current iteration number in simulation  C     myIter :: Current iteration number in simulation
145  C     myThid - Thread number for this instance of the routine.  C     myThid :: Thread number for this instance of the routine.
146        _RL myTime        _RL myTime
147        INTEGER myIter        INTEGER myIter
148        INTEGER myThid        INTEGER myThid
149    
150    C     !FUNCTIONS:
151    #ifdef ALLOW_DIAGNOSTICS
152          LOGICAL  DIAGNOSTICS_IS_ON
153          EXTERNAL DIAGNOSTICS_IS_ON
154    #endif
155    
156  C     !LOCAL VARIABLES:  C     !LOCAL VARIABLES:
157  C     == Local variables  C     == Local variables
158  C     fVer[UV]               o fVer: Vertical flux term - note fVer  C     fVer[UV]               o fVer: Vertical flux term - note fVer
# Line 145  C     phiSurfX,  ::  gradient of Surface Line 169  C     phiSurfX,  ::  gradient of Surface
169  C     phiSurfY             or geopotential (atmos) in X and Y direction  C     phiSurfY             or geopotential (atmos) in X and Y direction
170  C     guDissip   :: dissipation tendency (all explicit terms), u component  C     guDissip   :: dissipation tendency (all explicit terms), u component
171  C     gvDissip   :: dissipation tendency (all explicit terms), v component  C     gvDissip   :: dissipation tendency (all explicit terms), v component
172  C     iMin, iMax     - Ranges and sub-block indices on which calculations  C     KappaRU    :: vertical viscosity for velocity U-component
173  C     jMin, jMax       are applied.  C     KappaRV    :: vertical viscosity for velocity V-component
174  C     bi, bj  C     iMin, iMax :: Ranges and sub-block indices on which calculations
175  C     k, kup,        - Index for layer above and below. kup and kDown  C     jMin, jMax    are applied.
176  C     kDown, km1       are switched with layer to be the appropriate  C     bi, bj     :: tile indices
177  C                      index into fVerTerm.  C     k          :: current level index
178    C     km1, kp1   :: index of level above (k-1) and below (k+1)
179    C     kUp, kDown :: Index for interface above and below. kUp and kDown are
180    C                   are switched with k to be the appropriate index into fVerU,V
181        _RL fVerU   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerU   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
182        _RL fVerV   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerV   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
183        _RL phiHydF (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL phiHydF (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
184        _RL phiHydC (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL phiHydC (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
185        _RL dPhiHydX(1-Olx:sNx+Olx,1-Oly:sNy+Oly)        _RL dPhiHydX(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
186        _RL dPhiHydY(1-Olx:sNx+Olx,1-Oly:sNy+Oly)        _RL dPhiHydY(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
187        _RL phiSurfX(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL phiSurfX(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
188        _RL phiSurfY(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL phiSurfY(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
189        _RL guDissip(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL guDissip(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
190        _RL gvDissip(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL gvDissip(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
191        _RL KappaRU (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)        _RL KappaRU (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
192        _RL KappaRV (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)        _RL KappaRV (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
193    
194        INTEGER iMin, iMax        INTEGER iMin, iMax
195        INTEGER jMin, jMax        INTEGER jMin, jMax
196        INTEGER bi, bj        INTEGER bi, bj
197        INTEGER i, j        INTEGER i, j
198        INTEGER k, km1, kp1, kup, kDown        INTEGER k, km1, kp1, kUp, kDown
199    
200  #ifdef ALLOW_DIAGNOSTICS  #ifdef ALLOW_DIAGNOSTICS
201          LOGICAL dPhiHydDiagIsOn
202        _RL tmpFac        _RL tmpFac
203  #endif /* ALLOW_DIAGNOSTICS */  #endif /* ALLOW_DIAGNOSTICS */
204    
   
205  C---    The algorithm...  C---    The algorithm...
206  C  C
207  C       "Correction Step"  C       "Correction Step"
# Line 221  C--- Line 248  C---
248  CEOP  CEOP
249    
250  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
251        IF ( debugLevel .GE. debLevB )        IF (debugMode) CALL DEBUG_ENTER( 'DYNAMICS', myThid )
252       &   CALL DEBUG_ENTER( 'DYNAMICS', myThid )  #endif
253    
254    #ifdef ALLOW_DIAGNOSTICS
255          dPhiHydDiagIsOn = .FALSE.
256          IF ( useDiagnostics )
257         &  dPhiHydDiagIsOn = DIAGNOSTICS_IS_ON( 'Um_dPHdx', myThid )
258         &               .OR. DIAGNOSTICS_IS_ON( 'Vm_dPHdy', myThid )
259  #endif  #endif
260    
261  C-- Call to routine for calculation of  C-- Call to routine for calculation of Eliassen-Palm-flux-forced
262  C   Eliassen-Palm-flux-forced U-tendency,  C    U-tendency, if desired:
 C   if desired:  
263  #ifdef INCLUDE_EP_FORCING_CODE  #ifdef INCLUDE_EP_FORCING_CODE
264        CALL CALC_EP_FORCING(myThid)        CALL CALC_EP_FORCING(myThid)
265  #endif  #endif
266    
267    #ifdef ALLOW_AUTODIFF_MONITOR_DIAG
268          CALL DUMMY_IN_DYNAMICS( myTime, myIter, myThid )
269    #endif
270    
271  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
272  C--   HPF directive to help TAMC  C--   HPF directive to help TAMC
273  CHPF$ INDEPENDENT  CHPF$ INDEPENDENT
# Line 263  CHPF$&                  ) Line 299  CHPF$&                  )
299  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
300    
301  C--   Set up work arrays with valid (i.e. not NaN) values  C--   Set up work arrays with valid (i.e. not NaN) values
302  C     These inital values do not alter the numerical results. They  C     These initial values do not alter the numerical results. They
303  C     just ensure that all memory references are to valid floating  C     just ensure that all memory references are to valid floating
304  C     point numbers. This prevents spurious hardware signals due to  C     point numbers. This prevents spurious hardware signals due to
305  C     uninitialised but inert locations.  C     uninitialised but inert locations.
306    
307    #ifdef ALLOW_AUTODIFF_TAMC
308          DO k=1,Nr          DO k=1,Nr
309           DO j=1-OLy,sNy+OLy           DO j=1-OLy,sNy+OLy
310            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  
311  cph(  cph(
312  c--   need some re-initialisation here to break dependencies  c--   need some re-initialisation here to break dependencies
313  cph)  cph)
314             gU(i,j,k,bi,bj) = 0. _d 0             gU(i,j,k,bi,bj) = 0. _d 0
315             gV(i,j,k,bi,bj) = 0. _d 0             gV(i,j,k,bi,bj) = 0. _d 0
 #endif  
316            ENDDO            ENDDO
317           ENDDO           ENDDO
318          ENDDO          ENDDO
319    #endif /* ALLOW_AUTODIFF_TAMC */
320          DO j=1-OLy,sNy+OLy          DO j=1-OLy,sNy+OLy
321           DO i=1-OLx,sNx+OLx           DO i=1-OLx,sNx+OLx
322            fVerU  (i,j,1) = 0. _d 0            fVerU  (i,j,1) = 0. _d 0
323            fVerU  (i,j,2) = 0. _d 0            fVerU  (i,j,2) = 0. _d 0
324            fVerV  (i,j,1) = 0. _d 0            fVerV  (i,j,1) = 0. _d 0
325            fVerV  (i,j,2) = 0. _d 0            fVerV  (i,j,2) = 0. _d 0
326            phiHydF (i,j)  = 0. _d 0            phiHydF (i,j)  = 0. _d 0
327            phiHydC (i,j)  = 0. _d 0            phiHydC (i,j)  = 0. _d 0
328    #ifndef INCLUDE_PHIHYD_CALCULATION_CODE
329            dPhiHydX(i,j)  = 0. _d 0            dPhiHydX(i,j)  = 0. _d 0
330            dPhiHydY(i,j)  = 0. _d 0            dPhiHydY(i,j)  = 0. _d 0
331    #endif
332            phiSurfX(i,j)  = 0. _d 0            phiSurfX(i,j)  = 0. _d 0
333            phiSurfY(i,j)  = 0. _d 0            phiSurfY(i,j)  = 0. _d 0
334            guDissip(i,j)  = 0. _d 0            guDissip(i,j)  = 0. _d 0
335            gvDissip(i,j)  = 0. _d 0            gvDissip(i,j)  = 0. _d 0
336    #ifdef ALLOW_AUTODIFF_TAMC
337              phiHydLow(i,j,bi,bj) = 0. _d 0
338    # if (defined NONLIN_FRSURF) && (defined ALLOW_MOM_FLUXFORM)
339    #  ifndef DISABLE_RSTAR_CODE
340    #   ifndef ALLOW_AUTODIFF_OPENAD
341              dWtransC(i,j,bi,bj) = 0. _d 0
342              dWtransU(i,j,bi,bj) = 0. _d 0
343              dWtransV(i,j,bi,bj) = 0. _d 0
344    #   endif
345    #  endif
346    # endif
347    #endif
348           ENDDO           ENDDO
349          ENDDO          ENDDO
350    
# Line 307  C--     Start computation of dynamics Line 355  C--     Start computation of dynamics
355          jMax = sNy+1          jMax = sNy+1
356    
357  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
358  CADJ STORE wvel (:,:,:,bi,bj) =  CADJ STORE wVel (:,:,:,bi,bj) =
359  CADJ &     comlev1_bibj, key = idynkey, byte = isbyte  CADJ &     comlev1_bibj, key=idynkey, byte=isbyte
360  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
361    
362  C--     Explicit part of the Surface Potentiel Gradient (add in TIMESTEP)  C--     Explicit part of the Surface Potential Gradient (add in TIMESTEP)
363  C       (note: this loop will be replaced by CALL CALC_GRAD_ETA)  C       (note: this loop will be replaced by CALL CALC_GRAD_ETA)
364          IF (implicSurfPress.NE.1.) THEN          IF (implicSurfPress.NE.1.) THEN
365            CALL CALC_GRAD_PHI_SURF(            CALL CALC_GRAD_PHI_SURF(
366       I         bi,bj,iMin,iMax,jMin,jMax,       I         bi,bj,iMin,iMax,jMin,jMax,
367       I         etaN,       I         etaN,
368       O         phiSurfX,phiSurfY,       O         phiSurfX,phiSurfY,
369       I         myThid )                               I         myThid )
370          ENDIF          ENDIF
371    
372  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
373  CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key=idynkey, byte=isbyte  CADJ STORE uVel (:,:,:,bi,bj) = comlev1_bibj, key=idynkey, byte=isbyte
374  CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key=idynkey, byte=isbyte  CADJ STORE vVel (:,:,:,bi,bj) = comlev1_bibj, key=idynkey, byte=isbyte
375  #ifdef ALLOW_KPP  #ifdef ALLOW_KPP
376  CADJ STORE KPPviscAz (:,:,:,bi,bj)  CADJ STORE KPPviscAz (:,:,:,bi,bj)
377  CADJ &                 = comlev1_bibj, key=idynkey, byte=isbyte  CADJ &                 = comlev1_bibj, key=idynkey, byte=isbyte
378  #endif /* ALLOW_KPP */  #endif /* ALLOW_KPP */
379  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
380    
381  #ifdef  INCLUDE_CALC_DIFFUSIVITY_CALL  #if (defined INCLUDE_CALC_DIFFUSIVITY_CALL) && !(defined ALLOW_AUTODIFF)
382  C--      Calculate the total vertical diffusivity          IF ( .NOT.momViscosity ) THEN
383          DO k=1,Nr  #endif /* INCLUDE_CALC_DIFFUSIVITY_CALL and not ALLOW_AUTODIFF */
384           CALL CALC_VISCOSITY(            DO k=1,Nr
385       I        bi,bj,iMin,iMax,jMin,jMax,k,             DO j=1-OLy,sNy+OLy
386       O        KappaRU,KappaRV,              DO i=1-OLx,sNx+OLx
387       I        myThid)               KappaRU(i,j,k) = 0. _d 0
388         ENDDO               KappaRV(i,j,k) = 0. _d 0
389  #endif              ENDDO
390               ENDDO
391              ENDDO
392    #ifdef INCLUDE_CALC_DIFFUSIVITY_CALL
393    C--     Calculate the total vertical viscosity
394    #ifdef ALLOW_AUTODIFF
395            IF ( momViscosity ) THEN
396    #else
397            ELSE
398    #endif
399              CALL CALC_VISCOSITY(
400         I            bi,bj, iMin,iMax,jMin,jMax,
401         O            KappaRU, KappaRV,
402         I            myThid )
403            ENDIF
404    #endif /* INCLUDE_CALC_DIFFUSIVITY_CALL */
405    
406  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
407  CADJ STORE KappaRU(:,:,:)  CADJ STORE KappaRU(:,:,:)
408  CADJ &                 = comlev1_bibj, key=idynkey, byte=isbyte  CADJ &     = comlev1_bibj, key=idynkey, byte=isbyte
409  CADJ STORE KappaRV(:,:,:)  CADJ STORE KappaRV(:,:,:)
410  CADJ &                 = comlev1_bibj, key=idynkey, byte=isbyte  CADJ &     = comlev1_bibj, key=idynkey, byte=isbyte
411  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
412    
413    #ifdef ALLOW_OBCS
414    C--   For Stevens boundary conditions velocities need to be extrapolated
415    C     (copied) to a narrow strip outside the domain
416            IF ( useOBCS ) THEN
417              CALL OBCS_COPY_UV_N(
418         U         uVel(1-OLx,1-OLy,1,bi,bj),
419         U         vVel(1-OLx,1-OLy,1,bi,bj),
420         I         Nr, bi, bj, myThid )
421            ENDIF
422    #endif /* ALLOW_OBCS */
423    
424    #ifdef ALLOW_EDDYPSI
425            CALL CALC_EDDY_STRESS(bi,bj,myThid)
426    #endif
427    
428  C--     Start of dynamics loop  C--     Start of dynamics loop
429          DO k=1,Nr          DO k=1,Nr
430    
# Line 359  C--       kDown  Cycles through 2,1 to p Line 437  C--       kDown  Cycles through 2,1 to p
437            kup  = 1+MOD(k+1,2)            kup  = 1+MOD(k+1,2)
438            kDown= 1+MOD(k,2)            kDown= 1+MOD(k,2)
439    
440  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
441           kkey = (idynkey-1)*Nr + k           kkey = (idynkey-1)*Nr + k
442  c  c
443  CADJ STORE totphihyd (:,:,k,bi,bj)  CADJ STORE totPhiHyd (:,:,k,bi,bj)
444    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
445    CADJ STORE phiHydLow (:,:,bi,bj)
446    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
447    CADJ STORE theta (:,:,k,bi,bj)
448    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
449    CADJ STORE salt  (:,:,k,bi,bj)
450  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
451  CADJ STORE theta (:,:,k,bi,bj)  CADJ STORE gT(:,:,k,bi,bj)
452  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
453  CADJ STORE salt  (:,:,k,bi,bj)  CADJ STORE gS(:,:,k,bi,bj)
454  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
455  # ifdef NONLIN_FRSURF  # ifdef NONLIN_FRSURF
456  cph-test  cph-test
457  CADJ STORE  phiHydC (:,:)  CADJ STORE  phiHydC (:,:)
458  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
459  CADJ STORE  phiHydF (:,:)  CADJ STORE  phiHydF (:,:)
460  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
461  CADJ STORE  gudissip (:,:)  CADJ STORE  guDissip (:,:)
462  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
463  CADJ STORE  gvdissip (:,:)  CADJ STORE  gvDissip (:,:)
464  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
465  CADJ STORE  fVerU (:,:,:)  CADJ STORE  fVerU (:,:,:)
466  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
467  CADJ STORE  fVerV (:,:,:)  CADJ STORE  fVerV (:,:,:)
468  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
469  CADJ STORE gu(:,:,k,bi,bj)  CADJ STORE gU(:,:,k,bi,bj)
470  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
471  CADJ STORE gv(:,:,k,bi,bj)  CADJ STORE gV(:,:,k,bi,bj)
472  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
473  CADJ STORE gunm1(:,:,k,bi,bj)  #  ifndef ALLOW_ADAMSBASHFORTH_3
474    CADJ STORE guNm1(:,:,k,bi,bj)
475  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
476  CADJ STORE gvnm1(:,:,k,bi,bj)  CADJ STORE gvNm1(:,:,k,bi,bj)
477  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
478    #  else
479    CADJ STORE guNm(:,:,k,bi,bj,1)
480    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
481    CADJ STORE guNm(:,:,k,bi,bj,2)
482    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
483    CADJ STORE gvNm(:,:,k,bi,bj,1)
484    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
485    CADJ STORE gvNm(:,:,k,bi,bj,2)
486    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
487    #  endif
488  #  ifdef ALLOW_CD_CODE  #  ifdef ALLOW_CD_CODE
489  CADJ STORE unm1(:,:,k,bi,bj)  CADJ STORE uNM1(:,:,k,bi,bj)
490  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
491  CADJ STORE vnm1(:,:,k,bi,bj)  CADJ STORE vNM1(:,:,k,bi,bj)
492  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
493  CADJ STORE uVelD(:,:,k,bi,bj)  CADJ STORE uVelD(:,:,k,bi,bj)
494  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
495  CADJ STORE vVelD(:,:,k,bi,bj)  CADJ STORE vVelD(:,:,k,bi,bj)
496  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
497  #  endif  #  endif
498  # endif  # endif
499    # ifdef ALLOW_DEPTH_CONTROL
500    CADJ STORE  fVerU (:,:,:)
501    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
502    CADJ STORE  fVerV (:,:,:)
503    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
504    # endif
505  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
506    
507  C--      Integrate hydrostatic balance for phiHyd with BC of  C--      Integrate hydrostatic balance for phiHyd with BC of phiHyd(z=0)=0
508  C        phiHyd(z=0)=0           IF ( implicitIntGravWave ) THEN
509           CALL CALC_PHI_HYD(             CALL CALC_PHI_HYD(
510         I        bi,bj,iMin,iMax,jMin,jMax,k,
511         I        gT, gS,
512         U        phiHydF,
513         O        phiHydC, dPhiHydX, dPhiHydY,
514         I        myTime, myIter, myThid )
515             ELSE
516               CALL CALC_PHI_HYD(
517       I        bi,bj,iMin,iMax,jMin,jMax,k,       I        bi,bj,iMin,iMax,jMin,jMax,k,
518       I        theta, salt,       I        theta, salt,
519       U        phiHydF,       U        phiHydF,
520       O        phiHydC, dPhiHydX, dPhiHydY,       O        phiHydC, dPhiHydX, dPhiHydY,
521       I        myTime, myIter, myThid )       I        myTime, myIter, myThid )
522             ENDIF
523    #ifdef ALLOW_DIAGNOSTICS
524             IF ( dPhiHydDiagIsOn ) THEN
525               tmpFac = -1. _d 0
526               CALL DIAGNOSTICS_SCALE_FILL( dPhiHydX, tmpFac, 1,
527         &                           'Um_dPHdx', k, 1, 2, bi, bj, myThid )
528               CALL DIAGNOSTICS_SCALE_FILL( dPhiHydY, tmpFac, 1,
529         &                           'Vm_dPHdy', k, 1, 2, bi, bj, myThid )
530             ENDIF
531    #endif /* ALLOW_DIAGNOSTICS */
532    
533  C--      Calculate accelerations in the momentum equations (gU, gV, ...)  C--      Calculate accelerations in the momentum equations (gU, gV, ...)
534  C        and step forward storing the result in gU, gV, etc...  C        and step forward storing the result in gU, gV, etc...
535           IF ( momStepping ) THEN           IF ( momStepping ) THEN
536    #ifdef ALLOW_AUTODIFF_TAMC
537    # ifdef NONLIN_FRSURF
538    #  if (defined ALLOW_MOM_FLUXFORM) && !(defined DISABLE_RSTAR_CODE)
539    CADJ STORE dWtransC(:,:,bi,bj)
540    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
541    CADJ STORE dWtransU(:,:,bi,bj)
542    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
543    CADJ STORE dWtransV(:,:,bi,bj)
544    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
545    #  endif
546    CADJ STORE fVerU(:,:,:)
547    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
548    CADJ STORE fVerV(:,:,:)
549    CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte
550    # endif /* NONLIN_FRSURF */
551    #endif /* ALLOW_AUTODIFF_TAMC */
552               IF (.NOT. vectorInvariantMomentum) THEN
553  #ifdef ALLOW_MOM_FLUXFORM  #ifdef ALLOW_MOM_FLUXFORM
554             IF (.NOT. vectorInvariantMomentum) CALL MOM_FLUXFORM(                CALL MOM_FLUXFORM(
555       I         bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown,       I         bi,bj,k,iMin,iMax,jMin,jMax,
556       I         KappaRU, KappaRV,       I         KappaRU, KappaRV,
557       U         fVerU, fVerV,       U         fVerU(1-OLx,1-OLy,kUp),   fVerV(1-OLx,1-OLy,kUp),
558         O         fVerU(1-OLx,1-OLy,kDown), fVerV(1-OLx,1-OLy,kDown),
559       O         guDissip, gvDissip,       O         guDissip, gvDissip,
560       I         myTime, myIter, myThid)       I         myTime, myIter, myThid)
561  #endif  #endif
562               ELSE
563  #ifdef ALLOW_MOM_VECINV  #ifdef ALLOW_MOM_VECINV
            IF (vectorInvariantMomentum) THEN  
 C  
 # ifdef ALLOW_AUTODIFF_TAMC  
 #  ifdef NONLIN_FRSURF  
 CADJ STORE fVerU(:,:,:)  
 CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  
 CADJ STORE fVerV(:,:,:)  
 CADJ &     = comlev1_bibj_k, key=kkey, byte=isbyte  
 #  endif  
 # endif /* ALLOW_AUTODIFF_TAMC */  
 C  
564               CALL MOM_VECINV(               CALL MOM_VECINV(
565       I         bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown,       I         bi,bj,k,iMin,iMax,jMin,jMax,
566       I         KappaRU, KappaRV,       I         KappaRU, KappaRV,
567       U         fVerU, fVerV,       I         fVerU(1-OLx,1-OLy,kUp),   fVerV(1-OLx,1-OLy,kUp),
568         O         fVerU(1-OLx,1-OLy,kDown), fVerV(1-OLx,1-OLy,kDown),
569       O         guDissip, gvDissip,       O         guDissip, gvDissip,
570       I         myTime, myIter, myThid)       I         myTime, myIter, myThid)
            ENDIF  
571  #endif  #endif
572               ENDIF
573    
574             CALL TIMESTEP(             CALL TIMESTEP(
575       I         bi,bj,iMin,iMax,jMin,jMax,k,       I         bi,bj,iMin,iMax,jMin,jMax,k,
576       I         dPhiHydX,dPhiHydY, phiSurfX, phiSurfY,       I         dPhiHydX,dPhiHydY, phiSurfX, phiSurfY,
577       I         guDissip, gvDissip,       I         guDissip, gvDissip,
578       I         myTime, myIter, myThid)       I         myTime, myIter, myThid)
579    
 #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 */  
   
580           ENDIF           ENDIF
581    
   
582  C--     end of dynamics k loop (1:Nr)  C--     end of dynamics k loop (1:Nr)
583          ENDDO          ENDDO
584    
585  C--     Implicit Vertical advection & viscosity  C--     Implicit Vertical advection & viscosity
586  #ifdef INCLUDE_IMPLVERTADV_CODE  #if (defined (INCLUDE_IMPLVERTADV_CODE) && \
587         defined (ALLOW_MOM_COMMON) && !(defined ALLOW_AUTODIFF_TAMC))
588          IF ( momImplVertAdv ) THEN          IF ( momImplVertAdv ) THEN
589            CALL MOM_U_IMPLICIT_R( kappaRU,            CALL MOM_U_IMPLICIT_R( kappaRU,
590       I                           bi, bj, myTime, myIter, myThid )       I                           bi, bj, myTime, myIter, myThid )
591            CALL MOM_V_IMPLICIT_R( kappaRV,            CALL MOM_V_IMPLICIT_R( kappaRV,
592       I                           bi, bj, myTime, myIter, myThid )       I                           bi, bj, myTime, myIter, myThid )
# Line 479  CADJ STORE gU(:,:,:,bi,bj) = comlev1_bib Line 600  CADJ STORE gU(:,:,:,bi,bj) = comlev1_bib
600  #endif    /* ALLOW_AUTODIFF_TAMC */  #endif    /* ALLOW_AUTODIFF_TAMC */
601            CALL IMPLDIFF(            CALL IMPLDIFF(
602       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
603       I         -1, KappaRU,recip_HFacW,       I         -1, KappaRU, recip_hFacW(1-OLx,1-OLy,1,bi,bj),
604       U         gU,       U         gU,
605       I         myThid )       I         myThid )
606  #ifdef    ALLOW_AUTODIFF_TAMC  #ifdef    ALLOW_AUTODIFF_TAMC
# Line 488  CADJ STORE gV(:,:,:,bi,bj) = comlev1_bib Line 609  CADJ STORE gV(:,:,:,bi,bj) = comlev1_bib
609  #endif    /* ALLOW_AUTODIFF_TAMC */  #endif    /* ALLOW_AUTODIFF_TAMC */
610            CALL IMPLDIFF(            CALL IMPLDIFF(
611       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
612       I         -2, KappaRV,recip_HFacS,       I         -2, KappaRV, recip_hFacS(1-OLx,1-OLy,1,bi,bj),
613       U         gV,       U         gV,
614       I         myThid )       I         myThid )
615          ENDIF          ENDIF
616    
617  #ifdef   ALLOW_OBCS  #ifdef ALLOW_OBCS
618  C--      Apply open boundary conditions  C--      Apply open boundary conditions
619          IF ( useOBCS .AND.(implicitViscosity.OR.momImplVertAdv) ) THEN          IF ( useOBCS ) THEN
620             DO K=1,Nr  C--      but first save intermediate velocities to be used in the
621               CALL OBCS_APPLY_UV( bi, bj, k, gU, gV, myThid )  C        next time step for the Stevens boundary conditions
622             ENDDO            CALL OBCS_SAVE_UV_N(
623         I        bi, bj, iMin, iMax, jMin, jMax, 0,
624         I        gU, gV, myThid )
625              CALL OBCS_APPLY_UV( bi, bj, 0, gU, gV, myThid )
626          ENDIF          ENDIF
627  #endif   /* ALLOW_OBCS */  #endif /* ALLOW_OBCS */
628    
629  #ifdef    ALLOW_CD_CODE  #ifdef    ALLOW_CD_CODE
630          IF (implicitViscosity.AND.useCDscheme) THEN          IF (implicitViscosity.AND.useCDscheme) THEN
# Line 509  CADJ STORE vVelD(:,:,:,bi,bj) = comlev1_ Line 633  CADJ STORE vVelD(:,:,:,bi,bj) = comlev1_
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         0, KappaRU,recip_HFacW,       I         0, KappaRU, recip_hFacW(1-OLx,1-OLy,1,bi,bj),
637       U         vVelD,       U         vVelD,
638       I         myThid )       I         myThid )
639  #ifdef    ALLOW_AUTODIFF_TAMC  #ifdef    ALLOW_AUTODIFF_TAMC
# Line 517  CADJ STORE uVelD(:,:,:,bi,bj) = comlev1_ Line 641  CADJ STORE uVelD(:,:,:,bi,bj) = comlev1_
641  #endif    /* ALLOW_AUTODIFF_TAMC */  #endif    /* ALLOW_AUTODIFF_TAMC */
642            CALL IMPLDIFF(            CALL IMPLDIFF(
643       I         bi, bj, iMin, iMax, jMin, jMax,       I         bi, bj, iMin, iMax, jMin, jMax,
644       I         0, KappaRV,recip_HFacS,       I         0, KappaRV, recip_hFacS(1-OLx,1-OLy,1,bi,bj),
645       U         uVelD,       U         uVelD,
646       I         myThid )       I         myThid )
647          ENDIF          ENDIF
648  #endif    /* ALLOW_CD_CODE */  #endif    /* ALLOW_CD_CODE */
649  C--     End implicit Vertical advection & viscosity  C--     End implicit Vertical advection & viscosity
   
        ENDDO  
       ENDDO  
   
 #ifdef ALLOW_OBCS  
       IF (useOBCS) THEN  
        CALL OBCS_PRESCRIBE_EXCHANGES(myThid)  
       ENDIF  
 #endif  
650    
651  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
652    
653  #ifdef ALLOW_NONHYDROSTATIC  #ifdef ALLOW_NONHYDROSTATIC
654  C--   Step forward W field in N-H algorithm  C--   Step forward W field in N-H algorithm
655        IF ( momStepping .AND. nonHydrostatic ) THEN          IF ( nonHydrostatic ) THEN
656  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
657           IF ( debugLevel .GE. debLevB )           IF (debugMode) CALL DEBUG_CALL('CALC_GW', myThid )
      &     CALL DEBUG_CALL('CALC_GW', myThid )  
658  #endif  #endif
659           CALL TIMER_START('CALC_GW          [DYNAMICS]',myThid)           CALL TIMER_START('CALC_GW          [DYNAMICS]',myThid)
660           CALL CALC_GW( myTime, myIter, myThid )           CALL CALC_GW(
661           CALL TIMESTEP_WVEL( myTime, myIter, myThid )       I                 bi,bj, KappaRU, KappaRV,
662           CALL TIMER_STOP ('CALC_GW          [DYNAMICS]',myThid)       I                 myTime, myIter, myThid )
663        ENDIF          ENDIF
664            IF ( nonHydrostatic.OR.implicitIntGravWave )
665         &   CALL TIMESTEP_WVEL( bi,bj, myTime, myIter, myThid )
666            IF ( nonHydrostatic )
667         &   CALL TIMER_STOP ('CALC_GW          [DYNAMICS]',myThid)
668  #endif  #endif
669    
670  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
671    
672    C-    end of bi,bj loops
673           ENDDO
674          ENDDO
675    
676    #ifdef ALLOW_OBCS
677          IF (useOBCS) THEN
678            CALL OBCS_EXCHANGES( myThid )
679          ENDIF
680    #endif
681    
682  Cml(  Cml(
683  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
684  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
685  C     has to be removed by something like the following subroutine:  C     has to be removed by something like the following subroutine:
686  C      CALL REMOVE_MEAN_RL( 1, phiHydLow, maskH, maskH, rA, drF,  C      CALL REMOVE_MEAN_RL( 1, phiHydLow, maskInC, maskInC, rA, drF,
687  C     &                'phiHydLow', myThid )  C     &                     'phiHydLow', myTime, myThid )
688  Cml)  Cml)
689    
690  #ifdef ALLOW_DIAGNOSTICS  #ifdef ALLOW_DIAGNOSTICS
691        IF ( usediagnostics ) THEN        IF ( useDiagnostics ) THEN
692    
693         CALL DIAGNOSTICS_FILL(totPhihyd,'PHIHYD  ',0,Nr,0,1,1,myThid)         CALL DIAGNOSTICS_FILL(totPhihyd,'PHIHYD  ',0,Nr,0,1,1,myThid)
694         CALL DIAGNOSTICS_FILL(phiHydLow,'PHIBOT  ',0, 1,0,1,1,myThid)         CALL DIAGNOSTICS_FILL(phiHydLow,'PHIBOT  ',0, 1,0,1,1,myThid)
# Line 574  Cml) Line 702  Cml)
702    
703        ENDIF        ENDIF
704  #endif /* ALLOW_DIAGNOSTICS */  #endif /* ALLOW_DIAGNOSTICS */
705          
706  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
707        If ( debugLevel .GE. debLevB ) THEN        IF ( debugLevel .GE. debLevD ) THEN
708         CALL DEBUG_STATS_RL(1,EtaN,'EtaN (DYNAMICS)',myThid)         CALL DEBUG_STATS_RL(1,EtaN,'EtaN (DYNAMICS)',myThid)
709         CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (DYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (DYNAMICS)',myThid)
710         CALL DEBUG_STATS_RL(Nr,vVel,'Vvel (DYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,vVel,'Vvel (DYNAMICS)',myThid)
# Line 597  Cml) Line 725  Cml)
725  #endif  #endif
726    
727  #ifdef DYNAMICS_GUGV_EXCH_CHECK  #ifdef DYNAMICS_GUGV_EXCH_CHECK
728  C- jmc: For safety checking only: This Exchange here should not change  C- jmc: For safety checking only: This Exchange here should not change
729  C       the solution. If solution changes, it means something is wrong,  C       the solution. If solution changes, it means something is wrong,
730  C       but it does not mean that it is less wrong with this exchange.  C       but it does not mean that it is less wrong with this exchange.
731        IF ( debugLevel .GT. debLevB ) THEN        IF ( debugLevel .GE. debLevE ) THEN
732         CALL EXCH_UV_XYZ_RL(gU,gV,.TRUE.,myThid)         CALL EXCH_UV_XYZ_RL(gU,gV,.TRUE.,myThid)
733        ENDIF        ENDIF
734  #endif  #endif
735    
736  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
737        IF ( debugLevel .GE. debLevB )        IF (debugMode) CALL DEBUG_LEAVE( 'DYNAMICS', myThid )
      &   CALL DEBUG_LEAVE( 'DYNAMICS', myThid )  
738  #endif  #endif
739    
740        RETURN        RETURN
Legend:
Removed from v.1.127  
changed lines
  Added in v.1.166
  ViewVC Help
Powered by ViewVC 1.1.22