/[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.151 - (show annotations) (download)
Wed Apr 6 20:18:19 2005 UTC (19 years, 1 month ago) by heimbach
Branch: MAIN
Changes since 1.150: +9 -3 lines
File MIME type: text/plain
Make lambda[Theta,Salt]ClimRelax spatially varying.

1 C $Header: /u/gcmpack/MITgcm/model/inc/PARAMS.h,v 1.150 2005/04/06 18:23:21 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 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 rigidLid :: Set to true to use rigid lid
224 C implicitFreeSurface :: Set to true to use implcit free surface
225 C exactConserv :: Set to true to conserve exactly the total Volume
226 C uniformLin_PhiSurf :: Set to true to use a uniform Bo_surf in the
227 C linear relation Phi_surf = Bo_surf*eta
228 C momStepping :: Turns momentum equation time-stepping off
229 C tempStepping :: Turns temperature equation time-stepping off
230 C saltStepping :: Turns salinity equation time-stepping off
231 C useConstantF :: Coriolis parameter set to f0
232 C useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
233 C useSphereF :: Coriolis parameter set to 2.omega.sin(phi)
234 C useCDscheme :: use CD-scheme to calculate Coriolis terms.
235 C useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
236 C useJamartMomAdv :: Use wet-point method for V.I. non-linear term
237 C SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny
238 C upwindVorticity :: bias interpolation of vorticity in the Coriolis term
239 C highOrderVorticity :: use 3rd/4th order interp. of vorticity in Coriolis
240 C useAbsVorticity :: work with f+zeta in Coriolis terms
241 C implicitDiffusion :: Turns implicit vertical diffusion on
242 C implicitViscosity :: Turns implicit vertical viscosity on
243 C tempImplVertAdv :: Turns on implicit vertical advection for Temperature
244 C saltImplVertAdv :: Turns on implicit vertical advection for Salinity
245 C momImplVertAdv :: Turns on implicit vertical advection for Momentum
246 C multiDimAdvection :: Flag that enable multi-dimension advection
247 C useMultiDimAdvec :: True if multi-dim advection is used at least once
248 C forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
249 C out off Adams-Bashforth time stepping.
250 C doThetaClimRelax :: Set true if relaxation to temperature
251 C climatology is required.
252 C doSaltClimRelax :: Set true if relaxation to salinity
253 C climatology is required.
254 C periodicExternalForcing :: Set true if forcing is time-dependant
255 C usingPCoords :: Set to indicate that we are working in a pressure
256 C type coordinate (p or p*).
257 C usingZCoords :: Set to indicate that we are working in a height
258 C type coordinate (z or z*)
259 C fluidIsAir :: Set to indicate that the fluid major constituent
260 C is air
261 C fluidIsWater :: Set to indicate that the fluid major constituent
262 C is water
263 C useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
264 C this requires specific code for restart & exchange
265 C setCenterDr :: set cell Center depth and put Interface at the middle
266 C nonHydrostatic :: Using non-hydrostatic terms
267 C quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
268 C globalFiles :: Selects between "global" and "tiled" files
269 C useSingleCpuIO :: On SGI platforms, option globalFiles is either
270 C slow (f77) or does not work (f90). When
271 C useSingleCpuIO is set, mdsio_writefield.F
272 C outputs from master mpi process only.
273 C allowFreezing :: Allows surface water to freeze and form ice
274 C useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
275 C groundAtK1 :: put the surface(k=1) at the Lower Boundary (=ground)
276 C pickup_write_mdsio :: use mdsio to write pickups
277 C pickup_read_mdsio :: use mdsio to read pickups
278 C pickup_write_immed :: echo the pickup immediately (for conversion)
279 C timeave_mdsio :: use mdsio for timeave output
280 C snapshot_mdsio :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
281 C seaice_mdsio :: use mdsio for seaice output
282 C monitor_stdio :: use stdio for monitor output
283 C calendarDumps :: When set, approximate months (30-31 days) and years (360-372 days)
284 C for parameters chkPtFreq, pChkPtFreq, taveFreq, SEAICE_taveFreq,
285 C KPP_taveFreq, and freq in pkg/diagnostics are converted to exact
286 C calendar months and years. Requires pkg/cal.
287 COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
288 & usingCurvilinearGrid, usingCylindricalGrid,
289 & no_slip_sides,no_slip_bottom,
290 & staggerTimeStep,
291 & momViscosity, momAdvection, momForcing, useCoriolis,
292 & momPressureForcing, vectorInvariantMomentum,
293 & tempAdvection, tempForcing,
294 & saltAdvection, saltForcing,
295 & useRealFreshWaterFlux,
296 & useFullLeith,
297 & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
298 & momStepping, tempStepping, saltStepping,
299 & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
300 & useConstantF, useBetaPlaneF, useSphereF,
301 & useCDscheme,
302 & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
303 & SadournyCoriolis, upwindVorticity, highOrderVorticity,
304 & useAbsVorticity,
305 & implicitDiffusion, implicitViscosity,
306 & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
307 & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,
308 & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
309 & periodicExternalForcing,
310 & fluidIsAir, fluidIsWater,
311 & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
312 & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
313 & allowFreezing, useOldFreezing, groundAtK1,
314 & usePickupBeforeC35, usePickupBeforeC54, debugMode,
315 & readPickupWithTracer, writePickupWithTracer,
316 & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
317 & timeave_mdsio, snapshot_mdsio, monitor_stdio, seaice_mdsio,
318 & outputTypesInclusive,
319 & inAdMode, inAdTrue, inAdFalse, inAdExact,
320 & calendarDumps
321
322 LOGICAL usingCartesianGrid
323 LOGICAL usingSphericalPolarGrid
324 LOGICAL usingCylindricalGrid
325 LOGICAL usingCurvilinearGrid
326 LOGICAL usingSphericalPolarMTerms
327 LOGICAL useNHMTerms
328 LOGICAL no_slip_sides
329 LOGICAL no_slip_bottom
330 LOGICAL staggerTimeStep
331 LOGICAL momViscosity
332 LOGICAL momAdvection
333 LOGICAL momForcing
334 LOGICAL momPressureForcing
335 LOGICAL useCoriolis
336 LOGICAL vectorInvariantMomentum
337 LOGICAL tempAdvection
338 LOGICAL tempForcing
339 LOGICAL saltAdvection
340 LOGICAL saltForcing
341 LOGICAL useRealFreshWaterFlux
342 LOGICAL useFullLeith
343 LOGICAL rigidLid
344 LOGICAL implicitFreeSurface
345 LOGICAL exactConserv
346 LOGICAL uniformLin_PhiSurf
347 LOGICAL momStepping
348 LOGICAL tempStepping
349 LOGICAL saltStepping
350 LOGICAL metricTerms
351 LOGICAL useConstantF
352 LOGICAL useBetaPlaneF
353 LOGICAL useSphereF
354 LOGICAL useCDscheme
355 LOGICAL useEnergyConservingCoriolis
356 LOGICAL useJamartWetPoints
357 LOGICAL useJamartMomAdv
358 LOGICAL SadournyCoriolis
359 LOGICAL upwindVorticity
360 LOGICAL highOrderVorticity
361 LOGICAL useAbsVorticity
362 LOGICAL implicitDiffusion
363 LOGICAL implicitViscosity
364 LOGICAL tempImplVertAdv
365 LOGICAL saltImplVertAdv
366 LOGICAL momImplVertAdv
367 LOGICAL multiDimAdvection
368 LOGICAL useMultiDimAdvec
369 LOGICAL forcing_In_AB
370 LOGICAL doThetaClimRelax
371 LOGICAL doSaltClimRelax
372 LOGICAL doTr1ClimRelax
373 LOGICAL periodicExternalForcing
374 LOGICAL fluidIsAir
375 LOGICAL fluidIsWater
376 LOGICAL usingPCoords
377 LOGICAL usingZCoords
378 LOGICAL useDynP_inEos_Zc
379 LOGICAL setCenterDr
380 LOGICAL nonHydrostatic
381 LOGICAL quasiHydrostatic
382 LOGICAL globalFiles
383 LOGICAL useSingleCpuIO
384 LOGICAL allowFreezing
385 LOGICAL useOldFreezing
386 LOGICAL groundAtK1
387 LOGICAL usePickupBeforeC35
388 LOGICAL usePickupBeforeC54
389 LOGICAL debugMode
390 LOGICAL readPickupWithTracer
391 LOGICAL writePickupWithTracer
392 LOGICAL pickup_read_mdsio, pickup_write_mdsio
393 LOGICAL pickup_write_immed
394 LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
395 LOGICAL seaice_mdsio
396 LOGICAL outputTypesInclusive
397 LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
398 LOGICAL calendarDumps
399
400 C-- COMMON /PARM_R/ "Real" valued parameters used by the model.
401 C cg2dTargetResidual
402 C :: Target residual for cg2d solver; no unit (RHS normalisation)
403 C cg2dTargetResWunit
404 C :: Target residual for cg2d solver; W unit (No RHS normalisation)
405 C cg3dTargetResidual
406 C :: Target residual for cg3d solver.
407 C cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
408 C Note. 20th May 1998
409 C I made a weird discovery! In the model paper we argue
410 C for the form of the preconditioner used here ( see
411 C A Finite-volume, Incompressible Navier-Stokes Model
412 C ...., Marshall et. al ). The algebra gives a simple
413 C 0.5 factor for the averaging of ac and aCw to get a
414 C symmettric pre-conditioner. By using a factor of 0.51
415 C i.e. scaling the off-diagonal terms in the
416 C preconditioner down slightly I managed to get the
417 C number of iterations for convergence in a test case to
418 C drop form 192 -> 134! Need to investigate this further!
419 C For now I have introduced a parameter cg2dpcOffDFac which
420 C defaults to 0.51 but can be set at runtime.
421 C delR :: Vertical grid spacing ( units of r ).
422 C delRc :: Vertical grid spacing between cell centers (r unit).
423 C delX :: Separation between cell faces (m) or (deg), depending
424 C delY on input flags.
425 C gravity :: Accel. due to gravity ( m/s^2 )
426 C recip_gravity and its inverse
427 C gBaro :: Accel. due to gravity used in barotropic equation ( m/s^2 )
428 C rhoNil :: Reference density for the linear equation of state
429 C rhoConst :: Vertically constant reference density
430 C rhoConstFresh :: Constant reference density for fresh water (rain)
431 C tRef :: reference vertical profile for potential temperature
432 C sRef :: reference vertical profile for salinity/specific humidity
433 C phiMin :: Latitude of southern most cell face.
434 C thetaMin :: Longitude of western most cell face (this
435 C is an "inert" parameter but it is included
436 C to make geographical references simple.)
437 C rSphere :: Radius of sphere for a spherical polar grid ( m ).
438 C recip_RSphere :: Reciprocal radius of sphere ( m ).
439 C f0 :: Reference coriolis parameter ( 1/s )
440 C ( Southern edge f for beta plane )
441 C beta :: df/dy ( s^-1.m^-1 )
442 C omega :: Angular velocity ( rad/s )
443 C rotationPeriod :: Rotation period (s) (= 2.pi/omega)
444 C viscAh :: Eddy viscosity coeff. for mixing of
445 C momentum laterally ( m^2/s )
446 C viscAhW :: Eddy viscosity coeff. for mixing of vertical
447 C momentum laterally, no effect for hydrostatic
448 C model, defaults to viscAh if unset ( m^2/s )
449 C viscAr :: Eddy viscosity coeff. for mixing of
450 C momentum vertically ( units of r^2/s )
451 C viscA4 :: Biharmonic viscosity coeff. for mixing of
452 C momentum laterally ( m^4/s )
453 C viscA4W :: Biharmonic viscosity coeff. for mixing of vertical
454 C momentum laterally, no effect for hydrostatic
455 C model, defaults to viscA4 if unset ( m^2/s )
456 C viscAhD :: Eddy viscosity coeff. for mixing of momentum laterally
457 C (act on Divergence part) ( m^2/s )
458 C viscAhZ :: Eddy viscosity coeff. for mixing of momentum laterally
459 C (act on Vorticity part) ( m^2/s )
460 C viscA4D :: Biharmonic viscosity coeff. for mixing of momentum laterally
461 C (act on Divergence part) ( m^4/s )
462 C viscA4Z :: Biharmonic viscosity coeff. for mixing of momentum laterally
463 C (act on Vorticity part) ( m^4/s )
464 C viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))
465 C viscC2leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
466 C viscC2smag :: Smagorinsky non-dimensional viscosity factor
467 C viscAhMax :: Maximum eddy viscosity coeff. for mixing of
468 C momentum laterally ( m^2/s )
469 C viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
470 C viscAhGridMin:: in terms of non-dimensional grid-size dependent viscosity
471 C viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
472 C momentum laterally ( m^4/s )
473 C viscAhGrid:: non-dimensional grid-size dependent viscosity
474 C viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
475 C viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
476 C viscA4GridMin:: in terms of non-dimensional grid-size dependent viscosity
477 C viscC4leith :: Leith non-dimensional viscosity factor (grad(vort))
478 C viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
479 C diffKhT :: Laplacian diffusion coeff. for mixing of
480 C heat laterally ( m^2/s )
481 C diffKrNrT :: vertical profile of Laplacian diffusion coeff.
482 C for mixing of heat vertically ( units of r^2/s )
483 C diffK4T :: Biharmonic diffusion coeff. for mixing of
484 C heat laterally ( m^4/s )
485 C diffKhS :: Laplacian diffusion coeff. for mixing of
486 C salt laterally ( m^2/s )
487 C diffKrNrS :: vertical profile of Laplacian diffusion coeff.
488 C for mixing of salt vertically ( units of r^2/s ),
489 C diffK4S :: Biharmonic diffusion coeff. for mixing of
490 C salt laterally ( m^4/s )
491 C diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
492 C diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
493 C diffKrBL79scl :: depth scale for arctan fn (m) Bryan and Lewis, 1979
494 C diffKrBL79Ho :: depth offset for arctan fn (m) Bryan and Lewis, 1979
495 C deltaT :: Default timestep ( s )
496 C deltaTClock :: Timestep used as model "clock". This determines the
497 C IO frequencies and is used in tagging output. It can
498 C be totally different to the dynamical time. Typically
499 C it will be the deep-water timestep for accelerated runs.
500 C Frequency of checkpointing and dumping of the model state
501 C are referenced to this clock. ( s )
502 C deltaTMom :: Timestep for momemtum equations ( s )
503 C dTtracerLev :: Timestep for tracer equations ( s ), function of level k
504 C deltaTfreesurf :: Timestep for free-surface equation ( s )
505 C freesurfFac :: Parameter to turn implicit free surface term on or off
506 C freesurfac = 1. uses implicit free surface
507 C freesurfac = 0. uses rigid lid
508 C implicSurfPress :: parameter of the Crank-Nickelson time stepping :
509 C Implicit part of Surface Pressure Gradient ( 0-1 )
510 C implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
511 C Implicit part of barotropic flow Divergence ( 0-1 )
512 C hFacMin :: Minimum fraction size of a cell (affects hFacC etc...)
513 C hFacMinDz :: Minimum dimesional size of a cell (affects hFacC etc..., m)
514 C hFacMinDp :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
515 C hFacMinDr :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
516 C hFacInf :: Threshold (inf and sup) for fraction size of surface cell
517 C hFacSup that control vanishing and creating levels
518 C tauCD :: CD scheme coupling timescale ( 1/s )
519 C rCD :: CD scheme normalised coupling parameter ( 0-1 )
520 C baseTime :: model base time (time origin) = time @ iteration zero
521 C startTime :: Starting time for this integration ( s ).
522 C endTime :: Ending time for this integration ( s ).
523 C chkPtFreq :: Frequency of rolling check pointing ( s ).
524 C pChkPtFreq :: Frequency of permanent check pointing ( s ).
525 C dumpFreq :: Frequency with which model state is written to
526 C post-processing files ( s ).
527 C diagFreq :: Frequency with which model writes diagnostic output
528 C of intermediate quantities.
529 C afFacMom :: Advection of momentum term tracer parameter
530 C vfFacMom :: Momentum viscosity tracer parameter
531 C pfFacMom :: Momentum pressure forcing tracer parameter
532 C cfFacMom :: Coriolis term tracer parameter
533 C foFacMom :: Momentum forcing tracer parameter
534 C mtFacMom :: Metric terms tracer parameter
535 C cosPower :: Power of cosine of latitude to multiply viscosity
536 C cAdjFreq :: Frequency of convective adjustment
537 C
538 C taveFreq :: Frequency with which time-averaged model state
539 C is written to post-processing files ( s ).
540 C tave_lastIter :: (for state variable only) fraction of the last time
541 C step (of each taveFreq period) put in the time average.
542 C (fraction for 1rst iter = 1 - tave_lastIter)
543 C tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
544 C lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
545 C tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
546 C lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
547 C latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
548 C i.e. where |yC| <= latBandClimRelax
549 C externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
550 C externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
551 C (note: externForcingCycle must be an integer
552 C number times externForcingPeriod)
553 C convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
554 C (use model surface (local) value if set to -1)
555 C temp_EvPrRn :: temperature of Rain & Evap.
556 C salt_EvPrRn :: salinity of Rain & Evap.
557 C (notes: a) tracer content of Rain/Evap only used if both
558 C NonLin_FrSurf & useRealFreshWater are set.
559 C b) use model surface (local) value if set to UNSET_RL)
560 C horiVertRatio :: Ratio on units in vertical to units in horizontal.
561 C recip_horiVertRatio ( 1 if horiz in m and vertical in m ).
562 C ( g*rho if horiz in m and vertical in Pa ).
563 C Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
564 C starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
565 C bottomDragLinear :: Drag coefficient built in to core dynamics
566 C --"-"-- Quadratic ( linear: 1/s, quadratic: 1/m )
567 COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
568 & cg2dpcOffDFac, cg3dTargetResidual,
569 & delR, delRc, delX, delY,
570 & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
571 & abeps,
572 & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
573 & viscAh, viscAhW, viscAhMax,
574 & viscAhGrid, viscAhGridMax, viscAhGridMin,
575 & viscC2leith, viscC2leithD,
576 & viscC2smag,
577 & viscAhD, viscAhZ, viscA4D, viscA4Z,
578 & viscA4, viscA4W,
579 & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,
580 & viscC4leith, viscC4leithD, viscAr, viscAstrain, viscAtension,
581 & diffKhT, diffK4T, diffKrNrT,
582 & diffKhS, diffK4S, diffKrNrS,
583 & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
584 & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
585 & hFacMin, hFacMinDz, hFacInf, hFacSup,
586 & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
587 & recip_rhoConst, rhoConst,
588 & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
589 & baseTime, startTime, endTime,
590 & chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,
591 & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
592 & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
593 & cosPower, cAdjFreq, omega, rotationPeriod,
594 & tauThetaClimRelax, lambdaThetaClimRelax,
595 & tauSaltClimRelax, lambdaSaltClimRelax,
596 & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
597 & externForcingCycle, externForcingPeriod,
598 & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
599 & hFacMinDr, hFacMinDp,
600 & horiVertRatio, recip_horiVertRatio,
601 & ivdc_kappa, Ro_SeaLevel,
602 & bottomDragLinear,bottomDragQuadratic,
603 & tCylIn, tCylOut
604
605 _RL cg2dTargetResidual
606 _RL cg2dTargetResWunit
607 _RL cg3dTargetResidual
608 _RL cg2dpcOffDFac
609 _RL delR(Nr)
610 _RL delRc(Nr+1)
611 _RL delX(Nx)
612 _RL delY(Ny)
613 _RL deltaT
614 _RL deltaTClock
615 _RL deltaTmom
616 _RL dTtracerLev(Nr)
617 _RL deltaTfreesurf
618 _RL abeps
619 _RL phiMin
620 _RL thetaMin
621 _RL rSphere
622 _RL recip_RSphere
623 _RL f0
624 _RL freeSurfFac
625 _RL implicSurfPress
626 _RL implicDiv2Dflow
627 _RL hFacMin
628 _RL hFacMinDz
629 _RL hFacMinDp
630 _RL hFacMinDr
631 _RL hFacInf
632 _RL hFacSup
633 _RL beta
634 _RL viscAh
635 _RL viscAhW
636 _RL viscAhD
637 _RL viscAhZ
638 _RL viscAhMax
639 _RL viscAhGrid
640 _RL viscAhGridMax
641 _RL viscAhGridMin
642 _RL viscC2leith
643 _RL viscC2leithD
644 _RL viscC2smag
645 _RL viscAstrain
646 _RL viscAtension
647 _RL viscAr
648 _RL viscA4
649 _RL viscA4W
650 _RL viscA4D
651 _RL viscA4Z
652 _RL viscA4Max
653 _RL viscA4Grid, viscA4GridMax, viscA4GridMin
654 _RL viscC4leith
655 _RL viscC4leithD
656 _RL diffKhT
657 _RL diffKrNrT(Nr)
658 _RL diffK4T
659 _RL diffKhS
660 _RL diffKrNrS(Nr)
661 _RL diffK4S
662 _RL diffKrBL79surf
663 _RL diffKrBL79deep
664 _RL diffKrBL79scl
665 _RL diffKrBL79Ho
666 _RL delt
667 _RL tauCD
668 _RL rCD
669 _RL gravity
670 _RL recip_gravity
671 _RL gBaro
672 _RL rhonil
673 _RL recip_rhonil
674 _RL rhoConst
675 _RL recip_rhoConst
676 _RL rhoConstFresh
677 _RL convertEmP2rUnit
678 _RL tRef(Nr)
679 _RL sRef(Nr)
680 _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
681 _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
682 _RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
683 _RS lambdaThetaClimRelax(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
684 _RS lambdaSaltClimRelax(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
685 _RL baseTime
686 _RL startTime
687 _RL endTime
688 _RL chkPtFreq
689 _RL pChkPtFreq
690 _RL dumpFreq
691 _RL adjDumpFreq
692 _RL diagFreq
693 _RL taveFreq
694 _RL tave_lastIter
695 _RL monitorFreq
696 _RL adjMonitorFreq
697 _RL afFacMom
698 _RL vfFacMom
699 _RL pfFacMom
700 _RL cfFacMom
701 _RL foFacMom
702 _RL mTFacMom
703 _RL cosPower
704 _RL cAdjFreq
705 _RL omega
706 _RL rotationPeriod
707 _RL tauThetaClimRelax
708 _RL tauSaltClimRelax
709 _RL tauTr1ClimRelax
710 _RL lambdaTr1ClimRelax
711 _RL latBandClimRelax
712 _RL externForcingCycle
713 _RL externForcingPeriod
714 _RL convertFW2Salt
715 _RL temp_EvPrRn
716 _RL salt_EvPrRn
717 _RL horiVertRatio
718 _RL recip_horiVertRatio
719 _RL ivdc_kappa
720 _RL Ro_SeaLevel
721 _RL bottomDragLinear
722 _RL bottomDragQuadratic
723 _RL tCylIn
724 _RL tCylOut
725
726 C-- COMMON /PARM_A/ Thermodynamics constants ?
727 COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
728 _RL HeatCapacity_Cp
729 _RL recip_Cp
730
731 C-- COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
732 C celsius2K :: convert centigrade (Celsius) degree to Kelvin
733 C atm_Po :: standard reference pressure
734 C atm_Cp :: specific heat (Cp) of the (dry) air at constant pressure
735 C atm_Rd :: gas constant for dry air
736 C atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
737 C atm_Rq :: water vapour specific volume anomaly relative to dry air
738 C (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
739 C integr_GeoPot :: option to select the way we integrate the geopotential
740 C (still a subject of discussions ...)
741 C selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
742 C derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
743 COMMON /PARM_ATM/
744 & celsius2K,
745 & atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
746 & integr_GeoPot, selectFindRoSurf
747 _RL celsius2K
748 _RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq
749 INTEGER integr_GeoPot, selectFindRoSurf
750
751 C Logical flags for selecting packages
752 LOGICAL useOPPS
753 LOGICAL usePP81
754 LOGICAL useMY82
755 LOGICAL useGGL90
756 LOGICAL useKPP
757 LOGICAL useGMRedi
758 LOGICAL useOBCS
759 LOGICAL useAIM
760 LOGICAL useLand
761 LOGICAL useGrdchk
762 LOGICAL useECCO
763 LOGICAL useSHAP_FILT
764 LOGICAL useZONAL_FILT
765 LOGICAL useFLT
766 LOGICAL usePTRACERS
767 LOGICAL useGCHEM
768 LOGICAL useSBO
769 LOGICAL useSEAICE
770 LOGICAL useBulkForce
771 LOGICAL useThSIce
772 LOGICAL usefizhi
773 LOGICAL usegridalt
774 LOGICAL usediagnostics
775 LOGICAL useEBM
776 LOGICAL useMNC
777 COMMON /PARM_PACKAGES/
778 & useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
779 & useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
780 & usePTRACERS, useGCHEM,
781 & useSBO, useSEAICE, useThSIce, useBulkForce,
782 & usefizhi, usegridalt, usediagnostics, useEBM, useMNC,
783 & usePP81, useMY82, useOPPS, useGGL90
784
785 CEH3 ;;; Local Variables: ***
786 CEH3 ;;; mode:fortran ***
787 CEH3 ;;; End: ***

  ViewVC Help
Powered by ViewVC 1.1.22