/[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.105 - (hide annotations) (download)
Sat Mar 20 20:35:21 2004 UTC (20 years, 1 month ago) by edhill
Branch: MAIN
Changes since 1.104: +16 -3 lines
File MIME type: text/plain
 o read the MNC run-time params at the eeboot stage
   - mnc will be gracefully disabled if the data.mnc file does not exist
 o add look-up tables for AJA's unlimited-dim interface

1 edhill 1.105 C $Header: /u/gcmpack/MITgcm/model/inc/PARAMS.h,v 1.104 2004/03/19 05:09:41 edhill 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 cnh 1.63 C implicitDiffusion :: Turns implicit vertical diffusion on
217     C implicitViscosity :: Turns implicit vertical viscosity on
218 jmc 1.100 C tempImplVertAdv :: Turns on implicit vertical advection for Temperature
219     C saltImplVertAdv :: Turns on implicit vertical advection for Salinity
220     C momImplVertAdv :: Turns on implicit vertical advection for Momentum
221 jmc 1.71 C multiDimAdvection :: Flag that enable multi-dimension advection
222     C forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
223     C out off Adams-Bashforth time stepping.
224 cnh 1.63 C doThetaClimRelax :: Set true if relaxation to temperature
225 cnh 1.18 C climatology is required.
226 cnh 1.63 C doSaltClimRelax :: Set true if relaxation to salinity
227 cnh 1.18 C climatology is required.
228 cnh 1.63 C periodicExternalForcing :: Set true if forcing is time-dependant
229     C usingPCoords :: Set to indicate that we are working in pressure
230 jmc 1.87 C coords. (jmc: is it still used ?)
231 cnh 1.63 C usingZCoords :: Set to indicate that we are working in height
232 jmc 1.87 C coords. (jmc: is it still used ?)
233     C useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
234     C this requires specific code for restart & exchange
235 jmc 1.70 C setCenterDr :: set cell Center depth and put Interface at the middle
236 cnh 1.63 C nonHydrostatic :: Using non-hydrostatic terms
237 adcroft 1.79 C quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
238 cnh 1.63 C globalFiles :: Selects between "global" and "tiled" files
239 dimitri 1.85 C useSingleCpuIO :: On SGI platforms, option globalFiles is either
240     C slow (f77) or does not work (f90). When
241     C useSingleCpuIO is set, mdsio_writefield.F
242     C outputs from master mpi process only.
243 jmc 1.97 C allowFreezing :: Allows surface water to freeze and form ice
244     C useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
245 cnh 1.63 C groundAtK1 :: put the surface(k=1) at the Lower Boundary (=ground)
246 cnh 1.1 COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
247 adcroft 1.52 & usingCurvilinearGrid,
248 adcroft 1.36 & no_slip_sides,no_slip_bottom,
249 adcroft 1.46 & staggerTimeStep,
250 cnh 1.33 & momViscosity, momAdvection, momForcing, useCoriolis,
251 adcroft 1.58 & momPressureForcing, vectorInvariantMomentum,
252     & tempDiffusion, tempAdvection, tempForcing,
253 cnh 1.8 & saltDiffusion, saltAdvection, saltForcing,
254 jmc 1.68 & useRealFreshWaterFlux,
255 jmc 1.55 & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
256 heimbach 1.56 & momStepping, tempStepping, saltStepping, tr1Stepping,
257 adcroft 1.77 & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
258 cnh 1.15 & useConstantF, useBetaPlaneF, useSphereF,
259 jmc 1.89 & useCDscheme,
260 jmc 1.71 & useEnergyConservingCoriolis, useJamartWetPoints,
261 adcroft 1.40 & implicitDiffusion, implicitViscosity,
262 jmc 1.100 & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
263 jmc 1.71 & multiDimAdvection, forcing_In_AB,
264 heimbach 1.56 & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
265 jmc 1.70 & periodicExternalForcing,
266 jmc 1.87 & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
267 dimitri 1.85 & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
268 jmc 1.97 & allowFreezing, useOldFreezing, groundAtK1,
269 heimbach 1.56 & usePickupBeforeC35, debugMode,
270 jmc 1.71 & readPickupWithTracer, writePickupWithTracer
271 cnh 1.1 LOGICAL usingCartesianGrid
272     LOGICAL usingSphericalPolarGrid
273 adcroft 1.52 LOGICAL usingCurvilinearGrid
274 cnh 1.15 LOGICAL usingSphericalPolarMTerms
275 adcroft 1.77 LOGICAL useNHMTerms
276 adcroft 1.36 LOGICAL no_slip_sides
277     LOGICAL no_slip_bottom
278 adcroft 1.46 LOGICAL staggerTimeStep
279 cnh 1.1 LOGICAL momViscosity
280     LOGICAL momAdvection
281     LOGICAL momForcing
282 cnh 1.9 LOGICAL momPressureForcing
283 cnh 1.1 LOGICAL useCoriolis
284 adcroft 1.58 LOGICAL vectorInvariantMomentum
285 cnh 1.1 LOGICAL tempDiffusion
286     LOGICAL tempAdvection
287     LOGICAL tempForcing
288     LOGICAL saltDiffusion
289     LOGICAL saltAdvection
290     LOGICAL saltForcing
291 jmc 1.68 LOGICAL useRealFreshWaterFlux
292 adcroft 1.52 LOGICAL rigidLid
293 cnh 1.8 LOGICAL implicitFreeSurface
294 adcroft 1.52 LOGICAL exactConserv
295 jmc 1.55 LOGICAL uniformLin_PhiSurf
296 cnh 1.10 LOGICAL momStepping
297     LOGICAL tempStepping
298 adcroft 1.17 LOGICAL saltStepping
299 heimbach 1.56 LOGICAL tr1Stepping
300 cnh 1.15 LOGICAL metricTerms
301     LOGICAL useConstantF
302     LOGICAL useBetaPlaneF
303     LOGICAL useSphereF
304 jmc 1.89 LOGICAL useCDscheme
305 jmc 1.71 LOGICAL useEnergyConservingCoriolis
306     LOGICAL useJamartWetPoints
307 adcroft 1.14 LOGICAL implicitDiffusion
308 adcroft 1.40 LOGICAL implicitViscosity
309 jmc 1.100 LOGICAL tempImplVertAdv
310     LOGICAL saltImplVertAdv
311     LOGICAL momImplVertAdv
312 jmc 1.71 LOGICAL multiDimAdvection
313     LOGICAL forcing_In_AB
314 cnh 1.18 LOGICAL doThetaClimRelax
315     LOGICAL doSaltClimRelax
316 heimbach 1.56 LOGICAL doTr1ClimRelax
317 adcroft 1.19 LOGICAL periodicExternalForcing
318 cnh 1.29 LOGICAL usingPCoords
319     LOGICAL usingZCoords
320 jmc 1.87 LOGICAL useDynP_inEos_Zc
321 jmc 1.70 LOGICAL setCenterDr
322 adcroft 1.37 LOGICAL nonHydrostatic
323 adcroft 1.79 LOGICAL quasiHydrostatic
324 adcroft 1.38 LOGICAL globalFiles
325 dimitri 1.85 LOGICAL useSingleCpuIO
326 adcroft 1.38 LOGICAL allowFreezing
327 jmc 1.97 LOGICAL useOldFreezing
328 adcroft 1.46 LOGICAL groundAtK1
329 heimbach 1.51 LOGICAL usePickupBeforeC35
330 adcroft 1.54 LOGICAL debugMode
331 heimbach 1.56 LOGICAL readPickupWithTracer
332     LOGICAL writePickupWithTracer
333 cnh 1.1
334     C-- COMMON /PARM_R/ "Real" valued parameters used by the model.
335 adcroft 1.52 C gg2dTargetResidual
336 cnh 1.63 C :: Target residual for cg2d solver; no unit (RHS normalisation)
337 adcroft 1.52 C cg2dTargetResWunit
338 cnh 1.63 C :: Target residual for cg2d solver; W unit (No RHS normalisation)
339 cnh 1.33 C cg3dTargetResidual
340 cnh 1.63 C :: Target residual for cg3d solver.
341     C cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
342 cnh 1.7 C Note. 20th May 1998
343     C I made a weird discovery! In the model paper we argue
344     C for the form of the preconditioner used here ( see
345     C A Finite-volume, Incompressible Navier-Stokes Model
346     C ...., Marshall et. al ). The algebra gives a simple
347     C 0.5 factor for the averaging of ac and aCw to get a
348     C symmettric pre-conditioner. By using a factor of 0.51
349     C i.e. scaling the off-diagonal terms in the
350     C preconditioner down slightly I managed to get the
351     C number of iterations for convergence in a test case to
352     C drop form 192 -> 134! Need to investigate this further!
353     C For now I have introduced a parameter cg2dpcOffDFac which
354     C defaults to 0.51 but can be set at runtime.
355 cnh 1.63 C delR :: Vertical grid spacing ( units of r ).
356 jmc 1.70 C delRc :: Vertical grid spacing between cell centers (r unit).
357 cnh 1.63 C delX :: Separation between cell faces (m) or (deg), depending
358 cnh 1.1 C delY on input flags.
359 cnh 1.63 C gravity :: Accel. due to gravity ( m/s^2 )
360 cnh 1.32 C recip_gravity and its inverse
361 cnh 1.63 C gBaro :: Accel. due to gravity used in barotropic equation ( m/s^2 )
362 mlosch 1.75 C rhoNil :: Reference density for the linear equation of state
363 cnh 1.63 C rhoConst :: Vertically constant reference density
364 mlosch 1.75 C rhoConstFresh :: Constant reference density for fresh water (rain)
365 cnh 1.63 C startTime :: Start time for model ( s )
366     C phiMin :: Latitude of southern most cell face.
367     C thetaMin :: Longitude of western most cell face (this
368 cnh 1.1 C is an "inert" parameter but it is included
369     C to make geographical references simple.)
370 cnh 1.63 C rSphere :: Radius of sphere for a spherical polar grid ( m ).
371     C recip_RSphere :: Reciprocal radius of sphere ( m ).
372     C f0 :: Reference coriolis parameter ( 1/s )
373 cnh 1.1 C ( Southern edge f for beta plane )
374 cnh 1.63 C beta :: df/dy ( s^-1.m^-1 )
375     C omega :: Angular velocity ( rad/s )
376 jmc 1.88 C rotationPeriod :: Rotation period (s) (= 2.pi/omega)
377 cnh 1.63 C viscAh :: Eddy viscosity coeff. for mixing of
378 cnh 1.1 C momentum laterally ( m^2/s )
379 cnh 1.63 C viscAr :: Eddy viscosity coeff. for mixing of
380 cnh 1.24 C momentum vertically ( units of r^2/s )
381 cnh 1.63 C viscA4 :: Biharmonic viscosity coeff. for mixing of
382 cnh 1.1 C momentum laterally ( m^4/s )
383 adcroft 1.102 C viscAhMax :: Maximum eddy viscosity coeff. for mixing of
384     C momentum laterally ( m^2/s )
385     C viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
386     C momentum laterally ( m^4/s )
387     C viscAhGrid:: non-dimensional grid-size dependent viscosity
388     C viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
389 cnh 1.63 C diffKhT :: Laplacian diffusion coeff. for mixing of
390 cnh 1.1 C heat laterally ( m^2/s )
391 cnh 1.63 C diffKrT :: Laplacian diffusion coeff. for mixing of
392 cnh 1.24 C heat vertically ( units of r^2/s )
393 cnh 1.63 C diffK4T :: Biharmonic diffusion coeff. for mixing of
394 cnh 1.1 C heat laterally ( m^4/s )
395 cnh 1.63 C diffKhS :: Laplacian diffusion coeff. for mixing of
396 cnh 1.1 C salt laterally ( m^2/s )
397 cnh 1.63 C diffKrS :: Laplacian diffusion coeff. for mixing of
398 cnh 1.24 C salt vertically ( units of r^2/s )
399 cnh 1.63 C diffK4S :: Biharmonic diffusion coeff. for mixing of
400 cnh 1.1 C salt laterally ( m^4/s )
401 cnh 1.63 C deltaT :: Default timestep ( s )
402     C deltaTClock :: Timestep used as model "clock". This determines the
403 cnh 1.7 C IO frequencies and is used in tagging output. It can
404     C be totally different to the dynamical time. Typically
405     C it will be the deep-water timestep for accelerated runs.
406     C Frequency of checkpointing and dumping of the model state
407     C are referenced to this clock. ( s )
408 cnh 1.63 C deltaTMom :: Timestep for momemtum equations ( s )
409     C deltaTtracer :: Timestep for tracer equations ( s )
410 adcroft 1.72 C deltaTfreesurf :: Timestep for free-surface equation ( s )
411 cnh 1.63 C freesurfFac :: Parameter to turn implicit free surface term on or off
412 cnh 1.8 C freesurfac = 1. uses implicit free surface
413     C freesurfac = 0. uses rigid lid
414 cnh 1.63 C implicSurfPress :: parameter of the Crank-Nickelson time stepping :
415 jmc 1.48 C Implicit part of Surface Pressure Gradient ( 0-1 )
416 cnh 1.63 C implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
417 jmc 1.48 C Implicit part of barotropic flow Divergence ( 0-1 )
418 cnh 1.63 C hFacMin :: Minimum fraction size of a cell (affects hFacC etc...)
419     C hFacMinDz :: Minimum dimesional size of a cell (affects hFacC etc..., m)
420     C hFacMinDp :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
421     C hFacMinDr :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
422     C hFacInf :: Threshold (inf and sup) for fraction size of surface cell
423 adcroft 1.52 C hFacSup that control vanishing and creating levels
424 cnh 1.63 C tauCD :: CD scheme coupling timescale ( 1/s )
425     C rCD :: CD scheme normalised coupling parameter ( 0-1 )
426     C startTime :: Starting time for this integration ( s ).
427     C endTime :: Ending time for this integration ( s ).
428     C chkPtFreq :: Frequency of rolling check pointing ( s ).
429     C pChkPtFreq :: Frequency of permanent check pointing ( s ).
430     C dumpFreq :: Frequency with which model state is written to
431 cnh 1.24 C post-processing files ( s ).
432 cnh 1.63 C diagFreq :: Frequency with which model writes diagnostic output
433 adcroft 1.59 C of intermediate quantities.
434 cnh 1.63 C afFacMom :: Advection of momentum term tracer parameter
435     C vfFacMom :: Momentum viscosity tracer parameter
436     C pfFacMom :: Momentum pressure forcing tracer parameter
437     C cfFacMom :: Coriolis term tracer parameter
438     C foFacMom :: Momentum forcing tracer parameter
439     C mtFacMom :: Metric terms tracer parameter
440     C cosPower :: Power of cosine of latitude to multiply viscosity
441     C cAdjFreq :: Frequency of convective adjustment
442 cnh 1.24 C
443 jmc 1.76 C taveFreq :: Frequency with which time-averaged model state
444     C is written to post-processing files ( s ).
445     C tave_lastIter :: (for state variable only) fraction of the last time
446     C step (of each taveFreq period) put in the time average.
447     C (fraction for 1rst iter = 1 - tave_lastIter)
448 cnh 1.63 C tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
449     C lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
450     C tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
451     C lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
452 jmc 1.95 C latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
453     C i.e. where |yC| <= latBandClimRelax
454 cnh 1.63 C externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
455     C externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
456 adcroft 1.19 C (note: externForcingCycle must be an integer
457     C number times externForcingPeriod)
458 jmc 1.68 C convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
459     C (use model surface (local) value if set to -1)
460     C temp_EvPrRn :: temperature of Rain & Evap.
461     C salt_EvPrRn :: salinity of Rain & Evap.
462     C trac_EvPrRn :: tracer concentration in Rain & Evap.
463     C (notes: a) tracer content of Rain/Evap only used if both
464     C NonLin_FrSurf & useRealFreshWater are set.
465     C b) use model surface (local) value if set to UNSET_RL)
466 cnh 1.63 C horiVertRatio :: Ratio on units in vertical to units in horizontal.
467 cnh 1.31 C recip_horiVertRatio ( 1 if horiz in m and vertical in m ).
468 cnh 1.30 C ( g*rho if horiz in m and vertical in Pa ).
469 cnh 1.63 C Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
470 adcroft 1.46 C starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
471 cnh 1.63 C bottomDragLinear :: Drag coefficient built in to core dynamics
472 adcroft 1.64 C --"-"-- Quadratic ( linear: 1/s, quadratic: 1/m )
473 adcroft 1.52 COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
474     & cg2dpcOffDFac, cg3dTargetResidual,
475 jmc 1.96 & delR, delRc, delX, delY,
476 adcroft 1.72 & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,
477     & abeps, startTime,
478 adcroft 1.52 & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
479 adcroft 1.78 & fCori, fCoriG, fCoriCos,
480 adcroft 1.102 & viscAh, viscAhMax, viscAhGrid,
481     & viscA4, viscA4Max, viscA4Grid,
482     & viscAr, viscAstrain, viscAtension,
483 jmc 1.96 & diffKhT, diffK4T, diffKrT,
484     & diffKhS, diffK4S, diffKrS,
485 jmc 1.48 & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
486 adcroft 1.52 & hFacMin, hFacMinDz, hFacInf, hFacSup,
487 cnh 1.32 & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
488 mlosch 1.75 & recip_rhoConst, rhoConst,
489 jmc 1.76 & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
490 heimbach 1.103 & endTime, chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,
491 jmc 1.76 & diagFreq, taveFreq, tave_lastIter, monitorFreq,
492 cnh 1.15 & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
493 jmc 1.88 & cosPower, cAdjFreq, omega, rotationPeriod,
494 heimbach 1.56 & tauThetaClimRelax, lambdaThetaClimRelax,
495 adcroft 1.19 & tauSaltClimRelax, lambdaSaltClimRelax,
496 jmc 1.95 & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
497 cnh 1.27 & externForcingCycle, externForcingPeriod,
498 jmc 1.68 & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,
499 jmc 1.96 & hFacMinDr, hFacMinDp,
500 jmc 1.68 & horiVertRatio, recip_horiVertRatio,
501 jmc 1.67 & ivdc_kappa, Ro_SeaLevel,
502 adcroft 1.46 & bottomDragLinear,bottomDragQuadratic
503 cnh 1.27
504 adcroft 1.6 _RL cg2dTargetResidual
505 adcroft 1.52 _RL cg2dTargetResWunit
506 cnh 1.33 _RL cg3dTargetResidual
507 cnh 1.7 _RL cg2dpcOffDFac
508 cnh 1.25 _RL delR(Nr)
509 jmc 1.70 _RL delRc(Nr+1)
510 adcroft 1.6 _RL delX(Nx)
511     _RL delY(Ny)
512     _RL deltaT
513 cnh 1.7 _RL deltaTClock
514 adcroft 1.6 _RL deltaTmom
515     _RL deltaTtracer
516 adcroft 1.72 _RL deltaTfreesurf
517 adcroft 1.6 _RL abeps
518     _RL phiMin
519     _RL thetaMin
520     _RL rSphere
521 cnh 1.25 _RL recip_RSphere
522 adcroft 1.6 _RL f0
523 cnh 1.8 _RL freeSurfFac
524 jmc 1.48 _RL implicSurfPress
525     _RL implicDiv2Dflow
526 adcroft 1.22 _RL hFacMin
527     _RL hFacMinDz
528 cnh 1.28 _RL hFacMinDp
529 cnh 1.27 _RL hFacMinDr
530 adcroft 1.52 _RL hFacInf
531     _RL hFacSup
532 adcroft 1.6 _RL beta
533     _RL viscAh
534 adcroft 1.102 _RL viscAhMax
535     _RL viscAhGrid
536 adcroft 1.60 _RL viscAstrain
537     _RL viscAtension
538 cnh 1.25 _RL viscAr
539 adcroft 1.6 _RL viscA4
540 adcroft 1.102 _RL viscA4Max
541     _RL viscA4Grid
542 adcroft 1.6 _RL diffKhT
543 cnh 1.25 _RL diffKrT
544 adcroft 1.6 _RL diffK4T
545     _RL diffKhS
546 cnh 1.25 _RL diffKrS
547 adcroft 1.6 _RL diffK4S
548     _RL delt
549     _RL tauCD
550     _RL rCD
551     _RL gravity
552 cnh 1.32 _RL recip_gravity
553 cnh 1.8 _RL gBaro
554 adcroft 1.6 _RL rhonil
555 cnh 1.25 _RL recip_rhonil
556     _RL rhoConst
557 cnh 1.26 _RL recip_rhoConst
558 mlosch 1.75 _RL rhoConstFresh
559 jmc 1.76 _RL convertEmP2rUnit
560 cnh 1.25 _RL tRef(Nr)
561     _RL sRef(Nr)
562 adcroft 1.52 _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
563     _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
564 adcroft 1.78 _RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
565 adcroft 1.6 _RL startTime
566     _RL endTime
567     _RL chkPtFreq
568 cnh 1.7 _RL pChkPtFreq
569 adcroft 1.6 _RL dumpFreq
570 heimbach 1.103 _RL adjDumpFreq
571 adcroft 1.59 _RL diagFreq
572 adcroft 1.20 _RL taveFreq
573 jmc 1.76 _RL tave_lastIter
574 adcroft 1.53 _RL monitorFreq
575 cnh 1.9 _RL afFacMom
576     _RL vfFacMom
577     _RL pfFacMom
578     _RL cfFacMom
579     _RL foFacMom
580 cnh 1.15 _RL mTFacMom
581 adcroft 1.39 _RL cosPower
582 cnh 1.9 _RL cAdjFreq
583 cnh 1.15 _RL omega
584 jmc 1.88 _RL rotationPeriod
585 cnh 1.18 _RL tauThetaClimRelax
586     _RL lambdaThetaClimRelax
587     _RL tauSaltClimRelax
588     _RL lambdaSaltClimRelax
589 heimbach 1.56 _RL tauTr1ClimRelax
590     _RL lambdaTr1ClimRelax
591 jmc 1.95 _RL latBandClimRelax
592 adcroft 1.19 _RL externForcingCycle
593     _RL externForcingPeriod
594 jmc 1.68 _RL convertFW2Salt
595     _RL temp_EvPrRn
596     _RL salt_EvPrRn
597     _RL trac_EvPrRn
598 cnh 1.30 _RL horiVertRatio
599 cnh 1.31 _RL recip_horiVertRatio
600 adcroft 1.41 _RL ivdc_kappa
601 adcroft 1.46 _RL Ro_SeaLevel
602     _RL bottomDragLinear
603     _RL bottomDragQuadratic
604 adcroft 1.6
605 jmc 1.91 C-- COMMON /PARM_A/ Thermodynamics constants ?
606     COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
607 adcroft 1.6 _RL HeatCapacity_Cp
608 adcroft 1.36 _RL recip_Cp
609 jmc 1.55
610 jmc 1.91 C-- COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
611     C celsius2K :: convert centigrade (Celsius) degree to Kelvin
612 jmc 1.83 C atm_Po :: standard reference pressure
613     C atm_Cp :: specific heat (Cp) of the (dry) air at constant pressure
614     C atm_Rd :: gas constant for dry air
615 cnh 1.63 C atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
616 jmc 1.94 C atm_Rq :: water vapour specific volume anomaly relative to dry air
617     C (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
618 jmc 1.83 C integr_GeoPot :: option to select the way we integrate the geopotential
619 jmc 1.55 C (still a subject of discussions ...)
620 jmc 1.83 C selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
621     C derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
622 jmc 1.91 COMMON /PARM_ATM/
623     & celsius2K,
624 jmc 1.94 & atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
625 jmc 1.91 & integr_GeoPot, selectFindRoSurf
626     _RL celsius2K
627 jmc 1.94 _RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq
628 jmc 1.83 INTEGER integr_GeoPot, selectFindRoSurf
629 cnh 1.7
630 adcroft 1.44 C Logical flags for selecting packages
631 heimbach 1.45 LOGICAL useKPP
632     LOGICAL useGMRedi
633 adcroft 1.46 LOGICAL useOBCS
634 jmc 1.49 LOGICAL useAIM
635 jmc 1.91 LOGICAL useLand
636 heimbach 1.56 LOGICAL useGrdchk
637 heimbach 1.45 LOGICAL useECCO
638 adcroft 1.52 LOGICAL useSHAP_FILT
639 jmc 1.67 LOGICAL useZONAL_FILT
640 adcroft 1.62 LOGICAL useFLT
641 adcroft 1.69 LOGICAL usePTRACERS
642 dimitri 1.86 LOGICAL useSBO
643 heimbach 1.80 LOGICAL useSEAICE
644 jmc 1.98 LOGICAL useBulkForce
645     LOGICAL useThSIce
646 molod 1.99 LOGICAL usefizhi
647     LOGICAL usegridalt
648 molod 1.101 LOGICAL usediagnostics
649 adcroft 1.44 COMMON /PARM_PACKAGES/
650 jmc 1.91 & useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
651 adcroft 1.69 & useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
652 molod 1.101 & usePTRACERS, useSBO, useSEAICE, useThSIce, useBulkForce,
653 edhill 1.105 & usefizhi, usegridalt, usediagnostics
654    
655     C Run-time flags for early-initialization of MNC
656     LOGICAL
657     & useMNC,
658     & mnc_echo_gtypes, mnc_pickup_create, mnc_pickup_read
659     COMMON /PARM_MNC/
660     & useMNC,
661     & mnc_echo_gtypes, mnc_pickup_create, mnc_pickup_read
662    
663    
664    
665     CEH3 ;;; Local Variables: ***
666     CEH3 ;;; mode:fortran ***
667     CEH3 ;;; End: ***

  ViewVC Help
Powered by ViewVC 1.1.22