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

Legend:
Removed from v.1.69  
changed lines
  Added in v.1.195

  ViewVC Help
Powered by ViewVC 1.1.22