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