/[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.278 - (hide annotations) (download)
Sat Jan 3 23:53:50 2015 UTC (9 years, 3 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint65j, checkpoint65i
Changes since 1.277: +19 -8 lines
File MIME type: text/plain
add run-time parameters to select bottom-drag options

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

  ViewVC Help
Powered by ViewVC 1.1.22