model/inc/DYNVARS.h

C $Header: /u/gcmpack/MITgcm/model/inc/DYNVARS.h,v 1.46 2013/09/18 01:39:01 m_bates 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+1)
C  note: a) used with "exactConserv", necessary for Non-Lin free-surf and mixed
C           forward/backward free-surf time stepping (e.g., Crank-Nickelson)
C        b) same as etaN but not necessarily at the same time, e.g.:
C           implicDiv2DFlow=1 => etaH=etaN ; =0 => etaH=etaN^(n-1);

#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)

#if (defined (ALLOW_3D_DIFFKR) || defined (ALLOW_DIFFKR_CONTROL))
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

C   The following blocks containing requires anomaly fields of control vars
C   and related to Options: 
C   ALLOW_KAPGM_CONTROL , ALLOW_KAPREDI_CONTROL and ALLOW_BOTTOMDRAG_CONTROL
C   have been moved to header file "CTRL_FIELDS.h"

#ifdef ALLOW_EDDYPSI
C     uMean    :: The mean zonal velocity (residual velocity less the bolus velocity)
C     vMean    :: The mean meridional velocity (residual velocity less the bolus velocity)
C     tauxEddy :: The eddy stress used in the momentum equation of a residual model
C     tauyEddy :: The eddy stress used in the momentum equation of a residual model

      COMMON /DYNVARS_EDDYPSI/ tauxEddy,tauyEddy, uMean, vMean

      _RL uMean(   1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL vMean(   1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL tauxEddy(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL tauyEddy(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
#endif

#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

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)

1	C $Header: /u/gcmpack/MITgcm/model/inc/DYNVARS.h,v 1.46 2013/09/18 01:39:01 m_bates Exp $
2	C $Name: $
3
4	CBOP
5	C !ROUTINE: DYNVARS.h
6	C !INTERFACE:
7	C include "DYNVARS.h"
8	C !DESCRIPTION:
9	C \bv
10	C ==========================================================
11	C \| DYNVARS.h
12	C \| o Dynamical model variables (common block DYNVARS_R)
13	C ==========================================================
14	C \| The value and two levels of time tendency are held for
15	C \| each prognostic variable.
16	C ==========================================================
17	C \ev
18	CEOP
19
20	C State Variables:
21	C etaN :: free-surface r-anomaly (r unit) at current time level
22	C uVel :: zonal velocity (m/s, i=1 held at western face)
23	C vVel :: meridional velocity (m/s, j=1 held at southern face)
24	C theta :: potential temperature (oC, held at pressure/tracer point)
25	C salt :: salinity (ppt, held at pressure/tracer point)
26	C gX, gxNm1 :: Time tendencies at current and previous time levels.
27	C etaH :: surface r-anomaly, advanced in time consistently
28	C with 2.D flow divergence (Exact-Conservation):
29	C etaH^n+1 = etaH^n - delta_t*Div.(H^n U^n+1)
30	C note: a) used with "exactConserv", necessary for Non-Lin free-surf and mixed
31	C forward/backward free-surf time stepping (e.g., Crank-Nickelson)
32	C b) same as etaN but not necessarily at the same time, e.g.:
33	C implicDiv2DFlow=1 => etaH=etaN ; =0 => etaH=etaN^(n-1);
34
35	#ifdef ALLOW_ADAMSBASHFORTH_3
36	COMMON /DYNVARS_R/
37	& etaN,
38	& uVel,vVel,wVel,theta,salt,
39	& gU, gV, gT, gS,
40	& guNm, gvNm, gtNm, gsNm
41	#else /* ALLOW_ADAMSBASHFORTH_3 */
42	COMMON /DYNVARS_R/
43	& etaN,
44	& uVel,vVel,wVel,theta,salt,
45	& gU, gV, gT, gS,
46	& guNm1,gvNm1,gtNm1,gsNm1
47	#endif /* ALLOW_ADAMSBASHFORTH_3 */
48	_RL etaN (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
49	_RL uVel (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
50	_RL vVel (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
51	_RL wVel (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
52	_RL theta(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
53	_RL salt (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
54	_RL gU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
55	_RL gV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
56	_RL gT(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
57	_RL gS(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
58	#ifdef ALLOW_ADAMSBASHFORTH_3
59	_RL guNm(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy,2)
60	_RL gvNm(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy,2)
61	_RL gtNm(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy,2)
62	_RL gsNm(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy,2)
63	#else /* ALLOW_ADAMSBASHFORTH_3 */
64	_RL guNm1(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
65	_RL gvNm1(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
66	_RL gtNm1(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
67	_RL gsNm1(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
68	#endif /* ALLOW_ADAMSBASHFORTH_3 */
69
70	COMMON /DYNVARS_R_2/
71	& etaH
72	_RL etaH (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
73
74	#if (defined (ALLOW_3D_DIFFKR) \|\| defined (ALLOW_DIFFKR_CONTROL))
75	C diffKr :: full 3D specification of Laplacian diffusion coeff.
76	C for mixing of tracers vertically ( units of r^2/s )
77	COMMON /DYNVARS_DIFFKR/
78	& diffKr
79	_RL diffKr (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
80	#endif
81
82	C The following blocks containing requires anomaly fields of control vars
83	C and related to Options:
84	C ALLOW_KAPGM_CONTROL , ALLOW_KAPREDI_CONTROL and ALLOW_BOTTOMDRAG_CONTROL
85	C have been moved to header file "CTRL_FIELDS.h"
86
87	#ifdef ALLOW_EDDYPSI
88	C uMean :: The mean zonal velocity (residual velocity less the bolus velocity)
89	C vMean :: The mean meridional velocity (residual velocity less the bolus velocity)
90	C tauxEddy :: The eddy stress used in the momentum equation of a residual model
91	C tauyEddy :: The eddy stress used in the momentum equation of a residual model
92
93	COMMON /DYNVARS_EDDYPSI/ tauxEddy,tauyEddy, uMean, vMean
94
95	_RL uMean( 1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
96	_RL vMean( 1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
97	_RL tauxEddy(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
98	_RL tauyEddy(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
99	#endif
100
101	#ifdef ALLOW_BL79_LAT_VARY
102	C BL79LatArray :: is used for latitudinal dependence of
103	C BryanLewis79 vertical diffusivity
104	COMMON /DYNVARS_BL79LatArray/ BL79LatArray
105	_RL BL79LatArray (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
106	#endif
107
108	C Diagnostic Variables:
109	C phiHydLow :: Phi-Hydrostatic at r-lower boundary
110	C (bottom in z-coordinates, top in p-coordinates)
111	C totPhiHyd :: total hydrostatic Potential (anomaly, for now),
112	C at cell center level ; includes surface contribution.
113	C (for diagnostic + used in Z-coord with EOS_funct_P)
114	C rhoInSitu :: In-Situ density anomaly [kg/m^3] at cell center level.
115	C hMixLayer :: Mixed layer depth [m]
116	C (for diagnostic + used GMRedi "fm07")
117	C IVDConvCount :: Impl.Vert.Diffusion convection counter:
118	C = 0 (not convecting) or 1 (convecting)
119	COMMON /DYNVARS_DIAG/
120	& phiHydLow, totPhiHyd,
121	& rhoInSitu,
122	& hMixLayer, IVDConvCount
123	_RL phiHydLow(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
124	_RL totPhiHyd(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
125	_RL rhoInSitu(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
126	_RL hMixLayer(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
127	_RL IVDConvCount(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
128