pkg/shelfice/SHELFICE.h

C $Header: /u/gcmpack/MITgcm/pkg/shelfice/SHELFICE.h,v 1.14 2014/12/19 18:08:36 dgoldberg 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     SHELFICEmassFile         :: name of shelfice Mass file
C     SHELFICEloadAnomalyFile  :: name of shelfice load anomaly file
C     SHELFICEMassDynTendFile  :: file name for other mass tendency (e.g. dynamics)
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     SHELFICEMassStepping     :: flag to step forward ice shelf mass/thickness
C                                 accounts for melting/freezing & dynamics (from
C                                 file or from coupling)
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,
C                                 see Holland 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     shelficeMassInit       :: ice-shelf mass (per unit area) [kg/m^2]
C     shelficeMass           :: ice-shelf mass (per unit area) [kg/m^2]
C     shelfIceMassDynTendency :: other mass balance tendency (e.g., from dynamics)
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) [kg/m^2/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,
     &     shelficeMassInit,
     &     shelficeMass,
     &     shelficeLoadAnomaly,
     &     shelficeHeatFlux,
     &     shelfIceFreshWaterFlux,
     &     shelfIceMassDynTendency
      _RS R_shelfIce            (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RS shelficeMass          (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RS shelficeMassInit      (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)
      _RS
     &   shelfIceMassDynTendency(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
      LOGICAL SHELFICEMassStepping
      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,
     &     SHELFICEMassStepping

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

#endif /* ALLOW_SHELFICE */
1	jmc	1.15	C $Header: /u/gcmpack/MITgcm/pkg/shelfice/SHELFICE.h,v 1.14 2014/12/19 18:08:36 dgoldberg 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	jmc	1.12	C ==========================================================
11			C \| SHELFICE.h
12			C \| o Basic header thermodnynamic shelf ice package.
13			C \| Contains all SHELFICE field declarations.
14			C ==========================================================
15	mlosch	1.1
16			C-----------------------------------------------------------------------
17			C
18			C-- Constants that can be set in data.shelfice
19	jmc	1.12	C SHELFICEtopoFile :: File containing the topography of the
20			C shelfice draught (unit=m)
21			C SHELFICEmassFile :: name of shelfice Mass file
22			C SHELFICEloadAnomalyFile :: name of shelfice load anomaly file
23	jmc	1.15	C SHELFICEMassDynTendFile :: file name for other mass tendency (e.g. dynamics)
24	jmc	1.12	C SHELFICEDragLinear :: linear drag at bottom shelfice (1/s)
25			C SHELFICEDragQuadratic :: quadratic drag at bottom shelfice (1/m)
26			C SHELFICEheatTransCoeff :: heat transfer coefficient that determines
27	mlosch	1.3	C heat flux into shelfice (m/s)
28	jmc	1.12	C SHELFICEsaltTransCoeff :: salinity transfer coefficient that determines
29			C salt flux into shelfice (m/s)
30			C SHELFICElatentHeat :: latent heat of fusion (J/kg)
31			C useISOMIPTD :: use simple ISOMIP thermodynamics
32			C SHELFICEconserve :: use conservative form of H&O-thermodynamics
33			C following Jenkins et al. (2001, JPO)
34	jmc	1.15	C SHELFICEMassStepping :: flag to step forward ice shelf mass/thickness
35			C accounts for melting/freezing & dynamics (from
36			C file or from coupling)
37	jmc	1.12	C SHELFICEboundaryLayer :: turn on vertical merging of cells to for a
38			C boundary layer of drF thickness
39			C SHELFICEadvDiffHeatFlux :: use advective-diffusive heat flux into the ice shelf
40			C instead of diffusive heat flux (default), see Holland
41			C and Jenkins (1999), eq.21,22,26,31
42			C SHELFICEuseGammaFrict :: use velocity dependent exchange coefficients,
43			C see Holland and Jenkins (1999), eq.11-18
44			C no_slip_shelfice :: set slip conditions for shelfice separately,
45			C (by default the same as no_slip_bottom)
46			C SHELFICEwriteState :: enable output
47			C SHELFICE_dump_mnc :: use netcdf for snapshot output
48			C SHELFICE_tave_mnc :: use netcdf for time-averaged output
49			C SHELFICE_dumpFreq :: analoguous to dumpFreq (= default)
50			C SHELFICE_taveFreq :: analoguous to taveFreq (= default)
51	mlosch	1.1	C
52			C-- Fields
53	jmc	1.12	C ktopC :: index of the top "wet cell" (2D)
54			C R_shelfIce :: shelfice topography [m]
55	dgoldberg	1.14	C shelficeMassInit :: ice-shelf mass (per unit area) [kg/m^2]
56	dimitri	1.13	C shelficeMass :: ice-shelf mass (per unit area) [kg/m^2]
57	jmc	1.15	C shelfIceMassDynTendency :: other mass balance tendency (e.g., from dynamics)
58	jmc	1.12	C shelficeLoadAnomaly :: pressure load anomaly of shelfice [Pa]
59			C shelficeHeatFlux :: upward heat flux [W/m^2]
60	dimitri	1.13	C shelficeFreshWaterFlux :: upward fresh water flux (virt. salt flux) [kg/m^2/s]
61	jmc	1.12	C shelficeForcingT :: analogue of surfaceForcingT
62			C units are r_unit.Kelvin/s (=Kelvin.m/s if r=z)
63			C shelficeForcingS :: analogue of surfaceForcingS
64			C units are r_unit.psu/s (=psu.m/s if r=z)
65	mlosch	1.1	C-----------------------------------------------------------------------
66			C \ev
67			CEOP
68
69			COMMON /SHELFICE_PARMS_I/ kTopC
70			INTEGER kTopC (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
71
72	jmc	1.12	COMMON /SHELFICE_PARMS_R/
73	mlosch	1.1	& SHELFICE_dumpFreq, SHELFICE_taveFreq,
74	mlosch	1.3	& SHELFICEheatTransCoeff, SHELFICEsaltTransCoeff,
75			& rhoShelfice, SHELFICEkappa,
76	mlosch	1.1	& SHELFICElatentHeat, recip_SHELFICElatentHeat,
77	mlosch	1.3	& SHELFICEheatCapacity_Cp,
78			& SHELFICEthetaSurface,
79	heimbach	1.9	& SHELFICEDragLinear, SHELFICEDragQuadratic,
80	heimbach	1.10	& shiCdrag, shiZetaN, shiRc,
81			& shiPrandtl, shiSchmidt, shiKinVisc
82
83	mlosch	1.1	_RL SHELFICE_dumpFreq, SHELFICE_taveFreq
84	mlosch	1.3	_RL SHELFICEheatTransCoeff
85			_RL SHELFICEsaltTransCoeff
86	mlosch	1.1	_RL SHELFICElatentHeat
87	mlosch	1.3	_RL SHELFICEheatCapacity_Cp
88			_RL rhoShelfice
89			_RL SHELFICEkappa
90	mlosch	1.1	_RL recip_SHELFICElatentHeat
91			_RL SHELFICEDragLinear
92			_RL SHELFICEDragQuadratic
93	mlosch	1.3	_RL SHELFICEthetaSurface
94	heimbach	1.9	_RL shiCdrag, shiZetaN, shiRc
95	heimbach	1.10	_RL shiPrandtl, shiSchmidt, shiKinVisc
96	heimbach	1.9
97	jmc	1.12	COMMON /SHELFICE_FIELDS_RL/
98	heimbach	1.9	& shelficeForcingT, shelficeForcingS,
99			& shiTransCoeffT, shiTransCoeffS
100	mlosch	1.1	_RL shelficeForcingT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
101			_RL shelficeForcingS (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
102	heimbach	1.9	_RL shiTransCoeffT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
103			_RL shiTransCoeffS (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
104	mlosch	1.1
105	jmc	1.12	COMMON /SHELFICE_FIELDS_RS/
106	mlosch	1.1	& R_shelfIce,
107	dgoldberg	1.14	& shelficeMassInit,
108	jmc	1.12	& shelficeMass,
109			& shelficeLoadAnomaly,
110	mlosch	1.1	& shelficeHeatFlux,
111	dgoldberg	1.14	& shelfIceFreshWaterFlux,
112	jmc	1.15	& shelfIceMassDynTendency
113	mlosch	1.1	_RS R_shelfIce (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
114	jmc	1.12	_RS shelficeMass (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
115	dgoldberg	1.14	_RS shelficeMassInit (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
116	mlosch	1.2	_RS shelficeLoadAnomaly (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
117	mlosch	1.1	_RS shelficeHeatFlux (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
118			_RS shelficeFreshWaterFlux(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
119	jmc	1.15	_RS
120			& shelfIceMassDynTendency(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
121	mlosch	1.8
122	jmc	1.12	#ifdef ALLOW_SHIFWFLX_CONTROL
123	mlosch	1.8	COMMON /SHELFICE_MASKS_CTRL/ maskSHI
124			_RS maskSHI (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
125			#endif /* ALLOW_SHIFWFLX_CONTROL */
126	jmc	1.12
127	mlosch	1.1	LOGICAL SHELFICEisOn
128			LOGICAL useISOMIPTD
129	mlosch	1.5	LOGICAL SHELFICEconserve
130	mlosch	1.4	LOGICAL SHELFICEboundaryLayer
131	mlosch	1.1	LOGICAL no_slip_shelfice
132			LOGICAL SHELFICEwriteState
133			LOGICAL SHELFICE_dump_mdsio
134			LOGICAL SHELFICE_tave_mdsio
135			LOGICAL SHELFICE_dump_mnc
136			LOGICAL SHELFICE_tave_mnc
137	mlosch	1.11	LOGICAL SHELFICEadvDiffHeatFlux
138	heimbach	1.9	LOGICAL SHELFICEuseGammaFrict
139	jmc	1.15	LOGICAL SHELFICEMassStepping
140	mlosch	1.1	COMMON /SHELFICE_PARMS_L/
141			& SHELFICEisOn,
142			& useISOMIPTD,
143	mlosch	1.5	& SHELFICEconserve,
144	mlosch	1.4	& SHELFICEboundaryLayer,
145	mlosch	1.1	& no_slip_shelfice,
146			& SHELFICEwriteState,
147			& SHELFICE_dump_mdsio,
148			& SHELFICE_tave_mdsio,
149			& SHELFICE_dump_mnc,
150	heimbach	1.9	& SHELFICE_tave_mnc,
151	mlosch	1.11	& SHELFICEadvDiffHeatFlux,
152	dgoldberg	1.14	& SHELFICEuseGammaFrict,
153	jmc	1.15	& SHELFICEMassStepping
154	mlosch	1.1
155	mlosch	1.2	CHARACTER*(MAX_LEN_FNAM) SHELFICEloadAnomalyFile
156	jmc	1.12	CHARACTER*(MAX_LEN_FNAM) SHELFICEmassFile
157	mlosch	1.6	CHARACTER*(MAX_LEN_FNAM) SHELFICEtopoFile
158	jmc	1.15	CHARACTER*(MAX_LEN_FNAM) SHELFICEMassDynTendFile
159	jmc	1.12	COMMON /SHELFICE_PARM_C/
160			& SHELFICEloadAnomalyFile,
161			& SHELFICEmassFile,
162	dgoldberg	1.14	& SHELFICEtopoFile,
163	jmc	1.15	& SHELFICEMassDynTendFile
164	mlosch	1.2
165	mlosch	1.1	#endif /* ALLOW_SHELFICE */