/[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.107 by edhill, Mon Apr 5 06:01:07 2004 UTC revision 1.140 by mlosch, Thu Dec 9 09:01:07 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
# Line 74  C     buoyancyRelation :: Flag used to i Line 73  C     buoyancyRelation :: Flag used to i
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, MDJWF, IDEALGAS  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, pickupSuff,       &                eosType, pickupSuff,
86       &                mdsioLocalDir       &                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 93  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 102  C                        LINEAR, POLY3, Line 104  C                        LINEAR, POLY3,
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        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
107          CHARACTER*(MAX_LEN_FNAM) the_run_name
108        CHARACTER*(6) eosType        CHARACTER*(6) eosType
109        CHARACTER*(10) pickupSuff        CHARACTER*(10) pickupSuff
110    
# Line 110  C     cg2dMaxIters        :: Maximum num Line 113  C     cg2dMaxIters        :: Maximum num
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 126  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 137  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       &        debugLevel       &        debugLevel
153        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
154        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
155          INTEGER cg2dPreCondFreq
156        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
157        INTEGER cg3dChkResFreq        INTEGER cg3dChkResFreq
158        INTEGER nIter0        INTEGER nIter0
# Line 153  C                           =0 (default) Line 165  C                           =0 (default)
165        INTEGER nCheckLev        INTEGER nCheckLev
166        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
167        INTEGER select_rStar        INTEGER select_rStar
168        INTEGER tempAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
169        INTEGER saltAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
       INTEGER tracerAdvScheme  
170        INTEGER debugLevel        INTEGER debugLevel
171    
172  C  C
# Line 171  C     usingCartesianGrid :: If TRUE grid Line 182  C     usingCartesianGrid :: If TRUE grid
182  C                          coordinate frame.  C                          coordinate frame.
183  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
184  C                               spherical polar frame.  C                               spherical polar frame.
185    C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
186  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.
187  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
188  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 184  C     metricTerms   :: Flag which turns Line 196  C     metricTerms   :: Flag which turns
196  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
197  C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.  C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.
198  C     useCoriolis   :: Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
 C     tempDiffusion :: Flag which turns diffusion of temperature on  
 C                     and off.  
199  C     tempAdvection :: Flag which turns advection of temperature on  C     tempAdvection :: Flag which turns advection of temperature on
200  C                     and off.  C                     and off.
201  C     tempForcing   :: Flag which turns external forcing of temperature on  C     tempForcing   :: Flag which turns external forcing of temperature on
202  C                     and off.  C                     and off.
 C     saltDiffusion :: Flag which turns diffusion of salinity on  
 C                     and off.  
203  C     saltAdvection :: Flag which turns advection of salinity on  C     saltAdvection :: Flag which turns advection of salinity on
204  C                     and off.  C                     and off.
205  C     saltForcing   :: Flag which turns external forcing of salinity on  C     saltForcing   :: Flag which turns external forcing of salinity on
# Line 207  C                           linear relat Line 215  C                           linear relat
215  C     momStepping   :: Turns momentum equation time-stepping off  C     momStepping   :: Turns momentum equation time-stepping off
216  C     tempStepping  :: Turns temperature equation time-stepping off  C     tempStepping  :: Turns temperature equation time-stepping off
217  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  
218  C     useConstantF  :: Coriolis parameter set to f0  C     useConstantF  :: Coriolis parameter set to f0
219  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
220  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
221  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
222  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
223    C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
224    C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny
225    C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
226    C     highOrderVorticity :: use 3rd/4th order interp. of vorticity in Coriolis
227    C     useAbsVorticity :: work with f+zeta in Coriolis terms
228  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
229  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
230  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
231  C     saltImplVertAdv :: Turns on implicit vertical advection for Salinity  C     saltImplVertAdv :: Turns on implicit vertical advection for Salinity
232  C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum  C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
233  C     multiDimAdvection :: Flag that enable multi-dimension advection  C     multiDimAdvection :: Flag that enable multi-dimension advection
234    C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
235  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
236  C                      out off Adams-Bashforth time stepping.  C                      out off Adams-Bashforth time stepping.
237  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
# Line 226  C                        climatology is Line 239  C                        climatology is
239  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
240  C                        climatology is required.  C                        climatology is required.
241  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
242  C     usingPCoords     :: Set to indicate that we are working in pressure  C     usingPCoords     :: Set to indicate that we are working in a pressure
243  C                        coords. (jmc: is it still used ?)  C                        type coordinate (p or p*).
244  C     usingZCoords     :: Set to indicate that we are working in height  C     usingZCoords     :: Set to indicate that we are working in a height
245  C                        coords. (jmc: is it still used ?)  C                        type coordinate (z or z*)
246    C     fluidIsAir       :: Set to indicate that the fluid major constituent
247    C                        is air
248    C     fluidIsWater     :: Set to indicate that the fluid major constituent
249    C                        is water
250  C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)  C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
251  C                         this requires specific code for restart & exchange  C                         this requires specific code for restart & exchange
252  C     setCenterDr    :: set cell Center depth and put Interface at the middle  C     setCenterDr    :: set cell Center depth and put Interface at the middle
# Line 243  C                       outputs from mas Line 260  C                       outputs from mas
260  C     allowFreezing  :: Allows surface water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
261  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
262  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
263    C     pickup_write_mdsio :: use mdsio to write pickups
264    C     pickup_read_mdsio  :: use mdsio to read  pickups
265    C     pickup_write_immed :: echo the pickup immediately (for conversion)
266    C     timeave_mdsio      :: use mdsio for timeave output
267    C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
268    C     monitor_stdio      :: use stdio for monitor output
269        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
270       & usingCurvilinearGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
271       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
272       & staggerTimeStep,       & staggerTimeStep,
273       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
274       & momPressureForcing, vectorInvariantMomentum,       & momPressureForcing, vectorInvariantMomentum,
275       & tempDiffusion, tempAdvection, tempForcing,       & tempAdvection, tempForcing,
276       & saltDiffusion, saltAdvection, saltForcing,       & saltAdvection, saltForcing,
277       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
278       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
279       & momStepping, tempStepping, saltStepping, tr1Stepping,       & momStepping, tempStepping, saltStepping,
280       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
281       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
282       & useCDscheme,       & useCDscheme,
283       & useEnergyConservingCoriolis, useJamartWetPoints,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
284         & SadournyCoriolis, upwindVorticity, highOrderVorticity,
285         & useAbsVorticity,
286       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
287       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
288       & multiDimAdvection, forcing_In_AB,       & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,
289       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
290       & periodicExternalForcing,       & periodicExternalForcing,
291         & fluidIsAir, fluidIsWater,
292       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
293       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
294       & allowFreezing, useOldFreezing, groundAtK1,       & allowFreezing, useOldFreezing, groundAtK1,
295       & usePickupBeforeC35, debugMode,       & usePickupBeforeC35, usePickupBeforeC54, debugMode,
296       & readPickupWithTracer, writePickupWithTracer       & readPickupWithTracer, writePickupWithTracer,
297         & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
298         & timeave_mdsio, snapshot_mdsio, monitor_stdio,
299         & outputTypesInclusive
300    
301        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
302        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
303          LOGICAL usingCylindricalGrid
304        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
305        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
306        LOGICAL useNHMTerms        LOGICAL useNHMTerms
# Line 282  C     groundAtK1  :: put the surface(k=1 Line 313  C     groundAtK1  :: put the surface(k=1
313        LOGICAL momPressureForcing        LOGICAL momPressureForcing
314        LOGICAL useCoriolis        LOGICAL useCoriolis
315        LOGICAL vectorInvariantMomentum        LOGICAL vectorInvariantMomentum
       LOGICAL tempDiffusion  
316        LOGICAL tempAdvection        LOGICAL tempAdvection
317        LOGICAL tempForcing        LOGICAL tempForcing
       LOGICAL saltDiffusion  
318        LOGICAL saltAdvection        LOGICAL saltAdvection
319        LOGICAL saltForcing        LOGICAL saltForcing
320        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
# Line 296  C     groundAtK1  :: put the surface(k=1 Line 325  C     groundAtK1  :: put the surface(k=1
325        LOGICAL momStepping        LOGICAL momStepping
326        LOGICAL tempStepping        LOGICAL tempStepping
327        LOGICAL saltStepping        LOGICAL saltStepping
       LOGICAL tr1Stepping  
328        LOGICAL metricTerms        LOGICAL metricTerms
329        LOGICAL useConstantF        LOGICAL useConstantF
330        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
# Line 304  C     groundAtK1  :: put the surface(k=1 Line 332  C     groundAtK1  :: put the surface(k=1
332        LOGICAL useCDscheme        LOGICAL useCDscheme
333        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
334        LOGICAL useJamartWetPoints        LOGICAL useJamartWetPoints
335          LOGICAL useJamartMomAdv
336          LOGICAL SadournyCoriolis
337          LOGICAL upwindVorticity
338          LOGICAL highOrderVorticity
339          LOGICAL useAbsVorticity
340        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
341        LOGICAL implicitViscosity        LOGICAL implicitViscosity
342        LOGICAL tempImplVertAdv        LOGICAL tempImplVertAdv
343        LOGICAL saltImplVertAdv        LOGICAL saltImplVertAdv
344        LOGICAL momImplVertAdv        LOGICAL momImplVertAdv
345        LOGICAL multiDimAdvection        LOGICAL multiDimAdvection
346          LOGICAL useMultiDimAdvec
347        LOGICAL forcing_In_AB        LOGICAL forcing_In_AB
348        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
349        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
350        LOGICAL doTr1ClimRelax        LOGICAL doTr1ClimRelax
351        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
352          LOGICAL fluidIsAir
353          LOGICAL fluidIsWater
354        LOGICAL usingPCoords        LOGICAL usingPCoords
355        LOGICAL usingZCoords        LOGICAL usingZCoords
356        LOGICAL useDynP_inEos_Zc        LOGICAL useDynP_inEos_Zc
# Line 327  C     groundAtK1  :: put the surface(k=1 Line 363  C     groundAtK1  :: put the surface(k=1
363        LOGICAL useOldFreezing        LOGICAL useOldFreezing
364        LOGICAL groundAtK1        LOGICAL groundAtK1
365        LOGICAL usePickupBeforeC35        LOGICAL usePickupBeforeC35
366          LOGICAL usePickupBeforeC54
367        LOGICAL debugMode        LOGICAL debugMode
368        LOGICAL readPickupWithTracer        LOGICAL readPickupWithTracer
369        LOGICAL writePickupWithTracer        LOGICAL writePickupWithTracer
370          LOGICAL pickup_read_mdsio, pickup_write_mdsio
371          LOGICAL pickup_write_immed
372          LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
373          LOGICAL outputTypesInclusive
374    
375  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
376  C     gg2dTargetResidual  C     cg2dTargetResidual
377  C          :: Target residual for cg2d solver; no unit (RHS normalisation)  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
378  C     cg2dTargetResWunit  C     cg2dTargetResWunit
379  C          :: Target residual for cg2d solver; W unit (No RHS normalisation)  C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
# Line 362  C     gBaro     :: Accel. due to gravity Line 403  C     gBaro     :: Accel. due to gravity
403  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil    :: Reference density for the linear equation of state
404  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density
405  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
406    C     tRef      :: reference vertical profile for potential temperature
407    C     sRef      :: reference vertical profile for salinity/specific humidity
408  C     startTime :: Start time for model ( s )  C     startTime :: Start time for model ( s )
409  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
410  C     thetaMin  :: Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
# Line 376  C     omega     :: Angular velocity ( ra Line 419  C     omega     :: Angular velocity ( ra
419  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
420  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscAh    :: Eddy viscosity coeff. for mixing of
421  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
422    C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical
423    C                 momentum laterally, no effect for hydrostatic
424    C                 model, defaults to viscAh if unset ( m^2/s )
425  C     viscAr    :: Eddy viscosity coeff. for mixing of  C     viscAr    :: Eddy viscosity coeff. for mixing of
426  C                 momentum vertically ( units of r^2/s )  C                 momentum vertically ( units of r^2/s )
427  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
428  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
429    C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical
430    C                 momentum laterally, no effect for hydrostatic
431    C                 model, defaults to viscA4 if unset ( m^2/s )
432    C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally
433    C                  (act on Divergence part) ( m^2/s )
434    C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally
435    C                  (act on Vorticity  part) ( m^2/s )
436    C     viscA4D   :: Biharmonic viscosity coeff. for mixing of momentum laterally
437    C                  (act on Divergence part) ( m^4/s )
438    C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally
439    C                  (act on Vorticity  part) ( m^4/s )
440    C     viscC2leith :: Leith non-dimensional viscosity factor
441  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of
442  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
443  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
444  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
445  C     viscAhGrid:: non-dimensional grid-size dependent viscosity  C     viscAhGrid:: non-dimensional grid-size dependent viscosity
446  C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity  C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
447    C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
448    C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity
449    C     viscC4leith :: Leith non-dimensional viscosity factor
450  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
451  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
452  C     diffKrT   :: Laplacian diffusion coeff. for mixing of  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
453  C                 heat vertically ( units of r^2/s )  C                 for mixing of heat vertically ( units of r^2/s )
454  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
455  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
456  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
457  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
458  C     diffKrS   :: Laplacian diffusion coeff. for mixing of  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
459  C                 salt vertically ( units of r^2/s )  C                 for mixing of salt vertically ( units of r^2/s ),
460  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
461  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
462    C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
463    C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
464    C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979
465    C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979
466  C     deltaT    :: Default timestep ( s )  C     deltaT    :: Default timestep ( s )
467  C     deltaTClock  :: Timestep used as model "clock". This determines the  C     deltaTClock  :: Timestep used as model "clock". This determines the
468  C                    IO frequencies and is used in tagging output. It can  C                    IO frequencies and is used in tagging output. It can
# Line 406  C                    it will be the deep Line 471  C                    it will be the deep
471  C                    Frequency of checkpointing and dumping of the model state  C                    Frequency of checkpointing and dumping of the model state
472  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
473  C     deltaTMom    :: Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
474  C     deltaTtracer :: Timestep for tracer equations ( s )  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k
475  C     deltaTfreesurf :: Timestep for free-surface equation ( s )  C     deltaTfreesurf :: Timestep for free-surface equation ( s )
476  C     freesurfFac  :: Parameter to turn implicit free surface term on or off  C     freesurfFac  :: Parameter to turn implicit free surface term on or off
477  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
# Line 459  C     convertFW2Salt :: salinity, used t Line 524  C     convertFW2Salt :: salinity, used t
524  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
525  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
526  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
 C     trac_EvPrRn :: tracer concentration in Rain & Evap.  
527  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
528  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
529  C                b) use model surface (local) value if set to UNSET_RL)  C                b) use model surface (local) value if set to UNSET_RL)
# Line 473  C      --"-"--  Quadratic  ( linear: 1/s Line 537  C      --"-"--  Quadratic  ( linear: 1/s
537        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
538       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
539       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
540       & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
541       & abeps, startTime,       & abeps, startTime,
542       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
543       & fCori, fCoriG, fCoriCos,       & fCori, fCoriG, fCoriCos,
544       & viscAh,  viscAhMax, viscAhGrid,       & viscAh, viscAhW, viscAhMax, viscAhGrid, viscC2leith,
545       & viscA4,  viscA4Max, viscA4Grid,       & viscAhD, viscAhZ, viscA4D, viscA4Z,
546       & viscAr, viscAstrain, viscAtension,       & viscA4, viscA4W,
547       & diffKhT, diffK4T, diffKrT,       & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,
548       & diffKhS, diffK4S, diffKrS,       & viscC4leith, viscAr, viscAstrain, viscAtension,
549         & diffKhT, diffK4T, diffKrNrT,
550         & diffKhS, diffK4S, diffKrNrS,
551         & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
552       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
553       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
554       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
# Line 495  C      --"-"--  Quadratic  ( linear: 1/s Line 562  C      --"-"--  Quadratic  ( linear: 1/s
562       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
563       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
564       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
565       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
566       & hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
567       & horiVertRatio, recip_horiVertRatio,       & horiVertRatio, recip_horiVertRatio,
568       & ivdc_kappa, Ro_SeaLevel,       & ivdc_kappa, Ro_SeaLevel,
569       & bottomDragLinear,bottomDragQuadratic       & bottomDragLinear,bottomDragQuadratic,
570         & tCyl
571    
572        _RL cg2dTargetResidual        _RL cg2dTargetResidual
573        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
# Line 512  C      --"-"--  Quadratic  ( linear: 1/s Line 580  C      --"-"--  Quadratic  ( linear: 1/s
580        _RL deltaT        _RL deltaT
581        _RL deltaTClock        _RL deltaTClock
582        _RL deltaTmom        _RL deltaTmom
583        _RL deltaTtracer        _RL dTtracerLev(Nr)
584        _RL deltaTfreesurf        _RL deltaTfreesurf
585        _RL abeps        _RL abeps
586        _RL phiMin        _RL phiMin
# Line 531  C      --"-"--  Quadratic  ( linear: 1/s Line 599  C      --"-"--  Quadratic  ( linear: 1/s
599        _RL hFacSup        _RL hFacSup
600        _RL beta        _RL beta
601        _RL viscAh        _RL viscAh
602          _RL viscAhW
603          _RL viscAhD
604          _RL viscAhZ
605        _RL viscAhMax        _RL viscAhMax
606        _RL viscAhGrid        _RL viscAhGrid
607          _RL viscC2leith
608        _RL viscAstrain        _RL viscAstrain
609        _RL viscAtension        _RL viscAtension
610        _RL viscAr        _RL viscAr
611        _RL viscA4        _RL viscA4
612          _RL viscA4W
613          _RL viscA4D
614          _RL viscA4Z
615        _RL viscA4Max        _RL viscA4Max
616        _RL viscA4Grid        _RL viscA4Grid, viscA4GridMax, viscA4GridMin
617          _RL viscC4leith
618        _RL diffKhT        _RL diffKhT
619        _RL diffKrT        _RL diffKrNrT(Nr)
620        _RL diffK4T        _RL diffK4T
621        _RL diffKhS        _RL diffKhS
622        _RL diffKrS        _RL diffKrNrS(Nr)
623        _RL diffK4S        _RL diffK4S
624          _RL diffKrBL79surf
625          _RL diffKrBL79deep
626          _RL diffKrBL79scl
627          _RL diffKrBL79Ho
628        _RL delt        _RL delt
629        _RL tauCD        _RL tauCD
630        _RL rCD        _RL rCD
# Line 594  C      --"-"--  Quadratic  ( linear: 1/s Line 674  C      --"-"--  Quadratic  ( linear: 1/s
674        _RL convertFW2Salt        _RL convertFW2Salt
675        _RL temp_EvPrRn        _RL temp_EvPrRn
676        _RL salt_EvPrRn        _RL salt_EvPrRn
       _RL trac_EvPrRn  
677        _RL horiVertRatio        _RL horiVertRatio
678        _RL recip_horiVertRatio        _RL recip_horiVertRatio
679        _RL ivdc_kappa        _RL ivdc_kappa
680        _RL Ro_SeaLevel        _RL Ro_SeaLevel
681        _RL bottomDragLinear        _RL bottomDragLinear
682        _RL bottomDragQuadratic        _RL bottomDragQuadratic
683          _RL tCyl
684    
685  C--   COMMON /PARM_A/ Thermodynamics constants ?  C--   COMMON /PARM_A/ Thermodynamics constants ?
686        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
# Line 628  C             derived from the orography Line 708  C             derived from the orography
708        INTEGER integr_GeoPot, selectFindRoSurf        INTEGER integr_GeoPot, selectFindRoSurf
709    
710  C Logical flags for selecting packages  C Logical flags for selecting packages
711          LOGICAL useOPPS
712          LOGICAL usePP81
713          LOGICAL useMY82
714          LOGICAL useGGL90
715        LOGICAL useKPP        LOGICAL useKPP
716        LOGICAL useGMRedi        LOGICAL useGMRedi
717        LOGICAL useOBCS        LOGICAL useOBCS
# Line 639  C Logical flags for selecting packages Line 723  C Logical flags for selecting packages
723        LOGICAL useZONAL_FILT        LOGICAL useZONAL_FILT
724        LOGICAL useFLT        LOGICAL useFLT
725        LOGICAL usePTRACERS        LOGICAL usePTRACERS
726          LOGICAL useGCHEM
727        LOGICAL useSBO        LOGICAL useSBO
728        LOGICAL useSEAICE        LOGICAL useSEAICE
729        LOGICAL useBulkForce        LOGICAL useBulkForce
# Line 646  C Logical flags for selecting packages Line 731  C Logical flags for selecting packages
731        LOGICAL usefizhi        LOGICAL usefizhi
732        LOGICAL usegridalt        LOGICAL usegridalt
733        LOGICAL usediagnostics        LOGICAL usediagnostics
734          LOGICAL useEBM
735          LOGICAL useMNC
736        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
737       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
738       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
739       &        usePTRACERS,  useSBO, useSEAICE, useThSIce, useBulkForce,       &        usePTRACERS, useGCHEM,
740       &        usefizhi,  usegridalt, usediagnostics       &        useSBO, useSEAICE, useThSIce, useBulkForce,
741         &        usefizhi, usegridalt, usediagnostics, useEBM, useMNC,
742  C     Run-time flags for early-initialization of MNC       &        usePP81, useMY82, useOPPS, useGGL90
       LOGICAL  
      &     useMNC,  
      &     mnc_use_indir, mnc_use_outdir, mnc_outdir_date,  
      &     mnc_echo_gvtypes, mnc_pickup_create, mnc_pickup_read,  
      &     mnc_use_for_mon  
       CHARACTER*(MAX_LEN_FNAM) mnc_outdir_str  
       CHARACTER*(MAX_LEN_FNAM) mnc_indir_str  
       COMMON /PARM_MNC/  
      &     useMNC,  
      &     mnc_use_indir, mnc_use_outdir, mnc_outdir_date,  
      &     mnc_echo_gvtypes, mnc_pickup_create, mnc_pickup_read,  
      &     mnc_outdir_str, mnc_indir_str,  
      &     mnc_use_for_mon  
   
743    
744  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
745  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***

Legend:
Removed from v.1.107  
changed lines
  Added in v.1.140

  ViewVC Help
Powered by ViewVC 1.1.22