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

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.266

  ViewVC Help
Powered by ViewVC 1.1.22