/[MITgcm]/MITgcm/model/inc/PARAMS.h
ViewVC logotype

Contents of /MITgcm/model/inc/PARAMS.h

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


Revision 1.40 - (show annotations) (download)
Wed Jul 28 16:32:03 1999 UTC (24 years, 9 months ago) by adcroft
Branch: MAIN
CVS Tags: checkpoint24
Changes since 1.39: +5 -2 lines
File MIME type: text/plain
Added a parameter "implicitViscosity" to separately control implicit
viscosity and diffusion.

1 C $Header: /u/gcmpack/models/MITgcmUV/model/inc/PARAMS.h,v 1.39 1999/06/29 18:33:21 adcroft Exp $
2 C
3 C /==========================================================\
4 C | PARAMS.h |
5 C | o Header file defining model "parameters". |
6 C |==========================================================|
7 C | The values from the model standard input file are |
8 C | stored into the variables held here. Notes describing |
9 C | the parameters can also be found here. |
10 C \==========================================================/
11
12 C Macros for special grid options
13 #include "PARAMS_MACROS.h"
14
15 C-- Contants
16 C Useful physical values
17 Real*8 PI
18 PARAMETER ( PI = 3.14159265358979323844D0 )
19 Real*8 deg2rad
20 PARAMETER ( deg2rad = 2.D0*PI/360.D0 )
21
22 C Symbolic values
23 C precXXXX - Used to indicate what precision to use for
24 C dumping model state.
25 INTEGER precFloat32
26 PARAMETER ( precFloat32 = 32 )
27 INTEGER precFloat64
28 PARAMETER ( precFloat64 = 64 )
29 C UNSET_xxx - Used to indicate variables that have not been given a value
30 Real*8 UNSET_FLOAT8
31 PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
32 Real*4 UNSET_FLOAT4
33 PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )
34 _RL UNSET_RL
35 PARAMETER ( UNSET_RL = 1.234567D5 )
36 _RS UNSET_RS
37 PARAMETER ( UNSET_RS = 1.234567E5 )
38 INTEGER UNSET_I
39 PARAMETER ( UNSET_I = 123456789 )
40
41 C Checkpoint data
42 INTEGER maxNoChkptLev
43 PARAMETER ( maxNoChkptLev = 2 )
44
45 C-- COMMON /PARM_C/ Character valued parameters used by the model.
46 C checkPtSuff - List of checkpoint file suffices
47 C bathyFile - File containing bathymetry. If not defined bathymetry
48 C is taken from inline function.
49 C hydrogThetaFile - File containing initial hydrographic data for potential
50 C temperature.
51 C hydrogSaltFile - File containing initial hydrographic data for salinity.
52 C zonalWindFile - File containing zonal wind data
53 C meridWindFile - File containing meridional wind data
54 C thetaClimFile - File containing theta climataology used
55 C in relaxation term -lambda(theta-theta*)
56 C saltClimFile - File containing salt climataology used
57 C in relaxation term -lambda(salt-salt*)
58 C surfQfile - File containing surface heat flux
59 C EmPmRfile - File containing surface fresh water flux
60 C buoyancyRelation - Flag used to indicate which relation to use to
61 C get buoyancy.
62 COMMON /PARM_C/ checkPtSuff,
63 & bathyFile, hydrogThetaFile, hydrogSaltFile,
64 & zonalWindFile, meridWindFile, thetaClimFile,
65 & saltClimFile, buoyancyRelation,
66 & EmPmRfile,surfQfile
67 CHARACTER*(5) checkPtSuff(maxNoChkptLev)
68 CHARACTER*(MAX_LEN_FNAM) bathyFile
69 CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
70 CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
71 CHARACTER*(MAX_LEN_FNAM) zonalWindFile
72 CHARACTER*(MAX_LEN_FNAM) meridWindFile
73 CHARACTER*(MAX_LEN_FNAM) thetaClimFile
74 CHARACTER*(MAX_LEN_FNAM) saltClimFile
75 CHARACTER*(MAX_LEN_FNAM) surfQfile
76 CHARACTER*(MAX_LEN_FNAM) EmPmRfile
77 CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
78
79 C-- COMMON /PARM_I/ Integer valued parameters used by the model.
80 C cg2dMaxIters - Maximum number of iterations in the
81 C two-dimensional con. grad solver.
82 C cg2dChkResFreq - Frequency with which to check residual
83 C in con. grad solver.
84 C cg3dMaxIters - Maximum number of iterations in the
85 C three-dimensional con. grad solver.
86 C cg3dChkResFreq - Frequency with which to check residual
87 C in con. grad solver.
88 C nIter0 - Start time-step number of for this run
89 C nTimeSteps - Number of timesteps to execute
90 C numStepsPerPickup - For offline setup. Frequency of pickup
91 C of flow fields.
92 C writeStatePrec - Precision used for writing model state.
93 C writeBinaryPrec - Precision used for writing binary files
94 C readBinaryPrec - Precision used for reading binary files
95 C nCheckLev - Holds current checkpoint level
96 C nShap - "Order" of shapiro filter to apply to
97 C model prognositic fields.
98 C nShap == 1 => del2
99 C nShap == 2 => del4
100 C nShap == 3 => del6
101 C etc...
102
103 COMMON /PARM_I/
104 & cg2dMaxIters,
105 & cg2dChkResFreq,
106 & cg3dMaxIters,
107 & cg3dChkResFreq,
108 & nIter0, nTimeSteps,
109 & numStepsPerPickup,
110 & writeStatePrec, nCheckLev,
111 & writeBinaryPrec, readBinaryPrec,
112 & nShap
113 INTEGER cg2dMaxIters
114 INTEGER cg2dChkResFreq
115 INTEGER cg3dMaxIters
116 INTEGER cg3dChkResFreq
117 INTEGER nIter0
118 INTEGER nTimeSteps
119 INTEGER numStepsPerPickup
120 INTEGER writeStatePrec
121 INTEGER writeBinaryPrec
122 INTEGER readBinaryPrec
123 INTEGER nCheckLev
124 INTEGER nShap
125
126 C-- COMMON /PARM_L/ Logical valued parameters used by the model.
127 C usingCartesianGrid - If TRUE grid generation will be in a cartesian
128 C coordinate frame.
129 C usingSphericalPolarGrid - If TRUE grid generation will be in a
130 C spherical polar frame.
131 C no_slip_sides - Impose "no-slip" at lateral boundaries.
132 C no_slip_bottom- Impose "no-slip" at bottom boundary.
133 C momViscosity - Flag which turns momentum friction terms on and off.
134 C momAdvection - Flag which turns advection of momentum on and off.
135 C momForcing - Flag which turns external forcing of momentum on
136 C and off.
137 C momPressureForcing - Flag which turns pressure term in momentum equation
138 C on and off.
139 C metricTerms - Flag which turns metric terms on or off.
140 C usingSphericalPolarMTerms - If TRUE use spherical polar metric terms.
141 C useCoriolis - Flag which turns the coriolis terms on and off.
142 C tempDiffusion - Flag which turns diffusion of temperature on
143 C and off.
144 C tempAdvection - Flag which turns advection of temperature on
145 C and off.
146 C tempForcing - Flag which turns external forcing of temperature on
147 C and off.
148 C saltDiffusion - Flag which turns diffusion of salinit on
149 C and off.
150 C saltAdvection - Flag which turns advection of salinit on
151 C and off.
152 C saltForcing - Flag which turns external forcing of salinit on
153 C and off.
154 C implicitFreeSurface - Set to true to use implcit free surface
155 C rigidLid - Set to true to use rigid lid
156 C momStepping - Turns momentum equation time-stepping off
157 C tempStepping - Turns temperature equation time-stepping off
158 C saltStepping - Turns salinity equation time-stepping off
159 C useConstantF - Coriolis parameter set to f0
160 C useBetaPlaneF - Coriolis parameter set to f0 + beta.y
161 C useSphereF - Coriolis parameter set to 2.omega.sin(phi)
162 C implicitDiffusion - Turns implicit vertical diffusion on
163 C implicitViscosity - Turns implicit vertical viscosity on
164 C doThetaClimRelax - Set true if relaxation to temperature
165 C climatology is required.
166 C doSaltClimRelax - Set true if relaxation to salinity
167 C climatology is required.
168 C periodicExternalForcing - Set true if forcing is time-dependant
169 C usingPCoords - Set to indicate that we are working in pressure
170 C coords.
171 C usingZCoords - Set to indicate that we are working in height
172 C coords.
173 C openBoundaries - Using open-boundaries
174 C nonHydrostatic - Using non-hydrostatic terms
175 C globalFiles - Selects between "global" and "tiled" files
176 C allowFreezing - Allows water to freeze and form ice
177 COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
178 & no_slip_sides,no_slip_bottom,
179 & momViscosity, momAdvection, momForcing, useCoriolis,
180 & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,
181 & saltDiffusion, saltAdvection, saltForcing,
182 & implicitFreeSurface, rigidLid,
183 & momStepping, tempStepping, saltStepping,
184 & metricTerms, usingSphericalPolarMTerms,
185 & useConstantF, useBetaPlaneF, useSphereF,
186 & implicitDiffusion, implicitViscosity,
187 & doThetaClimRelax, doSaltClimRelax,
188 & periodicExternalForcing, usingPCoords, usingZCoords,
189 & openBoundaries, nonHydrostatic, globalFiles,
190 & allowFreezing
191 LOGICAL usingCartesianGrid
192 LOGICAL usingSphericalPolarGrid
193 LOGICAL usingSphericalPolarMTerms
194 LOGICAL no_slip_sides
195 LOGICAL no_slip_bottom
196 LOGICAL momViscosity
197 LOGICAL momAdvection
198 LOGICAL momForcing
199 LOGICAL momPressureForcing
200 LOGICAL useCoriolis
201 LOGICAL tempDiffusion
202 LOGICAL tempAdvection
203 LOGICAL tempForcing
204 LOGICAL saltDiffusion
205 LOGICAL saltAdvection
206 LOGICAL saltForcing
207 LOGICAL implicitFreeSurface
208 LOGICAL rigidLid
209 LOGICAL momStepping
210 LOGICAL tempStepping
211 LOGICAL saltStepping
212 LOGICAL metricTerms
213 LOGICAL useConstantF
214 LOGICAL useBetaPlaneF
215 LOGICAL useSphereF
216 LOGICAL implicitDiffusion
217 LOGICAL implicitViscosity
218 LOGICAL doThetaClimRelax
219 LOGICAL doSaltClimRelax
220 LOGICAL periodicExternalForcing
221 LOGICAL usingPCoords
222 LOGICAL usingZCoords
223 LOGICAL openBoundaries
224 LOGICAL nonHydrostatic
225 LOGICAL globalFiles
226 LOGICAL allowFreezing
227
228 C-- COMMON /PARM_R/ "Real" valued parameters used by the model.
229 C cg2dTargetResidual
230 C - Target residual for cg2d solver.
231 C cg3dTargetResidual
232 C - Target residual for cg3d solver.
233 C cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.
234 C Note. 20th May 1998
235 C I made a weird discovery! In the model paper we argue
236 C for the form of the preconditioner used here ( see
237 C A Finite-volume, Incompressible Navier-Stokes Model
238 C ...., Marshall et. al ). The algebra gives a simple
239 C 0.5 factor for the averaging of ac and aCw to get a
240 C symmettric pre-conditioner. By using a factor of 0.51
241 C i.e. scaling the off-diagonal terms in the
242 C preconditioner down slightly I managed to get the
243 C number of iterations for convergence in a test case to
244 C drop form 192 -> 134! Need to investigate this further!
245 C For now I have introduced a parameter cg2dpcOffDFac which
246 C defaults to 0.51 but can be set at runtime.
247 C delP - Vertical grid spacing ( Pa ).
248 C delZ - Vertical grid spacing ( m ).
249 C delR - Vertical grid spacing ( units of r ).
250 C delX - Separation between cell faces (m) or (deg), depending
251 C delY on input flags.
252 C gravity - Accel. due to gravity ( m/s^2 )
253 C recip_gravity and its inverse
254 C gBaro - Accel. due to gravity used in barotropic equation ( m/s^2 )
255 C ronil - Reference density
256 C rhoConst - Vertically constant reference density
257 C startTime - Start time for model ( s )
258 C phiMin - Latitude of southern most cell face.
259 C thetaMin - Longitude of western most cell face (this
260 C is an "inert" parameter but it is included
261 C to make geographical references simple.)
262 C rSphere - Radius of sphere for a spherical polar grid ( m ).
263 C recip_RSphere - Reciprocal radius of sphere ( m ).
264 C f0 - Reference coriolis parameter ( 1/s )
265 C ( Southern edge f for beta plane )
266 C beta - df/dy ( s^-1.m^-1 )
267 C omega - Angular velocity ( rad/s )
268 C viscAh - Eddy viscosity coeff. for mixing of
269 C momentum laterally ( m^2/s )
270 C viscAz - Eddy viscosity coeff. for mixing of
271 C momentum vertically ( m^2/s )
272 C viscAp - Eddy viscosity coeff. for mixing of
273 C momentum vertically ( Pa^2/s )
274 C viscAr - Eddy viscosity coeff. for mixing of
275 C momentum vertically ( units of r^2/s )
276 C viscA4 - Biharmonic viscosity coeff. for mixing of
277 C momentum laterally ( m^4/s )
278 C diffKhT - Laplacian diffusion coeff. for mixing of
279 C heat laterally ( m^2/s )
280 C diffKzT - Laplacian diffusion coeff. for mixing of
281 C heat vertically ( m^2/s )
282 C diffKpT - Laplacian diffusion coeff. for mixing of
283 C heat vertically ( Pa^2/s )
284 C diffKrT - Laplacian diffusion coeff. for mixing of
285 C heat vertically ( units of r^2/s )
286 C diffK4T - Biharmonic diffusion coeff. for mixing of
287 C heat laterally ( m^4/s )
288 C diffKhS - Laplacian diffusion coeff. for mixing of
289 C salt laterally ( m^2/s )
290 C diffKzS - Laplacian diffusion coeff. for mixing of
291 C salt vertically ( m^2/s )
292 C diffKpS - Laplacian diffusion coeff. for mixing of
293 C salt vertically ( Pa^2/s )
294 C diffKrS - Laplacian diffusion coeff. for mixing of
295 C salt vertically ( units of r^2/s )
296 C diffK4S - Biharmonic diffusion coeff. for mixing of
297 C salt laterally ( m^4/s )
298 C deltaT - Default timestep ( s )
299 C deltaTClock - Timestep used as model "clock". This determines the
300 C IO frequencies and is used in tagging output. It can
301 C be totally different to the dynamical time. Typically
302 C it will be the deep-water timestep for accelerated runs.
303 C Frequency of checkpointing and dumping of the model state
304 C are referenced to this clock. ( s )
305 C deltaTMom - Timestep for momemtum equations ( s )
306 C deltaTtracer - Timestep for tracer equations ( s )
307 C freesurfFac - Parameter to turn implicit free surface term on or off
308 C freesurfac = 1. uses implicit free surface
309 C freesurfac = 0. uses rigid lid
310 C hFacMin - Minimum fraction size of a cell (affects hFacC etc...)
311 C hFacMinDz - Minimum dimesional size of a cell (affects hFacC etc..., m)
312 C hFacMinDp - Minimum dimesional size of a cell (affects hFacC etc..., Pa)
313 C hFacMinDr - Minimum dimesional size of a cell (affects hFacC etc..., units of r)
314 C tauCD - CD scheme coupling timescale ( 1/s )
315 C rCD - CD scheme normalised coupling parameter ( 0-1 )
316 C GMmaxslope - max. slope allowed in GM/Redi tensor
317 C GMlength - Length to use in Visbeck et al. formula for K (m)
318 C GMalpha - alpha to use in Visbeck et al. formula for K
319 C GMdepth - Depth over which to integrate Richardson # (Visbeck et al.)
320 C GMkbackground - background value of GM/Redi diffusion coefficient ( m^2/s )
321 C GMmaxval - max. value of KapGM allowed in GM/Redi scheme ( m^2/s )
322 C startTime - Starting time for this integration ( s ).
323 C endTime - Ending time for this integration ( s ).
324 C chkPtFreq - Frequency of rolling check pointing ( s ).
325 C pChkPtFreq - Frequency of permanent check pointing ( s ).
326 C dumpFreq - Frequency with which model state is written to
327 C post-processing files ( s ).
328 C afFacMom - Advection of momentum term tracer parameter
329 C vfFacMom - Momentum viscosity tracer parameter
330 C pfFacMom - Momentum pressure forcing tracer parameter
331 C cfFacMom - Coriolis term tracer parameter
332 C foFacMom - Momentum forcing tracer parameter
333 C mtFacMom - Metric terms tracer parameter
334 C cosPower - Power of cosine of latitude to multiply viscosity
335 C cAdjFreq - Frequency of convective adjustment
336 C
337 C taveFreq - Frequency with which time-averaged model state is written to
338 C post-processing files ( s ).
339 C tauThetaClimRelax - Relaxation to climatology time scale ( s ).
340 C lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).
341 C tauSaltClimRelax - Relaxation to climatology time scale ( s ).
342 C lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).
343 C externForcingPeriod - Is the period of which forcing varies (eg. 1 month)
344 C externForcingCycle - Is the repeat time of the forcing (eg. 1 year)
345 C (note: externForcingCycle must be an integer
346 C number times externForcingPeriod)
347 C horiVertRatio - Ratio on units in vertical to units in horizontal.
348 C recip_horiVertRatio ( 1 if horiz in m and vertical in m ).
349 C ( g*rho if horiz in m and vertical in Pa ).
350 C latFFTFiltLo - Low latitude for FFT filtering of latitude
351 C circles ( see filter*.F )
352 COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,
353 & cg3dTargetResidual,
354 & delP, delZ, delR, delX, delY,
355 & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,
356 & phiMin, thetaMin, rSphere, recip_RSphere, f0, fCori, beta,
357 & viscAh, viscAz, viscA4, viscAr,
358 & diffKhT, diffKzT, diffK4T, diffKrT,
359 & diffKhS, diffKzS, diffK4S, diffKrS,
360 & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,
361 & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,
362 & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
363 & recip_rhoConst, rhoConst, tRef, sRef,
364 & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
365 & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
366 & cosPower,
367 & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
368 & tauSaltClimRelax, lambdaSaltClimRelax,
369 & externForcingCycle, externForcingPeriod,
370 & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
371 & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
372 & latFFTFiltLo
373
374 _RL cg2dTargetResidual
375 _RL cg3dTargetResidual
376 _RL cg2dpcOffDFac
377 _RL delZ(Nr)
378 _RL delP(Nr)
379 _RL delR(Nr)
380 _RL delX(Nx)
381 _RL delY(Ny)
382 _RL deltaT
383 _RL deltaTClock
384 _RL deltaTmom
385 _RL deltaTtracer
386 _RL abeps
387 _RL phiMin
388 _RL thetaMin
389 _RL rSphere
390 _RL recip_RSphere
391 _RL f0
392 _RL freeSurfFac
393 _RL hFacMin
394 _RL hFacMinDz
395 _RL hFacMinDp
396 _RL hFacMinDr
397 _RL beta
398 _RL viscAh
399 _RL viscAz
400 _RL viscAp
401 _RL viscAr
402 _RL viscA4
403 _RL diffKhT
404 _RL diffKrT
405 _RL diffKzT
406 _RL diffKpT
407 _RL diffK4T
408 _RL diffKhS
409 _RL diffKrS
410 _RL diffKzS
411 _RL diffKpS
412 _RL diffK4S
413 _RL delt
414 _RL tauCD
415 _RL rCD
416 _RL GMmaxslope
417 _RL GMlength
418 _RL GMalpha
419 _RL GMdepth
420 _RL GMkbackground
421 _RL GMmaxval
422 _RL gravity
423 _RL recip_gravity
424 _RL gBaro
425 _RL rhonil
426 _RL recip_rhonil
427 _RL rhoConst
428 _RL recip_rhoConst
429 _RL specVol_S(Nr)
430 _RL tRef(Nr)
431 _RL theta_S(Nr)
432 _RL sRef(Nr)
433 _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
434 _RL startTime
435 _RL endTime
436 _RL chkPtFreq
437 _RL pChkPtFreq
438 _RL dumpFreq
439 _RL taveFreq
440 _RL afFacMom
441 _RL vfFacMom
442 _RL pfFacMom
443 _RL cfFacMom
444 _RL foFacMom
445 _RL mTFacMom
446 _RL cosPower
447 _RL cAdjFreq
448 _RL omega
449 _RL tauThetaClimRelax
450 _RL lambdaThetaClimRelax
451 _RL tauSaltClimRelax
452 _RL lambdaSaltClimRelax
453 _RL externForcingCycle
454 _RL externForcingPeriod
455 _RL horiVertRatio
456 _RL recip_horiVertRatio
457 _RL latFFTFiltLo
458
459 COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
460 & Lamba_theta
461 _RL HeatCapacity_Cp
462 _RL Lamba_theta
463 _RL recip_Cp
464
465 C Equation of State (polynomial coeffients)
466 COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
467 _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)
468 C Linear equation of state
469 C tAlpha - Linear EOS thermal expansion coefficient ( 1/degree ).
470 C sBeta - Linear EOS haline contraction coefficient.
471 COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
472 _RL tAlpha
473 _RL sBeta
474 character*(6) eosType
475
476 C These are input arrays (of integers) that contain the *absolute*
477 C computational index of an open-boundary (OB) point.
478 C A zero (0) element means there is no corresponding OB in that column/row.
479 C The computational coordinate refers to "tracer" cells.
480 C For a northern/southern OB, the OB V point is to the south/north.
481 C For an eastern/western OB, the OB U point is to the west/east.
482 C eg.
483 C OB_Jnorth(3)=34 means that:
484 C T( 3 ,34) is a an OB point
485 C U(3:4,34) is a an OB point
486 C V( 4 ,34) is a an OB point
487 C while
488 C OB_Jsouth(3)=1 means that:
489 C T( 3 ,1) is a an OB point
490 C U(3:4,1) is a an OB point
491 C V( 4 ,2) is a an OB point
492 C
493 C For convenience, negative values for Jnorth/Ieast refer to
494 C points relative to the Northern/Eastern edges of the model
495 C eg. OB_Jnorth(3)=-1 means that the point (3,Ny-1) is a northern O-B.
496 C
497 COMMON /PARM_OB/
498 & OB_Jnorth,OB_Jsouth,OB_Ieast,OB_Iwest
499 INTEGER OB_Jnorth(Nx)
500 INTEGER OB_Jsouth(Nx)
501 INTEGER OB_Ieast(Ny)
502 INTEGER OB_Iwest(Ny)

  ViewVC Help
Powered by ViewVC 1.1.22