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