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

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

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

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