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