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