/[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.59 by adcroft, Fri Aug 17 18:40:30 2001 UTC revision 1.177 by mlosch, Fri Feb 10 07:50:37 2006 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  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 21  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
# Line 44  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     topoFile    - File containing the topography of the surface (unit=m)  C     topoFile    :: File containing the topography of the surface (unit=m)
59  C                   (mainly used for the atmosphere = ground height).  C                   (mainly used for the atmosphere = ground height).
60  C     hydrogThetaFile - File containing initial hydrographic data for potential  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     surfQswfile     - File containing surface shortwave radiation  C                        (old version, kept for backward compatibility)
73  C     dQdTfile        - File containing thermal relaxation coefficient  C     surfQnetFile    :: File containing surface net heat flux
74  C     EmPmRfile       - File containing surface fresh water flux  C     surfQswFile     :: File containing surface shortwave radiation
75  C     buoyancyRelation - Flag used to indicate which relation to use to  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, topoFile,       &                delXFile, delYFile, horizGridFile,
88         &                bathyFile, topoFile, shelfIceFile,
89       &                hydrogThetaFile, hydrogSaltFile,       &                hydrogThetaFile, hydrogSaltFile,
90       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
91       &                saltClimFile, buoyancyRelation,       &                saltClimFile, buoyancyRelation,
92       &                EmPmRfile, surfQfile, surfQswfile,       &                EmPmRfile, saltFluxFile,
93         &                surfQfile, surfQnetFile, surfQswFile,
94         &                lambdaThetaFile, lambdaSaltFile,
95       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
96       &                dQdTfile       &                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, topoFile        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 81  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) surfQswfile        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        CHARACTER*(MAX_LEN_FNAM) uVelInitFile
119        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
120        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
121        CHARACTER*(MAX_LEN_FNAM) dQdTfile        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     nonlinFreeSurf      - option related to non-linear free surface  C     nonlinFreeSurf      :: option related to non-linear free surface
152  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
153    C     select_rStar        :: option related to r* vertical coordinate
154    C                           =0 (default) use r coord. ; > 0 use r*
155    C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
156    C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
157    C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
158    C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector
159    C     selectKEscheme      :: Kinetic Energy scheme selector (Vector Inv.)
160    C     debugLevel          :: debug level selector: higher -> more writing
161    
162        COMMON /PARM_I/        COMMON /PARM_I/
163       &        cg2dMaxIters,       &        cg2dMaxIters,
164       &        cg2dChkResFreq,       &        cg2dChkResFreq, cg2dPreCondFreq,
165       &        cg3dMaxIters,       &        cg3dMaxIters,
166       &        cg3dChkResFreq,       &        cg3dChkResFreq,
167       &        nIter0, nTimeSteps, nEndIter,       &        nIter0, nTimeSteps, nEndIter,
168       &        numStepsPerPickup,       &        numStepsPerPickup,
169       &        writeStatePrec, nCheckLev,       &        writeStatePrec, nCheckLev,
170       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
171       &        nonlinFreeSurf,       &        nonlinFreeSurf, select_rStar,
172       &        zonal_filt_sinpow, zonal_filt_cospow,       &        tempAdvScheme, tempVertAdvScheme,
173       &        tempAdvScheme, saltAdvScheme, tracerAdvScheme       &        saltAdvScheme, saltVertAdvScheme,
174         &        selectKEscheme,
175         &        debugLevel
176        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
177        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
178          INTEGER cg2dPreCondFreq
179        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
180        INTEGER cg3dChkResFreq        INTEGER cg3dChkResFreq
181        INTEGER nIter0        INTEGER nIter0
# Line 134  C                           =0 Linear fr Line 187  C                           =0 Linear fr
187        INTEGER readBinaryPrec        INTEGER readBinaryPrec
188        INTEGER nCheckLev        INTEGER nCheckLev
189        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
190        INTEGER zonal_filt_sinpow        INTEGER select_rStar
191        INTEGER zonal_filt_cospow        INTEGER tempAdvScheme, tempVertAdvScheme
192        INTEGER tempAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
193        INTEGER saltAdvScheme        INTEGER selectKEscheme
194        INTEGER tracerAdvScheme        INTEGER debugLevel
195    
196    C
197          INTEGER debLevZero
198          PARAMETER(debLevZero=0)
199          INTEGER debLevA
200          PARAMETER(debLevA=1)
201          INTEGER debLevB
202          PARAMETER(debLevB=2)
203    
204  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
205  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
206  C                          coordinate frame.  C                          coordinate frame.
207  C     usingSphericalPolarGrid - If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
208  C                               spherical polar frame.  C                               spherical polar frame.
209  C     no_slip_sides - Impose "no-slip" at lateral boundaries.  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
210  C     no_slip_bottom- Impose "no-slip" at bottom boundary.  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.
211  C     staggerTimeStep - enable a Stagger time stepping T,S Rho then U,V  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
212  C     momViscosity  - Flag which turns momentum friction terms on and off.  C     momViscosity  :: Flag which turns momentum friction terms on and off.
213  C     momAdvection  - Flag which turns advection of momentum on and off.  C     momAdvection  :: Flag which turns advection of momentum on and off.
214  C     momForcing    - Flag which turns external forcing of momentum on  C     momForcing    :: Flag which turns external forcing of momentum on
215  C                     and off.  C                     and off.
216  C     momPressureForcing - Flag which turns pressure term in momentum equation  C     momPressureForcing :: Flag which turns pressure term in momentum equation
217  C                          on and off.  C                          on and off.
218  C     metricTerms   - Flag which turns metric terms on or off.  C     metricTerms   :: Flag which turns metric terms on or off.
219  C     usingSphericalPolarMTerms - If TRUE use spherical polar metric terms.  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
220  C     useCoriolis   - Flag which turns the coriolis terms on and off.  C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.
221  C     tempDiffusion - Flag which turns diffusion of temperature on  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
222    C     tempAdvection :: Flag which turns advection of temperature on
223  C                     and off.  C                     and off.
224  C     tempAdvection - Flag which turns advection of temperature on  C     tempForcing   :: Flag which turns external forcing of temperature on
225  C                     and off.  C                     and off.
226  C     tempForcing   - Flag which turns external forcing of temperature on  C     saltAdvection :: Flag which turns advection of salinity on
227  C                     and off.  C                     and off.
228  C     saltDiffusion - Flag which turns diffusion of salinit on  C     saltForcing   :: Flag which turns external forcing of salinity on
229  C                     and off.  C                     and off.
230  C     saltAdvection - Flag which turns advection of salinit on  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
231  C                     and off.  C                         as a real Fresh Water (=> changes the Sea Level)
232  C     saltForcing   - Flag which turns external forcing of salinit on  C                         if F, converts P+R-E to salt flux (no SL effect)
233  C                     and off.  C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable
234  C     rigidLid            - Set to true to use rigid lid  C                       on irregular grids)
235  C     implicitFreeSurface - Set to true to use implcit free surface  C     useAreaViscLength :: Set to true to use old scaling for viscous
236  C     exactConserv        - Set to true to conserve exactly the total Volume  C              lengths, e.g., L2=Raz.  May be preferable for cube sphere.
237  C     uniformLin_PhiSurf  - Set to true to use a uniform Bo_surf in the  C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
238    C     rigidLid            :: Set to true to use rigid lid
239    C     implicitFreeSurface :: Set to true to use implicit free surface
240    C     exactConserv        :: Set to true to conserve exactly the total Volume
241    C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
242  C                           linear relation Phi_surf = Bo_surf*eta  C                           linear relation Phi_surf = Bo_surf*eta
243  C     momStepping   - Turns momentum equation time-stepping off  C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
244  C     tempStepping  - Turns temperature equation time-stepping off  C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
245  C     saltStepping  - Turns salinity equation time-stepping off  C     momStepping   :: Turns momentum equation time-stepping off
246  C     tr1Stepping   - Turns passive tracer 1 time-stepping on/off  C     tempStepping  :: Turns temperature equation time-stepping off
247  C     useConstantF  - Coriolis parameter set to f0  C     saltStepping  :: Turns salinity equation time-stepping off
248  C     useBetaPlaneF - Coriolis parameter set to f0 + beta.y  C     useConstantF  :: Coriolis parameter set to f0
249  C     useSphereF    - Coriolis parameter set to 2.omega.sin(phi)  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
250  C     implicitDiffusion - Turns implicit vertical diffusion on  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
251  C     implicitViscosity - Turns implicit vertical viscosity on  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
252  C     doThetaClimRelax - Set true if relaxation to temperature  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
253    C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
254    C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny
255    C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
256    C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
257    C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
258    C     useAbsVorticity :: work with f+zeta in Coriolis terms
259    C     implicitDiffusion :: Turns implicit vertical diffusion on
260    C     implicitViscosity :: Turns implicit vertical viscosity on
261    C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
262    C     saltImplVertAdv :: Turns on implicit vertical advection for Salinity
263    C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
264    C     multiDimAdvection :: Flag that enable multi-dimension advection
265    C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
266    C     forcing_In_AB     :: if False, put forcing (Temp,Salt,Tracers) contribution
267    C                          out off Adams-Bashforth time stepping.
268    C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always
269    C                          apply AB on tracer tendencies (rather than on Tracer)
270    C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
271    C     doThetaClimRelax :: Set true if relaxation to temperature
272  C                        climatology is required.  C                        climatology is required.
273  C     doSaltClimRelax  - Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
274  C                        climatology is required.  C                        climatology is required.
275  C     periodicExternalForcing - Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
276  C     usingPCoords     - Set to indicate that we are working in pressure  C     usingPCoords     :: Set to indicate that we are working in a pressure
277  C                        coords.  C                        type coordinate (p or p*).
278  C     usingZCoords     - Set to indicate that we are working in height  C     usingZCoords     :: Set to indicate that we are working in a height
279  C                        coords.  C                        type coordinate (z or z*)
280  C     nonHydrostatic - Using non-hydrostatic terms  C     fluidIsAir       :: Set to indicate that the fluid major constituent
281  C     globalFiles    - Selects between "global" and "tiled" files  C                        is air
282  C     allowFreezing  - Allows water to freeze and form ice  C     fluidIsWater     :: Set to indicate that the fluid major constituent
283  C     groundAtK1  - put the surface(k=1) at the Lower Boundary (=ground)  C                        is water
284    C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
285    C                         this requires specific code for restart & exchange
286    C     setCenterDr    :: set cell Center depth and put Interface at the middle
287    C     nonHydrostatic :: Using non-hydrostatic terms
288    C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
289    C     globalFiles    :: Selects between "global" and "tiled" files
290    C     useSingleCpuIO :: On SGI platforms, option globalFiles is either
291    C                       slow (f77) or does not work (f90).  When
292    C                       useSingleCpuIO is set, mdsio_writefield.F
293    C                       outputs from master mpi process only.
294    C     allowFreezing  :: Allows surface water to freeze and form ice
295    C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
296    C     pickup_write_mdsio :: use mdsio to write pickups
297    C     pickup_read_mdsio  :: use mdsio to read  pickups
298    C     pickup_write_immed :: echo the pickup immediately (for conversion)
299    C     timeave_mdsio      :: use mdsio for timeave output
300    C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
301    C     monitor_stdio      :: use stdio for monitor output
302    C     calendarDumps :: When set, approximate months (30-31 days) and years (360-372 days)
303    C                      for parameters chkPtFreq, pChkPtFreq, taveFreq, SEAICE_taveFreq,
304    C                      KPP_taveFreq, and freq in pkg/diagnostics are converted to exact
305    C                      calendar months and years.  Requires pkg/cal.
306    C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
307    C                        & Last iteration, in addition multiple of dumpFreq iter.
308    C     balanceEmPmR    :: substract global mean of EmPmR at every time step
309    C     balanceQnet     :: substract global mean of Qnet at every time step
310    C     balancePrintMean:: print substracted global means to STDOUT
311    
312        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
313       & usingCurvilinearGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
314       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
      & staggerTimeStep,  
315       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
316       & momPressureForcing, vectorInvariantMomentum,       & momPressureForcing, vectorInvariantMomentum,
317       & tempDiffusion, tempAdvection, tempForcing,       & tempAdvection, tempForcing,
318       & saltDiffusion, saltAdvection, saltForcing,       & saltAdvection, saltForcing,
319         & useRealFreshWaterFlux,
320         & useFullLeith, useStrainTensionVisc,
321         & useAreaViscLength,
322       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
323       & momStepping, tempStepping, saltStepping, tr1Stepping,       & implicitIntGravWave, staggerTimeStep,
324       & metricTerms, usingSphericalPolarMTerms,       & momStepping, tempStepping, saltStepping,
325         & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
326       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
327         & useCDscheme,
328         & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
329         & SadournyCoriolis, upwindVorticity, highOrderVorticity,
330         & useAbsVorticity, upwindShear,
331       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
332         & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
333         & multiDimAdvection, useMultiDimAdvec,
334         & forcing_In_AB, doAB_onGtGs,
335       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
336       & periodicExternalForcing, usingPCoords, usingZCoords,       & periodicExternalForcing,
337       & nonHydrostatic, globalFiles,       & fluidIsAir, fluidIsWater,
338       & allowFreezing, groundAtK1,       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
339       & usePickupBeforeC35, debugMode,       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
340       & readPickupWithTracer, writePickupWithTracer       & allowFreezing, useOldFreezing,
341         & usePickupBeforeC35, usePickupBeforeC54, startFromPickupAB2,
342         & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
343         & timeave_mdsio, snapshot_mdsio, monitor_stdio,
344         & outputTypesInclusive, dumpInitAndLast, debugMode,
345         & inAdMode, inAdTrue, inAdFalse, inAdExact,
346         & calendarDumps,
347         & balanceEmPmR, balanceQnet, balancePrintMean
348    
349        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
350        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
351          LOGICAL usingCylindricalGrid
352        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
353        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
354          LOGICAL useNHMTerms
355        LOGICAL no_slip_sides        LOGICAL no_slip_sides
356        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
       LOGICAL staggerTimeStep  
357        LOGICAL momViscosity        LOGICAL momViscosity
358        LOGICAL momAdvection        LOGICAL momAdvection
359        LOGICAL momForcing        LOGICAL momForcing
360        LOGICAL momPressureForcing        LOGICAL momPressureForcing
361        LOGICAL useCoriolis        LOGICAL useCoriolis
362        LOGICAL vectorInvariantMomentum        LOGICAL vectorInvariantMomentum
       LOGICAL tempDiffusion  
363        LOGICAL tempAdvection        LOGICAL tempAdvection
364        LOGICAL tempForcing        LOGICAL tempForcing
       LOGICAL saltDiffusion  
365        LOGICAL saltAdvection        LOGICAL saltAdvection
366        LOGICAL saltForcing        LOGICAL saltForcing
367          LOGICAL useRealFreshWaterFlux
368          LOGICAL useFullLeith
369          LOGICAL useStrainTensionVisc
370          LOGICAL useAreaViscLength
371        LOGICAL rigidLid        LOGICAL rigidLid
372        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
373        LOGICAL exactConserv        LOGICAL exactConserv
374        LOGICAL uniformLin_PhiSurf        LOGICAL uniformLin_PhiSurf
375          LOGICAL implicitIntGravWave
376          LOGICAL staggerTimeStep
377        LOGICAL momStepping        LOGICAL momStepping
378        LOGICAL tempStepping        LOGICAL tempStepping
379        LOGICAL saltStepping        LOGICAL saltStepping
       LOGICAL tr1Stepping  
380        LOGICAL metricTerms        LOGICAL metricTerms
381        LOGICAL useConstantF        LOGICAL useConstantF
382        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
383        LOGICAL useSphereF        LOGICAL useSphereF
384          LOGICAL useCDscheme
385          LOGICAL useEnergyConservingCoriolis
386          LOGICAL useJamartWetPoints
387          LOGICAL useJamartMomAdv
388          LOGICAL SadournyCoriolis
389          LOGICAL upwindVorticity
390          LOGICAL highOrderVorticity
391          LOGICAL useAbsVorticity
392          LOGICAL upwindShear
393        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
394        LOGICAL implicitViscosity        LOGICAL implicitViscosity
395          LOGICAL tempImplVertAdv
396          LOGICAL saltImplVertAdv
397          LOGICAL momImplVertAdv
398          LOGICAL multiDimAdvection
399          LOGICAL useMultiDimAdvec
400          LOGICAL forcing_In_AB
401          LOGICAL doAB_onGtGs
402        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
403        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
404        LOGICAL doTr1ClimRelax        LOGICAL doTr1ClimRelax
405        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
406          LOGICAL fluidIsAir
407          LOGICAL fluidIsWater
408        LOGICAL usingPCoords        LOGICAL usingPCoords
409        LOGICAL usingZCoords        LOGICAL usingZCoords
410          LOGICAL useDynP_inEos_Zc
411          LOGICAL setCenterDr
412        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
413          LOGICAL quasiHydrostatic
414        LOGICAL globalFiles        LOGICAL globalFiles
415          LOGICAL useSingleCpuIO
416        LOGICAL allowFreezing        LOGICAL allowFreezing
417        LOGICAL groundAtK1        LOGICAL useOldFreezing
418        LOGICAL usePickupBeforeC35        LOGICAL usePickupBeforeC35
419          LOGICAL usePickupBeforeC54
420          LOGICAL startFromPickupAB2
421          LOGICAL dumpInitAndLast
422        LOGICAL debugMode        LOGICAL debugMode
423        LOGICAL readPickupWithTracer        LOGICAL pickup_read_mdsio, pickup_write_mdsio
424        LOGICAL writePickupWithTracer        LOGICAL pickup_write_immed
425          LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
426          LOGICAL outputTypesInclusive
427          LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
428          LOGICAL calendarDumps
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     gg2dTargetResidual  C     cg2dTargetResidual
436  C          - Target residual for cg2d solver; no unit (RHS normalisation)  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
437  C     cg2dTargetResWunit  C     cg2dTargetResWunit
438  C          - Target residual for cg2d solver; W unit (No RHS normalisation)  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 284  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     implicSurfPress - parameter of the Crank-Nickelson time stepping :  C     abEps        :: Adams-Bashforth-2 stabilizing weight
552    C     alph_AB      :: Adams-Bashforth-3 primary factor
553    C     beta_AB      :: Adams-Bashforth-3 secondary factor
554    C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
555  C                     Implicit part of Surface Pressure Gradient ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
556  C     implicDiv2Dflow - parameter of the Crank-Nickelson time stepping :  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
557  C                     Implicit part of barotropic flow Divergence ( 0-1 )  C                     Implicit part of barotropic flow Divergence ( 0-1 )
558  C     hFacMin      - Minimum fraction size of a cell (affects hFacC etc...)  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
559  C     hFacMinDz    - Minimum dimesional size of a cell (affects hFacC etc..., m)  C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)
560  C     hFacMinDp    - Minimum dimesional size of a cell (affects hFacC etc..., Pa)  C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
561  C     hFacMinDr    - Minimum dimesional size of a cell (affects hFacC etc..., units of r)  C     hFacMinDr    :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
562  C     hFacInf      - Threshold (inf and sup) for fraction size of surface cell  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
563  C     hFacSup        that control vanishing and creating levels  C     hFacSup        that control vanishing and creating levels
564  C     tauCD        - CD scheme coupling timescale ( 1/s )  C     tauCD        :: CD scheme coupling timescale ( 1/s )
565  C     rCD          - CD scheme normalised coupling parameter ( 0-1 )  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )
566  C     startTime     - Starting time for this integration ( s ).  C     baseTime      :: model base time (time origin) = time @ iteration zero
567  C     endTime       - Ending time for this integration ( s ).  C     startTime     :: Starting time for this integration ( s ).
568  C     chkPtFreq     - Frequency of rolling check pointing ( s ).  C     endTime       :: Ending time for this integration ( s ).
569  C     pChkPtFreq    - Frequency of permanent check pointing ( s ).  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
570  C     dumpFreq      - Frequency with which model state is written to  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     diagFreq      - Frequency with which model writes diagnostic output  C     diagFreq      :: Frequency with which model writes diagnostic output
574  C                     of intermediate quantities.  C                     of intermediate quantities.
575  C     afFacMom      - Advection of momentum term tracer parameter  C     afFacMom      :: Advection of momentum term tracer parameter
576  C     vfFacMom      - Momentum viscosity tracer parameter  C     vfFacMom      :: Momentum viscosity tracer parameter
577  C     pfFacMom      - Momentum pressure forcing tracer parameter  C     pfFacMom      :: Momentum pressure forcing tracer parameter
578  C     cfFacMom      - Coriolis term tracer parameter  C     cfFacMom      :: Coriolis term tracer parameter
579  C     foFacMom      - Momentum forcing tracer parameter  C     foFacMom      :: Momentum forcing tracer parameter
580  C     mtFacMom      - Metric terms tracer parameter  C     mtFacMom      :: Metric terms tracer parameter
581  C     cosPower      - Power of cosine of latitude to multiply viscosity  C     cosPower      :: Power of cosine of latitude to multiply viscosity
582  C     cAdjFreq      - Frequency of convective adjustment  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
 C                          circles ( see filter*.F )  
 C     Ro_SeaLevel        - standard position of Sea-Level in "R" coordinate, used as  
608  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
609  C     bottomDragLinear   - Drag coefficient built in to core dynamics  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
610  C         "     Quadratic  ( linear: 1/s, quadratic: 1/m )  C                           (default=2: full drag ; =1: gives half-slip BC)
611    C     bottomDragLinear   :: Drag coefficient built in to core dynamics
612    C     bottomDragQuadratic   ( linear: 1/s, quadratic: 1/m )
613    C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales
614    C                      (i.e. allows convection at different Rayleigh numbers)
615        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
616       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
617       & delP, delZ, delR, delX, delY,       & delR, delRc, delX, delY,
618       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
619         & abEps, alph_AB, beta_AB,
620       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
621       & fCori, fCoriG,       & viscAh, viscAhW, viscAhMax,
622       & viscAh,  viscAz,  viscA4,  viscAr,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
623       & diffKhT, diffKzT, diffK4T, diffKrT,       & viscC2leith, viscC2leithD,
624       & diffKhS, diffKzS, diffK4S, diffKrS,       & 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,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
634       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
635       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
636       & recip_rhoConst, rhoConst, tRef, sRef,       & recip_rhoConst, rhoConst,
637       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,       & rhoConstFresh, convertEmP2rUnit, tRef, sRef, phiRef, dBdrRef,
638       & diagFreq, taveFreq, monitorFreq,       & 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, cAdjFreq, omega,       & cosPower, cAdjFreq, omega, rotationPeriod,
643       & tauThetaClimRelax, lambdaThetaClimRelax,       & tauThetaClimRelax, tauThetaClimRelax3Dim,
644       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, tauSaltClimRelax3Dim,
645       & tauTr1ClimRelax, lambdaTr1ClimRelax,       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
646       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
647       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
648       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,       & hFacMinDr, hFacMinDp,
649       & latFFTFiltLo, ivdc_kappa, Ro_SeaLevel, zonal_filt_lat,       & horiVertRatio, recip_horiVertRatio,
650       & bottomDragLinear,bottomDragQuadratic       & ivdc_kappa, Ro_SeaLevel,
651         & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
652         & tCylIn, tCylOut
653    
654        _RL cg2dTargetResidual        _RL cg2dTargetResidual
655        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
656        _RL cg3dTargetResidual        _RL cg3dTargetResidual
657        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
       _RL delZ(Nr)  
       _RL delP(Nr)  
658        _RL delR(Nr)        _RL delR(Nr)
659          _RL delRc(Nr+1)
660        _RL delX(Nx)        _RL delX(Nx)
661        _RL delY(Ny)        _RL delY(Ny)
662        _RL deltaT        _RL deltaT
663        _RL deltaTClock        _RL deltaTClock
664        _RL deltaTmom        _RL deltaTmom
665        _RL deltaTtracer        _RL dTtracerLev(Nr)
666        _RL abeps        _RL deltaTfreesurf
667          _RL abEps, alph_AB, beta_AB
668        _RL phiMin        _RL phiMin
669        _RL thetaMin        _RL thetaMin
670        _RL rSphere        _RL rSphere
# Line 451  C         "     Quadratic  ( linear: 1/s Line 681  C         "     Quadratic  ( linear: 1/s
681        _RL hFacSup        _RL hFacSup
682        _RL beta        _RL beta
683        _RL viscAh        _RL viscAh
684        _RL viscAz        _RL viscAhW
685        _RL viscAp        _RL viscAhD
686          _RL viscAhZ
687          _RL viscAhMax
688          _RL viscAhReMax
689          _RL viscAhGrid
690          _RL viscAhGridMax
691          _RL viscAhGridMin
692          _RL viscC2leith
693          _RL viscC2leithD
694          _RL viscC2smag
695          _RL viscC4smag
696        _RL viscAr        _RL viscAr
697        _RL viscA4        _RL viscA4
698          _RL viscA4W
699          _RL viscA4D
700          _RL viscA4Z
701          _RL viscA4Max
702          _RL viscA4ReMax
703          _RL viscA4Grid, viscA4GridMax, viscA4GridMin
704          _RL viscC4leith
705          _RL viscC4leithD
706        _RL diffKhT        _RL diffKhT
707        _RL diffKrT        _RL diffKrNrT(Nr)
       _RL diffKzT  
       _RL diffKpT  
708        _RL diffK4T        _RL diffK4T
709        _RL diffKhS        _RL diffKhS
710        _RL diffKrS        _RL diffKrNrS(Nr)
       _RL diffKzS  
       _RL diffKpS  
711        _RL diffK4S        _RL diffK4S
712          _RL diffKrBL79surf
713          _RL diffKrBL79deep
714          _RL diffKrBL79scl
715          _RL diffKrBL79Ho
716        _RL delt        _RL delt
717        _RL tauCD        _RL tauCD
718        _RL rCD        _RL rCD
# Line 475  C         "     Quadratic  ( linear: 1/s Line 723  C         "     Quadratic  ( linear: 1/s
723        _RL recip_rhonil        _RL recip_rhonil
724        _RL rhoConst        _RL rhoConst
725        _RL recip_rhoConst        _RL recip_rhoConst
726        _RL specVol_S(Nr)        _RL rhoConstFresh
727          _RL convertEmP2rUnit
728        _RL tRef(Nr)        _RL tRef(Nr)
       _RL theta_S(Nr)  
729        _RL sRef(Nr)        _RL sRef(Nr)
730        _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL phiRef(2*Nr+1)
731        _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL dBdrRef(Nr)
732          _RL baseTime
733        _RL startTime        _RL startTime
734        _RL endTime        _RL endTime
735        _RL chkPtFreq        _RL chkPtFreq
736        _RL pChkPtFreq        _RL pChkPtFreq
737        _RL dumpFreq        _RL dumpFreq
738          _RL adjDumpFreq
739        _RL diagFreq        _RL diagFreq
740        _RL taveFreq        _RL taveFreq
741          _RL tave_lastIter
742        _RL monitorFreq        _RL monitorFreq
743          _RL adjMonitorFreq
744        _RL afFacMom        _RL afFacMom
745        _RL vfFacMom        _RL vfFacMom
746        _RL pfFacMom        _RL pfFacMom
# Line 498  C         "     Quadratic  ( linear: 1/s Line 750  C         "     Quadratic  ( linear: 1/s
750        _RL cosPower        _RL cosPower
751        _RL cAdjFreq        _RL cAdjFreq
752        _RL omega        _RL omega
753          _RL rotationPeriod
754        _RL tauThetaClimRelax        _RL tauThetaClimRelax
       _RL lambdaThetaClimRelax  
755        _RL tauSaltClimRelax        _RL tauSaltClimRelax
756        _RL lambdaSaltClimRelax        _RL tauThetaClimRelax3Dim
757          _RL tauSaltClimRelax3Dim
758        _RL tauTr1ClimRelax        _RL tauTr1ClimRelax
759        _RL lambdaTr1ClimRelax        _RL lambdaTr1ClimRelax
760          _RL latBandClimRelax
761        _RL externForcingCycle        _RL externForcingCycle
762        _RL externForcingPeriod        _RL externForcingPeriod
763          _RL convertFW2Salt
764          _RL temp_EvPrRn
765          _RL salt_EvPrRn
766        _RL horiVertRatio        _RL horiVertRatio
767        _RL recip_horiVertRatio        _RL recip_horiVertRatio
       _RL latFFTFiltLo  
768        _RL ivdc_kappa        _RL ivdc_kappa
769        _RL Ro_SeaLevel        _RL Ro_SeaLevel
770        _RL zonal_filt_lat        _RL sideDragFactor
771        _RL bottomDragLinear        _RL bottomDragLinear
772        _RL bottomDragQuadratic        _RL bottomDragQuadratic
773          _RL nh_Am2
774          _RL tCylIn
775          _RL tCylOut
776    
777        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,  C--   COMMON /PARM_A/ Thermodynamics constants ?
778       &                Lamba_theta        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
779        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
       _RL Lamba_theta  
780        _RL recip_Cp        _RL recip_Cp
781    
782  C Equation of State (polynomial coeffients)  C--   COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
783        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS  C     celsius2K :: convert centigrade (Celsius) degree to Kelvin
784        _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)  C     atm_Po    :: standard reference pressure
785  C Linear equation of state  C     atm_Cp    :: specific heat (Cp) of the (dry) air at constant pressure
786  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  C     atm_Rd    :: gas constant for dry air
787  C     sBeta     - Linear EOS haline contraction coefficient.  C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
788        COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air
789        _RL tAlpha  C                  (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
790        _RL sBeta  C     integr_GeoPot :: option to select the way we integrate the geopotential
       character*(6) eosType  
   
 C Atmospheric physical parameters (Ideal Gas EOS, ...)  
 C     atm_po    - standard reference pressure  
 C     atm_cp    - specific heat (Cp) of the (dry) air at constant pressure  
 C     atm_kappa - kappa = R/Cp (R: constant of Ideal Gas EOS)  
 C     Integr_GeoPot - option to select the way we integrate the geopotential  
791  C                     (still a subject of discussions ...)  C                     (still a subject of discussions ...)
792        COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po,  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
793       &                  Integr_GeoPot  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
794        _RL atm_cp, atm_kappa, atm_po        COMMON /PARM_ATM/
795        INTEGER Integr_GeoPot       &            celsius2K,
796         &            atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
797         &            integr_GeoPot, selectFindRoSurf
798          _RL celsius2K
799          _RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq
800          INTEGER integr_GeoPot, selectFindRoSurf
801    
802  C Logical flags for selecting packages  C Logical flags for selecting packages
803          LOGICAL useOPPS
804          LOGICAL usePP81
805          LOGICAL useMY82
806          LOGICAL useGGL90
807        LOGICAL useKPP        LOGICAL useKPP
808        LOGICAL useGMRedi        LOGICAL useGMRedi
809        LOGICAL useOBCS        LOGICAL useOBCS
810        LOGICAL useAIM        LOGICAL useAIM
811          LOGICAL useLand
812        LOGICAL useGrdchk        LOGICAL useGrdchk
813        LOGICAL useECCO        LOGICAL useECCO
814        LOGICAL useSHAP_FILT        LOGICAL useSHAP_FILT
815          LOGICAL useZONAL_FILT
816          LOGICAL useFLT
817          LOGICAL usePTRACERS
818          LOGICAL useGCHEM
819          LOGICAL useRBCS
820          LOGICAL useSBO
821          LOGICAL useSEAICE
822          LOGICAL useShelfIce
823          LOGICAL useBulkForce
824          LOGICAL useThSIce
825          LOGICAL usefizhi
826          LOGICAL usegridalt
827          LOGICAL usediagnostics
828          LOGICAL useEBM
829          LOGICAL useMNC
830          LOGICAL useMATRIX
831          LOGICAL useRunClock
832          LOGICAL useEMBED_FILES
833        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
834       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
835       &        useSHAP_FILT, useGrdchk       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
836         &        usePTRACERS, useGCHEM, useRBCS,
837         &        useSBO, useSEAICE, useShelfIce, useThSIce, useBulkForce,
838         &        usefizhi, usegridalt, usediagnostics, useEBM, useMNC,
839         &        usePP81, useMY82, useOPPS, useGGL90, useMATRIX,
840         &        useRunClock, useEMBED_FILES
841    
842    CEH3 ;;; Local Variables: ***
843    CEH3 ;;; mode:fortran ***
844    CEH3 ;;; End: ***

Legend:
Removed from v.1.59  
changed lines
  Added in v.1.177

  ViewVC Help
Powered by ViewVC 1.1.22