/[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.237 - (hide annotations) (download)
Mon Apr 26 20:37:02 2010 UTC (14 years, 1 month ago) by dimitri
Branch: MAIN
CVS Tags: checkpoint62g, checkpoint62f
Changes since 1.236: +6 -2 lines
File MIME type: text/plain
Adding parameters to specify temperature and salinity of addMass array
separately from temp_EvPrRn and salt_EvPrRn

1 dimitri 1.237 C $Header: /u/gcmpack/MITgcm/model/inc/PARAMS.h,v 1.236 2010/02/17 00:21:32 gforget Exp $
2 mlosch 1.74 C $Name: $
3 cnh 1.1 C
4 edhill 1.124
5 cnh 1.63 CBOP
6 edhill 1.124 C !ROUTINE: PARAMS.h
7     C !INTERFACE:
8     C #include PARAMS.h
9    
10     C !DESCRIPTION:
11     C Header file defining model "parameters". The values from the
12     C model standard input file are stored into the variables held
13     C here. Notes describing the parameters can also be found here.
14    
15 cnh 1.63 CEOP
16 cnh 1.13
17     C Macros for special grid options
18     #include "PARAMS_MACROS.h"
19 cnh 1.1
20     C-- Contants
21     C Useful physical values
22     Real*8 PI
23     PARAMETER ( PI = 3.14159265358979323844D0 )
24     Real*8 deg2rad
25     PARAMETER ( deg2rad = 2.D0*PI/360.D0 )
26    
27     C-- COMMON /PARM_C/ Character valued parameters used by the model.
28 jmc 1.205 C buoyancyRelation :: Flag used to indicate which relation to use to
29     C get buoyancy.
30     C eosType :: choose the equation of state:
31     C LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
32     C pickupSuff :: force to start from pickup files (even if nIter0=0)
33     C and read pickup files with this suffix (max 10 Char.)
34     C mdsioLocalDir :: read-write tiled file from/to this directory name
35     C (+ 4 digits Processor-Rank) instead of current dir.
36 jmc 1.191 C tRefFile :: File containing reference Potential Temperat. tRef (1.D)
37     C sRefFile :: File containing reference salinity/spec.humid. sRef (1.D)
38     C rhoRefFile :: File containing reference density profile rhoRef (1.D)
39     C delRFile :: File containing vertical grid spacing delR (1.D array)
40     C delRcFile :: File containing vertical grid spacing delRc (1.D array)
41 jmc 1.162 C delXFile :: File containing X-spacing grid definition (1.D array)
42     C delYFile :: File containing Y-spacing grid definition (1.D array)
43 jmc 1.191 C horizGridFile :: File containing horizontal-grid definition
44 jmc 1.162 C (only when using curvilinear_grid)
45 jmc 1.205 C bathyFile :: File containing bathymetry. If not defined bathymetry
46     C is taken from inline function.
47     C topoFile :: File containing the topography of the surface (unit=m)
48     C (mainly used for the atmosphere = ground height).
49     C hydrogThetaFile :: File containing initial hydrographic data (3-D)
50     C for potential temperature.
51     C hydrogSaltFile :: File containing initial hydrographic data (3-D)
52     C for salinity.
53 dimitri 1.199 C diffKrFile :: File containing 3D specification of vertical diffusivity
54 gforget 1.236 C viscAhDfile :: File containing 3D specification of horizontal viscosity
55     C viscAhZfile :: File containing 3D specification of horizontal viscosity
56     C viscA4Dfile :: File containing 3D specification of horizontal viscosity
57     C viscA4Zfile :: File containing 3D specification of horizontal viscosity
58 cnh 1.63 C zonalWindFile :: File containing zonal wind data
59     C meridWindFile :: File containing meridional wind data
60 jmc 1.205 C thetaClimFile :: File containing surface theta climataology used
61 cnh 1.18 C in relaxation term -lambda(theta-theta*)
62 jmc 1.205 C saltClimFile :: File containing surface salt climataology used
63 cnh 1.18 C in relaxation term -lambda(salt-salt*)
64 jmc 1.120 C surfQfile :: File containing surface heat flux, excluding SW
65     C (old version, kept for backward compatibility)
66     C surfQnetFile :: File containing surface net heat flux
67     C surfQswFile :: File containing surface shortwave radiation
68 cnh 1.63 C dQdTfile :: File containing thermal relaxation coefficient
69     C EmPmRfile :: File containing surface fresh water flux
70 dimitri 1.210 C NOTE: for backward compatibility EmPmRfile is specified in
71     C m/s when using external_fields_load.F. It is converted
72     C to kg/m2/s by multiplying by rhoConstFresh.
73 jmc 1.141 C saltFluxFile :: File containing surface salt flux
74 mlosch 1.73 C pLoadFile :: File containing pressure loading
75 gforget 1.217 C eddyPsiXFile :: File containing zonal Eddy streamfunction data
76     C eddyPsiYFile :: File containing meridional Eddy streamfunction data
77 edhill 1.124 C the_run_name :: string identifying the name of the model "run"
78 jmc 1.205 COMMON /PARM_C/
79     & buoyancyRelation, eosType,
80     & pickupSuff, mdsioLocalDir,
81 jmc 1.191 & tRefFile, sRefFile, rhoRefFile,
82     & delRFile, delRcFile,
83 jmc 1.162 & delXFile, delYFile, horizGridFile,
84 mlosch 1.224 & bathyFile, topoFile,
85 gforget 1.236 & viscAhDfile, viscAhZfile,
86     & viscA4Dfile, viscA4Zfile,
87 dimitri 1.199 & hydrogThetaFile, hydrogSaltFile, diffKrFile,
88 cnh 1.18 & zonalWindFile, meridWindFile, thetaClimFile,
89 jmc 1.205 & saltClimFile,
90 jmc 1.141 & EmPmRfile, saltFluxFile,
91     & surfQfile, surfQnetFile, surfQswFile,
92 heimbach 1.151 & lambdaThetaFile, lambdaSaltFile,
93 heimbach 1.50 & uVelInitFile, vVelInitFile, pSurfInitFile,
94 mlosch 1.74 & dQdTfile, ploadFile,
95 gforget 1.217 & eddyPsiXFile, eddyPsiYFile,
96 edhill 1.124 & the_run_name
97 jmc 1.205 CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
98     CHARACTER*(6) eosType
99     CHARACTER*(10) pickupSuff
100     CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
101 jmc 1.191 CHARACTER*(MAX_LEN_FNAM) tRefFile
102     CHARACTER*(MAX_LEN_FNAM) sRefFile
103     CHARACTER*(MAX_LEN_FNAM) rhoRefFile
104     CHARACTER*(MAX_LEN_FNAM) delRFile
105     CHARACTER*(MAX_LEN_FNAM) delRcFile
106 jmc 1.162 CHARACTER*(MAX_LEN_FNAM) delXFile
107     CHARACTER*(MAX_LEN_FNAM) delYFile
108     CHARACTER*(MAX_LEN_FNAM) horizGridFile
109 mlosch 1.224 CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
110 dimitri 1.198 CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile
111 dimitri 1.199 CHARACTER*(MAX_LEN_FNAM) diffKrFile
112 gforget 1.236 CHARACTER*(MAX_LEN_FNAM) viscAhDfile
113     CHARACTER*(MAX_LEN_FNAM) viscAhZfile
114     CHARACTER*(MAX_LEN_FNAM) viscA4Dfile
115     CHARACTER*(MAX_LEN_FNAM) viscA4Zfile
116 cnh 1.16 CHARACTER*(MAX_LEN_FNAM) zonalWindFile
117     CHARACTER*(MAX_LEN_FNAM) meridWindFile
118 cnh 1.18 CHARACTER*(MAX_LEN_FNAM) thetaClimFile
119     CHARACTER*(MAX_LEN_FNAM) saltClimFile
120 adcroft 1.37 CHARACTER*(MAX_LEN_FNAM) surfQfile
121 jmc 1.120 CHARACTER*(MAX_LEN_FNAM) surfQnetFile
122     CHARACTER*(MAX_LEN_FNAM) surfQswFile
123 adcroft 1.37 CHARACTER*(MAX_LEN_FNAM) EmPmRfile
124 jmc 1.141 CHARACTER*(MAX_LEN_FNAM) saltFluxFile
125 adcroft 1.42 CHARACTER*(MAX_LEN_FNAM) uVelInitFile
126     CHARACTER*(MAX_LEN_FNAM) vVelInitFile
127 adcroft 1.43 CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
128 heimbach 1.50 CHARACTER*(MAX_LEN_FNAM) dQdTfile
129 mlosch 1.73 CHARACTER*(MAX_LEN_FNAM) ploadFile
130 gforget 1.217 CHARACTER*(MAX_LEN_FNAM) eddyPsiXFile
131     CHARACTER*(MAX_LEN_FNAM) eddyPsiYFile
132 heimbach 1.151 CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
133     CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile
134 jmc 1.193 CHARACTER*(MAX_LEN_PREC/2) the_run_name
135 cnh 1.7
136 cnh 1.1 C-- COMMON /PARM_I/ Integer valued parameters used by the model.
137 cnh 1.63 C cg2dMaxIters :: Maximum number of iterations in the
138 cnh 1.1 C two-dimensional con. grad solver.
139 cnh 1.63 C cg2dChkResFreq :: Frequency with which to check residual
140 cnh 1.1 C in con. grad solver.
141 jmc 1.119 C cg2dPreCondFreq :: Frequency for updating cg2d preconditioner
142     C (non-linear free-surf.)
143 cnh 1.63 C cg3dMaxIters :: Maximum number of iterations in the
144 cnh 1.33 C three-dimensional con. grad solver.
145 cnh 1.63 C cg3dChkResFreq :: Frequency with which to check residual
146 cnh 1.33 C in con. grad solver.
147 cnh 1.63 C nIter0 :: Start time-step number of for this run
148     C nTimeSteps :: Number of timesteps to execute
149     C writeStatePrec :: Precision used for writing model state.
150     C writeBinaryPrec :: Precision used for writing binary files
151     C readBinaryPrec :: Precision used for reading binary files
152     C nonlinFreeSurf :: option related to non-linear free surface
153 jmc 1.55 C =0 Linear free surface ; >0 Non-linear
154 jmc 1.84 C select_rStar :: option related to r* vertical coordinate
155     C =0 (default) use r coord. ; > 0 use r*
156 jmc 1.234 C selectNHfreeSurf :: option for Non-Hydrostatic (free-)Surface formulation:
157     C =0 (default) hydrostatic surf. ; > 0 add NH effects.
158 jmc 1.222 C selectAddFluid :: option to add mass source/sink of fluid in the interior
159     C (3-D generalisation of oceanic real-fresh water flux)
160     C =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)
161 jmc 1.180 C momForcingOutAB :: =1: take momentum forcing contribution
162     C out of (=0: in) Adams-Bashforth time stepping.
163     C tracForcingOutAB :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
164     C out of (=0: in) Adams-Bashforth time stepping.
165 jmc 1.115 C tempAdvScheme :: Temp. Horiz.Advection scheme selector
166 jmc 1.168 C tempVertAdvScheme :: Temp. Vert. Advection scheme selector
167 jmc 1.115 C saltAdvScheme :: Salt. Horiz.advection scheme selector
168     C saltVertAdvScheme :: Salt. Vert. Advection scheme selector
169 jmc 1.168 C selectKEscheme :: Kinetic Energy scheme selector (Vector Inv.)
170 jmc 1.214 C selectVortScheme :: Scheme selector for Vorticity term (Vector Inv.)
171 jmc 1.211 C monitorSelect :: select group of variables to monitor
172     C =1 : dynvars ; =2 : + vort ; =3 : + surface
173 jmc 1.115 C debugLevel :: debug level selector: higher -> more writing
174 cnh 1.34
175 cnh 1.1 COMMON /PARM_I/
176     & cg2dMaxIters,
177 jmc 1.119 & cg2dChkResFreq, cg2dPreCondFreq,
178 cnh 1.33 & cg3dMaxIters,
179     & cg3dChkResFreq,
180 adcroft 1.41 & nIter0, nTimeSteps, nEndIter,
181 jmc 1.205 & writeStatePrec,
182 cnh 1.34 & writeBinaryPrec, readBinaryPrec,
183 jmc 1.84 & nonlinFreeSurf, select_rStar,
184 jmc 1.234 & selectNHfreeSurf,
185 jmc 1.222 & selectAddFluid,
186 jmc 1.180 & momForcingOutAB, tracForcingOutAB,
187 jmc 1.115 & tempAdvScheme, tempVertAdvScheme,
188     & saltAdvScheme, saltVertAdvScheme,
189 jmc 1.214 & selectKEscheme, selectVortScheme,
190 jmc 1.211 & monitorSelect, debugLevel
191 cnh 1.1 INTEGER cg2dMaxIters
192     INTEGER cg2dChkResFreq
193 jmc 1.119 INTEGER cg2dPreCondFreq
194 cnh 1.33 INTEGER cg3dMaxIters
195     INTEGER cg3dChkResFreq
196 cnh 1.1 INTEGER nIter0
197     INTEGER nTimeSteps
198 adcroft 1.41 INTEGER nEndIter
199 cnh 1.7 INTEGER writeStatePrec
200     INTEGER writeBinaryPrec
201     INTEGER readBinaryPrec
202 jmc 1.55 INTEGER nonlinFreeSurf
203 jmc 1.84 INTEGER select_rStar
204 jmc 1.234 INTEGER selectNHfreeSurf
205 jmc 1.222 INTEGER selectAddFluid
206 jmc 1.180 INTEGER momForcingOutAB, tracForcingOutAB
207 jmc 1.115 INTEGER tempAdvScheme, tempVertAdvScheme
208     INTEGER saltAdvScheme, saltVertAdvScheme
209 jmc 1.183 INTEGER selectKEscheme
210 jmc 1.214 INTEGER selectVortScheme
211 jmc 1.211 INTEGER monitorSelect
212 heimbach 1.92 INTEGER debugLevel
213    
214 cnh 1.1 C-- COMMON /PARM_L/ Logical valued parameters used by the model.
215 jmc 1.215 C- Coordinate + Grid params:
216     C fluidIsAir :: Set to indicate that the fluid major constituent
217     C is air
218     C fluidIsWater :: Set to indicate that the fluid major constituent
219     C is water
220     C usingPCoords :: Set to indicate that we are working in a pressure
221     C type coordinate (p or p*).
222     C usingZCoords :: Set to indicate that we are working in a height
223     C type coordinate (z or z*)
224     C useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
225     C this requires specific code for restart & exchange
226 cnh 1.63 C usingCartesianGrid :: If TRUE grid generation will be in a cartesian
227 cnh 1.1 C coordinate frame.
228 jmc 1.206 C usingSphericalPolarGrid :: If TRUE grid generation will be in a
229 cnh 1.1 C spherical polar frame.
230 jmc 1.215 C rotateGrid :: rotate grid coordinates to geographical coordinates
231     C according to Euler angles phiEuler, thetaEuler, psiEuler
232     C usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
233 afe 1.114 C usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
234 jmc 1.192 C deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)
235 jmc 1.215 C setInterFDr :: set Interface depth (put cell-Center at the middle)
236     C setCenterDr :: set cell-Center depth (put Interface at the middle)
237     C- Momentum params:
238     C no_slip_sides :: Impose "no-slip" at lateral boundaries.
239 cnh 1.63 C no_slip_bottom :: Impose "no-slip" at bottom boundary.
240 jmc 1.215 C useFullLeith :: Set to true to use full Leith viscosity(may be unstable
241     C on irregular grids)
242     C useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
243     C useAreaViscLength :: Set to true to use old scaling for viscous lengths,
244     C e.g., L2=Raz. May be preferable for cube sphere.
245 cnh 1.63 C momViscosity :: Flag which turns momentum friction terms on and off.
246     C momAdvection :: Flag which turns advection of momentum on and off.
247     C momForcing :: Flag which turns external forcing of momentum on
248 jmc 1.215 C and off.
249 cnh 1.63 C momPressureForcing :: Flag which turns pressure term in momentum equation
250 cnh 1.9 C on and off.
251 cnh 1.63 C metricTerms :: Flag which turns metric terms on or off.
252 jmc 1.182 C useNHMTerms :: If TRUE use non-hydrostatic metric terms.
253 cnh 1.63 C useCoriolis :: Flag which turns the coriolis terms on and off.
254 jmc 1.215 C use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off
255     C useConstantF :: Coriolis parameter set to f0
256     C useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
257     C useSphereF :: Coriolis parameter set to 2.omega.sin(phi)
258     C useCDscheme :: use CD-scheme to calculate Coriolis terms.
259     C vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)
260     C (default = F = use mom_fluxform package)
261     C useJamartWetPoints :: Use wet-point method for Coriolis (Jamart & Ozer 1986)
262     C useJamartMomAdv :: Use wet-point method for V.I. non-linear term
263     C upwindVorticity :: bias interpolation of vorticity in the Coriolis term
264     C highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
265     C useAbsVorticity :: work with f+zeta in Coriolis terms
266     C upwindShear :: use 1rst order upwind interp. (V.I., vertical advection)
267     C momStepping :: Turns momentum equation time-stepping off
268     C- Temp. & Salt params:
269     C tempStepping :: Turns temperature equation time-stepping off
270     C saltStepping :: Turns salinity equation time-stepping off
271     C tempAdvection :: Flag which turns advection of temperature on and off.
272     C tempIsActiveTr :: Pot.Temp. is a dynamically active tracer
273     C tempForcing :: Flag which turns external forcing of temperature on
274     C and off.
275     C saltAdvection :: Flag which turns advection of salinity on and off.
276     C saltIsActiveTr :: Salinity is a dynamically active tracer
277     C saltForcing :: Flag which turns external forcing of salinity on
278     C and off.
279 jmc 1.230 C maskIniTemp :: apply mask to initial Pot.Temp.
280     C maskIniSalt :: apply mask to initial salinity
281     C checkIniTemp :: check for points with identically zero initial Pot.Temp.
282     C checkIniSalt :: check for points with identically zero initial salinity
283 jmc 1.206 C useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
284 jmc 1.71 C as a real Fresh Water (=> changes the Sea Level)
285     C if F, converts P+R-E to salt flux (no SL effect)
286 mlosch 1.232 C- Pressure solver related parameters (PARM02)
287     C useSRCGSolver :: Set to true to use conjugate gradient
288     C solver with single reduction (only one call of
289     C s/r mpi_allreduce), default is false
290 jmc 1.215 C- Time-stepping params:
291 cnh 1.63 C rigidLid :: Set to true to use rigid lid
292 jmc 1.173 C implicitFreeSurface :: Set to true to use implicit free surface
293 cnh 1.63 C exactConserv :: Set to true to conserve exactly the total Volume
294 dfer 1.194 C linFSConserveTr :: Set to true to correct source/sink of tracer
295 jmc 1.206 C at the surface due to Linear Free Surface
296 cnh 1.63 C uniformLin_PhiSurf :: Set to true to use a uniform Bo_surf in the
297 jmc 1.215 C linear relation Phi_surf = Bo_surf*eta
298     C quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
299     C nonHydrostatic :: Using non-hydrostatic algorithm
300     C use3Dsolver :: set to true to use 3-D pressure solver
301 jmc 1.173 C implicitIntGravWave :: treat Internal Gravity Wave implicitly
302 jmc 1.215 C staggerTimeStep :: enable a Stagger time stepping U,V (& W) then T,S
303 cnh 1.63 C implicitDiffusion :: Turns implicit vertical diffusion on
304     C implicitViscosity :: Turns implicit vertical viscosity on
305 jmc 1.100 C tempImplVertAdv :: Turns on implicit vertical advection for Temperature
306     C saltImplVertAdv :: Turns on implicit vertical advection for Salinity
307     C momImplVertAdv :: Turns on implicit vertical advection for Momentum
308 jmc 1.71 C multiDimAdvection :: Flag that enable multi-dimension advection
309 jmc 1.118 C useMultiDimAdvec :: True if multi-dim advection is used at least once
310 jmc 1.180 C momDissip_In_AB :: if False, put Dissipation tendency contribution
311 jmc 1.170 C out off Adams-Bashforth time stepping.
312     C doAB_onGtGs :: if the Adams-Bashforth time stepping is used, always
313 jmc 1.195 C apply AB on tracer tendencies (rather than on Tracer)
314 jmc 1.215 C- Other forcing params -
315     C balanceEmPmR :: substract global mean of EmPmR at every time step
316     C balanceQnet :: substract global mean of Qnet at every time step
317     C balancePrintMean:: print substracted global means to STDOUT
318 cnh 1.63 C doThetaClimRelax :: Set true if relaxation to temperature
319 cnh 1.18 C climatology is required.
320 cnh 1.63 C doSaltClimRelax :: Set true if relaxation to salinity
321 cnh 1.18 C climatology is required.
322 jmc 1.215 C allowFreezing :: Allows surface water to freeze and form ice
323     C useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
324 cnh 1.63 C periodicExternalForcing :: Set true if forcing is time-dependant
325 jmc 1.215 C- I/O parameters -
326 cnh 1.63 C globalFiles :: Selects between "global" and "tiled" files
327 dimitri 1.85 C useSingleCpuIO :: On SGI platforms, option globalFiles is either
328     C slow (f77) or does not work (f90). When
329     C useSingleCpuIO is set, mdsio_writefield.F
330     C outputs from master mpi process only.
331 jmc 1.215 C pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
332     C startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
333     C usePickupBeforeC54 :: start from old-pickup files, generated with code from
334     C before checkpoint-54a, Jul 06, 2004.
335 edhill 1.124 C pickup_write_mdsio :: use mdsio to write pickups
336     C pickup_read_mdsio :: use mdsio to read pickups
337     C pickup_write_immed :: echo the pickup immediately (for conversion)
338 mlosch 1.213 C writePickupAtEnd :: write pickup at the last timestep
339 edhill 1.124 C timeave_mdsio :: use mdsio for timeave output
340     C snapshot_mdsio :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
341 edhill 1.125 C monitor_stdio :: use stdio for monitor output
342 jmc 1.206 C dumpInitAndLast :: dumps model state to files at Initial (nIter0)
343 jmc 1.164 C & Last iteration, in addition multiple of dumpFreq iter.
344 mlosch 1.177
345 jmc 1.215 COMMON /PARM_L/
346     & fluidIsAir, fluidIsWater,
347     & usingPCoords, usingZCoords, useDynP_inEos_Zc,
348     & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,
349 afe 1.114 & usingCurvilinearGrid, usingCylindricalGrid,
350 jmc 1.192 & deepAtmosphere, setInterFDr, setCenterDr,
351 jmc 1.215 & no_slip_sides, no_slip_bottom,
352     & useFullLeith, useStrainTensionVisc, useAreaViscLength,
353     & momViscosity, momAdvection, momForcing,
354     & momPressureForcing, metricTerms, useNHMTerms,
355     & useCoriolis, use3dCoriolis,
356     & useConstantF, useBetaPlaneF, useSphereF,
357     & useCDscheme, vectorInvariantMomentum,
358     & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
359     & upwindVorticity, highOrderVorticity,
360     & useAbsVorticity, upwindShear,
361     & momStepping, tempStepping, saltStepping,
362     & tempAdvection, tempIsActiveTr, tempForcing,
363     & saltAdvection, saltIsActiveTr, saltForcing,
364 jmc 1.230 & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
365 jmc 1.222 & useRealFreshWaterFlux,
366 dfer 1.194 & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,
367     & uniformLin_PhiSurf,
368 jmc 1.215 & quasiHydrostatic, nonHydrostatic,
369 jmc 1.178 & use3Dsolver, implicitIntGravWave, staggerTimeStep,
370 adcroft 1.40 & implicitDiffusion, implicitViscosity,
371 jmc 1.100 & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
372 jmc 1.183 & multiDimAdvection, useMultiDimAdvec,
373 jmc 1.180 & momDissip_In_AB, doAB_onGtGs,
374 jmc 1.215 & balanceEmPmR, balanceQnet, balancePrintMean,
375     & doThetaClimRelax, doSaltClimRelax,
376     & allowFreezing, useOldFreezing,
377 jmc 1.183 & periodicExternalForcing,
378 jmc 1.215 & globalFiles, useSingleCpuIO,
379 jmc 1.206 & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
380 edhill 1.124 & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
381 mlosch 1.213 & writePickupAtEnd,
382 edhill 1.155 & timeave_mdsio, snapshot_mdsio, monitor_stdio,
383 jmc 1.164 & outputTypesInclusive, dumpInitAndLast, debugMode,
384 mlosch 1.232 & inAdMode, inAdTrue, inAdFalse, inAdExact,
385     & useSRCGSolver
386 edhill 1.131
387 jmc 1.215 LOGICAL fluidIsAir
388     LOGICAL fluidIsWater
389     LOGICAL usingPCoords
390     LOGICAL usingZCoords
391     LOGICAL useDynP_inEos_Zc
392 cnh 1.1 LOGICAL usingCartesianGrid
393 jmc 1.215 LOGICAL usingSphericalPolarGrid, rotateGrid
394 afe 1.114 LOGICAL usingCylindricalGrid
395 adcroft 1.52 LOGICAL usingCurvilinearGrid
396 jmc 1.192 LOGICAL deepAtmosphere
397 jmc 1.191 LOGICAL setInterFDr
398     LOGICAL setCenterDr
399 adcroft 1.77 LOGICAL useNHMTerms
400 adcroft 1.36 LOGICAL no_slip_sides
401     LOGICAL no_slip_bottom
402 cnh 1.1 LOGICAL momViscosity
403     LOGICAL momAdvection
404     LOGICAL momForcing
405 cnh 1.9 LOGICAL momPressureForcing
406 cnh 1.1 LOGICAL useCoriolis
407 adcroft 1.58 LOGICAL vectorInvariantMomentum
408 cnh 1.1 LOGICAL tempAdvection
409 jmc 1.216 LOGICAL tempIsActiveTr
410 cnh 1.1 LOGICAL tempForcing
411     LOGICAL saltAdvection
412 jmc 1.216 LOGICAL saltIsActiveTr
413 cnh 1.1 LOGICAL saltForcing
414 jmc 1.230 LOGICAL maskIniTemp
415     LOGICAL maskIniSalt
416     LOGICAL checkIniTemp
417     LOGICAL checkIniSalt
418 jmc 1.68 LOGICAL useRealFreshWaterFlux
419 baylor 1.165 LOGICAL useFullLeith
420     LOGICAL useStrainTensionVisc
421 baylor 1.167 LOGICAL useAreaViscLength
422 adcroft 1.52 LOGICAL rigidLid
423 cnh 1.8 LOGICAL implicitFreeSurface
424 adcroft 1.52 LOGICAL exactConserv
425 dfer 1.194 LOGICAL linFSConserveTr
426 jmc 1.55 LOGICAL uniformLin_PhiSurf
427 jmc 1.215 LOGICAL quasiHydrostatic
428     LOGICAL nonHydrostatic
429 jmc 1.178 LOGICAL use3Dsolver
430 jmc 1.173 LOGICAL implicitIntGravWave
431     LOGICAL staggerTimeStep
432 cnh 1.10 LOGICAL momStepping
433     LOGICAL tempStepping
434 adcroft 1.17 LOGICAL saltStepping
435 cnh 1.15 LOGICAL metricTerms
436     LOGICAL useConstantF
437     LOGICAL useBetaPlaneF
438     LOGICAL useSphereF
439 jmc 1.188 LOGICAL use3dCoriolis
440 jmc 1.89 LOGICAL useCDscheme
441 jmc 1.71 LOGICAL useEnergyConservingCoriolis
442     LOGICAL useJamartWetPoints
443 adcroft 1.113 LOGICAL useJamartMomAdv
444 adcroft 1.111 LOGICAL upwindVorticity
445     LOGICAL highOrderVorticity
446     LOGICAL useAbsVorticity
447 jmc 1.159 LOGICAL upwindShear
448 adcroft 1.14 LOGICAL implicitDiffusion
449 adcroft 1.40 LOGICAL implicitViscosity
450 jmc 1.183 LOGICAL tempImplVertAdv
451     LOGICAL saltImplVertAdv
452 jmc 1.100 LOGICAL momImplVertAdv
453 jmc 1.71 LOGICAL multiDimAdvection
454 jmc 1.118 LOGICAL useMultiDimAdvec
455 jmc 1.180 LOGICAL momDissip_In_AB
456 jmc 1.170 LOGICAL doAB_onGtGs
457 jmc 1.215 LOGICAL balanceEmPmR
458     LOGICAL balanceQnet
459     LOGICAL balancePrintMean
460 cnh 1.18 LOGICAL doThetaClimRelax
461     LOGICAL doSaltClimRelax
462 jmc 1.215 LOGICAL allowFreezing
463     LOGICAL useOldFreezing
464 adcroft 1.19 LOGICAL periodicExternalForcing
465 adcroft 1.38 LOGICAL globalFiles
466 dimitri 1.85 LOGICAL useSingleCpuIO
467 jmc 1.206 LOGICAL pickupStrictlyMatch
468 jmc 1.117 LOGICAL usePickupBeforeC54
469 jmc 1.154 LOGICAL startFromPickupAB2
470 edhill 1.124 LOGICAL pickup_read_mdsio, pickup_write_mdsio
471 mlosch 1.213 LOGICAL pickup_write_immed, writePickupAtEnd
472 edhill 1.125 LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
473 edhill 1.133 LOGICAL outputTypesInclusive
474 jmc 1.215 LOGICAL dumpInitAndLast
475     LOGICAL debugMode
476 heimbach 1.143 LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
477 mlosch 1.232 LOGICAL useSRCGSolver
478 cnh 1.1
479     C-- COMMON /PARM_R/ "Real" valued parameters used by the model.
480 jmc 1.119 C cg2dTargetResidual
481 cnh 1.63 C :: Target residual for cg2d solver; no unit (RHS normalisation)
482 adcroft 1.52 C cg2dTargetResWunit
483 cnh 1.63 C :: Target residual for cg2d solver; W unit (No RHS normalisation)
484 cnh 1.33 C cg3dTargetResidual
485 cnh 1.63 C :: Target residual for cg3d solver.
486     C cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
487 cnh 1.7 C Note. 20th May 1998
488     C I made a weird discovery! In the model paper we argue
489     C for the form of the preconditioner used here ( see
490     C A Finite-volume, Incompressible Navier-Stokes Model
491     C ...., Marshall et. al ). The algebra gives a simple
492     C 0.5 factor for the averaging of ac and aCw to get a
493     C symmettric pre-conditioner. By using a factor of 0.51
494     C i.e. scaling the off-diagonal terms in the
495     C preconditioner down slightly I managed to get the
496     C number of iterations for convergence in a test case to
497     C drop form 192 -> 134! Need to investigate this further!
498     C For now I have introduced a parameter cg2dpcOffDFac which
499     C defaults to 0.51 but can be set at runtime.
500 cnh 1.63 C delR :: Vertical grid spacing ( units of r ).
501 jmc 1.70 C delRc :: Vertical grid spacing between cell centers (r unit).
502 cnh 1.63 C delX :: Separation between cell faces (m) or (deg), depending
503 cnh 1.1 C delY on input flags.
504 cnh 1.63 C gravity :: Accel. due to gravity ( m/s^2 )
505 cnh 1.32 C recip_gravity and its inverse
506 cnh 1.63 C gBaro :: Accel. due to gravity used in barotropic equation ( m/s^2 )
507 mlosch 1.75 C rhoNil :: Reference density for the linear equation of state
508 jmc 1.191 C rhoConst :: Vertically constant reference density
509     C rhoFacC :: normalized (by rhoConst) reference density at cell-Center
510     C rhoFacF :: normalized (by rhoConst) reference density at cell-interFace
511 mlosch 1.75 C rhoConstFresh :: Constant reference density for fresh water (rain)
512 jmc 1.223 C rho1Ref :: reference vertical profile for density
513 jmc 1.132 C tRef :: reference vertical profile for potential temperature
514 jmc 1.191 C sRef :: reference vertical profile for salinity/specific humidity
515     C phiRef :: reference potential (pressure/rho, geopotential) profile
516 jmc 1.173 C dBdrRef :: vertical gradient of reference boyancy [(m/s/r)^2)]:
517     C :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
518     C :: p-coord: = -(d.alpha/dp)_ref [(m^2.s/kg)^2]
519 jmc 1.197 C rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
520     C :: from r-coordinate vertical velocity to vertical velocity [m/s].
521     C :: z-coord: = 1 ; p-coord: wSpeed [m/s] = rVel [Pa/s] * rVel2wUnit
522     C wUnit2rVel :: units conversion factor (Non-Hydrostatic code),
523     C :: from vertical velocity [m/s] to r-coordinate vertical velocity.
524     C :: z-coord: = 1 ; p-coord: rVel [Pa/s] = wSpeed [m/s] * wUnit2rVel
525 jmc 1.203 C mass2rUnit :: units conversion factor (surface forcing),
526     C :: from mass per unit area [kg/m2] to vertical r-coordinate unit.
527     C :: z-coord: = 1/rhoConst ( [kg/m2] / rho = [m] ) ;
528     C :: p-coord: = gravity ( [kg/m2] * g = [Pa] ) ;
529     C rUnit2mass :: units conversion factor (surface forcing),
530     C :: from vertical r-coordinate unit to mass per unit area [kg/m2].
531     C :: z-coord: = rhoConst ( [m] * rho = [kg/m2] ) ;
532     C :: p-coord: = 1/gravity ( [Pa] / g = [kg/m2] ) ;
533 jmc 1.227 C xgOrigin :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
534     C :: most cell face (Lat-Lon grid) (Note: this is an "inert"
535     C :: parameter but it makes geographical references simple.)
536     C ygOrigin :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
537     C :: most face (Lat-Lon grid).
538     C rSphere :: Radius of sphere for a spherical polar grid ( m ).
539 jmc 1.191 C recip_rSphere :: Reciprocal radius of sphere ( m ).
540 jmc 1.227 C f0 :: Reference coriolis parameter ( 1/s )
541     C ( Southern edge f for beta plane )
542     C beta :: df/dy ( s^-1.m^-1 )
543     C omega :: Angular velocity ( rad/s )
544 jmc 1.88 C rotationPeriod :: Rotation period (s) (= 2.pi/omega)
545 jmc 1.229 C viscArNr :: vertical profile of Eddy viscosity coeff.
546     C for vertical mixing of momentum ( units of r^2/s )
547 jmc 1.227 C viscAh :: Eddy viscosity coeff. for mixing of
548     C momentum laterally ( m^2/s )
549     C viscAhW :: Eddy viscosity coeff. for mixing of vertical
550     C momentum laterally, no effect for hydrostatic
551     C model, defaults to viscAh if unset ( m^2/s )
552     C Not used if variable horiz. viscosity is used.
553     C viscA4 :: Biharmonic viscosity coeff. for mixing of
554     C momentum laterally ( m^4/s )
555     C viscA4W :: Biharmonic viscosity coeff. for mixing of vertical
556     C momentum laterally, no effect for hydrostatic
557     C model, defaults to viscA4 if unset ( m^2/s )
558     C Not used if variable horiz. viscosity is used.
559     C viscAhD :: Eddy viscosity coeff. for mixing of momentum laterally
560     C (act on Divergence part) ( m^2/s )
561     C viscAhZ :: Eddy viscosity coeff. for mixing of momentum laterally
562     C (act on Vorticity part) ( m^2/s )
563     C viscA4D :: Biharmonic viscosity coeff. for mixing of momentum laterally
564     C (act on Divergence part) ( m^4/s )
565     C viscA4Z :: Biharmonic viscosity coeff. for mixing of momentum laterally
566     C (act on Vorticity part) ( m^4/s )
567 jmc 1.214 C viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))
568 baylor 1.166 C viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
569 jmc 1.214 C viscC4leith :: Leith non-dimensional viscosity factor (grad(vort))
570     C viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
571     C viscC2smag :: Smagorinsky non-dimensional viscosity factor (harmonic)
572     C viscC4smag :: Smagorinsky non-dimensional viscosity factor (biharmonic)
573     C viscAhMax :: Maximum eddy viscosity coeff. for mixing of
574     C momentum laterally ( m^2/s )
575     C viscAhReMax :: Maximum gridscale Reynolds number for eddy viscosity
576     C coeff. for mixing of momentum laterally (non-dim)
577     C viscAhGrid :: non-dimensional grid-size dependent viscosity
578 baylor 1.146 C viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
579 baylor 1.166 C viscAhGridMin:: in terms of non-dimensional grid-size dependent visc.
580 jmc 1.214 C viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
581     C momentum laterally ( m^4/s )
582     C viscA4ReMax :: Maximum Gridscale Reynolds number for
583     C biharmonic viscosity coeff. momentum laterally (non-dim)
584     C viscA4Grid :: non-dimensional grid-size dependent bi-harmonic viscosity
585 dimitri 1.136 C viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
586     C viscA4GridMin:: in terms of non-dimensional grid-size dependent viscosity
587 cnh 1.63 C diffKhT :: Laplacian diffusion coeff. for mixing of
588 cnh 1.1 C heat laterally ( m^2/s )
589 jmc 1.214 C diffKrNrT :: vertical profile of Laplacian diffusion coeff.
590 jmc 1.132 C for mixing of heat vertically ( units of r^2/s )
591 cnh 1.63 C diffK4T :: Biharmonic diffusion coeff. for mixing of
592 cnh 1.1 C heat laterally ( m^4/s )
593 cnh 1.63 C diffKhS :: Laplacian diffusion coeff. for mixing of
594 cnh 1.1 C salt laterally ( m^2/s )
595 jmc 1.214 C diffKrNrS :: vertical profile of Laplacian diffusion coeff.
596     C for mixing of salt vertically ( units of r^2/s ),
597 cnh 1.63 C diffK4S :: Biharmonic diffusion coeff. for mixing of
598 cnh 1.1 C salt laterally ( m^4/s )
599 adcroft 1.112 C diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
600     C diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
601     C diffKrBL79scl :: depth scale for arctan fn (m) Bryan and Lewis, 1979
602     C diffKrBL79Ho :: depth offset for arctan fn (m) Bryan and Lewis, 1979
603 dimitri 1.201 C BL79LatVary :: polarwise of this latitude diffKrBL79 is applied with
604     C gradual transition to diffKrBLEQ towards Equator
605     C diffKrBLEQsurf :: same as diffKrBL79surf but at Equator
606     C diffKrBLEQdeep :: same as diffKrBL79deep but at Equator
607     C diffKrBLEQscl :: same as diffKrBL79scl but at Equator
608     C diffKrBLEQHo :: same as diffKrBL79Ho but at Equator
609 cnh 1.63 C deltaT :: Default timestep ( s )
610     C deltaTClock :: Timestep used as model "clock". This determines the
611 cnh 1.7 C IO frequencies and is used in tagging output. It can
612     C be totally different to the dynamical time. Typically
613     C it will be the deep-water timestep for accelerated runs.
614     C Frequency of checkpointing and dumping of the model state
615     C are referenced to this clock. ( s )
616 cnh 1.63 C deltaTMom :: Timestep for momemtum equations ( s )
617 jmc 1.139 C dTtracerLev :: Timestep for tracer equations ( s ), function of level k
618 adcroft 1.72 C deltaTfreesurf :: Timestep for free-surface equation ( s )
619 cnh 1.63 C freesurfFac :: Parameter to turn implicit free surface term on or off
620 cnh 1.8 C freesurfac = 1. uses implicit free surface
621     C freesurfac = 0. uses rigid lid
622 jmc 1.154 C abEps :: Adams-Bashforth-2 stabilizing weight
623     C alph_AB :: Adams-Bashforth-3 primary factor
624     C beta_AB :: Adams-Bashforth-3 secondary factor
625 cnh 1.63 C implicSurfPress :: parameter of the Crank-Nickelson time stepping :
626 jmc 1.48 C Implicit part of Surface Pressure Gradient ( 0-1 )
627 cnh 1.63 C implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
628 jmc 1.48 C Implicit part of barotropic flow Divergence ( 0-1 )
629 jmc 1.233 C implicitNHPress :: parameter of the Crank-Nickelson time stepping :
630     C Implicit part of Non-Hydrostatic Pressure Gradient ( 0-1 )
631 cnh 1.63 C hFacMin :: Minimum fraction size of a cell (affects hFacC etc...)
632 jmc 1.231 C hFacMinDz :: Minimum dimensional size of a cell (affects hFacC etc..., m)
633     C hFacMinDp :: Minimum dimensional size of a cell (affects hFacC etc..., Pa)
634     C hFacMinDr :: Minimum dimensional size of a cell (-> hFacC etc..., r units)
635 cnh 1.63 C hFacInf :: Threshold (inf and sup) for fraction size of surface cell
636 jmc 1.231 C hFacSup that control vanishing and creating levels
637     C tauCD :: CD scheme coupling timescale ( s )
638     C rCD :: CD scheme normalised coupling parameter (= 1 - deltaT/tauCD)
639     C epsAB_CD :: Adams-Bashforth-2 stabilizing weight used in CD scheme
640 jmc 1.150 C baseTime :: model base time (time origin) = time @ iteration zero
641 cnh 1.63 C startTime :: Starting time for this integration ( s ).
642     C endTime :: Ending time for this integration ( s ).
643     C chkPtFreq :: Frequency of rolling check pointing ( s ).
644     C pChkPtFreq :: Frequency of permanent check pointing ( s ).
645     C dumpFreq :: Frequency with which model state is written to
646 cnh 1.24 C post-processing files ( s ).
647 cnh 1.63 C diagFreq :: Frequency with which model writes diagnostic output
648 adcroft 1.59 C of intermediate quantities.
649 cnh 1.63 C afFacMom :: Advection of momentum term tracer parameter
650     C vfFacMom :: Momentum viscosity tracer parameter
651     C pfFacMom :: Momentum pressure forcing tracer parameter
652     C cfFacMom :: Coriolis term tracer parameter
653     C foFacMom :: Momentum forcing tracer parameter
654     C mtFacMom :: Metric terms tracer parameter
655     C cosPower :: Power of cosine of latitude to multiply viscosity
656     C cAdjFreq :: Frequency of convective adjustment
657 cnh 1.24 C
658 jmc 1.214 C taveFreq :: Frequency with which time-averaged model state
659 jmc 1.76 C is written to post-processing files ( s ).
660 jmc 1.214 C tave_lastIter :: (for state variable only) fraction of the last time
661     C step (of each taveFreq period) put in the time average.
662 jmc 1.76 C (fraction for 1rst iter = 1 - tave_lastIter)
663 cnh 1.63 C tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
664     C tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
665 jmc 1.95 C latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
666     C i.e. where |yC| <= latBandClimRelax
667 cnh 1.63 C externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
668     C externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
669 adcroft 1.19 C (note: externForcingCycle must be an integer
670     C number times externForcingPeriod)
671 jmc 1.68 C convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
672     C (use model surface (local) value if set to -1)
673 jmc 1.214 C temp_EvPrRn :: temperature of Rain & Evap.
674 jmc 1.68 C salt_EvPrRn :: salinity of Rain & Evap.
675 dimitri 1.237 C temp_addMass :: temperature of addMass array
676     C salt_addMass :: salinity of addMass array
677 jmc 1.214 C (notes: a) tracer content of Rain/Evap only used if both
678 jmc 1.68 C NonLin_FrSurf & useRealFreshWater are set.
679     C b) use model surface (local) value if set to UNSET_RL)
680 dfer 1.225 C hMixCriteria:: criteria for mixed-layer diagnostic
681     C dRhoSmall :: parameter for mixed-layer diagnostic
682 dfer 1.226 C hMixSmooth :: Smoothing parameter for mixed-layer diag (default=0=no smoothing)
683 jmc 1.202 C ivdc_kappa :: implicit vertical diffusivity for convection [m^2/s]
684     C Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
685     C starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
686 jmc 1.214 C sideDragFactor :: side-drag scaling factor (used only if no_slip_sides)
687 jmc 1.169 C (default=2: full drag ; =1: gives half-slip BC)
688 jmc 1.184 C bottomDragLinear :: Linear bottom-drag coefficient (units of [r]/s)
689     C bottomDragQuadratic :: Quadratic bottom-drag coefficient (units of [r]/m)
690     C (if using zcoordinate, units becomes linear: m/s, quadratic: [-])
691 heimbach 1.185 C smoothAbsFuncRange :: 1/2 of interval around zero, for which FORTRAN ABS
692     C is to be replace by a smoother function
693     C (affects myabs, mymin, mymax)
694 jmc 1.169 C nh_Am2 :: scales the non-hydrostatic terms and changes internal scales
695     C (i.e. allows convection at different Rayleigh numbers)
696 mlosch 1.212 C phiEuler :: Euler angle, rotation about original z-axis
697     C thetaEuler :: Euler angle, rotation about new x-axis
698     C psiEuler :: Euler angle, rotation about new z-axis
699 jmc 1.183 COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
700 adcroft 1.52 & cg2dpcOffDFac, cg3dTargetResidual,
701 jmc 1.96 & delR, delRc, delX, delY,
702 jmc 1.139 & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
703 jmc 1.154 & abEps, alph_AB, beta_AB,
704 jmc 1.227 & xgOrigin, ygOrigin, rSphere, recip_RSphere, f0, beta,
705 baylor 1.146 & viscAh, viscAhW, viscAhMax,
706     & viscAhGrid, viscAhGridMax, viscAhGridMin,
707     & viscC2leith, viscC2leithD,
708 baylor 1.165 & viscC2smag, viscC4smag,
709 jmc 1.135 & viscAhD, viscAhZ, viscA4D, viscA4Z,
710 jmc 1.214 & viscA4, viscA4W, viscA4Max,
711     & viscA4Grid, viscA4GridMax, viscA4GridMin,
712     & viscAhReMax, viscA4ReMax,
713 jmc 1.229 & viscC4leith, viscC4leithD, viscArNr,
714 dimitri 1.199 & diffKhT, diffK4T, diffKrNrT,
715     & diffKhS, diffK4S, diffKrNrS,
716 adcroft 1.112 & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
717 dimitri 1.201 & BL79LatVary,
718 dimitri 1.200 & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
719 jmc 1.231 & tauCD, rCD, epsAB_CD,
720 jmc 1.233 & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,
721 adcroft 1.52 & hFacMin, hFacMinDz, hFacInf, hFacSup,
722 jmc 1.203 & gravity, recip_gravity, gBaro,
723 jmc 1.191 & rhonil, recip_rhonil, rhoConst, recip_rhoConst,
724     & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
725 jmc 1.223 & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,
726 jmc 1.203 & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
727 jmc 1.183 & baseTime, startTime, endTime,
728     & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
729 heimbach 1.143 & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
730 cnh 1.15 & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
731 jmc 1.88 & cosPower, cAdjFreq, omega, rotationPeriod,
732 jmc 1.215 & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
733 cnh 1.27 & externForcingCycle, externForcingPeriod,
734 jmc 1.137 & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
735 dimitri 1.237 & temp_addMass, salt_addMass, hFacMinDr, hFacMinDp,
736 dfer 1.226 & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth, Ro_SeaLevel,
737 jmc 1.169 & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
738 jmc 1.191 & smoothAbsFuncRange,
739 mlosch 1.212 & tCylIn, tCylOut,
740     & phiEuler, thetaEuler, psiEuler
741 cnh 1.27
742 adcroft 1.6 _RL cg2dTargetResidual
743 adcroft 1.52 _RL cg2dTargetResWunit
744 cnh 1.33 _RL cg3dTargetResidual
745 cnh 1.7 _RL cg2dpcOffDFac
746 cnh 1.25 _RL delR(Nr)
747 jmc 1.70 _RL delRc(Nr+1)
748 adcroft 1.6 _RL delX(Nx)
749     _RL delY(Ny)
750     _RL deltaT
751 cnh 1.7 _RL deltaTClock
752 adcroft 1.6 _RL deltaTmom
753 jmc 1.139 _RL dTtracerLev(Nr)
754 adcroft 1.72 _RL deltaTfreesurf
755 jmc 1.154 _RL abEps, alph_AB, beta_AB
756 jmc 1.227 _RL xgOrigin
757     _RL ygOrigin
758 adcroft 1.6 _RL rSphere
759 jmc 1.191 _RL recip_rSphere
760 adcroft 1.6 _RL f0
761 cnh 1.8 _RL freeSurfFac
762 jmc 1.48 _RL implicSurfPress
763     _RL implicDiv2Dflow
764 jmc 1.233 _RL implicitNHPress
765 adcroft 1.22 _RL hFacMin
766     _RL hFacMinDz
767 cnh 1.28 _RL hFacMinDp
768 cnh 1.27 _RL hFacMinDr
769 adcroft 1.52 _RL hFacInf
770     _RL hFacSup
771 adcroft 1.6 _RL beta
772 jmc 1.229 _RL viscArNr(Nr)
773 adcroft 1.6 _RL viscAh
774 mlosch 1.128 _RL viscAhW
775 jmc 1.135 _RL viscAhD
776     _RL viscAhZ
777 adcroft 1.102 _RL viscAhMax
778 baylor 1.166 _RL viscAhReMax
779 jmc 1.214 _RL viscAhGrid, viscAhGridMax, viscAhGridMin
780 adcroft 1.110 _RL viscC2leith
781 baylor 1.146 _RL viscC2leithD
782 baylor 1.147 _RL viscC2smag
783 jmc 1.183 _RL viscA4
784 mlosch 1.140 _RL viscA4W
785 jmc 1.135 _RL viscA4D
786     _RL viscA4Z
787 adcroft 1.102 _RL viscA4Max
788 baylor 1.166 _RL viscA4ReMax
789 dimitri 1.136 _RL viscA4Grid, viscA4GridMax, viscA4GridMin
790 adcroft 1.110 _RL viscC4leith
791 baylor 1.146 _RL viscC4leithD
792 jmc 1.214 _RL viscC4smag
793 jmc 1.183 _RL diffKhT
794 jmc 1.132 _RL diffKrNrT(Nr)
795 jmc 1.183 _RL diffK4T
796     _RL diffKhS
797 jmc 1.132 _RL diffKrNrS(Nr)
798 jmc 1.183 _RL diffK4S
799 adcroft 1.112 _RL diffKrBL79surf
800     _RL diffKrBL79deep
801     _RL diffKrBL79scl
802     _RL diffKrBL79Ho
803 dimitri 1.201 _RL BL79LatVary
804 dimitri 1.200 _RL diffKrBLEQsurf
805     _RL diffKrBLEQdeep
806     _RL diffKrBLEQscl
807     _RL diffKrBLEQHo
808 jmc 1.231 _RL tauCD, rCD, epsAB_CD
809 adcroft 1.6 _RL gravity
810 cnh 1.32 _RL recip_gravity
811 cnh 1.8 _RL gBaro
812 jmc 1.191 _RL rhonil, recip_rhonil
813     _RL rhoConst, recip_rhoConst
814     _RL rhoFacC(Nr), recip_rhoFacC(Nr)
815     _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
816 mlosch 1.75 _RL rhoConstFresh
817 jmc 1.223 _RL rho1Ref(Nr)
818 cnh 1.25 _RL tRef(Nr)
819     _RL sRef(Nr)
820 jmc 1.171 _RL phiRef(2*Nr+1)
821 jmc 1.173 _RL dBdrRef(Nr)
822 jmc 1.197 _RL rVel2wUnit(Nr+1), wUnit2rVel(Nr+1)
823 jmc 1.203 _RL mass2rUnit, rUnit2mass
824 jmc 1.150 _RL baseTime
825 adcroft 1.6 _RL startTime
826     _RL endTime
827     _RL chkPtFreq
828 cnh 1.7 _RL pChkPtFreq
829 adcroft 1.6 _RL dumpFreq
830 heimbach 1.103 _RL adjDumpFreq
831 adcroft 1.59 _RL diagFreq
832 adcroft 1.20 _RL taveFreq
833 jmc 1.76 _RL tave_lastIter
834 adcroft 1.53 _RL monitorFreq
835 heimbach 1.143 _RL adjMonitorFreq
836 cnh 1.9 _RL afFacMom
837     _RL vfFacMom
838     _RL pfFacMom
839     _RL cfFacMom
840     _RL foFacMom
841 jmc 1.182 _RL mtFacMom
842 adcroft 1.39 _RL cosPower
843 cnh 1.9 _RL cAdjFreq
844 cnh 1.15 _RL omega
845 jmc 1.88 _RL rotationPeriod
846 cnh 1.18 _RL tauThetaClimRelax
847     _RL tauSaltClimRelax
848 jmc 1.95 _RL latBandClimRelax
849 adcroft 1.19 _RL externForcingCycle
850     _RL externForcingPeriod
851 jmc 1.68 _RL convertFW2Salt
852     _RL temp_EvPrRn
853     _RL salt_EvPrRn
854 dimitri 1.237 _RL temp_addMass
855     _RL salt_addMass
856 adcroft 1.41 _RL ivdc_kappa
857 jmc 1.202 _RL hMixCriteria
858 dfer 1.225 _RL dRhoSmall
859 dfer 1.226 _RL hMixSmooth
860 adcroft 1.46 _RL Ro_SeaLevel
861 jmc 1.169 _RL sideDragFactor
862 adcroft 1.46 _RL bottomDragLinear
863     _RL bottomDragQuadratic
864 heimbach 1.185 _RL smoothAbsFuncRange
865 jmc 1.169 _RL nh_Am2
866 afe 1.142 _RL tCylIn
867     _RL tCylOut
868 mlosch 1.212 _RL phiEuler, thetaEuler, psiEuler
869 adcroft 1.6
870 jmc 1.91 C-- COMMON /PARM_A/ Thermodynamics constants ?
871     COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
872 adcroft 1.6 _RL HeatCapacity_Cp
873 adcroft 1.36 _RL recip_Cp
874 jmc 1.55
875 jmc 1.91 C-- COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
876     C celsius2K :: convert centigrade (Celsius) degree to Kelvin
877 jmc 1.83 C atm_Po :: standard reference pressure
878     C atm_Cp :: specific heat (Cp) of the (dry) air at constant pressure
879     C atm_Rd :: gas constant for dry air
880 cnh 1.63 C atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
881 jmc 1.94 C atm_Rq :: water vapour specific volume anomaly relative to dry air
882     C (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
883 jmc 1.83 C integr_GeoPot :: option to select the way we integrate the geopotential
884 jmc 1.214 C (still a subject of discussions ...)
885 jmc 1.83 C selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
886     C derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
887 jmc 1.183 COMMON /PARM_ATM/
888 jmc 1.91 & celsius2K,
889 jmc 1.94 & atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
890 jmc 1.91 & integr_GeoPot, selectFindRoSurf
891     _RL celsius2K
892 jmc 1.94 _RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq
893 jmc 1.83 INTEGER integr_GeoPot, selectFindRoSurf
894 cnh 1.7
895 adcroft 1.44 C Logical flags for selecting packages
896 jmc 1.220 LOGICAL useGAD
897     LOGICAL useOBCS
898     LOGICAL useSHAP_FILT
899     LOGICAL useZONAL_FILT
900 mlosch 1.126 LOGICAL useOPPS
901 mlosch 1.121 LOGICAL usePP81
902     LOGICAL useMY82
903 mlosch 1.126 LOGICAL useGGL90
904 heimbach 1.45 LOGICAL useKPP
905     LOGICAL useGMRedi
906 jmc 1.220 LOGICAL useDOWN_SLOPE
907 jmc 1.183 LOGICAL useCAL
908     LOGICAL useEXF
909 jmc 1.220 LOGICAL useBulkForce
910 jmc 1.183 LOGICAL useEBM
911 jmc 1.220 LOGICAL useCheapAML
912 heimbach 1.56 LOGICAL useGrdchk
913 jmc 1.231 LOGICAL useSMOOTH
914 heimbach 1.45 LOGICAL useECCO
915 jmc 1.220 LOGICAL useSBO
916 adcroft 1.62 LOGICAL useFLT
917 adcroft 1.69 LOGICAL usePTRACERS
918 mlosch 1.138 LOGICAL useGCHEM
919 stephd 1.172 LOGICAL useRBCS
920 jmc 1.181 LOGICAL useOffLine
921 jmc 1.183 LOGICAL useMATRIX
922 heimbach 1.80 LOGICAL useSEAICE
923 jmc 1.220 LOGICAL useSALT_PLUME
924 mlosch 1.176 LOGICAL useShelfIce
925 dimitri 1.235 LOGICAL useICEFRONT
926 jmc 1.183 LOGICAL useThSIce
927 jscott 1.190 LOGICAL useATM2d
928 jmc 1.220 LOGICAL useAIM
929     LOGICAL useLand
930     LOGICAL useFizhi
931     LOGICAL useGridAlt
932 jmc 1.179 LOGICAL useDiagnostics
933 jmc 1.220 LOGICAL useREGRID
934 rpa 1.228 LOGICAL useLayers
935 edhill 1.130 LOGICAL useMNC
936 adcroft 1.158 LOGICAL useRunClock
937 edhill 1.175 LOGICAL useEMBED_FILES
938 heimbach 1.187 LOGICAL useMYPACKAGE
939 adcroft 1.44 COMMON /PARM_PACKAGES/
940 jmc 1.220 & useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,
941 jmc 1.183 & useOPPS, usePP81, useMY82, useGGL90, useKPP,
942 jmc 1.220 & useGMRedi, useDOWN_SLOPE,
943     & useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
944 jmc 1.231 & useGrdchk, useSMOOTH, useECCO, useSBO, useFLT,
945 jmc 1.183 & usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
946 dimitri 1.235 & useSEAICE, useSALT_PLUME, useShelfIce,
947     & useICEFRONT, useThSIce,
948 jmc 1.220 & useATM2D, useAIM, useLand, useFizhi, useGridAlt,
949 rpa 1.228 & useDiagnostics, useREGRID, useLayers, useMNC,
950 jmc 1.220 & useRunClock, useEMBED_FILES,
951 jmc 1.219 & useMYPACKAGE
952 edhill 1.105 CEH3 ;;; Local Variables: ***
953     CEH3 ;;; mode:fortran ***
954     CEH3 ;;; End: ***

  ViewVC Help
Powered by ViewVC 1.1.22