/[MITgcm]/MITgcm_contrib/dgoldberg/streamice/STREAMICE.h
ViewVC logotype

Contents of /MITgcm_contrib/dgoldberg/streamice/STREAMICE.h

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.23 - (show annotations) (download)
Tue Jun 11 17:42:17 2013 UTC (12 years, 1 month ago) by dgoldberg
Branch: MAIN
Changes since 1.22: +3 -1 lines
File MIME type: text/plain
allow subcycling for thickness advec

1 C---+----1--+-+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
2
3 #ifdef ALLOW_STREAMICE
4
5 C -------------------------- REAL PARAMS ---------------------------------------------------
6
7 COMMON /STREAMICE_PARMS_R/
8 & streamice_density, streamice_density_ocean_avg,
9 ! & A_glen_isothermal, n_glen, eps_glen_min, eps_u_min,
10 & B_glen_isothermal, n_glen, eps_glen_min, eps_u_min,
11 & C_basal_fric_const, n_basal_friction, streamice_input_flux_unif,
12 & streamice_vel_update, streamice_cg_tol, streamice_nonlin_tol,
13 & streamice_nonlin_tol_fp,
14 & streamice_CFL_factor, streamice_adjDump,
15 & streamice_bg_surf_slope_x, streamice_bg_surf_slope_y,
16 & streamice_kx_b_init, streamice_ky_b_init,
17 & streamice_wgt_drift, streamice_wgt_surf,
18 & streamice_wgt_avthick, streamice_wgt_vel,
19 & streamice_wgt_tikh,
20 & streamice_addl_backstress,
21 & streamice_smooth_gl_width,
22 & streamice_adot_uniform
23 _RL streamice_density, streamice_density_ocean_avg
24 ! _RL A_glen_isothermal, n_glen, eps_glen_min, eps_u_min
25 _RL B_glen_isothermal, n_glen, eps_glen_min, eps_u_min
26 _RL C_basal_fric_const
27 _RL n_basal_friction
28 _RL streamice_input_flux_unif
29 _RL streamice_vel_update
30 _RL streamice_cg_tol, streamice_nonlin_tol
31 _RL streamice_nonlin_tol_fp
32 _RL streamice_CFL_factor
33 _RL streamice_adjDump
34 _RL streamice_bg_surf_slope_x, streamice_bg_surf_slope_y
35 _RL streamice_kx_b_init, streamice_ky_b_init
36 _RL streamice_wgt_drift, streamice_wgt_surf
37 _RL streamice_wgt_avthick, streamice_wgt_vel
38 _RL streamice_wgt_tikh
39 _RL streamice_addl_backstress
40 _RL streamice_smooth_gl_width
41 _RL streamice_adot_uniform
42
43
44 C parms for parameterized initial thickness
45 C SHELF_MAX_DRAFT: max thickness of ice in m
46 C SHELF_MIN_DRAFT: min thickness of ice in m
47 C SHELF_EDGE_POS: extent of ice shelf in (km?)
48 C SHELF_SLOPE_SCALE: dist over which shelf slopes (km?)
49 C SHELF_FLAT_WIDTH: width of flat shelf (km?)
50 C also must be aware of units (m for cartesian, deg for curvilinear, m/deg for CYLINDRICAL POLAR)
51 C FLOW_DIR: 1.0=west, 2.0=east, 3.0=south, 4.0=north
52
53 COMMON /STREAMICE_H_INIT_R/
54 & shelf_max_draft,
55 & shelf_min_draft,
56 & shelf_edge_pos,
57 & shelf_slope_scale,
58 & shelf_flat_width,
59 & flow_dir
60 _RL shelf_max_draft
61 _RL shelf_min_draft
62 _RL shelf_edge_pos
63 _RL shelf_slope_scale
64 _RL shelf_flat_width
65 _RL flow_dir
66
67 C -------------------------- INT PARAMS ---------------------------------------------------
68
69 INTEGER streamice_max_nl
70 PARAMETER ( streamice_max_nl = 100 )
71
72 COMMON /STREAMICE_PARMS_I/
73 & streamice_max_cg_iter, streamice_max_nl_iter,
74 & streamice_vel_upd_counter, streamice_nstep_velocity,
75 & streamice_n_sub_regularize
76 INTEGER streamice_max_cg_iter, streamice_max_nl_iter
77 INTEGER streamice_vel_upd_counter, streamice_nstep_velocity
78 INTEGER streamice_n_sub_regularize
79
80 C -------------------------- CHAR PARAMS ---------------------------------------------------
81
82 CHARACTER*(MAX_LEN_FNAM) STREAMICEthickFile
83 CHARACTER*(MAX_LEN_FNAM) STREAMICEthickInit
84 CHARACTER*(MAX_LEN_FNAM) STREAMICEcalveMaskFile
85 CHARACTER*(MAX_LEN_FNAM) STREAMICEsigcoordInit
86 CHARACTER*(MAX_LEN_FNAM) STREAMICEsigcoordFile
87 CHARACTER*(MAX_LEN_FNAM) STREAMICEdelsigFile
88 CHARACTER*(MAX_LEN_FNAM) STREAMICEbasalTracConfig
89 CHARACTER*(MAX_LEN_FNAM) STREAMICEGlenConstConfig
90 CHARACTER*(MAX_LEN_FNAM) STREAMICEbasalTracFile
91 CHARACTER*(MAX_LEN_FNAM) STREAMICEGlenConstFile
92 CHARACTER*(MAX_LEN_FNAM) STREAMICEvelOptimFile
93 CHARACTER*(MAX_LEN_FNAM) STREAMICEtopogFile
94 CHARACTER*(MAX_LEN_FNAM) STREAMICEcostMaskFile
95 CHARACTER*(MAX_LEN_FNAM) STREAMICE_ADV_SCHEME
96
97 ! THE FOLLOWING FILENAMES ARE FOR SPECIFYING IRREGULAR DOMAIN GEOMETRIES
98 ! (i.e. boundaries that do not conform with rectangular walls)
99 CHARACTER*(MAX_LEN_FNAM) STREAMICEhmaskFile
100 CHARACTER*(MAX_LEN_FNAM) STREAMICEHBCxFile
101 CHARACTER*(MAX_LEN_FNAM) STREAMICEHBCyFile
102 CHARACTER*(MAX_LEN_FNAM) STREAMICEuFaceBdryFile
103 CHARACTER*(MAX_LEN_FNAM) STREAMICEvFaceBdryFile
104 CHARACTER*(MAX_LEN_FNAM) STREAMICEuDirichValsFile
105 CHARACTER*(MAX_LEN_FNAM) STREAMICEvDirichValsFile
106
107 #ifdef ALLOW_PETSC
108 ! CHARACTER PARAMS FOR PETSC
109 CHARACTER*(MAX_LEN_FNAM) PETSC_SOLVER_TYPE
110 CHARACTER*(MAX_LEN_FNAM) PETSC_PRECOND_TYPE
111 #endif
112
113 #ifdef ALLOW_STREAMICE_2DTRACER
114 ! CHARACTER PARAMS FOR TRACER
115 CHARACTER*(MAX_LEN_FNAM) STREAMICETrac2DBCxFile
116 CHARACTER*(MAX_LEN_FNAM) STREAMICETrac2DBCyFile
117 CHARACTER*(MAX_LEN_FNAM) STREAMICETrac2DinitFile
118 #endif
119
120 COMMON /STREAMICE_PARM_C/
121 & STREAMICEthickInit,
122 & STREAMICEthickFile,
123 & STREAMICEcalveMaskFile,
124 & STREAMICEsigcoordInit,
125 & STREAMICEsigcoordFile,
126 & STREAMICEdelsigFile,
127 & STREAMICEbasalTracConfig,
128 & STREAMICEbasalTracFile,
129 & STREAMICEvelOptimFile,
130 & STREAMICEtopogFile,
131 & STREAMICEhmaskFile,
132 & STREAMICEHBCxFile,
133 & STREAMICEHBCyFile,
134 & STREAMICEuFaceBdryFile,
135 & STREAMICEvFaceBdryFile,
136 & STREAMICEuDirichValsFile,
137 & STREAMICEvDirichValsFile,
138 & STREAMICEGlenConstFile,
139 & STREAMICEGlenConstConfig,
140 & STREAMICEcostMaskFile,
141 & STREAMICE_ADV_SCHEME
142
143 #ifdef ALLOW_PETSC
144 COMMON /PETSC_PARM_C/
145 & PETSC_SOLVER_TYPE,
146 & PETSC_PRECOND_TYPE
147 #endif
148
149 #ifdef ALLOW_STREAMICE_2DTRACER
150 COMMON /STREAMICE_TRAC2D_C/
151 & STREAMICETrac2DBCxFile,
152 & STREAMICETrac2DBCyFile,
153 & STREAMICETrac2DinitFile
154 #endif
155
156 C -------------------------- LOGICAL PARAMS ---------------------------------------------------
157
158 LOGICAL STREAMICEison
159 LOGICAL STREAMICE_dump_mdsio
160 LOGICAL STREAMICE_tave_mdsio
161 LOGICAL STREAMICE_dump_mnc
162 LOGICAL STREAMICE_tave_mnc
163 LOGICAL STREAMICE_GL_regularize, STREAMICE_move_front
164 LOGICAL STREAMICE_calve_to_mask
165 LOGICAL STREAMICE_construct_matrix
166 LOGICAL STREAMICE_lower_cg_tol
167 LOGICAL STREAMICE_diagnostic_only
168 LOGICAL STREAMICE_ppm_driving_stress
169 LOGICAL STREAMICE_h_ctrl_const_surf
170
171 C The following parameters specify periodic boundary conditions.
172 C For now this will completely override all other boundary conditions
173 C and apply to the entire boundary
174
175 LOGICAL STREAMICE_NS_periodic
176 LOGICAL STREAMICE_EW_periodic
177
178 C LOGICAL STREAMICE_hybrid_stress
179
180 COMMON /STREAMICE_PARM_L/
181 & STREAMICEison,
182 & STREAMICE_dump_mdsio, STREAMICE_tave_mdsio,
183 & STREAMICE_dump_mnc, STREAMICE_tave_mnc,
184 & STREAMICE_GL_regularize, STREAMICE_move_front,
185 & STREAMICE_calve_to_mask,
186 & STREAMICE_construct_matrix,
187 & STREAMICE_lower_cg_tol,
188 & STREAMICE_NS_periodic, STREAMICE_EW_periodic,
189 & STREAMICE_diagnostic_only,
190 & STREAMICE_ppm_driving_stress,
191 & STREAMICE_h_ctrl_const_surf
192
193 C -------------------------- AND NOW ARRAYS ---------------------------------------------------
194
195 C EXPLANATION OF MASKS
196
197 C STREAMICE_hmask VALUES 1=ice-covered cell
198 C 2=partially ice-covered cell (no dynamics)
199 C 0=ice-free cell (for now, it means the cell
200 C is treated as an open-ocean cell
201 C that ice shelf can flow into)
202 C -1=outside computational domain; will not change
203 C
204 C STREAMICE_umask VALUES 1=degree of freedom;
205 C 0=homogeneous dirich condition
206 C 3=inhomogeneous dirich condition
207
208 C STREAMICE_vmask similar to umask
209
210 C STREAMICE_ufacemask VALUES -1=unset,
211 C 0=no-flow boundary,
212 C 1=no-stress bdry
213 C 2=stress bdry condition,
214 C 3=inhomogeneous dirichlet boundary,
215 C 4=flux boundary: at these faces a flux will be specified by u_flux_bdry_SI
216 C
217 C STREAMICE_vfacemask similar to ufacemask
218 C STREAMICE_ufacemask_bdry field initialized at the beginning of simulation
219 C specified all ufacemask values except for calving front
220 C CONSTANT FOR A SIMULATION (ie not changes after streamice_init_fixed)
221 C STREAMICE_vfacemask_bdry CONSTANT FOR A SIMULATION
222 C STREAMICE_calve_mask specified allowed extent of ice shelf
223 C (should be integer, but don't know howvi sre to read ints from file)
224 C not necessarily used, but CONSTANT FOR A SIMULATION
225 C STREAMICE_float_cond will only be used if partial floatation is implemented
226
227 C Short arrays (e.g. masks)
228 COMMON /STREAMICE_FIELDS_RS/
229 & STREAMICE_hmask,
230 & STREAMICE_umask,
231 & STREAMICE_vmask,
232 & STREAMICE_ufacemask,
233 & STREAMICE_vfacemask,
234 & STREAMICE_ufacemask_bdry,
235 & STREAMICE_vfacemask_bdry,
236 & STREAMICE_float_cond,
237 & STREAMICE_calve_mask,
238 & STREAMICE_ctrl_mask,
239 & STREAMICE_cost_mask
240 _RS STREAMICE_hmask (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
241 _RS STREAMICE_umask (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
242 _RS STREAMICE_vmask (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
243 _RS STREAMICE_ufacemask
244 & (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
245 _RS STREAMICE_vfacemask
246 & (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
247 _RS STREAMICE_ufacemask_bdry
248 & (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
249 _RS STREAMICE_vfacemask_bdry
250 & (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
251 _RS STREAMICE_float_cond
252 & (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
253 _RS STREAMICE_calve_mask
254 & (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
255 _RS STREAMICE_ctrl_mask
256 & (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
257 _RS STREAMICE_cost_mask
258 & (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
259
260 C NOTES :
261 C STREAMICE_ufacemask_bdry, STREAMICE_vfacemask_bdry ARE CONSTANT (FIXED)
262 C STREAMICE_hmask IS PART OF **STATE**
263 C All other masks are updated within a timestep BASED ON STREAMICE_hmask
264
265 C Number of quadrature points are hardcoded.. could turn into a CPP macro
266
267 C REAL ARRAYS
268
269 COMMON /STREAMICE_FIELDS_RL/
270 & H_streamice,
271 & U_streamice,
272 & V_streamice,
273 & visc_streamice,
274 & tau_beta_eff_streamice,
275 & float_frac_streamice,
276 & base_el_streamice,
277 & surf_el_streamice,
278 & area_shelf_streamice,
279 & mass_ice_streamice,
280 & u_flux_bdry_SI,
281 & v_flux_bdry_SI,
282 & h_ubdry_values_SI,
283 & h_vbdry_values_SI,
284 & u_bdry_values_SI,
285 & v_bdry_values_SI,
286 & STREAMICE_dummy_array,
287 & C_basal_friction,
288 ! & A_glen,
289 & B_glen,
290 & BDOT_streamice, ADOT_streamice, ! mass balances in meters per year
291 & streamice_sigma_coord, streamice_delsigma,
292 & H_streamice_prev
293
294 #ifdef STREAMICE_HYBRID_STRESS
295 COMMON /STREAMICE_HYBRID/
296 & streamice_taubx, streamice_tauby,
297 & streamice_u_surf, streamice_v_surf,
298 & visc_streamice_full, streamice_omega, streamice_basal_geom,
299 & streamice_vert_shear_uz, streamice_vert_shear_vz
300 #endif
301
302 #ifdef ALLOW_STREAMICE_2DTRACER
303 COMMON /STREAMICE_TRAC2D_FIELDS_RL/
304 & trac2d_ubdry_values_SI,
305 & trac2d_vbdry_values_SI,
306 & trac2d
307 #ifdef STREAMICE_TRACER_AB
308 COMMON /STREAMICE_TRAC2D_AB_RL/
309 & GAD_trac_2d
310 #endif
311 #endif
312
313 #ifdef USE_ALT_RLOW
314 COMMON /STREAMICE_RLOW/
315 & R_low_si
316 #endif
317
318
319 _RL H_streamice (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
320 _RL U_streamice (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
321 _RL V_streamice (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
322 _RL visc_streamice (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
323 _RL tau_beta_eff_streamice(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
324 _RL float_frac_streamice (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
325 _RL surf_el_streamice (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
326 _RL base_el_streamice (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
327 _RL area_shelf_streamice (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
328 _RL mass_ice_streamice (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
329 _RL u_flux_bdry_SI (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
330 _RL v_flux_bdry_SI (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
331 _RL h_ubdry_values_SI (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
332 _RL h_vbdry_values_SI (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
333 _RL u_bdry_values_SI (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
334 _RL v_bdry_values_SI (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
335 _RL C_basal_friction (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
336 ! _RL A_glen (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
337 _RL B_glen (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
338 _RL streamice_sigma_coord (Nr)
339 _RL streamice_delsigma (Nr)
340
341 #ifdef USE_ALT_RLOW
342 _RL R_low_si (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
343 #endif
344
345 C The following arrays are used for the hybrid stress balance
346 #ifdef STREAMICE_HYBRID_STRESS
347 _RL streamice_taubx (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
348 _RL streamice_tauby (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
349 _RL streamice_u_surf (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
350 _RL streamice_v_surf (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
351 _RL streamice_omega (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
352 _RL streamice_basal_geom
353 & (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
354 _RL visc_streamice_full
355 & (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
356 _RL streamice_vert_shear_uz (Nr)
357 _RL streamice_vert_shear_vz (Nr)
358 #endif
359
360 #ifdef ALLOW_STREAMICE_2DTRACER
361 _RL trac2d_ubdry_values_SI
362 & (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
363 _RL trac2d_vbdry_values_SI
364 & (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
365 _RL trac2d (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
366 #ifdef STREAMICE_TRACER_AB
367 _RL GAD_trac_2d (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
368 #endif
369 #endif
370
371 _RL ADOT_streamice (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
372 !! IMPORTANT: MELT RATE IN METERS PER YEAR
373 !! POSITIVE WHERE MELTING
374 _RL BDOT_streamice (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
375 _RL H_streamice_prev (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
376 _RL STREAMICE_dummy_array (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
377
378
379
380 COMMON /STREAMICE_COST_RL/
381 & cost_func1_streamice
382 _RL cost_func1_streamice(nSx,nSy)
383
384 C NOTES :
385 C REAL ARRAYS THAT COMPRISE "STATE":
386 C H_streamice,
387 C U_streamice,
388 C V_streamice,
389 C visc_streamice,
390 C tau_beta_eff_streamice,
391 C area_shelf_streamice
392 C (and don't forget STREAMICE_hmask)
393 C
394 C visc & tau are now calculated based on U,V in streamice_vel_solve
395 C but with Hybdrid stress formulation they will become part of
396 C velocity initial guess, so they are kept
397
398 #ifdef ALLOW_PETSC
399 COMMON /STREAMICE_PETSC_DOFS_COMMON/
400 & streamice_petsc_dofs_u,
401 & streamice_petsc_dofs_v,
402 & n_dofs_process
403 _RS streamice_petsc_dofs_u
404 & (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
405 _RS streamice_petsc_dofs_v
406 & (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
407 INTEGER n_dofs_process (0:nPx*nPy-1)
408 #endif
409
410
411 #endif /* ALLOW_STREAMICE */
412
413 CEH3 ;;; Local Variables: ***
414 CEH3 ;;; mode:fortran ***
415 CEH3 ;;; End: ***

  ViewVC Help
Powered by ViewVC 1.1.22