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