/[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.276 - (hide annotations) (download)
Thu Aug 7 18:43:33 2014 UTC (9 years, 9 months ago) by heimbach
Branch: MAIN
CVS Tags: checkpoint65b, checkpoint65c, checkpoint65f, checkpoint65d, checkpoint65e
Changes since 1.275: +3 -2 lines
File MIME type: text/plain
Add geothermal flux forcing

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

  ViewVC Help
Powered by ViewVC 1.1.22