pkg/shelfice/SHELFICE.h

C $Header: /u/gcmpack/MITgcm/pkg/shelfice/SHELFICE.h,v 1.10 2012/01/06 13:45:59 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     SHELFICEadvDiffHeatFlux  - use advective-diffusive heat flux into the ice shelf
C                                instead of diffusive heat flux (default), see Holland 
C                                and Jenkins (1999), eq.21,22,26,31
C     SHELFICEuseGammaFrict    - use velocity dependent exchange coefficients, see Holland a
C                                and Jenkins (1999), eq.11-18
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 SHELFICEadvDiffHeatFlux
      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,
     &     SHELFICEadvDiffHeatFlux,
     &     SHELFICEuseGammaFrict

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

#endif /* ALLOW_SHELFICE */
1	mlosch	1.11	C $Header: /u/gcmpack/MITgcm/pkg/shelfice/SHELFICE.h,v 1.10 2012/01/06 13:45:59 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.11	C SHELFICEadvDiffHeatFlux - use advective-diffusive heat flux into the ice shelf
35			C instead of diffusive heat flux (default), see Holland
36			C and Jenkins (1999), eq.21,22,26,31
37			C SHELFICEuseGammaFrict - use velocity dependent exchange coefficients, see Holland a
38			C and Jenkins (1999), eq.11-18
39	mlosch	1.1	C no_slip_shelfice - set slip conditions for shelfice separately,
40			C (by default the same as no_slip_bottom)
41			C SHELFICEwriteState - enable output
42			C SHELFICE_dump_mnc - use netcdf for snapshot output
43			C SHELFICE_tave_mnc - use netcdf for time-averaged output
44			C SHELFICE_dumpFreq - analoguous to dumpFreq (= default)
45			C SHELFICE_taveFreq - analoguous to taveFreq (= default)
46			C
47			C-- Fields
48	mlosch	1.2	C ktopC - index of the top "wet cell" (2D)
49			C R_shelfIce - shelfice topography [m]
50			C shelficeLoadAnomaly - pressure load anomaly of shelfice [Pa]
51			C shelficeHeatFlux - upward heat flux [W/m^2]
52			C shelficeFreshWaterFlux - upward fresh water flux (virt. salt flux) [m/s]
53			C shelficeForcingT - analogue of surfaceForcingT
54	dimitri	1.7	C units are r_unit.Kelvin/s (=Kelvin.m/s if r=z)
55	mlosch	1.2	C shelficeForcingS - analogue of surfaceForcingS
56	dimitri	1.7	C units are r_unit.psu/s (=psu.m/s if r=z)
57	mlosch	1.1	C-----------------------------------------------------------------------
58			C \ev
59			CEOP
60
61			COMMON /SHELFICE_PARMS_I/ kTopC
62			INTEGER kTopC (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
63
64			COMMON /SHELFICE_PARMS_R/
65			& SHELFICE_dumpFreq, SHELFICE_taveFreq,
66	mlosch	1.3	& SHELFICEheatTransCoeff, SHELFICEsaltTransCoeff,
67			& rhoShelfice, SHELFICEkappa,
68	mlosch	1.1	& SHELFICElatentHeat, recip_SHELFICElatentHeat,
69	mlosch	1.3	& SHELFICEheatCapacity_Cp,
70			& SHELFICEthetaSurface,
71	heimbach	1.9	& SHELFICEDragLinear, SHELFICEDragQuadratic,
72	heimbach	1.10	& shiCdrag, shiZetaN, shiRc,
73			& shiPrandtl, shiSchmidt, shiKinVisc
74
75	mlosch	1.1	_RL SHELFICE_dumpFreq, SHELFICE_taveFreq
76	mlosch	1.3	_RL SHELFICEheatTransCoeff
77			_RL SHELFICEsaltTransCoeff
78	mlosch	1.1	_RL SHELFICElatentHeat
79	mlosch	1.3	_RL SHELFICEheatCapacity_Cp
80			_RL rhoShelfice
81			_RL SHELFICEkappa
82	mlosch	1.1	_RL recip_SHELFICElatentHeat
83			_RL SHELFICEDragLinear
84			_RL SHELFICEDragQuadratic
85	mlosch	1.3	_RL SHELFICEthetaSurface
86	heimbach	1.9	_RL shiCdrag, shiZetaN, shiRc
87	heimbach	1.10	_RL shiPrandtl, shiSchmidt, shiKinVisc
88	heimbach	1.9
89	mlosch	1.1
90			COMMON /SHELFICE_FIELDS_RL/
91	heimbach	1.9	& shelficeForcingT, shelficeForcingS,
92			& shiTransCoeffT, shiTransCoeffS
93	mlosch	1.1	_RL shelficeForcingT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
94			_RL shelficeForcingS (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
95	heimbach	1.9	_RL shiTransCoeffT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
96			_RL shiTransCoeffS (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
97	mlosch	1.1
98			COMMON /SHELFICE_FIELDS_RS/
99			& R_shelfIce,
100	mlosch	1.2	& shelficeLoadAnomaly,
101	mlosch	1.1	& shelficeHeatFlux,
102			& shelfIceFreshWaterFlux
103			_RS R_shelfIce (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
104	mlosch	1.2	_RS shelficeLoadAnomaly (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
105	mlosch	1.1	_RS shelficeHeatFlux (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
106			_RS shelficeFreshWaterFlux(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
107	mlosch	1.8
108			#ifdef ALLOW_SHIFWFLX_CONTROL
109			COMMON /SHELFICE_MASKS_CTRL/ maskSHI
110			_RS maskSHI (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
111			#endif /* ALLOW_SHIFWFLX_CONTROL */
112	mlosch	1.1
113			LOGICAL SHELFICEisOn
114			LOGICAL useISOMIPTD
115	mlosch	1.5	LOGICAL SHELFICEconserve
116	mlosch	1.4	LOGICAL SHELFICEboundaryLayer
117	mlosch	1.1	LOGICAL no_slip_shelfice
118			LOGICAL SHELFICEwriteState
119			LOGICAL SHELFICE_dump_mdsio
120			LOGICAL SHELFICE_tave_mdsio
121			LOGICAL SHELFICE_dump_mnc
122			LOGICAL SHELFICE_tave_mnc
123	mlosch	1.11	LOGICAL SHELFICEadvDiffHeatFlux
124	heimbach	1.9	LOGICAL SHELFICEuseGammaFrict
125	mlosch	1.1	COMMON /SHELFICE_PARMS_L/
126			& SHELFICEisOn,
127			& useISOMIPTD,
128	mlosch	1.5	& SHELFICEconserve,
129	mlosch	1.4	& SHELFICEboundaryLayer,
130	mlosch	1.1	& no_slip_shelfice,
131			& SHELFICEwriteState,
132			& SHELFICE_dump_mdsio,
133			& SHELFICE_tave_mdsio,
134			& SHELFICE_dump_mnc,
135	heimbach	1.9	& SHELFICE_tave_mnc,
136	mlosch	1.11	& SHELFICEadvDiffHeatFlux,
137	heimbach	1.9	& SHELFICEuseGammaFrict
138	mlosch	1.1
139	mlosch	1.2	CHARACTER*(MAX_LEN_FNAM) SHELFICEloadAnomalyFile
140	mlosch	1.6	CHARACTER*(MAX_LEN_FNAM) SHELFICEtopoFile
141	mlosch	1.2	COMMON /SHELFICE_PARM_C/
142	mlosch	1.6	& SHELFICEloadAnomalyFile,
143			& SHELFICEtopoFile
144	mlosch	1.2
145	mlosch	1.1	#endif /* ALLOW_SHELFICE */