pkg/shelfice/SHELFICE.h

C $Header: /u/gcmpack/MITgcm/pkg/shelfice/SHELFICE.h,v 1.9 2011/06/29 16:24:10 heimbach Exp $
C $Name:  $

#ifdef ALLOW_SHELFICE

CBOP
C !ROUTINE: SHELFICE.h

C !DESCRIPTION: \bv
C     /==========================================================\
C     | SHELFICE.h                                               |
C     | o Basic header thermodnynamic shelf ice package.         |
C     |   Contains all SHELFICE field declarations.              |
C     \==========================================================/

C-----------------------------------------------------------------------
C
C--   Constants that can be set in data.shelfice
C     SHELFICEtopoFile         - File containing the topography of the 
C                                shelfice draught (unit=m)
C     SHELFICEloadAnomalyFile  - name of shelfice load anomaly file
C     SHELFICEDragLinear       - linear drag at bottom shelfice (1/s)
C     SHELFICEDragQuadratic    - quadratic drag at bottom shelfice (1/m)
C     SHELFICEheatTransCoeff   - heat transfer coefficient that determines
C                                 heat flux into shelfice (m/s)
C     SHELFICEsaltTransCoeff   - salinity transfer coefficient that determines
C                                salt flux into shelfice (m/s)
C     SHELFICElatentHeat       - latent heat of fusion (J/kg)
C     useISOMIPTD              - use simple ISOMIP thermodynamics
C     SHELFICEconserve         - use conservative form of H&O-thermodynamics 
C                                following Jenkins et al. (2001, JPO)
C     SHELFICEboundaryLayer    - turn on vertical merging of cells to for a 
C                                boundary layer of drF thickness
C     no_slip_shelfice         - set slip conditions for shelfice separately,
C                                (by default the same as no_slip_bottom) 
C     SHELFICEwriteState       - enable output
C     SHELFICE_dump_mnc        - use netcdf for snapshot output
C     SHELFICE_tave_mnc        - use netcdf for time-averaged output
C     SHELFICE_dumpFreq        - analoguous to dumpFreq (= default)
C     SHELFICE_taveFreq        - analoguous to taveFreq (= default)
C
C--   Fields
C     ktopC                  - index of the top "wet cell" (2D)
C     R_shelfIce             - shelfice topography [m]
C     shelficeLoadAnomaly    - pressure load anomaly of shelfice [Pa]
C     shelficeHeatFlux       - upward heat flux [W/m^2]
C     shelficeFreshWaterFlux - upward fresh water flux (virt. salt flux) [m/s]
C     shelficeForcingT       - analogue of surfaceForcingT
C                              units are  r_unit.Kelvin/s (=Kelvin.m/s if r=z)
C     shelficeForcingS       - analogue of surfaceForcingS
C                              units are  r_unit.psu/s (=psu.m/s if r=z)
C-----------------------------------------------------------------------
C \ev
CEOP

      COMMON /SHELFICE_PARMS_I/  kTopC
      INTEGER kTopC (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)

      COMMON /SHELFICE_PARMS_R/ 
     &     SHELFICE_dumpFreq, SHELFICE_taveFreq,
     &     SHELFICEheatTransCoeff, SHELFICEsaltTransCoeff,
     &     rhoShelfice, SHELFICEkappa,
     &     SHELFICElatentHeat, recip_SHELFICElatentHeat,
     &     SHELFICEheatCapacity_Cp,
     &     SHELFICEthetaSurface,
     &     SHELFICEDragLinear, SHELFICEDragQuadratic,
     &     shiCdrag, shiZetaN, shiRc,
     &     shiPrandtl, shiSchmidt, shiKinVisc

      _RL SHELFICE_dumpFreq, SHELFICE_taveFreq
      _RL SHELFICEheatTransCoeff
      _RL SHELFICEsaltTransCoeff
      _RL SHELFICElatentHeat
      _RL SHELFICEheatCapacity_Cp
      _RL rhoShelfice
      _RL SHELFICEkappa
      _RL recip_SHELFICElatentHeat
      _RL SHELFICEDragLinear
      _RL SHELFICEDragQuadratic
      _RL SHELFICEthetaSurface
      _RL shiCdrag, shiZetaN, shiRc
      _RL shiPrandtl, shiSchmidt, shiKinVisc


      COMMON /SHELFICE_FIELDS_RL/ 
     &     shelficeForcingT, shelficeForcingS,
     &     shiTransCoeffT, shiTransCoeffS
      _RL shelficeForcingT      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RL shelficeForcingS      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RL shiTransCoeffT        (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RL shiTransCoeffS        (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)

      COMMON /SHELFICE_FIELDS_RS/ 
     &     R_shelfIce,
     &     shelficeLoadAnomaly, 
     &     shelficeHeatFlux,
     &     shelfIceFreshWaterFlux
      _RS R_shelfIce            (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RS shelficeLoadAnomaly   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RS shelficeHeatFlux      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RS shelficeFreshWaterFlux(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)

#ifdef ALLOW_SHIFWFLX_CONTROL      
      COMMON /SHELFICE_MASKS_CTRL/ maskSHI
      _RS maskSHI  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
#endif /* ALLOW_SHIFWFLX_CONTROL */
      
      LOGICAL SHELFICEisOn
      LOGICAL useISOMIPTD
      LOGICAL SHELFICEconserve
      LOGICAL SHELFICEboundaryLayer
      LOGICAL no_slip_shelfice
      LOGICAL SHELFICEwriteState
      LOGICAL SHELFICE_dump_mdsio
      LOGICAL SHELFICE_tave_mdsio
      LOGICAL SHELFICE_dump_mnc
      LOGICAL SHELFICE_tave_mnc
      LOGICAL SHELFICEuseGammaFrict
      COMMON /SHELFICE_PARMS_L/
     &     SHELFICEisOn,
     &     useISOMIPTD,
     &     SHELFICEconserve,
     &     SHELFICEboundaryLayer,
     &     no_slip_shelfice,
     &     SHELFICEwriteState,
     &     SHELFICE_dump_mdsio,
     &     SHELFICE_tave_mdsio,
     &     SHELFICE_dump_mnc,
     &     SHELFICE_tave_mnc,
     &     SHELFICEuseGammaFrict

      CHARACTER*(MAX_LEN_FNAM) SHELFICEloadAnomalyFile
      CHARACTER*(MAX_LEN_FNAM) SHELFICEtopoFile
      COMMON /SHELFICE_PARM_C/ 
     &     SHELFICEloadAnomalyFile, 
     &     SHELFICEtopoFile

#endif /* ALLOW_SHELFICE */
1	heimbach	1.10	C $Header: /u/gcmpack/MITgcm/pkg/shelfice/SHELFICE.h,v 1.9 2011/06/29 16:24:10 heimbach Exp $
2	mlosch	1.1	C $Name: $
3
4			#ifdef ALLOW_SHELFICE
5
6			CBOP
7			C !ROUTINE: SHELFICE.h
8
9			C !DESCRIPTION: \bv
10			C /==========================================================\
11			C \| SHELFICE.h \|
12			C \| o Basic header thermodnynamic shelf ice package. \|
13			C \| Contains all SHELFICE field declarations. \|
14			C \==========================================================/
15
16			C-----------------------------------------------------------------------
17			C
18			C-- Constants that can be set in data.shelfice
19	mlosch	1.6	C SHELFICEtopoFile - File containing the topography of the
20			C shelfice draught (unit=m)
21	mlosch	1.2	C SHELFICEloadAnomalyFile - name of shelfice load anomaly file
22	mlosch	1.1	C SHELFICEDragLinear - linear drag at bottom shelfice (1/s)
23			C SHELFICEDragQuadratic - quadratic drag at bottom shelfice (1/m)
24	mlosch	1.3	C SHELFICEheatTransCoeff - heat transfer coefficient that determines
25			C heat flux into shelfice (m/s)
26			C SHELFICEsaltTransCoeff - salinity transfer coefficient that determines
27			C salt flux into shelfice (m/s)
28	mlosch	1.1	C SHELFICElatentHeat - latent heat of fusion (J/kg)
29			C useISOMIPTD - use simple ISOMIP thermodynamics
30	mlosch	1.5	C SHELFICEconserve - use conservative form of H&O-thermodynamics
31			C following Jenkins et al. (2001, JPO)
32	mlosch	1.4	C SHELFICEboundaryLayer - turn on vertical merging of cells to for a
33			C boundary layer of drF thickness
34	mlosch	1.1	C no_slip_shelfice - set slip conditions for shelfice separately,
35			C (by default the same as no_slip_bottom)
36			C SHELFICEwriteState - enable output
37			C SHELFICE_dump_mnc - use netcdf for snapshot output
38			C SHELFICE_tave_mnc - use netcdf for time-averaged output
39			C SHELFICE_dumpFreq - analoguous to dumpFreq (= default)
40			C SHELFICE_taveFreq - analoguous to taveFreq (= default)
41			C
42			C-- Fields
43	mlosch	1.2	C ktopC - index of the top "wet cell" (2D)
44			C R_shelfIce - shelfice topography [m]
45			C shelficeLoadAnomaly - pressure load anomaly of shelfice [Pa]
46			C shelficeHeatFlux - upward heat flux [W/m^2]
47			C shelficeFreshWaterFlux - upward fresh water flux (virt. salt flux) [m/s]
48			C shelficeForcingT - analogue of surfaceForcingT
49	dimitri	1.7	C units are r_unit.Kelvin/s (=Kelvin.m/s if r=z)
50	mlosch	1.2	C shelficeForcingS - analogue of surfaceForcingS
51	dimitri	1.7	C units are r_unit.psu/s (=psu.m/s if r=z)
52	mlosch	1.1	C-----------------------------------------------------------------------
53			C \ev
54			CEOP
55
56			COMMON /SHELFICE_PARMS_I/ kTopC
57			INTEGER kTopC (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
58
59			COMMON /SHELFICE_PARMS_R/
60			& SHELFICE_dumpFreq, SHELFICE_taveFreq,
61	mlosch	1.3	& SHELFICEheatTransCoeff, SHELFICEsaltTransCoeff,
62			& rhoShelfice, SHELFICEkappa,
63	mlosch	1.1	& SHELFICElatentHeat, recip_SHELFICElatentHeat,
64	mlosch	1.3	& SHELFICEheatCapacity_Cp,
65			& SHELFICEthetaSurface,
66	heimbach	1.9	& SHELFICEDragLinear, SHELFICEDragQuadratic,
67	heimbach	1.10	& shiCdrag, shiZetaN, shiRc,
68			& shiPrandtl, shiSchmidt, shiKinVisc
69
70	mlosch	1.1	_RL SHELFICE_dumpFreq, SHELFICE_taveFreq
71	mlosch	1.3	_RL SHELFICEheatTransCoeff
72			_RL SHELFICEsaltTransCoeff
73	mlosch	1.1	_RL SHELFICElatentHeat
74	mlosch	1.3	_RL SHELFICEheatCapacity_Cp
75			_RL rhoShelfice
76			_RL SHELFICEkappa
77	mlosch	1.1	_RL recip_SHELFICElatentHeat
78			_RL SHELFICEDragLinear
79			_RL SHELFICEDragQuadratic
80	mlosch	1.3	_RL SHELFICEthetaSurface
81	heimbach	1.9	_RL shiCdrag, shiZetaN, shiRc
82	heimbach	1.10	_RL shiPrandtl, shiSchmidt, shiKinVisc
83	heimbach	1.9
84	mlosch	1.1
85			COMMON /SHELFICE_FIELDS_RL/
86	heimbach	1.9	& shelficeForcingT, shelficeForcingS,
87			& shiTransCoeffT, shiTransCoeffS
88	mlosch	1.1	_RL shelficeForcingT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
89			_RL shelficeForcingS (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
90	heimbach	1.9	_RL shiTransCoeffT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
91			_RL shiTransCoeffS (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
92	mlosch	1.1
93			COMMON /SHELFICE_FIELDS_RS/
94			& R_shelfIce,
95	mlosch	1.2	& shelficeLoadAnomaly,
96	mlosch	1.1	& shelficeHeatFlux,
97			& shelfIceFreshWaterFlux
98			_RS R_shelfIce (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
99	mlosch	1.2	_RS shelficeLoadAnomaly (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
100	mlosch	1.1	_RS shelficeHeatFlux (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
101			_RS shelficeFreshWaterFlux(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
102	mlosch	1.8
103			#ifdef ALLOW_SHIFWFLX_CONTROL
104			COMMON /SHELFICE_MASKS_CTRL/ maskSHI
105			_RS maskSHI (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
106			#endif /* ALLOW_SHIFWFLX_CONTROL */
107	mlosch	1.1
108			LOGICAL SHELFICEisOn
109			LOGICAL useISOMIPTD
110	mlosch	1.5	LOGICAL SHELFICEconserve
111	mlosch	1.4	LOGICAL SHELFICEboundaryLayer
112	mlosch	1.1	LOGICAL no_slip_shelfice
113			LOGICAL SHELFICEwriteState
114			LOGICAL SHELFICE_dump_mdsio
115			LOGICAL SHELFICE_tave_mdsio
116			LOGICAL SHELFICE_dump_mnc
117			LOGICAL SHELFICE_tave_mnc
118	heimbach	1.9	LOGICAL SHELFICEuseGammaFrict
119	mlosch	1.1	COMMON /SHELFICE_PARMS_L/
120			& SHELFICEisOn,
121			& useISOMIPTD,
122	mlosch	1.5	& SHELFICEconserve,
123	mlosch	1.4	& SHELFICEboundaryLayer,
124	mlosch	1.1	& no_slip_shelfice,
125			& SHELFICEwriteState,
126			& SHELFICE_dump_mdsio,
127			& SHELFICE_tave_mdsio,
128			& SHELFICE_dump_mnc,
129	heimbach	1.9	& SHELFICE_tave_mnc,
130			& SHELFICEuseGammaFrict
131	mlosch	1.1
132	mlosch	1.2	CHARACTER*(MAX_LEN_FNAM) SHELFICEloadAnomalyFile
133	mlosch	1.6	CHARACTER*(MAX_LEN_FNAM) SHELFICEtopoFile
134	mlosch	1.2	COMMON /SHELFICE_PARM_C/
135	mlosch	1.6	& SHELFICEloadAnomalyFile,
136			& SHELFICEtopoFile
137	mlosch	1.2
138	mlosch	1.1	#endif /* ALLOW_SHELFICE */