/[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.7 by cnh, Thu May 21 18:28:50 1998 UTC revision 1.132 by jmc, Sun Oct 17 23:03:08 2004 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
21  C     Useful physical values  C     Useful physical values
# Line 17  C     Useful physical values Line 25  C     Useful physical values
25        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )
26    
27  C     Symbolic values  C     Symbolic values
28  C     precXXXX - Used to indicate what precision to use for  C     precXXXX :: Used to indicate what precision to use for
29  C                dumping model state.  C                dumping model state.
30        INTEGER precFloat32        INTEGER precFloat32
31        PARAMETER ( precFloat32 = 0 )        PARAMETER ( precFloat32 = 32 )
32        INTEGER precFloat64        INTEGER precFloat64
33        PARAMETER ( precFloat64 = 1 )        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  C     Checkpoint data
47        INTEGER maxNoChkptLev        INTEGER maxNoChkptLev
48        PARAMETER ( maxNoChkptLev = 2 )        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     checkPtSuff - List of checkpoint file suffices  C     checkPtSuff :: List of checkpoint file suffices
52        COMMON /PARM_C/ checkPtSuff  C     bathyFile   :: File containing bathymetry. If not defined bathymetry
53    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     pLoadFile       :: File containing pressure loading
72    C     buoyancyRelation :: Flag used to indicate which relation to use to
73    C                        get buoyancy.
74    C     eosType         :: choose the equation of state:
75    C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
76    C     the_run_name    :: string identifying the name of the model "run"
77          COMMON /PARM_C/ checkPtSuff,
78         &                bathyFile, topoFile,
79         &                hydrogThetaFile, hydrogSaltFile,
80         &                zonalWindFile, meridWindFile, thetaClimFile,
81         &                saltClimFile, buoyancyRelation,
82         &                EmPmRfile, surfQfile, surfQnetFile, surfQswFile,
83         &                uVelInitFile, vVelInitFile, pSurfInitFile,
84         &                dQdTfile, ploadFile,
85         &                eosType, pickupSuff,
86         &                mdsioLocalDir,
87         &                the_run_name
88        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
89          CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
90          CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
91          CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
92          CHARACTER*(MAX_LEN_FNAM) zonalWindFile
93          CHARACTER*(MAX_LEN_FNAM) meridWindFile
94          CHARACTER*(MAX_LEN_FNAM) thetaClimFile
95          CHARACTER*(MAX_LEN_FNAM) saltClimFile
96          CHARACTER*(MAX_LEN_FNAM) surfQfile
97          CHARACTER*(MAX_LEN_FNAM) surfQnetFile
98          CHARACTER*(MAX_LEN_FNAM) surfQswFile
99          CHARACTER*(MAX_LEN_FNAM) EmPmRfile
100          CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
101          CHARACTER*(MAX_LEN_FNAM) uVelInitFile
102          CHARACTER*(MAX_LEN_FNAM) vVelInitFile
103          CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
104          CHARACTER*(MAX_LEN_FNAM) dQdTfile
105          CHARACTER*(MAX_LEN_FNAM) ploadFile
106          CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
107          CHARACTER*(MAX_LEN_FNAM) the_run_name
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.  C                           in con. grad solver.
116  C     nIter0              - Start time-step number of for this run  C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner
117  C     nTimeSteps          - Number of timesteps to execute  C                            (non-linear free-surf.)
118  C     numStepsPerPickup   - For offline setup. Frequency of pickup  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.
122    C     nIter0              :: Start time-step number of for this run
123    C     nTimeSteps          :: Number of timesteps to execute
124    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.  C     writeStatePrec      :: Precision used for writing model state.
127  C     writeBinaryPrec     - Precision used for writing binary files  C     writeBinaryPrec     :: Precision used for writing binary files
128  C     readBinaryPrec      - Precision used for reading binary files  C     readBinaryPrec      :: Precision used for reading binary files
129  C     nCheckLev           - Holds current checkpoint level  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         &        cg3dChkResFreq,
145         &        nIter0, nTimeSteps, nEndIter,
146       &        numStepsPerPickup,       &        numStepsPerPickup,
147       &        writeStatePrec, nCheckLev,       &        writeStatePrec, nCheckLev,
148       &        writeBinaryPrec, readBinaryPrec       &        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        INTEGER writeStatePrec
164        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
165        INTEGER readBinaryPrec        INTEGER readBinaryPrec
166        INTEGER nCheckLev        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     useConstantF  :: Coriolis parameter set to f0
225    C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
226    C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
227    C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
228    C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
229    C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
230    C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny
231    C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
232    C     highOrderVorticity :: use 3rd/4th order interp. of vorticity in Coriolis
233    C     useAbsVorticity :: work with f+zeta in Coriolis terms
234    C     implicitDiffusion :: Turns implicit vertical diffusion on
235    C     implicitViscosity :: Turns implicit vertical viscosity on
236    C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
237    C     saltImplVertAdv :: Turns on implicit vertical advection for Salinity
238    C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
239    C     multiDimAdvection :: Flag that enable multi-dimension advection
240    C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
241    C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
242    C                      out off Adams-Bashforth time stepping.
243    C     doThetaClimRelax :: Set true if relaxation to temperature
244    C                        climatology is required.
245    C     doSaltClimRelax  :: Set true if relaxation to salinity
246    C                        climatology is required.
247    C     periodicExternalForcing :: Set true if forcing is time-dependant
248    C     usingPCoords     :: Set to indicate that we are working in pressure
249    C                        coords. (jmc: is it still used ?)
250    C     usingZCoords     :: Set to indicate that we are working in height
251    C                        coords. (jmc: is it still used ?)
252    C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
253    C                         this requires specific code for restart & exchange
254    C     setCenterDr    :: set cell Center depth and put Interface at the middle
255    C     nonHydrostatic :: Using non-hydrostatic terms
256    C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
257    C     globalFiles    :: Selects between "global" and "tiled" files
258    C     useSingleCpuIO :: On SGI platforms, option globalFiles is either
259    C                       slow (f77) or does not work (f90).  When
260    C                       useSingleCpuIO is set, mdsio_writefield.F
261    C                       outputs from master mpi process only.
262    C     allowFreezing  :: Allows surface water to freeze and form ice
263    C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
264    C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
265    C     pickup_write_mdsio :: use mdsio to write pickups
266    C     pickup_read_mdsio  :: use mdsio to read  pickups
267    C     pickup_write_immed :: echo the pickup immediately (for conversion)
268    C     timeave_mdsio      :: use mdsio for timeave output
269    C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
270    C     monitor_stdio      :: use stdio for monitor output
271        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
272       & momViscosity, momAdvection, momForcing, useCoriolis,       & usingCurvilinearGrid, usingCylindricalGrid,
273         & no_slip_sides,no_slip_bottom,
274         & staggerTimeStep,
275         & momViscosity, momAdvection, momForcing, useCoriolis,
276         & momPressureForcing, vectorInvariantMomentum,
277       & tempDiffusion, tempAdvection, tempForcing,       & tempDiffusion, tempAdvection, tempForcing,
278       & saltDiffusion, saltAdvection, saltForcing       & saltDiffusion, saltAdvection, saltForcing,
279         & useRealFreshWaterFlux,
280         & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
281         & momStepping, tempStepping, saltStepping,
282         & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
283         & useConstantF, useBetaPlaneF, useSphereF,
284         & useCDscheme,
285         & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
286         & SadournyCoriolis, upwindVorticity, highOrderVorticity,
287         & useAbsVorticity,
288         & implicitDiffusion, implicitViscosity,
289         & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
290         & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,
291         & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
292         & periodicExternalForcing,
293         & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
294         & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
295         & allowFreezing, useOldFreezing, groundAtK1,
296         & usePickupBeforeC35, usePickupBeforeC54, debugMode,
297         & readPickupWithTracer, writePickupWithTracer,
298         & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
299         & timeave_mdsio, snapshot_mdsio, monitor_stdio,
300         & timeave_ioinc, snapshot_ioinc, monitor_ioinc,
301         & pickup_write_ioinc
302    
303        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
304        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
305          LOGICAL usingCylindricalGrid
306          LOGICAL usingCurvilinearGrid
307          LOGICAL usingSphericalPolarMTerms
308          LOGICAL useNHMTerms
309          LOGICAL no_slip_sides
310          LOGICAL no_slip_bottom
311          LOGICAL staggerTimeStep
312        LOGICAL momViscosity        LOGICAL momViscosity
313        LOGICAL momAdvection        LOGICAL momAdvection
314        LOGICAL momForcing        LOGICAL momForcing
315          LOGICAL momPressureForcing
316        LOGICAL useCoriolis        LOGICAL useCoriolis
317          LOGICAL vectorInvariantMomentum
318        LOGICAL tempDiffusion        LOGICAL tempDiffusion
319        LOGICAL tempAdvection        LOGICAL tempAdvection
320        LOGICAL tempForcing        LOGICAL tempForcing
321        LOGICAL saltDiffusion        LOGICAL saltDiffusion
322        LOGICAL saltAdvection        LOGICAL saltAdvection
323        LOGICAL saltForcing        LOGICAL saltForcing
324          LOGICAL useRealFreshWaterFlux
325          LOGICAL rigidLid
326          LOGICAL implicitFreeSurface
327          LOGICAL exactConserv
328          LOGICAL uniformLin_PhiSurf
329          LOGICAL momStepping
330          LOGICAL tempStepping
331          LOGICAL saltStepping
332          LOGICAL metricTerms
333          LOGICAL useConstantF
334          LOGICAL useBetaPlaneF
335          LOGICAL useSphereF
336          LOGICAL useCDscheme
337          LOGICAL useEnergyConservingCoriolis
338          LOGICAL useJamartWetPoints
339          LOGICAL useJamartMomAdv
340          LOGICAL SadournyCoriolis
341          LOGICAL upwindVorticity
342          LOGICAL highOrderVorticity
343          LOGICAL useAbsVorticity
344          LOGICAL implicitDiffusion
345          LOGICAL implicitViscosity
346          LOGICAL tempImplVertAdv
347          LOGICAL saltImplVertAdv
348          LOGICAL momImplVertAdv
349          LOGICAL multiDimAdvection
350          LOGICAL useMultiDimAdvec
351          LOGICAL forcing_In_AB
352          LOGICAL doThetaClimRelax
353          LOGICAL doSaltClimRelax
354          LOGICAL doTr1ClimRelax
355          LOGICAL periodicExternalForcing
356          LOGICAL usingPCoords
357          LOGICAL usingZCoords
358          LOGICAL useDynP_inEos_Zc
359          LOGICAL setCenterDr
360          LOGICAL nonHydrostatic
361          LOGICAL quasiHydrostatic
362          LOGICAL globalFiles
363          LOGICAL useSingleCpuIO
364          LOGICAL allowFreezing
365          LOGICAL useOldFreezing
366          LOGICAL groundAtK1
367          LOGICAL usePickupBeforeC35
368          LOGICAL usePickupBeforeC54
369          LOGICAL debugMode
370          LOGICAL readPickupWithTracer
371          LOGICAL writePickupWithTracer
372          LOGICAL pickup_read_mdsio, pickup_write_mdsio
373          LOGICAL pickup_write_immed
374          LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
375          LOGICAL timeave_ioinc, snapshot_ioinc, monitor_ioinc
376          LOGICAL pickup_write_ioinc
377    
378  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
379  C     cg2dTargetResidual  C     cg2dTargetResidual
380  C               - Target residual for cg2d solver.  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
381  C     cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal.  C     cg2dTargetResWunit
382    C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
383    C     cg3dTargetResidual
384    C               :: Target residual for cg3d solver.
385    C     cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
386  C     Note. 20th May 1998  C     Note. 20th May 1998
387  C           I made a weird discovery! In the model paper we argue  C           I made a weird discovery! In the model paper we argue
388  C           for the form of the preconditioner used here ( see  C           for the form of the preconditioner used here ( see
# Line 119  C           number of iterations for con Line 396  C           number of iterations for con
396  C           drop form 192 -> 134! Need to investigate this further!  C           drop form 192 -> 134! Need to investigate this further!
397  C           For now I have introduced a parameter cg2dpcOffDFac which  C           For now I have introduced a parameter cg2dpcOffDFac which
398  C           defaults to 0.51 but can be set at runtime.  C           defaults to 0.51 but can be set at runtime.
399  C     delZ      - Vertical grid spacing ( m ) - delZ is the distance  C     delR      :: Vertical grid spacing ( units of r ).
400  C                 between "w" surfaces.  C     delRc     :: Vertical grid spacing between cell centers (r unit).
401  C     delX      - Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
402  C     delY        on input flags.  C     delY        on input flags.
403  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
404  C     ronil     - Reference density  C     recip_gravity and its inverse
405  C     startTime - Start time for model ( s )  C     gBaro     :: Accel. due to gravity used in barotropic equation ( m/s^2 )
406  C     phiMin    - Latitude of southern most cell face.  C     rhoNil    :: Reference density for the linear equation of state
407  C     thetaMin  - Longitude of western most cell face (this  C     rhoConst  :: Vertically constant reference density
408    C     rhoConstFresh :: Constant reference density for fresh water (rain)
409    C     tRef      :: reference vertical profile for potential temperature
410    C     sRef      :: reference vertical profile for salinity/specific humidity
411    C     startTime :: Start time for model ( s )
412    C     phiMin    :: Latitude of southern most cell face.
413    C     thetaMin  :: Longitude of western most cell face (this
414  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
415  C                 to make geographical references simple.)  C                 to make geographical references simple.)
416  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).
417  C     f0        - Reference coriolis parameter ( 1/s )  C     recip_RSphere  :: Reciprocal radius of sphere ( m ).
418    C     f0        :: Reference coriolis parameter ( 1/s )
419  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
420  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      :: df/dy ( s^-1.m^-1 )
421  C     viscAh    - Eddy viscosity coeff. for mixing of  C     omega     :: Angular velocity ( rad/s )
422    C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
423    C     viscAh    :: Eddy viscosity coeff. for mixing of
424    C                 momentum laterally ( m^2/s )
425    C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical
426    C                 momentum laterally, no effect for hydrostatic
427    C                 model, defaults to viscAh if unset ( m^2/s )
428    C     viscAr    :: Eddy viscosity coeff. for mixing of
429    C                 momentum vertically ( units of r^2/s )
430    C     viscA4    :: Biharmonic viscosity coeff. for mixing of
431    C                 momentum laterally ( m^4/s )
432    C     viscC2leith :: Leith non-dimensional viscosity factor
433    C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of
434  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
435  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  
436  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
437  C     diffKhT   - Laplacian diffusion coeff. for mixing of  C     viscAhGrid:: non-dimensional grid-size dependent viscosity
438    C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
439    C     viscC4leith :: Leith non-dimensional viscosity factor
440    C     diffKhT   :: Laplacian diffusion coeff. for mixing of
441  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
442  C     diffKzT   - Laplacian diffusion coeff. for mixing of  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
443  C                 heat vertically ( m^2/s )  C                 for mixing of heat vertically ( units of r^2/s )
444  C     diffK4T   - Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
445  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
446  C     diffKhS  -  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
447  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
448  C     diffKzS   - Laplacian diffusion coeff. for mixing of  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
449  C                 salt vertically ( m^2/s )  C                 for mixing of salt vertically ( units of r^2/s ),
450  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
451  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
452  C     deltaT    - Default timestep ( s )  C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
453  C     deltaTClock  - Timestep used as model "clock". This determines the  C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
454    C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979
455    C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979
456    C     deltaT    :: Default timestep ( s )
457    C     deltaTClock  :: Timestep used as model "clock". This determines the
458  C                    IO frequencies and is used in tagging output. It can  C                    IO frequencies and is used in tagging output. It can
459  C                    be totally different to the dynamical time. Typically  C                    be totally different to the dynamical time. Typically
460  C                    it will be the deep-water timestep for accelerated runs.  C                    it will be the deep-water timestep for accelerated runs.
461  C                    Frequency of checkpointing and dumping of the model state  C                    Frequency of checkpointing and dumping of the model state
462  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
463  C     deltaTMom    - Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
464  C     deltaTtracer - Timestep for tracer equations ( s )  C     deltaTtracer :: Timestep for tracer equations ( s )
465  C     tauCD     - CD scheme coupling timescale ( 1/s )  C     deltaTfreesurf :: Timestep for free-surface equation ( s )
466  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C     freesurfFac  :: Parameter to turn implicit free surface term on or off
467  C     GMmaxslope  - max. slope allowed in GM/Redi tensor  C                    freesurfac = 1. uses implicit free surface
468  C     GMlength  - Length to use in Visbeck et al. formula for K  C                    freesurfac = 0. uses rigid lid
469  C     GMalpha   - alpha to use in Visbeck et al. formula for K  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
470  C     GMdepth   - Depth over which to integrate Richardson # (Visbeck et al.)  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
471  C     GMbackground - background value of GM/Redi coefficient  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
472  C     startTime - Starting time for this integration ( s ).  C                     Implicit part of barotropic flow Divergence ( 0-1 )
473  C     endTime   - Ending time for this integration ( s ).  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
474  C     chkPtFreq  - Frequency of rolling check pointing ( s ).  C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)
475  C     pChkPtFreq - Frequency of permanent check pointing ( s ).  C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
476  C     dumpFreq  - Frequency with which model state is written to  C     hFacMinDr    :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
477  C                 post-processing files ( s ).  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
478        COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, delZ, delX, delY,  C     hFacSup        that control vanishing and creating levels
479       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, phiMin,  C     tauCD        :: CD scheme coupling timescale ( 1/s )
480       & thetaMin, rSphere, f0, fCori, beta, viscAh, viscAz, viscA4,  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )
481       & diffKhT, diffKzT, diffK4T, diffKhS, diffKzS, diffK4S, delT,  C     startTime     :: Starting time for this integration ( s ).
482       & tauCD, rCD,  C     endTime       :: Ending time for this integration ( s ).
483       & GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
484       & gravity, rhonil, tRef, sRef,  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
485       & endTime, chkPtFreq, pchkPtFreq, dumpFreq  C     dumpFreq      :: Frequency with which model state is written to
486    C                     post-processing files ( s ).
487    C     diagFreq      :: Frequency with which model writes diagnostic output
488    C                     of intermediate quantities.
489    C     afFacMom      :: Advection of momentum term tracer parameter
490    C     vfFacMom      :: Momentum viscosity tracer parameter
491    C     pfFacMom      :: Momentum pressure forcing tracer parameter
492    C     cfFacMom      :: Coriolis term tracer parameter
493    C     foFacMom      :: Momentum forcing tracer parameter
494    C     mtFacMom      :: Metric terms tracer parameter
495    C     cosPower      :: Power of cosine of latitude to multiply viscosity
496    C     cAdjFreq      :: Frequency of convective adjustment
497    C
498    C     taveFreq      :: Frequency with which time-averaged model state
499    C                      is written to post-processing files ( s ).
500    C     tave_lastIter :: (for state variable only) fraction of the last time
501    C                      step (of each taveFreq period) put in the time average.
502    C                      (fraction for 1rst iter = 1 - tave_lastIter)
503    C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
504    C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
505    C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
506    C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
507    C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
508    C                         i.e. where |yC| <= latBandClimRelax
509    C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
510    C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
511    C                          (note: externForcingCycle must be an integer
512    C                           number times externForcingPeriod)
513    C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
514    C                       (use model surface (local) value if set to -1)
515    C     temp_EvPrRn :: temperature of Rain & Evap.
516    C     salt_EvPrRn :: salinity of Rain & Evap.
517    C     trac_EvPrRn :: tracer concentration in Rain & Evap.
518    C        (notes: a) tracer content of Rain/Evap only used if both
519    C                     NonLin_FrSurf & useRealFreshWater are set.
520    C                b) use model surface (local) value if set to UNSET_RL)
521    C     horiVertRatio      :: Ratio on units in vertical to units in horizontal.
522    C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
523    C                          ( g*rho if horiz in m and vertical in Pa ).
524    C     Ro_SeaLevel        :: standard position of Sea-Level in "R" coordinate, used as
525    C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
526    C     bottomDragLinear   :: Drag coefficient built in to core dynamics
527    C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )
528          COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
529         & cg2dpcOffDFac, cg3dTargetResidual,
530         & delR, delRc, delX, delY,
531         & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,
532         & abeps, startTime,
533         & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
534         & fCori, fCoriG, fCoriCos,
535         & viscAh, viscAhW, viscAhMax, viscAhGrid, viscC2leith,
536         & viscA4,  viscA4Max, viscA4Grid, viscC4leith,
537         & viscAr, viscAstrain, viscAtension,
538         & diffKhT, diffK4T, diffKrNrT,
539         & diffKhS, diffK4S, diffKrNrS,
540         & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
541         & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
542         & hFacMin, hFacMinDz, hFacInf, hFacSup,
543         & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
544         & recip_rhoConst, rhoConst,
545         & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
546         & endTime, chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,
547         & diagFreq, taveFreq, tave_lastIter, monitorFreq,
548         & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
549         & cosPower, cAdjFreq, omega, rotationPeriod,
550         & tauThetaClimRelax, lambdaThetaClimRelax,
551         & tauSaltClimRelax, lambdaSaltClimRelax,
552         & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
553         & externForcingCycle, externForcingPeriod,
554         & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,
555         & hFacMinDr, hFacMinDp,
556         & horiVertRatio, recip_horiVertRatio,
557         & ivdc_kappa, Ro_SeaLevel,
558         & bottomDragLinear,bottomDragQuadratic,
559         & tCyl
560    
561        _RL cg2dTargetResidual        _RL cg2dTargetResidual
562          _RL cg2dTargetResWunit
563          _RL cg3dTargetResidual
564        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
565        _RL delZ(Nz)        _RL delR(Nr)
566          _RL delRc(Nr+1)
567        _RL delX(Nx)        _RL delX(Nx)
568        _RL delY(Ny)        _RL delY(Ny)
569        _RL deltaT        _RL deltaT
570        _RL deltaTClock        _RL deltaTClock
571        _RL deltaTmom        _RL deltaTmom
572        _RL deltaTtracer        _RL deltaTtracer
573          _RL deltaTfreesurf
574        _RL abeps        _RL abeps
575        _RL phiMin        _RL phiMin
576        _RL thetaMin        _RL thetaMin
577        _RL rSphere        _RL rSphere
578          _RL recip_RSphere
579        _RL f0        _RL f0
580          _RL freeSurfFac
581          _RL implicSurfPress
582          _RL implicDiv2Dflow
583          _RL hFacMin
584          _RL hFacMinDz
585          _RL hFacMinDp
586          _RL hFacMinDr
587          _RL hFacInf
588          _RL hFacSup
589        _RL beta        _RL beta
590        _RL viscAh        _RL viscAh
591        _RL viscAz        _RL viscAhW
592          _RL viscAhMax
593          _RL viscAhGrid
594          _RL viscC2leith
595          _RL viscAstrain
596          _RL viscAtension
597          _RL viscAr
598        _RL viscA4        _RL viscA4
599          _RL viscA4Max
600          _RL viscA4Grid
601          _RL viscC4leith
602        _RL diffKhT        _RL diffKhT
603        _RL diffKzT        _RL diffKrNrT(Nr)
604        _RL diffK4T        _RL diffK4T
605        _RL diffKhS        _RL diffKhS
606        _RL diffKzS        _RL diffKrNrS(Nr)
607        _RL diffK4S        _RL diffK4S
608          _RL diffKrBL79surf
609          _RL diffKrBL79deep
610          _RL diffKrBL79scl
611          _RL diffKrBL79Ho
612        _RL delt        _RL delt
613        _RL tauCD        _RL tauCD
614        _RL rCD        _RL rCD
       _RL GMmaxslope  
       _RL GMlength  
       _RL GMalpha  
       _RL GMdepth  
       _RL GMkbackground  
615        _RL gravity        _RL gravity
616          _RL recip_gravity
617          _RL gBaro
618        _RL rhonil        _RL rhonil
619        _RL tRef(Nz)        _RL recip_rhonil
620        _RL sRef(Nz)        _RL rhoConst
621        _RL Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL recip_rhoConst
622          _RL rhoConstFresh
623          _RL convertEmP2rUnit
624          _RL tRef(Nr)
625          _RL sRef(Nr)
626          _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
627          _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
628          _RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
629        _RL startTime        _RL startTime
630        _RL endTime        _RL endTime
631        _RL chkPtFreq        _RL chkPtFreq
632        _RL pChkPtFreq        _RL pChkPtFreq
633        _RL dumpFreq        _RL dumpFreq
634          _RL adjDumpFreq
635          _RL diagFreq
636          _RL taveFreq
637          _RL tave_lastIter
638          _RL monitorFreq
639          _RL afFacMom
640          _RL vfFacMom
641          _RL pfFacMom
642          _RL cfFacMom
643          _RL foFacMom
644          _RL mTFacMom
645          _RL cosPower
646          _RL cAdjFreq
647          _RL omega
648          _RL rotationPeriod
649          _RL tauThetaClimRelax
650          _RL lambdaThetaClimRelax
651          _RL tauSaltClimRelax
652          _RL lambdaSaltClimRelax
653          _RL tauTr1ClimRelax
654          _RL lambdaTr1ClimRelax
655          _RL latBandClimRelax
656          _RL externForcingCycle
657          _RL externForcingPeriod
658          _RL convertFW2Salt
659          _RL temp_EvPrRn
660          _RL salt_EvPrRn
661          _RL trac_EvPrRn
662          _RL horiVertRatio
663          _RL recip_horiVertRatio
664          _RL ivdc_kappa
665          _RL Ro_SeaLevel
666          _RL bottomDragLinear
667          _RL bottomDragQuadratic
668          _RL tCyl
669    
670        COMMON /PARM_A/ HeatCapacity_Cp,  C--   COMMON /PARM_A/ Thermodynamics constants ?
671       &                Lamba_theta        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
672        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
673        _RL Lamba_theta        _RL recip_Cp
674    
675    C--   COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
676    C     celsius2K :: convert centigrade (Celsius) degree to Kelvin
677    C     atm_Po    :: standard reference pressure
678    C     atm_Cp    :: specific heat (Cp) of the (dry) air at constant pressure
679    C     atm_Rd    :: gas constant for dry air
680    C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
681    C     atm_Rq    :: water vapour specific volume anomaly relative to dry air
682    C                  (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
683    C     integr_GeoPot :: option to select the way we integrate the geopotential
684    C                     (still a subject of discussions ...)
685    C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
686    C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
687          COMMON /PARM_ATM/
688         &            celsius2K,
689         &            atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
690         &            integr_GeoPot, selectFindRoSurf
691          _RL celsius2K
692          _RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq
693          INTEGER integr_GeoPot, selectFindRoSurf
694    
695  C Equation of State (polynomial coeffients)  C Logical flags for selecting packages
696        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        LOGICAL useOPPS
697        _RL eosC(Nz+1,9),eosSig0(Nz+1),eosRefT(Nz+1),eosRefS(Nz+1)        LOGICAL usePP81
698  C Linear equation of state        LOGICAL useMY82
699  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).        LOGICAL useGGL90
700  C     sBeta     - Linear EOS haline contraction coefficient.        LOGICAL useKPP
701        COMMON /PARM_EOS_LIN/ tAlpha,sBeta        LOGICAL useGMRedi
702        _RL tAlpha        LOGICAL useOBCS
703        _RL sBeta        LOGICAL useAIM
704          LOGICAL useLand
705          LOGICAL useGrdchk
706          LOGICAL useECCO
707          LOGICAL useSHAP_FILT
708          LOGICAL useZONAL_FILT
709          LOGICAL useFLT
710          LOGICAL usePTRACERS
711          LOGICAL useSBO
712          LOGICAL useSEAICE
713          LOGICAL useBulkForce
714          LOGICAL useThSIce
715          LOGICAL usefizhi
716          LOGICAL usegridalt
717          LOGICAL usediagnostics
718          LOGICAL useEBM
719          LOGICAL useMNC
720          COMMON /PARM_PACKAGES/
721         &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
722         &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
723         &        usePTRACERS,  useSBO, useSEAICE, useThSIce, useBulkForce,
724         &        usefizhi,  usegridalt, usediagnostics, useEBM, useMNC,
725         &        usePP81, useMY82, useOPPS, useGGL90
726    
727    CEH3 ;;; Local Variables: ***
728    CEH3 ;;; mode:fortran ***
729    CEH3 ;;; End: ***

Legend:
Removed from v.1.7  
changed lines
  Added in v.1.132

  ViewVC Help
Powered by ViewVC 1.1.22