/[MITgcm]/MITgcm/model/inc/PARAMS.h
ViewVC logotype

Diff of /MITgcm/model/inc/PARAMS.h

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

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

Legend:
Removed from v.1.5  
changed lines
  Added in v.1.236

  ViewVC Help
Powered by ViewVC 1.1.22