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

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.286

  ViewVC Help
Powered by ViewVC 1.1.22