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