/[MITgcm]/MITgcm/model/inc/PARAMS.h
ViewVC logotype

Annotation of /MITgcm/model/inc/PARAMS.h

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.89 - (hide annotations) (download)
Thu Apr 17 13:11:31 2003 UTC (21 years, 1 month ago) by jmc
Branch: MAIN
CVS Tags: checkpoint50c_post, checkpoint50c_pre, checkpoint50d_post, checkpoint50f_post, checkpoint50f_pre, checkpoint50g_post, checkpoint50e_pre, checkpoint50e_post, checkpoint50d_pre, checkpoint50b_post
Changes since 1.88: +4 -1 lines
File MIME type: text/plain
new flag "useCDscheme" (default=F);

1 jmc 1.89 C $Header: /u/gcmpack/MITgcm/model/inc/PARAMS.h,v 1.88 2003/03/17 16:59:38 jmc Exp $
2 mlosch 1.74 C $Name: $
3 cnh 1.1 C
4 cnh 1.63 CBOP
5     C !ROUTINE: PARAMS.h
6     C !INTERFACE:
7     C include PARAMS.h
8     C !DESCRIPTION: \bv
9     C *==========================================================*
10     C | PARAMS.h
11     C | o Header file defining model "parameters".
12     C *==========================================================*
13     C | The values from the model standard input file are
14     C | stored into the variables held here. Notes describing
15     C | the parameters can also be found here.
16     C *==========================================================*
17     C \ev
18     CEOP
19 cnh 1.13
20     C Macros for special grid options
21     #include "PARAMS_MACROS.h"
22 cnh 1.1
23     C-- Contants
24     C Useful physical values
25     Real*8 PI
26     PARAMETER ( PI = 3.14159265358979323844D0 )
27     Real*8 deg2rad
28     PARAMETER ( deg2rad = 2.D0*PI/360.D0 )
29    
30 cnh 1.7 C Symbolic values
31 cnh 1.63 C precXXXX :: Used to indicate what precision to use for
32 cnh 1.7 C dumping model state.
33     INTEGER precFloat32
34 adcroft 1.36 PARAMETER ( precFloat32 = 32 )
35 cnh 1.7 INTEGER precFloat64
36 adcroft 1.36 PARAMETER ( precFloat64 = 64 )
37 cnh 1.63 C UNSET_xxx :: Used to indicate variables that have not been given a value
38 cnh 1.28 Real*8 UNSET_FLOAT8
39     PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
40     Real*4 UNSET_FLOAT4
41     PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )
42     _RL UNSET_RL
43     PARAMETER ( UNSET_RL = 1.234567D5 )
44     _RS UNSET_RS
45     PARAMETER ( UNSET_RS = 1.234567E5 )
46     INTEGER UNSET_I
47     PARAMETER ( UNSET_I = 123456789 )
48 cnh 1.7
49     C Checkpoint data
50     INTEGER maxNoChkptLev
51     PARAMETER ( maxNoChkptLev = 2 )
52    
53 cnh 1.1 C-- COMMON /PARM_C/ Character valued parameters used by the model.
54 cnh 1.63 C checkPtSuff :: List of checkpoint file suffices
55     C bathyFile :: File containing bathymetry. If not defined bathymetry
56 cnh 1.16 C is taken from inline function.
57 cnh 1.63 C topoFile :: File containing the topography of the surface (unit=m)
58 jmc 1.55 C (mainly used for the atmosphere = ground height).
59 cnh 1.63 C hydrogThetaFile :: File containing initial hydrographic data for potential
60 cnh 1.16 C temperature.
61 cnh 1.63 C hydrogSaltFile :: File containing initial hydrographic data for salinity.
62     C zonalWindFile :: File containing zonal wind data
63     C meridWindFile :: File containing meridional wind data
64     C thetaClimFile :: File containing theta climataology used
65 cnh 1.18 C in relaxation term -lambda(theta-theta*)
66 cnh 1.63 C saltClimFile :: File containing salt climataology used
67 cnh 1.18 C in relaxation term -lambda(salt-salt*)
68 cnh 1.63 C surfQfile :: File containing surface heat flux
69     C surfQswfile :: File containing surface shortwave radiation
70     C dQdTfile :: File containing thermal relaxation coefficient
71     C EmPmRfile :: File containing surface fresh water flux
72 mlosch 1.73 C pLoadFile :: File containing pressure loading
73 cnh 1.63 C buoyancyRelation :: Flag used to indicate which relation to use to
74 cnh 1.26 C get buoyancy.
75 mlosch 1.74 C eosType :: choose the equation of state:
76 jmc 1.87 C LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
77 cnh 1.16 COMMON /PARM_C/ checkPtSuff,
78 jmc 1.55 & bathyFile, topoFile,
79     & hydrogThetaFile, hydrogSaltFile,
80 cnh 1.18 & zonalWindFile, meridWindFile, thetaClimFile,
81 adcroft 1.37 & saltClimFile, buoyancyRelation,
82 heimbach 1.45 & EmPmRfile, surfQfile, surfQswfile,
83 heimbach 1.50 & uVelInitFile, vVelInitFile, pSurfInitFile,
84 mlosch 1.74 & dQdTfile, ploadFile,
85     & eosType
86 cnh 1.7 CHARACTER*(5) checkPtSuff(maxNoChkptLev)
87 jmc 1.55 CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
88 cnh 1.16 CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
89     CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
90     CHARACTER*(MAX_LEN_FNAM) zonalWindFile
91     CHARACTER*(MAX_LEN_FNAM) meridWindFile
92 cnh 1.18 CHARACTER*(MAX_LEN_FNAM) thetaClimFile
93     CHARACTER*(MAX_LEN_FNAM) saltClimFile
94 adcroft 1.37 CHARACTER*(MAX_LEN_FNAM) surfQfile
95 heimbach 1.45 CHARACTER*(MAX_LEN_FNAM) surfQswfile
96 adcroft 1.37 CHARACTER*(MAX_LEN_FNAM) EmPmRfile
97 cnh 1.26 CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
98 adcroft 1.42 CHARACTER*(MAX_LEN_FNAM) uVelInitFile
99     CHARACTER*(MAX_LEN_FNAM) vVelInitFile
100 adcroft 1.43 CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
101 heimbach 1.50 CHARACTER*(MAX_LEN_FNAM) dQdTfile
102 mlosch 1.73 CHARACTER*(MAX_LEN_FNAM) ploadFile
103 mlosch 1.74 CHARACTER*(6) eosType
104 cnh 1.7
105 cnh 1.1 C-- COMMON /PARM_I/ Integer valued parameters used by the model.
106 cnh 1.63 C cg2dMaxIters :: Maximum number of iterations in the
107 cnh 1.1 C two-dimensional con. grad solver.
108 cnh 1.63 C cg2dChkResFreq :: Frequency with which to check residual
109 cnh 1.1 C in con. grad solver.
110 cnh 1.63 C cg3dMaxIters :: Maximum number of iterations in the
111 cnh 1.33 C three-dimensional con. grad solver.
112 cnh 1.63 C cg3dChkResFreq :: Frequency with which to check residual
113 cnh 1.33 C in con. grad solver.
114 cnh 1.63 C nIter0 :: Start time-step number of for this run
115     C nTimeSteps :: Number of timesteps to execute
116     C numStepsPerPickup :: For offline setup. Frequency of pickup
117 cnh 1.1 C of flow fields.
118 cnh 1.63 C writeStatePrec :: Precision used for writing model state.
119     C writeBinaryPrec :: Precision used for writing binary files
120     C readBinaryPrec :: Precision used for reading binary files
121     C nCheckLev :: Holds current checkpoint level
122     C nonlinFreeSurf :: option related to non-linear free surface
123 jmc 1.55 C =0 Linear free surface ; >0 Non-linear
124 jmc 1.84 C select_rStar :: option related to r* vertical coordinate
125     C =0 (default) use r coord. ; > 0 use r*
126 cnh 1.34
127 cnh 1.1 COMMON /PARM_I/
128     & cg2dMaxIters,
129     & cg2dChkResFreq,
130 cnh 1.33 & cg3dMaxIters,
131     & cg3dChkResFreq,
132 adcroft 1.41 & nIter0, nTimeSteps, nEndIter,
133 cnh 1.7 & numStepsPerPickup,
134     & writeStatePrec, nCheckLev,
135 cnh 1.34 & writeBinaryPrec, readBinaryPrec,
136 jmc 1.84 & nonlinFreeSurf, select_rStar,
137 adcroft 1.57 & tempAdvScheme, saltAdvScheme, tracerAdvScheme
138 cnh 1.1 INTEGER cg2dMaxIters
139     INTEGER cg2dChkResFreq
140 cnh 1.33 INTEGER cg3dMaxIters
141     INTEGER cg3dChkResFreq
142 cnh 1.1 INTEGER nIter0
143     INTEGER nTimeSteps
144 adcroft 1.41 INTEGER nEndIter
145 cnh 1.1 INTEGER numStepsPerPickup
146 cnh 1.7 INTEGER writeStatePrec
147     INTEGER writeBinaryPrec
148     INTEGER readBinaryPrec
149     INTEGER nCheckLev
150 jmc 1.55 INTEGER nonlinFreeSurf
151 jmc 1.84 INTEGER select_rStar
152 adcroft 1.57 INTEGER tempAdvScheme
153     INTEGER saltAdvScheme
154     INTEGER tracerAdvScheme
155 cnh 1.1
156     C-- COMMON /PARM_L/ Logical valued parameters used by the model.
157 cnh 1.63 C usingCartesianGrid :: If TRUE grid generation will be in a cartesian
158 cnh 1.1 C coordinate frame.
159 cnh 1.63 C usingSphericalPolarGrid :: If TRUE grid generation will be in a
160 cnh 1.1 C spherical polar frame.
161 cnh 1.63 C no_slip_sides :: Impose "no-slip" at lateral boundaries.
162     C no_slip_bottom :: Impose "no-slip" at bottom boundary.
163     C staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
164     C momViscosity :: Flag which turns momentum friction terms on and off.
165     C momAdvection :: Flag which turns advection of momentum on and off.
166     C momForcing :: Flag which turns external forcing of momentum on
167 cnh 1.1 C and off.
168 cnh 1.63 C momPressureForcing :: Flag which turns pressure term in momentum equation
169 cnh 1.9 C on and off.
170 cnh 1.63 C metricTerms :: Flag which turns metric terms on or off.
171     C usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
172 adcroft 1.77 C useNHMTerms :: If TRUE use non-hydrostatic metric terms.
173 cnh 1.63 C useCoriolis :: Flag which turns the coriolis terms on and off.
174     C tempDiffusion :: Flag which turns diffusion of temperature on
175 cnh 1.1 C and off.
176 cnh 1.63 C tempAdvection :: Flag which turns advection of temperature on
177 cnh 1.1 C and off.
178 cnh 1.63 C tempForcing :: Flag which turns external forcing of temperature on
179 cnh 1.1 C and off.
180 jmc 1.71 C saltDiffusion :: Flag which turns diffusion of salinity on
181 cnh 1.1 C and off.
182 jmc 1.71 C saltAdvection :: Flag which turns advection of salinity on
183 cnh 1.1 C and off.
184 jmc 1.71 C saltForcing :: Flag which turns external forcing of salinity on
185 cnh 1.1 C and off.
186 jmc 1.71 C useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
187     C as a real Fresh Water (=> changes the Sea Level)
188     C if F, converts P+R-E to salt flux (no SL effect)
189 cnh 1.63 C rigidLid :: Set to true to use rigid lid
190     C implicitFreeSurface :: Set to true to use implcit free surface
191     C exactConserv :: Set to true to conserve exactly the total Volume
192     C uniformLin_PhiSurf :: Set to true to use a uniform Bo_surf in the
193 jmc 1.55 C linear relation Phi_surf = Bo_surf*eta
194 cnh 1.63 C momStepping :: Turns momentum equation time-stepping off
195     C tempStepping :: Turns temperature equation time-stepping off
196     C saltStepping :: Turns salinity equation time-stepping off
197     C tr1Stepping :: Turns passive tracer 1 time-stepping on/off
198     C useConstantF :: Coriolis parameter set to f0
199     C useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
200     C useSphereF :: Coriolis parameter set to 2.omega.sin(phi)
201 jmc 1.89 C useCDscheme :: use CD-scheme to calculate Coriolis terms.
202 jmc 1.71 C useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
203 cnh 1.63 C implicitDiffusion :: Turns implicit vertical diffusion on
204     C implicitViscosity :: Turns implicit vertical viscosity on
205 jmc 1.71 C multiDimAdvection :: Flag that enable multi-dimension advection
206     C forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
207     C out off Adams-Bashforth time stepping.
208 cnh 1.63 C doThetaClimRelax :: Set true if relaxation to temperature
209 cnh 1.18 C climatology is required.
210 cnh 1.63 C doSaltClimRelax :: Set true if relaxation to salinity
211 cnh 1.18 C climatology is required.
212 cnh 1.63 C periodicExternalForcing :: Set true if forcing is time-dependant
213     C usingPCoords :: Set to indicate that we are working in pressure
214 jmc 1.87 C coords. (jmc: is it still used ?)
215 cnh 1.63 C usingZCoords :: Set to indicate that we are working in height
216 jmc 1.87 C coords. (jmc: is it still used ?)
217     C useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
218     C this requires specific code for restart & exchange
219 jmc 1.70 C setCenterDr :: set cell Center depth and put Interface at the middle
220 cnh 1.63 C nonHydrostatic :: Using non-hydrostatic terms
221 adcroft 1.79 C quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
222 cnh 1.63 C globalFiles :: Selects between "global" and "tiled" files
223 dimitri 1.85 C useSingleCpuIO :: On SGI platforms, option globalFiles is either
224     C slow (f77) or does not work (f90). When
225     C useSingleCpuIO is set, mdsio_writefield.F
226     C outputs from master mpi process only.
227 cnh 1.63 C allowFreezing :: Allows water to freeze and form ice
228     C groundAtK1 :: put the surface(k=1) at the Lower Boundary (=ground)
229 cnh 1.1 COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
230 adcroft 1.52 & usingCurvilinearGrid,
231 adcroft 1.36 & no_slip_sides,no_slip_bottom,
232 adcroft 1.46 & staggerTimeStep,
233 cnh 1.33 & momViscosity, momAdvection, momForcing, useCoriolis,
234 adcroft 1.58 & momPressureForcing, vectorInvariantMomentum,
235     & tempDiffusion, tempAdvection, tempForcing,
236 cnh 1.8 & saltDiffusion, saltAdvection, saltForcing,
237 jmc 1.68 & useRealFreshWaterFlux,
238 jmc 1.55 & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
239 heimbach 1.56 & momStepping, tempStepping, saltStepping, tr1Stepping,
240 adcroft 1.77 & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
241 cnh 1.15 & useConstantF, useBetaPlaneF, useSphereF,
242 jmc 1.89 & useCDscheme,
243 jmc 1.71 & useEnergyConservingCoriolis, useJamartWetPoints,
244 adcroft 1.40 & implicitDiffusion, implicitViscosity,
245 jmc 1.71 & multiDimAdvection, forcing_In_AB,
246 heimbach 1.56 & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
247 jmc 1.70 & periodicExternalForcing,
248 jmc 1.87 & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
249 dimitri 1.85 & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
250 heimbach 1.51 & allowFreezing, groundAtK1,
251 heimbach 1.56 & usePickupBeforeC35, debugMode,
252 jmc 1.71 & readPickupWithTracer, writePickupWithTracer
253 cnh 1.1 LOGICAL usingCartesianGrid
254     LOGICAL usingSphericalPolarGrid
255 adcroft 1.52 LOGICAL usingCurvilinearGrid
256 cnh 1.15 LOGICAL usingSphericalPolarMTerms
257 adcroft 1.77 LOGICAL useNHMTerms
258 adcroft 1.36 LOGICAL no_slip_sides
259     LOGICAL no_slip_bottom
260 adcroft 1.46 LOGICAL staggerTimeStep
261 cnh 1.1 LOGICAL momViscosity
262     LOGICAL momAdvection
263     LOGICAL momForcing
264 cnh 1.9 LOGICAL momPressureForcing
265 cnh 1.1 LOGICAL useCoriolis
266 adcroft 1.58 LOGICAL vectorInvariantMomentum
267 cnh 1.1 LOGICAL tempDiffusion
268     LOGICAL tempAdvection
269     LOGICAL tempForcing
270     LOGICAL saltDiffusion
271     LOGICAL saltAdvection
272     LOGICAL saltForcing
273 jmc 1.68 LOGICAL useRealFreshWaterFlux
274 adcroft 1.52 LOGICAL rigidLid
275 cnh 1.8 LOGICAL implicitFreeSurface
276 adcroft 1.52 LOGICAL exactConserv
277 jmc 1.55 LOGICAL uniformLin_PhiSurf
278 cnh 1.10 LOGICAL momStepping
279     LOGICAL tempStepping
280 adcroft 1.17 LOGICAL saltStepping
281 heimbach 1.56 LOGICAL tr1Stepping
282 cnh 1.15 LOGICAL metricTerms
283     LOGICAL useConstantF
284     LOGICAL useBetaPlaneF
285     LOGICAL useSphereF
286 jmc 1.89 LOGICAL useCDscheme
287 jmc 1.71 LOGICAL useEnergyConservingCoriolis
288     LOGICAL useJamartWetPoints
289 adcroft 1.14 LOGICAL implicitDiffusion
290 adcroft 1.40 LOGICAL implicitViscosity
291 jmc 1.71 LOGICAL multiDimAdvection
292     LOGICAL forcing_In_AB
293 cnh 1.18 LOGICAL doThetaClimRelax
294     LOGICAL doSaltClimRelax
295 heimbach 1.56 LOGICAL doTr1ClimRelax
296 adcroft 1.19 LOGICAL periodicExternalForcing
297 cnh 1.29 LOGICAL usingPCoords
298     LOGICAL usingZCoords
299 jmc 1.87 LOGICAL useDynP_inEos_Zc
300 jmc 1.70 LOGICAL setCenterDr
301 adcroft 1.37 LOGICAL nonHydrostatic
302 adcroft 1.79 LOGICAL quasiHydrostatic
303 adcroft 1.38 LOGICAL globalFiles
304 dimitri 1.85 LOGICAL useSingleCpuIO
305 adcroft 1.38 LOGICAL allowFreezing
306 adcroft 1.46 LOGICAL groundAtK1
307 heimbach 1.51 LOGICAL usePickupBeforeC35
308 adcroft 1.54 LOGICAL debugMode
309 heimbach 1.56 LOGICAL readPickupWithTracer
310     LOGICAL writePickupWithTracer
311 cnh 1.1
312     C-- COMMON /PARM_R/ "Real" valued parameters used by the model.
313 adcroft 1.52 C gg2dTargetResidual
314 cnh 1.63 C :: Target residual for cg2d solver; no unit (RHS normalisation)
315 adcroft 1.52 C cg2dTargetResWunit
316 cnh 1.63 C :: Target residual for cg2d solver; W unit (No RHS normalisation)
317 cnh 1.33 C cg3dTargetResidual
318 cnh 1.63 C :: Target residual for cg3d solver.
319     C cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
320 cnh 1.7 C Note. 20th May 1998
321     C I made a weird discovery! In the model paper we argue
322     C for the form of the preconditioner used here ( see
323     C A Finite-volume, Incompressible Navier-Stokes Model
324     C ...., Marshall et. al ). The algebra gives a simple
325     C 0.5 factor for the averaging of ac and aCw to get a
326     C symmettric pre-conditioner. By using a factor of 0.51
327     C i.e. scaling the off-diagonal terms in the
328     C preconditioner down slightly I managed to get the
329     C number of iterations for convergence in a test case to
330     C drop form 192 -> 134! Need to investigate this further!
331     C For now I have introduced a parameter cg2dpcOffDFac which
332     C defaults to 0.51 but can be set at runtime.
333 cnh 1.63 C delP :: Vertical grid spacing ( Pa ).
334     C delZ :: Vertical grid spacing ( m ).
335     C delR :: Vertical grid spacing ( units of r ).
336 jmc 1.70 C delRc :: Vertical grid spacing between cell centers (r unit).
337 cnh 1.63 C delX :: Separation between cell faces (m) or (deg), depending
338 cnh 1.1 C delY on input flags.
339 cnh 1.63 C gravity :: Accel. due to gravity ( m/s^2 )
340 cnh 1.32 C recip_gravity and its inverse
341 cnh 1.63 C gBaro :: Accel. due to gravity used in barotropic equation ( m/s^2 )
342 mlosch 1.75 C rhoNil :: Reference density for the linear equation of state
343 cnh 1.63 C rhoConst :: Vertically constant reference density
344 mlosch 1.75 C rhoConstFresh :: Constant reference density for fresh water (rain)
345 cnh 1.63 C startTime :: Start time for model ( s )
346     C phiMin :: Latitude of southern most cell face.
347     C thetaMin :: Longitude of western most cell face (this
348 cnh 1.1 C is an "inert" parameter but it is included
349     C to make geographical references simple.)
350 cnh 1.63 C rSphere :: Radius of sphere for a spherical polar grid ( m ).
351     C recip_RSphere :: Reciprocal radius of sphere ( m ).
352     C f0 :: Reference coriolis parameter ( 1/s )
353 cnh 1.1 C ( Southern edge f for beta plane )
354 cnh 1.63 C beta :: df/dy ( s^-1.m^-1 )
355     C omega :: Angular velocity ( rad/s )
356 jmc 1.88 C rotationPeriod :: Rotation period (s) (= 2.pi/omega)
357 cnh 1.63 C viscAh :: Eddy viscosity coeff. for mixing of
358 cnh 1.1 C momentum laterally ( m^2/s )
359 cnh 1.63 C viscAz :: Eddy viscosity coeff. for mixing of
360 cnh 1.1 C momentum vertically ( m^2/s )
361 cnh 1.63 C viscAp :: Eddy viscosity coeff. for mixing of
362 cnh 1.27 C momentum vertically ( Pa^2/s )
363 cnh 1.63 C viscAr :: Eddy viscosity coeff. for mixing of
364 cnh 1.24 C momentum vertically ( units of r^2/s )
365 cnh 1.63 C viscA4 :: Biharmonic viscosity coeff. for mixing of
366 cnh 1.1 C momentum laterally ( m^4/s )
367 cnh 1.63 C diffKhT :: Laplacian diffusion coeff. for mixing of
368 cnh 1.1 C heat laterally ( m^2/s )
369 cnh 1.63 C diffKzT :: Laplacian diffusion coeff. for mixing of
370 cnh 1.1 C heat vertically ( m^2/s )
371 cnh 1.63 C diffKpT :: Laplacian diffusion coeff. for mixing of
372 cnh 1.27 C heat vertically ( Pa^2/s )
373 cnh 1.63 C diffKrT :: Laplacian diffusion coeff. for mixing of
374 cnh 1.24 C heat vertically ( units of r^2/s )
375 cnh 1.63 C diffK4T :: Biharmonic diffusion coeff. for mixing of
376 cnh 1.1 C heat laterally ( m^4/s )
377 cnh 1.63 C diffKhS :: Laplacian diffusion coeff. for mixing of
378 cnh 1.1 C salt laterally ( m^2/s )
379 cnh 1.63 C diffKzS :: Laplacian diffusion coeff. for mixing of
380 cnh 1.1 C salt vertically ( m^2/s )
381 cnh 1.63 C diffKpS :: Laplacian diffusion coeff. for mixing of
382 cnh 1.27 C salt vertically ( Pa^2/s )
383 cnh 1.63 C diffKrS :: Laplacian diffusion coeff. for mixing of
384 cnh 1.24 C salt vertically ( units of r^2/s )
385 cnh 1.63 C diffK4S :: Biharmonic diffusion coeff. for mixing of
386 cnh 1.1 C salt laterally ( m^4/s )
387 cnh 1.63 C deltaT :: Default timestep ( s )
388     C deltaTClock :: Timestep used as model "clock". This determines the
389 cnh 1.7 C IO frequencies and is used in tagging output. It can
390     C be totally different to the dynamical time. Typically
391     C it will be the deep-water timestep for accelerated runs.
392     C Frequency of checkpointing and dumping of the model state
393     C are referenced to this clock. ( s )
394 cnh 1.63 C deltaTMom :: Timestep for momemtum equations ( s )
395     C deltaTtracer :: Timestep for tracer equations ( s )
396 adcroft 1.72 C deltaTfreesurf :: Timestep for free-surface equation ( s )
397 cnh 1.63 C freesurfFac :: Parameter to turn implicit free surface term on or off
398 cnh 1.8 C freesurfac = 1. uses implicit free surface
399     C freesurfac = 0. uses rigid lid
400 cnh 1.63 C implicSurfPress :: parameter of the Crank-Nickelson time stepping :
401 jmc 1.48 C Implicit part of Surface Pressure Gradient ( 0-1 )
402 cnh 1.63 C implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
403 jmc 1.48 C Implicit part of barotropic flow Divergence ( 0-1 )
404 cnh 1.63 C hFacMin :: Minimum fraction size of a cell (affects hFacC etc...)
405     C hFacMinDz :: Minimum dimesional size of a cell (affects hFacC etc..., m)
406     C hFacMinDp :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
407     C hFacMinDr :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
408     C hFacInf :: Threshold (inf and sup) for fraction size of surface cell
409 adcroft 1.52 C hFacSup that control vanishing and creating levels
410 cnh 1.63 C tauCD :: CD scheme coupling timescale ( 1/s )
411     C rCD :: CD scheme normalised coupling parameter ( 0-1 )
412     C startTime :: Starting time for this integration ( s ).
413     C endTime :: Ending time for this integration ( s ).
414     C chkPtFreq :: Frequency of rolling check pointing ( s ).
415     C pChkPtFreq :: Frequency of permanent check pointing ( s ).
416     C dumpFreq :: Frequency with which model state is written to
417 cnh 1.24 C post-processing files ( s ).
418 cnh 1.63 C diagFreq :: Frequency with which model writes diagnostic output
419 adcroft 1.59 C of intermediate quantities.
420 cnh 1.63 C afFacMom :: Advection of momentum term tracer parameter
421     C vfFacMom :: Momentum viscosity tracer parameter
422     C pfFacMom :: Momentum pressure forcing tracer parameter
423     C cfFacMom :: Coriolis term tracer parameter
424     C foFacMom :: Momentum forcing tracer parameter
425     C mtFacMom :: Metric terms tracer parameter
426     C cosPower :: Power of cosine of latitude to multiply viscosity
427     C cAdjFreq :: Frequency of convective adjustment
428 cnh 1.24 C
429 jmc 1.76 C taveFreq :: Frequency with which time-averaged model state
430     C is written to post-processing files ( s ).
431     C tave_lastIter :: (for state variable only) fraction of the last time
432     C step (of each taveFreq period) put in the time average.
433     C (fraction for 1rst iter = 1 - tave_lastIter)
434 cnh 1.63 C tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
435     C lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
436     C tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
437     C lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
438     C externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
439     C externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
440 adcroft 1.19 C (note: externForcingCycle must be an integer
441     C number times externForcingPeriod)
442 jmc 1.68 C convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
443     C (use model surface (local) value if set to -1)
444     C temp_EvPrRn :: temperature of Rain & Evap.
445     C salt_EvPrRn :: salinity of Rain & Evap.
446     C trac_EvPrRn :: tracer concentration in Rain & Evap.
447     C (notes: a) tracer content of Rain/Evap only used if both
448     C NonLin_FrSurf & useRealFreshWater are set.
449     C b) use model surface (local) value if set to UNSET_RL)
450 cnh 1.63 C horiVertRatio :: Ratio on units in vertical to units in horizontal.
451 cnh 1.31 C recip_horiVertRatio ( 1 if horiz in m and vertical in m ).
452 cnh 1.30 C ( g*rho if horiz in m and vertical in Pa ).
453 cnh 1.63 C Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
454 adcroft 1.46 C starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
455 cnh 1.63 C bottomDragLinear :: Drag coefficient built in to core dynamics
456 adcroft 1.64 C --"-"-- Quadratic ( linear: 1/s, quadratic: 1/m )
457 adcroft 1.52 COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
458     & cg2dpcOffDFac, cg3dTargetResidual,
459 jmc 1.70 & delP, delZ, delR, delRc, delX, delY,
460 adcroft 1.72 & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,
461     & abeps, startTime,
462 adcroft 1.52 & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
463 adcroft 1.78 & fCori, fCoriG, fCoriCos,
464 adcroft 1.60 & viscAh, viscAz, viscA4, viscAr, viscAstrain, viscAtension,
465 cnh 1.24 & diffKhT, diffKzT, diffK4T, diffKrT,
466 cnh 1.25 & diffKhS, diffKzS, diffK4S, diffKrS,
467 jmc 1.48 & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
468 adcroft 1.52 & hFacMin, hFacMinDz, hFacInf, hFacSup,
469 cnh 1.32 & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
470 mlosch 1.75 & recip_rhoConst, rhoConst,
471 jmc 1.76 & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
472 adcroft 1.59 & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
473 jmc 1.76 & diagFreq, taveFreq, tave_lastIter, monitorFreq,
474 cnh 1.15 & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
475 jmc 1.88 & cosPower, cAdjFreq, omega, rotationPeriod,
476 heimbach 1.56 & tauThetaClimRelax, lambdaThetaClimRelax,
477 adcroft 1.19 & tauSaltClimRelax, lambdaSaltClimRelax,
478 heimbach 1.56 & tauTr1ClimRelax, lambdaTr1ClimRelax,
479 cnh 1.27 & externForcingCycle, externForcingPeriod,
480 jmc 1.68 & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,
481 cnh 1.28 & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
482 jmc 1.68 & horiVertRatio, recip_horiVertRatio,
483 jmc 1.67 & ivdc_kappa, Ro_SeaLevel,
484 adcroft 1.46 & bottomDragLinear,bottomDragQuadratic
485 cnh 1.27
486 adcroft 1.6 _RL cg2dTargetResidual
487 adcroft 1.52 _RL cg2dTargetResWunit
488 cnh 1.33 _RL cg3dTargetResidual
489 cnh 1.7 _RL cg2dpcOffDFac
490 cnh 1.25 _RL delZ(Nr)
491     _RL delP(Nr)
492     _RL delR(Nr)
493 jmc 1.70 _RL delRc(Nr+1)
494 adcroft 1.6 _RL delX(Nx)
495     _RL delY(Ny)
496     _RL deltaT
497 cnh 1.7 _RL deltaTClock
498 adcroft 1.6 _RL deltaTmom
499     _RL deltaTtracer
500 adcroft 1.72 _RL deltaTfreesurf
501 adcroft 1.6 _RL abeps
502     _RL phiMin
503     _RL thetaMin
504     _RL rSphere
505 cnh 1.25 _RL recip_RSphere
506 adcroft 1.6 _RL f0
507 cnh 1.8 _RL freeSurfFac
508 jmc 1.48 _RL implicSurfPress
509     _RL implicDiv2Dflow
510 adcroft 1.22 _RL hFacMin
511     _RL hFacMinDz
512 cnh 1.28 _RL hFacMinDp
513 cnh 1.27 _RL hFacMinDr
514 adcroft 1.52 _RL hFacInf
515     _RL hFacSup
516 adcroft 1.6 _RL beta
517     _RL viscAh
518 adcroft 1.60 _RL viscAstrain
519     _RL viscAtension
520 adcroft 1.6 _RL viscAz
521 cnh 1.27 _RL viscAp
522 cnh 1.25 _RL viscAr
523 adcroft 1.6 _RL viscA4
524     _RL diffKhT
525 cnh 1.25 _RL diffKrT
526 adcroft 1.6 _RL diffKzT
527 cnh 1.27 _RL diffKpT
528 adcroft 1.6 _RL diffK4T
529     _RL diffKhS
530 cnh 1.25 _RL diffKrS
531 adcroft 1.6 _RL diffKzS
532 cnh 1.27 _RL diffKpS
533 adcroft 1.6 _RL diffK4S
534     _RL delt
535     _RL tauCD
536     _RL rCD
537     _RL gravity
538 cnh 1.32 _RL recip_gravity
539 cnh 1.8 _RL gBaro
540 adcroft 1.6 _RL rhonil
541 cnh 1.25 _RL recip_rhonil
542     _RL rhoConst
543 cnh 1.26 _RL recip_rhoConst
544 mlosch 1.75 _RL rhoConstFresh
545 jmc 1.76 _RL convertEmP2rUnit
546 cnh 1.25 _RL tRef(Nr)
547     _RL sRef(Nr)
548 adcroft 1.52 _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
549     _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
550 adcroft 1.78 _RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
551 adcroft 1.6 _RL startTime
552     _RL endTime
553     _RL chkPtFreq
554 cnh 1.7 _RL pChkPtFreq
555 adcroft 1.6 _RL dumpFreq
556 adcroft 1.59 _RL diagFreq
557 adcroft 1.20 _RL taveFreq
558 jmc 1.76 _RL tave_lastIter
559 adcroft 1.53 _RL monitorFreq
560 cnh 1.9 _RL afFacMom
561     _RL vfFacMom
562     _RL pfFacMom
563     _RL cfFacMom
564     _RL foFacMom
565 cnh 1.15 _RL mTFacMom
566 adcroft 1.39 _RL cosPower
567 cnh 1.9 _RL cAdjFreq
568 cnh 1.15 _RL omega
569 jmc 1.88 _RL rotationPeriod
570 cnh 1.18 _RL tauThetaClimRelax
571     _RL lambdaThetaClimRelax
572     _RL tauSaltClimRelax
573     _RL lambdaSaltClimRelax
574 heimbach 1.56 _RL tauTr1ClimRelax
575     _RL lambdaTr1ClimRelax
576 adcroft 1.19 _RL externForcingCycle
577     _RL externForcingPeriod
578 jmc 1.68 _RL convertFW2Salt
579     _RL temp_EvPrRn
580     _RL salt_EvPrRn
581     _RL trac_EvPrRn
582 cnh 1.30 _RL horiVertRatio
583 cnh 1.31 _RL recip_horiVertRatio
584 adcroft 1.41 _RL ivdc_kappa
585 adcroft 1.46 _RL Ro_SeaLevel
586     _RL bottomDragLinear
587     _RL bottomDragQuadratic
588 adcroft 1.6
589 adcroft 1.36 COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
590 cnh 1.1 & Lamba_theta
591 adcroft 1.6 _RL HeatCapacity_Cp
592     _RL Lamba_theta
593 adcroft 1.36 _RL recip_Cp
594 jmc 1.55
595     C Atmospheric physical parameters (Ideal Gas EOS, ...)
596 jmc 1.83 C atm_Po :: standard reference pressure
597     C atm_Cp :: specific heat (Cp) of the (dry) air at constant pressure
598     C atm_Rd :: gas constant for dry air
599 cnh 1.63 C atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
600 jmc 1.83 C integr_GeoPot :: option to select the way we integrate the geopotential
601 jmc 1.55 C (still a subject of discussions ...)
602 jmc 1.83 C selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
603     C derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
604     COMMON /PARM_ATM/ atm_Cp, atm_Rd, atm_kappa, atm_Po,
605     & integr_GeoPot, selectFindRoSurf
606     _RL atm_Po, atm_Cp, atm_Rd, atm_kappa
607     INTEGER integr_GeoPot, selectFindRoSurf
608 cnh 1.7
609 adcroft 1.44 C Logical flags for selecting packages
610 heimbach 1.45 LOGICAL useKPP
611     LOGICAL useGMRedi
612 adcroft 1.46 LOGICAL useOBCS
613 jmc 1.49 LOGICAL useAIM
614 heimbach 1.56 LOGICAL useGrdchk
615 heimbach 1.45 LOGICAL useECCO
616 adcroft 1.52 LOGICAL useSHAP_FILT
617 jmc 1.67 LOGICAL useZONAL_FILT
618 adcroft 1.62 LOGICAL useFLT
619 adcroft 1.69 LOGICAL usePTRACERS
620 dimitri 1.86 LOGICAL useSBO
621 heimbach 1.80 LOGICAL useSEAICE
622 cheisey 1.81 cswdblk -- add ---
623 cheisey 1.82 LOGICAL useBulkforce
624     LOGICAL useThermSEAICE
625 cheisey 1.81 cswdblk --- end add ---
626 adcroft 1.44 COMMON /PARM_PACKAGES/
627 heimbach 1.56 & useKPP, useGMRedi, useOBCS, useAIM, useECCO,
628 adcroft 1.69 & useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
629 dimitri 1.86 & usePTRACERS, useSBO, useSEAICE,
630 cheisey 1.81 cswdblk -- add ---
631 cheisey 1.82 & useThermSEAICE, useBulkforce
632 cheisey 1.81 cswdblk --- end add ---

  ViewVC Help
Powered by ViewVC 1.1.22