/[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.111 by adcroft, Wed Jun 2 13:23:55 2004 UTC revision 1.145 by heimbach, Mon Feb 28 17:35:38 2005 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     saltFluxFile    :: File containing surface salt flux
72  C     pLoadFile       :: File containing pressure loading  C     pLoadFile       :: File containing pressure loading
73    C     eddyTauxFile    :: File containing zonal Eddy stress data
74    C     eddyTauyFile    :: File containing meridional Eddy stress data
75  C     buoyancyRelation :: Flag used to indicate which relation to use to  C     buoyancyRelation :: Flag used to indicate which relation to use to
76  C                        get buoyancy.  C                        get buoyancy.
77  C     eosType         :: choose the equation of state:  C     eosType         :: choose the equation of state:
78  C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS  C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
79    C     the_run_name    :: string identifying the name of the model "run"
80        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/ checkPtSuff,
81       &                bathyFile, topoFile,       &                bathyFile, topoFile,
82       &                hydrogThetaFile, hydrogSaltFile,       &                hydrogThetaFile, hydrogSaltFile,
83       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
84       &                saltClimFile, buoyancyRelation,       &                saltClimFile, buoyancyRelation,
85       &                EmPmRfile, surfQfile, surfQswfile,       &                EmPmRfile, saltFluxFile,
86         &                surfQfile, surfQnetFile, surfQswFile,
87       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
88       &                dQdTfile, ploadFile,       &                dQdTfile, ploadFile,
89         &                eddyTauxFile, eddyTauyFile,
90       &                eosType, pickupSuff,       &                eosType, pickupSuff,
91       &                mdsioLocalDir       &                mdsioLocalDir,
92         &                the_run_name
93        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
94        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
95        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
# Line 93  C                        LINEAR, POLY3, Line 99  C                        LINEAR, POLY3,
99        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
100        CHARACTER*(MAX_LEN_FNAM) saltClimFile        CHARACTER*(MAX_LEN_FNAM) saltClimFile
101        CHARACTER*(MAX_LEN_FNAM) surfQfile        CHARACTER*(MAX_LEN_FNAM) surfQfile
102        CHARACTER*(MAX_LEN_FNAM) surfQswfile        CHARACTER*(MAX_LEN_FNAM) surfQnetFile
103          CHARACTER*(MAX_LEN_FNAM) surfQswFile
104        CHARACTER*(MAX_LEN_FNAM) EmPmRfile        CHARACTER*(MAX_LEN_FNAM) EmPmRfile
105          CHARACTER*(MAX_LEN_FNAM) saltFluxFile
106        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
107        CHARACTER*(MAX_LEN_FNAM) uVelInitFile        CHARACTER*(MAX_LEN_FNAM) uVelInitFile
108        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
109        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
110        CHARACTER*(MAX_LEN_FNAM) dQdTfile        CHARACTER*(MAX_LEN_FNAM) dQdTfile
111        CHARACTER*(MAX_LEN_FNAM) ploadFile        CHARACTER*(MAX_LEN_FNAM) ploadFile
112          CHARACTER*(MAX_LEN_FNAM) eddyTauxFile
113          CHARACTER*(MAX_LEN_FNAM) eddyTauyFile
114        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
115          CHARACTER*(MAX_LEN_FNAM) the_run_name
116        CHARACTER*(6) eosType        CHARACTER*(6) eosType
117        CHARACTER*(10) pickupSuff        CHARACTER*(10) pickupSuff
118    
# Line 110  C     cg2dMaxIters        :: Maximum num Line 121  C     cg2dMaxIters        :: Maximum num
121  C                           two-dimensional con. grad solver.  C                           two-dimensional con. grad solver.
122  C     cg2dChkResFreq      :: Frequency with which to check residual  C     cg2dChkResFreq      :: Frequency with which to check residual
123  C                           in con. grad solver.  C                           in con. grad solver.
124    C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner
125    C                            (non-linear free-surf.)
126  C     cg3dMaxIters        :: Maximum number of iterations in the  C     cg3dMaxIters        :: Maximum number of iterations in the
127  C                           three-dimensional con. grad solver.  C                           three-dimensional con. grad solver.
128  C     cg3dChkResFreq      :: Frequency with which to check residual  C     cg3dChkResFreq      :: Frequency with which to check residual
# Line 126  C     nonlinFreeSurf      :: option rela Line 139  C     nonlinFreeSurf      :: option rela
139  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
140  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
141  C                           =0 (default) use r coord. ; > 0 use r*  C                           =0 (default) use r coord. ; > 0 use r*
142    C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
143    C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
144    C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
145    C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector
146    C     debugLevel          :: debug level selector: higher -> more writing
147    
148        COMMON /PARM_I/        COMMON /PARM_I/
149       &        cg2dMaxIters,       &        cg2dMaxIters,
150       &        cg2dChkResFreq,       &        cg2dChkResFreq, cg2dPreCondFreq,
151       &        cg3dMaxIters,       &        cg3dMaxIters,
152       &        cg3dChkResFreq,       &        cg3dChkResFreq,
153       &        nIter0, nTimeSteps, nEndIter,       &        nIter0, nTimeSteps, nEndIter,
# Line 137  C                           =0 (default) Line 155  C                           =0 (default)
155       &        writeStatePrec, nCheckLev,       &        writeStatePrec, nCheckLev,
156       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
157       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
158       &        tempAdvScheme, saltAdvScheme, tracerAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
159         &        saltAdvScheme, saltVertAdvScheme,
160       &        debugLevel       &        debugLevel
161        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
162        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
163          INTEGER cg2dPreCondFreq
164        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
165        INTEGER cg3dChkResFreq        INTEGER cg3dChkResFreq
166        INTEGER nIter0        INTEGER nIter0
# Line 153  C                           =0 (default) Line 173  C                           =0 (default)
173        INTEGER nCheckLev        INTEGER nCheckLev
174        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
175        INTEGER select_rStar        INTEGER select_rStar
176        INTEGER tempAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
177        INTEGER saltAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
       INTEGER tracerAdvScheme  
178        INTEGER debugLevel        INTEGER debugLevel
179    
180  C  C
# Line 171  C     usingCartesianGrid :: If TRUE grid Line 190  C     usingCartesianGrid :: If TRUE grid
190  C                          coordinate frame.  C                          coordinate frame.
191  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
192  C                               spherical polar frame.  C                               spherical polar frame.
193    C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
194  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.
195  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
196  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 204  C     metricTerms   :: Flag which turns
204  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
205  C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.  C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.
206  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.  
207  C     tempAdvection :: Flag which turns advection of temperature on  C     tempAdvection :: Flag which turns advection of temperature on
208  C                     and off.  C                     and off.
209  C     tempForcing   :: Flag which turns external forcing of temperature on  C     tempForcing   :: Flag which turns external forcing of temperature on
210  C                     and off.  C                     and off.
 C     saltDiffusion :: Flag which turns diffusion of salinity on  
 C                     and off.  
211  C     saltAdvection :: Flag which turns advection of salinity on  C     saltAdvection :: Flag which turns advection of salinity on
212  C                     and off.  C                     and off.
213  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 223  C                           linear relat
223  C     momStepping   :: Turns momentum equation time-stepping off  C     momStepping   :: Turns momentum equation time-stepping off
224  C     tempStepping  :: Turns temperature equation time-stepping off  C     tempStepping  :: Turns temperature equation time-stepping off
225  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  
226  C     useConstantF  :: Coriolis parameter set to f0  C     useConstantF  :: Coriolis parameter set to f0
227  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
228  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
229  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
230  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
231    C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
232  C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny  C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny
233  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
234  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity in Coriolis  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity in Coriolis
# Line 223  C     tempImplVertAdv :: Turns on implic Line 239  C     tempImplVertAdv :: Turns on implic
239  C     saltImplVertAdv :: Turns on implicit vertical advection for Salinity  C     saltImplVertAdv :: Turns on implicit vertical advection for Salinity
240  C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum  C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
241  C     multiDimAdvection :: Flag that enable multi-dimension advection  C     multiDimAdvection :: Flag that enable multi-dimension advection
242    C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
243  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
244  C                      out off Adams-Bashforth time stepping.  C                      out off Adams-Bashforth time stepping.
245  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
# Line 230  C                        climatology is Line 247  C                        climatology is
247  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
248  C                        climatology is required.  C                        climatology is required.
249  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
250  C     usingPCoords     :: Set to indicate that we are working in pressure  C     usingPCoords     :: Set to indicate that we are working in a pressure
251  C                        coords. (jmc: is it still used ?)  C                        type coordinate (p or p*).
252  C     usingZCoords     :: Set to indicate that we are working in height  C     usingZCoords     :: Set to indicate that we are working in a height
253  C                        coords. (jmc: is it still used ?)  C                        type coordinate (z or z*)
254    C     fluidIsAir       :: Set to indicate that the fluid major constituent
255    C                        is air
256    C     fluidIsWater     :: Set to indicate that the fluid major constituent
257    C                        is water
258  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.)
259  C                         this requires specific code for restart & exchange  C                         this requires specific code for restart & exchange
260  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 247  C                       outputs from mas Line 268  C                       outputs from mas
268  C     allowFreezing  :: Allows surface water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
269  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
270  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
271    C     pickup_write_mdsio :: use mdsio to write pickups
272    C     pickup_read_mdsio  :: use mdsio to read  pickups
273    C     pickup_write_immed :: echo the pickup immediately (for conversion)
274    C     timeave_mdsio      :: use mdsio for timeave output
275    C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
276    C     monitor_stdio      :: use stdio for monitor output
277    C     calendarDumps :: When set, approximate months (30-31 days) and years (360-372 days)
278    C                      for parameters chkPtFreq, pChkPtFreq, taveFreq, SEAICE_taveFreq,
279    C                      KPP_taveFreq, and freq in pkg/diagnostics are converted to exact
280    C                      calendar months and years.  Requires pkg/cal.
281        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
282       & usingCurvilinearGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
283       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
284       & staggerTimeStep,       & staggerTimeStep,
285       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
286       & momPressureForcing, vectorInvariantMomentum,       & momPressureForcing, vectorInvariantMomentum,
287       & tempDiffusion, tempAdvection, tempForcing,       & tempAdvection, tempForcing,
288       & saltDiffusion, saltAdvection, saltForcing,       & saltAdvection, saltForcing,
289       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
290       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
291       & momStepping, tempStepping, saltStepping, tr1Stepping,       & momStepping, tempStepping, saltStepping,
292       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
293       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
294       & useCDscheme,       & useCDscheme,
295       & useEnergyConservingCoriolis, useJamartWetPoints,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
296       & SadournyCoriolis, upwindVorticity, highOrderVorticity,       & SadournyCoriolis, upwindVorticity, highOrderVorticity,
297       & useAbsVorticity,       & useAbsVorticity,
298       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
299       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
300       & multiDimAdvection, forcing_In_AB,       & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,
301       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
302       & periodicExternalForcing,       & periodicExternalForcing,
303         & fluidIsAir, fluidIsWater,
304       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
305       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
306       & allowFreezing, useOldFreezing, groundAtK1,       & allowFreezing, useOldFreezing, groundAtK1,
307       & usePickupBeforeC35, debugMode,       & usePickupBeforeC35, usePickupBeforeC54, debugMode,
308       & readPickupWithTracer, writePickupWithTracer       & readPickupWithTracer, writePickupWithTracer,
309         & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
310         & timeave_mdsio, snapshot_mdsio, monitor_stdio,
311         & outputTypesInclusive,
312         & inAdMode, inAdTrue, inAdFalse, inAdExact,
313         & calendarDumps
314    
315        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
316        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
317          LOGICAL usingCylindricalGrid
318        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
319        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
320        LOGICAL useNHMTerms        LOGICAL useNHMTerms
# Line 288  C     groundAtK1  :: put the surface(k=1 Line 327  C     groundAtK1  :: put the surface(k=1
327        LOGICAL momPressureForcing        LOGICAL momPressureForcing
328        LOGICAL useCoriolis        LOGICAL useCoriolis
329        LOGICAL vectorInvariantMomentum        LOGICAL vectorInvariantMomentum
       LOGICAL tempDiffusion  
330        LOGICAL tempAdvection        LOGICAL tempAdvection
331        LOGICAL tempForcing        LOGICAL tempForcing
       LOGICAL saltDiffusion  
332        LOGICAL saltAdvection        LOGICAL saltAdvection
333        LOGICAL saltForcing        LOGICAL saltForcing
334        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
# Line 302  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
# Line 310  C     groundAtK1  :: put the surface(k=1 Line 346  C     groundAtK1  :: put the surface(k=1
346        LOGICAL useCDscheme        LOGICAL useCDscheme
347        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
348        LOGICAL useJamartWetPoints        LOGICAL useJamartWetPoints
349          LOGICAL useJamartMomAdv
350        LOGICAL SadournyCoriolis        LOGICAL SadournyCoriolis
351        LOGICAL upwindVorticity        LOGICAL upwindVorticity
352        LOGICAL highOrderVorticity        LOGICAL highOrderVorticity
# Line 320  C     groundAtK1  :: put the surface(k=1 Line 357  C     groundAtK1  :: put the surface(k=1
357        LOGICAL saltImplVertAdv        LOGICAL saltImplVertAdv
358        LOGICAL momImplVertAdv        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
364        LOGICAL doTr1ClimRelax        LOGICAL doTr1ClimRelax
365        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
366          LOGICAL fluidIsAir
367          LOGICAL fluidIsWater
368        LOGICAL usingPCoords        LOGICAL usingPCoords
369        LOGICAL usingZCoords        LOGICAL usingZCoords
370        LOGICAL useDynP_inEos_Zc        LOGICAL useDynP_inEos_Zc
# Line 337  C     groundAtK1  :: put the surface(k=1 Line 377  C     groundAtK1  :: put the surface(k=1
377        LOGICAL useOldFreezing        LOGICAL useOldFreezing
378        LOGICAL groundAtK1        LOGICAL groundAtK1
379        LOGICAL usePickupBeforeC35        LOGICAL usePickupBeforeC35
380          LOGICAL usePickupBeforeC54
381        LOGICAL debugMode        LOGICAL debugMode
382        LOGICAL readPickupWithTracer        LOGICAL readPickupWithTracer
383        LOGICAL writePickupWithTracer        LOGICAL writePickupWithTracer
384          LOGICAL pickup_read_mdsio, pickup_write_mdsio
385          LOGICAL pickup_write_immed
386          LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
387          LOGICAL outputTypesInclusive
388          LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
389          LOGICAL calendarDumps
390    
391  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
392  C     gg2dTargetResidual  C     cg2dTargetResidual
393  C          :: Target residual for cg2d solver; no unit (RHS normalisation)  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
394  C     cg2dTargetResWunit  C     cg2dTargetResWunit
395  C          :: Target residual for cg2d solver; W unit (No RHS normalisation)  C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
# Line 372  C     gBaro     :: Accel. due to gravity Line 419  C     gBaro     :: Accel. due to gravity
419  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil    :: Reference density for the linear equation of state
420  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density
421  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
422    C     tRef      :: reference vertical profile for potential temperature
423    C     sRef      :: reference vertical profile for salinity/specific humidity
424  C     startTime :: Start time for model ( s )  C     startTime :: Start time for model ( s )
425  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
426  C     thetaMin  :: Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
# Line 386  C     omega     :: Angular velocity ( ra Line 435  C     omega     :: Angular velocity ( ra
435  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
436  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscAh    :: Eddy viscosity coeff. for mixing of
437  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
438    C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical
439    C                 momentum laterally, no effect for hydrostatic
440    C                 model, defaults to viscAh if unset ( m^2/s )
441  C     viscAr    :: Eddy viscosity coeff. for mixing of  C     viscAr    :: Eddy viscosity coeff. for mixing of
442  C                 momentum vertically ( units of r^2/s )  C                 momentum vertically ( units of r^2/s )
443  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
444  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
445    C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical
446    C                 momentum laterally, no effect for hydrostatic
447    C                 model, defaults to viscA4 if unset ( m^2/s )
448    C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally
449    C                  (act on Divergence part) ( m^2/s )
450    C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally
451    C                  (act on Vorticity  part) ( m^2/s )
452    C     viscA4D   :: Biharmonic viscosity coeff. for mixing of momentum laterally
453    C                  (act on Divergence part) ( m^4/s )
454    C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally
455    C                  (act on Vorticity  part) ( m^4/s )
456  C     viscC2leith :: Leith non-dimensional viscosity factor  C     viscC2leith :: Leith non-dimensional viscosity factor
457  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of
458  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
# Line 397  C     viscA4Max :: Maximum biharmonic vi Line 460  C     viscA4Max :: Maximum biharmonic vi
460  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
461  C     viscAhGrid:: non-dimensional grid-size dependent viscosity  C     viscAhGrid:: non-dimensional grid-size dependent viscosity
462  C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity  C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
463    C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
464    C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity
465  C     viscC4leith :: Leith non-dimensional viscosity factor  C     viscC4leith :: Leith non-dimensional viscosity factor
466  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
467  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
468  C     diffKrT   :: Laplacian diffusion coeff. for mixing of  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
469  C                 heat vertically ( units of r^2/s )  C                 for mixing of heat vertically ( units of r^2/s )
470  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
471  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
472  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
473  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
474  C     diffKrS   :: Laplacian diffusion coeff. for mixing of  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
475  C                 salt vertically ( units of r^2/s )  C                 for mixing of salt vertically ( units of r^2/s ),
476  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
477  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
478    C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
479    C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
480    C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979
481    C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979
482  C     deltaT    :: Default timestep ( s )  C     deltaT    :: Default timestep ( s )
483  C     deltaTClock  :: Timestep used as model "clock". This determines the  C     deltaTClock  :: Timestep used as model "clock". This determines the
484  C                    IO frequencies and is used in tagging output. It can  C                    IO frequencies and is used in tagging output. It can
# Line 418  C                    it will be the deep Line 487  C                    it will be the deep
487  C                    Frequency of checkpointing and dumping of the model state  C                    Frequency of checkpointing and dumping of the model state
488  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
489  C     deltaTMom    :: Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
490  C     deltaTtracer :: Timestep for tracer equations ( s )  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k
491  C     deltaTfreesurf :: Timestep for free-surface equation ( s )  C     deltaTfreesurf :: Timestep for free-surface equation ( s )
492  C     freesurfFac  :: Parameter to turn implicit free surface term on or off  C     freesurfFac  :: Parameter to turn implicit free surface term on or off
493  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
# Line 471  C     convertFW2Salt :: salinity, used t Line 540  C     convertFW2Salt :: salinity, used t
540  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
541  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
542  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
 C     trac_EvPrRn :: tracer concentration in Rain & Evap.  
543  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
544  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
545  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 485  C      --"-"--  Quadratic  ( linear: 1/s Line 553  C      --"-"--  Quadratic  ( linear: 1/s
553        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
554       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
555       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
556       & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
557       & abeps, startTime,       & abeps, startTime,
558       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
559       & fCori, fCoriG, fCoriCos,       & fCori, fCoriG, fCoriCos,
560       & viscAh,  viscAhMax, viscAhGrid, viscC2leith,       & viscAh, viscAhW, viscAhMax, viscAhGrid, viscC2leith,
561       & viscA4,  viscA4Max, viscA4Grid, viscC4leith,       & viscAhD, viscAhZ, viscA4D, viscA4Z,
562       & viscAr, viscAstrain, viscAtension,       & viscA4, viscA4W,
563       & diffKhT, diffK4T, diffKrT,       & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,
564       & diffKhS, diffK4S, diffKrS,       & viscC4leith, viscAr, viscAstrain, viscAtension,
565         & diffKhT, diffK4T, diffKrNrT,
566         & diffKhS, diffK4S, diffKrNrS,
567         & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
568       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
569       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
570       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
571       & recip_rhoConst, rhoConst,       & recip_rhoConst, rhoConst,
572       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
573       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,
574       & diagFreq, taveFreq, tave_lastIter, monitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
575       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
576       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq, omega, rotationPeriod,
577       & tauThetaClimRelax, lambdaThetaClimRelax,       & tauThetaClimRelax, lambdaThetaClimRelax,
578       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
579       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
580       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
581       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
582       & hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
583       & horiVertRatio, recip_horiVertRatio,       & horiVertRatio, recip_horiVertRatio,
584       & ivdc_kappa, Ro_SeaLevel,       & ivdc_kappa, Ro_SeaLevel,
585       & bottomDragLinear,bottomDragQuadratic       & bottomDragLinear,bottomDragQuadratic,
586         & tCylIn, tCylOut
587    
588        _RL cg2dTargetResidual        _RL cg2dTargetResidual
589        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
# Line 524  C      --"-"--  Quadratic  ( linear: 1/s Line 596  C      --"-"--  Quadratic  ( linear: 1/s
596        _RL deltaT        _RL deltaT
597        _RL deltaTClock        _RL deltaTClock
598        _RL deltaTmom        _RL deltaTmom
599        _RL deltaTtracer        _RL dTtracerLev(Nr)
600        _RL deltaTfreesurf        _RL deltaTfreesurf
601        _RL abeps        _RL abeps
602        _RL phiMin        _RL phiMin
# Line 543  C      --"-"--  Quadratic  ( linear: 1/s Line 615  C      --"-"--  Quadratic  ( linear: 1/s
615        _RL hFacSup        _RL hFacSup
616        _RL beta        _RL beta
617        _RL viscAh        _RL viscAh
618          _RL viscAhW
619          _RL viscAhD
620          _RL viscAhZ
621        _RL viscAhMax        _RL viscAhMax
622        _RL viscAhGrid        _RL viscAhGrid
623        _RL viscC2leith        _RL viscC2leith
# Line 550  C      --"-"--  Quadratic  ( linear: 1/s Line 625  C      --"-"--  Quadratic  ( linear: 1/s
625        _RL viscAtension        _RL viscAtension
626        _RL viscAr        _RL viscAr
627        _RL viscA4        _RL viscA4
628          _RL viscA4W
629          _RL viscA4D
630          _RL viscA4Z
631        _RL viscA4Max        _RL viscA4Max
632        _RL viscA4Grid        _RL viscA4Grid, viscA4GridMax, viscA4GridMin
633        _RL viscC4leith        _RL viscC4leith
634        _RL diffKhT        _RL diffKhT
635        _RL diffKrT        _RL diffKrNrT(Nr)
636        _RL diffK4T        _RL diffK4T
637        _RL diffKhS        _RL diffKhS
638        _RL diffKrS        _RL diffKrNrS(Nr)
639        _RL diffK4S        _RL diffK4S
640          _RL diffKrBL79surf
641          _RL diffKrBL79deep
642          _RL diffKrBL79scl
643          _RL diffKrBL79Ho
644        _RL delt        _RL delt
645        _RL tauCD        _RL tauCD
646        _RL rCD        _RL rCD
# Line 586  C      --"-"--  Quadratic  ( linear: 1/s Line 668  C      --"-"--  Quadratic  ( linear: 1/s
668        _RL taveFreq        _RL taveFreq
669        _RL tave_lastIter        _RL tave_lastIter
670        _RL monitorFreq        _RL monitorFreq
671          _RL adjMonitorFreq
672        _RL afFacMom        _RL afFacMom
673        _RL vfFacMom        _RL vfFacMom
674        _RL pfFacMom        _RL pfFacMom
# Line 608  C      --"-"--  Quadratic  ( linear: 1/s Line 691  C      --"-"--  Quadratic  ( linear: 1/s
691        _RL convertFW2Salt        _RL convertFW2Salt
692        _RL temp_EvPrRn        _RL temp_EvPrRn
693        _RL salt_EvPrRn        _RL salt_EvPrRn
       _RL trac_EvPrRn  
694        _RL horiVertRatio        _RL horiVertRatio
695        _RL recip_horiVertRatio        _RL recip_horiVertRatio
696        _RL ivdc_kappa        _RL ivdc_kappa
697        _RL Ro_SeaLevel        _RL Ro_SeaLevel
698        _RL bottomDragLinear        _RL bottomDragLinear
699        _RL bottomDragQuadratic        _RL bottomDragQuadratic
700          _RL tCylIn
701          _RL tCylOut
702    
703  C--   COMMON /PARM_A/ Thermodynamics constants ?  C--   COMMON /PARM_A/ Thermodynamics constants ?
704        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
# Line 642  C             derived from the orography Line 726  C             derived from the orography
726        INTEGER integr_GeoPot, selectFindRoSurf        INTEGER integr_GeoPot, selectFindRoSurf
727    
728  C Logical flags for selecting packages  C Logical flags for selecting packages
729          LOGICAL useOPPS
730          LOGICAL usePP81
731          LOGICAL useMY82
732          LOGICAL useGGL90
733        LOGICAL useKPP        LOGICAL useKPP
734        LOGICAL useGMRedi        LOGICAL useGMRedi
735        LOGICAL useOBCS        LOGICAL useOBCS
# Line 653  C Logical flags for selecting packages Line 741  C Logical flags for selecting packages
741        LOGICAL useZONAL_FILT        LOGICAL useZONAL_FILT
742        LOGICAL useFLT        LOGICAL useFLT
743        LOGICAL usePTRACERS        LOGICAL usePTRACERS
744          LOGICAL useGCHEM
745        LOGICAL useSBO        LOGICAL useSBO
746        LOGICAL useSEAICE        LOGICAL useSEAICE
747        LOGICAL useBulkForce        LOGICAL useBulkForce
# Line 661  C Logical flags for selecting packages Line 750  C Logical flags for selecting packages
750        LOGICAL usegridalt        LOGICAL usegridalt
751        LOGICAL usediagnostics        LOGICAL usediagnostics
752        LOGICAL useEBM        LOGICAL useEBM
753          LOGICAL useMNC
754        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
755       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
756       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
757       &        usePTRACERS,  useSBO, useSEAICE, useThSIce, useBulkForce,       &        usePTRACERS, useGCHEM,
758       &        usefizhi,  usegridalt, usediagnostics, useEBM       &        useSBO, useSEAICE, useThSIce, useBulkForce,
759         &        usefizhi, usegridalt, usediagnostics, useEBM, useMNC,
760  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_write, 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_write, mnc_pickup_read,  
      &     mnc_outdir_str, mnc_indir_str,  
      &     mnc_use_for_mon  
   
761    
762  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
763  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
Legend:
Removed from v.1.111  
changed lines
  Added in v.1.145
  ViewVC Help
Powered by ViewVC 1.1.22