/[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.180 - (show annotations) (download)
Tue Mar 7 15:27:14 2006 UTC (18 years, 2 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint58b_post
Changes since 1.179: +10 -4 lines
File MIME type: text/plain
change forcing_In_AB to affects both T,S forcing and Momentum forcing
(allow to differentiate between forcing components using new integer flags:
 momForcingOutAB=1/0 & tracForcingOutAB=1/0)
and add new flag to put Dissipation tendency out of Adams-Bashforth.

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

  ViewVC Help
Powered by ViewVC 1.1.22