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