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