pkg/seaice/SEAICE.h

C $Header: /u/gcmpack/MITgcm/pkg/seaice/SEAICE.h,v 1.31 2007/05/09 14:31:46 mlosch Exp $
C $Name:  $

CBOP
C !ROUTINE: SEAICE.h

C !DESCRIPTION: \bv
C     /==========================================================\
C     | SEAICE.h                                                 |
C     | o Basic header for sea ice model.                        |
C     |   Contains most sea ice field declarations.              |
C     \==========================================================/
C
C     UICE  - zonal ice velocity in m/s at South-West B-grid 
C             (or C-grid #ifdef SEAICE_CGRID) U point
C             >0 from West to East
C     UICEC - average of UICE(1) between last two time steps
C     VICE  - meridional ice velocity in m/s at South-West B-grid
C             (or C-grid #ifdef SEAICE_CGRID) V point
C             >0 from South to North
C             note: the South-West B-grid U and V points are on
C                the lower, left-hand corner of each grid cell
C     VICEC - average of VICE(1) between last two time steps
C     AREA  - fractional ice-covered area in m^2/m^2
C             at center of grid, i.e., tracer point
C             0 is no cover, 1 is 100% cover
C     HEFF  - effective ice thickness in m
C             at center of grid, i.e., tracer point
C             note: for non-zero AREA, actual ice
C                thickness is HEFF / AREA
C     HSNOW - effective snow thickness in m
C             at center of grid, i.e., tracer point
C             note: for non-zero AREA, actual snow
C                thickness is HEFF / AREA
C \ev
CEOP
      COMMON/SEAICE_DYNVARS_1/AREA
      _RL AREA       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,3,nSx,nSy)

      COMMON/SEAICE_DYNVARS_2/UICE,VICE
      _RL UICE       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,3,nSx,nSy)
      _RL VICE       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,3,nSx,nSy)

      COMMON/SEAICE_DYNVARS_3/
     &     ETA,ZETA,DRAGS,DRAGA,FORCEX,FORCEY,UICEC,VICEC
      _RL ETA        (1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)
      _RL ZETA       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)
      _RL DRAGS      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)
      _RL DRAGA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)
      _RL FORCEX     (1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)
      _RL FORCEY     (1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)
      _RL UICEC      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)
      _RL VICEC      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)

#ifndef SEAICE_CGRID
      COMMON/SEAICE_DYNVARS_BGRID/ AMASS, DAIRN
      _RL AMASS      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)
      _RL DAIRN      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)
#else 
      COMMON/SEAICE_DYNVARS_CGRID/
     &     seaiceMassC, seaiceMassU, seaiceMassV
      _RL seaiceMassC(1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)
      _RL seaiceMassU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)
      _RL seaiceMassV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)
#endif

      COMMON/SEAICE_DYNVARS_4/
     &     DWATN, PRESS0, FORCEX0, FORCEY0, ZMAX, ZMIN
      _RL DWATN      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)
      _RL PRESS0     (1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)
      _RL FORCEX0    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)
      _RL FORCEY0    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)
      _RL ZMAX       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)
      _RL ZMIN       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)

      COMMON/SEAICE_TRANS/HEFF,HSNOW
      _RL HEFF       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,3,nSx,nSy)
      _RL HSNOW      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)

      COMMON/ARRAY/HEFFM
      _RL HEFFM      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)
#ifdef SEAICE_CGRID
      COMMON/ARRAYC/ seaiceMaskU, seaiceMaskV
      _RL seaiceMaskU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)
      _RL seaiceMaskV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)
#else
      COMMON/ARRAYB/ UVM
      _RL UVM        (1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)
#endif /* SEAICE_CGRID */
      COMMON/OFL/YNEG
      COMMON/RIV/RIVER
      _RL YNEG       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)
      _RL RIVER      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)

#ifdef SEAICE_MULTICATEGORY
      INTEGER MULTDIM
      PARAMETER (MULTDIM=7)
      COMMON/MULTICATEGORY/TICES
      _RL TICES      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,MULTDIM,nSx,nSy)
#endif

#if (defined (SEAICE_CGRID) && defined (SEAICE_ALLOW_EVP))
C
C     additional fields needed by the EVP solver
C
C     seaice_sigma1  - sigma11+sigma22, defined at C-points
C     seaice_sigma2  - sigma11-sigma22, defined at C-points
C     seaice_sigma12 - off-diagonal term, defined at Z-points
C     stressDivergenceX/Y - divergence of stress tensor
      COMMON /SEAICE_EVP_FIELDS/
     &     stressDivergenceX, stressDivergenceY,
     &     seaice_sigma1, seaice_sigma2, seaice_sigma12
      _RL stressDivergenceX(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RL stressDivergenceY(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RL seaice_sigma1    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RL seaice_sigma2    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RL seaice_sigma12   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
#endif /* SEAICE_ALLOW_EVP and SEAICE_CGRID */

      COMMON/MIX/TMIX,TICE
      _RL TMIX       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RL TICE       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)

      COMMON/GWATXY/GWATX,GWATY
      _RL GWATX      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RL GWATY      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)

      COMMON/WIND_STRESS_ICE/TAUX,TAUY
C     TAUX   - zonal      wind stress over ice at U point
C     TAUY   - meridional wind stress over ice at V point
      _RL TAUX       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RL TAUY       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)

#ifndef SEAICE_CGRID
      COMMON/WIND_STRESS_OCE/WINDX,WINDY
C     WINDX  - zonal      wind stress over water at C points
C     WINDY  - meridional wind stress over water at C points
      _RL WINDX      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RL WINDY      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
#endif

c     COMMON/COUNT/ICOUNT
c     COMMON/DAY/IDELT
c     INTEGER ICOUNT, IDELT

C--   KGEO    Level used as a proxy for geostrophic velocity.
      COMMON/SEAICE_KGEO/KGEO
      integer KGEO   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,  nSx,nSy)

#ifdef ALLOW_AUTODIFF_TAMC
      integer iicekey
      integer nEVPstepMax
      parameter ( nEVPstepMax=60 )
#endif

CEH3 ;;; Local Variables: ***
CEH3 ;;; mode:fortran ***
CEH3 ;;; End: ***
1	C $Header: /u/gcmpack/MITgcm/pkg/seaice/SEAICE.h,v 1.31 2007/05/09 14:31:46 mlosch Exp $
2	C $Name: $
3
4	CBOP
5	C !ROUTINE: SEAICE.h
6
7	C !DESCRIPTION: \bv
8	C /==========================================================\
9	C \| SEAICE.h \|
10	C \| o Basic header for sea ice model. \|
11	C \| Contains most sea ice field declarations. \|
12	C \==========================================================/
13	C
14	C UICE - zonal ice velocity in m/s at South-West B-grid
15	C (or C-grid #ifdef SEAICE_CGRID) U point
16	C >0 from West to East
17	C UICEC - average of UICE(1) between last two time steps
18	C VICE - meridional ice velocity in m/s at South-West B-grid
19	C (or C-grid #ifdef SEAICE_CGRID) V point
20	C >0 from South to North
21	C note: the South-West B-grid U and V points are on
22	C the lower, left-hand corner of each grid cell
23	C VICEC - average of VICE(1) between last two time steps
24	C AREA - fractional ice-covered area in m^2/m^2
25	C at center of grid, i.e., tracer point
26	C 0 is no cover, 1 is 100% cover
27	C HEFF - effective ice thickness in m
28	C at center of grid, i.e., tracer point
29	C note: for non-zero AREA, actual ice
30	C thickness is HEFF / AREA
31	C HSNOW - effective snow thickness in m
32	C at center of grid, i.e., tracer point
33	C note: for non-zero AREA, actual snow
34	C thickness is HEFF / AREA
35	C \ev
36	CEOP
37	COMMON/SEAICE_DYNVARS_1/AREA
38	_RL AREA (1-OLx:sNx+OLx,1-OLy:sNy+OLy,3,nSx,nSy)
39
40	COMMON/SEAICE_DYNVARS_2/UICE,VICE
41	_RL UICE (1-OLx:sNx+OLx,1-OLy:sNy+OLy,3,nSx,nSy)
42	_RL VICE (1-OLx:sNx+OLx,1-OLy:sNy+OLy,3,nSx,nSy)
43
44	COMMON/SEAICE_DYNVARS_3/
45	& ETA,ZETA,DRAGS,DRAGA,FORCEX,FORCEY,UICEC,VICEC
46	_RL ETA (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
47	_RL ZETA (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
48	_RL DRAGS (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
49	_RL DRAGA (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
50	_RL FORCEX (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
51	_RL FORCEY (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
52	_RL UICEC (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
53	_RL VICEC (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
54
55	#ifndef SEAICE_CGRID
56	COMMON/SEAICE_DYNVARS_BGRID/ AMASS, DAIRN
57	_RL AMASS (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
58	_RL DAIRN (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
59	#else
60	COMMON/SEAICE_DYNVARS_CGRID/
61	& seaiceMassC, seaiceMassU, seaiceMassV
62	_RL seaiceMassC(1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
63	_RL seaiceMassU(1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
64	_RL seaiceMassV(1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
65	#endif
66
67	COMMON/SEAICE_DYNVARS_4/
68	& DWATN, PRESS0, FORCEX0, FORCEY0, ZMAX, ZMIN
69	_RL DWATN (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
70	_RL PRESS0 (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
71	_RL FORCEX0 (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
72	_RL FORCEY0 (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
73	_RL ZMAX (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
74	_RL ZMIN (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
75
76	COMMON/SEAICE_TRANS/HEFF,HSNOW
77	_RL HEFF (1-OLx:sNx+OLx,1-OLy:sNy+OLy,3,nSx,nSy)
78	_RL HSNOW (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
79
80	COMMON/ARRAY/HEFFM
81	_RL HEFFM (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
82	#ifdef SEAICE_CGRID
83	COMMON/ARRAYC/ seaiceMaskU, seaiceMaskV
84	_RL seaiceMaskU(1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
85	_RL seaiceMaskV(1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
86	#else
87	COMMON/ARRAYB/ UVM
88	_RL UVM (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
89	#endif /* SEAICE_CGRID */
90	COMMON/OFL/YNEG
91	COMMON/RIV/RIVER
92	_RL YNEG (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
93	_RL RIVER (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
94
95	#ifdef SEAICE_MULTICATEGORY
96	INTEGER MULTDIM
97	PARAMETER (MULTDIM=7)
98	COMMON/MULTICATEGORY/TICES
99	_RL TICES (1-OLx:sNx+OLx,1-OLy:sNy+OLy,MULTDIM,nSx,nSy)
100	#endif
101
102	#if (defined (SEAICE_CGRID) && defined (SEAICE_ALLOW_EVP))
103	C
104	C additional fields needed by the EVP solver
105	C
106	C seaice_sigma1 - sigma11+sigma22, defined at C-points
107	C seaice_sigma2 - sigma11-sigma22, defined at C-points
108	C seaice_sigma12 - off-diagonal term, defined at Z-points
109	C stressDivergenceX/Y - divergence of stress tensor
110	COMMON /SEAICE_EVP_FIELDS/
111	& stressDivergenceX, stressDivergenceY,
112	& seaice_sigma1, seaice_sigma2, seaice_sigma12
113	_RL stressDivergenceX(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
114	_RL stressDivergenceY(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
115	_RL seaice_sigma1 (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
116	_RL seaice_sigma2 (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
117	_RL seaice_sigma12 (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
118	#endif /* SEAICE_ALLOW_EVP and SEAICE_CGRID */
119
120	COMMON/MIX/TMIX,TICE
121	_RL TMIX (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
122	_RL TICE (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
123
124	COMMON/GWATXY/GWATX,GWATY
125	_RL GWATX (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
126	_RL GWATY (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
127
128	COMMON/WIND_STRESS_ICE/TAUX,TAUY
129	C TAUX - zonal wind stress over ice at U point
130	C TAUY - meridional wind stress over ice at V point
131	_RL TAUX (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
132	_RL TAUY (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
133
134	#ifndef SEAICE_CGRID
135	COMMON/WIND_STRESS_OCE/WINDX,WINDY
136	C WINDX - zonal wind stress over water at C points
137	C WINDY - meridional wind stress over water at C points
138	_RL WINDX (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
139	_RL WINDY (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
140	#endif
141
142	c COMMON/COUNT/ICOUNT
143	c COMMON/DAY/IDELT
144	c INTEGER ICOUNT, IDELT
145
146	C-- KGEO Level used as a proxy for geostrophic velocity.
147	COMMON/SEAICE_KGEO/KGEO
148	integer KGEO (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
149
150	#ifdef ALLOW_AUTODIFF_TAMC
151	integer iicekey
152	integer nEVPstepMax
153	parameter ( nEVPstepMax=60 )
154	#endif
155
156	CEH3 ;;; Local Variables: ***
157	CEH3 ;;; mode:fortran ***
158	CEH3 ;;; End: ***