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

Legend:
Removed from v.1.2  
changed lines
  Added in v.1.264

  ViewVC Help
Powered by ViewVC 1.1.22