| 1 | mmazloff | 1.1 | C $Header: /u/gcmpack/MITgcm/pkg/seaice/SEAICE.h,v 1.52 2009/10/22 12:15:38 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 HSNOW / AREA | 
| 35 |  |  | C     HSALT - effective sea ice salinity in g/m^2 | 
| 36 |  |  | C             at center of grid, i.e., tracer point | 
| 37 |  |  | C     ICEAGE- effective sea ice age in s | 
| 38 |  |  | C             at center of grid, i.e., tracer point | 
| 39 |  |  | C             note: for non-zero AREA, actual ice | 
| 40 |  |  | C                age is ICEAGE / AREA | 
| 41 |  |  | C \ev | 
| 42 |  |  | CEOP | 
| 43 |  |  |  | 
| 44 |  |  | C--   Grid variables for seaice | 
| 45 |  |  | COMMON/ARRAY/HEFFM | 
| 46 |  |  | _RL HEFFM      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 47 |  |  | #ifdef SEAICE_CGRID | 
| 48 |  |  | COMMON/ARRAYC/ seaiceMaskU, seaiceMaskV | 
| 49 |  |  | _RL seaiceMaskU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 50 |  |  | _RL seaiceMaskV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 51 |  |  | C     k1/2AtZ :: coefficients at C and Z points | 
| 52 |  |  | C     k1/2AtC    for metric terms in U/V ice equations. | 
| 53 |  |  | COMMON/ARRAYCMETRIC/  k1AtC, k1AtZ, k2AtC, k2AtZ | 
| 54 |  |  | _RS k1AtC      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 55 |  |  | _RS k1AtZ      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 56 |  |  | _RS k2AtC      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 57 |  |  | _RS k2AtZ      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 58 |  |  | #else | 
| 59 |  |  | COMMON/ARRAYB/ UVM | 
| 60 |  |  | _RL UVM        (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 61 |  |  | #endif /* SEAICE_CGRID */ | 
| 62 |  |  |  | 
| 63 |  |  | C--   Dynamical variables | 
| 64 |  |  | COMMON/SEAICE_DYNVARS_1/AREA,HEFF,HSNOW,UICE,VICE | 
| 65 |  |  | _RL AREA       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 66 |  |  | _RL HEFF       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 67 |  |  | _RL HSNOW      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 68 |  |  | _RL UICE       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 69 |  |  | _RL VICE       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 70 |  |  |  | 
| 71 |  |  | COMMON/SEAICE_DYNVARS_2/AREANM1,HEFFNM1,UICENM1,VICENM1 | 
| 72 |  |  | _RL HEFFNM1    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 73 |  |  | _RL AREANM1    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 74 |  |  | _RL UICENM1    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 75 |  |  | _RL VICENM1    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 76 |  |  |  | 
| 77 |  |  | COMMON/SEAICE_DYNVARS_3/ | 
| 78 |  |  | &     ETA,ZETA,PRESS, e11, e22, e12, | 
| 79 |  |  | &     DRAGS,DRAGA,FORCEX,FORCEY,UICEC,VICEC | 
| 80 |  |  | _RL ETA        (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 81 |  |  | _RL ZETA       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 82 |  |  | C     ice strength/pressure term | 
| 83 |  |  | _RL PRESS      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 84 |  |  | C     strain rate tensor | 
| 85 |  |  | _RL e11        (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 86 |  |  | _RL e22        (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 87 |  |  | _RL e12        (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 88 |  |  | C | 
| 89 |  |  | _RL DRAGS      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 90 |  |  | _RL DRAGA      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 91 |  |  | _RL FORCEX     (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 92 |  |  | _RL FORCEY     (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 93 |  |  | _RL UICEC      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 94 |  |  | _RL VICEC      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 95 |  |  |  | 
| 96 |  |  | #ifndef SEAICE_CGRID | 
| 97 |  |  | COMMON/SEAICE_DYNVARS_BGRID/ AMASS, DAIRN | 
| 98 |  |  | _RL AMASS      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 99 |  |  | _RL DAIRN      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 100 |  |  | #else | 
| 101 |  |  | COMMON/SEAICE_DYNVARS_CGRID/ | 
| 102 |  |  | &     seaiceMassC, seaiceMassU, seaiceMassV | 
| 103 |  |  | _RL seaiceMassC(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 104 |  |  | _RL seaiceMassU(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 105 |  |  | _RL seaiceMassV(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 106 |  |  | #endif | 
| 107 |  |  |  | 
| 108 |  |  | COMMON/SEAICE_DYNVARS_4/ | 
| 109 |  |  | &     DWATN, PRESS0, FORCEX0, FORCEY0, ZMAX, ZMIN | 
| 110 |  |  | _RL DWATN      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 111 |  |  | _RL PRESS0     (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 112 |  |  | _RL FORCEX0    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 113 |  |  | _RL FORCEY0    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 114 |  |  | _RL ZMAX       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 115 |  |  | _RL ZMIN       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 116 |  |  |  | 
| 117 |  |  | #ifdef SEAICE_SALINITY | 
| 118 |  |  | COMMON/SEAICE_SALINITY_R/HSALT | 
| 119 |  |  | _RL HSALT      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 120 |  |  | #endif | 
| 121 |  |  |  | 
| 122 |  |  | #ifdef SEAICE_AGE | 
| 123 |  |  | COMMON/SEAICE_AGE_R/ICEAGE | 
| 124 |  |  | _RL ICEAGE     (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 125 |  |  | #endif | 
| 126 |  |  |  | 
| 127 |  |  | COMMON/OFL/YNEG | 
| 128 |  |  | COMMON/RIV/RIVER | 
| 129 |  |  | _RL YNEG       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 130 |  |  | _RL RIVER      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 131 |  |  |  | 
| 132 |  |  | C     saltWtrIce contains m of salty ice melted (<0) or created (>0) | 
| 133 |  |  | C     frWtrIce contains m of freshwater ice melted (<0) or created (>0) | 
| 134 |  |  | C              that is, ice due to precipitation or snow | 
| 135 |  |  | C     frWtrAtm contains freshwater flux from the atmosphere | 
| 136 |  |  | COMMON/ICEFLUX/ saltWtrIce, frWtrIce | 
| 137 |  |  | #ifdef ALLOW_MEAN_SFLUX_COST_CONTRIBUTION | 
| 138 |  |  | &     , frWtrAtm | 
| 139 |  |  | _RL frWtrAtm   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 140 |  |  | #endif | 
| 141 |  |  | _RL saltWtrIce (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 142 |  |  | _RL frWtrIce   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 143 |  |  |  | 
| 144 |  |  | INTEGER MULTDIM | 
| 145 |  |  | PARAMETER (MULTDIM=7) | 
| 146 |  |  | #ifdef SEAICE_MULTICATEGORY | 
| 147 |  |  | COMMON/MULTICATEGORY/TICES | 
| 148 |  |  | _RL TICES      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,MULTDIM,nSx,nSy) | 
| 149 |  |  | #endif | 
| 150 |  |  |  | 
| 151 |  |  | #if (defined (SEAICE_CGRID) && defined (SEAICE_ALLOW_EVP)) | 
| 152 |  |  | C | 
| 153 |  |  | C     additional fields needed by the EVP solver | 
| 154 |  |  | C | 
| 155 |  |  | C     seaice_sigma1  - sigma11+sigma22, defined at C-points | 
| 156 |  |  | C     seaice_sigma2  - sigma11-sigma22, defined at C-points | 
| 157 |  |  | C     seaice_sigma12 - off-diagonal term, defined at Z-points | 
| 158 |  |  | COMMON /SEAICE_EVP_FIELDS/ | 
| 159 |  |  | &     seaice_sigma1, seaice_sigma2, seaice_sigma12 | 
| 160 |  |  | _RL seaice_sigma1    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 161 |  |  | _RL seaice_sigma2    (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 162 |  |  | _RL seaice_sigma12   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 163 |  |  | #endif /* SEAICE_ALLOW_EVP and SEAICE_CGRID */ | 
| 164 |  |  |  | 
| 165 |  |  | #ifdef SEAICE_CGRID | 
| 166 |  |  | C     stressDivergenceX/Y - divergence of stress tensor | 
| 167 |  |  | COMMON /SEAICE_STRESSDIV/ | 
| 168 |  |  | &     stressDivergenceX, stressDivergenceY | 
| 169 |  |  | _RL stressDivergenceX(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 170 |  |  | _RL stressDivergenceY(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 171 |  |  | #endif /* SEAICE_CGRID */ | 
| 172 |  |  |  | 
| 173 |  |  | COMMON/MIX/TMIX,TICE | 
| 174 |  |  | _RL TMIX       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 175 |  |  | _RL TICE       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 176 |  |  |  | 
| 177 |  |  | COMMON/WIND_STRESS_ICE/TAUX,TAUY | 
| 178 |  |  | C     TAUX   - zonal      wind stress over ice at U point | 
| 179 |  |  | C     TAUY   - meridional wind stress over ice at V point | 
| 180 |  |  | _RL TAUX       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 181 |  |  | _RL TAUY       (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 182 |  |  |  | 
| 183 |  |  | #ifndef SEAICE_CGRID | 
| 184 |  |  | COMMON/WIND_STRESS_OCE/WINDX,WINDY | 
| 185 |  |  | C     WINDX  - zonal      wind stress over water at C points | 
| 186 |  |  | C     WINDY  - meridional wind stress over water at C points | 
| 187 |  |  | _RL WINDX      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 188 |  |  | _RL WINDY      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 189 |  |  |  | 
| 190 |  |  | COMMON/GWATXY/GWATX,GWATY | 
| 191 |  |  | _RL GWATX      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 192 |  |  | _RL GWATY      (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 193 |  |  |  | 
| 194 |  |  | C--   KGEO    Level used as a proxy for geostrophic velocity. | 
| 195 |  |  | COMMON/SEAICE_KGEO/KGEO | 
| 196 |  |  | INTEGER KGEO   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 197 |  |  | #endif | 
| 198 |  |  |  | 
| 199 |  |  | #ifdef ALLOW_SEAICE_COST_EXPORT | 
| 200 |  |  | _RL uHeffExportCell(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 201 |  |  | _RL vHeffExportCell(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) | 
| 202 |  |  | COMMON /SEAICE_COST_EXPORT_R/ | 
| 203 |  |  | &       uHeffExportCell, vHeffExportCell | 
| 204 |  |  | #endif | 
| 205 |  |  |  | 
| 206 |  |  | cif( | 
| 207 |  |  | #ifdef SHORTWAVE_HEATING | 
| 208 |  |  | _RL SWFRACB | 
| 209 |  |  | COMMON /SEAICE_SW_R/ | 
| 210 |  |  | &       SWFRACB | 
| 211 |  |  | #endif | 
| 212 |  |  | cif) | 
| 213 |  |  |  | 
| 214 |  |  | #ifdef ALLOW_AUTODIFF_TAMC | 
| 215 |  |  | INTEGER iicekey | 
| 216 |  |  | INTEGER nEVPstepMax | 
| 217 |  |  | PARAMETER ( nEVPstepMax=300 ) | 
| 218 |  |  | #endif | 
| 219 |  |  |  | 
| 220 |  |  | CEH3 ;;; Local Variables: *** | 
| 221 |  |  | CEH3 ;;; mode:fortran *** | 
| 222 |  |  | CEH3 ;;; End: *** |