/[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.77 by heimbach,
Mon Aug 13 23:26:56 2001 UTC
+revision 1.83.2.1 by adcroft,
Tue Feb 26 16:04:47 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 44 
 C     == Global variables ===
+Line 87 
 C     == Global variables ===
  #  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 124 
 C     myThid - Thread number for this in
        INTEGER myIter
        INTEGER myThid
+ C     !LOCAL VARIABLES:
  C     == Local variables
  C     fVer[STUV]               o fVer: Vertical flux term - note fVer
  C                                      is "pipelined" in the vertical
-Line 76 
 C     bi, bj
+Line 144 
 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.
        _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 89 
 C     tauAB - Adams-Bashforth timesteppi
+Line 156 
 C     tauAB - Adams-Bashforth timesteppi
        _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
-Line 149 
 C         salt* = salt[n] + dt x ( 3/2 G
+Line 212 
 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
-Line 159 
 C     uninitialised but inert locations.
+Line 223 
 C     uninitialised but inert locations.
         DO i=1-OLx,sNx+OLx
          DO k=1,Nr
           phiHyd(i,j,k)  = 0. _d 0
- cph         KappaRU(i,j,k) = 0. _d 0
+          KappaRU(i,j,k) = 0. _d 0
- cph         KappaRV(i,j,k) = 0. _d 0
+          KappaRV(i,j,k) = 0. _d 0
           sigmaX(i,j,k) = 0. _d 0
           sigmaY(i,j,k) = 0. _d 0
           sigmaR(i,j,k) = 0. _d 0
-Line 192 
 CHPF$&                  )
+Line 256 
 CHPF$&                  )
  #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
-Line 223 
 C--     Start computation of dynamics
+Line 283 
 C--     Start computation of dynamics
          jMax = sNy+OLy-1
  #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
  CADJ STORE wvel (:,:,:,bi,bj) = comlev1_bibj, key = ikey, byte = isbyte
  #endif /* ALLOW_AUTODIFF_TAMC */
-Line 238 
 C       (note: this loop will be replace
+Line 296 
 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
-Line 270 
 C        distinguishe between Stagger an
+Line 337 
 C        distinguishe between Stagger an
           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 284 
 C        distinguishe between Stagger an
+Line 351 
 C        distinguishe between Stagger an
  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, myThid)
+      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, myIter, myThid)
+ #endif
             CALL TIMESTEP(
       I         bi,bj,iMin,iMax,jMin,jMax,k,
       I         phiHyd, phiSurfX, phiSurfY,
-Line 385 
 Cjmc(end)
+Line 461 
 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.77
 


changed lines


 
Added in v.1.83.2.1
 Legend:



Removed from v.1.77
 


changed lines


 
Added in v.1.83.2.1
-Removed from v.1.77
+Added in v.1.83.2.1

	ViewVC Help
Powered by ViewVC 1.1.22