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