/[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.256 - (hide annotations) (download)
Mon Dec 12 18:58:51 2011 UTC (12 years, 5 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint63g, checkpoint63h
Changes since 1.255: +3 -5 lines
File MIME type: text/plain
move delX,delY to new header file (SET_GRID.h) and adjust length to 1rst
face dimensions.

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

  ViewVC Help
Powered by ViewVC 1.1.22