/[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.85 by dimitri, Tue Feb 18 05:33:53 2003 UTC revision 1.129 by edhill, Sun Oct 10 06:08:47 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 123  C     nonlinFreeSurf      :: option rela Line 131  C     nonlinFreeSurf      :: option rela
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  C     select_rStar        :: option related to r* vertical coordinate
133  C                           =0 (default) use r coord. ; > 0 use r*  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,
# Line 134  C                           =0 (default) Line 147  C                           =0 (default)
147       &        writeStatePrec, nCheckLev,       &        writeStatePrec, nCheckLev,
148       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
149       &        nonlinFreeSurf, select_rStar,       &        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 149  C                           =0 (default) Line 166  C                           =0 (default)
166        INTEGER nCheckLev        INTEGER nCheckLev
167        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
168        INTEGER select_rStar        INTEGER select_rStar
169        INTEGER tempAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
170        INTEGER saltAdvScheme        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 194  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 210  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
# Line 221  C     useSingleCpuIO :: On SGI platforms Line 259  C     useSingleCpuIO :: On SGI platforms
259  C                       slow (f77) or does not work (f90).  When  C                       slow (f77) or does not work (f90).  When
260  C                       useSingleCpuIO is set, mdsio_writefield.F  C                       useSingleCpuIO is set, mdsio_writefield.F
261  C                       outputs from master mpi process only.  C                       outputs from master mpi process only.
262  C     allowFreezing  :: Allows water to freeze and form ice  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    C     useMNC           :: overall package run-time flag
272    C     mnc_use_indir    :: use "mnc_indir_str" as input filename prefix
273    C     mnc_use_outdir   :: use "mnc_outdir_str" as output filename prefix
274    C     mnc_outdir_date  :: use a date string within the output dir name
275    C     mnc_echo_gvtypes :: echo type names (fails on many platforms)
276    C     pickup_write_mnc :: use mnc to write pickups
277    C     pickup_read_mnc  :: use mnc to read  pickups
278    C     mon_write_mnc    :: use mnc to write monitor output
279        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
280       & usingCurvilinearGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
281       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
282       & staggerTimeStep,       & staggerTimeStep,
283       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
# Line 233  C     groundAtK1  :: put the surface(k=1 Line 286  C     groundAtK1  :: put the surface(k=1
286       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
287       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
288       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
289       & momStepping, tempStepping, saltStepping, tr1Stepping,       & momStepping, tempStepping, saltStepping,
290       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
291       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
292       & useEnergyConservingCoriolis, useJamartWetPoints,       & useCDscheme,
293         & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
294         & SadournyCoriolis, upwindVorticity, highOrderVorticity,
295         & useAbsVorticity,
296       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
297       & multiDimAdvection, forcing_In_AB,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
298         & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,
299       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
300       & periodicExternalForcing,       & periodicExternalForcing,
301       & usingPCoords, usingZCoords, setCenterDr,       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
302       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
303       & allowFreezing, groundAtK1,       & allowFreezing, useOldFreezing, groundAtK1,
304       & usePickupBeforeC35, debugMode,       & usePickupBeforeC35, usePickupBeforeC54, debugMode,
305       & readPickupWithTracer, writePickupWithTracer       & readPickupWithTracer, writePickupWithTracer,
306         &     useMNC,
307         &     mnc_use_indir, mnc_use_outdir, mnc_outdir_date,
308         &     mnc_echo_gvtypes,
309         &     pickup_write_mnc, pickup_read_mnc,
310         &     timeave_mnc, snapshot_mnc, monitor_mnc, autodiff_mnc,
311         & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
312         & timeave_mdsio, snapshot_mdsio, monitor_stdio
313        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
314        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
315          LOGICAL usingCylindricalGrid
316        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
317        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
318        LOGICAL useNHMTerms        LOGICAL useNHMTerms
# Line 274  C     groundAtK1  :: put the surface(k=1 Line 339  C     groundAtK1  :: put the surface(k=1
339        LOGICAL momStepping        LOGICAL momStepping
340        LOGICAL tempStepping        LOGICAL tempStepping
341        LOGICAL saltStepping        LOGICAL saltStepping
       LOGICAL tr1Stepping  
342        LOGICAL metricTerms        LOGICAL metricTerms
343        LOGICAL useConstantF        LOGICAL useConstantF
344        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
345        LOGICAL useSphereF        LOGICAL useSphereF
346          LOGICAL useCDscheme
347        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
348        LOGICAL useJamartWetPoints        LOGICAL useJamartWetPoints
349          LOGICAL useJamartMomAdv
350          LOGICAL SadournyCoriolis
351          LOGICAL upwindVorticity
352          LOGICAL highOrderVorticity
353          LOGICAL useAbsVorticity
354        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
355        LOGICAL implicitViscosity        LOGICAL implicitViscosity
356          LOGICAL tempImplVertAdv
357          LOGICAL saltImplVertAdv
358          LOGICAL momImplVertAdv
359        LOGICAL multiDimAdvection        LOGICAL multiDimAdvection
360          LOGICAL useMultiDimAdvec
361        LOGICAL forcing_In_AB        LOGICAL forcing_In_AB
362        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
363        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
# Line 291  C     groundAtK1  :: put the surface(k=1 Line 365  C     groundAtK1  :: put the surface(k=1
365        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
366        LOGICAL usingPCoords        LOGICAL usingPCoords
367        LOGICAL usingZCoords        LOGICAL usingZCoords
368          LOGICAL useDynP_inEos_Zc
369        LOGICAL setCenterDr        LOGICAL setCenterDr
370        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
371        LOGICAL quasiHydrostatic        LOGICAL quasiHydrostatic
372        LOGICAL globalFiles        LOGICAL globalFiles
373        LOGICAL useSingleCpuIO        LOGICAL useSingleCpuIO
374        LOGICAL allowFreezing        LOGICAL allowFreezing
375          LOGICAL useOldFreezing
376        LOGICAL groundAtK1        LOGICAL groundAtK1
377        LOGICAL usePickupBeforeC35        LOGICAL usePickupBeforeC35
378          LOGICAL usePickupBeforeC54
379        LOGICAL debugMode        LOGICAL debugMode
380        LOGICAL readPickupWithTracer        LOGICAL readPickupWithTracer
381        LOGICAL writePickupWithTracer        LOGICAL writePickupWithTracer
382          LOGICAL
383         &     useMNC,
384         &     mnc_use_indir, mnc_use_outdir, mnc_outdir_date,
385         &     mnc_echo_gvtypes,
386         &     pickup_write_mnc, pickup_read_mnc,
387         &     timeave_mnc, snapshot_mnc, monitor_mnc, autodiff_mnc
388          LOGICAL pickup_read_mdsio, pickup_write_mdsio
389          LOGICAL pickup_write_immed
390          LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
391    
392  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
393  C     gg2dTargetResidual  C     cg2dTargetResidual
394  C          :: Target residual for cg2d solver; no unit (RHS normalisation)  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
395  C     cg2dTargetResWunit  C     cg2dTargetResWunit
396  C          :: Target residual for cg2d solver; W unit (No RHS normalisation)  C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
# Line 324  C           number of iterations for con Line 410  C           number of iterations for con
410  C           drop form 192 -> 134! Need to investigate this further!  C           drop form 192 -> 134! Need to investigate this further!
411  C           For now I have introduced a parameter cg2dpcOffDFac which  C           For now I have introduced a parameter cg2dpcOffDFac which
412  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  ).  
413  C     delR      :: Vertical grid spacing ( units of r ).  C     delR      :: Vertical grid spacing ( units of r ).
414  C     delRc     :: Vertical grid spacing between cell centers (r unit).  C     delRc     :: Vertical grid spacing between cell centers (r unit).
415  C     delX      :: Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
# Line 347  C     f0        :: Reference coriolis pa Line 431  C     f0        :: Reference coriolis pa
431  C                 ( Southern edge f for beta plane )  C                 ( Southern edge f for beta plane )
432  C     beta      :: df/dy ( s^-1.m^-1 )  C     beta      :: df/dy ( s^-1.m^-1 )
433  C     omega     :: Angular velocity ( rad/s )  C     omega     :: Angular velocity ( rad/s )
434    C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
435  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscAh    :: Eddy viscosity coeff. for mixing of
436  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
437  C     viscAz    :: Eddy viscosity coeff. for mixing of  C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical
438  C                 momentum vertically ( m^2/s )  C                 momentum laterally, no effect for hydrostatic
439  C     viscAp    :: Eddy viscosity coeff. for mixing of  C                 model, defaults to viscAh if unset ( m^2/s )
 C                 momentum vertically ( Pa^2/s )  
440  C     viscAr    :: Eddy viscosity coeff. for mixing of  C     viscAr    :: Eddy viscosity coeff. for mixing of
441  C                 momentum vertically ( units of r^2/s )  C                 momentum vertically ( units of r^2/s )
442  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
443  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
444    C     viscC2leith :: Leith non-dimensional viscosity factor
445    C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of
446    C                 momentum laterally ( m^2/s )
447    C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
448    C                 momentum laterally ( m^4/s )
449    C     viscAhGrid:: non-dimensional grid-size dependent viscosity
450    C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
451    C     viscC4leith :: Leith non-dimensional viscosity factor
452  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
453  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 )  
454  C     diffKrT   :: Laplacian diffusion coeff. for mixing of  C     diffKrT   :: Laplacian diffusion coeff. for mixing of
455  C                 heat vertically ( units of r^2/s )  C                 heat vertically ( units of r^2/s )
456  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
457  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
458  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
459  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 )  
460  C     diffKrS   :: Laplacian diffusion coeff. for mixing of  C     diffKrS   :: Laplacian diffusion coeff. for mixing of
461  C                 salt vertically ( units of r^2/s )  C                 salt vertically ( units of r^2/s )
462  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
463  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
464    C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
465    C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
466    C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979
467    C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979
468  C     deltaT    :: Default timestep ( s )  C     deltaT    :: Default timestep ( s )
469  C     deltaTClock  :: Timestep used as model "clock". This determines the  C     deltaTClock  :: Timestep used as model "clock". This determines the
470  C                    IO frequencies and is used in tagging output. It can  C                    IO frequencies and is used in tagging output. It can
# Line 428  C     tauThetaClimRelax :: Relaxation to Line 516  C     tauThetaClimRelax :: Relaxation to
516  C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).  C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).
517  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
518  C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).  C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).
519    C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
520    C                         i.e. where |yC| <= latBandClimRelax
521  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
522  C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)  C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
523  C                          (note: externForcingCycle must be an integer  C                          (note: externForcingCycle must be an integer
# Line 449  C     bottomDragLinear   :: Drag coeffic Line 539  C     bottomDragLinear   :: Drag coeffic
539  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )
540        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
541       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
542       & delP, delZ, delR, delRc, delX, delY,       & delR, delRc, delX, delY,
543       & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,
544       & abeps, startTime,       & abeps, startTime,
545       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
546       & fCori, fCoriG, fCoriCos,       & fCori, fCoriG, fCoriCos,
547       & viscAh,  viscAz,  viscA4,  viscAr, viscAstrain, viscAtension,       & viscAh, viscAhW, viscAhMax, viscAhGrid, viscC2leith,
548       & diffKhT, diffKzT, diffK4T, diffKrT,       & viscA4,  viscA4Max, viscA4Grid, viscC4leith,
549       & diffKhS, diffKzS, diffK4S, diffKrS,       & viscAr, viscAstrain, viscAtension,
550         & diffKhT, diffK4T, diffKrT,
551         & diffKhS, diffK4S, diffKrS,
552         & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
553       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
554       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
555       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
556       & recip_rhoConst, rhoConst,       & recip_rhoConst, rhoConst,
557       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
558       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,
559       & diagFreq, taveFreq, tave_lastIter, monitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq,
560       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
561       & cosPower, cAdjFreq, omega,       & cosPower, cAdjFreq, omega, rotationPeriod,
562       & tauThetaClimRelax, lambdaThetaClimRelax,       & tauThetaClimRelax, lambdaThetaClimRelax,
563       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
564       & tauTr1ClimRelax, lambdaTr1ClimRelax,       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
565       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
566       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,
567       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
568       & horiVertRatio, recip_horiVertRatio,       & horiVertRatio, recip_horiVertRatio,
569       & ivdc_kappa, Ro_SeaLevel,       & ivdc_kappa, Ro_SeaLevel,
570       & bottomDragLinear,bottomDragQuadratic       & bottomDragLinear,bottomDragQuadratic,
571         & tCyl
572    
573        _RL cg2dTargetResidual        _RL cg2dTargetResidual
574        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
575        _RL cg3dTargetResidual        _RL cg3dTargetResidual
576        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
       _RL delZ(Nr)  
       _RL delP(Nr)  
577        _RL delR(Nr)        _RL delR(Nr)
578        _RL delRc(Nr+1)        _RL delRc(Nr+1)
579        _RL delX(Nx)        _RL delX(Nx)
# Line 508  C      --"-"--  Quadratic  ( linear: 1/s Line 600  C      --"-"--  Quadratic  ( linear: 1/s
600        _RL hFacSup        _RL hFacSup
601        _RL beta        _RL beta
602        _RL viscAh        _RL viscAh
603          _RL viscAhW
604          _RL viscAhMax
605          _RL viscAhGrid
606          _RL viscC2leith
607        _RL viscAstrain        _RL viscAstrain
608        _RL viscAtension        _RL viscAtension
       _RL viscAz  
       _RL viscAp  
609        _RL viscAr        _RL viscAr
610        _RL viscA4        _RL viscA4
611          _RL viscA4Max
612          _RL viscA4Grid
613          _RL viscC4leith
614        _RL diffKhT        _RL diffKhT
615        _RL diffKrT        _RL diffKrT
       _RL diffKzT  
       _RL diffKpT  
616        _RL diffK4T        _RL diffK4T
617        _RL diffKhS        _RL diffKhS
618        _RL diffKrS        _RL diffKrS
       _RL diffKzS  
       _RL diffKpS  
619        _RL diffK4S        _RL diffK4S
620          _RL diffKrBL79surf
621          _RL diffKrBL79deep
622          _RL diffKrBL79scl
623          _RL diffKrBL79Ho
624        _RL delt        _RL delt
625        _RL tauCD        _RL tauCD
626        _RL rCD        _RL rCD
# Line 546  C      --"-"--  Quadratic  ( linear: 1/s Line 643  C      --"-"--  Quadratic  ( linear: 1/s
643        _RL chkPtFreq        _RL chkPtFreq
644        _RL pChkPtFreq        _RL pChkPtFreq
645        _RL dumpFreq        _RL dumpFreq
646          _RL adjDumpFreq
647        _RL diagFreq        _RL diagFreq
648        _RL taveFreq        _RL taveFreq
649        _RL tave_lastIter        _RL tave_lastIter
# Line 559  C      --"-"--  Quadratic  ( linear: 1/s Line 657  C      --"-"--  Quadratic  ( linear: 1/s
657        _RL cosPower        _RL cosPower
658        _RL cAdjFreq        _RL cAdjFreq
659        _RL omega        _RL omega
660          _RL rotationPeriod
661        _RL tauThetaClimRelax        _RL tauThetaClimRelax
662        _RL lambdaThetaClimRelax        _RL lambdaThetaClimRelax
663        _RL tauSaltClimRelax        _RL tauSaltClimRelax
664        _RL lambdaSaltClimRelax        _RL lambdaSaltClimRelax
665        _RL tauTr1ClimRelax        _RL tauTr1ClimRelax
666        _RL lambdaTr1ClimRelax        _RL lambdaTr1ClimRelax
667          _RL latBandClimRelax
668        _RL externForcingCycle        _RL externForcingCycle
669        _RL externForcingPeriod        _RL externForcingPeriod
670        _RL convertFW2Salt        _RL convertFW2Salt
# Line 577  C      --"-"--  Quadratic  ( linear: 1/s Line 677  C      --"-"--  Quadratic  ( linear: 1/s
677        _RL Ro_SeaLevel        _RL Ro_SeaLevel
678        _RL bottomDragLinear        _RL bottomDragLinear
679        _RL bottomDragQuadratic        _RL bottomDragQuadratic
680          _RL tCyl
681    
682        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp,  C--   COMMON /PARM_A/ Thermodynamics constants ?
683       &                Lamba_theta        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
684        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
       _RL Lamba_theta  
685        _RL recip_Cp        _RL recip_Cp
686    
687  CmlC Equation of State (polynomial coeffients)  C--   COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
688  Cml      COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS  C     celsius2K :: convert centigrade (Celsius) degree to Kelvin
 Cml      _RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1)  
 CmlC Linear equation of state  
 CmlC     tAlpha    :: Linear EOS thermal expansion coefficient ( 1/degree ).  
 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, ...)  
689  C     atm_Po    :: standard reference pressure  C     atm_Po    :: standard reference pressure
690  C     atm_Cp    :: specific heat (Cp) of the (dry) air at constant pressure  C     atm_Cp    :: specific heat (Cp) of the (dry) air at constant pressure
691  C     atm_Rd    :: gas constant for dry air  C     atm_Rd    :: gas constant for dry air
692  C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)  C     atm_kappa :: kappa = R/Cp (R: constant of Ideal Gas EOS)
693    C     atm_Rq    :: water vapour specific volume anomaly relative to dry air
694    C                  (e.g. typical value = (29/18 -1) 10^-3 with q [g/kg])
695  C     integr_GeoPot :: option to select the way we integrate the geopotential  C     integr_GeoPot :: option to select the way we integrate the geopotential
696  C                     (still a subject of discussions ...)  C                     (still a subject of discussions ...)
697  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is  C     selectFindRoSurf :: select the way surf. ref. pressure (=Ro_surf) is
698  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)  C             derived from the orography. Implemented: 0,1 (see INI_P_GROUND)
699        COMMON /PARM_ATM/ atm_Cp, atm_Rd, atm_kappa, atm_Po,        COMMON /PARM_ATM/
700       &                  integr_GeoPot, selectFindRoSurf       &            celsius2K,
701        _RL atm_Po, atm_Cp, atm_Rd, atm_kappa       &            atm_Cp, atm_Rd, atm_kappa, atm_Rq, atm_Po,
702         &            integr_GeoPot, selectFindRoSurf
703          _RL celsius2K
704          _RL atm_Po, atm_Cp, atm_Rd, atm_kappa, atm_Rq
705        INTEGER integr_GeoPot, selectFindRoSurf        INTEGER integr_GeoPot, selectFindRoSurf
706    
707  C Logical flags for selecting packages  C Logical flags for selecting packages
708          LOGICAL useOPPS
709          LOGICAL usePP81
710          LOGICAL useMY82
711          LOGICAL useGGL90
712        LOGICAL useKPP        LOGICAL useKPP
713        LOGICAL useGMRedi        LOGICAL useGMRedi
714        LOGICAL useOBCS        LOGICAL useOBCS
715        LOGICAL useAIM        LOGICAL useAIM
716          LOGICAL useLand
717        LOGICAL useGrdchk        LOGICAL useGrdchk
718        LOGICAL useECCO        LOGICAL useECCO
719        LOGICAL useSHAP_FILT        LOGICAL useSHAP_FILT
720        LOGICAL useZONAL_FILT        LOGICAL useZONAL_FILT
721        LOGICAL useFLT        LOGICAL useFLT
722        LOGICAL usePTRACERS        LOGICAL usePTRACERS
723          LOGICAL useSBO
724        LOGICAL useSEAICE        LOGICAL useSEAICE
725  cswdblk -- add ---        LOGICAL useBulkForce
726        LOGICAL useBulkforce        LOGICAL useThSIce
727        LOGICAL useThermSEAICE        LOGICAL usefizhi
728  cswdblk --- end add ---        LOGICAL usegridalt
729          LOGICAL usediagnostics
730          LOGICAL useEBM
731        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
732       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
733       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
734       &        usePTRACERS, useSEAICE,       &        usePTRACERS,  useSBO, useSEAICE, useThSIce, useBulkForce,
735  cswdblk -- add ---       &        usefizhi,  usegridalt, usediagnostics, useEBM,
736       &        useThermSEAICE, useBulkforce       &        usePP81, useMY82, useOPPS, useGGL90
737  cswdblk --- end add ---  
738    CEH3 ;;; Local Variables: ***
739    CEH3 ;;; mode:fortran ***
740    CEH3 ;;; End: ***

Legend:
Removed from v.1.85  
changed lines
  Added in v.1.129

  ViewVC Help
Powered by ViewVC 1.1.22