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