C $Header: /u/gcmpack/MITgcm/model/inc/DYNVARS.h,v 1.41 2010/02/17 23:39:35 gforget Exp $
C $Name: $
CBOP
C !ROUTINE: DYNVARS.h
C !INTERFACE:
C include "DYNVARS.h"
C !DESCRIPTION:
C \bv
C *==========================================================*
C | DYNVARS.h
C | o Dynamical model variables (common block DYNVARS_R)
C *==========================================================*
C | The value and two levels of time tendency are held for
C | each prognostic variable.
C *==========================================================*
C \ev
CEOP
C State Variables:
C etaN :: free-surface r-anomaly (r unit) at current time level
C uVel :: zonal velocity (m/s, i=1 held at western face)
C vVel :: meridional velocity (m/s, j=1 held at southern face)
C theta :: potential temperature (oC, held at pressure/tracer point)
C salt :: salinity (ppt, held at pressure/tracer point)
C gX, gxNm1 :: Time tendencies at current and previous time levels.
C etaH :: surface r-anomaly, advanced in time consistently
C with 2.D flow divergence (Exact-Conservation):
C etaH^n+1 = etaH^n - delta_t*Div.(H^n U^n)
C note: a) used with "exactConserv" but strictly necessary for NonLinFreeSurf
C b) same as etaN but not necessarely at the same time, e.g.:
C implicDiv2DFlow=0 => etaH=etaN ; =1 => etaH=etaNm1 ;
#ifdef ALLOW_ADAMSBASHFORTH_3
COMMON /DYNVARS_R/
& etaN,
& uVel,vVel,wVel,theta,salt,
& gU, gV, gT, gS,
& guNm, gvNm, gtNm, gsNm
#else /* ALLOW_ADAMSBASHFORTH_3 */
COMMON /DYNVARS_R/
& etaN,
& uVel,vVel,wVel,theta,salt,
& gU, gV, gT, gS,
& guNm1,gvNm1,gtNm1,gsNm1
#endif /* ALLOW_ADAMSBASHFORTH_3 */
_RL etaN (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
_RL uVel (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
_RL vVel (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
_RL wVel (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
_RL theta(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
_RL salt (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
_RL gU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
_RL gV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
_RL gT(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
_RL gS(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
#ifdef ALLOW_ADAMSBASHFORTH_3
_RL guNm(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy,2)
_RL gvNm(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy,2)
_RL gtNm(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy,2)
_RL gsNm(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy,2)
#else /* ALLOW_ADAMSBASHFORTH_3 */
_RL guNm1(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
_RL gvNm1(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
_RL gtNm1(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
_RL gsNm1(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
#endif /* ALLOW_ADAMSBASHFORTH_3 */
COMMON /DYNVARS_R_2/
& etaH
_RL etaH (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
#ifdef ALLOW_3D_DIFFKR
C diffKr :: full 3D specification of Laplacian diffusion coeff.
C for mixing of tracers vertically ( units of r^2/s )
COMMON /DYNVARS_DIFFKR/
& diffKr
_RL diffKr (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
#endif
cph(
cph the following block will eventually move to a separate
cph header file containing requires anomaly fields of control vars.
cph
#if (defined (ALLOW_AUTODIFF) defined (ALLOW_KAPGM_CONTROL))
COMMON /DYNVARS_KAPGM/
& kapgm
_RL kapgm (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
#endif
#if (defined (ALLOW_AUTODIFF) defined (ALLOW_KAPREDI_CONTROL))
COMMON /DYNVARS_KAPREDI/
& kapredi
_RL kapredi (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
#endif
#if (defined (ALLOW_AUTODIFF) defined (ALLOW_BOTTOMDRAG_CONTROL))
COMMON /DYNVARS_BOTTOMDRAG/
& bottomdragfld
_RL bottomdragfld (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
#endif
cph
cph)
#ifdef ALLOW_BL79_LAT_VARY
C BL79LatArray :: is used for latitudinal dependence of
C BryanLewis79 vertical diffusivity
COMMON /DYNVARS_BL79LatArray/ BL79LatArray
_RL BL79LatArray (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
#endif
#ifdef ALLOW_ADDFLUID
C addMass :: source (<0: sink) of fluid in the domain interior
C in mass per unit of time [kg/s]
C (generalisation of oceanic real fresh-water flux)
COMMON /DYNVARS_ADD_FLUID/ addMass
_RL addMass(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
#endif
C Diagnostic Variables:
C phiHydLow :: Phi-Hydrostatic at r-lower boundary
C (bottom in z-coordinates, top in p-coordinates)
C totPhiHyd :: total hydrostatic Potential (anomaly, for now),
C at cell center level ; includes surface contribution.
C (for diagnostic + used in Z-coord with EOS_funct_P)
C rhoInSitu :: In-Situ density anomaly [kg/m^3] at cell center level.
C hMixLayer :: Mixed layer depth [m]
C (for diagnostic + used GMRedi "fm07")
C IVDConvCount :: Impl.Vert.Diffusion convection counter:
C = 0 (not convecting) or 1 (convecting)
COMMON /DYNVARS_DIAG/
& phiHydLow, totPhiHyd,
& rhoInSitu,
& hMixLayer, IVDConvCount
_RL phiHydLow(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
_RL totPhiHyd(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
_RL rhoInSitu(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
_RL hMixLayer(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
_RL IVDConvCount(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)