/[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.65.4.5 - (hide annotations) (download)
Tue Jul 8 15:18:29 2003 UTC (20 years, 9 months ago) by heimbach
Branch: ecco-branch
CVS Tags: ecco_c51_e34c
Changes since 1.65.4.4: +15 -3 lines
File MIME type: text/plain
o introducing integer flag debugLevel
o introducing pathname variable mdsioLocalDir for mdsio

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

  ViewVC Help
Powered by ViewVC 1.1.22