/[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.79 by adcroft, Thu Nov 7 21:51:15 2002 UTC revision 1.134 by jmc, Mon Oct 18 21:32:48 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 191  C                           linear relat Line 221  C                           linear relat
221  C     momStepping   :: Turns momentum equation time-stepping off  C     momStepping   :: Turns momentum equation time-stepping off
222  C     tempStepping  :: Turns temperature equation time-stepping off  C     tempStepping  :: Turns temperature equation time-stepping off
223  C     saltStepping  :: Turns salinity equation time-stepping off  C     saltStepping  :: Turns salinity equation time-stepping off
 C     tr1Stepping   :: Turns passive tracer 1 time-stepping on/off  
224  C     useConstantF  :: Coriolis parameter set to f0  C     useConstantF  :: Coriolis parameter set to f0
225  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
226  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
227    C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
228  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
229    C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
230    C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny
231    C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
232    C     highOrderVorticity :: use 3rd/4th order interp. of vorticity in Coriolis
233    C     useAbsVorticity :: work with f+zeta in Coriolis terms
234  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
235  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
236    C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
237    C     saltImplVertAdv :: Turns on implicit vertical advection for Salinity
238    C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
239  C     multiDimAdvection :: Flag that enable multi-dimension advection  C     multiDimAdvection :: Flag that enable multi-dimension advection
240    C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
241  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
242  C                      out off Adams-Bashforth time stepping.  C                      out off Adams-Bashforth time stepping.
243  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
# Line 206  C                        climatology is Line 245  C                        climatology is
245  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
246  C                        climatology is required.  C                        climatology is required.
247  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
248  C     usingPCoords     :: Set to indicate that we are working in pressure  C     usingPCoords     :: Set to indicate that we are working in a pressure
249  C                        coords.  C                        type coordinate (p or p*).
250  C     usingZCoords     :: Set to indicate that we are working in height  C     usingZCoords     :: Set to indicate that we are working in a height
251  C                        coords.  C                        type coordinate (z or z*)
252    C     fluidIsAir       :: Set to indicate that the fluid major constituent
253    C                        is air
254    C     fluidIsWater     :: Set to indicate that the fluid major constituent
255    C                        is water
256    C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
257    C                         this requires specific code for restart & exchange
258  C     setCenterDr    :: set cell Center depth and put Interface at the middle  C     setCenterDr    :: set cell Center depth and put Interface at the middle
259  C     nonHydrostatic :: Using non-hydrostatic terms  C     nonHydrostatic :: Using non-hydrostatic terms
260  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
261  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files
262  C     allowFreezing  :: Allows water to freeze and form ice  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either
263    C                       slow (f77) or does not work (f90).  When
264    C                       useSingleCpuIO is set, mdsio_writefield.F
265    C                       outputs from master mpi process only.
266    C     allowFreezing  :: Allows surface water to freeze and form ice
267    C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
268  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
269    C     pickup_write_mdsio :: use mdsio to write pickups
270    C     pickup_read_mdsio  :: use mdsio to read  pickups
271    C     pickup_write_immed :: echo the pickup immediately (for conversion)
272    C     timeave_mdsio      :: use mdsio for timeave output
273    C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
274    C     monitor_stdio      :: use stdio for monitor output
275        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
276       & usingCurvilinearGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
277       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
278       & staggerTimeStep,       & staggerTimeStep,
279       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
# Line 226  C     groundAtK1  :: put the surface(k=1 Line 282  C     groundAtK1  :: put the surface(k=1
282       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
283       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
284       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
285       & momStepping, tempStepping, saltStepping, tr1Stepping,       & momStepping, tempStepping, saltStepping,
286       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
287       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
288       & useEnergyConservingCoriolis, useJamartWetPoints,       & useCDscheme,
289         & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
290         & SadournyCoriolis, upwindVorticity, highOrderVorticity,
291         & useAbsVorticity,
292       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
293       & multiDimAdvection, forcing_In_AB,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
294         & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,
295       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
296       & periodicExternalForcing,       & periodicExternalForcing,
297       & usingPCoords, usingZCoords, setCenterDr,       & fluidIsAir, fluidIsWater,
298       & nonHydrostatic, quasiHydrostatic, globalFiles,       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
299       & allowFreezing, groundAtK1,       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
300       & usePickupBeforeC35, debugMode,       & allowFreezing, useOldFreezing, groundAtK1,
301       & readPickupWithTracer, writePickupWithTracer       & usePickupBeforeC35, usePickupBeforeC54, debugMode,
302         & readPickupWithTracer, writePickupWithTracer,
303         & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
304         & timeave_mdsio, snapshot_mdsio, monitor_stdio,
305         & outputTypesInclusive
306    
307        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
308        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
309          LOGICAL usingCylindricalGrid
310        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
311        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
312        LOGICAL useNHMTerms        LOGICAL useNHMTerms
# Line 267  C     groundAtK1  :: put the surface(k=1 Line 333  C     groundAtK1  :: put the surface(k=1
333        LOGICAL momStepping        LOGICAL momStepping
334        LOGICAL tempStepping        LOGICAL tempStepping
335        LOGICAL saltStepping        LOGICAL saltStepping
       LOGICAL tr1Stepping  
336        LOGICAL metricTerms        LOGICAL metricTerms
337        LOGICAL useConstantF        LOGICAL useConstantF
338        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
339        LOGICAL useSphereF        LOGICAL useSphereF
340          LOGICAL useCDscheme
341        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
342        LOGICAL useJamartWetPoints        LOGICAL useJamartWetPoints
343          LOGICAL useJamartMomAdv
344          LOGICAL SadournyCoriolis
345          LOGICAL upwindVorticity
346          LOGICAL highOrderVorticity
347          LOGICAL useAbsVorticity
348        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
349        LOGICAL implicitViscosity        LOGICAL implicitViscosity
350          LOGICAL tempImplVertAdv
351          LOGICAL saltImplVertAdv
352          LOGICAL momImplVertAdv
353        LOGICAL multiDimAdvection        LOGICAL multiDimAdvection
354          LOGICAL useMultiDimAdvec
355        LOGICAL forcing_In_AB        LOGICAL forcing_In_AB
356        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
357        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
358        LOGICAL doTr1ClimRelax        LOGICAL doTr1ClimRelax
359        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
360          LOGICAL fluidIsAir
361          LOGICAL fluidIsWater
362        LOGICAL usingPCoords        LOGICAL usingPCoords
363        LOGICAL usingZCoords        LOGICAL usingZCoords
364          LOGICAL useDynP_inEos_Zc
365        LOGICAL setCenterDr        LOGICAL setCenterDr
366        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
367        LOGICAL quasiHydrostatic        LOGICAL quasiHydrostatic
368        LOGICAL globalFiles        LOGICAL globalFiles
369          LOGICAL useSingleCpuIO
370        LOGICAL allowFreezing        LOGICAL allowFreezing
371          LOGICAL useOldFreezing
372        LOGICAL groundAtK1        LOGICAL groundAtK1
373        LOGICAL usePickupBeforeC35        LOGICAL usePickupBeforeC35
374          LOGICAL usePickupBeforeC54
375        LOGICAL debugMode        LOGICAL debugMode
376        LOGICAL readPickupWithTracer        LOGICAL readPickupWithTracer
377        LOGICAL writePickupWithTracer        LOGICAL writePickupWithTracer
378          LOGICAL pickup_read_mdsio, pickup_write_mdsio
379          LOGICAL pickup_write_immed
380          LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
381          LOGICAL outputTypesInclusive
382    
383  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
384  C     gg2dTargetResidual  C     cg2dTargetResidual
385  C          :: Target residual for cg2d solver; no unit (RHS normalisation)  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
386  C     cg2dTargetResWunit  C     cg2dTargetResWunit
387  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 401  C           number of iterations for con
401  C           drop form 192 -> 134! Need to investigate this further!  C           drop form 192 -> 134! Need to investigate this further!
402  C           For now I have introduced a parameter cg2dpcOffDFac which  C           For now I have introduced a parameter cg2dpcOffDFac which
403  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  ).  
404  C     delR      :: Vertical grid spacing ( units of r ).  C     delR      :: Vertical grid spacing ( units of r ).
405  C     delRc     :: Vertical grid spacing between cell centers (r unit).  C     delRc     :: Vertical grid spacing between cell centers (r unit).
406  C     delX      :: Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
# Line 328  C     gBaro     :: Accel. due to gravity Line 411  C     gBaro     :: Accel. due to gravity
411  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil    :: Reference density for the linear equation of state
412  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density
413  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
414    C     tRef      :: reference vertical profile for potential temperature
415    C     sRef      :: reference vertical profile for salinity/specific humidity
416  C     startTime :: Start time for model ( s )  C     startTime :: Start time for model ( s )
417  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
418  C     thetaMin  :: Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
# Line 339  C     f0        :: Reference coriolis pa Line 424  C     f0        :: Reference coriolis pa
424  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
425  C     beta      :: df/dy ( s^-1.m^-1 )  C     beta      :: df/dy ( s^-1.m^-1 )
426  C     omega     :: Angular velocity ( rad/s )  C     omega     :: Angular velocity ( rad/s )
427    C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
428  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscAh    :: Eddy viscosity coeff. for mixing of
429  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
430  C     viscAz    :: Eddy viscosity coeff. for mixing of  C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical
431  C                 momentum vertically ( m^2/s )  C                 momentum laterally, no effect for hydrostatic
432  C     viscAp    :: Eddy viscosity coeff. for mixing of  C                 model, defaults to viscAh if unset ( m^2/s )
 C                 momentum vertically ( Pa^2/s )  
433  C     viscAr    :: Eddy viscosity coeff. for mixing of  C     viscAr    :: Eddy viscosity coeff. for mixing of
434  C                 momentum vertically ( units of r^2/s )  C                 momentum vertically ( units of r^2/s )
435  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
436  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
437    C     viscC2leith :: Leith non-dimensional viscosity factor
438    C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of
439    C                 momentum laterally ( m^2/s )
440    C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
441    C                 momentum laterally ( m^4/s )
442    C     viscAhGrid:: non-dimensional grid-size dependent viscosity
443    C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
444    C     viscC4leith :: Leith non-dimensional viscosity factor
445  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
446  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
447  C     diffKzT   :: Laplacian diffusion coeff. for mixing of  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
448  C                 heat vertically ( m^2/s )  C                 for mixing of heat vertically ( units of r^2/s )
 C     diffKpT   :: Laplacian diffusion coeff. for mixing of  
 C                 heat vertically ( Pa^2/s )  
 C     diffKrT   :: Laplacian diffusion coeff. for mixing of  
 C                 heat vertically ( units of r^2/s )  
449  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
450  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
451  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
452  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
453  C     diffKzS   :: Laplacian diffusion coeff. for mixing of  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
454  C                 salt vertically ( m^2/s )  C                 for mixing of salt vertically ( units of r^2/s ),
 C     diffKpS   :: Laplacian diffusion coeff. for mixing of  
 C                 salt vertically ( Pa^2/s )  
 C     diffKrS   :: Laplacian diffusion coeff. for mixing of  
 C                 salt vertically ( units of r^2/s )  
455  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
456  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
457    C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
458    C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
459    C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979
460    C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979
461  C     deltaT    :: Default timestep ( s )  C     deltaT    :: Default timestep ( s )
462  C     deltaTClock  :: Timestep used as model "clock". This determines the  C     deltaTClock  :: Timestep used as model "clock". This determines the
463  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 509  C     tauThetaClimRelax :: Relaxation to
509  C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).  C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
510  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
511  C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).  C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
512    C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
513    C                         i.e. where |yC| <= latBandClimRelax
514  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
515  C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)  C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
516  C                          (note: externForcingCycle must be an integer  C                          (note: externForcingCycle must be an integer
# Line 441  C     bottomDragLinear   :: Drag coeffic Line 532  C     bottomDragLinear   :: Drag coeffic
532  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )
533        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
534       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
535       & delP, delZ, delR, delRc, delX, delY,       & delR, delRc, delX, delY,
536       & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,
537       & abeps, startTime,       & abeps, startTime,
538       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
539       & fCori, fCoriG, fCoriCos,       & fCori, fCoriG, fCoriCos,
540       & viscAh,  viscAz,  viscA4,  viscAr, viscAstrain, viscAtension,       & viscAh, viscAhW, viscAhMax, viscAhGrid, viscC2leith,
541       & diffKhT, diffKzT, diffK4T, diffKrT,       & viscA4,  viscA4Max, viscA4Grid, viscC4leith,
542       & diffKhS, diffKzS, diffK4S, diffKrS,       & viscAr, viscAstrain, viscAtension,
543         & diffKhT, diffK4T, diffKrNrT,
544         & diffKhS, diffK4S, diffKrNrS,
545         & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
546       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
547       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
548       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
549       & recip_rhoConst, rhoConst,       & recip_rhoConst, rhoConst,
550       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
551       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,
552       & diagFreq, taveFreq, tave_lastIter, monitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq,
553       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
554       & cosPower, cAdjFreq, omega,       & cosPower, cAdjFreq, omega, rotationPeriod,
555       & tauThetaClimRelax, lambdaThetaClimRelax,       & tauThetaClimRelax, lambdaThetaClimRelax,
556       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
557       & tauTr1ClimRelax, lambdaTr1ClimRelax,       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
558       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
559       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,
560       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
561       & horiVertRatio, recip_horiVertRatio,       & horiVertRatio, recip_horiVertRatio,
562       & ivdc_kappa, Ro_SeaLevel,       & ivdc_kappa, Ro_SeaLevel,
563       & bottomDragLinear,bottomDragQuadratic       & bottomDragLinear,bottomDragQuadratic,
564         & tCyl
565    
566        _RL cg2dTargetResidual        _RL cg2dTargetResidual
567        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
568        _RL cg3dTargetResidual        _RL cg3dTargetResidual
569        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
       _RL delZ(Nr)  
       _RL delP(Nr)  
570        _RL delR(Nr)        _RL delR(Nr)
571        _RL delRc(Nr+1)        _RL delRc(Nr+1)
572        _RL delX(Nx)        _RL delX(Nx)
# Line 500  C      --"-"--  Quadratic  ( linear: 1/s Line 593  C      --"-"--  Quadratic  ( linear: 1/s
593        _RL hFacSup        _RL hFacSup
594        _RL beta        _RL beta
595        _RL viscAh        _RL viscAh
596          _RL viscAhW
597          _RL viscAhMax
598          _RL viscAhGrid
599          _RL viscC2leith
600        _RL viscAstrain        _RL viscAstrain
601        _RL viscAtension        _RL viscAtension
       _RL viscAz  
       _RL viscAp  
602        _RL viscAr        _RL viscAr
603        _RL viscA4        _RL viscA4
604          _RL viscA4Max
605          _RL viscA4Grid
606          _RL viscC4leith
607        _RL diffKhT        _RL diffKhT
608        _RL diffKrT        _RL diffKrNrT(Nr)
       _RL diffKzT  
       _RL diffKpT  
609        _RL diffK4T        _RL diffK4T
610        _RL diffKhS        _RL diffKhS
611        _RL diffKrS        _RL diffKrNrS(Nr)
       _RL diffKzS  
       _RL diffKpS  
612        _RL diffK4S        _RL diffK4S
613          _RL diffKrBL79surf
614          _RL diffKrBL79deep
615          _RL diffKrBL79scl
616          _RL diffKrBL79Ho
617        _RL delt        _RL delt
618        _RL tauCD        _RL tauCD
619        _RL rCD        _RL rCD
# Line 538  C      --"-"--  Quadratic  ( linear: 1/s Line 636  C      --"-"--  Quadratic  ( linear: 1/s
636        _RL chkPtFreq        _RL chkPtFreq
637        _RL pChkPtFreq        _RL pChkPtFreq
638        _RL dumpFreq        _RL dumpFreq
639          _RL adjDumpFreq
640        _RL diagFreq        _RL diagFreq
641        _RL taveFreq        _RL taveFreq
642        _RL tave_lastIter        _RL tave_lastIter
# Line 551  C      --"-"--  Quadratic  ( linear: 1/s Line 650  C      --"-"--  Quadratic  ( linear: 1/s
650        _RL cosPower        _RL cosPower
651        _RL cAdjFreq        _RL cAdjFreq
652        _RL omega        _RL omega
653          _RL rotationPeriod
654        _RL tauThetaClimRelax        _RL tauThetaClimRelax
655        _RL lambdaThetaClimRelax        _RL lambdaThetaClimRelax
656        _RL tauSaltClimRelax        _RL tauSaltClimRelax
657        _RL lambdaSaltClimRelax        _RL lambdaSaltClimRelax
658        _RL tauTr1ClimRelax        _RL tauTr1ClimRelax
659        _RL lambdaTr1ClimRelax        _RL lambdaTr1ClimRelax
660          _RL latBandClimRelax
661        _RL externForcingCycle        _RL externForcingCycle
662        _RL externForcingPeriod        _RL externForcingPeriod
663        _RL convertFW2Salt        _RL convertFW2Salt
# Line 569  C      --"-"--  Quadratic  ( linear: 1/s Line 670  C      --"-"--  Quadratic  ( linear: 1/s
670        _RL Ro_SeaLevel        _RL Ro_SeaLevel
671        _RL bottomDragLinear        _RL bottomDragLinear
672        _RL bottomDragQuadratic        _RL bottomDragQuadratic
673          _RL tCyl
674    
675        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,  C--   COMMON /PARM_A/ Thermodynamics constants ?
676       &                Lamba_theta        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
677        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
       _RL Lamba_theta  
678        _RL recip_Cp        _RL recip_Cp
679    
680  CmlC Equation of State (polynomial coeffients)  C--   COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
681  Cml      COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS  C     celsius2K :: convert centigrade (Celsius) degree to Kelvin
682  Cml      _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)  C     atm_Po    :: standard reference pressure
683  CmlC Linear equation of state  C     atm_Cp    :: specific heat (Cp) of the (dry) air at constant pressure
684  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  
685  C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)  C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
686  C     Integr_GeoPot :: option to select the way we integrate the geopotential  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air
687    C                  (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
688    C     integr_GeoPot :: option to select the way we integrate the geopotential
689  C                     (still a subject of discussions ...)  C                     (still a subject of discussions ...)
690        COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po,  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
691       &                  Integr_GeoPot  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
692        _RL atm_cp, atm_kappa, atm_po        COMMON /PARM_ATM/
693        INTEGER Integr_GeoPot       &            celsius2K,
694         &            atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
695         &            integr_GeoPot, selectFindRoSurf
696          _RL celsius2K
697          _RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq
698          INTEGER integr_GeoPot, selectFindRoSurf
699    
700  C Logical flags for selecting packages  C Logical flags for selecting packages
701          LOGICAL useOPPS
702          LOGICAL usePP81
703          LOGICAL useMY82
704          LOGICAL useGGL90
705        LOGICAL useKPP        LOGICAL useKPP
706        LOGICAL useGMRedi        LOGICAL useGMRedi
707        LOGICAL useOBCS        LOGICAL useOBCS
708        LOGICAL useAIM        LOGICAL useAIM
709          LOGICAL useLand
710        LOGICAL useGrdchk        LOGICAL useGrdchk
711        LOGICAL useECCO        LOGICAL useECCO
712        LOGICAL useSHAP_FILT        LOGICAL useSHAP_FILT
713        LOGICAL useZONAL_FILT        LOGICAL useZONAL_FILT
714        LOGICAL useFLT        LOGICAL useFLT
715        LOGICAL usePTRACERS        LOGICAL usePTRACERS
716          LOGICAL useSBO
717          LOGICAL useSEAICE
718          LOGICAL useBulkForce
719          LOGICAL useThSIce
720          LOGICAL usefizhi
721          LOGICAL usegridalt
722          LOGICAL usediagnostics
723          LOGICAL useEBM
724          LOGICAL useMNC
725        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
726       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
727       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
728       &        usePTRACERS       &        usePTRACERS,  useSBO, useSEAICE, useThSIce, useBulkForce,
729         &        usefizhi,  usegridalt, usediagnostics, useEBM, useMNC,
730         &        usePP81, useMY82, useOPPS, useGGL90
731    
732    CEH3 ;;; Local Variables: ***
733    CEH3 ;;; mode:fortran ***
734    CEH3 ;;; End: ***

Legend:
Removed from v.1.79  
changed lines
  Added in v.1.134

  ViewVC Help
Powered by ViewVC 1.1.22