model/inc/DYNVARS.h

C $Header: /u/gcmpack/MITgcm/model/inc/DYNVARS.h,v 1.19 2002/11/29 13:38:37 heimbach 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
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 prvious time levels.
C     uVelD  - D grid zonal velocity
C     vVelD  - D grid meridional velocity
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 ;

      COMMON /DYNVARS_R/
     &                   etaN, etaH,
     &                   uVel,vVel,wVel,theta,salt,
     &                   gu,gv,gt,gs,guNm1,gvNm1,gtNm1,gsNm1
      _RL  etaN  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RL  etaH  (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)
      _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)

#ifdef INCLUDE_CD_CODE
      COMMON /DYNVARS_CD/ 
     &                   uVelD, vVelD,
     &                   etaNm1,
     &                   uNM1,  vNM1,
     &                   guCD, gvCD
      _RL  uVeld (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL  vVeld (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL  etaNm1(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RL  uNm1  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL  vNm1  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL  guCD  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL  gvCD  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
#endif

#ifdef ALLOW_NONHYDROSTATIC
      COMMON /DYNVARS_NH/ phi_nh
      _RL  phi_nh(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
#endif /* ALLOW_NONHYDROSTATIC */

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_TAMC) && defined (ALLOW_DIFFKR_CONTROL))
      COMMON /DYNVARS_DIFFKR/
     &                       diffKr
      _RL  diffKr (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
#endif
#if (defined (ALLOW_AUTODIFF_TAMC) && 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_TAMC) && defined (ALLOW_BOTTOMDRAG_CONTROL))
      COMMON /DYNVARS_BOTTOMDRAG/
     &                       bottomdragfld
      _RL  bottomdragfld (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
#endif
cph
cph)

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)
      COMMON /DYNVARS_DIAG/ phiHydLow, totPhiHyd
      _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)
1	C $Header: /u/gcmpack/MITgcm/model/inc/DYNVARS.h,v 1.19 2002/11/29 13:38:37 heimbach Exp $
2	C $Name: $
3	CBOP
4	C !ROUTINE: DYNVARS.h
5	C !INTERFACE:
6	C include "DYNVARS.h"
7	C !DESCRIPTION:
8	C \bv
9	C ==========================================================
10	C \| DYNVARS.h
11	C \| o Dynamical model variables (common block DYNVARS_R)
12	C ==========================================================
13	C \| The value and two levels of time tendency are held for
14	C \| each prognostic variable.
15	C ==========================================================
16	C \ev
17	CEOP
18	C
19	C etaN - free-surface r-anomaly (r unit) at current time level
20	C uVel - zonal velocity (m/s, i=1 held at western face)
21	C vVel - meridional velocity (m/s, j=1 held at southern face)
22	C theta - potential temperature (oC, held at pressure/tracer point)
23	C salt - salinity (ppt, held at pressure/tracer point)
24	C gX, gXNM1 - Time tendencies at current and prvious time levels.
25	C uVelD - D grid zonal velocity
26	C vVelD - D grid meridional velocity
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)
30	C note: a) used with "exactConserv" but strictly necessary for NonLinFreeSurf
31	C b) same as etaN but not necessarely at the same time, e.g.:
32	C implicDiv2DFlow=0 => etaH=etaN ; =1 => etaH=etaNm1 ;
33
34	COMMON /DYNVARS_R/
35	& etaN, etaH,
36	& uVel,vVel,wVel,theta,salt,
37	& gu,gv,gt,gs,guNm1,gvNm1,gtNm1,gsNm1
38	_RL etaN (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
39	_RL etaH (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
40	_RL uVel (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
41	_RL vVel (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
42	_RL wVel (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
43	_RL theta(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
44	_RL salt (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
45	_RL gu(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
46	_RL gv(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
47	_RL gt(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
48	_RL gs(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
49	_RL guNm1(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
50	_RL gvNm1(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
51	_RL gtNm1(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
52	_RL gsNm1(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
53
54	#ifdef INCLUDE_CD_CODE
55	COMMON /DYNVARS_CD/
56	& uVelD, vVelD,
57	& etaNm1,
58	& uNM1, vNM1,
59	& guCD, gvCD
60	_RL uVeld (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
61	_RL vVeld (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
62	_RL etaNm1(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
63	_RL uNm1 (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
64	_RL vNm1 (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
65	_RL guCD (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
66	_RL gvCD (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
67	#endif
68
69	#ifdef ALLOW_NONHYDROSTATIC
70	COMMON /DYNVARS_NH/ phi_nh
71	_RL phi_nh(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
72	#endif /* ALLOW_NONHYDROSTATIC */
73
74	cph(
75	cph the following block will eventually move to a separate
76	cph header file containing requires anomaly fields of control vars.
77	cph
78	#if (defined (ALLOW_AUTODIFF_TAMC) && defined (ALLOW_DIFFKR_CONTROL))
79	COMMON /DYNVARS_DIFFKR/
80	& diffKr
81	_RL diffKr (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
82	#endif
83	#if (defined (ALLOW_AUTODIFF_TAMC) && defined (ALLOW_KAPGM_CONTROL))
84	COMMON /DYNVARS_KAPGM/
85	& kapgm
86	_RL kapgm (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
87	#endif
88	#if (defined (ALLOW_AUTODIFF_TAMC) && defined (ALLOW_BOTTOMDRAG_CONTROL))
89	COMMON /DYNVARS_BOTTOMDRAG/
90	& bottomdragfld
91	_RL bottomdragfld (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
92	#endif
93	cph
94	cph)
95
96	C diagnostic variables:
97	C phiHydLow :: Phi-Hydrostatic at r-lower boundary
98	C (bottom in z-coordinates, top in p-coordinates)
99	C totPhiHyd :: total hydrostatic Potential (anomaly, for now),
100	C at cell center level ; includes surface contribution.
101	C (for diagnostic + used in Z-coord with EOS_funct_P)
102	COMMON /DYNVARS_DIAG/ phiHydLow, totPhiHyd
103	_RL phiHydLow(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
104	_RL totPhiHyd(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)