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