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

Legend:
Removed from v.1.10  
changed lines
  Added in v.1.212

  ViewVC Help
Powered by ViewVC 1.1.22