/[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.6 by adcroft, Wed May 20 21:29:31 1998 UTC revision 1.117 by jmc, Tue Jul 6 00:51:35 2004 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2    C $Name$
3  C  C
4  C     /==========================================================\  CBOP
5  C     | PARAMS.h                                                 |  C    !ROUTINE: PARAMS.h
6  C     | o Header file defining model "parameters".               |  C    !INTERFACE:
7  C     |==========================================================|  C    include PARAMS.h
8  C     | The values from the model's standard input file are      |  C    !DESCRIPTION: \bv
9  C     | stored into the variables held here. Notes describing    |  C     *==========================================================*
10  C     | the parameters can also be found here.                   |  C     | PARAMS.h                                                  
11  C     \==========================================================/  C     | o Header file defining model "parameters".                
12    C     *==========================================================*
13    C     | The values from the model standard input file are        
14    C     | stored into the variables held here. Notes describing    
15    C     | the parameters can also be found here.                    
16    C     *==========================================================*
17    C     \ev
18    CEOP
19    
20    C     Macros for special grid options
21    #include "PARAMS_MACROS.h"
22    
23  C--   Contants  C--   Contants
 C     nOBands - No. of offline data time bands  
       INTEGER nOBands  
       PARAMETER ( nOBands = 12 )  
24  C     Useful physical values  C     Useful physical values
25        Real*8 PI        Real*8 PI
26        PARAMETER ( PI    = 3.14159265358979323844D0   )        PARAMETER ( PI    = 3.14159265358979323844D0   )
27        Real*8 deg2rad        Real*8 deg2rad
28        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )
29    
30    C     Symbolic values
31    C     precXXXX :: Used to indicate what precision to use for
32    C                dumping model state.
33          INTEGER precFloat32
34          PARAMETER ( precFloat32 = 32 )
35          INTEGER precFloat64
36          PARAMETER ( precFloat64 = 64 )
37    C     UNSET_xxx :: Used to indicate variables that have not been given a value
38          Real*8 UNSET_FLOAT8
39          PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
40          Real*4 UNSET_FLOAT4
41          PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )
42          _RL    UNSET_RL    
43          PARAMETER ( UNSET_RL     = 1.234567D5 )
44          _RS    UNSET_RS    
45          PARAMETER ( UNSET_RS     = 1.234567E5 )
46          INTEGER UNSET_I
47          PARAMETER ( UNSET_I      = 123456789  )
48    
49    C     Checkpoint data
50          INTEGER maxNoChkptLev
51          PARAMETER ( maxNoChkptLev = 2 )
52    
53  C--   COMMON /PARM_C/ Character valued parameters used by the model.  C--   COMMON /PARM_C/ Character valued parameters used by the model.
54  C     oBandId  - Offline dataset identifiers for different periods.  C     checkPtSuff :: List of checkpoint file suffices
55        COMMON /PARM_C/ oBandId  C     bathyFile   :: File containing bathymetry. If not defined bathymetry
56        CHARACTER*3 oBandId(nOBands)  C                   is taken from inline function.
57    C     topoFile    :: File containing the topography of the surface (unit=m)
58    C                   (mainly used for the atmosphere = ground height).
59    C     hydrogThetaFile :: File containing initial hydrographic data for potential
60    C                       temperature.
61    C     hydrogSaltFile  :: File containing initial hydrographic data for salinity.
62    C     zonalWindFile   :: File containing zonal wind data
63    C     meridWindFile   :: File containing meridional wind data
64    C     thetaClimFile   :: File containing theta climataology used
65    C                       in relaxation term -lambda(theta-theta*)
66    C     saltClimFile    :: File containing salt climataology used
67    C                       in relaxation term -lambda(salt-salt*)
68    C     surfQfile       :: File containing surface heat flux
69    C     surfQswfile     :: File containing surface shortwave radiation
70    C     dQdTfile        :: File containing thermal relaxation coefficient
71    C     EmPmRfile       :: File containing surface fresh water flux
72    C     pLoadFile       :: File containing pressure loading
73    C     buoyancyRelation :: Flag used to indicate which relation to use to
74    C                        get buoyancy.
75    C     eosType         :: choose the equation of state:
76    C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
77          COMMON /PARM_C/ checkPtSuff,
78         &                bathyFile, topoFile,
79         &                hydrogThetaFile, hydrogSaltFile,
80         &                zonalWindFile, meridWindFile, thetaClimFile,
81         &                saltClimFile, buoyancyRelation,
82         &                EmPmRfile, surfQfile, surfQswfile,
83         &                uVelInitFile, vVelInitFile, pSurfInitFile,
84         &                dQdTfile, ploadFile,
85         &                eosType, pickupSuff,
86         &                mdsioLocalDir
87          CHARACTER*(5) checkPtSuff(maxNoChkptLev)
88          CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
89          CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
90          CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
91          CHARACTER*(MAX_LEN_FNAM) zonalWindFile
92          CHARACTER*(MAX_LEN_FNAM) meridWindFile
93          CHARACTER*(MAX_LEN_FNAM) thetaClimFile
94          CHARACTER*(MAX_LEN_FNAM) saltClimFile
95          CHARACTER*(MAX_LEN_FNAM) surfQfile
96          CHARACTER*(MAX_LEN_FNAM) surfQswfile
97          CHARACTER*(MAX_LEN_FNAM) EmPmRfile
98          CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
99          CHARACTER*(MAX_LEN_FNAM) uVelInitFile
100          CHARACTER*(MAX_LEN_FNAM) vVelInitFile
101          CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
102          CHARACTER*(MAX_LEN_FNAM) dQdTfile
103          CHARACTER*(MAX_LEN_FNAM) ploadFile
104          CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
105          CHARACTER*(6) eosType
106          CHARACTER*(10) pickupSuff
107    
108  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
109  C     cg2dMaxIters        - Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
110  C                           two-dimensional con. grad solver.  C                           two-dimensional con. grad solver.
111  C     cg2dChkResFreq      - Frequency with which to check residual  C     cg2dChkResFreq      :: Frequency with which to check residual
112  C                           in con. grad solver.  C                           in con. grad solver.
113  C     nIter0              - Start time-step number of for this run  C     cg3dMaxIters        :: Maximum number of iterations in the
114  C     nTimeSteps          - Number of timesteps to execute  C                           three-dimensional con. grad solver.
115  C     numStepsPerPickup   - For offline setup. Frequency of pickup  C     cg3dChkResFreq      :: Frequency with which to check residual
116    C                           in con. grad solver.
117    C     nIter0              :: Start time-step number of for this run
118    C     nTimeSteps          :: Number of timesteps to execute
119    C     numStepsPerPickup   :: For offline setup. Frequency of pickup
120  C                           of flow fields.  C                           of flow fields.
121    C     writeStatePrec      :: Precision used for writing model state.
122    C     writeBinaryPrec     :: Precision used for writing binary files
123    C     readBinaryPrec      :: Precision used for reading binary files
124    C     nCheckLev           :: Holds current checkpoint level
125    C     nonlinFreeSurf      :: option related to non-linear free surface
126    C                           =0 Linear free surface ; >0 Non-linear
127    C     select_rStar        :: option related to r* vertical coordinate
128    C                           =0 (default) use r coord. ; > 0 use r*
129    C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
130    C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
131    C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
132    C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector
133    C     debugLevel          :: debug level selector: higher -> more writing
134    
135        COMMON /PARM_I/        COMMON /PARM_I/
136       &        cg2dMaxIters,       &        cg2dMaxIters,
137       &        cg2dChkResFreq,       &        cg2dChkResFreq,
138       &        nIter0, nTimeSteps,       &        cg3dMaxIters,
139       &        numStepsPerPickup       &        cg3dChkResFreq,
140         &        nIter0, nTimeSteps, nEndIter,
141         &        numStepsPerPickup,
142         &        writeStatePrec, nCheckLev,
143         &        writeBinaryPrec, readBinaryPrec,
144         &        nonlinFreeSurf, select_rStar,
145         &        tempAdvScheme, tempVertAdvScheme,
146         &        saltAdvScheme, saltVertAdvScheme,
147         &        tracerAdvScheme,
148         &        debugLevel
149        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
150        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
151          INTEGER cg3dMaxIters
152          INTEGER cg3dChkResFreq
153        INTEGER nIter0        INTEGER nIter0
154        INTEGER nTimeSteps        INTEGER nTimeSteps
155          INTEGER nEndIter
156        INTEGER numStepsPerPickup        INTEGER numStepsPerPickup
157          INTEGER writeStatePrec
158          INTEGER writeBinaryPrec
159          INTEGER readBinaryPrec
160          INTEGER nCheckLev
161          INTEGER nonlinFreeSurf
162          INTEGER select_rStar
163          INTEGER tempAdvScheme, tempVertAdvScheme
164          INTEGER saltAdvScheme, saltVertAdvScheme
165          INTEGER tracerAdvScheme
166          INTEGER debugLevel
167    
168    C
169          INTEGER debLevZero
170          PARAMETER(debLevZero=0)
171          INTEGER debLevA
172          PARAMETER(debLevA=1)
173          INTEGER debLevB
174          PARAMETER(debLevB=2)
175    
176  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
177  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
178  C                          coordinate frame.  C                          coordinate frame.
179  C     usingSphericalPolarGrid - If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
180  C                               spherical polar frame.  C                               spherical polar frame.
181  C     momViscosity  - Flag which turns momentum friction terms on and off.  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
182  C     momAdvection  - Flag which turns advection of momentum on and off.  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.
183  C     momForcing    - Flag which turns external forcing of momentum on  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
184    C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
185    C     momViscosity  :: Flag which turns momentum friction terms on and off.
186    C     momAdvection  :: Flag which turns advection of momentum on and off.
187    C     momForcing    :: Flag which turns external forcing of momentum on
188  C                     and off.  C                     and off.
189  C     useCoriolis   - Flag which turns the coriolis terms on and off.  C     momPressureForcing :: Flag which turns pressure term in momentum equation
190  C     tempDiffusion - Flag which turns diffusion of temperature on  C                          on and off.
191    C     metricTerms   :: Flag which turns metric terms on or off.
192    C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
193    C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.
194    C     useCoriolis   :: Flag which turns the coriolis terms on and off.
195    C     tempDiffusion :: Flag which turns diffusion of temperature on
196  C                     and off.  C                     and off.
197  C     tempAdvection - Flag which turns advection of temperature on  C     tempAdvection :: Flag which turns advection of temperature on
198  C                     and off.  C                     and off.
199  C     tempForcing   - Flag which turns external forcing of temperature on  C     tempForcing   :: Flag which turns external forcing of temperature on
200  C                     and off.  C                     and off.
201  C     saltDiffusion - Flag which turns diffusion of salinit on  C     saltDiffusion :: Flag which turns diffusion of salinity on
202  C                     and off.  C                     and off.
203  C     saltAdvection - Flag which turns advection of salinit on  C     saltAdvection :: Flag which turns advection of salinity on
204  C                     and off.  C                     and off.
205  C     saltForcing   - Flag which turns external forcing of salinit on  C     saltForcing   :: Flag which turns external forcing of salinity on
206  C                     and off.  C                     and off.
207    C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
208    C                         as a real Fresh Water (=> changes the Sea Level)
209    C                         if F, converts P+R-E to salt flux (no SL effect)
210    C     rigidLid            :: Set to true to use rigid lid
211    C     implicitFreeSurface :: Set to true to use implcit free surface
212    C     exactConserv        :: Set to true to conserve exactly the total Volume
213    C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
214    C                           linear relation Phi_surf = Bo_surf*eta
215    C     momStepping   :: Turns momentum equation time-stepping off
216    C     tempStepping  :: Turns temperature equation time-stepping off
217    C     saltStepping  :: Turns salinity equation time-stepping off
218    C     tr1Stepping   :: Turns passive tracer 1 time-stepping on/off
219    C     useConstantF  :: Coriolis parameter set to f0
220    C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
221    C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
222    C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
223    C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
224    C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
225    C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny
226    C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
227    C     highOrderVorticity :: use 3rd/4th order interp. of vorticity in Coriolis
228    C     useAbsVorticity :: work with f+zeta in Coriolis terms
229    C     implicitDiffusion :: Turns implicit vertical diffusion on
230    C     implicitViscosity :: Turns implicit vertical viscosity on
231    C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
232    C     saltImplVertAdv :: Turns on implicit vertical advection for Salinity
233    C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
234    C     multiDimAdvection :: Flag that enable multi-dimension advection
235    C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
236    C                      out off Adams-Bashforth time stepping.
237    C     doThetaClimRelax :: Set true if relaxation to temperature
238    C                        climatology is required.
239    C     doSaltClimRelax  :: Set true if relaxation to salinity
240    C                        climatology is required.
241    C     periodicExternalForcing :: Set true if forcing is time-dependant
242    C     usingPCoords     :: Set to indicate that we are working in pressure
243    C                        coords. (jmc: is it still used ?)
244    C     usingZCoords     :: Set to indicate that we are working in height
245    C                        coords. (jmc: is it still used ?)
246    C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
247    C                         this requires specific code for restart & exchange
248    C     setCenterDr    :: set cell Center depth and put Interface at the middle
249    C     nonHydrostatic :: Using non-hydrostatic terms
250    C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
251    C     globalFiles    :: Selects between "global" and "tiled" files
252    C     useSingleCpuIO :: On SGI platforms, option globalFiles is either
253    C                       slow (f77) or does not work (f90).  When
254    C                       useSingleCpuIO is set, mdsio_writefield.F
255    C                       outputs from master mpi process only.
256    C     allowFreezing  :: Allows surface water to freeze and form ice
257    C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
258    C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
259        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
260       & momViscosity, momAdvection, momForcing, useCoriolis,       & usingCurvilinearGrid, usingCylindricalGrid,
261         & no_slip_sides,no_slip_bottom,
262         & staggerTimeStep,
263         & momViscosity, momAdvection, momForcing, useCoriolis,
264         & momPressureForcing, vectorInvariantMomentum,
265       & tempDiffusion, tempAdvection, tempForcing,       & tempDiffusion, tempAdvection, tempForcing,
266       & saltDiffusion, saltAdvection, saltForcing       & saltDiffusion, saltAdvection, saltForcing,
267         & useRealFreshWaterFlux,
268         & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
269         & momStepping, tempStepping, saltStepping, tr1Stepping,
270         & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
271         & useConstantF, useBetaPlaneF, useSphereF,
272         & useCDscheme,
273         & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
274         & SadournyCoriolis, upwindVorticity, highOrderVorticity,
275         & useAbsVorticity,
276         & implicitDiffusion, implicitViscosity,
277         & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
278         & multiDimAdvection, forcing_In_AB,
279         & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
280         & periodicExternalForcing,
281         & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
282         & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
283         & allowFreezing, useOldFreezing, groundAtK1,
284         & usePickupBeforeC35, usePickupBeforeC54, debugMode,
285         & readPickupWithTracer, writePickupWithTracer
286        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
287        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
288          LOGICAL usingCylindricalGrid
289          LOGICAL usingCurvilinearGrid
290          LOGICAL usingSphericalPolarMTerms
291          LOGICAL useNHMTerms
292          LOGICAL no_slip_sides
293          LOGICAL no_slip_bottom
294          LOGICAL staggerTimeStep
295        LOGICAL momViscosity        LOGICAL momViscosity
296        LOGICAL momAdvection        LOGICAL momAdvection
297        LOGICAL momForcing        LOGICAL momForcing
298          LOGICAL momPressureForcing
299        LOGICAL useCoriolis        LOGICAL useCoriolis
300          LOGICAL vectorInvariantMomentum
301        LOGICAL tempDiffusion        LOGICAL tempDiffusion
302        LOGICAL tempAdvection        LOGICAL tempAdvection
303        LOGICAL tempForcing        LOGICAL tempForcing
304        LOGICAL saltDiffusion        LOGICAL saltDiffusion
305        LOGICAL saltAdvection        LOGICAL saltAdvection
306        LOGICAL saltForcing        LOGICAL saltForcing
307          LOGICAL useRealFreshWaterFlux
308          LOGICAL rigidLid
309          LOGICAL implicitFreeSurface
310          LOGICAL exactConserv
311          LOGICAL uniformLin_PhiSurf
312          LOGICAL momStepping
313          LOGICAL tempStepping
314          LOGICAL saltStepping
315          LOGICAL tr1Stepping
316          LOGICAL metricTerms
317          LOGICAL useConstantF
318          LOGICAL useBetaPlaneF
319          LOGICAL useSphereF
320          LOGICAL useCDscheme
321          LOGICAL useEnergyConservingCoriolis
322          LOGICAL useJamartWetPoints
323          LOGICAL useJamartMomAdv
324          LOGICAL SadournyCoriolis
325          LOGICAL upwindVorticity
326          LOGICAL highOrderVorticity
327          LOGICAL useAbsVorticity
328          LOGICAL implicitDiffusion
329          LOGICAL implicitViscosity
330          LOGICAL tempImplVertAdv
331          LOGICAL saltImplVertAdv
332          LOGICAL momImplVertAdv
333          LOGICAL multiDimAdvection
334          LOGICAL forcing_In_AB
335          LOGICAL doThetaClimRelax
336          LOGICAL doSaltClimRelax
337          LOGICAL doTr1ClimRelax
338          LOGICAL periodicExternalForcing
339          LOGICAL usingPCoords
340          LOGICAL usingZCoords
341          LOGICAL useDynP_inEos_Zc
342          LOGICAL setCenterDr
343          LOGICAL nonHydrostatic
344          LOGICAL quasiHydrostatic
345          LOGICAL globalFiles
346          LOGICAL useSingleCpuIO
347          LOGICAL allowFreezing
348          LOGICAL useOldFreezing
349          LOGICAL groundAtK1
350          LOGICAL usePickupBeforeC35
351          LOGICAL usePickupBeforeC54
352          LOGICAL debugMode
353          LOGICAL readPickupWithTracer
354          LOGICAL writePickupWithTracer
355    
356  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
357  C     cg2dTargetResidual  C     gg2dTargetResidual
358  C               - Target residual for cg2d solver.  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
359  C     delZ      - Vertical grid spacing ( m ) - delZ is the distance  C     cg2dTargetResWunit
360  C                 between "w" surfaces.  C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
361  C     delX      - Separation between cell faces (m) or (deg), depending  C     cg3dTargetResidual
362    C               :: Target residual for cg3d solver.
363    C     cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
364    C     Note. 20th May 1998
365    C           I made a weird discovery! In the model paper we argue
366    C           for the form of the preconditioner used here ( see
367    C           A Finite-volume, Incompressible Navier-Stokes Model
368    C           ...., Marshall et. al ). The algebra gives a simple
369    C           0.5 factor for the averaging of ac and aCw to get a
370    C           symmettric pre-conditioner. By using a factor of 0.51
371    C           i.e. scaling the off-diagonal terms in the
372    C           preconditioner down slightly I managed to get the
373    C           number of iterations for convergence in a test case to
374    C           drop form 192 -> 134! Need to investigate this further!
375    C           For now I have introduced a parameter cg2dpcOffDFac which
376    C           defaults to 0.51 but can be set at runtime.
377    C     delR      :: Vertical grid spacing ( units of r ).
378    C     delRc     :: Vertical grid spacing between cell centers (r unit).
379    C     delX      :: Separation between cell faces (m) or (deg), depending
380  C     delY        on input flags.  C     delY        on input flags.
381  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
382  C     ronil     - Reference density  C     recip_gravity and its inverse
383  C     startTime - Start time for model ( s )  C     gBaro     :: Accel. due to gravity used in barotropic equation ( m/s^2 )
384  C     phiMin    - Latitude of southern most cell face.  C     rhoNil    :: Reference density for the linear equation of state
385  C     thetaMin  - Longitude of western most cell face (this  C     rhoConst  :: Vertically constant reference density
386    C     rhoConstFresh :: Constant reference density for fresh water (rain)
387    C     startTime :: Start time for model ( s )
388    C     phiMin    :: Latitude of southern most cell face.
389    C     thetaMin  :: Longitude of western most cell face (this
390  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
391  C                 to make geographical references simple.)  C                 to make geographical references simple.)
392  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).
393  C     f0        - Reference coriolis parameter ( 1/s )  C     recip_RSphere  :: Reciprocal radius of sphere ( m ).
394    C     f0        :: Reference coriolis parameter ( 1/s )
395  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
396  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      :: df/dy ( s^-1.m^-1 )
397  C     viscAh    - Eddy viscosity coeff. for mixing of  C     omega     :: Angular velocity ( rad/s )
398    C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
399    C     viscAh    :: Eddy viscosity coeff. for mixing of
400  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
401  C     viscAz    - Eddy viscosity coeff. for mixing of  C     viscAr    :: Eddy viscosity coeff. for mixing of
402  C                 momentum vertically ( m^2/s )  C                 momentum vertically ( units of r^2/s )
403  C     viscA4    - Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
404  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
405  C     diffKhT   - Laplacian diffusion coeff. for mixing of  C     viscC2leith :: Leith non-dimensional viscosity factor
406    C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of
407    C                 momentum laterally ( m^2/s )
408    C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
409    C                 momentum laterally ( m^4/s )
410    C     viscAhGrid:: non-dimensional grid-size dependent viscosity
411    C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
412    C     viscC4leith :: Leith non-dimensional viscosity factor
413    C     diffKhT   :: Laplacian diffusion coeff. for mixing of
414  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
415  C     diffKzT   - Laplacian diffusion coeff. for mixing of  C     diffKrT   :: Laplacian diffusion coeff. for mixing of
416  C                 heat vertically ( m^2/s )  C                 heat vertically ( units of r^2/s )
417  C     diffK4T   - Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
418  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
419  C     diffKhS  -  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
420  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
421  C     diffKzS   - Laplacian diffusion coeff. for mixing of  C     diffKrS   :: Laplacian diffusion coeff. for mixing of
422  C                 salt vertically ( m^2/s )  C                 salt vertically ( units of r^2/s )
423  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
424  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
425  C     deltaT    - Default timestep ( s )  C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
426  C     deltaTMom    - Timestep for momemtum equations ( s )  C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
427  C     deltaTtracer - Timestep for tracer equations ( s )  C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979
428  C     tauCD     - CD scheme coupling timescale ( 1/s )  C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979
429  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C     deltaT    :: Default timestep ( s )
430  C     GMmaxslope  - max. slope allowed in GM/Redi tensor  C     deltaTClock  :: Timestep used as model "clock". This determines the
431  C     GMlength  - Length to use in Visbeck et al. formula for K  C                    IO frequencies and is used in tagging output. It can
432  C     GMalpha   - alpha to use in Visbeck et al. formula for K  C                    be totally different to the dynamical time. Typically
433  C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)  C                    it will be the deep-water timestep for accelerated runs.
434  C     GMbackground - background value of GM/Redi coefficient  C                    Frequency of checkpointing and dumping of the model state
435  C     startTime - Starting time for this integration ( s ).  C                    are referenced to this clock. ( s )
436  C     endTime   - Ending time for this integration ( s ).  C     deltaTMom    :: Timestep for momemtum equations ( s )
437  C     chkPtFreq - Frequency of check pointing ( s ).  C     deltaTtracer :: Timestep for tracer equations ( s )
438  C     dumpFreq  - Frequency with which model state is written to  C     deltaTfreesurf :: Timestep for free-surface equation ( s )
439  C                 post-processing files ( s ).  C     freesurfFac  :: Parameter to turn implicit free surface term on or off
440        COMMON /PARM_R/ cg2dTargetResidual, delZ, delX, delY, deltaT,  C                    freesurfac = 1. uses implicit free surface
441       & deltaTmom, deltaTtracer, abeps, startTime, phiMin, thetaMin,  C                    freesurfac = 0. uses rigid lid
442       & rSphere, f0, fCori, beta, viscAh, viscAz, viscA4, diffKhT, diffKzT,  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
443       & diffK4T, diffKhS, diffKzS, diffK4S, delT, tauCD, rCD,  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
444       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
445       & gravity, rhonil, tRef, sRef,  C                     Implicit part of barotropic flow Divergence ( 0-1 )
446       & endTime, chkPtFreq, dumpFreq  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
447    C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)
448    C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
449    C     hFacMinDr    :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
450    C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
451    C     hFacSup        that control vanishing and creating levels
452    C     tauCD        :: CD scheme coupling timescale ( 1/s )
453    C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )
454    C     startTime     :: Starting time for this integration ( s ).
455    C     endTime       :: Ending time for this integration ( s ).
456    C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
457    C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
458    C     dumpFreq      :: Frequency with which model state is written to
459    C                     post-processing files ( s ).
460    C     diagFreq      :: Frequency with which model writes diagnostic output
461    C                     of intermediate quantities.
462    C     afFacMom      :: Advection of momentum term tracer parameter
463    C     vfFacMom      :: Momentum viscosity tracer parameter
464    C     pfFacMom      :: Momentum pressure forcing tracer parameter
465    C     cfFacMom      :: Coriolis term tracer parameter
466    C     foFacMom      :: Momentum forcing tracer parameter
467    C     mtFacMom      :: Metric terms tracer parameter
468    C     cosPower      :: Power of cosine of latitude to multiply viscosity
469    C     cAdjFreq      :: Frequency of convective adjustment
470    C
471    C     taveFreq      :: Frequency with which time-averaged model state
472    C                      is written to post-processing files ( s ).
473    C     tave_lastIter :: (for state variable only) fraction of the last time
474    C                      step (of each taveFreq period) put in the time average.
475    C                      (fraction for 1rst iter = 1 - tave_lastIter)
476    C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
477    C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
478    C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
479    C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
480    C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
481    C                         i.e. where |yC| <= latBandClimRelax
482    C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
483    C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
484    C                          (note: externForcingCycle must be an integer
485    C                           number times externForcingPeriod)
486    C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
487    C                       (use model surface (local) value if set to -1)
488    C     temp_EvPrRn :: temperature of Rain & Evap.
489    C     salt_EvPrRn :: salinity of Rain & Evap.
490    C     trac_EvPrRn :: tracer concentration in Rain & Evap.
491    C        (notes: a) tracer content of Rain/Evap only used if both
492    C                     NonLin_FrSurf & useRealFreshWater are set.
493    C                b) use model surface (local) value if set to UNSET_RL)
494    C     horiVertRatio      :: Ratio on units in vertical to units in horizontal.
495    C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
496    C                          ( g*rho if horiz in m and vertical in Pa ).
497    C     Ro_SeaLevel        :: standard position of Sea-Level in "R" coordinate, used as
498    C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
499    C     bottomDragLinear   :: Drag coefficient built in to core dynamics
500    C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )
501          COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
502         & cg2dpcOffDFac, cg3dTargetResidual,
503         & delR, delRc, delX, delY,
504         & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,
505         & abeps, startTime,
506         & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
507         & fCori, fCoriG, fCoriCos,
508         & viscAh,  viscAhMax, viscAhGrid, viscC2leith,
509         & viscA4,  viscA4Max, viscA4Grid, viscC4leith,
510         & viscAr, viscAstrain, viscAtension,
511         & diffKhT, diffK4T, diffKrT,
512         & diffKhS, diffK4S, diffKrS,
513         & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
514         & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
515         & hFacMin, hFacMinDz, hFacInf, hFacSup,
516         & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
517         & recip_rhoConst, rhoConst,
518         & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
519         & endTime, chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,
520         & diagFreq, taveFreq, tave_lastIter, monitorFreq,
521         & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
522         & cosPower, cAdjFreq, omega, rotationPeriod,
523         & tauThetaClimRelax, lambdaThetaClimRelax,
524         & tauSaltClimRelax, lambdaSaltClimRelax,
525         & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
526         & externForcingCycle, externForcingPeriod,
527         & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,
528         & hFacMinDr, hFacMinDp,
529         & horiVertRatio, recip_horiVertRatio,
530         & ivdc_kappa, Ro_SeaLevel,
531         & bottomDragLinear,bottomDragQuadratic,
532         & tCyl
533    
534        _RL cg2dTargetResidual        _RL cg2dTargetResidual
535        _RL delZ(Nz)        _RL cg2dTargetResWunit
536          _RL cg3dTargetResidual
537          _RL cg2dpcOffDFac
538          _RL delR(Nr)
539          _RL delRc(Nr+1)
540        _RL delX(Nx)        _RL delX(Nx)
541        _RL delY(Ny)        _RL delY(Ny)
542        _RL deltaT        _RL deltaT
543          _RL deltaTClock
544        _RL deltaTmom        _RL deltaTmom
545        _RL deltaTtracer        _RL deltaTtracer
546          _RL deltaTfreesurf
547        _RL abeps        _RL abeps
548        _RL phiMin        _RL phiMin
549        _RL thetaMin        _RL thetaMin
550        _RL rSphere        _RL rSphere
551          _RL recip_RSphere
552        _RL f0        _RL f0
553          _RL freeSurfFac
554          _RL implicSurfPress
555          _RL implicDiv2Dflow
556          _RL hFacMin
557          _RL hFacMinDz
558          _RL hFacMinDp
559          _RL hFacMinDr
560          _RL hFacInf
561          _RL hFacSup
562        _RL beta        _RL beta
563        _RL viscAh        _RL viscAh
564        _RL viscAz        _RL viscAhMax
565          _RL viscAhGrid
566          _RL viscC2leith
567          _RL viscAstrain
568          _RL viscAtension
569          _RL viscAr
570        _RL viscA4        _RL viscA4
571          _RL viscA4Max
572          _RL viscA4Grid
573          _RL viscC4leith
574        _RL diffKhT        _RL diffKhT
575        _RL diffKzT        _RL diffKrT
576        _RL diffK4T        _RL diffK4T
577        _RL diffKhS        _RL diffKhS
578        _RL diffKzS        _RL diffKrS
579        _RL diffK4S        _RL diffK4S
580          _RL diffKrBL79surf
581          _RL diffKrBL79deep
582          _RL diffKrBL79scl
583          _RL diffKrBL79Ho
584        _RL delt        _RL delt
585        _RL tauCD        _RL tauCD
586        _RL rCD        _RL rCD
       _RL GMmaxslope  
       _RL GMlength  
       _RL GMalpha  
       _RL GMdepth  
       _RL GMkbackground  
587        _RL gravity        _RL gravity
588          _RL recip_gravity
589          _RL gBaro
590        _RL rhonil        _RL rhonil
591        _RL tRef(Nz)        _RL recip_rhonil
592        _RL sRef(Nz)        _RL rhoConst
593        _RL Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL recip_rhoConst
594          _RL rhoConstFresh
595          _RL convertEmP2rUnit
596          _RL tRef(Nr)
597          _RL sRef(Nr)
598          _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
599          _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
600          _RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
601        _RL startTime        _RL startTime
602        _RL endTime        _RL endTime
603        _RL chkPtFreq        _RL chkPtFreq
604          _RL pChkPtFreq
605        _RL dumpFreq        _RL dumpFreq
606          _RL adjDumpFreq
607          _RL diagFreq
608          _RL taveFreq
609          _RL tave_lastIter
610          _RL monitorFreq
611          _RL afFacMom
612          _RL vfFacMom
613          _RL pfFacMom
614          _RL cfFacMom
615          _RL foFacMom
616          _RL mTFacMom
617          _RL cosPower
618          _RL cAdjFreq
619          _RL omega
620          _RL rotationPeriod
621          _RL tauThetaClimRelax
622          _RL lambdaThetaClimRelax
623          _RL tauSaltClimRelax
624          _RL lambdaSaltClimRelax
625          _RL tauTr1ClimRelax
626          _RL lambdaTr1ClimRelax
627          _RL latBandClimRelax
628          _RL externForcingCycle
629          _RL externForcingPeriod
630          _RL convertFW2Salt
631          _RL temp_EvPrRn
632          _RL salt_EvPrRn
633          _RL trac_EvPrRn
634          _RL horiVertRatio
635          _RL recip_horiVertRatio
636          _RL ivdc_kappa
637          _RL Ro_SeaLevel
638          _RL bottomDragLinear
639          _RL bottomDragQuadratic
640          _RL tCyl
641    
642        COMMON /PARM_A/ HeatCapacity_Cp,  C--   COMMON /PARM_A/ Thermodynamics constants ?
643       &                Lamba_theta        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
644        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
645        _RL Lamba_theta        _RL recip_Cp
646    
647    C--   COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
648    C     celsius2K :: convert centigrade (Celsius) degree to Kelvin
649    C     atm_Po    :: standard reference pressure
650    C     atm_Cp    :: specific heat (Cp) of the (dry) air at constant pressure
651    C     atm_Rd    :: gas constant for dry air
652    C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
653    C     atm_Rq    :: water vapour specific volume anomaly relative to dry air
654    C                  (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
655    C     integr_GeoPot :: option to select the way we integrate the geopotential
656    C                     (still a subject of discussions ...)
657    C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
658    C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
659          COMMON /PARM_ATM/
660         &            celsius2K,
661         &            atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
662         &            integr_GeoPot, selectFindRoSurf
663          _RL celsius2K
664          _RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq
665          INTEGER integr_GeoPot, selectFindRoSurf
666    
667    C Logical flags for selecting packages
668          LOGICAL useKPP
669          LOGICAL useGMRedi
670          LOGICAL useOBCS
671          LOGICAL useAIM
672          LOGICAL useLand
673          LOGICAL useGrdchk
674          LOGICAL useECCO
675          LOGICAL useSHAP_FILT
676          LOGICAL useZONAL_FILT
677          LOGICAL useFLT
678          LOGICAL usePTRACERS
679          LOGICAL useSBO
680          LOGICAL useSEAICE
681          LOGICAL useBulkForce
682          LOGICAL useThSIce
683          LOGICAL usefizhi
684          LOGICAL usegridalt
685          LOGICAL usediagnostics
686          LOGICAL useEBM
687          COMMON /PARM_PACKAGES/
688         &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
689         &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
690         &        usePTRACERS,  useSBO, useSEAICE, useThSIce, useBulkForce,
691         &        usefizhi,  usegridalt, usediagnostics, useEBM
692    
693    C     Run-time flags for early-initialization of MNC
694          LOGICAL
695         &     useMNC,
696         &     mnc_use_indir, mnc_use_outdir, mnc_outdir_date,
697         &     mnc_echo_gvtypes, mnc_pickup_write, mnc_pickup_read,
698         &     mnc_use_for_mon
699          CHARACTER*(MAX_LEN_FNAM) mnc_outdir_str
700          CHARACTER*(MAX_LEN_FNAM) mnc_indir_str
701          COMMON /PARM_MNC/
702         &     useMNC,
703         &     mnc_use_indir, mnc_use_outdir, mnc_outdir_date,
704         &     mnc_echo_gvtypes, mnc_pickup_write, mnc_pickup_read,
705         &     mnc_outdir_str, mnc_indir_str,
706         &     mnc_use_for_mon
707    
708    
709  C Equation of State (polynomial coeffients)  CEH3 ;;; Local Variables: ***
710        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS  CEH3 ;;; mode:fortran ***
711        _RL eosC(Nz+1,9),eosSig0(Nz+1),eosRefT(Nz+1),eosRefS(Nz+1)  CEH3 ;;; End: ***
 C Linear equation of state  
 C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).  
 C     sBeta     - Linear EOS haline contraction coefficient.  
       COMMON /PARM_EOS_LIN/ tAlpha,sBeta  
       _RL tAlpha  
       _RL sBeta  
Legend:
Removed from v.1.6  
changed lines
  Added in v.1.117
  ViewVC Help
Powered by ViewVC 1.1.22