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

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

  ViewVC Help
Powered by ViewVC 1.1.22