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