/[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.194 - (show annotations) (download)
Tue Jan 2 20:52:07 2007 UTC (17 years, 4 months ago) by dfer
Branch: MAIN
Changes since 1.193: +6 -2 lines
File MIME type: text/plain
initial check in: correction of tracer source/sink due to Linear
Free surface

1 C $Header: /u/gcmpack/MITgcm/model/inc/PARAMS.h,v 1.193 2006/12/28 01:46:30 jmc Exp $
2 C $Name: $
3 C
4
5 CBOP
6 C !ROUTINE: PARAMS.h
7 C !INTERFACE:
8 C #include PARAMS.h
9
10 C !DESCRIPTION:
11 C Header file defining model "parameters". The values from the
12 C model standard input file are stored into the variables held
13 C here. Notes describing the parameters can also be found here.
14
15 CEOP
16
17 C Macros for special grid options
18 #include "PARAMS_MACROS.h"
19
20 C-- Contants
21 C Useful physical values
22 Real*8 PI
23 PARAMETER ( PI = 3.14159265358979323844D0 )
24 Real*8 deg2rad
25 PARAMETER ( deg2rad = 2.D0*PI/360.D0 )
26
27 C Symbolic values
28 C precXXXX :: Used to indicate what precision to use for
29 C dumping model state.
30 INTEGER precFloat32
31 PARAMETER ( precFloat32 = 32 )
32 INTEGER precFloat64
33 PARAMETER ( precFloat64 = 64 )
34 C UNSET_xxx :: Used to indicate variables that have not been given a value
35 Real*8 UNSET_FLOAT8
36 PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
37 Real*4 UNSET_FLOAT4
38 PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )
39 _RL UNSET_RL
40 PARAMETER ( UNSET_RL = 1.234567D5 )
41 _RS UNSET_RS
42 PARAMETER ( UNSET_RS = 1.234567E5 )
43 INTEGER UNSET_I
44 PARAMETER ( UNSET_I = 123456789 )
45
46 C Checkpoint data
47 INTEGER maxNoChkptLev
48 PARAMETER ( maxNoChkptLev = 2 )
49
50 C-- COMMON /PARM_C/ Character valued parameters used by the model.
51 C checkPtSuff :: List of checkpoint file suffices
52 C tRefFile :: File containing reference Potential Temperat. tRef (1.D)
53 C sRefFile :: File containing reference salinity/spec.humid. sRef (1.D)
54 C rhoRefFile :: File containing reference density profile rhoRef (1.D)
55 C delRFile :: File containing vertical grid spacing delR (1.D array)
56 C delRcFile :: File containing vertical grid spacing delRc (1.D array)
57 C delXFile :: File containing X-spacing grid definition (1.D array)
58 C delYFile :: File containing Y-spacing grid definition (1.D array)
59 C horizGridFile :: File containing horizontal-grid definition
60 C (only when using curvilinear_grid)
61 C bathyFile :: File containing bathymetry. If not defined bathymetry
62 C is taken from inline function.
63 C topoFile :: File containing the topography of the surface (unit=m)
64 C (mainly used for the atmosphere = ground height).
65 C shelfIceFile:: File containing the topography of the shelfice draught
66 C (unit=m)
67 C hydrogThetaFile :: File containing initial hydrographic data for potential
68 C temperature.
69 C hydrogSaltFile :: File containing initial hydrographic data for salinity.
70 C zonalWindFile :: File containing zonal wind data
71 C meridWindFile :: File containing meridional wind data
72 C thetaClimFile :: File containing theta climataology used
73 C in relaxation term -lambda(theta-theta*)
74 C saltClimFile :: File containing salt climataology used
75 C in relaxation term -lambda(salt-salt*)
76 C surfQfile :: File containing surface heat flux, excluding SW
77 C (old version, kept for backward compatibility)
78 C surfQnetFile :: File containing surface net heat flux
79 C surfQswFile :: File containing surface shortwave radiation
80 C dQdTfile :: File containing thermal relaxation coefficient
81 C EmPmRfile :: File containing surface fresh water flux
82 C saltFluxFile :: File containing surface salt flux
83 C pLoadFile :: File containing pressure loading
84 C eddyTauxFile :: File containing zonal Eddy stress data
85 C eddyTauyFile :: File containing meridional Eddy stress data
86 C buoyancyRelation :: Flag used to indicate which relation to use to
87 C get buoyancy.
88 C eosType :: choose the equation of state:
89 C LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
90 C the_run_name :: string identifying the name of the model "run"
91 COMMON /PARM_C/ checkPtSuff,
92 & tRefFile, sRefFile, rhoRefFile,
93 & delRFile, delRcFile,
94 & delXFile, delYFile, horizGridFile,
95 & bathyFile, topoFile, shelfIceFile,
96 & hydrogThetaFile, hydrogSaltFile,
97 & zonalWindFile, meridWindFile, thetaClimFile,
98 & saltClimFile, buoyancyRelation,
99 & EmPmRfile, saltFluxFile,
100 & surfQfile, surfQnetFile, surfQswFile,
101 & lambdaThetaFile, lambdaSaltFile,
102 & uVelInitFile, vVelInitFile, pSurfInitFile,
103 & dQdTfile, ploadFile,
104 & eddyTauxFile, eddyTauyFile,
105 & eosType, pickupSuff,
106 & mdsioLocalDir,
107 & the_run_name
108 CHARACTER*(5) checkPtSuff(maxNoChkptLev)
109 CHARACTER*(MAX_LEN_FNAM) tRefFile
110 CHARACTER*(MAX_LEN_FNAM) sRefFile
111 CHARACTER*(MAX_LEN_FNAM) rhoRefFile
112 CHARACTER*(MAX_LEN_FNAM) delRFile
113 CHARACTER*(MAX_LEN_FNAM) delRcFile
114 CHARACTER*(MAX_LEN_FNAM) delXFile
115 CHARACTER*(MAX_LEN_FNAM) delYFile
116 CHARACTER*(MAX_LEN_FNAM) horizGridFile
117 CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile, shelfIceFile
118 CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
119 CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
120 CHARACTER*(MAX_LEN_FNAM) zonalWindFile
121 CHARACTER*(MAX_LEN_FNAM) meridWindFile
122 CHARACTER*(MAX_LEN_FNAM) thetaClimFile
123 CHARACTER*(MAX_LEN_FNAM) saltClimFile
124 CHARACTER*(MAX_LEN_FNAM) surfQfile
125 CHARACTER*(MAX_LEN_FNAM) surfQnetFile
126 CHARACTER*(MAX_LEN_FNAM) surfQswFile
127 CHARACTER*(MAX_LEN_FNAM) EmPmRfile
128 CHARACTER*(MAX_LEN_FNAM) saltFluxFile
129 CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
130 CHARACTER*(MAX_LEN_FNAM) uVelInitFile
131 CHARACTER*(MAX_LEN_FNAM) vVelInitFile
132 CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
133 CHARACTER*(MAX_LEN_FNAM) dQdTfile
134 CHARACTER*(MAX_LEN_FNAM) ploadFile
135 CHARACTER*(MAX_LEN_FNAM) eddyTauxFile
136 CHARACTER*(MAX_LEN_FNAM) eddyTauyFile
137 CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
138 CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile
139 CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
140 CHARACTER*(MAX_LEN_PREC/2) the_run_name
141 CHARACTER*(6) eosType
142 CHARACTER*(10) pickupSuff
143
144 C-- COMMON /PARM_I/ Integer valued parameters used by the model.
145 C cg2dMaxIters :: Maximum number of iterations in the
146 C two-dimensional con. grad solver.
147 C cg2dChkResFreq :: Frequency with which to check residual
148 C in con. grad solver.
149 C cg2dPreCondFreq :: Frequency for updating cg2d preconditioner
150 C (non-linear free-surf.)
151 C cg3dMaxIters :: Maximum number of iterations in the
152 C three-dimensional con. grad solver.
153 C cg3dChkResFreq :: Frequency with which to check residual
154 C in con. grad solver.
155 C nIter0 :: Start time-step number of for this run
156 C nTimeSteps :: Number of timesteps to execute
157 C numStepsPerPickup :: For offline setup. Frequency of pickup
158 C of flow fields.
159 C writeStatePrec :: Precision used for writing model state.
160 C writeBinaryPrec :: Precision used for writing binary files
161 C readBinaryPrec :: Precision used for reading binary files
162 C nCheckLev :: Holds current checkpoint level
163 C nonlinFreeSurf :: option related to non-linear free surface
164 C =0 Linear free surface ; >0 Non-linear
165 C select_rStar :: option related to r* vertical coordinate
166 C =0 (default) use r coord. ; > 0 use r*
167 C momForcingOutAB :: =1: take momentum forcing contribution
168 C out of (=0: in) Adams-Bashforth time stepping.
169 C tracForcingOutAB :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
170 C out of (=0: in) Adams-Bashforth time stepping.
171 C tempAdvScheme :: Temp. Horiz.Advection scheme selector
172 C tempVertAdvScheme :: Temp. Vert. Advection scheme selector
173 C saltAdvScheme :: Salt. Horiz.advection scheme selector
174 C saltVertAdvScheme :: Salt. Vert. Advection scheme selector
175 C selectKEscheme :: Kinetic Energy scheme selector (Vector Inv.)
176 C debugLevel :: debug level selector: higher -> more writing
177
178 COMMON /PARM_I/
179 & cg2dMaxIters,
180 & cg2dChkResFreq, cg2dPreCondFreq,
181 & cg3dMaxIters,
182 & cg3dChkResFreq,
183 & nIter0, nTimeSteps, nEndIter,
184 & numStepsPerPickup,
185 & writeStatePrec, nCheckLev,
186 & writeBinaryPrec, readBinaryPrec,
187 & nonlinFreeSurf, select_rStar,
188 & momForcingOutAB, tracForcingOutAB,
189 & tempAdvScheme, tempVertAdvScheme,
190 & saltAdvScheme, saltVertAdvScheme,
191 & selectKEscheme,
192 & debugLevel
193 INTEGER cg2dMaxIters
194 INTEGER cg2dChkResFreq
195 INTEGER cg2dPreCondFreq
196 INTEGER cg3dMaxIters
197 INTEGER cg3dChkResFreq
198 INTEGER nIter0
199 INTEGER nTimeSteps
200 INTEGER nEndIter
201 INTEGER numStepsPerPickup
202 INTEGER writeStatePrec
203 INTEGER writeBinaryPrec
204 INTEGER readBinaryPrec
205 INTEGER nCheckLev
206 INTEGER nonlinFreeSurf
207 INTEGER select_rStar
208 INTEGER momForcingOutAB, tracForcingOutAB
209 INTEGER tempAdvScheme, tempVertAdvScheme
210 INTEGER saltAdvScheme, saltVertAdvScheme
211 INTEGER selectKEscheme
212 INTEGER debugLevel
213
214 C
215 INTEGER debLevZero
216 PARAMETER(debLevZero=0)
217 INTEGER debLevA
218 PARAMETER(debLevA=1)
219 INTEGER debLevB
220 PARAMETER(debLevB=2)
221
222 C-- COMMON /PARM_L/ Logical valued parameters used by the model.
223 C usingCartesianGrid :: If TRUE grid generation will be in a cartesian
224 C coordinate frame.
225 C usingSphericalPolarGrid :: If TRUE grid generation will be in a
226 C spherical polar frame.
227 C usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
228 C usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
229 C deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)
230 C no_slip_sides :: Impose "no-slip" at lateral boundaries.
231 C no_slip_bottom :: Impose "no-slip" at bottom boundary.
232 C momViscosity :: Flag which turns momentum friction terms on and off.
233 C momAdvection :: Flag which turns advection of momentum on and off.
234 C momForcing :: Flag which turns external forcing of momentum on
235 C and off.
236 C momPressureForcing :: Flag which turns pressure term in momentum equation
237 C on and off.
238 C metricTerms :: Flag which turns metric terms on or off.
239 C useNHMTerms :: If TRUE use non-hydrostatic metric terms.
240 C useCoriolis :: Flag which turns the coriolis terms on and off.
241 C tempAdvection :: Flag which turns advection of temperature on
242 C and off.
243 C tempForcing :: Flag which turns external forcing of temperature on
244 C and off.
245 C saltAdvection :: Flag which turns advection of salinity on
246 C and off.
247 C saltForcing :: Flag which turns external forcing of salinity on
248 C and off.
249 C useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
250 C as a real Fresh Water (=> changes the Sea Level)
251 C if F, converts P+R-E to salt flux (no SL effect)
252 C useFullLeith :: Set to true to use full Leith viscosity(may be unstable
253 C on irregular grids)
254 C useAreaViscLength :: Set to true to use old scaling for viscous
255 C lengths, e.g., L2=Raz. May be preferable for cube sphere.
256 C useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
257 C rigidLid :: Set to true to use rigid lid
258 C implicitFreeSurface :: Set to true to use implicit free surface
259 C exactConserv :: Set to true to conserve exactly the total Volume
260 C linFSConserveTr :: Set to true to correct source/sink of tracer
261 C at the surface due to Linear Free Surface
262 C uniformLin_PhiSurf :: Set to true to use a uniform Bo_surf in the
263 C linear relation Phi_surf = Bo_surf*eta
264 C use3Dsolver :: set to true to use 3-D pressure solver
265 C implicitIntGravWave :: treat Internal Gravity Wave implicitly
266 C staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
267 C momStepping :: Turns momentum equation time-stepping off
268 C tempStepping :: Turns temperature equation time-stepping off
269 C saltStepping :: Turns salinity equation time-stepping off
270 C useConstantF :: Coriolis parameter set to f0
271 C useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
272 C useSphereF :: Coriolis parameter set to 2.omega.sin(phi)
273 C use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off
274 C useCDscheme :: use CD-scheme to calculate Coriolis terms.
275 C useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
276 C useJamartMomAdv :: Use wet-point method for V.I. non-linear term
277 C SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny
278 C upwindVorticity :: bias interpolation of vorticity in the Coriolis term
279 C highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
280 C upwindShear :: use 1rst order upwind interp. (V.I., vertical advection)
281 C useAbsVorticity :: work with f+zeta in Coriolis terms
282 C implicitDiffusion :: Turns implicit vertical diffusion on
283 C implicitViscosity :: Turns implicit vertical viscosity on
284 C tempImplVertAdv :: Turns on implicit vertical advection for Temperature
285 C saltImplVertAdv :: Turns on implicit vertical advection for Salinity
286 C momImplVertAdv :: Turns on implicit vertical advection for Momentum
287 C multiDimAdvection :: Flag that enable multi-dimension advection
288 C useMultiDimAdvec :: True if multi-dim advection is used at least once
289 C momDissip_In_AB :: if False, put Dissipation tendency contribution
290 C out off Adams-Bashforth time stepping.
291 C doAB_onGtGs :: if the Adams-Bashforth time stepping is used, always
292 C apply AB on tracer tendencies (rather than on Tracer)
293 C startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
294 C doThetaClimRelax :: Set true if relaxation to temperature
295 C climatology is required.
296 C doSaltClimRelax :: Set true if relaxation to salinity
297 C climatology is required.
298 C periodicExternalForcing :: Set true if forcing is time-dependant
299 C usingPCoords :: Set to indicate that we are working in a pressure
300 C type coordinate (p or p*).
301 C usingZCoords :: Set to indicate that we are working in a height
302 C type coordinate (z or z*)
303 C fluidIsAir :: Set to indicate that the fluid major constituent
304 C is air
305 C fluidIsWater :: Set to indicate that the fluid major constituent
306 C is water
307 C useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
308 C this requires specific code for restart & exchange
309 C setInterFDr :: set Interface depth (put cell-Center at the middle)
310 C setCenterDr :: set cell-Center depth (put Interface at the middle)
311 C nonHydrostatic :: Using non-hydrostatic terms
312 C quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
313 C globalFiles :: Selects between "global" and "tiled" files
314 C useSingleCpuIO :: On SGI platforms, option globalFiles is either
315 C slow (f77) or does not work (f90). When
316 C useSingleCpuIO is set, mdsio_writefield.F
317 C outputs from master mpi process only.
318 C allowFreezing :: Allows surface water to freeze and form ice
319 C useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
320 C pickup_write_mdsio :: use mdsio to write pickups
321 C pickup_read_mdsio :: use mdsio to read pickups
322 C pickup_write_immed :: echo the pickup immediately (for conversion)
323 C timeave_mdsio :: use mdsio for timeave output
324 C snapshot_mdsio :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
325 C monitor_stdio :: use stdio for monitor output
326 C dumpInitAndLast :: dumps model state to files at Initial (nIter0)
327 C & Last iteration, in addition multiple of dumpFreq iter.
328 C balanceEmPmR :: substract global mean of EmPmR at every time step
329 C balanceQnet :: substract global mean of Qnet at every time step
330 C balancePrintMean:: print substracted global means to STDOUT
331
332 COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
333 & usingCurvilinearGrid, usingCylindricalGrid,
334 & deepAtmosphere, setInterFDr, setCenterDr,
335 & no_slip_sides,no_slip_bottom,
336 & momViscosity, momAdvection, momForcing, useCoriolis,
337 & momPressureForcing, vectorInvariantMomentum,
338 & tempAdvection, tempForcing,
339 & saltAdvection, saltForcing,
340 & useRealFreshWaterFlux,
341 & useFullLeith, useStrainTensionVisc,
342 & useAreaViscLength,
343 & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,
344 & uniformLin_PhiSurf,
345 & use3Dsolver, implicitIntGravWave, staggerTimeStep,
346 & momStepping, tempStepping, saltStepping,
347 & metricTerms, useNHMTerms,
348 & useConstantF, useBetaPlaneF, useSphereF, use3dCoriolis,
349 & useCDscheme,
350 & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
351 & SadournyCoriolis, upwindVorticity, highOrderVorticity,
352 & useAbsVorticity, upwindShear,
353 & implicitDiffusion, implicitViscosity,
354 & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
355 & multiDimAdvection, useMultiDimAdvec,
356 & momDissip_In_AB, doAB_onGtGs,
357 & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
358 & periodicExternalForcing,
359 & fluidIsAir, fluidIsWater,
360 & usingPCoords, usingZCoords, useDynP_inEos_Zc,
361 & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
362 & allowFreezing, useOldFreezing,
363 & usePickupBeforeC35, usePickupBeforeC54, startFromPickupAB2,
364 & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
365 & timeave_mdsio, snapshot_mdsio, monitor_stdio,
366 & outputTypesInclusive, dumpInitAndLast, debugMode,
367 & inAdMode, inAdTrue, inAdFalse, inAdExact,
368 & balanceEmPmR, balanceQnet, balancePrintMean
369
370 LOGICAL usingCartesianGrid
371 LOGICAL usingSphericalPolarGrid
372 LOGICAL usingCylindricalGrid
373 LOGICAL usingCurvilinearGrid
374 LOGICAL deepAtmosphere
375 LOGICAL setInterFDr
376 LOGICAL setCenterDr
377 LOGICAL useNHMTerms
378 LOGICAL no_slip_sides
379 LOGICAL no_slip_bottom
380 LOGICAL momViscosity
381 LOGICAL momAdvection
382 LOGICAL momForcing
383 LOGICAL momPressureForcing
384 LOGICAL useCoriolis
385 LOGICAL vectorInvariantMomentum
386 LOGICAL tempAdvection
387 LOGICAL tempForcing
388 LOGICAL saltAdvection
389 LOGICAL saltForcing
390 LOGICAL useRealFreshWaterFlux
391 LOGICAL useFullLeith
392 LOGICAL useStrainTensionVisc
393 LOGICAL useAreaViscLength
394 LOGICAL rigidLid
395 LOGICAL implicitFreeSurface
396 LOGICAL exactConserv
397 LOGICAL linFSConserveTr
398 LOGICAL uniformLin_PhiSurf
399 LOGICAL use3Dsolver
400 LOGICAL implicitIntGravWave
401 LOGICAL staggerTimeStep
402 LOGICAL momStepping
403 LOGICAL tempStepping
404 LOGICAL saltStepping
405 LOGICAL metricTerms
406 LOGICAL useConstantF
407 LOGICAL useBetaPlaneF
408 LOGICAL useSphereF
409 LOGICAL use3dCoriolis
410 LOGICAL useCDscheme
411 LOGICAL useEnergyConservingCoriolis
412 LOGICAL useJamartWetPoints
413 LOGICAL useJamartMomAdv
414 LOGICAL SadournyCoriolis
415 LOGICAL upwindVorticity
416 LOGICAL highOrderVorticity
417 LOGICAL useAbsVorticity
418 LOGICAL upwindShear
419 LOGICAL implicitDiffusion
420 LOGICAL implicitViscosity
421 LOGICAL tempImplVertAdv
422 LOGICAL saltImplVertAdv
423 LOGICAL momImplVertAdv
424 LOGICAL multiDimAdvection
425 LOGICAL useMultiDimAdvec
426 LOGICAL momDissip_In_AB
427 LOGICAL doAB_onGtGs
428 LOGICAL doThetaClimRelax
429 LOGICAL doSaltClimRelax
430 LOGICAL doTr1ClimRelax
431 LOGICAL periodicExternalForcing
432 LOGICAL fluidIsAir
433 LOGICAL fluidIsWater
434 LOGICAL usingPCoords
435 LOGICAL usingZCoords
436 LOGICAL useDynP_inEos_Zc
437 LOGICAL nonHydrostatic
438 LOGICAL quasiHydrostatic
439 LOGICAL globalFiles
440 LOGICAL useSingleCpuIO
441 LOGICAL allowFreezing
442 LOGICAL useOldFreezing
443 LOGICAL usePickupBeforeC35
444 LOGICAL usePickupBeforeC54
445 LOGICAL startFromPickupAB2
446 LOGICAL dumpInitAndLast
447 LOGICAL debugMode
448 LOGICAL pickup_read_mdsio, pickup_write_mdsio
449 LOGICAL pickup_write_immed
450 LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
451 LOGICAL outputTypesInclusive
452 LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
453
454 LOGICAL balanceEmPmR
455 LOGICAL balanceQnet
456 LOGICAL balancePrintMean
457
458 C-- COMMON /PARM_R/ "Real" valued parameters used by the model.
459 C cg2dTargetResidual
460 C :: Target residual for cg2d solver; no unit (RHS normalisation)
461 C cg2dTargetResWunit
462 C :: Target residual for cg2d solver; W unit (No RHS normalisation)
463 C cg3dTargetResidual
464 C :: Target residual for cg3d solver.
465 C cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
466 C Note. 20th May 1998
467 C I made a weird discovery! In the model paper we argue
468 C for the form of the preconditioner used here ( see
469 C A Finite-volume, Incompressible Navier-Stokes Model
470 C ...., Marshall et. al ). The algebra gives a simple
471 C 0.5 factor for the averaging of ac and aCw to get a
472 C symmettric pre-conditioner. By using a factor of 0.51
473 C i.e. scaling the off-diagonal terms in the
474 C preconditioner down slightly I managed to get the
475 C number of iterations for convergence in a test case to
476 C drop form 192 -> 134! Need to investigate this further!
477 C For now I have introduced a parameter cg2dpcOffDFac which
478 C defaults to 0.51 but can be set at runtime.
479 C delR :: Vertical grid spacing ( units of r ).
480 C delRc :: Vertical grid spacing between cell centers (r unit).
481 C delX :: Separation between cell faces (m) or (deg), depending
482 C delY on input flags.
483 C gravity :: Accel. due to gravity ( m/s^2 )
484 C recip_gravity and its inverse
485 C gBaro :: Accel. due to gravity used in barotropic equation ( m/s^2 )
486 C rhoNil :: Reference density for the linear equation of state
487 C rhoConst :: Vertically constant reference density
488 C rhoFacC :: normalized (by rhoConst) reference density at cell-Center
489 C rhoFacF :: normalized (by rhoConst) reference density at cell-interFace
490 C rhoConstFresh :: Constant reference density for fresh water (rain)
491 C tRef :: reference vertical profile for potential temperature
492 C sRef :: reference vertical profile for salinity/specific humidity
493 C phiRef :: reference potential (pressure/rho, geopotential) profile
494 C dBdrRef :: vertical gradient of reference boyancy [(m/s/r)^2)]:
495 C :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
496 C :: p-coord: = -(d.alpha/dp)_ref [(m^2.s/kg)^2]
497 C phiMin :: Latitude of southern most cell face.
498 C thetaMin :: Longitude of western most cell face (this
499 C is an "inert" parameter but it is included
500 C to make geographical references simple.)
501 C rSphere :: Radius of sphere for a spherical polar grid ( m ).
502 C recip_rSphere :: Reciprocal radius of sphere ( m ).
503 C f0 :: Reference coriolis parameter ( 1/s )
504 C ( Southern edge f for beta plane )
505 C beta :: df/dy ( s^-1.m^-1 )
506 C omega :: Angular velocity ( rad/s )
507 C rotationPeriod :: Rotation period (s) (= 2.pi/omega)
508 C viscAh :: Eddy viscosity coeff. for mixing of
509 C momentum laterally ( m^2/s )
510 C viscAhW :: Eddy viscosity coeff. for mixing of vertical
511 C momentum laterally, no effect for hydrostatic
512 C model, defaults to viscAh if unset ( m^2/s )
513 C Not used if variable horiz. viscosity is used.
514 C viscAr :: Eddy viscosity coeff. for mixing of
515 C momentum vertically ( units of r^2/s )
516 C viscA4 :: Biharmonic viscosity coeff. for mixing of
517 C momentum laterally ( m^4/s )
518 C viscA4W :: Biharmonic viscosity coeff. for mixing of vertical
519 C momentum laterally, no effect for hydrostatic
520 C model, defaults to viscA4 if unset ( m^2/s )
521 C Not used if variable horiz. viscosity is used.
522 C viscAhD :: Eddy viscosity coeff. for mixing of momentum laterally
523 C (act on Divergence part) ( m^2/s )
524 C viscAhZ :: Eddy viscosity coeff. for mixing of momentum laterally
525 C (act on Vorticity part) ( m^2/s )
526 C viscA4D :: Biharmonic viscosity coeff. for mixing of momentum laterally
527 C (act on Divergence part) ( m^4/s )
528 C viscA4Z :: Biharmonic viscosity coeff. for mixing of momentum laterally
529 C (act on Vorticity part) ( m^4/s )
530 C viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))
531 C viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
532 C viscC2smag :: Smagorinsky non-dimensional viscosity factor (harmonic)
533 C viscC4smag :: Smagorinsky non-dimensional viscosity factor (biharmonic)
534 C viscAhMax :: Maximum eddy viscosity coeff. for mixing of
535 C momentum laterally ( m^2/s )
536 C viscAhReMax :: Maximum gridscale Reynolds number for eddy viscosity
537 C coeff. for mixing of momentum laterally (non-dim)
538 C viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
539 C viscAhGridMin:: in terms of non-dimensional grid-size dependent visc.
540 C viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
541 C momentum laterally ( m^4/s )
542 C viscA4ReMax :: Maximum Gridscale Reynolds number for
543 C biharmonic viscosity coeff. momentum laterally (non-dim)
544 C viscAhGrid:: non-dimensional grid-size dependent viscosity
545 C viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
546 C viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
547 C viscA4GridMin:: in terms of non-dimensional grid-size dependent viscosity
548 C viscC4leith :: Leith non-dimensional viscosity factor (grad(vort))
549 C viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
550 C diffKhT :: Laplacian diffusion coeff. for mixing of
551 C heat laterally ( m^2/s )
552 C diffKrNrT :: vertical profile of Laplacian diffusion coeff.
553 C for mixing of heat vertically ( units of r^2/s )
554 C diffK4T :: Biharmonic diffusion coeff. for mixing of
555 C heat laterally ( m^4/s )
556 C diffKhS :: Laplacian diffusion coeff. for mixing of
557 C salt laterally ( m^2/s )
558 C diffKrNrS :: vertical profile of Laplacian diffusion coeff.
559 C for mixing of salt vertically ( units of r^2/s ),
560 C diffK4S :: Biharmonic diffusion coeff. for mixing of
561 C salt laterally ( m^4/s )
562 C diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
563 C diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
564 C diffKrBL79scl :: depth scale for arctan fn (m) Bryan and Lewis, 1979
565 C diffKrBL79Ho :: depth offset for arctan fn (m) Bryan and Lewis, 1979
566 C deltaT :: Default timestep ( s )
567 C deltaTClock :: Timestep used as model "clock". This determines the
568 C IO frequencies and is used in tagging output. It can
569 C be totally different to the dynamical time. Typically
570 C it will be the deep-water timestep for accelerated runs.
571 C Frequency of checkpointing and dumping of the model state
572 C are referenced to this clock. ( s )
573 C deltaTMom :: Timestep for momemtum equations ( s )
574 C dTtracerLev :: Timestep for tracer equations ( s ), function of level k
575 C deltaTfreesurf :: Timestep for free-surface equation ( s )
576 C freesurfFac :: Parameter to turn implicit free surface term on or off
577 C freesurfac = 1. uses implicit free surface
578 C freesurfac = 0. uses rigid lid
579 C abEps :: Adams-Bashforth-2 stabilizing weight
580 C alph_AB :: Adams-Bashforth-3 primary factor
581 C beta_AB :: Adams-Bashforth-3 secondary factor
582 C implicSurfPress :: parameter of the Crank-Nickelson time stepping :
583 C Implicit part of Surface Pressure Gradient ( 0-1 )
584 C implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
585 C Implicit part of barotropic flow Divergence ( 0-1 )
586 C hFacMin :: Minimum fraction size of a cell (affects hFacC etc...)
587 C hFacMinDz :: Minimum dimesional size of a cell (affects hFacC etc..., m)
588 C hFacMinDp :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
589 C hFacMinDr :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
590 C hFacInf :: Threshold (inf and sup) for fraction size of surface cell
591 C hFacSup that control vanishing and creating levels
592 C tauCD :: CD scheme coupling timescale ( 1/s )
593 C rCD :: CD scheme normalised coupling parameter ( 0-1 )
594 C baseTime :: model base time (time origin) = time @ iteration zero
595 C startTime :: Starting time for this integration ( s ).
596 C endTime :: Ending time for this integration ( s ).
597 C chkPtFreq :: Frequency of rolling check pointing ( s ).
598 C pChkPtFreq :: Frequency of permanent check pointing ( s ).
599 C dumpFreq :: Frequency with which model state is written to
600 C post-processing files ( s ).
601 C diagFreq :: Frequency with which model writes diagnostic output
602 C of intermediate quantities.
603 C afFacMom :: Advection of momentum term tracer parameter
604 C vfFacMom :: Momentum viscosity tracer parameter
605 C pfFacMom :: Momentum pressure forcing tracer parameter
606 C cfFacMom :: Coriolis term tracer parameter
607 C foFacMom :: Momentum forcing tracer parameter
608 C mtFacMom :: Metric terms tracer parameter
609 C cosPower :: Power of cosine of latitude to multiply viscosity
610 C cAdjFreq :: Frequency of convective adjustment
611 C
612 C taveFreq :: Frequency with which time-averaged model state
613 C is written to post-processing files ( s ).
614 C tave_lastIter :: (for state variable only) fraction of the last time
615 C step (of each taveFreq period) put in the time average.
616 C (fraction for 1rst iter = 1 - tave_lastIter)
617 C tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
618 C tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
619 C latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
620 C i.e. where |yC| <= latBandClimRelax
621 C externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
622 C externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
623 C (note: externForcingCycle must be an integer
624 C number times externForcingPeriod)
625 C convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
626 C (use model surface (local) value if set to -1)
627 C temp_EvPrRn :: temperature of Rain & Evap.
628 C salt_EvPrRn :: salinity of Rain & Evap.
629 C (notes: a) tracer content of Rain/Evap only used if both
630 C NonLin_FrSurf & useRealFreshWater are set.
631 C b) use model surface (local) value if set to UNSET_RL)
632 C horiVertRatio :: Ratio on units in vertical to units in horizontal.
633 C recip_horiVertRatio ( 1 if horiz in m and vertical in m ).
634 C ( g*rho if horiz in m and vertical in Pa ).
635 C Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
636 C starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
637 C sideDragFactor :: side-drag scaling factor (used only if no_slip_sides)
638 C (default=2: full drag ; =1: gives half-slip BC)
639 C bottomDragLinear :: Linear bottom-drag coefficient (units of [r]/s)
640 C bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)
641 C (if using zcoordinate, units becomes linear: m/s, quadratic: [-])
642 C smoothAbsFuncRange :: 1/2 of interval around zero, for which FORTRAN ABS
643 C is to be replace by a smoother function
644 C (affects myabs, mymin, mymax)
645 C nh_Am2 :: scales the non-hydrostatic terms and changes internal scales
646 C (i.e. allows convection at different Rayleigh numbers)
647 COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
648 & cg2dpcOffDFac, cg3dTargetResidual,
649 & delR, delRc, delX, delY,
650 & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
651 & abEps, alph_AB, beta_AB,
652 & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
653 & viscAh, viscAhW, viscAhMax,
654 & viscAhGrid, viscAhGridMax, viscAhGridMin,
655 & viscC2leith, viscC2leithD,
656 & viscC2smag, viscC4smag,
657 & viscAhD, viscAhZ, viscA4D, viscA4Z,
658 & viscA4, viscA4W,
659 & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,
660 & viscAhRemax, viscA4Remax,
661 & viscC4leith, viscC4leithD, viscAr,
662 & diffKhT, diffK4T, diffKrNrT,
663 & diffKhS, diffK4S, diffKrNrS,
664 & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
665 & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
666 & hFacMin, hFacMinDz, hFacInf, hFacSup,
667 & gravity, recip_Gravity, gBaro,
668 & rhonil, recip_rhonil, rhoConst, recip_rhoConst,
669 & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
670 & rhoConstFresh, convertEmP2rUnit, tRef, sRef, phiRef, dBdrRef,
671 & baseTime, startTime, endTime,
672 & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
673 & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
674 & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
675 & cosPower, cAdjFreq, omega, rotationPeriod,
676 & tauThetaClimRelax, tauSaltClimRelax,
677 & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
678 & externForcingCycle, externForcingPeriod,
679 & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
680 & hFacMinDr, hFacMinDp,
681 & horiVertRatio, recip_horiVertRatio,
682 & ivdc_kappa, Ro_SeaLevel,
683 & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
684 & smoothAbsFuncRange,
685 & tCylIn, tCylOut
686
687 _RL cg2dTargetResidual
688 _RL cg2dTargetResWunit
689 _RL cg3dTargetResidual
690 _RL cg2dpcOffDFac
691 _RL delR(Nr)
692 _RL delRc(Nr+1)
693 _RL delX(Nx)
694 _RL delY(Ny)
695 _RL deltaT
696 _RL deltaTClock
697 _RL deltaTmom
698 _RL dTtracerLev(Nr)
699 _RL deltaTfreesurf
700 _RL abEps, alph_AB, beta_AB
701 _RL phiMin
702 _RL thetaMin
703 _RL rSphere
704 _RL recip_rSphere
705 _RL f0
706 _RL freeSurfFac
707 _RL implicSurfPress
708 _RL implicDiv2Dflow
709 _RL hFacMin
710 _RL hFacMinDz
711 _RL hFacMinDp
712 _RL hFacMinDr
713 _RL hFacInf
714 _RL hFacSup
715 _RL beta
716 _RL viscAh
717 _RL viscAhW
718 _RL viscAhD
719 _RL viscAhZ
720 _RL viscAhMax
721 _RL viscAhReMax
722 _RL viscAhGrid
723 _RL viscAhGridMax
724 _RL viscAhGridMin
725 _RL viscC2leith
726 _RL viscC2leithD
727 _RL viscC2smag
728 _RL viscC4smag
729 _RL viscAr
730 _RL viscA4
731 _RL viscA4W
732 _RL viscA4D
733 _RL viscA4Z
734 _RL viscA4Max
735 _RL viscA4ReMax
736 _RL viscA4Grid, viscA4GridMax, viscA4GridMin
737 _RL viscC4leith
738 _RL viscC4leithD
739 _RL diffKhT
740 _RL diffKrNrT(Nr)
741 _RL diffK4T
742 _RL diffKhS
743 _RL diffKrNrS(Nr)
744 _RL diffK4S
745 _RL diffKrBL79surf
746 _RL diffKrBL79deep
747 _RL diffKrBL79scl
748 _RL diffKrBL79Ho
749 _RL delt
750 _RL tauCD
751 _RL rCD
752 _RL gravity
753 _RL recip_gravity
754 _RL gBaro
755 _RL rhonil, recip_rhonil
756 _RL rhoConst, recip_rhoConst
757 _RL rhoFacC(Nr), recip_rhoFacC(Nr)
758 _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
759 _RL rhoConstFresh
760 _RL convertEmP2rUnit
761 _RL tRef(Nr)
762 _RL sRef(Nr)
763 _RL phiRef(2*Nr+1)
764 _RL dBdrRef(Nr)
765 _RL baseTime
766 _RL startTime
767 _RL endTime
768 _RL chkPtFreq
769 _RL pChkPtFreq
770 _RL dumpFreq
771 _RL adjDumpFreq
772 _RL diagFreq
773 _RL taveFreq
774 _RL tave_lastIter
775 _RL monitorFreq
776 _RL adjMonitorFreq
777 _RL afFacMom
778 _RL vfFacMom
779 _RL pfFacMom
780 _RL cfFacMom
781 _RL foFacMom
782 _RL mtFacMom
783 _RL cosPower
784 _RL cAdjFreq
785 _RL omega
786 _RL rotationPeriod
787 _RL tauThetaClimRelax
788 _RL tauSaltClimRelax
789 _RL tauTr1ClimRelax
790 _RL lambdaTr1ClimRelax
791 _RL latBandClimRelax
792 _RL externForcingCycle
793 _RL externForcingPeriod
794 _RL convertFW2Salt
795 _RL temp_EvPrRn
796 _RL salt_EvPrRn
797 _RL horiVertRatio
798 _RL recip_horiVertRatio
799 _RL ivdc_kappa
800 _RL Ro_SeaLevel
801 _RL sideDragFactor
802 _RL bottomDragLinear
803 _RL bottomDragQuadratic
804 _RL smoothAbsFuncRange
805 _RL nh_Am2
806 _RL tCylIn
807 _RL tCylOut
808
809 C-- COMMON /PARM_A/ Thermodynamics constants ?
810 COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
811 _RL HeatCapacity_Cp
812 _RL recip_Cp
813
814 C-- COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
815 C celsius2K :: convert centigrade (Celsius) degree to Kelvin
816 C atm_Po :: standard reference pressure
817 C atm_Cp :: specific heat (Cp) of the (dry) air at constant pressure
818 C atm_Rd :: gas constant for dry air
819 C atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
820 C atm_Rq :: water vapour specific volume anomaly relative to dry air
821 C (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
822 C integr_GeoPot :: option to select the way we integrate the geopotential
823 C (still a subject of discussions ...)
824 C selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
825 C derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
826 COMMON /PARM_ATM/
827 & celsius2K,
828 & atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
829 & integr_GeoPot, selectFindRoSurf
830 _RL celsius2K
831 _RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq
832 INTEGER integr_GeoPot, selectFindRoSurf
833
834 C Logical flags for selecting packages
835 LOGICAL useOPPS
836 LOGICAL usePP81
837 LOGICAL useMY82
838 LOGICAL useGGL90
839 LOGICAL useKPP
840 LOGICAL useGMRedi
841 LOGICAL useOBCS
842 LOGICAL useAIM
843 LOGICAL useLand
844 LOGICAL useCAL
845 LOGICAL useEXF
846 LOGICAL useEBM
847 LOGICAL useGrdchk
848 LOGICAL useECCO
849 LOGICAL useSHAP_FILT
850 LOGICAL useZONAL_FILT
851 LOGICAL useFLT
852 LOGICAL usePTRACERS
853 LOGICAL useGCHEM
854 LOGICAL useRBCS
855 LOGICAL useOffLine
856 LOGICAL useMATRIX
857 LOGICAL useSBO
858 LOGICAL useSEAICE
859 LOGICAL useShelfIce
860 LOGICAL useThSIce
861 LOGICAL useATM2d
862 LOGICAL useBulkForce
863 LOGICAL usefizhi
864 LOGICAL usegridalt
865 LOGICAL useDiagnostics
866 LOGICAL useMNC
867 LOGICAL useREGRID
868 LOGICAL useRunClock
869 LOGICAL useEMBED_FILES
870 LOGICAL useMYPACKAGE
871 COMMON /PARM_PACKAGES/
872 & useOPPS, usePP81, useMY82, useGGL90, useKPP,
873 & useGMRedi, useOBCS, useAIM, useLand,
874 & useCAL, useEXF, useEBM, useGrdchk, useECCO,
875 & useSHAP_FILT, useZONAL_FILT, useFLT,
876 & usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
877 & useSBO, useSEAICE, useShelfIce,
878 & useThSIce, useATM2D, useBulkForce,
879 & usefizhi, usegridalt, useDiagnostics, useMNC, useREGRID,
880 & useRunClock, useEMBED_FILES, useMYPACKAGE
881
882 CEH3 ;;; Local Variables: ***
883 CEH3 ;;; mode:fortran ***
884 CEH3 ;;; End: ***

  ViewVC Help
Powered by ViewVC 1.1.22