/[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.72 by adcroft, Fri Jun 21 18:36:04 2002 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     buoyancyRelation :: Flag used to indicate which relation to use to
73    C                        get buoyancy.
74          COMMON /PARM_C/ checkPtSuff,
75         &                bathyFile, topoFile,
76         &                hydrogThetaFile, hydrogSaltFile,
77         &                zonalWindFile, meridWindFile, thetaClimFile,
78         &                saltClimFile, buoyancyRelation,
79         &                EmPmRfile, surfQfile, surfQswfile,
80         &                uVelInitFile, vVelInitFile, pSurfInitFile,
81         &                dQdTfile
82          CHARACTER*(5) checkPtSuff(maxNoChkptLev)
83          CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
84          CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
85          CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
86          CHARACTER*(MAX_LEN_FNAM) zonalWindFile
87          CHARACTER*(MAX_LEN_FNAM) meridWindFile
88          CHARACTER*(MAX_LEN_FNAM) thetaClimFile
89          CHARACTER*(MAX_LEN_FNAM) saltClimFile
90          CHARACTER*(MAX_LEN_FNAM) surfQfile
91          CHARACTER*(MAX_LEN_FNAM) surfQswfile
92          CHARACTER*(MAX_LEN_FNAM) EmPmRfile
93          CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
94          CHARACTER*(MAX_LEN_FNAM) uVelInitFile
95          CHARACTER*(MAX_LEN_FNAM) vVelInitFile
96          CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
97          CHARACTER*(MAX_LEN_FNAM) dQdTfile
98    
99  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
100  C     cg2dMaxIters        - Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
101  C                           two-dimensional con. grad solver.  C                           two-dimensional con. grad solver.
102  C     cg2dChkResFreq      - Frequency with which to check residual  C     cg2dChkResFreq      :: Frequency with which to check residual
103  C                           in con. grad solver.  C                           in con. grad solver.
104  C     nIter0              - Start time-step number of for this run  C     cg3dMaxIters        :: Maximum number of iterations in the
105  C     nTimeSteps          - Number of timesteps to execute  C                           three-dimensional con. grad solver.
106  C     numStepsPerPickup   - For offline setup. Frequency of pickup  C     cg3dChkResFreq      :: Frequency with which to check residual
107    C                           in con. grad solver.
108    C     nIter0              :: Start time-step number of for this run
109    C     nTimeSteps          :: Number of timesteps to execute
110    C     numStepsPerPickup   :: For offline setup. Frequency of pickup
111  C                           of flow fields.  C                           of flow fields.
112    C     writeStatePrec      :: Precision used for writing model state.
113    C     writeBinaryPrec     :: Precision used for writing binary files
114    C     readBinaryPrec      :: Precision used for reading binary files
115    C     nCheckLev           :: Holds current checkpoint level
116    C     nonlinFreeSurf      :: option related to non-linear free surface
117    C                           =0 Linear free surface ; >0 Non-linear
118    
119        COMMON /PARM_I/        COMMON /PARM_I/
120       &        cg2dMaxIters,       &        cg2dMaxIters,
121       &        cg2dChkResFreq,       &        cg2dChkResFreq,
122       &        nIter0, nTimeSteps,       &        cg3dMaxIters,
123       &        numStepsPerPickup       &        cg3dChkResFreq,
124         &        nIter0, nTimeSteps, nEndIter,
125         &        numStepsPerPickup,
126         &        writeStatePrec, nCheckLev,
127         &        writeBinaryPrec, readBinaryPrec,
128         &        nonlinFreeSurf,
129         &        tempAdvScheme, saltAdvScheme, tracerAdvScheme
130        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
131        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
132          INTEGER cg3dMaxIters
133          INTEGER cg3dChkResFreq
134        INTEGER nIter0        INTEGER nIter0
135        INTEGER nTimeSteps        INTEGER nTimeSteps
136          INTEGER nEndIter
137        INTEGER numStepsPerPickup        INTEGER numStepsPerPickup
138          INTEGER writeStatePrec
139          INTEGER writeBinaryPrec
140          INTEGER readBinaryPrec
141          INTEGER nCheckLev
142          INTEGER nonlinFreeSurf
143          INTEGER tempAdvScheme
144          INTEGER saltAdvScheme
145          INTEGER tracerAdvScheme
146    
147  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
148  C     usingCartesianGrid - If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
149  C                          coordinate frame.  C                          coordinate frame.
150  C     usingSphericalPolarGrid - If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
151  C                               spherical polar frame.  C                               spherical polar frame.
152  C     momViscosity  - Flag which turns momentum friction terms on and off.  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.
153  C     momAdvection  - Flag which turns advection of momentum on and off.  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
154  C     momForcing    - Flag which turns external forcing of momentum on  C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
155    C     momViscosity  :: Flag which turns momentum friction terms on and off.
156    C     momAdvection  :: Flag which turns advection of momentum on and off.
157    C     momForcing    :: Flag which turns external forcing of momentum on
158  C                     and off.  C                     and off.
159  C     useCoriolis   - Flag which turns the coriolis terms on and off.  C     momPressureForcing :: Flag which turns pressure term in momentum equation
160  C     tempDiffusion - Flag which turns diffusion of temperature on  C                          on and off.
161    C     metricTerms   :: Flag which turns metric terms on or off.
162    C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
163    C     useCoriolis   :: Flag which turns the coriolis terms on and off.
164    C     tempDiffusion :: Flag which turns diffusion of temperature on
165  C                     and off.  C                     and off.
166  C     tempAdvection - Flag which turns advection of temperature on  C     tempAdvection :: Flag which turns advection of temperature on
167  C                     and off.  C                     and off.
168  C     tempForcing   - Flag which turns external forcing of temperature on  C     tempForcing   :: Flag which turns external forcing of temperature on
169  C                     and off.  C                     and off.
170  C     saltDiffusion - Flag which turns diffusion of salinit on  C     saltDiffusion :: Flag which turns diffusion of salinity on
171  C                     and off.  C                     and off.
172  C     saltAdvection - Flag which turns advection of salinit on  C     saltAdvection :: Flag which turns advection of salinity on
173  C                     and off.  C                     and off.
174  C     saltForcing   - Flag which turns external forcing of salinit on  C     saltForcing   :: Flag which turns external forcing of salinity on
175  C                     and off.  C                     and off.
176    C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
177    C                         as a real Fresh Water (=> changes the Sea Level)
178    C                         if F, converts P+R-E to salt flux (no SL effect)
179    C     rigidLid            :: Set to true to use rigid lid
180    C     implicitFreeSurface :: Set to true to use implcit free surface
181    C     exactConserv        :: Set to true to conserve exactly the total Volume
182    C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
183    C                           linear relation Phi_surf = Bo_surf*eta
184    C     momStepping   :: Turns momentum equation time-stepping off
185    C     tempStepping  :: Turns temperature equation time-stepping off
186    C     saltStepping  :: Turns salinity equation time-stepping off
187    C     tr1Stepping   :: Turns passive tracer 1 time-stepping on/off
188    C     useConstantF  :: Coriolis parameter set to f0
189    C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
190    C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
191    C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
192    C     implicitDiffusion :: Turns implicit vertical diffusion on
193    C     implicitViscosity :: Turns implicit vertical viscosity on
194    C     multiDimAdvection :: Flag that enable multi-dimension advection
195    C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
196    C                      out off Adams-Bashforth time stepping.
197    C     doThetaClimRelax :: Set true if relaxation to temperature
198    C                        climatology is required.
199    C     doSaltClimRelax  :: Set true if relaxation to salinity
200    C                        climatology is required.
201    C     periodicExternalForcing :: Set true if forcing is time-dependant
202    C     usingPCoords     :: Set to indicate that we are working in pressure
203    C                        coords.
204    C     usingZCoords     :: Set to indicate that we are working in height
205    C                        coords.
206    C     setCenterDr    :: set cell Center depth and put Interface at the middle
207    C     nonHydrostatic :: Using non-hydrostatic terms
208    C     globalFiles    :: Selects between "global" and "tiled" files
209    C     allowFreezing  :: Allows water to freeze and form ice
210    C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
211        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
212       & momViscosity, momAdvection, momForcing, useCoriolis,       & usingCurvilinearGrid,
213         & no_slip_sides,no_slip_bottom,
214         & staggerTimeStep,
215         & momViscosity, momAdvection, momForcing, useCoriolis,
216         & momPressureForcing, vectorInvariantMomentum,
217       & tempDiffusion, tempAdvection, tempForcing,       & tempDiffusion, tempAdvection, tempForcing,
218       & saltDiffusion, saltAdvection, saltForcing       & saltDiffusion, saltAdvection, saltForcing,
219         & useRealFreshWaterFlux,
220         & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
221         & momStepping, tempStepping, saltStepping, tr1Stepping,
222         & metricTerms, usingSphericalPolarMTerms,
223         & useConstantF, useBetaPlaneF, useSphereF,
224         & useEnergyConservingCoriolis, useJamartWetPoints,
225         & implicitDiffusion, implicitViscosity,
226         & multiDimAdvection, forcing_In_AB,
227         & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
228         & periodicExternalForcing,
229         & usingPCoords, usingZCoords, setCenterDr,
230         & nonHydrostatic, globalFiles,
231         & allowFreezing, groundAtK1,
232         & usePickupBeforeC35, debugMode,
233         & readPickupWithTracer, writePickupWithTracer
234        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
235        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
236          LOGICAL usingCurvilinearGrid
237          LOGICAL usingSphericalPolarMTerms
238          LOGICAL no_slip_sides
239          LOGICAL no_slip_bottom
240          LOGICAL staggerTimeStep
241        LOGICAL momViscosity        LOGICAL momViscosity
242        LOGICAL momAdvection        LOGICAL momAdvection
243        LOGICAL momForcing        LOGICAL momForcing
244          LOGICAL momPressureForcing
245        LOGICAL useCoriolis        LOGICAL useCoriolis
246          LOGICAL vectorInvariantMomentum
247        LOGICAL tempDiffusion        LOGICAL tempDiffusion
248        LOGICAL tempAdvection        LOGICAL tempAdvection
249        LOGICAL tempForcing        LOGICAL tempForcing
250        LOGICAL saltDiffusion        LOGICAL saltDiffusion
251        LOGICAL saltAdvection        LOGICAL saltAdvection
252        LOGICAL saltForcing        LOGICAL saltForcing
253          LOGICAL useRealFreshWaterFlux
254          LOGICAL rigidLid
255          LOGICAL implicitFreeSurface
256          LOGICAL exactConserv
257          LOGICAL uniformLin_PhiSurf
258          LOGICAL momStepping
259          LOGICAL tempStepping
260          LOGICAL saltStepping
261          LOGICAL tr1Stepping
262          LOGICAL metricTerms
263          LOGICAL useConstantF
264          LOGICAL useBetaPlaneF
265          LOGICAL useSphereF
266          LOGICAL useEnergyConservingCoriolis
267          LOGICAL useJamartWetPoints
268          LOGICAL implicitDiffusion
269          LOGICAL implicitViscosity
270          LOGICAL multiDimAdvection
271          LOGICAL forcing_In_AB
272          LOGICAL doThetaClimRelax
273          LOGICAL doSaltClimRelax
274          LOGICAL doTr1ClimRelax
275          LOGICAL periodicExternalForcing
276          LOGICAL usingPCoords
277          LOGICAL usingZCoords
278          LOGICAL setCenterDr
279          LOGICAL nonHydrostatic
280          LOGICAL globalFiles
281          LOGICAL allowFreezing
282          LOGICAL groundAtK1
283          LOGICAL usePickupBeforeC35
284          LOGICAL debugMode
285          LOGICAL readPickupWithTracer
286          LOGICAL writePickupWithTracer
287    
288  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
289  C     cg2dTargetResidual  C     gg2dTargetResidual
290  C               - Target residual for cg2d solver.  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
291  C     delZ      - Vertical grid spacing ( m ) - delZ is the distance  C     cg2dTargetResWunit
292  C                 between "w" surfaces.  C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
293  C     delX      - Separation between cell faces (m) or (deg), depending  C     cg3dTargetResidual
294    C               :: Target residual for cg3d solver.
295    C     cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
296    C     Note. 20th May 1998
297    C           I made a weird discovery! In the model paper we argue
298    C           for the form of the preconditioner used here ( see
299    C           A Finite-volume, Incompressible Navier-Stokes Model
300    C           ...., Marshall et. al ). The algebra gives a simple
301    C           0.5 factor for the averaging of ac and aCw to get a
302    C           symmettric pre-conditioner. By using a factor of 0.51
303    C           i.e. scaling the off-diagonal terms in the
304    C           preconditioner down slightly I managed to get the
305    C           number of iterations for convergence in a test case to
306    C           drop form 192 -> 134! Need to investigate this further!
307    C           For now I have introduced a parameter cg2dpcOffDFac which
308    C           defaults to 0.51 but can be set at runtime.
309    C     delP      :: Vertical grid spacing ( Pa ).
310    C     delZ      :: Vertical grid spacing ( m  ).
311    C     delR      :: Vertical grid spacing ( units of r ).
312    C     delRc     :: Vertical grid spacing between cell centers (r unit).
313    C     delX      :: Separation between cell faces (m) or (deg), depending
314  C     delY        on input flags.  C     delY        on input flags.
315  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
316  C     ronil     - Reference density  C     recip_gravity and its inverse
317  C     startTime - Start time for model ( s )  C     gBaro     :: Accel. due to gravity used in barotropic equation ( m/s^2 )
318  C     phiMin    - Latitude of southern most cell face.  C     ronil     :: Reference density
319  C     thetaMin  - Longitude of western most cell face (this  C     rhoConst  :: Vertically constant reference density
320    C     startTime :: Start time for model ( s )
321    C     phiMin    :: Latitude of southern most cell face.
322    C     thetaMin  :: Longitude of western most cell face (this
323  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
324  C                 to make geographical references simple.)  C                 to make geographical references simple.)
325  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).
326  C     f0        - Reference coriolis parameter ( 1/s )  C     recip_RSphere  :: Reciprocal radius of sphere ( m ).
327    C     f0        :: Reference coriolis parameter ( 1/s )
328  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
329  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      :: df/dy ( s^-1.m^-1 )
330  C     viscAh    - Eddy viscosity coeff. for mixing of  C     omega     :: Angular velocity ( rad/s )
331    C     viscAh    :: Eddy viscosity coeff. for mixing of
332  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
333  C     viscAz    - Eddy viscosity coeff. for mixing of  C     viscAz    :: Eddy viscosity coeff. for mixing of
334  C                 momentum vertically ( m^2/s )  C                 momentum vertically ( m^2/s )
335  C     viscA4    - Biharmonic viscosity coeff. for mixing of  C     viscAp    :: Eddy viscosity coeff. for mixing of
336    C                 momentum vertically ( Pa^2/s )
337    C     viscAr    :: Eddy viscosity coeff. for mixing of
338    C                 momentum vertically ( units of r^2/s )
339    C     viscA4    :: Biharmonic viscosity coeff. for mixing of
340  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
341  C     diffKhT   - Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
342  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
343  C     diffKzT   - Laplacian diffusion coeff. for mixing of  C     diffKzT   :: Laplacian diffusion coeff. for mixing of
344  C                 heat vertically ( m^2/s )  C                 heat vertically ( m^2/s )
345  C     diffK4T   - Biharmonic diffusion coeff. for mixing of  C     diffKpT   :: Laplacian diffusion coeff. for mixing of
346    C                 heat vertically ( Pa^2/s )
347    C     diffKrT   :: Laplacian diffusion coeff. for mixing of
348    C                 heat vertically ( units of r^2/s )
349    C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
350  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
351  C     diffKhS  -  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
352  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
353  C     diffKzS   - Laplacian diffusion coeff. for mixing of  C     diffKzS   :: Laplacian diffusion coeff. for mixing of
354  C                 salt vertically ( m^2/s )  C                 salt vertically ( m^2/s )
355  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffKpS   :: Laplacian diffusion coeff. for mixing of
356    C                 salt vertically ( Pa^2/s )
357    C     diffKrS   :: Laplacian diffusion coeff. for mixing of
358    C                 salt vertically ( units of r^2/s )
359    C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
360  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
361  C     deltaT    - Default timestep ( s )  C     deltaT    :: Default timestep ( s )
362  C     deltaTMom    - Timestep for momemtum equations ( s )  C     deltaTClock  :: Timestep used as model "clock". This determines the
363  C     deltaTtracer - Timestep for tracer equations ( s )  C                    IO frequencies and is used in tagging output. It can
364  C     tauCD     - CD scheme coupling timescale ( 1/s )  C                    be totally different to the dynamical time. Typically
365  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C                    it will be the deep-water timestep for accelerated runs.
366  C     startTime - Starting time for this integration ( s ).  C                    Frequency of checkpointing and dumping of the model state
367  C     endTime   - Ending time for this integration ( s ).  C                    are referenced to this clock. ( s )
368  C     chkPtFreq - Frequency of check pointing ( s ).  C     deltaTMom    :: Timestep for momemtum equations ( s )
369  C     dumpFreq  - Frequency with which model state is written to  C     deltaTtracer :: Timestep for tracer equations ( s )
370  C                 post-processing files ( s ).  C     deltaTfreesurf :: Timestep for free-surface equation ( s )
371        COMMON /PARM_R/ cg2dTargetResidual, delZ, delX, delY, deltaT,  C     freesurfFac  :: Parameter to turn implicit free surface term on or off
372       & deltaTmom, deltaTtracer, abeps, startTime, phiMin, thetaMin,  C                    freesurfac = 1. uses implicit free surface
373       & rSphere, f0, fCori, beta, viscAh, viscAz, viscA4, diffKhT, diffKzT,  C                    freesurfac = 0. uses rigid lid
374       & diffK4T, diffKhS, diffKzS, diffK4S, delT, tauCD, rCD,  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
375       & tAlpha, sBeta, gravity, rhonil, tRef, sRef,  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
376       & endTime, chkPtFreq, dumpFreq  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
377        REAL cg2dTargetResidual  C                     Implicit part of barotropic flow Divergence ( 0-1 )
378        REAL delZ(Nz)  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
379        REAL delX(Nx)  C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)
380        REAL delY(Ny)  C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
381        REAL deltaT  C     hFacMinDr    :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
382        REAL deltaTmom  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
383        REAL deltaTtracer  C     hFacSup        that control vanishing and creating levels
384        REAL abeps  C     tauCD        :: CD scheme coupling timescale ( 1/s )
385        REAL phiMin  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )
386        REAL thetaMin  C     startTime     :: Starting time for this integration ( s ).
387        REAL rSphere  C     endTime       :: Ending time for this integration ( s ).
388        REAL f0  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
389        _RL  beta  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
390        REAL viscAh  C     dumpFreq      :: Frequency with which model state is written to
391        REAL viscAz  C                     post-processing files ( s ).
392        REAL viscA4  C     diagFreq      :: Frequency with which model writes diagnostic output
393        REAL diffKhT  C                     of intermediate quantities.
394        REAL diffKzT  C     afFacMom      :: Advection of momentum term tracer parameter
395        REAL diffK4T  C     vfFacMom      :: Momentum viscosity tracer parameter
396        REAL diffKhS  C     pfFacMom      :: Momentum pressure forcing tracer parameter
397        REAL diffKzS  C     cfFacMom      :: Coriolis term tracer parameter
398        REAL diffK4S  C     foFacMom      :: Momentum forcing tracer parameter
399        REAL delt  C     mtFacMom      :: Metric terms tracer parameter
400        REAL tauCD  C     cosPower      :: Power of cosine of latitude to multiply viscosity
401        REAL rCD  C     cAdjFreq      :: Frequency of convective adjustment
402        REAL tAlpha  C
403        REAL sBeta  C     taveFreq      :: Frequency with which time-averaged model state is written to
404        REAL gravity  C                     post-processing files ( s ).
405        REAL rhonil  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
406        REAL tRef(Nz)  C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
407        REAL sRef(Nz)  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
408        real Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)  C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
409        REAL startTime  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
410        REAL endTime  C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
411        REAL chkPtFreq  C                          (note: externForcingCycle must be an integer
412        REAL dumpFreq  C                           number times externForcingPeriod)
413        COMMON /PARM_A/ HeatCapacity_Cp,  C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
414    C                       (use model surface (local) value if set to -1)
415    C     temp_EvPrRn :: temperature of Rain & Evap.
416    C     salt_EvPrRn :: salinity of Rain & Evap.
417    C     trac_EvPrRn :: tracer concentration in Rain & Evap.
418    C        (notes: a) tracer content of Rain/Evap only used if both
419    C                     NonLin_FrSurf & useRealFreshWater are set.
420    C                b) use model surface (local) value if set to UNSET_RL)
421    C     horiVertRatio      :: Ratio on units in vertical to units in horizontal.
422    C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
423    C                          ( g*rho if horiz in m and vertical in Pa ).
424    C     Ro_SeaLevel        :: standard position of Sea-Level in "R" coordinate, used as
425    C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
426    C     bottomDragLinear   :: Drag coefficient built in to core dynamics
427    C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )
428          COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
429         & cg2dpcOffDFac, cg3dTargetResidual,
430         & delP, delZ, delR, delRc, delX, delY,
431         & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,
432         & abeps, startTime,
433         & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
434         & fCori, fCoriG,
435         & viscAh,  viscAz,  viscA4,  viscAr, viscAstrain, viscAtension,
436         & diffKhT, diffKzT, diffK4T, diffKrT,
437         & diffKhS, diffKzS, diffK4S, diffKrS,
438         & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
439         & hFacMin, hFacMinDz, hFacInf, hFacSup,
440         & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
441         & recip_rhoConst, rhoConst, tRef, sRef,
442         & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
443         & diagFreq, taveFreq, monitorFreq,
444         & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
445         & cosPower, cAdjFreq, omega,
446         & tauThetaClimRelax, lambdaThetaClimRelax,
447         & tauSaltClimRelax, lambdaSaltClimRelax,
448         & tauTr1ClimRelax, lambdaTr1ClimRelax,
449         & externForcingCycle, externForcingPeriod,
450         & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,
451         & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
452         & horiVertRatio, recip_horiVertRatio,
453         & ivdc_kappa, Ro_SeaLevel,
454         & bottomDragLinear,bottomDragQuadratic
455    
456          _RL cg2dTargetResidual
457          _RL cg2dTargetResWunit
458          _RL cg3dTargetResidual
459          _RL cg2dpcOffDFac
460          _RL delZ(Nr)
461          _RL delP(Nr)
462          _RL delR(Nr)
463          _RL delRc(Nr+1)
464          _RL delX(Nx)
465          _RL delY(Ny)
466          _RL deltaT
467          _RL deltaTClock
468          _RL deltaTmom
469          _RL deltaTtracer
470          _RL deltaTfreesurf
471          _RL abeps
472          _RL phiMin
473          _RL thetaMin
474          _RL rSphere
475          _RL recip_RSphere
476          _RL f0
477          _RL freeSurfFac
478          _RL implicSurfPress
479          _RL implicDiv2Dflow
480          _RL hFacMin
481          _RL hFacMinDz
482          _RL hFacMinDp
483          _RL hFacMinDr
484          _RL hFacInf
485          _RL hFacSup
486          _RL beta
487          _RL viscAh
488          _RL viscAstrain
489          _RL viscAtension
490          _RL viscAz
491          _RL viscAp
492          _RL viscAr
493          _RL viscA4
494          _RL diffKhT
495          _RL diffKrT
496          _RL diffKzT
497          _RL diffKpT
498          _RL diffK4T
499          _RL diffKhS
500          _RL diffKrS
501          _RL diffKzS
502          _RL diffKpS
503          _RL diffK4S
504          _RL delt
505          _RL tauCD
506          _RL rCD
507          _RL gravity
508          _RL recip_gravity
509          _RL gBaro
510          _RL rhonil
511          _RL recip_rhonil
512          _RL rhoConst
513          _RL recip_rhoConst
514          _RL tRef(Nr)
515          _RL sRef(Nr)
516          _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
517          _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
518          _RL startTime
519          _RL endTime
520          _RL chkPtFreq
521          _RL pChkPtFreq
522          _RL dumpFreq
523          _RL diagFreq
524          _RL taveFreq
525          _RL monitorFreq
526          _RL afFacMom
527          _RL vfFacMom
528          _RL pfFacMom
529          _RL cfFacMom
530          _RL foFacMom
531          _RL mTFacMom
532          _RL cosPower
533          _RL cAdjFreq
534          _RL omega
535          _RL tauThetaClimRelax
536          _RL lambdaThetaClimRelax
537          _RL tauSaltClimRelax
538          _RL lambdaSaltClimRelax
539          _RL tauTr1ClimRelax
540          _RL lambdaTr1ClimRelax
541          _RL externForcingCycle
542          _RL externForcingPeriod
543          _RL convertFW2Salt
544          _RL temp_EvPrRn
545          _RL salt_EvPrRn
546          _RL trac_EvPrRn
547          _RL horiVertRatio
548          _RL recip_horiVertRatio
549          _RL ivdc_kappa
550          _RL Ro_SeaLevel
551          _RL bottomDragLinear
552          _RL bottomDragQuadratic
553    
554          COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
555       &                Lamba_theta       &                Lamba_theta
556        REAL HeatCapacity_Cp        _RL HeatCapacity_Cp
557        REAL Lamba_theta        _RL Lamba_theta
558          _RL recip_Cp
559    
560    C Equation of State (polynomial coeffients)
561          COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS
562          _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)
563    C Linear equation of state
564    C     tAlpha    :: Linear EOS thermal expansion coefficient ( 1/degree ).
565    C     sBeta     :: Linear EOS haline contraction coefficient.
566          COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType
567          _RL tAlpha
568          _RL sBeta
569          character*(6) eosType
570    
571    C Atmospheric physical parameters (Ideal Gas EOS, ...)
572    C     atm_po    :: standard reference pressure
573    C     atm_cp    :: specific heat (Cp) of the (dry) air at constant pressure
574    C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
575    C     Integr_GeoPot :: option to select the way we integrate the geopotential
576    C                     (still a subject of discussions ...)
577          COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po,
578         &                  Integr_GeoPot
579          _RL atm_cp, atm_kappa, atm_po
580          INTEGER Integr_GeoPot
581    
582    C Logical flags for selecting packages
583          LOGICAL useKPP
584          LOGICAL useGMRedi
585          LOGICAL useOBCS
586          LOGICAL useAIM
587          LOGICAL useGrdchk
588          LOGICAL useECCO
589          LOGICAL useSHAP_FILT
590          LOGICAL useZONAL_FILT
591          LOGICAL useFLT
592          LOGICAL usePTRACERS
593          COMMON /PARM_PACKAGES/
594         &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,
595         &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
596         &        usePTRACERS
597    
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.72
  ViewVC Help
Powered by ViewVC 1.1.22