/[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.132 by jmc, Sun Oct 17 23:03:08 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 207  C     doSaltClimRelax  :: Set true if re Line 246  C     doSaltClimRelax  :: Set true if re
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 pressure
249  C                        coords.  C                        coords. (jmc: is it still used ?)
250  C     usingZCoords     :: Set to indicate that we are working in height  C     usingZCoords     :: Set to indicate that we are working in height
251  C                        coords.  C                        coords. (jmc: is it still used ?)
252    C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
253    C                         this requires specific code for restart & exchange
254  C     setCenterDr    :: set cell Center depth and put Interface at the middle  C     setCenterDr    :: set cell Center depth and put Interface at the middle
255  C     nonHydrostatic :: Using non-hydrostatic terms  C     nonHydrostatic :: Using non-hydrostatic terms
256  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
257  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files
258  C     allowFreezing  :: Allows water to freeze and form ice  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either
259    C                       slow (f77) or does not work (f90).  When
260    C                       useSingleCpuIO is set, mdsio_writefield.F
261    C                       outputs from master mpi process only.
262    C     allowFreezing  :: Allows surface water to freeze and form ice
263    C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
264  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
265    C     pickup_write_mdsio :: use mdsio to write pickups
266    C     pickup_read_mdsio  :: use mdsio to read  pickups
267    C     pickup_write_immed :: echo the pickup immediately (for conversion)
268    C     timeave_mdsio      :: use mdsio for timeave output
269    C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
270    C     monitor_stdio      :: use stdio for monitor output
271        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
272       & usingCurvilinearGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
273       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
274       & staggerTimeStep,       & staggerTimeStep,
275       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
# Line 226  C     groundAtK1  :: put the surface(k=1 Line 278  C     groundAtK1  :: put the surface(k=1
278       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
279       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
280       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
281       & momStepping, tempStepping, saltStepping, tr1Stepping,       & momStepping, tempStepping, saltStepping,
282       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
283       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
284       & useEnergyConservingCoriolis, useJamartWetPoints,       & useCDscheme,
285         & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
286         & SadournyCoriolis, upwindVorticity, highOrderVorticity,
287         & useAbsVorticity,
288       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
289       & multiDimAdvection, forcing_In_AB,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
290         & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,
291       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
292       & periodicExternalForcing,       & periodicExternalForcing,
293       & usingPCoords, usingZCoords, setCenterDr,       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
294       & nonHydrostatic, quasiHydrostatic, globalFiles,       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
295       & allowFreezing, groundAtK1,       & allowFreezing, useOldFreezing, groundAtK1,
296       & usePickupBeforeC35, debugMode,       & usePickupBeforeC35, usePickupBeforeC54, debugMode,
297       & readPickupWithTracer, writePickupWithTracer       & readPickupWithTracer, writePickupWithTracer,
298         & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
299         & timeave_mdsio, snapshot_mdsio, monitor_stdio,
300         & timeave_ioinc, snapshot_ioinc, monitor_ioinc,
301         & pickup_write_ioinc
302    
303        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
304        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
305          LOGICAL usingCylindricalGrid
306        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
307        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
308        LOGICAL useNHMTerms        LOGICAL useNHMTerms
# Line 267  C     groundAtK1  :: put the surface(k=1 Line 329  C     groundAtK1  :: put the surface(k=1
329        LOGICAL momStepping        LOGICAL momStepping
330        LOGICAL tempStepping        LOGICAL tempStepping
331        LOGICAL saltStepping        LOGICAL saltStepping
       LOGICAL tr1Stepping  
332        LOGICAL metricTerms        LOGICAL metricTerms
333        LOGICAL useConstantF        LOGICAL useConstantF
334        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
335        LOGICAL useSphereF        LOGICAL useSphereF
336          LOGICAL useCDscheme
337        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
338        LOGICAL useJamartWetPoints        LOGICAL useJamartWetPoints
339          LOGICAL useJamartMomAdv
340          LOGICAL SadournyCoriolis
341          LOGICAL upwindVorticity
342          LOGICAL highOrderVorticity
343          LOGICAL useAbsVorticity
344        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
345        LOGICAL implicitViscosity        LOGICAL implicitViscosity
346          LOGICAL tempImplVertAdv
347          LOGICAL saltImplVertAdv
348          LOGICAL momImplVertAdv
349        LOGICAL multiDimAdvection        LOGICAL multiDimAdvection
350          LOGICAL useMultiDimAdvec
351        LOGICAL forcing_In_AB        LOGICAL forcing_In_AB
352        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
353        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
# Line 284  C     groundAtK1  :: put the surface(k=1 Line 355  C     groundAtK1  :: put the surface(k=1
355        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
356        LOGICAL usingPCoords        LOGICAL usingPCoords
357        LOGICAL usingZCoords        LOGICAL usingZCoords
358          LOGICAL useDynP_inEos_Zc
359        LOGICAL setCenterDr        LOGICAL setCenterDr
360        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
361        LOGICAL quasiHydrostatic        LOGICAL quasiHydrostatic
362        LOGICAL globalFiles        LOGICAL globalFiles
363          LOGICAL useSingleCpuIO
364        LOGICAL allowFreezing        LOGICAL allowFreezing
365          LOGICAL useOldFreezing
366        LOGICAL groundAtK1        LOGICAL groundAtK1
367        LOGICAL usePickupBeforeC35        LOGICAL usePickupBeforeC35
368          LOGICAL usePickupBeforeC54
369        LOGICAL debugMode        LOGICAL debugMode
370        LOGICAL readPickupWithTracer        LOGICAL readPickupWithTracer
371        LOGICAL writePickupWithTracer        LOGICAL writePickupWithTracer
372          LOGICAL pickup_read_mdsio, pickup_write_mdsio
373          LOGICAL pickup_write_immed
374          LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
375          LOGICAL timeave_ioinc, snapshot_ioinc, monitor_ioinc
376          LOGICAL pickup_write_ioinc
377    
378  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
379  C     gg2dTargetResidual  C     cg2dTargetResidual
380  C          :: Target residual for cg2d solver; no unit (RHS normalisation)  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
381  C     cg2dTargetResWunit  C     cg2dTargetResWunit
382  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 396  C           number of iterations for con
396  C           drop form 192 -> 134! Need to investigate this further!  C           drop form 192 -> 134! Need to investigate this further!
397  C           For now I have introduced a parameter cg2dpcOffDFac which  C           For now I have introduced a parameter cg2dpcOffDFac which
398  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  ).  
399  C     delR      :: Vertical grid spacing ( units of r ).  C     delR      :: Vertical grid spacing ( units of r ).
400  C     delRc     :: Vertical grid spacing between cell centers (r unit).  C     delRc     :: Vertical grid spacing between cell centers (r unit).
401  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 406  C     gBaro     :: Accel. due to gravity
406  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil    :: Reference density for the linear equation of state
407  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density
408  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
409    C     tRef      :: reference vertical profile for potential temperature
410    C     sRef      :: reference vertical profile for salinity/specific humidity
411  C     startTime :: Start time for model ( s )  C     startTime :: Start time for model ( s )
412  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
413  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 419  C     f0        :: Reference coriolis pa
419  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
420  C     beta      :: df/dy ( s^-1.m^-1 )  C     beta      :: df/dy ( s^-1.m^-1 )
421  C     omega     :: Angular velocity ( rad/s )  C     omega     :: Angular velocity ( rad/s )
422    C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
423  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscAh    :: Eddy viscosity coeff. for mixing of
424  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
425  C     viscAz    :: Eddy viscosity coeff. for mixing of  C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical
426  C                 momentum vertically ( m^2/s )  C                 momentum laterally, no effect for hydrostatic
427  C     viscAp    :: Eddy viscosity coeff. for mixing of  C                 model, defaults to viscAh if unset ( m^2/s )
 C                 momentum vertically ( Pa^2/s )  
428  C     viscAr    :: Eddy viscosity coeff. for mixing of  C     viscAr    :: Eddy viscosity coeff. for mixing of
429  C                 momentum vertically ( units of r^2/s )  C                 momentum vertically ( units of r^2/s )
430  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
431  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
432    C     viscC2leith :: Leith non-dimensional viscosity factor
433    C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of
434    C                 momentum laterally ( m^2/s )
435    C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
436    C                 momentum laterally ( m^4/s )
437    C     viscAhGrid:: non-dimensional grid-size dependent viscosity
438    C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
439    C     viscC4leith :: Leith non-dimensional viscosity factor
440  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
441  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
442  C     diffKzT   :: Laplacian diffusion coeff. for mixing of  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
443  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 )  
444  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
445  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
446  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
447  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
448  C     diffKzS   :: Laplacian diffusion coeff. for mixing of  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
449  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 )  
450  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
451  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
452    C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
453    C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
454    C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979
455    C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979
456  C     deltaT    :: Default timestep ( s )  C     deltaT    :: Default timestep ( s )
457  C     deltaTClock  :: Timestep used as model "clock". This determines the  C     deltaTClock  :: Timestep used as model "clock". This determines the
458  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 504  C     tauThetaClimRelax :: Relaxation to
504  C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).  C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
505  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
506  C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).  C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
507    C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
508    C                         i.e. where |yC| <= latBandClimRelax
509  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
510  C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)  C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
511  C                          (note: externForcingCycle must be an integer  C                          (note: externForcingCycle must be an integer
# Line 441  C     bottomDragLinear   :: Drag coeffic Line 527  C     bottomDragLinear   :: Drag coeffic
527  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )
528        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
529       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
530       & delP, delZ, delR, delRc, delX, delY,       & delR, delRc, delX, delY,
531       & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,
532       & abeps, startTime,       & abeps, startTime,
533       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
534       & fCori, fCoriG, fCoriCos,       & fCori, fCoriG, fCoriCos,
535       & viscAh,  viscAz,  viscA4,  viscAr, viscAstrain, viscAtension,       & viscAh, viscAhW, viscAhMax, viscAhGrid, viscC2leith,
536       & diffKhT, diffKzT, diffK4T, diffKrT,       & viscA4,  viscA4Max, viscA4Grid, viscC4leith,
537       & diffKhS, diffKzS, diffK4S, diffKrS,       & viscAr, viscAstrain, viscAtension,
538         & diffKhT, diffK4T, diffKrNrT,
539         & diffKhS, diffK4S, diffKrNrS,
540         & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
541       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
542       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
543       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
544       & recip_rhoConst, rhoConst,       & recip_rhoConst, rhoConst,
545       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
546       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,
547       & diagFreq, taveFreq, tave_lastIter, monitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq,
548       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
549       & cosPower, cAdjFreq, omega,       & cosPower, cAdjFreq, omega, rotationPeriod,
550       & tauThetaClimRelax, lambdaThetaClimRelax,       & tauThetaClimRelax, lambdaThetaClimRelax,
551       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
552       & tauTr1ClimRelax, lambdaTr1ClimRelax,       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
553       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
554       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,
555       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
556       & horiVertRatio, recip_horiVertRatio,       & horiVertRatio, recip_horiVertRatio,
557       & ivdc_kappa, Ro_SeaLevel,       & ivdc_kappa, Ro_SeaLevel,
558       & bottomDragLinear,bottomDragQuadratic       & bottomDragLinear,bottomDragQuadratic,
559         & tCyl
560    
561        _RL cg2dTargetResidual        _RL cg2dTargetResidual
562        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
563        _RL cg3dTargetResidual        _RL cg3dTargetResidual
564        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
       _RL delZ(Nr)  
       _RL delP(Nr)  
565        _RL delR(Nr)        _RL delR(Nr)
566        _RL delRc(Nr+1)        _RL delRc(Nr+1)
567        _RL delX(Nx)        _RL delX(Nx)
# Line 500  C      --"-"--  Quadratic  ( linear: 1/s Line 588  C      --"-"--  Quadratic  ( linear: 1/s
588        _RL hFacSup        _RL hFacSup
589        _RL beta        _RL beta
590        _RL viscAh        _RL viscAh
591          _RL viscAhW
592          _RL viscAhMax
593          _RL viscAhGrid
594          _RL viscC2leith
595        _RL viscAstrain        _RL viscAstrain
596        _RL viscAtension        _RL viscAtension
       _RL viscAz  
       _RL viscAp  
597        _RL viscAr        _RL viscAr
598        _RL viscA4        _RL viscA4
599          _RL viscA4Max
600          _RL viscA4Grid
601          _RL viscC4leith
602        _RL diffKhT        _RL diffKhT
603        _RL diffKrT        _RL diffKrNrT(Nr)
       _RL diffKzT  
       _RL diffKpT  
604        _RL diffK4T        _RL diffK4T
605        _RL diffKhS        _RL diffKhS
606        _RL diffKrS        _RL diffKrNrS(Nr)
       _RL diffKzS  
       _RL diffKpS  
607        _RL diffK4S        _RL diffK4S
608          _RL diffKrBL79surf
609          _RL diffKrBL79deep
610          _RL diffKrBL79scl
611          _RL diffKrBL79Ho
612        _RL delt        _RL delt
613        _RL tauCD        _RL tauCD
614        _RL rCD        _RL rCD
# Line 538  C      --"-"--  Quadratic  ( linear: 1/s Line 631  C      --"-"--  Quadratic  ( linear: 1/s
631        _RL chkPtFreq        _RL chkPtFreq
632        _RL pChkPtFreq        _RL pChkPtFreq
633        _RL dumpFreq        _RL dumpFreq
634          _RL adjDumpFreq
635        _RL diagFreq        _RL diagFreq
636        _RL taveFreq        _RL taveFreq
637        _RL tave_lastIter        _RL tave_lastIter
# Line 551  C      --"-"--  Quadratic  ( linear: 1/s Line 645  C      --"-"--  Quadratic  ( linear: 1/s
645        _RL cosPower        _RL cosPower
646        _RL cAdjFreq        _RL cAdjFreq
647        _RL omega        _RL omega
648          _RL rotationPeriod
649        _RL tauThetaClimRelax        _RL tauThetaClimRelax
650        _RL lambdaThetaClimRelax        _RL lambdaThetaClimRelax
651        _RL tauSaltClimRelax        _RL tauSaltClimRelax
652        _RL lambdaSaltClimRelax        _RL lambdaSaltClimRelax
653        _RL tauTr1ClimRelax        _RL tauTr1ClimRelax
654        _RL lambdaTr1ClimRelax        _RL lambdaTr1ClimRelax
655          _RL latBandClimRelax
656        _RL externForcingCycle        _RL externForcingCycle
657        _RL externForcingPeriod        _RL externForcingPeriod
658        _RL convertFW2Salt        _RL convertFW2Salt
# Line 569  C      --"-"--  Quadratic  ( linear: 1/s Line 665  C      --"-"--  Quadratic  ( linear: 1/s
665        _RL Ro_SeaLevel        _RL Ro_SeaLevel
666        _RL bottomDragLinear        _RL bottomDragLinear
667        _RL bottomDragQuadratic        _RL bottomDragQuadratic
668          _RL tCyl
669    
670        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,  C--   COMMON /PARM_A/ Thermodynamics constants ?
671       &                Lamba_theta        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
672        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
       _RL Lamba_theta  
673        _RL recip_Cp        _RL recip_Cp
674    
675  CmlC Equation of State (polynomial coeffients)  C--   COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
676  Cml      COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS  C     celsius2K :: convert centigrade (Celsius) degree to Kelvin
677  Cml      _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)  C     atm_Po    :: standard reference pressure
678  CmlC Linear equation of state  C     atm_Cp    :: specific heat (Cp) of the (dry) air at constant pressure
679  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  
680  C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)  C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
681  C     Integr_GeoPot :: option to select the way we integrate the geopotential  C     atm_Rq    :: water vapour specific volume anomaly relative to dry air
682    C                  (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
683    C     integr_GeoPot :: option to select the way we integrate the geopotential
684  C                     (still a subject of discussions ...)  C                     (still a subject of discussions ...)
685        COMMON /PARM_ATM/ atm_cp, atm_kappa, atm_po,  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
686       &                  Integr_GeoPot  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
687        _RL atm_cp, atm_kappa, atm_po        COMMON /PARM_ATM/
688        INTEGER Integr_GeoPot       &            celsius2K,
689         &            atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
690         &            integr_GeoPot, selectFindRoSurf
691          _RL celsius2K
692          _RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq
693          INTEGER integr_GeoPot, selectFindRoSurf
694    
695  C Logical flags for selecting packages  C Logical flags for selecting packages
696          LOGICAL useOPPS
697          LOGICAL usePP81
698          LOGICAL useMY82
699          LOGICAL useGGL90
700        LOGICAL useKPP        LOGICAL useKPP
701        LOGICAL useGMRedi        LOGICAL useGMRedi
702        LOGICAL useOBCS        LOGICAL useOBCS
703        LOGICAL useAIM        LOGICAL useAIM
704          LOGICAL useLand
705        LOGICAL useGrdchk        LOGICAL useGrdchk
706        LOGICAL useECCO        LOGICAL useECCO
707        LOGICAL useSHAP_FILT        LOGICAL useSHAP_FILT
708        LOGICAL useZONAL_FILT        LOGICAL useZONAL_FILT
709        LOGICAL useFLT        LOGICAL useFLT
710        LOGICAL usePTRACERS        LOGICAL usePTRACERS
711          LOGICAL useSBO
712          LOGICAL useSEAICE
713          LOGICAL useBulkForce
714          LOGICAL useThSIce
715          LOGICAL usefizhi
716          LOGICAL usegridalt
717          LOGICAL usediagnostics
718          LOGICAL useEBM
719          LOGICAL useMNC
720        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
721       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
722       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
723       &        usePTRACERS       &        usePTRACERS,  useSBO, useSEAICE, useThSIce, useBulkForce,
724         &        usefizhi,  usegridalt, usediagnostics, useEBM, useMNC,
725         &        usePP81, useMY82, useOPPS, useGGL90
726    
727    CEH3 ;;; Local Variables: ***
728    CEH3 ;;; mode:fortran ***
729    CEH3 ;;; End: ***

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

  ViewVC Help
Powered by ViewVC 1.1.22