pkg/icefront/ICEFRONT.h

C $Header: /u/gcmpack/MITgcm/pkg/icefront/ICEFRONT.h,v 1.3 2010/01/25 22:37:19 dimitri Exp $
C $Name:  $

#ifdef ALLOW_ICEFRONT

CBOP
C !ROUTINE: ICEFRONT.h

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

C-----------------------------------------------------------------------
C
C--   Constants that can be set in data.icefront
C     ICEFRONTdepthFile        - name of icefront depth file (m)
C                                2D file containing depth of the ice front
C                                at each model grid cell
C     ICEFRONTlengthFile       - name of icefront length file (m/m^2)
C                                2D file containing the ratio of the horizontal
C                                length of the ice front in each model grid cell
C                                divided by the grid cell area
C     ICEFRONTheatTransCoeff   - heat transfer coefficient that determines
C                                 heat flux into icefront (m/s)
C     ICEFRONTsaltTransCoeff   - salinity transfer coefficient that determines
C                                salt flux into icefront (m/s)
C     ICEFRONTlatentHeat       - latent heat of fusion (J/kg)
C     ICEFRONTconserve         - use conservative form of H&O-thermodynamics 
C                                following Jenkins et al. (2001, JPO)
C     applyIcefrontTendT/S     -  
C
C--   Fields
C     K_icefront             - # of icefront model levels at every horizontal location (2D)
C     R_icefront             - icefront depth [m] (2D)
C     icefrontlength         - icefront horizontal length divided by grid cell area [m/m^2] (2D)
C     icefrontHeatFlux       - outward heat flux, +ve cools the ocean [W/m^2]
C     icefrontFreshWaterFlux - outward fresh water flux, +ve increases ocean salinity [m/s]
C     icefront_TendT         - temperature tendency (Kelvin/s)
C     icefront_TendS         - salinity tendency (psu/s)
C-----------------------------------------------------------------------
C \ev
CEOP

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

      COMMON /ICEFRONT_PARMS_R/ 
     &     ICEFRONTheatTransCoeff, ICEFRONTsaltTransCoeff,
     &     rhoIcefront, ICEFRONTkappa,
     &     ICEFRONTlatentHeat, recip_ICEFRONTlatentHeat,
     &     ICEFRONTheatCapacity_Cp,
     &     ICEFRONTthetaSurface
      _RL ICEFRONTheatTransCoeff
      _RL ICEFRONTsaltTransCoeff
      _RL ICEFRONTlatentHeat
      _RL ICEFRONTheatCapacity_Cp
      _RL rhoIcefront
      _RL ICEFRONTkappa
      _RL recip_ICEFRONTlatentHeat
      _RL ICEFRONTthetaSurface

      COMMON /ICEFRONT_FIELDS_RL/ 
     &     icefront_TendT,
     &     icefront_TendS
      _RL icefront_TendT        (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL icefront_TendS        (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)

      COMMON /ICEFRONT_FIELDS_RS/ 
     &     R_icefront,
     &     icefrontlength, 
     &     icefrontHeatFlux,
     &     icefrontFreshWaterFlux
      _RS R_icefront            (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RS icefrontlength        (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
      _RS icefrontHeatFlux      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RS icefrontFreshWaterFlux(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      
      LOGICAL ICEFRONTisOn
      LOGICAL ICEFRONTconserve
      LOGICAL applyIcefrontTendT
      LOGICAL applyIcefrontTendS
      COMMON /ICEFRONT_PARMS_L/
     &     ICEFRONTisOn,
     &     ICEFRONTconserve,
     &     applyIcefrontTendT,
     &     applyIcefrontTendS

      CHARACTER*(MAX_LEN_FNAM) ICEFRONTlengthFile
      CHARACTER*(MAX_LEN_FNAM) ICEFRONTdepthFile
      COMMON /ICEFRONT_PARM_C/ 
     &     ICEFRONTlengthFile, 
     &     ICEFRONTdepthFile

#endif /* ALLOW_ICEFRONT */
1	dimitri	1.4	C $Header: /u/gcmpack/MITgcm/pkg/icefront/ICEFRONT.h,v 1.3 2010/01/25 22:37:19 dimitri Exp $
2	dimitri	1.1	C $Name: $
3
4			#ifdef ALLOW_ICEFRONT
5
6			CBOP
7			C !ROUTINE: ICEFRONT.h
8
9			C !DESCRIPTION: \bv
10			C /==========================================================\
11			C \| ICEFRONT.h \|
12			C \| o Basic header thermodnynamic shelf ice package. \|
13			C \| Contains all ICEFRONT field declarations. \|
14			C \==========================================================/
15
16			C-----------------------------------------------------------------------
17			C
18			C-- Constants that can be set in data.icefront
19	dimitri	1.4	C ICEFRONTdepthFile - name of icefront depth file (m)
20			C 2D file containing depth of the ice front
21			C at each model grid cell
22			C ICEFRONTlengthFile - name of icefront length file (m/m^2)
23			C 2D file containing the ratio of the horizontal
24			C length of the ice front in each model grid cell
25			C divided by the grid cell area
26	dimitri	1.1	C ICEFRONTheatTransCoeff - heat transfer coefficient that determines
27			C heat flux into icefront (m/s)
28			C ICEFRONTsaltTransCoeff - salinity transfer coefficient that determines
29			C salt flux into icefront (m/s)
30			C ICEFRONTlatentHeat - latent heat of fusion (J/kg)
31			C ICEFRONTconserve - use conservative form of H&O-thermodynamics
32			C following Jenkins et al. (2001, JPO)
33	dimitri	1.4	C applyIcefrontTendT/S -
34	dimitri	1.1	C
35			C-- Fields
36	dimitri	1.4	C K_icefront - # of icefront model levels at every horizontal location (2D)
37			C R_icefront - icefront depth [m] (2D)
38			C icefrontlength - icefront horizontal length divided by grid cell area [m/m^2] (2D)
39			C icefrontHeatFlux - outward heat flux, +ve cools the ocean [W/m^2]
40			C icefrontFreshWaterFlux - outward fresh water flux, +ve increases ocean salinity [m/s]
41			C icefront_TendT - temperature tendency (Kelvin/s)
42			C icefront_TendS - salinity tendency (psu/s)
43	dimitri	1.1	C-----------------------------------------------------------------------
44			C \ev
45			CEOP
46
47	dimitri	1.4	COMMON /ICEFRONT_PARMS_I/ K_icefront
48			INTEGER K_icefront (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
49
50	dimitri	1.1	COMMON /ICEFRONT_PARMS_R/
51			& ICEFRONTheatTransCoeff, ICEFRONTsaltTransCoeff,
52			& rhoIcefront, ICEFRONTkappa,
53			& ICEFRONTlatentHeat, recip_ICEFRONTlatentHeat,
54			& ICEFRONTheatCapacity_Cp,
55	dimitri	1.2	& ICEFRONTthetaSurface
56	dimitri	1.1	_RL ICEFRONTheatTransCoeff
57			_RL ICEFRONTsaltTransCoeff
58			_RL ICEFRONTlatentHeat
59			_RL ICEFRONTheatCapacity_Cp
60			_RL rhoIcefront
61			_RL ICEFRONTkappa
62			_RL recip_ICEFRONTlatentHeat
63			_RL ICEFRONTthetaSurface
64
65			COMMON /ICEFRONT_FIELDS_RL/
66	dimitri	1.4	& icefront_TendT,
67			& icefront_TendS
68			_RL icefront_TendT (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
69			_RL icefront_TendS (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
70	dimitri	1.1
71			COMMON /ICEFRONT_FIELDS_RS/
72			& R_icefront,
73	dimitri	1.4	& icefrontlength,
74	dimitri	1.1	& icefrontHeatFlux,
75			& icefrontFreshWaterFlux
76			_RS R_icefront (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
77	dimitri	1.4	_RS icefrontlength (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
78	dimitri	1.3	_RS icefrontHeatFlux (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
79			_RS icefrontFreshWaterFlux(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
80	dimitri	1.1
81			LOGICAL ICEFRONTisOn
82			LOGICAL ICEFRONTconserve
83	dimitri	1.4	LOGICAL applyIcefrontTendT
84			LOGICAL applyIcefrontTendS
85	dimitri	1.1	COMMON /ICEFRONT_PARMS_L/
86			& ICEFRONTisOn,
87	dimitri	1.4	& ICEFRONTconserve,
88			& applyIcefrontTendT,
89			& applyIcefrontTendS
90	dimitri	1.1
91	dimitri	1.4	CHARACTER*(MAX_LEN_FNAM) ICEFRONTlengthFile
92			CHARACTER*(MAX_LEN_FNAM) ICEFRONTdepthFile
93	dimitri	1.1	COMMON /ICEFRONT_PARM_C/
94	dimitri	1.4	& ICEFRONTlengthFile,
95			& ICEFRONTdepthFile
96	dimitri	1.1
97			#endif /* ALLOW_ICEFRONT */