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