/[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.75 by adcroft, Fri Aug 3 19:06:11 2001 UTC revision 1.83.2.2 by heimbach, Mon Apr 8 20:10:37 2002 UTC
# Line 3  C $Name$ Line 3  C $Name$
3    
4  #include "CPP_OPTIONS.h"  #include "CPP_OPTIONS.h"
5    
6    CBOP
7    C     !ROUTINE: DYNAMICS
8    C     !INTERFACE:
9        SUBROUTINE DYNAMICS(myTime, myIter, myThid)        SUBROUTINE DYNAMICS(myTime, myIter, myThid)
10  C     /==========================================================\  C     !DESCRIPTION: \bv
11  C     | SUBROUTINE DYNAMICS                                      |  C     *==========================================================*
12  C     | o Controlling routine for the explicit part of the model |  C     | SUBROUTINE DYNAMICS                                      
13  C     |   dynamics.                                              |  C     | o Controlling routine for the explicit part of the model  
14  C     |==========================================================|  C     |   dynamics.                                              
15  C     | This routine evaluates the "dynamics" terms for each     |  C     *==========================================================*
16  C     | block of ocean in turn. Because the blocks of ocean have |  C     | This routine evaluates the "dynamics" terms for each      
17  C     | overlap regions they are independent of one another.     |  C     | block of ocean in turn. Because the blocks of ocean have  
18  C     | If terms involving lateral integrals are needed in this  |  C     | overlap regions they are independent of one another.      
19  C     | routine care will be needed. Similarly finite-difference |  C     | If terms involving lateral integrals are needed in this  
20  C     | operations with stencils wider than the overlap region   |  C     | routine care will be needed. Similarly finite-difference  
21  C     | require special consideration.                           |  C     | operations with stencils wider than the overlap region    
22  C     | Notes                                                    |  C     | require special consideration.                            
23  C     | =====                                                    |  C     | The algorithm...
24  C     | C*P* comments indicating place holders for which code is |  C     |
25  C     |      presently being developed.                          |  C     | "Correction Step"
26  C     \==========================================================/  C     | =================
27    C     | Here we update the horizontal velocities with the surface
28    C     | pressure such that the resulting flow is either consistent
29    C     | with the free-surface evolution or the rigid-lid:
30    C     |   U[n] = U* + dt x d/dx P
31    C     |   V[n] = V* + dt x d/dy P
32    C     |
33    C     | "Calculation of Gs"
34    C     | ===================
35    C     | This is where all the accelerations and tendencies (ie.
36    C     | physics, parameterizations etc...) are calculated
37    C     |   rho = rho ( theta[n], salt[n] )
38    C     |   b   = b(rho, theta)
39    C     |   K31 = K31 ( rho )
40    C     |   Gu[n] = Gu( u[n], v[n], wVel, b, ... )
41    C     |   Gv[n] = Gv( u[n], v[n], wVel, b, ... )
42    C     |   Gt[n] = Gt( theta[n], u[n], v[n], wVel, K31, ... )
43    C     |   Gs[n] = Gs( salt[n], u[n], v[n], wVel, K31, ... )
44    C     |
45    C     | "Time-stepping" or "Prediction"
46    C     | ================================
47    C     | The models variables are stepped forward with the appropriate
48    C     | time-stepping scheme (currently we use Adams-Bashforth II)
49    C     | - For momentum, the result is always *only* a "prediction"
50    C     | in that the flow may be divergent and will be "corrected"
51    C     | later with a surface pressure gradient.
52    C     | - Normally for tracers the result is the new field at time
53    C     | level [n+1} *BUT* in the case of implicit diffusion the result
54    C     | is also *only* a prediction.
55    C     | - We denote "predictors" with an asterisk (*).
56    C     |   U* = U[n] + dt x ( 3/2 Gu[n] - 1/2 Gu[n-1] )
57    C     |   V* = V[n] + dt x ( 3/2 Gv[n] - 1/2 Gv[n-1] )
58    C     |   theta[n+1] = theta[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
59    C     |   salt[n+1] = salt[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
60    C     | With implicit diffusion:
61    C     |   theta* = theta[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
62    C     |   salt* = salt[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
63    C     |   (1 + dt * K * d_zz) theta[n] = theta*
64    C     |   (1 + dt * K * d_zz) salt[n] = salt*
65    C     |
66    C     *==========================================================*
67    C     \ev
68    C     !USES:
69        IMPLICIT NONE        IMPLICIT NONE
   
70  C     == Global variables ===  C     == Global variables ===
71  #include "SIZE.h"  #include "SIZE.h"
72  #include "EEPARAMS.h"  #include "EEPARAMS.h"
# Line 32  C     == Global variables === Line 76  C     == Global variables ===
76  #ifdef ALLOW_PASSIVE_TRACER  #ifdef ALLOW_PASSIVE_TRACER
77  #include "TR1.h"  #include "TR1.h"
78  #endif  #endif
   
79  #ifdef ALLOW_AUTODIFF_TAMC  #ifdef ALLOW_AUTODIFF_TAMC
80  # include "tamc.h"  # include "tamc.h"
81  # include "tamc_keys.h"  # include "tamc_keys.h"
# Line 44  C     == Global variables === Line 87  C     == Global variables ===
87  #  include "GMREDI.h"  #  include "GMREDI.h"
88  # endif  # endif
89  #endif /* ALLOW_AUTODIFF_TAMC */  #endif /* ALLOW_AUTODIFF_TAMC */
   
90  #ifdef ALLOW_TIMEAVE  #ifdef ALLOW_TIMEAVE
91  #include "TIMEAVE_STATV.h"  #include "TIMEAVE_STATV.h"
92  #endif  #endif
93    
94    C     !CALLING SEQUENCE:
95    C     DYNAMICS()
96    C      |
97    C      |-- CALC_GRAD_PHI_SURF
98    C      |
99    C      |-- CALC_VISCOSITY
100    C      |
101    C      |-- CALC_PHI_HYD  
102    C      |
103    C      |-- MOM_FLUXFORM  
104    C      |
105    C      |-- MOM_VECINV    
106    C      |
107    C      |-- TIMESTEP      
108    C      |
109    C      |-- OBCS_APPLY_UV
110    C      |
111    C      |-- IMPLDIFF      
112    C      |
113    C      |-- OBCS_APPLY_UV
114    C      |
115    C      |-- CALL TIMEAVE_CUMUL_1T
116    C      |-- CALL DEBUG_STATS_RL
117    
118    C     !INPUT/OUTPUT PARAMETERS:
119  C     == Routine arguments ==  C     == Routine arguments ==
120  C     myTime - Current time in simulation  C     myTime - Current time in simulation
121  C     myIter - Current iteration number in simulation  C     myIter - Current iteration number in simulation
# Line 57  C     myThid - Thread number for this in Line 124  C     myThid - Thread number for this in
124        INTEGER myIter        INTEGER myIter
125        INTEGER myThid        INTEGER myThid
126    
127    C     !LOCAL VARIABLES:
128  C     == Local variables  C     == Local variables
 C     xA, yA                 - Per block temporaries holding face areas  
 C     uTrans, vTrans, rTrans - Per block temporaries holding flow  
 C                              transport  
 C                              o uTrans: Zonal transport  
 C                              o vTrans: Meridional transport  
 C                              o rTrans: Vertical transport  
 C     maskUp                   o maskUp: land/water mask for W points  
129  C     fVer[STUV]               o fVer: Vertical flux term - note fVer  C     fVer[STUV]               o fVer: Vertical flux term - note fVer
130  C                                      is "pipelined" in the vertical  C                                      is "pipelined" in the vertical
131  C                                      so we need an fVer for each  C                                      so we need an fVer for each
# Line 77  C                      In p coords phiHy Line 138  C                      In p coords phiHy
138  C                      surface height anomaly.  C                      surface height anomaly.
139  C     phiSurfX, - gradient of Surface potentiel (Pressure/rho, ocean)  C     phiSurfX, - gradient of Surface potentiel (Pressure/rho, ocean)
140  C     phiSurfY             or geopotentiel (atmos) in X and Y direction  C     phiSurfY             or geopotentiel (atmos) in X and Y direction
 C     KappaRT,       - Total diffusion in vertical for T and S.  
 C     KappaRS          (background + spatially varying, isopycnal term).  
141  C     iMin, iMax     - Ranges and sub-block indices on which calculations  C     iMin, iMax     - Ranges and sub-block indices on which calculations
142  C     jMin, jMax       are applied.  C     jMin, jMax       are applied.
143  C     bi, bj  C     bi, bj
144  C     k, kup,        - Index for layer above and below. kup and kDown  C     k, kup,        - Index for layer above and below. kup and kDown
145  C     kDown, km1       are switched with layer to be the appropriate  C     kDown, km1       are switched with layer to be the appropriate
146  C                      index into fVerTerm.  C                      index into fVerTerm.
 C     tauAB - Adams-Bashforth timestepping weight: 0=forward ; 1/2=Adams-Bashf.  
       _RS xA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RS yA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL uTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL vTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL rTrans  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RS maskUp  (1-OLx:sNx+OLx,1-OLy:sNy+OLy)  
       _RL fVerT   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)  
       _RL fVerS   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)  
       _RL fVerTr1 (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)  
147        _RL fVerU   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerU   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
148        _RL fVerV   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)        _RL fVerV   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
149        _RL phiHyd  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)        _RL phiHyd  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
# Line 102  C     tauAB - Adams-Bashforth timesteppi Line 151  C     tauAB - Adams-Bashforth timesteppi
151        _RL rhok    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL rhok    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
152        _RL phiSurfX(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL phiSurfX(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
153        _RL phiSurfY(1-OLx:sNx+OLx,1-OLy:sNy+OLy)        _RL phiSurfY(1-OLx:sNx+OLx,1-OLy:sNy+OLy)
       _RL KappaRT (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)  
       _RL KappaRS (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)  
154        _RL KappaRU (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)        _RL KappaRU (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)
155        _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)  
156    
157        INTEGER iMin, iMax        INTEGER iMin, iMax
158        INTEGER jMin, jMax        INTEGER jMin, jMax
159        INTEGER bi, bj        INTEGER bi, bj
160        INTEGER i, j        INTEGER i, j
161        INTEGER k, km1, kup, kDown        INTEGER k, km1, kp1, kup, kDown
162    
163  Cjmc : add for phiHyd output <- but not working if multi tile per CPU  Cjmc : add for phiHyd output <- but not working if multi tile per CPU
164  c     CHARACTER*(MAX_LEN_MBUF) suff  c     CHARACTER*(MAX_LEN_MBUF) suff
# Line 169  C         salt* = salt[n] + dt x ( 3/2 G Line 209  C         salt* = salt[n] + dt x ( 3/2 G
209  C         (1 + dt * K * d_zz) theta[n] = theta*  C         (1 + dt * K * d_zz) theta[n] = theta*
210  C         (1 + dt * K * d_zz) salt[n] = salt*  C         (1 + dt * K * d_zz) salt[n] = salt*
211  C---  C---
212    CEOP
213    
214    C--   Set up work arrays with valid (i.e. not NaN) values
215    C     These inital values do not alter the numerical results. They
216    C     just ensure that all memory references are to valid floating
217    C     point numbers. This prevents spurious hardware signals due to
218    C     uninitialised but inert locations.
219          DO j=1-OLy,sNy+OLy
220           DO i=1-OLx,sNx+OLx
221            DO k=1,Nr
222             phiHyd(i,j,k)  = 0. _d 0
223             KappaRU(i,j,k) = 0. _d 0
224             KappaRV(i,j,k) = 0. _d 0
225            ENDDO
226            rhoKM1 (i,j) = 0. _d 0
227            rhok   (i,j) = 0. _d 0
228            phiSurfX(i,j) = 0. _d 0
229            phiSurfY(i,j) = 0. _d 0
230           ENDDO
231          ENDDO
232    
233    #ifdef ALLOW_AUTODIFF_TAMC
234    C--   HPF directive to help TAMC
235    CHPF$ INDEPENDENT
236    #endif /* ALLOW_AUTODIFF_TAMC */
237    
238        DO bj=myByLo(myThid),myByHi(myThid)        DO bj=myByLo(myThid),myByHi(myThid)
239    
240    #ifdef ALLOW_AUTODIFF_TAMC
241    C--    HPF directive to help TAMC
242    CHPF$  INDEPENDENT, NEW (fVerU,fVerV
243    CHPF$&                  ,phiHyd
244    CHPF$&                  ,KappaRU,KappaRV
245    CHPF$&                  )
246    #endif /* ALLOW_AUTODIFF_TAMC */
247    
248         DO bi=myBxLo(myThid),myBxHi(myThid)         DO bi=myBxLo(myThid),myBxHi(myThid)
249  Ccs-  
250    #ifdef ALLOW_AUTODIFF_TAMC
251              act1 = bi - myBxLo(myThid)
252              max1 = myBxHi(myThid) - myBxLo(myThid) + 1
253              act2 = bj - myByLo(myThid)
254              max2 = myByHi(myThid) - myByLo(myThid) + 1
255              act3 = myThid - 1
256              max3 = nTx*nTy
257              act4 = ikey_dynamics - 1
258              ikey = (act1 + 1) + act2*max1
259         &                      + act3*max1*max2
260         &                      + act4*max1*max2*max3
261    #endif /* ALLOW_AUTODIFF_TAMC */
262    
263    C--     Set up work arrays that need valid initial values
264            DO j=1-OLy,sNy+OLy
265             DO i=1-OLx,sNx+OLx
266              fVerU  (i,j,1) = 0. _d 0
267              fVerU  (i,j,2) = 0. _d 0
268              fVerV  (i,j,1) = 0. _d 0
269              fVerV  (i,j,2) = 0. _d 0
270             ENDDO
271            ENDDO
272    
273  C--     Start computation of dynamics  C--     Start computation of dynamics
274          iMin = 1-OLx+2          iMin = 1-OLx+2
# Line 180  C--     Start computation of dynamics Line 276  C--     Start computation of dynamics
276          jMin = 1-OLy+2          jMin = 1-OLy+2
277          jMax = sNy+OLy-1          jMax = sNy+OLy-1
278    
279    #ifdef ALLOW_AUTODIFF_TAMC
280    CADJ STORE wvel (:,:,:,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte
281    #endif /* ALLOW_AUTODIFF_TAMC */
282    
283  C--     Explicit part of the Surface Potentiel Gradient (add in TIMESTEP)  C--     Explicit part of the Surface Potentiel Gradient (add in TIMESTEP)
284  C       (note: this loop will be replaced by CALL CALC_GRAD_ETA)  C       (note: this loop will be replaced by CALL CALC_GRAD_ETA)
285          IF (implicSurfPress.NE.1.) THEN          IF (implicSurfPress.NE.1.) THEN
# Line 190  C       (note: this loop will be replace Line 290  C       (note: this loop will be replace
290       I         myThid )                               I         myThid )                        
291          ENDIF          ENDIF
292    
293    #ifdef ALLOW_AUTODIFF_TAMC
294    CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte
295    CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte
296    #ifdef ALLOW_KPP
297    CADJ STORE KPPviscAz (:,:,:,bi,bj)
298    CADJ &                 = comlev1_bibj, key=ikey, byte=isbyte
299    #endif /* ALLOW_KPP */
300    #endif /* ALLOW_AUTODIFF_TAMC */
301    
302    #ifdef  INCLUDE_CALC_DIFFUSIVITY_CALL
303    C--      Calculate the total vertical diffusivity
304            DO k=1,Nr
305             CALL CALC_VISCOSITY(
306         I        bi,bj,iMin,iMax,jMin,jMax,k,
307         O        KappaRU,KappaRV,
308         I        myThid)
309           ENDDO
310    #endif
311    
312  C--     Start of dynamics loop  C--     Start of dynamics loop
313          DO k=1,Nr          DO k=1,Nr
314    
# Line 198  C--       kup    Cycles through 1,2 to p Line 317  C--       kup    Cycles through 1,2 to p
317  C--       kDown  Cycles through 2,1 to point to current layer  C--       kDown  Cycles through 2,1 to point to current layer
318    
319            km1  = MAX(1,k-1)            km1  = MAX(1,k-1)
320              kp1  = MIN(k+1,Nr)
321            kup  = 1+MOD(k+1,2)            kup  = 1+MOD(k+1,2)
322            kDown= 1+MOD(k,2)            kDown= 1+MOD(k,2)
323    
324    #ifdef ALLOW_AUTODIFF_TAMC
325             kkey = (ikey-1)*Nr + k
326    #endif /* ALLOW_AUTODIFF_TAMC */
327    
328  C--      Integrate hydrostatic balance for phiHyd with BC of  C--      Integrate hydrostatic balance for phiHyd with BC of
329  C        phiHyd(z=0)=0  C        phiHyd(z=0)=0
330  C        distinguishe between Stagger and Non Stagger time stepping  C        distinguishe between Stagger and Non Stagger time stepping
331           IF (staggerTimeStep) THEN           IF (staggerTimeStep) THEN
332             CALL CALC_PHI_HYD(             CALL CALC_PHI_HYD(
333       I        bi,bj,iMin,iMax,jMin,jMax,k,       I        bi,bj,iMin,iMax,jMin,jMax,k,
334       I        gTnm1, gSnm1,       I        gT, gS,
335       U        phiHyd,       U        phiHyd,
336       I        myThid )       I        myThid )
337           ELSE           ELSE
# Line 218  C        distinguishe between Stagger an Line 342  C        distinguishe between Stagger an
342       I        myThid )       I        myThid )
343           ENDIF           ENDIF
344    
 #ifdef ALLOW_AUTODIFF_TAMC  
 CADJ STORE KappaRT(:,:,k)    = comlev1_bibj_k, key=kkey, byte=isbyte  
 CADJ STORE KappaRS(:,:,k)    = comlev1_bibj_k, key=kkey, byte=isbyte  
 #endif /* ALLOW_AUTODIFF_TAMC */  
   
 #ifdef  INCLUDE_CALC_DIFFUSIVITY_CALL  
 C--      Calculate the total vertical diffusivity  
          CALL CALC_DIFFUSIVITY(  
      I        bi,bj,iMin,iMax,jMin,jMax,k,  
      I        maskUp,  
      O        KappaRT,KappaRS,KappaRU,KappaRV,  
      I        myThid)  
 #endif  
   
345  C--      Calculate accelerations in the momentum equations (gU, gV, ...)  C--      Calculate accelerations in the momentum equations (gU, gV, ...)
346  C        and step forward storing the result in gUnm1, gVnm1, etc...  C        and step forward storing the result in gUnm1, gVnm1, etc...
347           IF ( momStepping ) THEN           IF ( momStepping ) THEN
348             CALL CALC_MOM_RHS(  #ifndef DISABLE_MOM_FLUXFORM
349               IF (.NOT. vectorInvariantMomentum) CALL MOM_FLUXFORM(
350       I         bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown,       I         bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown,
351       I         phiHyd,KappaRU,KappaRV,       I         phiHyd,KappaRU,KappaRV,
352       U         fVerU, fVerV,       U         fVerU, fVerV,
353       I         myTime, myThid)       I         myTime, myIter, myThid)
354    #endif
355    #ifndef DISABLE_MOM_VECINV
356               IF (vectorInvariantMomentum) CALL MOM_VECINV(
357         I         bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown,
358         I         phiHyd,KappaRU,KappaRV,
359         U         fVerU, fVerV,
360         I         myTime, myIter, myThid)
361    #endif
362             CALL TIMESTEP(             CALL TIMESTEP(
363       I         bi,bj,iMin,iMax,jMin,jMax,k,       I         bi,bj,iMin,iMax,jMin,jMax,k,
364       I         phiHyd, phiSurfX, phiSurfY,       I         phiHyd, phiSurfX, phiSurfY,
# Line 336  Cjmc(end) Line 455  Cjmc(end)
455          IF (taveFreq.GT.0.) THEN          IF (taveFreq.GT.0.) THEN
456            CALL TIMEAVE_CUMUL_1T(phiHydtave, phiHyd, Nr,            CALL TIMEAVE_CUMUL_1T(phiHydtave, phiHyd, Nr,
457       I                              deltaTclock, bi, bj, myThid)       I                              deltaTclock, bi, bj, myThid)
           IF (ivdc_kappa.NE.0.) THEN  
             CALL TIMEAVE_CUMULATE(ConvectCountTave, ConvectCount, Nr,  
      I                              deltaTclock, bi, bj, myThid)  
           ENDIF  
458          ENDIF          ENDIF
459  #endif /* ALLOW_TIMEAVE */  #endif /* ALLOW_TIMEAVE */
460    
461         ENDDO         ENDDO
462        ENDDO        ENDDO
463    
464  #ifndef EXCLUDE_DEBUGMODE  #ifndef DISABLE_DEBUGMODE
465        If (debugMode) THEN        If (debugMode) THEN
466         CALL DEBUG_STATS_RL(1,EtaN,'EtaN (DYNAMICS)',myThid)         CALL DEBUG_STATS_RL(1,EtaN,'EtaN (DYNAMICS)',myThid)
467         CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (DYNAMICS)',myThid)         CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (DYNAMICS)',myThid)
Legend:
Removed from v.1.75  
changed lines
  Added in v.1.83.2.2
  ViewVC Help
Powered by ViewVC 1.1.22