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