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