/[MITgcm]/MITgcm/model/inc/PARAMS.h
ViewVC logotype

Diff of /MITgcm/model/inc/PARAMS.h

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.3 by cnh, Sun Apr 26 23:41:54 1998 UTC revision 1.96 by jmc, Wed Oct 29 00:17:44 2003 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     implicitDiffusion :: Turns implicit vertical diffusion on
217    C     implicitViscosity :: Turns implicit vertical viscosity on
218    C     multiDimAdvection :: Flag that enable multi-dimension advection
219    C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
220    C                      out off Adams-Bashforth time stepping.
221    C     doThetaClimRelax :: Set true if relaxation to temperature
222    C                        climatology is required.
223    C     doSaltClimRelax  :: Set true if relaxation to salinity
224    C                        climatology is required.
225    C     periodicExternalForcing :: Set true if forcing is time-dependant
226    C     usingPCoords     :: Set to indicate that we are working in pressure
227    C                        coords. (jmc: is it still used ?)
228    C     usingZCoords     :: Set to indicate that we are working in height
229    C                        coords. (jmc: is it still used ?)
230    C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
231    C                         this requires specific code for restart & exchange
232    C     setCenterDr    :: set cell Center depth and put Interface at the middle
233    C     nonHydrostatic :: Using non-hydrostatic terms
234    C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
235    C     globalFiles    :: Selects between "global" and "tiled" files
236    C     useSingleCpuIO :: On SGI platforms, option globalFiles is either
237    C                       slow (f77) or does not work (f90).  When
238    C                       useSingleCpuIO is set, mdsio_writefield.F
239    C                       outputs from master mpi process only.
240    C     allowFreezing  :: Allows water to freeze and form ice
241    C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
242        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
243       & momViscosity, momAdvection, momForcing, useCoriolis,       & usingCurvilinearGrid,
244         & no_slip_sides,no_slip_bottom,
245         & staggerTimeStep,
246         & momViscosity, momAdvection, momForcing, useCoriolis,
247         & momPressureForcing, vectorInvariantMomentum,
248       & tempDiffusion, tempAdvection, tempForcing,       & tempDiffusion, tempAdvection, tempForcing,
249       & saltDiffusion, saltAdvection, saltForcing       & saltDiffusion, saltAdvection, saltForcing,
250         & useRealFreshWaterFlux,
251         & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
252         & momStepping, tempStepping, saltStepping, tr1Stepping,
253         & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
254         & useConstantF, useBetaPlaneF, useSphereF,
255         & useCDscheme,
256         & useEnergyConservingCoriolis, useJamartWetPoints,
257         & implicitDiffusion, implicitViscosity,
258         & multiDimAdvection, forcing_In_AB,
259         & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
260         & periodicExternalForcing,
261         & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
262         & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
263         & allowFreezing, groundAtK1,
264         & usePickupBeforeC35, debugMode,
265         & readPickupWithTracer, writePickupWithTracer
266        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
267        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
268          LOGICAL usingCurvilinearGrid
269          LOGICAL usingSphericalPolarMTerms
270          LOGICAL useNHMTerms
271          LOGICAL no_slip_sides
272          LOGICAL no_slip_bottom
273          LOGICAL staggerTimeStep
274        LOGICAL momViscosity        LOGICAL momViscosity
275        LOGICAL momAdvection        LOGICAL momAdvection
276        LOGICAL momForcing        LOGICAL momForcing
277          LOGICAL momPressureForcing
278        LOGICAL useCoriolis        LOGICAL useCoriolis
279          LOGICAL vectorInvariantMomentum
280        LOGICAL tempDiffusion        LOGICAL tempDiffusion
281        LOGICAL tempAdvection        LOGICAL tempAdvection
282        LOGICAL tempForcing        LOGICAL tempForcing
283        LOGICAL saltDiffusion        LOGICAL saltDiffusion
284        LOGICAL saltAdvection        LOGICAL saltAdvection
285        LOGICAL saltForcing        LOGICAL saltForcing
286          LOGICAL useRealFreshWaterFlux
287          LOGICAL rigidLid
288          LOGICAL implicitFreeSurface
289          LOGICAL exactConserv
290          LOGICAL uniformLin_PhiSurf
291          LOGICAL momStepping
292          LOGICAL tempStepping
293          LOGICAL saltStepping
294          LOGICAL tr1Stepping
295          LOGICAL metricTerms
296          LOGICAL useConstantF
297          LOGICAL useBetaPlaneF
298          LOGICAL useSphereF
299          LOGICAL useCDscheme
300          LOGICAL useEnergyConservingCoriolis
301          LOGICAL useJamartWetPoints
302          LOGICAL implicitDiffusion
303          LOGICAL implicitViscosity
304          LOGICAL multiDimAdvection
305          LOGICAL forcing_In_AB
306          LOGICAL doThetaClimRelax
307          LOGICAL doSaltClimRelax
308          LOGICAL doTr1ClimRelax
309          LOGICAL periodicExternalForcing
310          LOGICAL usingPCoords
311          LOGICAL usingZCoords
312          LOGICAL useDynP_inEos_Zc
313          LOGICAL setCenterDr
314          LOGICAL nonHydrostatic
315          LOGICAL quasiHydrostatic
316          LOGICAL globalFiles
317          LOGICAL useSingleCpuIO
318          LOGICAL allowFreezing
319          LOGICAL groundAtK1
320          LOGICAL usePickupBeforeC35
321          LOGICAL debugMode
322          LOGICAL readPickupWithTracer
323          LOGICAL writePickupWithTracer
324    
325  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
326  C     cg2dTargetResidual  C     gg2dTargetResidual
327  C               - Target residual for cg2d solver.  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
328  C     delZ      - Vertical grid spacing ( m ) - delZ is the distance  C     cg2dTargetResWunit
329  C                 between "w" surfaces.  C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
330  C     delX      - Separation between cell faces (m) or (deg), depending  C     cg3dTargetResidual
331    C               :: Target residual for cg3d solver.
332    C     cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
333    C     Note. 20th May 1998
334    C           I made a weird discovery! In the model paper we argue
335    C           for the form of the preconditioner used here ( see
336    C           A Finite-volume, Incompressible Navier-Stokes Model
337    C           ...., Marshall et. al ). The algebra gives a simple
338    C           0.5 factor for the averaging of ac and aCw to get a
339    C           symmettric pre-conditioner. By using a factor of 0.51
340    C           i.e. scaling the off-diagonal terms in the
341    C           preconditioner down slightly I managed to get the
342    C           number of iterations for convergence in a test case to
343    C           drop form 192 -> 134! Need to investigate this further!
344    C           For now I have introduced a parameter cg2dpcOffDFac which
345    C           defaults to 0.51 but can be set at runtime.
346    C     delR      :: Vertical grid spacing ( units of r ).
347    C     delRc     :: Vertical grid spacing between cell centers (r unit).
348    C     delX      :: Separation between cell faces (m) or (deg), depending
349  C     delY        on input flags.  C     delY        on input flags.
350  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
351  C     ronil     - Reference density  C     recip_gravity and its inverse
352  C     startTime - Start time for model ( s )  C     gBaro     :: Accel. due to gravity used in barotropic equation ( m/s^2 )
353  C     phiMin    - Latitude of southern most cell face.  C     rhoNil    :: Reference density for the linear equation of state
354  C     thetaMin  - Longitude of western most cell face (this  C     rhoConst  :: Vertically constant reference density
355    C     rhoConstFresh :: Constant reference density for fresh water (rain)
356    C     startTime :: Start time for model ( s )
357    C     phiMin    :: Latitude of southern most cell face.
358    C     thetaMin  :: Longitude of western most cell face (this
359  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
360  C                 to make geographical references simple.)  C                 to make geographical references simple.)
361  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).
362  C     f0        - Reference coriolis parameter ( 1/s )  C     recip_RSphere  :: Reciprocal radius of sphere ( m ).
363    C     f0        :: Reference coriolis parameter ( 1/s )
364  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
365  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      :: df/dy ( s^-1.m^-1 )
366  C     viscAh    - Eddy viscosity coeff. for mixing of  C     omega     :: Angular velocity ( rad/s )
367    C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
368    C     viscAh    :: Eddy viscosity coeff. for mixing of
369  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
370  C     viscAz    - Eddy viscosity coeff. for mixing of  C     viscAr    :: Eddy viscosity coeff. for mixing of
371  C                 momentum vertically ( m^2/s )  C                 momentum vertically ( units of r^2/s )
372  C     viscA4    - Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
373  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
374  C     diffKhT   - Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
375  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
376  C     diffKzT   - Laplacian diffusion coeff. for mixing of  C     diffKrT   :: Laplacian diffusion coeff. for mixing of
377  C                 heat vertically ( m^2/s )  C                 heat vertically ( units of r^2/s )
378  C     diffK4T   - Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
379  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
380  C     diffKhS  -  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
381  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
382  C     diffKzS   - Laplacian diffusion coeff. for mixing of  C     diffKrS   :: Laplacian diffusion coeff. for mixing of
383  C                 salt vertically ( m^2/s )  C                 salt vertically ( units of r^2/s )
384  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
385  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
386  C     deltaT    - Default timestep ( s )  C     deltaT    :: Default timestep ( s )
387  C     deltaTMom    - Timestep for momemtum equations ( s )  C     deltaTClock  :: Timestep used as model "clock". This determines the
388  C     deltaTtracer - Timestep for tracer equations ( s )  C                    IO frequencies and is used in tagging output. It can
389  C     tauCD     - CD scheme coupling timescale ( 1/s )  C                    be totally different to the dynamical time. Typically
390  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C                    it will be the deep-water timestep for accelerated runs.
391  C     startTime - Starting time for this integration ( s ).  C                    Frequency of checkpointing and dumping of the model state
392  C     endTime   - Ending time for this integration ( s ).  C                    are referenced to this clock. ( s )
393  C     chkPtFreq - Frequency of check pointing ( s ).  C     deltaTMom    :: Timestep for momemtum equations ( s )
394  C     dumpFreq  - Frequency with which model state is written to  C     deltaTtracer :: Timestep for tracer equations ( s )
395  C                 post-processing files ( s ).  C     deltaTfreesurf :: Timestep for free-surface equation ( s )
396        COMMON /PARM_R/ cg2dTargetResidual, delZ, delX, delY, deltaT,  C     freesurfFac  :: Parameter to turn implicit free surface term on or off
397       & deltaTmom, deltaTtracer, abeps, startTime, phiMin, thetaMin,  C                    freesurfac = 1. uses implicit free surface
398       & rSphere, f0, fCori, beta, viscAh, viscAz, viscA4, diffKhT, diffKzT,  C                    freesurfac = 0. uses rigid lid
399       & diffK4T, diffKhS, diffKzS, diffK4S, delT, tauCD, rCD,  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
400       & tAlpha, sBeta, gravity, rhonil, tRef, sRef,  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
401       & endTime, chkPtFreq, dumpFreq  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
402        REAL cg2dTargetResidual  C                     Implicit part of barotropic flow Divergence ( 0-1 )
403        REAL delZ(Nz)  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
404        REAL delX(Nx)  C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)
405        REAL delY(Ny)  C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
406        REAL deltaT  C     hFacMinDr    :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
407        REAL deltaTmom  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
408        REAL deltaTtracer  C     hFacSup        that control vanishing and creating levels
409        REAL abeps  C     tauCD        :: CD scheme coupling timescale ( 1/s )
410        REAL phiMin  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )
411        REAL thetaMin  C     startTime     :: Starting time for this integration ( s ).
412        REAL rSphere  C     endTime       :: Ending time for this integration ( s ).
413        REAL f0  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
414        _RL  beta  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
415        REAL viscAh  C     dumpFreq      :: Frequency with which model state is written to
416        REAL viscAz  C                     post-processing files ( s ).
417        REAL viscA4  C     diagFreq      :: Frequency with which model writes diagnostic output
418        REAL diffKhT  C                     of intermediate quantities.
419        REAL diffKzT  C     afFacMom      :: Advection of momentum term tracer parameter
420        REAL diffK4T  C     vfFacMom      :: Momentum viscosity tracer parameter
421        REAL diffKhS  C     pfFacMom      :: Momentum pressure forcing tracer parameter
422        REAL diffKzS  C     cfFacMom      :: Coriolis term tracer parameter
423        REAL diffK4S  C     foFacMom      :: Momentum forcing tracer parameter
424        REAL delt  C     mtFacMom      :: Metric terms tracer parameter
425        REAL tauCD  C     cosPower      :: Power of cosine of latitude to multiply viscosity
426        REAL rCD  C     cAdjFreq      :: Frequency of convective adjustment
427        REAL tAlpha  C
428        REAL sBeta  C     taveFreq      :: Frequency with which time-averaged model state
429        REAL gravity  C                      is written to post-processing files ( s ).
430        REAL rhonil  C     tave_lastIter :: (for state variable only) fraction of the last time
431        REAL tRef(Nz)  C                      step (of each taveFreq period) put in the time average.
432        REAL sRef(Nz)  C                      (fraction for 1rst iter = 1 - tave_lastIter)
433        real Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
434        REAL startTime  C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
435        REAL endTime  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
436        REAL chkPtFreq  C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
437        REAL dumpFreq  C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
438        COMMON /PARM_A/ HeatCapacity_Cp,  C                         i.e. where |yC| <= latBandClimRelax
439       &                Lamba_theta  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
440        REAL HeatCapacity_Cp  C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
441        REAL Lamba_theta  C                          (note: externForcingCycle must be an integer
442    C                           number times externForcingPeriod)
443    C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
444    C                       (use model surface (local) value if set to -1)
445    C     temp_EvPrRn :: temperature of Rain & Evap.
446    C     salt_EvPrRn :: salinity of Rain & Evap.
447    C     trac_EvPrRn :: tracer concentration in Rain & Evap.
448    C        (notes: a) tracer content of Rain/Evap only used if both
449    C                     NonLin_FrSurf & useRealFreshWater are set.
450    C                b) use model surface (local) value if set to UNSET_RL)
451    C     horiVertRatio      :: Ratio on units in vertical to units in horizontal.
452    C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
453    C                          ( g*rho if horiz in m and vertical in Pa ).
454    C     Ro_SeaLevel        :: standard position of Sea-Level in "R" coordinate, used as
455    C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
456    C     bottomDragLinear   :: Drag coefficient built in to core dynamics
457    C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )
458          COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
459         & cg2dpcOffDFac, cg3dTargetResidual,
460         & delR, delRc, delX, delY,
461         & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,
462         & abeps, startTime,
463         & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
464         & fCori, fCoriG, fCoriCos,
465         & viscAh,  viscA4,  viscAr, viscAstrain, viscAtension,
466         & diffKhT, diffK4T, diffKrT,
467         & diffKhS, diffK4S, diffKrS,
468         & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
469         & hFacMin, hFacMinDz, hFacInf, hFacSup,
470         & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
471         & recip_rhoConst, rhoConst,
472         & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
473         & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
474         & diagFreq, taveFreq, tave_lastIter, monitorFreq,
475         & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
476         & cosPower, cAdjFreq, omega, rotationPeriod,
477         & tauThetaClimRelax, lambdaThetaClimRelax,
478         & tauSaltClimRelax, lambdaSaltClimRelax,
479         & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
480         & externForcingCycle, externForcingPeriod,
481         & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,
482         & hFacMinDr, hFacMinDp,
483         & horiVertRatio, recip_horiVertRatio,
484         & ivdc_kappa, Ro_SeaLevel,
485         & bottomDragLinear,bottomDragQuadratic
486    
487          _RL cg2dTargetResidual
488          _RL cg2dTargetResWunit
489          _RL cg3dTargetResidual
490          _RL cg2dpcOffDFac
491          _RL delR(Nr)
492          _RL delRc(Nr+1)
493          _RL delX(Nx)
494          _RL delY(Ny)
495          _RL deltaT
496          _RL deltaTClock
497          _RL deltaTmom
498          _RL deltaTtracer
499          _RL deltaTfreesurf
500          _RL abeps
501          _RL phiMin
502          _RL thetaMin
503          _RL rSphere
504          _RL recip_RSphere
505          _RL f0
506          _RL freeSurfFac
507          _RL implicSurfPress
508          _RL implicDiv2Dflow
509          _RL hFacMin
510          _RL hFacMinDz
511          _RL hFacMinDp
512          _RL hFacMinDr
513          _RL hFacInf
514          _RL hFacSup
515          _RL beta
516          _RL viscAh
517          _RL viscAstrain
518          _RL viscAtension
519          _RL viscAr
520          _RL viscA4
521          _RL diffKhT
522          _RL diffKrT
523          _RL diffK4T
524          _RL diffKhS
525          _RL diffKrS
526          _RL diffK4S
527          _RL delt
528          _RL tauCD
529          _RL rCD
530          _RL gravity
531          _RL recip_gravity
532          _RL gBaro
533          _RL rhonil
534          _RL recip_rhonil
535          _RL rhoConst
536          _RL recip_rhoConst
537          _RL rhoConstFresh
538          _RL convertEmP2rUnit
539          _RL tRef(Nr)
540          _RL sRef(Nr)
541          _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
542          _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
543          _RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
544          _RL startTime
545          _RL endTime
546          _RL chkPtFreq
547          _RL pChkPtFreq
548          _RL dumpFreq
549          _RL diagFreq
550          _RL taveFreq
551          _RL tave_lastIter
552          _RL monitorFreq
553          _RL afFacMom
554          _RL vfFacMom
555          _RL pfFacMom
556          _RL cfFacMom
557          _RL foFacMom
558          _RL mTFacMom
559          _RL cosPower
560          _RL cAdjFreq
561          _RL omega
562          _RL rotationPeriod
563          _RL tauThetaClimRelax
564          _RL lambdaThetaClimRelax
565          _RL tauSaltClimRelax
566          _RL lambdaSaltClimRelax
567          _RL tauTr1ClimRelax
568          _RL lambdaTr1ClimRelax
569          _RL latBandClimRelax
570          _RL externForcingCycle
571          _RL externForcingPeriod
572          _RL convertFW2Salt
573          _RL temp_EvPrRn
574          _RL salt_EvPrRn
575          _RL trac_EvPrRn
576          _RL horiVertRatio
577          _RL recip_horiVertRatio
578          _RL ivdc_kappa
579          _RL Ro_SeaLevel
580          _RL bottomDragLinear
581          _RL bottomDragQuadratic
582    
583    C--   COMMON /PARM_A/ Thermodynamics constants ?
584          COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
585          _RL HeatCapacity_Cp
586          _RL recip_Cp
587    
588    C--   COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
589    C     celsius2K :: convert centigrade (Celsius) degree to Kelvin
590    C     atm_Po    :: standard reference pressure
591    C     atm_Cp    :: specific heat (Cp) of the (dry) air at constant pressure
592    C     atm_Rd    :: gas constant for dry air
593    C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
594    C     atm_Rq    :: water vapour specific volume anomaly relative to dry air
595    C                  (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
596    C     integr_GeoPot :: option to select the way we integrate the geopotential
597    C                     (still a subject of discussions ...)
598    C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
599    C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
600          COMMON /PARM_ATM/
601         &            celsius2K,
602         &            atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
603         &            integr_GeoPot, selectFindRoSurf
604          _RL celsius2K
605          _RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq
606          INTEGER integr_GeoPot, selectFindRoSurf
607    
608    C Logical flags for selecting packages
609          LOGICAL useKPP
610          LOGICAL useGMRedi
611          LOGICAL useOBCS
612          LOGICAL useAIM
613          LOGICAL useLand
614          LOGICAL useGrdchk
615          LOGICAL useECCO
616          LOGICAL useSHAP_FILT
617          LOGICAL useZONAL_FILT
618          LOGICAL useFLT
619          LOGICAL usePTRACERS
620          LOGICAL useSBO
621          LOGICAL useSEAICE
622          LOGICAL useBulkforce
623          LOGICAL useThermSEAICE
624          COMMON /PARM_PACKAGES/
625         &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
626         &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
627         &        usePTRACERS,  useSBO, useSEAICE,
628         &        useThermSEAICE, useBulkforce
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.96
  ViewVC Help
Powered by ViewVC 1.1.22