/[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.81 by cheisey, Fri Nov 15 19:58:21 2002 UTC revision 1.124 by edhill, Fri Sep 10 12:19:29 2004 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  C $Name$
3  C  C
4    
5  CBOP  CBOP
6  C    !ROUTINE: PARAMS.h  C     !ROUTINE: PARAMS.h
7  C    !INTERFACE:  C     !INTERFACE:
8  C    include PARAMS.h  C     #include PARAMS.h
9  C    !DESCRIPTION: \bv  
10  C     *==========================================================*  C     !DESCRIPTION:
11  C     | PARAMS.h                                                    C     Header file defining model "parameters".  The values from the
12  C     | o Header file defining model "parameters".                  C     model standard input file are stored into the variables held
13  C     *==========================================================*  C     here. Notes describing the parameters can also be found here.
14  C     | The values from the model standard input file are          
 C     | stored into the variables held here. Notes describing      
 C     | the parameters can also be found here.                      
 C     *==========================================================*  
 C     \ev  
15  CEOP  CEOP
16    
17  C     Macros for special grid options  C     Macros for special grid options
# Line 65  C     thetaClimFile   :: File containing Line 62  C     thetaClimFile   :: File containing
62  C                       in relaxation term -lambda(theta-theta*)  C                       in relaxation term -lambda(theta-theta*)
63  C     saltClimFile    :: File containing salt climataology used  C     saltClimFile    :: File containing salt climataology used
64  C                       in relaxation term -lambda(salt-salt*)  C                       in relaxation term -lambda(salt-salt*)
65  C     surfQfile       :: File containing surface heat flux  C     surfQfile       :: File containing surface heat flux, excluding SW
66  C     surfQswfile     :: File containing surface shortwave radiation  C                        (old version, kept for backward compatibility)
67    C     surfQnetFile    :: File containing surface net heat flux
68    C     surfQswFile     :: File containing surface shortwave radiation
69  C     dQdTfile        :: File containing thermal relaxation coefficient  C     dQdTfile        :: File containing thermal relaxation coefficient
70  C     EmPmRfile       :: File containing surface fresh water flux  C     EmPmRfile       :: File containing surface fresh water flux
71  C     pLoadFile       :: File containing pressure loading  C     pLoadFile       :: File containing pressure loading
72  C     buoyancyRelation :: Flag used to indicate which relation to use to  C     buoyancyRelation :: Flag used to indicate which relation to use to
73  C                        get buoyancy.  C                        get buoyancy.
74  C     eosType         :: choose the equation of state:  C     eosType         :: choose the equation of state:
75  C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P  C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
76    C     the_run_name    :: string identifying the name of the model "run"
77        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/ checkPtSuff,
78       &                bathyFile, topoFile,       &                bathyFile, topoFile,
79       &                hydrogThetaFile, hydrogSaltFile,       &                hydrogThetaFile, hydrogSaltFile,
80       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
81       &                saltClimFile, buoyancyRelation,       &                saltClimFile, buoyancyRelation,
82       &                EmPmRfile, surfQfile, surfQswfile,       &                EmPmRfile, surfQfile, surfQnetFile, surfQswFile,
83       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
84       &                dQdTfile, ploadFile,       &                dQdTfile, ploadFile,
85       &                eosType       &                eosType, pickupSuff,
86         &                mdsioLocalDir,
87         &                the_run_name
88        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
89        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
90        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
# Line 92  C                        LINEAR, POLY3, Line 94  C                        LINEAR, POLY3,
94        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
95        CHARACTER*(MAX_LEN_FNAM) saltClimFile        CHARACTER*(MAX_LEN_FNAM) saltClimFile
96        CHARACTER*(MAX_LEN_FNAM) surfQfile        CHARACTER*(MAX_LEN_FNAM) surfQfile
97        CHARACTER*(MAX_LEN_FNAM) surfQswfile        CHARACTER*(MAX_LEN_FNAM) surfQnetFile
98          CHARACTER*(MAX_LEN_FNAM) surfQswFile
99        CHARACTER*(MAX_LEN_FNAM) EmPmRfile        CHARACTER*(MAX_LEN_FNAM) EmPmRfile
100        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
101        CHARACTER*(MAX_LEN_FNAM) uVelInitFile        CHARACTER*(MAX_LEN_FNAM) uVelInitFile
# Line 100  C                        LINEAR, POLY3, Line 103  C                        LINEAR, POLY3,
103        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
104        CHARACTER*(MAX_LEN_FNAM) dQdTfile        CHARACTER*(MAX_LEN_FNAM) dQdTfile
105        CHARACTER*(MAX_LEN_FNAM) ploadFile        CHARACTER*(MAX_LEN_FNAM) ploadFile
106          CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
107          CHARACTER*(MAX_LEN_FNAM) the_run_name
108        CHARACTER*(6) eosType        CHARACTER*(6) eosType
109          CHARACTER*(10) pickupSuff
110    
111  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
112  C     cg2dMaxIters        :: Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
113  C                           two-dimensional con. grad solver.  C                           two-dimensional con. grad solver.
114  C     cg2dChkResFreq      :: Frequency with which to check residual  C     cg2dChkResFreq      :: Frequency with which to check residual
115  C                           in con. grad solver.  C                           in con. grad solver.
116    C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner
117    C                            (non-linear free-surf.)
118  C     cg3dMaxIters        :: Maximum number of iterations in the  C     cg3dMaxIters        :: Maximum number of iterations in the
119  C                           three-dimensional con. grad solver.  C                           three-dimensional con. grad solver.
120  C     cg3dChkResFreq      :: Frequency with which to check residual  C     cg3dChkResFreq      :: Frequency with which to check residual
# Line 121  C     readBinaryPrec      :: Precision u Line 129  C     readBinaryPrec      :: Precision u
129  C     nCheckLev           :: Holds current checkpoint level  C     nCheckLev           :: Holds current checkpoint level
130  C     nonlinFreeSurf      :: option related to non-linear free surface  C     nonlinFreeSurf      :: option related to non-linear free surface
131  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
132    C     select_rStar        :: option related to r* vertical coordinate
133    C                           =0 (default) use r coord. ; > 0 use r*
134    C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
135    C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
136    C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
137    C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector
138    C     debugLevel          :: debug level selector: higher -> more writing
139    
140        COMMON /PARM_I/        COMMON /PARM_I/
141       &        cg2dMaxIters,       &        cg2dMaxIters,
142       &        cg2dChkResFreq,       &        cg2dChkResFreq, cg2dPreCondFreq,
143       &        cg3dMaxIters,       &        cg3dMaxIters,
144       &        cg3dChkResFreq,       &        cg3dChkResFreq,
145       &        nIter0, nTimeSteps, nEndIter,       &        nIter0, nTimeSteps, nEndIter,
146       &        numStepsPerPickup,       &        numStepsPerPickup,
147       &        writeStatePrec, nCheckLev,       &        writeStatePrec, nCheckLev,
148       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
149       &        nonlinFreeSurf,       &        nonlinFreeSurf, select_rStar,
150       &        tempAdvScheme, saltAdvScheme, tracerAdvScheme       &        tempAdvScheme, tempVertAdvScheme,
151         &        saltAdvScheme, saltVertAdvScheme,
152         &        tracerAdvScheme,
153         &        debugLevel
154        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
155        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
156          INTEGER cg2dPreCondFreq
157        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
158        INTEGER cg3dChkResFreq        INTEGER cg3dChkResFreq
159        INTEGER nIter0        INTEGER nIter0
# Line 146  C                           =0 Linear fr Line 165  C                           =0 Linear fr
165        INTEGER readBinaryPrec        INTEGER readBinaryPrec
166        INTEGER nCheckLev        INTEGER nCheckLev
167        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
168        INTEGER tempAdvScheme        INTEGER select_rStar
169        INTEGER saltAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
170          INTEGER saltAdvScheme, saltVertAdvScheme
171        INTEGER tracerAdvScheme        INTEGER tracerAdvScheme
172          INTEGER debugLevel
173    
174    C
175          INTEGER debLevZero
176          PARAMETER(debLevZero=0)
177          INTEGER debLevA
178          PARAMETER(debLevA=1)
179          INTEGER debLevB
180          PARAMETER(debLevB=2)
181    
182  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
183  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
184  C                          coordinate frame.  C                          coordinate frame.
185  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
186  C                               spherical polar frame.  C                               spherical polar frame.
187    C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
188  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.
189  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
190  C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V  C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
# Line 195  C     tr1Stepping   :: Turns passive tra Line 225  C     tr1Stepping   :: Turns passive tra
225  C     useConstantF  :: Coriolis parameter set to f0  C     useConstantF  :: Coriolis parameter set to f0
226  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
227  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
228    C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
229  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
230    C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
231    C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny
232    C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
233    C     highOrderVorticity :: use 3rd/4th order interp. of vorticity in Coriolis
234    C     useAbsVorticity :: work with f+zeta in Coriolis terms
235  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
236  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
237    C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
238    C     saltImplVertAdv :: Turns on implicit vertical advection for Salinity
239    C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
240  C     multiDimAdvection :: Flag that enable multi-dimension advection  C     multiDimAdvection :: Flag that enable multi-dimension advection
241    C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
242  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
243  C                      out off Adams-Bashforth time stepping.  C                      out off Adams-Bashforth time stepping.
244  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
# Line 207  C     doSaltClimRelax  :: Set true if re Line 247  C     doSaltClimRelax  :: Set true if re
247  C                        climatology is required.  C                        climatology is required.
248  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
249  C     usingPCoords     :: Set to indicate that we are working in pressure  C     usingPCoords     :: Set to indicate that we are working in pressure
250  C                        coords.  C                        coords. (jmc: is it still used ?)
251  C     usingZCoords     :: Set to indicate that we are working in height  C     usingZCoords     :: Set to indicate that we are working in height
252  C                        coords.  C                        coords. (jmc: is it still used ?)
253    C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
254    C                         this requires specific code for restart & exchange
255  C     setCenterDr    :: set cell Center depth and put Interface at the middle  C     setCenterDr    :: set cell Center depth and put Interface at the middle
256  C     nonHydrostatic :: Using non-hydrostatic terms  C     nonHydrostatic :: Using non-hydrostatic terms
257  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
258  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files
259  C     allowFreezing  :: Allows water to freeze and form ice  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either
260    C                       slow (f77) or does not work (f90).  When
261    C                       useSingleCpuIO is set, mdsio_writefield.F
262    C                       outputs from master mpi process only.
263    C     allowFreezing  :: Allows surface water to freeze and form ice
264    C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
265  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
266    C     pickup_write_mdsio :: use mdsio to write pickups
267    C     pickup_read_mdsio  :: use mdsio to read  pickups
268    C     pickup_write_immed :: echo the pickup immediately (for conversion)
269    C     timeave_mdsio      :: use mdsio for timeave output
270    C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
271    C     monitor_mdsio      :: use mdsio for monitor output
272        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
273       & usingCurvilinearGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
274       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
275       & staggerTimeStep,       & staggerTimeStep,
276       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
# Line 229  C     groundAtK1  :: put the surface(k=1 Line 282  C     groundAtK1  :: put the surface(k=1
282       & momStepping, tempStepping, saltStepping, tr1Stepping,       & momStepping, tempStepping, saltStepping, tr1Stepping,
283       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
284       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
285       & useEnergyConservingCoriolis, useJamartWetPoints,       & useCDscheme,
286         & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
287         & SadournyCoriolis, upwindVorticity, highOrderVorticity,
288         & useAbsVorticity,
289       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
290       & multiDimAdvection, forcing_In_AB,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
291         & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,
292       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
293       & periodicExternalForcing,       & periodicExternalForcing,
294       & usingPCoords, usingZCoords, setCenterDr,       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
295       & nonHydrostatic, quasiHydrostatic, globalFiles,       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
296       & allowFreezing, groundAtK1,       & allowFreezing, useOldFreezing, groundAtK1,
297       & usePickupBeforeC35, debugMode,       & usePickupBeforeC35, usePickupBeforeC54, debugMode,
298       & readPickupWithTracer, writePickupWithTracer       & readPickupWithTracer, writePickupWithTracer,
299         & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
300         & timeave_mdsio, snapshot_mdsio, monitor_mdsio
301        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
302        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
303          LOGICAL usingCylindricalGrid
304        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
305        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
306        LOGICAL useNHMTerms        LOGICAL useNHMTerms
# Line 272  C     groundAtK1  :: put the surface(k=1 Line 332  C     groundAtK1  :: put the surface(k=1
332        LOGICAL useConstantF        LOGICAL useConstantF
333        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
334        LOGICAL useSphereF        LOGICAL useSphereF
335          LOGICAL useCDscheme
336        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
337        LOGICAL useJamartWetPoints        LOGICAL useJamartWetPoints
338          LOGICAL useJamartMomAdv
339          LOGICAL SadournyCoriolis
340          LOGICAL upwindVorticity
341          LOGICAL highOrderVorticity
342          LOGICAL useAbsVorticity
343        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
344        LOGICAL implicitViscosity        LOGICAL implicitViscosity
345          LOGICAL tempImplVertAdv
346          LOGICAL saltImplVertAdv
347          LOGICAL momImplVertAdv
348        LOGICAL multiDimAdvection        LOGICAL multiDimAdvection
349          LOGICAL useMultiDimAdvec
350        LOGICAL forcing_In_AB        LOGICAL forcing_In_AB
351        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
352        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
# Line 284  C     groundAtK1  :: put the surface(k=1 Line 354  C     groundAtK1  :: put the surface(k=1
354        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
355        LOGICAL usingPCoords        LOGICAL usingPCoords
356        LOGICAL usingZCoords        LOGICAL usingZCoords
357          LOGICAL useDynP_inEos_Zc
358        LOGICAL setCenterDr        LOGICAL setCenterDr
359        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
360        LOGICAL quasiHydrostatic        LOGICAL quasiHydrostatic
361        LOGICAL globalFiles        LOGICAL globalFiles
362          LOGICAL useSingleCpuIO
363        LOGICAL allowFreezing        LOGICAL allowFreezing
364          LOGICAL useOldFreezing
365        LOGICAL groundAtK1        LOGICAL groundAtK1
366        LOGICAL usePickupBeforeC35        LOGICAL usePickupBeforeC35
367          LOGICAL usePickupBeforeC54
368        LOGICAL debugMode        LOGICAL debugMode
369        LOGICAL readPickupWithTracer        LOGICAL readPickupWithTracer
370        LOGICAL writePickupWithTracer        LOGICAL writePickupWithTracer
371          LOGICAL pickup_read_mdsio, pickup_write_mdsio
372          LOGICAL pickup_write_immed
373          LOGICAL timeave_mdsio, snapshot_mdsio, monitor_mdsio
374    
375  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
376  C     gg2dTargetResidual  C     cg2dTargetResidual
377  C          :: Target residual for cg2d solver; no unit (RHS normalisation)  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
378  C     cg2dTargetResWunit  C     cg2dTargetResWunit
379  C          :: Target residual for cg2d solver; W unit (No RHS normalisation)  C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
# Line 316  C           number of iterations for con Line 393  C           number of iterations for con
393  C           drop form 192 -> 134! Need to investigate this further!  C           drop form 192 -> 134! Need to investigate this further!
394  C           For now I have introduced a parameter cg2dpcOffDFac which  C           For now I have introduced a parameter cg2dpcOffDFac which
395  C           defaults to 0.51 but can be set at runtime.  C           defaults to 0.51 but can be set at runtime.
 C     delP      :: Vertical grid spacing ( Pa ).  
 C     delZ      :: Vertical grid spacing ( m  ).  
396  C     delR      :: Vertical grid spacing ( units of r ).  C     delR      :: Vertical grid spacing ( units of r ).
397  C     delRc     :: Vertical grid spacing between cell centers (r unit).  C     delRc     :: Vertical grid spacing between cell centers (r unit).
398  C     delX      :: Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
# Line 339  C     f0        :: Reference coriolis pa Line 414  C     f0        :: Reference coriolis pa
414  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
415  C     beta      :: df/dy ( s^-1.m^-1 )  C     beta      :: df/dy ( s^-1.m^-1 )
416  C     omega     :: Angular velocity ( rad/s )  C     omega     :: Angular velocity ( rad/s )
417    C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
418  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscAh    :: Eddy viscosity coeff. for mixing of
419  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
 C     viscAz    :: Eddy viscosity coeff. for mixing of  
 C                 momentum vertically ( m^2/s )  
 C     viscAp    :: Eddy viscosity coeff. for mixing of  
 C                 momentum vertically ( Pa^2/s )  
420  C     viscAr    :: Eddy viscosity coeff. for mixing of  C     viscAr    :: Eddy viscosity coeff. for mixing of
421  C                 momentum vertically ( units of r^2/s )  C                 momentum vertically ( units of r^2/s )
422  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
423  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
424    C     viscC2leith :: Leith non-dimensional viscosity factor
425    C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of
426    C                 momentum laterally ( m^2/s )
427    C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
428    C                 momentum laterally ( m^4/s )
429    C     viscAhGrid:: non-dimensional grid-size dependent viscosity
430    C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
431    C     viscC4leith :: Leith non-dimensional viscosity factor
432  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
433  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
 C     diffKzT   :: Laplacian diffusion coeff. for mixing of  
 C                 heat vertically ( m^2/s )  
 C     diffKpT   :: Laplacian diffusion coeff. for mixing of  
 C                 heat vertically ( Pa^2/s )  
434  C     diffKrT   :: Laplacian diffusion coeff. for mixing of  C     diffKrT   :: Laplacian diffusion coeff. for mixing of
435  C                 heat vertically ( units of r^2/s )  C                 heat vertically ( units of r^2/s )
436  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
437  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
438  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
439  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
 C     diffKzS   :: Laplacian diffusion coeff. for mixing of  
 C                 salt vertically ( m^2/s )  
 C     diffKpS   :: Laplacian diffusion coeff. for mixing of  
 C                 salt vertically ( Pa^2/s )  
440  C     diffKrS   :: Laplacian diffusion coeff. for mixing of  C     diffKrS   :: Laplacian diffusion coeff. for mixing of
441  C                 salt vertically ( units of r^2/s )  C                 salt vertically ( units of r^2/s )
442  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
443  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
444    C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
445    C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
446    C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979
447    C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979
448  C     deltaT    :: Default timestep ( s )  C     deltaT    :: Default timestep ( s )
449  C     deltaTClock  :: Timestep used as model "clock". This determines the  C     deltaTClock  :: Timestep used as model "clock". This determines the
450  C                    IO frequencies and is used in tagging output. It can  C                    IO frequencies and is used in tagging output. It can
# Line 420  C     tauThetaClimRelax :: Relaxation to Line 496  C     tauThetaClimRelax :: Relaxation to
496  C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).  C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
497  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
498  C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).  C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
499    C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
500    C                         i.e. where |yC| <= latBandClimRelax
501  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
502  C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)  C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
503  C                          (note: externForcingCycle must be an integer  C                          (note: externForcingCycle must be an integer
# Line 441  C     bottomDragLinear   :: Drag coeffic Line 519  C     bottomDragLinear   :: Drag coeffic
519  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )
520        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
521       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
522       & delP, delZ, delR, delRc, delX, delY,       & delR, delRc, delX, delY,
523       & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,
524       & abeps, startTime,       & abeps, startTime,
525       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
526       & fCori, fCoriG, fCoriCos,       & fCori, fCoriG, fCoriCos,
527       & viscAh,  viscAz,  viscA4,  viscAr, viscAstrain, viscAtension,       & viscAh,  viscAhMax, viscAhGrid, viscC2leith,
528       & diffKhT, diffKzT, diffK4T, diffKrT,       & viscA4,  viscA4Max, viscA4Grid, viscC4leith,
529       & diffKhS, diffKzS, diffK4S, diffKrS,       & viscAr, viscAstrain, viscAtension,
530         & diffKhT, diffK4T, diffKrT,
531         & diffKhS, diffK4S, diffKrS,
532         & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
533       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
534       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
535       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
536       & recip_rhoConst, rhoConst,       & recip_rhoConst, rhoConst,
537       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
538       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,
539       & diagFreq, taveFreq, tave_lastIter, monitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq,
540       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
541       & cosPower, cAdjFreq, omega,       & cosPower, cAdjFreq, omega, rotationPeriod,
542       & tauThetaClimRelax, lambdaThetaClimRelax,       & tauThetaClimRelax, lambdaThetaClimRelax,
543       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
544       & tauTr1ClimRelax, lambdaTr1ClimRelax,       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
545       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
546       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,
547       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
548       & horiVertRatio, recip_horiVertRatio,       & horiVertRatio, recip_horiVertRatio,
549       & ivdc_kappa, Ro_SeaLevel,       & ivdc_kappa, Ro_SeaLevel,
550       & bottomDragLinear,bottomDragQuadratic       & bottomDragLinear,bottomDragQuadratic,
551         & tCyl
552    
553        _RL cg2dTargetResidual        _RL cg2dTargetResidual
554        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
555        _RL cg3dTargetResidual        _RL cg3dTargetResidual
556        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
       _RL delZ(Nr)  
       _RL delP(Nr)  
557        _RL delR(Nr)        _RL delR(Nr)
558        _RL delRc(Nr+1)        _RL delRc(Nr+1)
559        _RL delX(Nx)        _RL delX(Nx)
# Line 500  C      --"-"--  Quadratic  ( linear: 1/s Line 580  C      --"-"--  Quadratic  ( linear: 1/s
580        _RL hFacSup        _RL hFacSup
581        _RL beta        _RL beta
582        _RL viscAh        _RL viscAh
583          _RL viscAhMax
584          _RL viscAhGrid
585          _RL viscC2leith
586        _RL viscAstrain        _RL viscAstrain
587        _RL viscAtension        _RL viscAtension
       _RL viscAz  
       _RL viscAp  
588        _RL viscAr        _RL viscAr
589        _RL viscA4        _RL viscA4
590          _RL viscA4Max
591          _RL viscA4Grid
592          _RL viscC4leith
593        _RL diffKhT        _RL diffKhT
594        _RL diffKrT        _RL diffKrT
       _RL diffKzT  
       _RL diffKpT  
595        _RL diffK4T        _RL diffK4T
596        _RL diffKhS        _RL diffKhS
597        _RL diffKrS        _RL diffKrS
       _RL diffKzS  
       _RL diffKpS  
598        _RL diffK4S        _RL diffK4S
599          _RL diffKrBL79surf
600          _RL diffKrBL79deep
601          _RL diffKrBL79scl
602          _RL diffKrBL79Ho
603        _RL delt        _RL delt
604        _RL tauCD        _RL tauCD
605        _RL rCD        _RL rCD
# Line 538  C      --"-"--  Quadratic  ( linear: 1/s Line 622  C      --"-"--  Quadratic  ( linear: 1/s
622        _RL chkPtFreq        _RL chkPtFreq
623        _RL pChkPtFreq        _RL pChkPtFreq
624        _RL dumpFreq        _RL dumpFreq
625          _RL adjDumpFreq
626        _RL diagFreq        _RL diagFreq
627        _RL taveFreq        _RL taveFreq
628        _RL tave_lastIter        _RL tave_lastIter
# Line 551  C      --"-"--  Quadratic  ( linear: 1/s Line 636  C      --"-"--  Quadratic  ( linear: 1/s
636        _RL cosPower        _RL cosPower
637        _RL cAdjFreq        _RL cAdjFreq
638        _RL omega        _RL omega
639          _RL rotationPeriod
640        _RL tauThetaClimRelax        _RL tauThetaClimRelax
641        _RL lambdaThetaClimRelax        _RL lambdaThetaClimRelax
642        _RL tauSaltClimRelax        _RL tauSaltClimRelax
643        _RL lambdaSaltClimRelax        _RL lambdaSaltClimRelax
644        _RL tauTr1ClimRelax        _RL tauTr1ClimRelax
645        _RL lambdaTr1ClimRelax        _RL lambdaTr1ClimRelax
646          _RL latBandClimRelax
647        _RL externForcingCycle        _RL externForcingCycle
648        _RL externForcingPeriod        _RL externForcingPeriod
649        _RL convertFW2Salt        _RL convertFW2Salt
# Line 569  C      --"-"--  Quadratic  ( linear: 1/s Line 656  C      --"-"--  Quadratic  ( linear: 1/s
656        _RL Ro_SeaLevel        _RL Ro_SeaLevel
657        _RL bottomDragLinear        _RL bottomDragLinear
658        _RL bottomDragQuadratic        _RL bottomDragQuadratic
659          _RL tCyl
660    
661        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,  C--   COMMON /PARM_A/ Thermodynamics constants ?
662       &                Lamba_theta        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
663        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
       _RL Lamba_theta  
664        _RL recip_Cp        _RL recip_Cp
665    
666  CmlC Equation of State (polynomial coeffients)  C--   COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
667  Cml      COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS  C     celsius2K :: convert centigrade (Celsius) degree to Kelvin
668  Cml      _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)  C     atm_Po    :: standard reference pressure
669  CmlC Linear equation of state  C     atm_Cp    :: specific heat (Cp) of the (dry) air at constant pressure
670  CmlC     tAlpha    :: Linear EOS thermal expansion coefficient ( 1/degree ).  C     atm_Rd    :: gas constant for dry air
 CmlC     sBeta     :: Linear EOS haline contraction coefficient.  
 Cml      COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType  
 Cml      _RL tAlpha  
 Cml      _RL sBeta  
   
 C Atmospheric physical parameters (Ideal Gas EOS, ...)  
 C     atm_po    :: standard reference pressure  
 C     atm_cp    :: specific heat (Cp) of the (dry) air at constant pressure  
671  C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)  C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
672  C     Integr_GeoPot :: option to select the way we integrate the geopotential  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air
673    C                  (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
674    C     integr_GeoPot :: option to select the way we integrate the geopotential
675  C                     (still a subject of discussions ...)  C                     (still a subject of discussions ...)
676        COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po,  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
677       &                  Integr_GeoPot  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
678        _RL atm_cp, atm_kappa, atm_po        COMMON /PARM_ATM/
679        INTEGER Integr_GeoPot       &            celsius2K,
680         &            atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
681         &            integr_GeoPot, selectFindRoSurf
682          _RL celsius2K
683          _RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq
684          INTEGER integr_GeoPot, selectFindRoSurf
685    
686  C Logical flags for selecting packages  C Logical flags for selecting packages
687          LOGICAL usePP81
688          LOGICAL useMY82
689        LOGICAL useKPP        LOGICAL useKPP
690        LOGICAL useGMRedi        LOGICAL useGMRedi
691        LOGICAL useOBCS        LOGICAL useOBCS
692        LOGICAL useAIM        LOGICAL useAIM
693          LOGICAL useLand
694        LOGICAL useGrdchk        LOGICAL useGrdchk
695        LOGICAL useECCO        LOGICAL useECCO
696        LOGICAL useSHAP_FILT        LOGICAL useSHAP_FILT
697        LOGICAL useZONAL_FILT        LOGICAL useZONAL_FILT
698        LOGICAL useFLT        LOGICAL useFLT
699        LOGICAL usePTRACERS        LOGICAL usePTRACERS
700          LOGICAL useSBO
701        LOGICAL useSEAICE        LOGICAL useSEAICE
702  cswdblk -- add ---        LOGICAL useBulkForce
703        LOGICAL useBulkf        LOGICAL useThSIce
704        LOGICAL useTSEAICE        LOGICAL usefizhi
705  cswdblk --- end add ---        LOGICAL usegridalt
706          LOGICAL usediagnostics
707          LOGICAL useEBM
708        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
709       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
710       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
711       &        usePTRACERS, useSEAICE,       &        usePTRACERS,  useSBO, useSEAICE, useThSIce, useBulkForce,
712  cswdblk -- add ---       &        usefizhi,  usegridalt, usediagnostics, useEBM,
713       &        useTSEAICE, useBulkf       &        usePP81, useMY82
714  cswdblk --- end add ---  
715    CEH3 ;;; Local Variables: ***
716    CEH3 ;;; mode:fortran ***
717    CEH3 ;;; End: ***

Legend:
Removed from v.1.81  
changed lines
  Added in v.1.124

  ViewVC Help
Powered by ViewVC 1.1.22