/[MITgcm]/MITgcm/model/src/dynamics.F

Diff of /MITgcm/model/src/dynamics.F

Parent Directory | 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.88 by heimbach,
Sat Jul 13 04:59:42 2002 UTC
 Line 3 
 C $Name$
  #include "CPP_OPTIONS.h"
+ CBOP
+ C     !ROUTINE: DYNAMICS
+ C     !INTERFACE:
        SUBROUTINE DYNAMICS(myTime, myIter, myThid)
- C     /==========================================================\
+ C     !DESCRIPTION: \bv
- C     | SUBROUTINE DYNAMICS                                      |
+ C     *==========================================================*
- C     | o Controlling routine for the explicit part of the model |
+ C     | SUBROUTINE DYNAMICS
- C     |   dynamics.                                              |
+ C     | o Controlling routine for the explicit part of the model
- C     |==========================================================|
+ C     |   dynamics.
- C     | This routine evaluates the "dynamics" terms for each     |
+ C     *==========================================================*
- C     | block of ocean in turn. Because the blocks of ocean have |
+ C     | This routine evaluates the "dynamics" terms for each
- C     | overlap regions they are independent of one another.     |
+ C     | block of ocean in turn. Because the blocks of ocean have
- C     | If terms involving lateral integrals are needed in this  |
+ C     | overlap regions they are independent of one another.
- C     | routine care will be needed. Similarly finite-difference |
+ C     | If terms involving lateral integrals are needed in this
- C     | operations with stencils wider than the overlap region   |
+ C     | routine care will be needed. Similarly finite-difference
- C     | require special consideration.                           |
+ C     | operations with stencils wider than the overlap region
- C     | Notes                                                    |
+ C     | require special consideration.
- C     | =====                                                    |
+ C     | The algorithm...
- C     | C*P* comments indicating place holders for which code is |
+ C     |
- C     |      presently being developed.                          |
+ C     | "Correction Step"
- C     \==========================================================/
+ C     | =================
+ C     | Here we update the horizontal velocities with the surface
+ C     | pressure such that the resulting flow is either consistent
+ C     | with the free-surface evolution or the rigid-lid:
+ C     |   U[n] = U* + dt x d/dx P
+ C     |   V[n] = V* + dt x d/dy P
+ C     |
+ C     | "Calculation of Gs"
+ C     | ===================
+ C     | This is where all the accelerations and tendencies (ie.
+ C     | physics, parameterizations etc...) are calculated
+ C     |   rho = rho ( theta[n], salt[n] )
+ C     |   b   = b(rho, theta)
+ C     |   K31 = K31 ( rho )
+ C     |   Gu[n] = Gu( u[n], v[n], wVel, b, ... )
+ C     |   Gv[n] = Gv( u[n], v[n], wVel, b, ... )
+ C     |   Gt[n] = Gt( theta[n], u[n], v[n], wVel, K31, ... )
+ C     |   Gs[n] = Gs( salt[n], u[n], v[n], wVel, K31, ... )
+ C     |
+ C     | "Time-stepping" or "Prediction"
+ C     | ================================
+ C     | The models variables are stepped forward with the appropriate
+ C     | time-stepping scheme (currently we use Adams-Bashforth II)
+ C     | - For momentum, the result is always *only* a "prediction"
+ C     | in that the flow may be divergent and will be "corrected"
+ C     | later with a surface pressure gradient.
+ C     | - Normally for tracers the result is the new field at time
+ C     | level [n+1} *BUT* in the case of implicit diffusion the result
+ C     | is also *only* a prediction.
+ C     | - We denote "predictors" with an asterisk (*).
+ C     |   U* = U[n] + dt x ( 3/2 Gu[n] - 1/2 Gu[n-1] )
+ C     |   V* = V[n] + dt x ( 3/2 Gv[n] - 1/2 Gv[n-1] )
+ C     |   theta[n+1] = theta[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
+ C     |   salt[n+1] = salt[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
+ C     | With implicit diffusion:
+ C     |   theta* = theta[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
+ C     |   salt* = salt[n] + dt x ( 3/2 Gt[n] - 1/2 atG[n-1] )
+ C     |   (1 + dt * K * d_zz) theta[n] = theta*
+ C     |   (1 + dt * K * d_zz) salt[n] = salt*
+ C     |
+ C     *==========================================================*
+ C     \ev
+ C     !USES:
        IMPLICIT NONE
  C     == Global variables ===
  #include "SIZE.h"
  #include "EEPARAMS.h"
-Line 32 
 C     == Global variables ===
+Line 76 
 C     == Global variables ===
  #ifdef ALLOW_PASSIVE_TRACER
  #include "TR1.h"
  #endif
  #ifdef ALLOW_AUTODIFF_TAMC
  # include "tamc.h"
  # include "tamc_keys.h"
-Line 40 
 C     == Global variables ===
+Line 83 
 C     == Global variables ===
  # ifdef ALLOW_KPP
  #  include "KPP.h"
  # endif
- # ifdef ALLOW_GMREDI
- #  include "GMREDI.h"
- # endif
  #endif /* ALLOW_AUTODIFF_TAMC */
  #ifdef ALLOW_TIMEAVE
  #include "TIMEAVE_STATV.h"
  #endif
+ C     !CALLING SEQUENCE:
+ C     DYNAMICS()
+ C      |
+ C      |-- CALC_GRAD_PHI_SURF
+ C      |
+ C      |-- CALC_VISCOSITY
+ C      |
+ C      |-- CALC_PHI_HYD
+ C      |
+ C      |-- MOM_FLUXFORM
+ C      |
+ C      |-- MOM_VECINV
+ C      |
+ C      |-- TIMESTEP
+ C      |
+ C      |-- OBCS_APPLY_UV
+ C      |
+ C      |-- IMPLDIFF
+ C      |
+ C      |-- OBCS_APPLY_UV
+ C      |
+ C      |-- CALL TIMEAVE_CUMUL_1T
+ C      |-- CALL DEBUG_STATS_RL
+ C     !INPUT/OUTPUT PARAMETERS:
  C     == Routine arguments ==
  C     myTime - Current time in simulation
  C     myIter - Current iteration number in simulation
-Line 57 
 C     myThid - Thread number for this in
+Line 121 
 C     myThid - Thread number for this in
        INTEGER myIter
        INTEGER myThid
+ 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
  C     fVer[STUV]               o fVer: Vertical flux term - note fVer
  C                                      is "pipelined" in the vertical
  C                                      so we need an fVer for each
-Line 77 
 C                      In p coords phiHy
+Line 135 
 C                      In p coords phiHy
  C                      surface height anomaly.
  C     phiSurfX, - gradient of Surface potentiel (Pressure/rho, ocean)
  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).
  C     iMin, iMax     - Ranges and sub-block indices on which calculations
  C     jMin, jMax       are applied.
  C     bi, bj
  C     k, kup,        - Index for layer above and below. kup and kDown
  C     kDown, km1       are switched with layer to be the appropriate
  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)
        _RL fVerU   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
        _RL fVerV   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,2)
        _RL phiHyd  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
-Line 102 
 C     tauAB - Adams-Bashforth timesteppi
+Line 148 
 C     tauAB - Adams-Bashforth timesteppi
        _RL rhok    (1-OLx:sNx+OLx,1-OLy:sNy+OLy)
        _RL phiSurfX(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)
        _RL KappaRU (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)
        _RL KappaRV (1-Olx:sNx+Olx,1-Oly:sNy+Oly,Nr)
-       _RL sigmaX  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
-       _RL sigmaY  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
-       _RL sigmaR  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
-       _RL tauAB
- C This is currently used by IVDC and Diagnostics
-       _RL ConvectCount (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr)
        INTEGER iMin, iMax
        INTEGER jMin, jMax
        INTEGER bi, bj
        INTEGER i, j
-       INTEGER k, km1, kup, kDown
+       INTEGER k, km1, kp1, kup, kDown
  Cjmc : add for phiHyd output <- but not working if multi tile per CPU
  c     CHARACTER*(MAX_LEN_MBUF) suff
-Line 169 
 C         salt* = salt[n] + dt x ( 3/2 G
+Line 206 
 C         salt* = salt[n] + dt x ( 3/2 G
  C         (1 + dt * K * d_zz) theta[n] = theta*
  C         (1 + dt * K * d_zz) salt[n] = salt*
  C---
+ CEOP
+ C--   Set up work arrays with valid (i.e. not NaN) values
+ C     These inital values do not alter the numerical results. They
+ C     just ensure that all memory references are to valid floating
+ C     point numbers. This prevents spurious hardware signals due to
+ C     uninitialised but inert locations.
+       DO j=1-OLy,sNy+OLy
+        DO i=1-OLx,sNx+OLx
+         rhoKM1 (i,j) = 0. _d 0
+         rhok   (i,j) = 0. _d 0
+         phiSurfX(i,j) = 0. _d 0
+         phiSurfY(i,j) = 0. _d 0
+        ENDDO
+       ENDDO
+ C-- Call to routine for calculation of
+ C   Eliassen-Palm-flux-forced U-tendency,
+ C   if desired:
+ #ifdef INCLUDE_EP_FORCING_CODE
+       CALL CALC_EP_FORCING(myThid)
+ #endif
+ #ifdef ALLOW_AUTODIFF_TAMC
+ C--   HPF directive to help TAMC
+ CHPF$ INDEPENDENT
+ #endif /* ALLOW_AUTODIFF_TAMC */
        DO bj=myByLo(myThid),myByHi(myThid)
+ #ifdef ALLOW_AUTODIFF_TAMC
+ C--    HPF directive to help TAMC
+ CHPF$  INDEPENDENT, NEW (fVerU,fVerV
+ CHPF$&                  ,phiHyd
+ CHPF$&                  ,KappaRU,KappaRV
+ CHPF$&                  )
+ #endif /* ALLOW_AUTODIFF_TAMC */
         DO bi=myBxLo(myThid),myBxHi(myThid)
- Ccs-
+ #ifdef ALLOW_AUTODIFF_TAMC
+           act1 = bi - myBxLo(myThid)
+           max1 = myBxHi(myThid) - myBxLo(myThid) + 1
+           act2 = bj - myByLo(myThid)
+           max2 = myByHi(myThid) - myByLo(myThid) + 1
+           act3 = myThid - 1
+           max3 = nTx*nTy
+           act4 = ikey_dynamics - 1
+           ikey = (act1 + 1) + act2*max1
+      &                      + act3*max1*max2
+      &                      + act4*max1*max2*max3
+ #endif /* ALLOW_AUTODIFF_TAMC */
+ C--     Set up work arrays that need valid initial values
+         DO j=1-OLy,sNy+OLy
+          DO i=1-OLx,sNx+OLx
+           DO k=1,Nr
+            phiHyd(i,j,k)  = 0. _d 0
+            KappaRU(i,j,k) = 0. _d 0
+            KappaRV(i,j,k) = 0. _d 0
+           ENDDO
+           fVerU  (i,j,1) = 0. _d 0
+           fVerU  (i,j,2) = 0. _d 0
+           fVerV  (i,j,1) = 0. _d 0
+           fVerV  (i,j,2) = 0. _d 0
+          ENDDO
+         ENDDO
  C--     Start computation of dynamics
          iMin = 1-OLx+2
-Line 180 
 C--     Start computation of dynamics
+Line 280 
 C--     Start computation of dynamics
          jMin = 1-OLy+2
          jMax = sNy+OLy-1
+ #ifdef ALLOW_AUTODIFF_TAMC
+ CADJ STORE wvel (:,:,:,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte
+ #endif /* ALLOW_AUTODIFF_TAMC */
  C--     Explicit part of the Surface Potentiel Gradient (add in TIMESTEP)
  C       (note: this loop will be replaced by CALL CALC_GRAD_ETA)
          IF (implicSurfPress.NE.1.) THEN
-Line 190 
 C       (note: this loop will be replace
+Line 294 
 C       (note: this loop will be replace
       I         myThid )
          ENDIF
+ #ifdef ALLOW_AUTODIFF_TAMC
+ CADJ STORE uvel (:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte
+ CADJ STORE vvel (:,:,:,bi,bj) = comlev1_bibj, key=ikey, byte=isbyte
+ #ifdef ALLOW_KPP
+ CADJ STORE KPPviscAz (:,:,:,bi,bj)
+ CADJ &                 = comlev1_bibj, key=ikey, byte=isbyte
+ #endif /* ALLOW_KPP */
+ #endif /* ALLOW_AUTODIFF_TAMC */
+ #ifdef  INCLUDE_CALC_DIFFUSIVITY_CALL
+ C--      Calculate the total vertical diffusivity
+         DO k=1,Nr
+          CALL CALC_VISCOSITY(
+      I        bi,bj,iMin,iMax,jMin,jMax,k,
+      O        KappaRU,KappaRV,
+      I        myThid)
+        ENDDO
+ #endif
  C--     Start of dynamics loop
          DO k=1,Nr
-Line 198 
 C--       kup    Cycles through 1,2 to p
+Line 321 
 C--       kup    Cycles through 1,2 to p
  C--       kDown  Cycles through 2,1 to point to current layer
            km1  = MAX(1,k-1)
+           kp1  = MIN(k+1,Nr)
            kup  = 1+MOD(k+1,2)
            kDown= 1+MOD(k,2)
+ #ifdef ALLOW_AUTODIFF_TAMC
+          kkey = (ikey-1)*Nr + k
+ #endif /* ALLOW_AUTODIFF_TAMC */
  C--      Integrate hydrostatic balance for phiHyd with BC of
  C        phiHyd(z=0)=0
  C        distinguishe between Stagger and Non Stagger time stepping
           IF (staggerTimeStep) THEN
             CALL CALC_PHI_HYD(
       I        bi,bj,iMin,iMax,jMin,jMax,k,
-      I        gTnm1, gSnm1,
+      I        gT, gS,
       U        phiHyd,
       I        myThid )
           ELSE
-Line 218 
 C        distinguishe between Stagger an
+Line 346 
 C        distinguishe between Stagger an
       I        myThid )
           ENDIF
- #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
  C--      Calculate accelerations in the momentum equations (gU, gV, ...)
  C        and step forward storing the result in gUnm1, gVnm1, etc...
           IF ( momStepping ) THEN
-            CALL CALC_MOM_RHS(
+ #ifndef DISABLE_MOM_FLUXFORM
+            IF (.NOT. vectorInvariantMomentum) CALL MOM_FLUXFORM(
+      I         bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown,
+      I         phiHyd,KappaRU,KappaRV,
+      U         fVerU, fVerV,
+      I         myTime, myIter, myThid)
+ #endif
+ #ifndef DISABLE_MOM_VECINV
+            IF (vectorInvariantMomentum) CALL MOM_VECINV(
       I         bi,bj,iMin,iMax,jMin,jMax,k,kup,kDown,
       I         phiHyd,KappaRU,KappaRV,
       U         fVerU, fVerV,
-      I         myTime, myThid)
+      I         myTime, myIter, myThid)
+ #endif
             CALL TIMESTEP(
       I         bi,bj,iMin,iMax,jMin,jMax,k,
       I         phiHyd, phiSurfX, phiSurfY,
-Line 269 
 C--      Apply open boundary conditions
+Line 392 
 C--      Apply open boundary conditions
  C--     end of dynamics k loop (1:Nr)
          ENDDO
  C--     Implicit viscosity
          IF (implicitViscosity.AND.momStepping) THEN
  #ifdef    ALLOW_AUTODIFF_TAMC
-           idkey = iikey + 3
  CADJ STORE gUNm1(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte
  #endif    /* ALLOW_AUTODIFF_TAMC */
            CALL IMPLDIFF(
-Line 283 
 CADJ STORE gUNm1(:,:,:,bi,bj) = comlev1_
+Line 403 
 CADJ STORE gUNm1(:,:,:,bi,bj) = comlev1_
       U         gUNm1,
       I         myThid )
  #ifdef    ALLOW_AUTODIFF_TAMC
-           idkey = iikey + 4
  CADJ STORE gVNm1(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte
  #endif    /* ALLOW_AUTODIFF_TAMC */
            CALL IMPLDIFF(
-Line 303 
 C--      Apply open boundary conditions
+Line 422 
 C--      Apply open boundary conditions
  #ifdef    INCLUDE_CD_CODE
  #ifdef    ALLOW_AUTODIFF_TAMC
-           idkey = iikey + 5
  CADJ STORE vVelD(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte
  #endif    /* ALLOW_AUTODIFF_TAMC */
            CALL IMPLDIFF(
-Line 312 
 CADJ STORE vVelD(:,:,:,bi,bj) = comlev1_
+Line 430 
 CADJ STORE vVelD(:,:,:,bi,bj) = comlev1_
       U         vVelD,
       I         myThid )
  #ifdef    ALLOW_AUTODIFF_TAMC
-           idkey = iikey + 6
  CADJ STORE uVelD(:,:,:,bi,bj) = comlev1_bibj , key=ikey, byte=isbyte
  #endif    /* ALLOW_AUTODIFF_TAMC */
            CALL IMPLDIFF(
-Line 336 
 Cjmc(end)
+Line 453 
 Cjmc(end)
          IF (taveFreq.GT.0.) THEN
            CALL TIMEAVE_CUMUL_1T(phiHydtave, phiHyd, Nr,
       I                              deltaTclock, bi, bj, myThid)
-           IF (ivdc_kappa.NE.0.) THEN
-             CALL TIMEAVE_CUMULATE(ConvectCountTave, ConvectCount, Nr,
-      I                              deltaTclock, bi, bj, myThid)
-           ENDIF
          ENDIF
  #endif /* ALLOW_TIMEAVE */
         ENDDO
        ENDDO
- #ifndef EXCLUDE_DEBUGMODE
+ #ifndef DISABLE_DEBUGMODE
        If (debugMode) THEN
         CALL DEBUG_STATS_RL(1,EtaN,'EtaN (DYNAMICS)',myThid)
         CALL DEBUG_STATS_RL(Nr,uVel,'Uvel (DYNAMICS)',myThid)

 Legend:



Removed from v.1.75
 


changed lines


 
Added in v.1.88
 Legend:



Removed from v.1.75
 


changed lines


 
Added in v.1.88
-Removed from v.1.75
+Added in v.1.88

	ViewVC Help
Powered by ViewVC 1.1.22