pkg/timeave/TIMEAVE_STATV.h

C $Header: /usr/local/gcmpack/MITgcm/pkg/timeave/TIMEAVE_STATV.h,v 1.11 2003/11/13 06:35:15 dimitri Exp $
C $Name:  $

#include "TIMEAVE_OPTIONS.h"

#ifdef ALLOW_TIMEAVE

CBOP
C     !ROUTINE: TIMEAVE_STATV.h
C     !INTERFACE:
C     include "TIMEAVE_STATV.h"
C     !DESCRIPTION: \bw
C     *================================================================*
C     | TIMEAVE_STATV.h
C     | o Time averages of model state-variables 
C     |   (common block TAVE_STATEVARS)
C     *================================================================*
C     | Time average of state variables is (generally) centered on the
C     |  middle of the time step (time average interval = TimeAve_half)
C     | Time average of intermediate and tendency variables is centered 
C     |  on the time step (time average interval=TimeAve_full)
C     *================================================================*
C     \ev
CEOP

C     TimeAve_*    :: time of temporal integration (s) *** for each thread ***
C     TimeAve_half :: half time_step multiple (used for state variables)
C     TimeAve_full :: full time_step multiple (used for for intermediate var.) 
C     uFluxtave    :: zonal surface wind stress (N/m^2,
C                     >0 for increase in uVel, i=1 held at western face)
C     vFluxtave    :: meridional surface wind stress (N/m^2,
C                     >0 for increase in vVel, j=1 held at southern face)
C     tFluxtave    :: net surface heat flux (W/m^2, >0 for increase in theta)
C     sFluxtave    :: net surface salt flux (g/m^2/s, >0 for increase in salt)
C     etatave      :: surface displacement (r unit, i.e. ocean:z, atmos:p)
C     uVeltave     :: zonal velocity (m/s, i=1 held at western face)
C     vVeltave     :: meridional velocity (m/s, j=1 held at southern face)
C     wVeltave     :: vertical velocity ([r]/s, i.e.: ocean:m/s atmos:Pa/s)
C     thetatave    :: potential temperature (oC, held at pressure/tracer point)
C     salttave     :: salinity (ppt, held at pressure/tracer point)
C     Eta2tave     :: eta * eta
C     TTtave       :: theta * theta
C     UUtave       :: uVel * uVel (used to compute the averaged KE)
C     VVtave       :: vVel * vVel (used to compute the averaged KE)
C     UVtave       :: uVel * vVel (at vorticity point, i.e. grid-corner)
C     KEtave       :: Kinetic Energy
C     UTtave       :: uVel * theta (* hFacW)
C     VTtave       :: vVel * theta (* hFacS)
C     WTtave       :: wVel * theta
C     tDiffRtave   :: vertical diffusion flux of Temperature (theta)
C     uZetatave    :: uVel*Relativ_Vorticity_3 (computed at v point)
C     vZetatave    :: vVel*Relativ_Vorticity_3 (computed at u point)
C     phiHydtave   :: Hydrostatic (ocean) pressure / (atmos) geo- Potential
C     phiHydLowtave:: Hydrostatic (ocean) pressure / (atmos) geo- Potential
C                     at the fixed boundary: (ocean) bottom pressure
C                     (atmos) geo- Potential
C     ConvectCountTave :: Average number of convective adjustment event

      COMMON /TAVE_TIME/ TimeAve_half,TimeAve_full
      _RL TimeAve_half(Nr,nSx,nSy)
      _RL TimeAve_full(Nr,nSx,nSy)

      COMMON /TAVE_STATEVARS/
     &                  uFluxtave,vFluxtave,tFluxtave,sFluxtave
     &                 ,etatave,uVeltave,vVeltave,wVeltave
     &                 ,thetatave,salttave
     &                 ,UTtave,VTtave,WTtave
#ifndef HRCUBE
     &                 ,Eta2tave,TTtave,UUtave,VVtave,UVtave
     &                 ,TdiffRtave,phiHydtave
     &                 ,phiHydLowtave,phiHydLow2Tave
     &                 ,ConvectCountTave
c    &                 ,KEtave
#endif /* ndef HRCUBE */
      _RL  uFluxtave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RL  vFluxtave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RL  tFluxtave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RL  sFluxtave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RL  etatave  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RL  uVeltave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL  vVeltave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL  wVeltave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL  thetatave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL  salttave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL  UTtave   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL  VTtave   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL  WTtave   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
#ifndef HRCUBE
      _RL  eta2Tave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RL  TTtave   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL  UUtave   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL  VVtave   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL  UVtave   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
c     _RL  KEtave   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL TdiffRtave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
#ifdef ALLOW_MOM_VECINV
      _RL uZetatave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL vZetatave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
#endif /* ALLOW_MOM_VECINV */
      _RL phiHydtave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL phiHydLowtave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RL phiHydLow2Tave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RL ConvectCountTave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
#endif /* ndef HRCUBE */

#ifdef NONLIN_FRSURF
C     hUtave       :: average zonal flow (=hFacW*uVel) (still in m/s !)
C     hVtave       :: average merid.flow (=hFacS*vVel) (still in m/s !)
C     hFacCtave    :: average thickness fraction of open water, Center
C     hFacWtave    :: average thickness fraction of open water, West side
C     hFacStave    :: average thickness fraction of open water, South side

#ifndef HRCUBE
      COMMON /TAVE_THICKNESS/ 
     &              hUtave, hVtave
c    &            , hFacCtave, hFacWtave, hFacStave 
      _RL  hUtave   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL  hVtave   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
c     _RL  hFacCtave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
c     _RL  hFacWtave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
c     _RL  hFacStave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
#endif /* ndef HRCUBE */
#endif /* NONLIN_FRSURF */

#endif /* ALLOW_TIMEAVE */ 
1	C $Header: /usr/local/gcmpack/MITgcm/pkg/timeave/TIMEAVE_STATV.h,v 1.11 2003/11/13 06:35:15 dimitri Exp $
2	C $Name: $
3
4	#include "TIMEAVE_OPTIONS.h"
5
6	#ifdef ALLOW_TIMEAVE
7
8	CBOP
9	C !ROUTINE: TIMEAVE_STATV.h
10	C !INTERFACE:
11	C include "TIMEAVE_STATV.h"
12	C !DESCRIPTION: \bw
13	C ================================================================
14	C \| TIMEAVE_STATV.h
15	C \| o Time averages of model state-variables
16	C \| (common block TAVE_STATEVARS)
17	C ================================================================
18	C \| Time average of state variables is (generally) centered on the
19	C \| middle of the time step (time average interval = TimeAve_half)
20	C \| Time average of intermediate and tendency variables is centered
21	C \| on the time step (time average interval=TimeAve_full)
22	C ================================================================
23	C \ev
24	CEOP
25
26	C TimeAve_* :: time of temporal integration (s) * for each thread *
27	C TimeAve_half :: half time_step multiple (used for state variables)
28	C TimeAve_full :: full time_step multiple (used for for intermediate var.)
29	C uFluxtave :: zonal surface wind stress (N/m^2,
30	C >0 for increase in uVel, i=1 held at western face)
31	C vFluxtave :: meridional surface wind stress (N/m^2,
32	C >0 for increase in vVel, j=1 held at southern face)
33	C tFluxtave :: net surface heat flux (W/m^2, >0 for increase in theta)
34	C sFluxtave :: net surface salt flux (g/m^2/s, >0 for increase in salt)
35	C etatave :: surface displacement (r unit, i.e. ocean:z, atmos:p)
36	C uVeltave :: zonal velocity (m/s, i=1 held at western face)
37	C vVeltave :: meridional velocity (m/s, j=1 held at southern face)
38	C wVeltave :: vertical velocity ([r]/s, i.e.: ocean:m/s atmos:Pa/s)
39	C thetatave :: potential temperature (oC, held at pressure/tracer point)
40	C salttave :: salinity (ppt, held at pressure/tracer point)
41	C Eta2tave :: eta * eta
42	C TTtave :: theta * theta
43	C UUtave :: uVel * uVel (used to compute the averaged KE)
44	C VVtave :: vVel * vVel (used to compute the averaged KE)
45	C UVtave :: uVel * vVel (at vorticity point, i.e. grid-corner)
46	C KEtave :: Kinetic Energy
47	C UTtave :: uVel * theta (* hFacW)
48	C VTtave :: vVel * theta (* hFacS)
49	C WTtave :: wVel * theta
50	C tDiffRtave :: vertical diffusion flux of Temperature (theta)
51	C uZetatave :: uVel*Relativ_Vorticity_3 (computed at v point)
52	C vZetatave :: vVel*Relativ_Vorticity_3 (computed at u point)
53	C phiHydtave :: Hydrostatic (ocean) pressure / (atmos) geo- Potential
54	C phiHydLowtave:: Hydrostatic (ocean) pressure / (atmos) geo- Potential
55	C at the fixed boundary: (ocean) bottom pressure
56	C (atmos) geo- Potential
57	C ConvectCountTave :: Average number of convective adjustment event
58
59	COMMON /TAVE_TIME/ TimeAve_half,TimeAve_full
60	_RL TimeAve_half(Nr,nSx,nSy)
61	_RL TimeAve_full(Nr,nSx,nSy)
62
63	COMMON /TAVE_STATEVARS/
64	& uFluxtave,vFluxtave,tFluxtave,sFluxtave
65	& ,etatave,uVeltave,vVeltave,wVeltave
66	& ,thetatave,salttave
67	& ,UTtave,VTtave,WTtave
68	#ifndef HRCUBE
69	& ,Eta2tave,TTtave,UUtave,VVtave,UVtave
70	& ,TdiffRtave,phiHydtave
71	& ,phiHydLowtave,phiHydLow2Tave
72	& ,ConvectCountTave
73	c & ,KEtave
74	#endif /* ndef HRCUBE */
75	_RL uFluxtave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
76	_RL vFluxtave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
77	_RL tFluxtave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
78	_RL sFluxtave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
79	_RL etatave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
80	_RL uVeltave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
81	_RL vVeltave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
82	_RL wVeltave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
83	_RL thetatave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
84	_RL salttave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
85	_RL UTtave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
86	_RL VTtave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
87	_RL WTtave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
88	#ifndef HRCUBE
89	_RL eta2Tave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
90	_RL TTtave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
91	_RL UUtave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
92	_RL VVtave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
93	_RL UVtave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
94	c _RL KEtave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
95	_RL TdiffRtave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
96	#ifdef ALLOW_MOM_VECINV
97	_RL uZetatave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
98	_RL vZetatave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
99	#endif /* ALLOW_MOM_VECINV */
100	_RL phiHydtave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
101	_RL phiHydLowtave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
102	_RL phiHydLow2Tave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
103	_RL ConvectCountTave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
104	#endif /* ndef HRCUBE */
105
106	#ifdef NONLIN_FRSURF
107	C hUtave :: average zonal flow (=hFacW*uVel) (still in m/s !)
108	C hVtave :: average merid.flow (=hFacS*vVel) (still in m/s !)
109	C hFacCtave :: average thickness fraction of open water, Center
110	C hFacWtave :: average thickness fraction of open water, West side
111	C hFacStave :: average thickness fraction of open water, South side
112
113	#ifndef HRCUBE
114	COMMON /TAVE_THICKNESS/
115	& hUtave, hVtave
116	c & , hFacCtave, hFacWtave, hFacStave
117	_RL hUtave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
118	_RL hVtave (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
119	c _RL hFacCtave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
120	c _RL hFacWtave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
121	c _RL hFacStave(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
122	#endif /* ndef HRCUBE */
123	#endif /* NONLIN_FRSURF */
124
125	#endif /* ALLOW_TIMEAVE */