/[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.96 by jmc, Wed Oct 29 00:17:44 2003 UTC revision 1.142 by afe, Tue Jan 11 20:49:24 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     buoyancyRelation :: Flag used to indicate which relation to use to  C     buoyancyRelation :: Flag used to indicate which relation to use to
74  C                        get buoyancy.  C                        get buoyancy.
75  C     eosType         :: choose the equation of state:  C     eosType         :: choose the equation of state:
76  C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS  C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
77    C     the_run_name    :: string identifying the name of the model "run"
78        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/ checkPtSuff,
79       &                bathyFile, topoFile,       &                bathyFile, topoFile,
80       &                hydrogThetaFile, hydrogSaltFile,       &                hydrogThetaFile, hydrogSaltFile,
81       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
82       &                saltClimFile, buoyancyRelation,       &                saltClimFile, buoyancyRelation,
83       &                EmPmRfile, surfQfile, surfQswfile,       &                EmPmRfile, saltFluxFile,
84         &                surfQfile, surfQnetFile, surfQswFile,
85       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
86       &                dQdTfile, ploadFile,       &                dQdTfile, ploadFile,
87       &                eosType, pickupSuff,       &                eosType, pickupSuff,
88       &                mdsioLocalDir       &                mdsioLocalDir,
89         &                the_run_name
90        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
91        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
92        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
# Line 93  C                        LINEAR, POLY3, Line 96  C                        LINEAR, POLY3,
96        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
97        CHARACTER*(MAX_LEN_FNAM) saltClimFile        CHARACTER*(MAX_LEN_FNAM) saltClimFile
98        CHARACTER*(MAX_LEN_FNAM) surfQfile        CHARACTER*(MAX_LEN_FNAM) surfQfile
99        CHARACTER*(MAX_LEN_FNAM) surfQswfile        CHARACTER*(MAX_LEN_FNAM) surfQnetFile
100          CHARACTER*(MAX_LEN_FNAM) surfQswFile
101        CHARACTER*(MAX_LEN_FNAM) EmPmRfile        CHARACTER*(MAX_LEN_FNAM) EmPmRfile
102          CHARACTER*(MAX_LEN_FNAM) saltFluxFile
103        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
104        CHARACTER*(MAX_LEN_FNAM) uVelInitFile        CHARACTER*(MAX_LEN_FNAM) uVelInitFile
105        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
# Line 102  C                        LINEAR, POLY3, Line 107  C                        LINEAR, POLY3,
107        CHARACTER*(MAX_LEN_FNAM) dQdTfile        CHARACTER*(MAX_LEN_FNAM) dQdTfile
108        CHARACTER*(MAX_LEN_FNAM) ploadFile        CHARACTER*(MAX_LEN_FNAM) ploadFile
109        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
110          CHARACTER*(MAX_LEN_FNAM) the_run_name
111        CHARACTER*(6) eosType        CHARACTER*(6) eosType
112        CHARACTER*(10) pickupSuff        CHARACTER*(10) pickupSuff
113    
# Line 110  C     cg2dMaxIters        :: Maximum num Line 116  C     cg2dMaxIters        :: Maximum num
116  C                           two-dimensional con. grad solver.  C                           two-dimensional con. grad solver.
117  C     cg2dChkResFreq      :: Frequency with which to check residual  C     cg2dChkResFreq      :: Frequency with which to check residual
118  C                           in con. grad solver.  C                           in con. grad solver.
119    C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner
120    C                            (non-linear free-surf.)
121  C     cg3dMaxIters        :: Maximum number of iterations in the  C     cg3dMaxIters        :: Maximum number of iterations in the
122  C                           three-dimensional con. grad solver.  C                           three-dimensional con. grad solver.
123  C     cg3dChkResFreq      :: Frequency with which to check residual  C     cg3dChkResFreq      :: Frequency with which to check residual
# Line 126  C     nonlinFreeSurf      :: option rela Line 134  C     nonlinFreeSurf      :: option rela
134  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
135  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
136  C                           =0 (default) use r coord. ; > 0 use r*  C                           =0 (default) use r coord. ; > 0 use r*
137    C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
138    C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
139    C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
140    C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector
141    C     debugLevel          :: debug level selector: higher -> more writing
142    
143        COMMON /PARM_I/        COMMON /PARM_I/
144       &        cg2dMaxIters,       &        cg2dMaxIters,
145       &        cg2dChkResFreq,       &        cg2dChkResFreq, cg2dPreCondFreq,
146       &        cg3dMaxIters,       &        cg3dMaxIters,
147       &        cg3dChkResFreq,       &        cg3dChkResFreq,
148       &        nIter0, nTimeSteps, nEndIter,       &        nIter0, nTimeSteps, nEndIter,
# Line 137  C                           =0 (default) Line 150  C                           =0 (default)
150       &        writeStatePrec, nCheckLev,       &        writeStatePrec, nCheckLev,
151       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
152       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
153       &        tempAdvScheme, saltAdvScheme, tracerAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
154         &        saltAdvScheme, saltVertAdvScheme,
155       &        debugLevel       &        debugLevel
156        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
157        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
158          INTEGER cg2dPreCondFreq
159        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
160        INTEGER cg3dChkResFreq        INTEGER cg3dChkResFreq
161        INTEGER nIter0        INTEGER nIter0
# Line 153  C                           =0 (default) Line 168  C                           =0 (default)
168        INTEGER nCheckLev        INTEGER nCheckLev
169        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
170        INTEGER select_rStar        INTEGER select_rStar
171        INTEGER tempAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
172        INTEGER saltAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
       INTEGER tracerAdvScheme  
173        INTEGER debugLevel        INTEGER debugLevel
174    
175  C  C
# Line 171  C     usingCartesianGrid :: If TRUE grid Line 185  C     usingCartesianGrid :: If TRUE grid
185  C                          coordinate frame.  C                          coordinate frame.
186  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
187  C                               spherical polar frame.  C                               spherical polar frame.
188    C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
189  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.
190  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
191  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 199  C     metricTerms   :: Flag which turns
199  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
200  C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.  C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.
201  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.  
202  C     tempAdvection :: Flag which turns advection of temperature on  C     tempAdvection :: Flag which turns advection of temperature on
203  C                     and off.  C                     and off.
204  C     tempForcing   :: Flag which turns external forcing of temperature on  C     tempForcing   :: Flag which turns external forcing of temperature on
205  C                     and off.  C                     and off.
 C     saltDiffusion :: Flag which turns diffusion of salinity on  
 C                     and off.  
206  C     saltAdvection :: Flag which turns advection of salinity on  C     saltAdvection :: Flag which turns advection of salinity on
207  C                     and off.  C                     and off.
208  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 218  C                           linear relat
218  C     momStepping   :: Turns momentum equation time-stepping off  C     momStepping   :: Turns momentum equation time-stepping off
219  C     tempStepping  :: Turns temperature equation time-stepping off  C     tempStepping  :: Turns temperature equation time-stepping off
220  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  
221  C     useConstantF  :: Coriolis parameter set to f0  C     useConstantF  :: Coriolis parameter set to f0
222  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
223  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
224  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
225  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)  C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
226    C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
227    C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny
228    C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
229    C     highOrderVorticity :: use 3rd/4th order interp. of vorticity in Coriolis
230    C     useAbsVorticity :: work with f+zeta in Coriolis terms
231  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
232  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
233    C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
234    C     saltImplVertAdv :: Turns on implicit vertical advection for Salinity
235    C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
236  C     multiDimAdvection :: Flag that enable multi-dimension advection  C     multiDimAdvection :: Flag that enable multi-dimension advection
237    C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
238  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
239  C                      out off Adams-Bashforth time stepping.  C                      out off Adams-Bashforth time stepping.
240  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
# Line 223  C                        climatology is Line 242  C                        climatology is
242  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
243  C                        climatology is required.  C                        climatology is required.
244  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
245  C     usingPCoords     :: Set to indicate that we are working in pressure  C     usingPCoords     :: Set to indicate that we are working in a pressure
246  C                        coords. (jmc: is it still used ?)  C                        type coordinate (p or p*).
247  C     usingZCoords     :: Set to indicate that we are working in height  C     usingZCoords     :: Set to indicate that we are working in a height
248  C                        coords. (jmc: is it still used ?)  C                        type coordinate (z or z*)
249    C     fluidIsAir       :: Set to indicate that the fluid major constituent
250    C                        is air
251    C     fluidIsWater     :: Set to indicate that the fluid major constituent
252    C                        is water
253  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.)
254  C                         this requires specific code for restart & exchange  C                         this requires specific code for restart & exchange
255  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 237  C     useSingleCpuIO :: On SGI platforms Line 260  C     useSingleCpuIO :: On SGI platforms
260  C                       slow (f77) or does not work (f90).  When  C                       slow (f77) or does not work (f90).  When
261  C                       useSingleCpuIO is set, mdsio_writefield.F  C                       useSingleCpuIO is set, mdsio_writefield.F
262  C                       outputs from master mpi process only.  C                       outputs from master mpi process only.
263  C     allowFreezing  :: Allows water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
264    C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
265  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
266    C     pickup_write_mdsio :: use mdsio to write pickups
267    C     pickup_read_mdsio  :: use mdsio to read  pickups
268    C     pickup_write_immed :: echo the pickup immediately (for conversion)
269    C     timeave_mdsio      :: use mdsio for timeave output
270    C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
271    C     monitor_stdio      :: use stdio for monitor output
272        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
273       & usingCurvilinearGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
274       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
275       & staggerTimeStep,       & staggerTimeStep,
276       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
277       & momPressureForcing, vectorInvariantMomentum,       & momPressureForcing, vectorInvariantMomentum,
278       & tempDiffusion, tempAdvection, tempForcing,       & tempAdvection, tempForcing,
279       & saltDiffusion, saltAdvection, saltForcing,       & saltAdvection, saltForcing,
280       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
281       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
282       & momStepping, tempStepping, saltStepping, tr1Stepping,       & momStepping, tempStepping, saltStepping,
283       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
284       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
285       & useCDscheme,       & useCDscheme,
286       & useEnergyConservingCoriolis, useJamartWetPoints,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
287         & SadournyCoriolis, upwindVorticity, highOrderVorticity,
288         & useAbsVorticity,
289       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
290       & multiDimAdvection, forcing_In_AB,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
291         & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,
292       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
293       & periodicExternalForcing,       & periodicExternalForcing,
294         & fluidIsAir, fluidIsWater,
295       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
296       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
297       & allowFreezing, groundAtK1,       & allowFreezing, useOldFreezing, groundAtK1,
298       & usePickupBeforeC35, debugMode,       & usePickupBeforeC35, usePickupBeforeC54, debugMode,
299       & readPickupWithTracer, writePickupWithTracer       & readPickupWithTracer, writePickupWithTracer,
300         & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
301         & timeave_mdsio, snapshot_mdsio, monitor_stdio,
302         & outputTypesInclusive
303    
304        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
305        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
306          LOGICAL usingCylindricalGrid
307        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
308        LOGICAL usingSphericalPolarMTerms        LOGICAL usingSphericalPolarMTerms
309        LOGICAL useNHMTerms        LOGICAL useNHMTerms
# Line 277  C     groundAtK1  :: put the surface(k=1 Line 316  C     groundAtK1  :: put the surface(k=1
316        LOGICAL momPressureForcing        LOGICAL momPressureForcing
317        LOGICAL useCoriolis        LOGICAL useCoriolis
318        LOGICAL vectorInvariantMomentum        LOGICAL vectorInvariantMomentum
       LOGICAL tempDiffusion  
319        LOGICAL tempAdvection        LOGICAL tempAdvection
320        LOGICAL tempForcing        LOGICAL tempForcing
       LOGICAL saltDiffusion  
321        LOGICAL saltAdvection        LOGICAL saltAdvection
322        LOGICAL saltForcing        LOGICAL saltForcing
323        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
# Line 291  C     groundAtK1  :: put the surface(k=1 Line 328  C     groundAtK1  :: put the surface(k=1
328        LOGICAL momStepping        LOGICAL momStepping
329        LOGICAL tempStepping        LOGICAL tempStepping
330        LOGICAL saltStepping        LOGICAL saltStepping
       LOGICAL tr1Stepping  
331        LOGICAL metricTerms        LOGICAL metricTerms
332        LOGICAL useConstantF        LOGICAL useConstantF
333        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
# Line 299  C     groundAtK1  :: put the surface(k=1 Line 335  C     groundAtK1  :: put the surface(k=1
335        LOGICAL useCDscheme        LOGICAL useCDscheme
336        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
337        LOGICAL useJamartWetPoints        LOGICAL useJamartWetPoints
338          LOGICAL useJamartMomAdv
339          LOGICAL SadournyCoriolis
340          LOGICAL upwindVorticity
341          LOGICAL highOrderVorticity
342          LOGICAL useAbsVorticity
343        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
344        LOGICAL implicitViscosity        LOGICAL implicitViscosity
345          LOGICAL tempImplVertAdv
346          LOGICAL saltImplVertAdv
347          LOGICAL momImplVertAdv
348        LOGICAL multiDimAdvection        LOGICAL multiDimAdvection
349          LOGICAL useMultiDimAdvec
350        LOGICAL forcing_In_AB        LOGICAL forcing_In_AB
351        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
352        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
353        LOGICAL doTr1ClimRelax        LOGICAL doTr1ClimRelax
354        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
355          LOGICAL fluidIsAir
356          LOGICAL fluidIsWater
357        LOGICAL usingPCoords        LOGICAL usingPCoords
358        LOGICAL usingZCoords        LOGICAL usingZCoords
359        LOGICAL useDynP_inEos_Zc        LOGICAL useDynP_inEos_Zc
# Line 316  C     groundAtK1  :: put the surface(k=1 Line 363  C     groundAtK1  :: put the surface(k=1
363        LOGICAL globalFiles        LOGICAL globalFiles
364        LOGICAL useSingleCpuIO        LOGICAL useSingleCpuIO
365        LOGICAL allowFreezing        LOGICAL allowFreezing
366          LOGICAL useOldFreezing
367        LOGICAL groundAtK1        LOGICAL groundAtK1
368        LOGICAL usePickupBeforeC35        LOGICAL usePickupBeforeC35
369          LOGICAL usePickupBeforeC54
370        LOGICAL debugMode        LOGICAL debugMode
371        LOGICAL readPickupWithTracer        LOGICAL readPickupWithTracer
372        LOGICAL writePickupWithTracer        LOGICAL writePickupWithTracer
373          LOGICAL pickup_read_mdsio, pickup_write_mdsio
374          LOGICAL pickup_write_immed
375          LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
376          LOGICAL outputTypesInclusive
377    
378  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
379  C     gg2dTargetResidual  C     cg2dTargetResidual
380  C          :: Target residual for cg2d solver; no unit (RHS normalisation)  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
381  C     cg2dTargetResWunit  C     cg2dTargetResWunit
382  C          :: Target residual for cg2d solver; W unit (No RHS normalisation)  C          :: Target residual for cg2d solver; W unit (No RHS normalisation)
# Line 353  C     gBaro     :: Accel. due to gravity Line 406  C     gBaro     :: Accel. due to gravity
406  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil    :: Reference density for the linear equation of state
407  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density
408  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
409    C     tRef      :: reference vertical profile for potential temperature
410    C     sRef      :: reference vertical profile for salinity/specific humidity
411  C     startTime :: Start time for model ( s )  C     startTime :: Start time for model ( s )
412  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
413  C     thetaMin  :: Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
# Line 367  C     omega     :: Angular velocity ( ra Line 422  C     omega     :: Angular velocity ( ra
422  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
423  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscAh    :: Eddy viscosity coeff. for mixing of
424  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
425    C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical
426    C                 momentum laterally, no effect for hydrostatic
427    C                 model, defaults to viscAh if unset ( m^2/s )
428  C     viscAr    :: Eddy viscosity coeff. for mixing of  C     viscAr    :: Eddy viscosity coeff. for mixing of
429  C                 momentum vertically ( units of r^2/s )  C                 momentum vertically ( units of r^2/s )
430  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
431  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
432    C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical
433    C                 momentum laterally, no effect for hydrostatic
434    C                 model, defaults to viscA4 if unset ( m^2/s )
435    C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally
436    C                  (act on Divergence part) ( m^2/s )
437    C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally
438    C                  (act on Vorticity  part) ( m^2/s )
439    C     viscA4D   :: Biharmonic viscosity coeff. for mixing of momentum laterally
440    C                  (act on Divergence part) ( m^4/s )
441    C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally
442    C                  (act on Vorticity  part) ( m^4/s )
443    C     viscC2leith :: Leith non-dimensional viscosity factor
444    C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of
445    C                 momentum laterally ( m^2/s )
446    C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
447    C                 momentum laterally ( m^4/s )
448    C     viscAhGrid:: non-dimensional grid-size dependent viscosity
449    C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
450    C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
451    C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity
452    C     viscC4leith :: Leith non-dimensional viscosity factor
453  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
454  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
455  C     diffKrT   :: Laplacian diffusion coeff. for mixing of  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
456  C                 heat vertically ( units of r^2/s )  C                 for mixing of heat vertically ( units of r^2/s )
457  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
458  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
459  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
460  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
461  C     diffKrS   :: Laplacian diffusion coeff. for mixing of  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
462  C                 salt vertically ( units of r^2/s )  C                 for mixing of salt vertically ( units of r^2/s ),
463  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
464  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
465    C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
466    C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
467    C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979
468    C     diffKrBL79Ho   :: depth offset for arctan fn (m) Bryan and Lewis, 1979
469  C     deltaT    :: Default timestep ( s )  C     deltaT    :: Default timestep ( s )
470  C     deltaTClock  :: Timestep used as model "clock". This determines the  C     deltaTClock  :: Timestep used as model "clock". This determines the
471  C                    IO frequencies and is used in tagging output. It can  C                    IO frequencies and is used in tagging output. It can
# Line 391  C                    it will be the deep Line 474  C                    it will be the deep
474  C                    Frequency of checkpointing and dumping of the model state  C                    Frequency of checkpointing and dumping of the model state
475  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
476  C     deltaTMom    :: Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
477  C     deltaTtracer :: Timestep for tracer equations ( s )  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k
478  C     deltaTfreesurf :: Timestep for free-surface equation ( s )  C     deltaTfreesurf :: Timestep for free-surface equation ( s )
479  C     freesurfFac  :: Parameter to turn implicit free surface term on or off  C     freesurfFac  :: Parameter to turn implicit free surface term on or off
480  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
# Line 444  C     convertFW2Salt :: salinity, used t Line 527  C     convertFW2Salt :: salinity, used t
527  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
528  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
529  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
 C     trac_EvPrRn :: tracer concentration in Rain & Evap.  
530  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
531  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
532  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 458  C      --"-"--  Quadratic  ( linear: 1/s Line 540  C      --"-"--  Quadratic  ( linear: 1/s
540        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
541       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
542       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
543       & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, 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,  viscA4,  viscAr, viscAstrain, viscAtension,       & viscAh, viscAhW, viscAhMax, viscAhGrid, viscC2leith,
548       & diffKhT, diffK4T, diffKrT,       & viscAhD, viscAhZ, viscA4D, viscA4Z,
549       & diffKhS, diffK4S, diffKrS,       & viscA4, viscA4W,
550         & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,
551         & viscC4leith, viscAr, viscAstrain, viscAtension,
552         & diffKhT, diffK4T, diffKrNrT,
553         & diffKhS, diffK4S, diffKrNrS,
554         & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
555       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
556       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
557       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
558       & recip_rhoConst, rhoConst,       & recip_rhoConst, rhoConst,
559       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
560       & endTime, chkPtFreq, pchkPtFreq, dumpFreq,       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,
561       & diagFreq, taveFreq, tave_lastIter, monitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq,
562       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
563       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq, omega, rotationPeriod,
# Line 478  C      --"-"--  Quadratic  ( linear: 1/s Line 565  C      --"-"--  Quadratic  ( linear: 1/s
565       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
566       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
567       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
568       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
569       & hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
570       & horiVertRatio, recip_horiVertRatio,       & horiVertRatio, recip_horiVertRatio,
571       & ivdc_kappa, Ro_SeaLevel,       & ivdc_kappa, Ro_SeaLevel,
572       & bottomDragLinear,bottomDragQuadratic       & bottomDragLinear,bottomDragQuadratic,
573         & tCylIn, tCylOut
574    
575        _RL cg2dTargetResidual        _RL cg2dTargetResidual
576        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
# Line 495  C      --"-"--  Quadratic  ( linear: 1/s Line 583  C      --"-"--  Quadratic  ( linear: 1/s
583        _RL deltaT        _RL deltaT
584        _RL deltaTClock        _RL deltaTClock
585        _RL deltaTmom        _RL deltaTmom
586        _RL deltaTtracer        _RL dTtracerLev(Nr)
587        _RL deltaTfreesurf        _RL deltaTfreesurf
588        _RL abeps        _RL abeps
589        _RL phiMin        _RL phiMin
# Line 514  C      --"-"--  Quadratic  ( linear: 1/s Line 602  C      --"-"--  Quadratic  ( linear: 1/s
602        _RL hFacSup        _RL hFacSup
603        _RL beta        _RL beta
604        _RL viscAh        _RL viscAh
605          _RL viscAhW
606          _RL viscAhD
607          _RL viscAhZ
608          _RL viscAhMax
609          _RL viscAhGrid
610          _RL viscC2leith
611        _RL viscAstrain        _RL viscAstrain
612        _RL viscAtension        _RL viscAtension
613        _RL viscAr        _RL viscAr
614        _RL viscA4        _RL viscA4
615          _RL viscA4W
616          _RL viscA4D
617          _RL viscA4Z
618          _RL viscA4Max
619          _RL viscA4Grid, viscA4GridMax, viscA4GridMin
620          _RL viscC4leith
621        _RL diffKhT        _RL diffKhT
622        _RL diffKrT        _RL diffKrNrT(Nr)
623        _RL diffK4T        _RL diffK4T
624        _RL diffKhS        _RL diffKhS
625        _RL diffKrS        _RL diffKrNrS(Nr)
626        _RL diffK4S        _RL diffK4S
627          _RL diffKrBL79surf
628          _RL diffKrBL79deep
629          _RL diffKrBL79scl
630          _RL diffKrBL79Ho
631        _RL delt        _RL delt
632        _RL tauCD        _RL tauCD
633        _RL rCD        _RL rCD
# Line 546  C      --"-"--  Quadratic  ( linear: 1/s Line 650  C      --"-"--  Quadratic  ( linear: 1/s
650        _RL chkPtFreq        _RL chkPtFreq
651        _RL pChkPtFreq        _RL pChkPtFreq
652        _RL dumpFreq        _RL dumpFreq
653          _RL adjDumpFreq
654        _RL diagFreq        _RL diagFreq
655        _RL taveFreq        _RL taveFreq
656        _RL tave_lastIter        _RL tave_lastIter
# Line 572  C      --"-"--  Quadratic  ( linear: 1/s Line 677  C      --"-"--  Quadratic  ( linear: 1/s
677        _RL convertFW2Salt        _RL convertFW2Salt
678        _RL temp_EvPrRn        _RL temp_EvPrRn
679        _RL salt_EvPrRn        _RL salt_EvPrRn
       _RL trac_EvPrRn  
680        _RL horiVertRatio        _RL horiVertRatio
681        _RL recip_horiVertRatio        _RL recip_horiVertRatio
682        _RL ivdc_kappa        _RL ivdc_kappa
683        _RL Ro_SeaLevel        _RL Ro_SeaLevel
684        _RL bottomDragLinear        _RL bottomDragLinear
685        _RL bottomDragQuadratic        _RL bottomDragQuadratic
686          _RL tCylIn
687          _RL tCylOut
688    
689  C--   COMMON /PARM_A/ Thermodynamics constants ?  C--   COMMON /PARM_A/ Thermodynamics constants ?
690        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
# Line 606  C             derived from the orography Line 712  C             derived from the orography
712        INTEGER integr_GeoPot, selectFindRoSurf        INTEGER integr_GeoPot, selectFindRoSurf
713    
714  C Logical flags for selecting packages  C Logical flags for selecting packages
715          LOGICAL useOPPS
716          LOGICAL usePP81
717          LOGICAL useMY82
718          LOGICAL useGGL90
719        LOGICAL useKPP        LOGICAL useKPP
720        LOGICAL useGMRedi        LOGICAL useGMRedi
721        LOGICAL useOBCS        LOGICAL useOBCS
# Line 617  C Logical flags for selecting packages Line 727  C Logical flags for selecting packages
727        LOGICAL useZONAL_FILT        LOGICAL useZONAL_FILT
728        LOGICAL useFLT        LOGICAL useFLT
729        LOGICAL usePTRACERS        LOGICAL usePTRACERS
730          LOGICAL useGCHEM
731        LOGICAL useSBO        LOGICAL useSBO
732        LOGICAL useSEAICE        LOGICAL useSEAICE
733        LOGICAL useBulkforce        LOGICAL useBulkForce
734        LOGICAL useThermSEAICE        LOGICAL useThSIce
735          LOGICAL usefizhi
736          LOGICAL usegridalt
737          LOGICAL usediagnostics
738          LOGICAL useEBM
739          LOGICAL useMNC
740        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
741       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
742       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
743       &        usePTRACERS,  useSBO, useSEAICE,       &        usePTRACERS, useGCHEM,
744       &        useThermSEAICE, useBulkforce       &        useSBO, useSEAICE, useThSIce, useBulkForce,
745         &        usefizhi, usegridalt, usediagnostics, useEBM, useMNC,
746         &        usePP81, useMY82, useOPPS, useGGL90
747    
748    CEH3 ;;; Local Variables: ***
749    CEH3 ;;; mode:fortran ***
750    CEH3 ;;; End: ***

Legend:
Removed from v.1.96  
changed lines
  Added in v.1.142

  ViewVC Help
Powered by ViewVC 1.1.22