/[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.87 by jmc, Tue Feb 18 15:12:17 2003 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2    C $Name$
3  C  C
4  C     /==========================================================\  CBOP
5  C     | PARAMS.h                                                 |  C    !ROUTINE: PARAMS.h
6  C     | o Header file defining model "parameters".               |  C    !INTERFACE:
7  C     |==========================================================|  C    include PARAMS.h
8  C     | The values from the model's standard input file are      |  C    !DESCRIPTION: \bv
9  C     | stored into the variables held here. Notes describing    |  C     *==========================================================*
10  C     | the parameters can also be found here.                   |  C     | PARAMS.h                                                  
11  C     \==========================================================/  C     | o Header file defining model "parameters".                
12    C     *==========================================================*
13    C     | The values from the model standard input file are        
14    C     | stored into the variables held here. Notes describing    
15    C     | the parameters can also be found here.                    
16    C     *==========================================================*
17    C     \ev
18    CEOP
19    
20    C     Macros for special grid options
21    #include "PARAMS_MACROS.h"
22    
23  C--   Contants  C--   Contants
 C     nOBands - No. of offline data time bands  
       INTEGER nOBands  
       PARAMETER ( nOBands = 12 )  
24  C     Useful physical values  C     Useful physical values
25        Real*8 PI        Real*8 PI
26        PARAMETER ( PI    = 3.14159265358979323844D0   )        PARAMETER ( PI    = 3.14159265358979323844D0   )
27        Real*8 deg2rad        Real*8 deg2rad
28        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )        PARAMETER ( deg2rad = 2.D0*PI/360.D0           )
29    
30    C     Symbolic values
31    C     precXXXX :: Used to indicate what precision to use for
32    C                dumping model state.
33          INTEGER precFloat32
34          PARAMETER ( precFloat32 = 32 )
35          INTEGER precFloat64
36          PARAMETER ( precFloat64 = 64 )
37    C     UNSET_xxx :: Used to indicate variables that have not been given a value
38          Real*8 UNSET_FLOAT8
39          PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
40          Real*4 UNSET_FLOAT4
41          PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )
42          _RL    UNSET_RL    
43          PARAMETER ( UNSET_RL     = 1.234567D5 )
44          _RS    UNSET_RS    
45          PARAMETER ( UNSET_RS     = 1.234567E5 )
46          INTEGER UNSET_I
47          PARAMETER ( UNSET_I      = 123456789  )
48    
49    C     Checkpoint data
50          INTEGER maxNoChkptLev
51          PARAMETER ( maxNoChkptLev = 2 )
52    
53  C--   COMMON /PARM_C/ Character valued parameters used by the model.  C--   COMMON /PARM_C/ Character valued parameters used by the model.
54  C     oBandId  - Offline dataset identifiers for different periods.  C     checkPtSuff :: List of checkpoint file suffices
55        COMMON /PARM_C/ oBandId  C     bathyFile   :: File containing bathymetry. If not defined bathymetry
56        CHARACTER*3 oBandId(nOBands)  C                   is taken from inline function.
57    C     topoFile    :: File containing the topography of the surface (unit=m)
58    C                   (mainly used for the atmosphere = ground height).
59    C     hydrogThetaFile :: File containing initial hydrographic data for potential
60    C                       temperature.
61    C     hydrogSaltFile  :: File containing initial hydrographic data for salinity.
62    C     zonalWindFile   :: File containing zonal wind data
63    C     meridWindFile   :: File containing meridional wind data
64    C     thetaClimFile   :: File containing theta climataology used
65    C                       in relaxation term -lambda(theta-theta*)
66    C     saltClimFile    :: File containing salt climataology used
67    C                       in relaxation term -lambda(salt-salt*)
68    C     surfQfile       :: File containing surface heat flux
69    C     surfQswfile     :: File containing surface shortwave radiation
70    C     dQdTfile        :: File containing thermal relaxation coefficient
71    C     EmPmRfile       :: File containing surface fresh water flux
72    C     pLoadFile       :: File containing pressure loading
73    C     buoyancyRelation :: Flag used to indicate which relation to use to
74    C                        get buoyancy.
75    C     eosType         :: choose the equation of state:
76    C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
77          COMMON /PARM_C/ checkPtSuff,
78         &                bathyFile, topoFile,
79         &                hydrogThetaFile, hydrogSaltFile,
80         &                zonalWindFile, meridWindFile, thetaClimFile,
81         &                saltClimFile, buoyancyRelation,
82         &                EmPmRfile, surfQfile, surfQswfile,
83         &                uVelInitFile, vVelInitFile, pSurfInitFile,
84         &                dQdTfile, ploadFile,
85         &                eosType
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. (jmc: is it still used ?)
214    C     usingZCoords     :: Set to indicate that we are working in height
215    C                        coords. (jmc: is it still used ?)
216    C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
217    C                         this requires specific code for restart & exchange
218    C     setCenterDr    :: set cell Center depth and put Interface at the middle
219    C     nonHydrostatic :: Using non-hydrostatic terms
220    C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
221    C     globalFiles    :: Selects between "global" and "tiled" files
222    C     useSingleCpuIO :: On SGI platforms, option globalFiles is either
223    C                       slow (f77) or does not work (f90).  When
224    C                       useSingleCpuIO is set, mdsio_writefield.F
225    C                       outputs from master mpi process only.
226    C     allowFreezing  :: Allows water to freeze and form ice
227    C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
228        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
229       & momViscosity, momAdvection, momForcing, useCoriolis,       & usingCurvilinearGrid,
230         & no_slip_sides,no_slip_bottom,
231         & staggerTimeStep,
232         & momViscosity, momAdvection, momForcing, useCoriolis,
233         & momPressureForcing, vectorInvariantMomentum,
234       & tempDiffusion, tempAdvection, tempForcing,       & tempDiffusion, tempAdvection, tempForcing,
235       & saltDiffusion, saltAdvection, saltForcing       & saltDiffusion, saltAdvection, saltForcing,
236         & useRealFreshWaterFlux,
237         & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
238         & momStepping, tempStepping, saltStepping, tr1Stepping,
239         & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
240         & useConstantF, useBetaPlaneF, useSphereF,
241         & useEnergyConservingCoriolis, useJamartWetPoints,
242         & implicitDiffusion, implicitViscosity,
243         & multiDimAdvection, forcing_In_AB,
244         & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
245         & periodicExternalForcing,
246         & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
247         & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
248         & allowFreezing, groundAtK1,
249         & usePickupBeforeC35, debugMode,
250         & readPickupWithTracer, writePickupWithTracer
251        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
252        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
253          LOGICAL usingCurvilinearGrid
254          LOGICAL usingSphericalPolarMTerms
255          LOGICAL useNHMTerms
256          LOGICAL no_slip_sides
257          LOGICAL no_slip_bottom
258          LOGICAL staggerTimeStep
259        LOGICAL momViscosity        LOGICAL momViscosity
260        LOGICAL momAdvection        LOGICAL momAdvection
261        LOGICAL momForcing        LOGICAL momForcing
262          LOGICAL momPressureForcing
263        LOGICAL useCoriolis        LOGICAL useCoriolis
264          LOGICAL vectorInvariantMomentum
265        LOGICAL tempDiffusion        LOGICAL tempDiffusion
266        LOGICAL tempAdvection        LOGICAL tempAdvection
267        LOGICAL tempForcing        LOGICAL tempForcing
268        LOGICAL saltDiffusion        LOGICAL saltDiffusion
269        LOGICAL saltAdvection        LOGICAL saltAdvection
270        LOGICAL saltForcing        LOGICAL saltForcing
271          LOGICAL useRealFreshWaterFlux
272          LOGICAL rigidLid
273          LOGICAL implicitFreeSurface
274          LOGICAL exactConserv
275          LOGICAL uniformLin_PhiSurf
276          LOGICAL momStepping
277          LOGICAL tempStepping
278          LOGICAL saltStepping
279          LOGICAL tr1Stepping
280          LOGICAL metricTerms
281          LOGICAL useConstantF
282          LOGICAL useBetaPlaneF
283          LOGICAL useSphereF
284          LOGICAL useEnergyConservingCoriolis
285          LOGICAL useJamartWetPoints
286          LOGICAL implicitDiffusion
287          LOGICAL implicitViscosity
288          LOGICAL multiDimAdvection
289          LOGICAL forcing_In_AB
290          LOGICAL doThetaClimRelax
291          LOGICAL doSaltClimRelax
292          LOGICAL doTr1ClimRelax
293          LOGICAL periodicExternalForcing
294          LOGICAL usingPCoords
295          LOGICAL usingZCoords
296          LOGICAL useDynP_inEos_Zc
297          LOGICAL setCenterDr
298          LOGICAL nonHydrostatic
299          LOGICAL quasiHydrostatic
300          LOGICAL globalFiles
301          LOGICAL useSingleCpuIO
302          LOGICAL allowFreezing
303          LOGICAL groundAtK1
304          LOGICAL usePickupBeforeC35
305          LOGICAL debugMode
306          LOGICAL readPickupWithTracer
307          LOGICAL writePickupWithTracer
308    
309  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
310  C     cg2dTargetResidual  C     gg2dTargetResidual
311  C               - Target residual for cg2d solver.  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
312  C     delZ      - Vertical grid spacing ( m ) - delZ is the distance  C     cg2dTargetResWunit
313  C                 between "w" surfaces.  C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
314  C     delX      - Separation between cell faces (m) or (deg), depending  C     cg3dTargetResidual
315    C               :: Target residual for cg3d solver.
316    C     cg2dpcOffDFac :: Averaging weight for preconditioner off-diagonal.
317    C     Note. 20th May 1998
318    C           I made a weird discovery! In the model paper we argue
319    C           for the form of the preconditioner used here ( see
320    C           A Finite-volume, Incompressible Navier-Stokes Model
321    C           ...., Marshall et. al ). The algebra gives a simple
322    C           0.5 factor for the averaging of ac and aCw to get a
323    C           symmettric pre-conditioner. By using a factor of 0.51
324    C           i.e. scaling the off-diagonal terms in the
325    C           preconditioner down slightly I managed to get the
326    C           number of iterations for convergence in a test case to
327    C           drop form 192 -> 134! Need to investigate this further!
328    C           For now I have introduced a parameter cg2dpcOffDFac which
329    C           defaults to 0.51 but can be set at runtime.
330    C     delP      :: Vertical grid spacing ( Pa ).
331    C     delZ      :: Vertical grid spacing ( m  ).
332    C     delR      :: Vertical grid spacing ( units of r ).
333    C     delRc     :: Vertical grid spacing between cell centers (r unit).
334    C     delX      :: Separation between cell faces (m) or (deg), depending
335  C     delY        on input flags.  C     delY        on input flags.
336  C     gravity   - Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
337  C     ronil     - Reference density  C     recip_gravity and its inverse
338  C     startTime - Start time for model ( s )  C     gBaro     :: Accel. due to gravity used in barotropic equation ( m/s^2 )
339  C     phiMin    - Latitude of southern most cell face.  C     rhoNil    :: Reference density for the linear equation of state
340  C     thetaMin  - Longitude of western most cell face (this  C     rhoConst  :: Vertically constant reference density
341    C     rhoConstFresh :: Constant reference density for fresh water (rain)
342    C     startTime :: Start time for model ( s )
343    C     phiMin    :: Latitude of southern most cell face.
344    C     thetaMin  :: Longitude of western most cell face (this
345  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
346  C                 to make geographical references simple.)  C                 to make geographical references simple.)
347  C     rSphere   - Radius of sphere for a spherical polar grid ( m ).  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).
348  C     f0        - Reference coriolis parameter ( 1/s )  C     recip_RSphere  :: Reciprocal radius of sphere ( m ).
349    C     f0        :: Reference coriolis parameter ( 1/s )
350  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
351  C     beta      - df/dy ( s^-1.m^-1 )  C     beta      :: df/dy ( s^-1.m^-1 )
352  C     viscAh    - Eddy viscosity coeff. for mixing of  C     omega     :: Angular velocity ( rad/s )
353    C     viscAh    :: Eddy viscosity coeff. for mixing of
354  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
355  C     viscAz    - Eddy viscosity coeff. for mixing of  C     viscAz    :: Eddy viscosity coeff. for mixing of
356  C                 momentum vertically ( m^2/s )  C                 momentum vertically ( m^2/s )
357  C     viscA4    - Biharmonic viscosity coeff. for mixing of  C     viscAp    :: Eddy viscosity coeff. for mixing of
358    C                 momentum vertically ( Pa^2/s )
359    C     viscAr    :: Eddy viscosity coeff. for mixing of
360    C                 momentum vertically ( units of r^2/s )
361    C     viscA4    :: Biharmonic viscosity coeff. for mixing of
362  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
363  C     diffKhT   - Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
364  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
365  C     diffKzT   - Laplacian diffusion coeff. for mixing of  C     diffKzT   :: Laplacian diffusion coeff. for mixing of
366  C                 heat vertically ( m^2/s )  C                 heat vertically ( m^2/s )
367  C     diffK4T   - Biharmonic diffusion coeff. for mixing of  C     diffKpT   :: Laplacian diffusion coeff. for mixing of
368    C                 heat vertically ( Pa^2/s )
369    C     diffKrT   :: Laplacian diffusion coeff. for mixing of
370    C                 heat vertically ( units of r^2/s )
371    C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
372  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
373  C     diffKhS  -  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
374  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
375  C     diffKzS   - Laplacian diffusion coeff. for mixing of  C     diffKzS   :: Laplacian diffusion coeff. for mixing of
376  C                 salt vertically ( m^2/s )  C                 salt vertically ( m^2/s )
377  C     diffK4S   - Biharmonic diffusion coeff. for mixing of  C     diffKpS   :: Laplacian diffusion coeff. for mixing of
378    C                 salt vertically ( Pa^2/s )
379    C     diffKrS   :: Laplacian diffusion coeff. for mixing of
380    C                 salt vertically ( units of r^2/s )
381    C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
382  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
383  C     deltaT    - Default timestep ( s )  C     deltaT    :: Default timestep ( s )
384  C     deltaTMom    - Timestep for momemtum equations ( s )  C     deltaTClock  :: Timestep used as model "clock". This determines the
385  C     deltaTtracer - Timestep for tracer equations ( s )  C                    IO frequencies and is used in tagging output. It can
386  C     tauCD     - CD scheme coupling timescale ( 1/s )  C                    be totally different to the dynamical time. Typically
387  C     rCD       - CD scheme normalised coupling parameter ( 0-1 )  C                    it will be the deep-water timestep for accelerated runs.
388  C     startTime - Starting time for this integration ( s ).  C                    Frequency of checkpointing and dumping of the model state
389  C     endTime   - Ending time for this integration ( s ).  C                    are referenced to this clock. ( s )
390  C     chkPtFreq - Frequency of check pointing ( s ).  C     deltaTMom    :: Timestep for momemtum equations ( s )
391  C     dumpFreq  - Frequency with which model state is written to  C     deltaTtracer :: Timestep for tracer equations ( s )
392  C                 post-processing files ( s ).  C     deltaTfreesurf :: Timestep for free-surface equation ( s )
393        COMMON /PARM_R/ cg2dTargetResidual, delZ, delX, delY, deltaT,  C     freesurfFac  :: Parameter to turn implicit free surface term on or off
394       & deltaTmom, deltaTtracer, abeps, startTime, phiMin, thetaMin,  C                    freesurfac = 1. uses implicit free surface
395       & rSphere, f0, fCori, beta, viscAh, viscAz, viscA4, diffKhT, diffKzT,  C                    freesurfac = 0. uses rigid lid
396       & diffK4T, diffKhS, diffKzS, diffK4S, delT, tauCD, rCD,  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
397       & gravity, rhonil, tRef, sRef,  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
398       & endTime, chkPtFreq, dumpFreq  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
399        REAL cg2dTargetResidual  C                     Implicit part of barotropic flow Divergence ( 0-1 )
400        REAL delZ(Nz)  C     hFacMin      :: Minimum fraction size of a cell (affects hFacC etc...)
401        REAL delX(Nx)  C     hFacMinDz    :: Minimum dimesional size of a cell (affects hFacC etc..., m)
402        REAL delY(Ny)  C     hFacMinDp    :: Minimum dimesional size of a cell (affects hFacC etc..., Pa)
403        REAL deltaT  C     hFacMinDr    :: Minimum dimesional size of a cell (affects hFacC etc..., units of r)
404        REAL deltaTmom  C     hFacInf      :: Threshold (inf and sup) for fraction size of surface cell
405        REAL deltaTtracer  C     hFacSup        that control vanishing and creating levels
406        REAL abeps  C     tauCD        :: CD scheme coupling timescale ( 1/s )
407        REAL phiMin  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )
408        REAL thetaMin  C     startTime     :: Starting time for this integration ( s ).
409        REAL rSphere  C     endTime       :: Ending time for this integration ( s ).
410        REAL f0  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
411        _RL  beta  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
412        REAL viscAh  C     dumpFreq      :: Frequency with which model state is written to
413        REAL viscAz  C                     post-processing files ( s ).
414        REAL viscA4  C     diagFreq      :: Frequency with which model writes diagnostic output
415        REAL diffKhT  C                     of intermediate quantities.
416        REAL diffKzT  C     afFacMom      :: Advection of momentum term tracer parameter
417        REAL diffK4T  C     vfFacMom      :: Momentum viscosity tracer parameter
418        REAL diffKhS  C     pfFacMom      :: Momentum pressure forcing tracer parameter
419        REAL diffKzS  C     cfFacMom      :: Coriolis term tracer parameter
420        REAL diffK4S  C     foFacMom      :: Momentum forcing tracer parameter
421        REAL delt  C     mtFacMom      :: Metric terms tracer parameter
422        REAL tauCD  C     cosPower      :: Power of cosine of latitude to multiply viscosity
423        REAL rCD  C     cAdjFreq      :: Frequency of convective adjustment
424        REAL gravity  C
425        REAL rhonil  C     taveFreq      :: Frequency with which time-averaged model state
426        REAL tRef(Nz)  C                      is written to post-processing files ( s ).
427        REAL sRef(Nz)  C     tave_lastIter :: (for state variable only) fraction of the last time
428        real Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)  C                      step (of each taveFreq period) put in the time average.
429        REAL startTime  C                      (fraction for 1rst iter = 1 - tave_lastIter)
430        REAL endTime  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
431        REAL chkPtFreq  C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
432        REAL dumpFreq  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
433        COMMON /PARM_A/ HeatCapacity_Cp,  C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
434    C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
435    C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
436    C                          (note: externForcingCycle must be an integer
437    C                           number times externForcingPeriod)
438    C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
439    C                       (use model surface (local) value if set to -1)
440    C     temp_EvPrRn :: temperature of Rain & Evap.
441    C     salt_EvPrRn :: salinity of Rain & Evap.
442    C     trac_EvPrRn :: tracer concentration in Rain & Evap.
443    C        (notes: a) tracer content of Rain/Evap only used if both
444    C                     NonLin_FrSurf & useRealFreshWater are set.
445    C                b) use model surface (local) value if set to UNSET_RL)
446    C     horiVertRatio      :: Ratio on units in vertical to units in horizontal.
447    C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
448    C                          ( g*rho if horiz in m and vertical in Pa ).
449    C     Ro_SeaLevel        :: standard position of Sea-Level in "R" coordinate, used as
450    C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
451    C     bottomDragLinear   :: Drag coefficient built in to core dynamics
452    C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )
453          COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
454         & cg2dpcOffDFac, cg3dTargetResidual,
455         & delP, delZ, delR, delRc, delX, delY,
456         & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,
457         & abeps, startTime,
458         & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
459         & fCori, fCoriG, fCoriCos,
460         & viscAh,  viscAz,  viscA4,  viscAr, viscAstrain, viscAtension,
461         & diffKhT, diffKzT, diffK4T, diffKrT,
462         & diffKhS, diffKzS, diffK4S, diffKrS,
463         & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
464         & hFacMin, hFacMinDz, hFacInf, hFacSup,
465         & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
466         & recip_rhoConst, rhoConst,
467         & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
468         & endTime, chkPtFreq, pchkPtFreq, dumpFreq,
469         & diagFreq, taveFreq, tave_lastIter, monitorFreq,
470         & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
471         & cosPower, cAdjFreq, omega,
472         & tauThetaClimRelax, lambdaThetaClimRelax,
473         & tauSaltClimRelax, lambdaSaltClimRelax,
474         & tauTr1ClimRelax, lambdaTr1ClimRelax,
475         & externForcingCycle, externForcingPeriod,
476         & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,
477         & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
478         & horiVertRatio, recip_horiVertRatio,
479         & ivdc_kappa, Ro_SeaLevel,
480         & bottomDragLinear,bottomDragQuadratic
481    
482          _RL cg2dTargetResidual
483          _RL cg2dTargetResWunit
484          _RL cg3dTargetResidual
485          _RL cg2dpcOffDFac
486          _RL delZ(Nr)
487          _RL delP(Nr)
488          _RL delR(Nr)
489          _RL delRc(Nr+1)
490          _RL delX(Nx)
491          _RL delY(Ny)
492          _RL deltaT
493          _RL deltaTClock
494          _RL deltaTmom
495          _RL deltaTtracer
496          _RL deltaTfreesurf
497          _RL abeps
498          _RL phiMin
499          _RL thetaMin
500          _RL rSphere
501          _RL recip_RSphere
502          _RL f0
503          _RL freeSurfFac
504          _RL implicSurfPress
505          _RL implicDiv2Dflow
506          _RL hFacMin
507          _RL hFacMinDz
508          _RL hFacMinDp
509          _RL hFacMinDr
510          _RL hFacInf
511          _RL hFacSup
512          _RL beta
513          _RL viscAh
514          _RL viscAstrain
515          _RL viscAtension
516          _RL viscAz
517          _RL viscAp
518          _RL viscAr
519          _RL viscA4
520          _RL diffKhT
521          _RL diffKrT
522          _RL diffKzT
523          _RL diffKpT
524          _RL diffK4T
525          _RL diffKhS
526          _RL diffKrS
527          _RL diffKzS
528          _RL diffKpS
529          _RL diffK4S
530          _RL delt
531          _RL tauCD
532          _RL rCD
533          _RL gravity
534          _RL recip_gravity
535          _RL gBaro
536          _RL rhonil
537          _RL recip_rhonil
538          _RL rhoConst
539          _RL recip_rhoConst
540          _RL rhoConstFresh
541          _RL convertEmP2rUnit
542          _RL tRef(Nr)
543          _RL sRef(Nr)
544          _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
545          _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
546          _RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
547          _RL startTime
548          _RL endTime
549          _RL chkPtFreq
550          _RL pChkPtFreq
551          _RL dumpFreq
552          _RL diagFreq
553          _RL taveFreq
554          _RL tave_lastIter
555          _RL monitorFreq
556          _RL afFacMom
557          _RL vfFacMom
558          _RL pfFacMom
559          _RL cfFacMom
560          _RL foFacMom
561          _RL mTFacMom
562          _RL cosPower
563          _RL cAdjFreq
564          _RL omega
565          _RL tauThetaClimRelax
566          _RL lambdaThetaClimRelax
567          _RL tauSaltClimRelax
568          _RL lambdaSaltClimRelax
569          _RL tauTr1ClimRelax
570          _RL lambdaTr1ClimRelax
571          _RL externForcingCycle
572          _RL externForcingPeriod
573          _RL convertFW2Salt
574          _RL temp_EvPrRn
575          _RL salt_EvPrRn
576          _RL trac_EvPrRn
577          _RL horiVertRatio
578          _RL recip_horiVertRatio
579          _RL ivdc_kappa
580          _RL Ro_SeaLevel
581          _RL bottomDragLinear
582          _RL bottomDragQuadratic
583    
584          COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,
585       &                Lamba_theta       &                Lamba_theta
586        REAL HeatCapacity_Cp        _RL HeatCapacity_Cp
587        REAL Lamba_theta        _RL Lamba_theta
588          _RL recip_Cp
589    
590    C Atmospheric physical parameters (Ideal Gas EOS, ...)
591    C     atm_Po    :: standard reference pressure
592    C     atm_Cp    :: specific heat (Cp) of the (dry) air at constant pressure
593    C     atm_Rd    :: gas constant for dry air
594    C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
595    C     integr_GeoPot :: option to select the way we integrate the geopotential
596    C                     (still a subject of discussions ...)
597    C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
598    C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
599          COMMON /PARM_ATM/ atm_Cp, atm_Rd, atm_kappa, atm_Po,
600         &                  integr_GeoPot, selectFindRoSurf
601          _RL atm_Po, atm_Cp, atm_Rd, atm_kappa
602          INTEGER integr_GeoPot, selectFindRoSurf
603    
604  C Equation of State (polynomial coeffients)  C Logical flags for selecting packages
605        COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS        LOGICAL useKPP
606        REAL eosC(Nz+1,9),eosSig0(Nz+1),eosRefT(Nz+1),eosRefS(Nz+1)        LOGICAL useGMRedi
607  C Linear equation of state        LOGICAL useOBCS
608  C     tAlpha    - Linear EOS thermal expansion coefficient ( 1/degree ).        LOGICAL useAIM
609  C     sBeta     - Linear EOS haline contraction coefficient.        LOGICAL useGrdchk
610        COMMON /PARM_EOS_LIN/ tAlpha,sBeta        LOGICAL useECCO
611        REAL tAlpha        LOGICAL useSHAP_FILT
612        REAL sBeta        LOGICAL useZONAL_FILT
613          LOGICAL useFLT
614          LOGICAL usePTRACERS
615          LOGICAL useSBO
616          LOGICAL useSEAICE
617    cswdblk -- add ---
618          LOGICAL useBulkforce
619          LOGICAL useThermSEAICE
620    cswdblk --- end add ---
621          COMMON /PARM_PACKAGES/
622         &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,
623         &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
624         &        usePTRACERS,  useSBO, useSEAICE,
625    cswdblk -- add ---
626         &        useThermSEAICE, useBulkforce
627    cswdblk --- end add ---
Legend:
Removed from v.1.5  
changed lines
  Added in v.1.87
  ViewVC Help
Powered by ViewVC 1.1.22