/[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.153 - (show annotations) (download)
Mon Apr 11 14:47:24 2005 UTC (19 years, 1 month ago) by dimitri
Branch: MAIN
CVS Tags: checkpoint57g_pre
Changes since 1.152: +6 -3 lines
File MIME type: text/plain
Added flag useAnisotropicViscAGridMax to turn on and off (off by default)
Alistair's latest length scale computation for horizontal viscosity.
It is used only for maximum viscosity calculations.  Alistair recommends
a value of viscA*GridMax=.25

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

  ViewVC Help
Powered by ViewVC 1.1.22