/[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.111 - (hide annotations) (download)
Wed Jun 2 13:23:55 2004 UTC (19 years, 11 months ago) by adcroft
Branch: MAIN
Changes since 1.110: +11 -1 lines
File MIME type: text/plain
Added Sadourny discretization of Coriolis in V.I. mode
 - moved some PARAMETERS from mom_*_coriolis.F to PARAMS.h
 - re-enabled use of omega3 in mom_vecinv.F

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

  ViewVC Help
Powered by ViewVC 1.1.22