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