/[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.275 - (hide annotations) (download)
Wed Jul 30 03:30:18 2014 UTC (9 years, 9 months ago) by jmc
Branch: MAIN
Changes since 1.274: +3 -2 lines
File MIME type: text/plain
-  add new pkg "kl10" for mixing due to internal wave breaking
  ( http://www.sciencedirect.com/science/article/pii/S1463500310000144 )

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

  ViewVC Help
Powered by ViewVC 1.1.22