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

Legend:
Removed from v.1.79  
changed lines
  Added in v.1.179

  ViewVC Help
Powered by ViewVC 1.1.22