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

Legend:
Removed from v.1.67  
changed lines
  Added in v.1.198

  ViewVC Help
Powered by ViewVC 1.1.22