/[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.235 - (hide annotations) (download)
Wed Jan 20 23:33:45 2010 UTC (14 years, 4 months ago) by dimitri
Branch: MAIN
CVS Tags: checkpoint62b
Changes since 1.234: +4 -2 lines
File MIME type: text/plain
Adding the shell of, and the hooks to, a new package that will be
used to model melting and freezing of vertical glacier ice fronts:
 Modified Files:
 	doc/tag-index model/inc/PARAMS.h model/src/do_oceanic_phys.F
 	model/src/external_forcing.F model/src/packages_boot.F
 	model/src/packages_check.F model/src/packages_init_fixed.F
 	model/src/packages_init_variables.F
 	model/src/packages_readparms.F
 Added Files:
 	pkg/icefront/ICEFRONT.h pkg/icefront/ICEFRONT_OPTIONS.h
 	pkg/icefront/icefront_check.F
 	pkg/icefront/icefront_description.tex
 	pkg/icefront/icefront_diagnostics_init.F
 	pkg/icefront/icefront_init_fixed.F
 	pkg/icefront/icefront_init_varia.F
 	pkg/icefront/icefront_readparms.F
 	pkg/icefront/icefront_tendency_apply.F
 	pkg/icefront/icefront_thermodynamics.F

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

  ViewVC Help
Powered by ViewVC 1.1.22