/[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.244 - (hide annotations) (download)
Wed Nov 17 21:15:08 2010 UTC (13 years, 6 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint62o
Changes since 1.243: +4 -2 lines
File MIME type: text/plain
add description of debugMode (+update debugLevel):
 debugMode  :: controls printing of debug messages (sequence of S/R calls).
 debugLevel :: controls printing of algorithm intermediate results and stats.

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

  ViewVC Help
Powered by ViewVC 1.1.22