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