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

Legend:
Removed from v.1.5  
changed lines
  Added in v.1.144

  ViewVC Help
Powered by ViewVC 1.1.22