/[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.39 - (show annotations) (download)
Tue Jun 29 18:33:21 1999 UTC (24 years, 10 months ago) by adcroft
Branch: MAIN
Changes since 1.38: +4 -1 lines
File MIME type: text/plain
Added COS(latitude)^cosPower dependence to viscosity terms.
New parameter "cosPower" defaults to 0.0 which removes latitudinal
dependence.

1 C $Header: /u/gcmpack/models/MITgcmUV/model/inc/PARAMS.h,v 1.38 1999/05/05 18:32:34 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 doThetaClimRelax - Set true if relaxation to temperature
164 C climatology is required.
165 C doSaltClimRelax - Set true if relaxation to salinity
166 C climatology is required.
167 C periodicExternalForcing - Set true if forcing is time-dependant
168 C usingPCoords - Set to indicate that we are working in pressure
169 C coords.
170 C usingZCoords - Set to indicate that we are working in height
171 C coords.
172 C openBoundaries - Using open-boundaries
173 C nonHydrostatic - Using non-hydrostatic terms
174 C globalFiles - Selects between "global" and "tiled" files
175 C allowFreezing - Allows water to freeze and form ice
176 COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
177 & no_slip_sides,no_slip_bottom,
178 & momViscosity, momAdvection, momForcing, useCoriolis,
179 & momPressureForcing,tempDiffusion, tempAdvection, tempForcing,
180 & saltDiffusion, saltAdvection, saltForcing,
181 & implicitFreeSurface, rigidLid,
182 & momStepping, tempStepping, saltStepping,
183 & metricTerms, usingSphericalPolarMTerms,
184 & useConstantF, useBetaPlaneF, useSphereF,
185 & implicitDiffusion, doThetaClimRelax, doSaltClimRelax,
186 & periodicExternalForcing, usingPCoords, usingZCoords,
187 & openBoundaries, nonHydrostatic, globalFiles,
188 & allowFreezing
189 LOGICAL usingCartesianGrid
190 LOGICAL usingSphericalPolarGrid
191 LOGICAL usingSphericalPolarMTerms
192 LOGICAL no_slip_sides
193 LOGICAL no_slip_bottom
194 LOGICAL momViscosity
195 LOGICAL momAdvection
196 LOGICAL momForcing
197 LOGICAL momPressureForcing
198 LOGICAL useCoriolis
199 LOGICAL tempDiffusion
200 LOGICAL tempAdvection
201 LOGICAL tempForcing
202 LOGICAL saltDiffusion
203 LOGICAL saltAdvection
204 LOGICAL saltForcing
205 LOGICAL implicitFreeSurface
206 LOGICAL rigidLid
207 LOGICAL momStepping
208 LOGICAL tempStepping
209 LOGICAL saltStepping
210 LOGICAL metricTerms
211 LOGICAL useConstantF
212 LOGICAL useBetaPlaneF
213 LOGICAL useSphereF
214 LOGICAL implicitDiffusion
215 LOGICAL doThetaClimRelax
216 LOGICAL doSaltClimRelax
217 LOGICAL periodicExternalForcing
218 LOGICAL usingPCoords
219 LOGICAL usingZCoords
220 LOGICAL openBoundaries
221 LOGICAL nonHydrostatic
222 LOGICAL globalFiles
223 LOGICAL allowFreezing
224
225 C-- COMMON /PARM_R/ "Real" valued parameters used by the model.
226 C cg2dTargetResidual
227 C - Target residual for cg2d solver.
228 C cg3dTargetResidual
229 C - Target residual for cg3d solver.
230 C cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.
231 C Note. 20th May 1998
232 C I made a weird discovery! In the model paper we argue
233 C for the form of the preconditioner used here ( see
234 C A Finite-volume, Incompressible Navier-Stokes Model
235 C ...., Marshall et. al ). The algebra gives a simple
236 C 0.5 factor for the averaging of ac and aCw to get a
237 C symmettric pre-conditioner. By using a factor of 0.51
238 C i.e. scaling the off-diagonal terms in the
239 C preconditioner down slightly I managed to get the
240 C number of iterations for convergence in a test case to
241 C drop form 192 -> 134! Need to investigate this further!
242 C For now I have introduced a parameter cg2dpcOffDFac which
243 C defaults to 0.51 but can be set at runtime.
244 C delP - Vertical grid spacing ( Pa ).
245 C delZ - Vertical grid spacing ( m ).
246 C delR - Vertical grid spacing ( units of r ).
247 C delX - Separation between cell faces (m) or (deg), depending
248 C delY on input flags.
249 C gravity - Accel. due to gravity ( m/s^2 )
250 C recip_gravity and its inverse
251 C gBaro - Accel. due to gravity used in barotropic equation ( m/s^2 )
252 C ronil - Reference density
253 C rhoConst - Vertically constant reference density
254 C startTime - Start time for model ( s )
255 C phiMin - Latitude of southern most cell face.
256 C thetaMin - Longitude of western most cell face (this
257 C is an "inert" parameter but it is included
258 C to make geographical references simple.)
259 C rSphere - Radius of sphere for a spherical polar grid ( m ).
260 C recip_RSphere - Reciprocal radius of sphere ( m ).
261 C f0 - Reference coriolis parameter ( 1/s )
262 C ( Southern edge f for beta plane )
263 C beta - df/dy ( s^-1.m^-1 )
264 C omega - Angular velocity ( rad/s )
265 C viscAh - Eddy viscosity coeff. for mixing of
266 C momentum laterally ( m^2/s )
267 C viscAz - Eddy viscosity coeff. for mixing of
268 C momentum vertically ( m^2/s )
269 C viscAp - Eddy viscosity coeff. for mixing of
270 C momentum vertically ( Pa^2/s )
271 C viscAr - Eddy viscosity coeff. for mixing of
272 C momentum vertically ( units of r^2/s )
273 C viscA4 - Biharmonic viscosity coeff. for mixing of
274 C momentum laterally ( m^4/s )
275 C diffKhT - Laplacian diffusion coeff. for mixing of
276 C heat laterally ( m^2/s )
277 C diffKzT - Laplacian diffusion coeff. for mixing of
278 C heat vertically ( m^2/s )
279 C diffKpT - Laplacian diffusion coeff. for mixing of
280 C heat vertically ( Pa^2/s )
281 C diffKrT - Laplacian diffusion coeff. for mixing of
282 C heat vertically ( units of r^2/s )
283 C diffK4T - Biharmonic diffusion coeff. for mixing of
284 C heat laterally ( m^4/s )
285 C diffKhS - Laplacian diffusion coeff. for mixing of
286 C salt laterally ( m^2/s )
287 C diffKzS - Laplacian diffusion coeff. for mixing of
288 C salt vertically ( m^2/s )
289 C diffKpS - Laplacian diffusion coeff. for mixing of
290 C salt vertically ( Pa^2/s )
291 C diffKrS - Laplacian diffusion coeff. for mixing of
292 C salt vertically ( units of r^2/s )
293 C diffK4S - Biharmonic diffusion coeff. for mixing of
294 C salt laterally ( m^4/s )
295 C deltaT - Default timestep ( s )
296 C deltaTClock - Timestep used as model "clock". This determines the
297 C IO frequencies and is used in tagging output. It can
298 C be totally different to the dynamical time. Typically
299 C it will be the deep-water timestep for accelerated runs.
300 C Frequency of checkpointing and dumping of the model state
301 C are referenced to this clock. ( s )
302 C deltaTMom - Timestep for momemtum equations ( s )
303 C deltaTtracer - Timestep for tracer equations ( s )
304 C freesurfFac - Parameter to turn implicit free surface term on or off
305 C freesurfac = 1. uses implicit free surface
306 C freesurfac = 0. uses rigid lid
307 C hFacMin - Minimum fraction size of a cell (affects hFacC etc...)
308 C hFacMinDz - Minimum dimesional size of a cell (affects hFacC etc..., m)
309 C hFacMinDp - Minimum dimesional size of a cell (affects hFacC etc..., Pa)
310 C hFacMinDr - Minimum dimesional size of a cell (affects hFacC etc..., units of r)
311 C tauCD - CD scheme coupling timescale ( 1/s )
312 C rCD - CD scheme normalised coupling parameter ( 0-1 )
313 C GMmaxslope - max. slope allowed in GM/Redi tensor
314 C GMlength - Length to use in Visbeck et al. formula for K (m)
315 C GMalpha - alpha to use in Visbeck et al. formula for K
316 C GMdepth - Depth over which to integrate Richardson # (Visbeck et al.)
317 C GMkbackground - background value of GM/Redi diffusion coefficient ( m^2/s )
318 C GMmaxval - max. value of KapGM allowed in GM/Redi scheme ( m^2/s )
319 C startTime - Starting time for this integration ( s ).
320 C endTime - Ending time for this integration ( s ).
321 C chkPtFreq - Frequency of rolling check pointing ( s ).
322 C pChkPtFreq - Frequency of permanent check pointing ( s ).
323 C dumpFreq - Frequency with which model state is written to
324 C post-processing files ( s ).
325 C afFacMom - Advection of momentum term tracer parameter
326 C vfFacMom - Momentum viscosity tracer parameter
327 C pfFacMom - Momentum pressure forcing tracer parameter
328 C cfFacMom - Coriolis term tracer parameter
329 C foFacMom - Momentum forcing tracer parameter
330 C mtFacMom - Metric terms tracer parameter
331 C cosPower - Power of cosine of latitude to multiply viscosity
332 C cAdjFreq - Frequency of convective adjustment
333 C
334 C taveFreq - Frequency with which time-averaged model state is written to
335 C post-processing files ( s ).
336 C tauThetaClimRelax - Relaxation to climatology time scale ( s ).
337 C lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ).
338 C tauSaltClimRelax - Relaxation to climatology time scale ( s ).
339 C lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ).
340 C externForcingPeriod - Is the period of which forcing varies (eg. 1 month)
341 C externForcingCycle - Is the repeat time of the forcing (eg. 1 year)
342 C (note: externForcingCycle must be an integer
343 C number times externForcingPeriod)
344 C horiVertRatio - Ratio on units in vertical to units in horizontal.
345 C recip_horiVertRatio ( 1 if horiz in m and vertical in m ).
346 C ( g*rho if horiz in m and vertical in Pa ).
347 C latFFTFiltLo - Low latitude for FFT filtering of latitude
348 C circles ( see filter*.F )
349 COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac,
350 & cg3dTargetResidual,
351 & delP, delZ, delR, delX, delY,
352 & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,
353 & phiMin, thetaMin, rSphere, recip_RSphere, f0, fCori, beta,
354 & viscAh, viscAz, viscA4, viscAr,
355 & diffKhT, diffKzT, diffK4T, diffKrT,
356 & diffKhS, diffKzS, diffK4S, diffKrS,
357 & delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz,
358 & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval,
359 & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
360 & recip_rhoConst, rhoConst, tRef, sRef,
361 & endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq,
362 & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
363 & cosPower,
364 & cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax,
365 & tauSaltClimRelax, lambdaSaltClimRelax,
366 & externForcingCycle, externForcingPeriod,
367 & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
368 & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,
369 & latFFTFiltLo
370
371 _RL cg2dTargetResidual
372 _RL cg3dTargetResidual
373 _RL cg2dpcOffDFac
374 _RL delZ(Nr)
375 _RL delP(Nr)
376 _RL delR(Nr)
377 _RL delX(Nx)
378 _RL delY(Ny)
379 _RL deltaT
380 _RL deltaTClock
381 _RL deltaTmom
382 _RL deltaTtracer
383 _RL abeps
384 _RL phiMin
385 _RL thetaMin
386 _RL rSphere
387 _RL recip_RSphere
388 _RL f0
389 _RL freeSurfFac
390 _RL hFacMin
391 _RL hFacMinDz
392 _RL hFacMinDp
393 _RL hFacMinDr
394 _RL beta
395 _RL viscAh
396 _RL viscAz
397 _RL viscAp
398 _RL viscAr
399 _RL viscA4
400 _RL diffKhT
401 _RL diffKrT
402 _RL diffKzT
403 _RL diffKpT
404 _RL diffK4T
405 _RL diffKhS
406 _RL diffKrS
407 _RL diffKzS
408 _RL diffKpS
409 _RL diffK4S
410 _RL delt
411 _RL tauCD
412 _RL rCD
413 _RL GMmaxslope
414 _RL GMlength
415 _RL GMalpha
416 _RL GMdepth
417 _RL GMkbackground
418 _RL GMmaxval
419 _RL gravity
420 _RL recip_gravity
421 _RL gBaro
422 _RL rhonil
423 _RL recip_rhonil
424 _RL rhoConst
425 _RL recip_rhoConst
426 _RL specVol_S(Nr)
427 _RL tRef(Nr)
428 _RL theta_S(Nr)
429 _RL sRef(Nr)
430 _RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
431 _RL startTime
432 _RL endTime
433 _RL chkPtFreq
434 _RL pChkPtFreq
435 _RL dumpFreq
436 _RL taveFreq
437 _RL afFacMom
438 _RL vfFacMom
439 _RL pfFacMom
440 _RL cfFacMom
441 _RL foFacMom
442 _RL mTFacMom
443 _RL cosPower
444 _RL cAdjFreq
445 _RL omega
446 _RL tauThetaClimRelax
447 _RL lambdaThetaClimRelax
448 _RL tauSaltClimRelax
449 _RL lambdaSaltClimRelax
450 _RL externForcingCycle
451 _RL externForcingPeriod
452 _RL horiVertRatio
453 _RL recip_horiVertRatio
454 _RL latFFTFiltLo
455
456 COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
457 & Lamba_theta
458 _RL HeatCapacity_Cp
459 _RL Lamba_theta
460 _RL recip_Cp
461
462 C Equation of State (polynomial coeffients)
463 COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
464 _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)
465 C Linear equation of state
466 C tAlpha - Linear EOS thermal expansion coefficient ( 1/degree ).
467 C sBeta - Linear EOS haline contraction coefficient.
468 COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
469 _RL tAlpha
470 _RL sBeta
471 character*(6) eosType
472
473 C These are input arrays (of integers) that contain the *absolute*
474 C computational index of an open-boundary (OB) point.
475 C A zero (0) element means there is no corresponding OB in that column/row.
476 C The computational coordinate refers to "tracer" cells.
477 C For a northern/southern OB, the OB V point is to the south/north.
478 C For an eastern/western OB, the OB U point is to the west/east.
479 C eg.
480 C OB_Jnorth(3)=34 means that:
481 C T( 3 ,34) is a an OB point
482 C U(3:4,34) is a an OB point
483 C V( 4 ,34) is a an OB point
484 C while
485 C OB_Jsouth(3)=1 means that:
486 C T( 3 ,1) is a an OB point
487 C U(3:4,1) is a an OB point
488 C V( 4 ,2) is a an OB point
489 C
490 C For convenience, negative values for Jnorth/Ieast refer to
491 C points relative to the Northern/Eastern edges of the model
492 C eg. OB_Jnorth(3)=-1 means that the point (3,Ny-1) is a northern O-B.
493 C
494 COMMON /PARM_OB/
495 & OB_Jnorth,OB_Jsouth,OB_Ieast,OB_Iwest
496 INTEGER OB_Jnorth(Nx)
497 INTEGER OB_Jsouth(Nx)
498 INTEGER OB_Ieast(Ny)
499 INTEGER OB_Iwest(Ny)

  ViewVC Help
Powered by ViewVC 1.1.22