/[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.268 - (hide annotations) (download)
Mon Apr 22 02:32:47 2013 UTC (11 years ago) by jmc
Branch: MAIN
CVS Tags: checkpoint64g
Changes since 1.267: +2 -4 lines
File MIME type: text/plain
remove unused forcing field "dQdT" and associated parameter "dQdTFile"

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

  ViewVC Help
Powered by ViewVC 1.1.22