/[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.122 by edhill, Sat Sep 4 18:19:21 2004 UTC revision 1.159 by jmc, Thu Jun 9 15:53:19 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 71  C     surfQnetFile    :: File containing Line 68  C     surfQnetFile    :: File containing
68  C     surfQswFile     :: File containing surface shortwave radiation  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, surfQnetFile, surfQswFile,       &                EmPmRfile, saltFluxFile,
86         &                surfQfile, surfQnetFile, surfQswFile,
87         &                lambdaThetaFile, lambdaSaltFile,
88       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
89       &                dQdTfile, ploadFile,       &                dQdTfile, ploadFile,
90         &                eddyTauxFile, eddyTauyFile,
91       &                eosType, pickupSuff,       &                eosType, pickupSuff,
92       &                mdsioLocalDir       &                mdsioLocalDir,
93         &                the_run_name
94        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
95        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
96        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
# Line 98  C                        LINEAR, POLY3, Line 103  C                        LINEAR, POLY3,
103        CHARACTER*(MAX_LEN_FNAM) surfQnetFile        CHARACTER*(MAX_LEN_FNAM) surfQnetFile
104        CHARACTER*(MAX_LEN_FNAM) surfQswFile        CHARACTER*(MAX_LEN_FNAM) surfQswFile
105        CHARACTER*(MAX_LEN_FNAM) EmPmRfile        CHARACTER*(MAX_LEN_FNAM) EmPmRfile
106          CHARACTER*(MAX_LEN_FNAM) saltFluxFile
107        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
108        CHARACTER*(MAX_LEN_FNAM) uVelInitFile        CHARACTER*(MAX_LEN_FNAM) uVelInitFile
109        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
110        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
111        CHARACTER*(MAX_LEN_FNAM) dQdTfile        CHARACTER*(MAX_LEN_FNAM) dQdTfile
112        CHARACTER*(MAX_LEN_FNAM) ploadFile        CHARACTER*(MAX_LEN_FNAM) ploadFile
113          CHARACTER*(MAX_LEN_FNAM) eddyTauxFile
114          CHARACTER*(MAX_LEN_FNAM) eddyTauyFile
115          CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
116          CHARACTER*(MAX_LEN_FNAM) lambdaSaltFile
117        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
118          CHARACTER*(MAX_LEN_FNAM) the_run_name
119        CHARACTER*(6) eosType        CHARACTER*(6) eosType
120        CHARACTER*(10) pickupSuff        CHARACTER*(10) pickupSuff
121    
# Line 149  C     debugLevel          :: debug level Line 160  C     debugLevel          :: debug level
160       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
161       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
162       &        saltAdvScheme, saltVertAdvScheme,       &        saltAdvScheme, saltVertAdvScheme,
      &        tracerAdvScheme,  
163       &        debugLevel       &        debugLevel
164        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
165        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
# Line 168  C     debugLevel          :: debug level Line 178  C     debugLevel          :: debug level
178        INTEGER select_rStar        INTEGER select_rStar
179        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
180        INTEGER saltAdvScheme, saltVertAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
       INTEGER tracerAdvScheme  
181        INTEGER debugLevel        INTEGER debugLevel
182    
183  C  C
# Line 198  C     metricTerms   :: Flag which turns Line 207  C     metricTerms   :: Flag which turns
207  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.
208  C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.  C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.
209  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.  
210  C     tempAdvection :: Flag which turns advection of temperature on  C     tempAdvection :: Flag which turns advection of temperature on
211  C                     and off.  C                     and off.
212  C     tempForcing   :: Flag which turns external forcing of temperature on  C     tempForcing   :: Flag which turns external forcing of temperature on
213  C                     and off.  C                     and off.
 C     saltDiffusion :: Flag which turns diffusion of salinity on  
 C                     and off.  
214  C     saltAdvection :: Flag which turns advection of salinity on  C     saltAdvection :: Flag which turns advection of salinity on
215  C                     and off.  C                     and off.
216  C     saltForcing   :: Flag which turns external forcing of salinity on  C     saltForcing   :: Flag which turns external forcing of salinity on
# Line 213  C                     and off. Line 218  C                     and off.
218  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
219  C                         as a real Fresh Water (=> changes the Sea Level)  C                         as a real Fresh Water (=> changes the Sea Level)
220  C                         if F, converts P+R-E to salt flux (no SL effect)  C                         if F, converts P+R-E to salt flux (no SL effect)
221    C     useFullLeith   :: Set to true to use full Leith viscosity (may be unstable
222    C                       on irregular grids)
223    C     useAnisotropicViscAGridMax :: Set to true to use Alistair's latest
224    C              anisotropic length scale.  It is used only for maximum viscosity
225    C              calculations.  Alistair recommends a value of viscA*GridMax=.25
226  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
227  C     implicitFreeSurface :: Set to true to use implcit free surface  C     implicitFreeSurface :: Set to true to use implcit free surface
228  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
# Line 221  C                           linear relat Line 231  C                           linear relat
231  C     momStepping   :: Turns momentum equation time-stepping off  C     momStepping   :: Turns momentum equation time-stepping off
232  C     tempStepping  :: Turns temperature equation time-stepping off  C     tempStepping  :: Turns temperature equation time-stepping off
233  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  
234  C     useConstantF  :: Coriolis parameter set to f0  C     useConstantF  :: Coriolis parameter set to f0
235  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
236  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
# Line 230  C     useJamartWetPoints :: Use wet-poin Line 239  C     useJamartWetPoints :: Use wet-poin
239  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
240  C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny  C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny
241  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
242  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity in Coriolis  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
243    C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
244  C     useAbsVorticity :: work with f+zeta in Coriolis terms  C     useAbsVorticity :: work with f+zeta in Coriolis terms
245  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
246  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
# Line 241  C     multiDimAdvection :: Flag that ena Line 251  C     multiDimAdvection :: Flag that ena
251  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
252  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
253  C                      out off Adams-Bashforth time stepping.  C                      out off Adams-Bashforth time stepping.
254    C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
255  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
256  C                        climatology is required.  C                        climatology is required.
257  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
258  C                        climatology is required.  C                        climatology is required.
259  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
260  C     usingPCoords     :: Set to indicate that we are working in pressure  C     usingPCoords     :: Set to indicate that we are working in a pressure
261  C                        coords. (jmc: is it still used ?)  C                        type coordinate (p or p*).
262  C     usingZCoords     :: Set to indicate that we are working in height  C     usingZCoords     :: Set to indicate that we are working in a height
263  C                        coords. (jmc: is it still used ?)  C                        type coordinate (z or z*)
264    C     fluidIsAir       :: Set to indicate that the fluid major constituent
265    C                        is air
266    C     fluidIsWater     :: Set to indicate that the fluid major constituent
267    C                        is water
268  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.)
269  C                         this requires specific code for restart & exchange  C                         this requires specific code for restart & exchange
270  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 263  C                       outputs from mas Line 278  C                       outputs from mas
278  C     allowFreezing  :: Allows surface water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
279  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
280  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
281    C     pickup_write_mdsio :: use mdsio to write pickups
282    C     pickup_read_mdsio  :: use mdsio to read  pickups
283    C     pickup_write_immed :: echo the pickup immediately (for conversion)
284    C     timeave_mdsio      :: use mdsio for timeave output
285    C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
286    C     monitor_stdio      :: use stdio for monitor output
287    C     calendarDumps :: When set, approximate months (30-31 days) and years (360-372 days)
288    C                      for parameters chkPtFreq, pChkPtFreq, taveFreq, SEAICE_taveFreq,
289    C                      KPP_taveFreq, and freq in pkg/diagnostics are converted to exact
290    C                      calendar months and years.  Requires pkg/cal.
291        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
292       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
293       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
294       & staggerTimeStep,       & staggerTimeStep,
295       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
296       & momPressureForcing, vectorInvariantMomentum,       & momPressureForcing, vectorInvariantMomentum,
297       & tempDiffusion, tempAdvection, tempForcing,       & tempAdvection, tempForcing,
298       & saltDiffusion, saltAdvection, saltForcing,       & saltAdvection, saltForcing,
299       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
300         & useFullLeith, useAnisotropicViscAGridMax,
301       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
302       & momStepping, tempStepping, saltStepping, tr1Stepping,       & momStepping, tempStepping, saltStepping,
303       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
304       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
305       & useCDscheme,       & useCDscheme,
306       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
307       & SadournyCoriolis, upwindVorticity, highOrderVorticity,       & SadournyCoriolis, upwindVorticity, highOrderVorticity,
308       & useAbsVorticity,       & useAbsVorticity, upwindShear,
309       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
310       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
311       & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,       & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,
312       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
313       & periodicExternalForcing,       & periodicExternalForcing,
314         & fluidIsAir, fluidIsWater,
315       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
316       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
317       & allowFreezing, useOldFreezing, groundAtK1,       & allowFreezing, useOldFreezing, groundAtK1,
318       & usePickupBeforeC35, usePickupBeforeC54, debugMode,       & usePickupBeforeC35, usePickupBeforeC54, startFromPickupAB2,
319       & readPickupWithTracer, writePickupWithTracer       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
320         & timeave_mdsio, snapshot_mdsio, monitor_stdio,
321         & outputTypesInclusive, debugMode,
322         & inAdMode, inAdTrue, inAdFalse, inAdExact,
323         & calendarDumps
324    
325        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
326        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
327        LOGICAL usingCylindricalGrid        LOGICAL usingCylindricalGrid
# Line 305  C     groundAtK1  :: put the surface(k=1 Line 337  C     groundAtK1  :: put the surface(k=1
337        LOGICAL momPressureForcing        LOGICAL momPressureForcing
338        LOGICAL useCoriolis        LOGICAL useCoriolis
339        LOGICAL vectorInvariantMomentum        LOGICAL vectorInvariantMomentum
       LOGICAL tempDiffusion  
340        LOGICAL tempAdvection        LOGICAL tempAdvection
341        LOGICAL tempForcing        LOGICAL tempForcing
       LOGICAL saltDiffusion  
342        LOGICAL saltAdvection        LOGICAL saltAdvection
343        LOGICAL saltForcing        LOGICAL saltForcing
344        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
345          LOGICAL useFullLeith, useAnisotropicViscAGridMax
346        LOGICAL rigidLid        LOGICAL rigidLid
347        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
348        LOGICAL exactConserv        LOGICAL exactConserv
# Line 319  C     groundAtK1  :: put the surface(k=1 Line 350  C     groundAtK1  :: put the surface(k=1
350        LOGICAL momStepping        LOGICAL momStepping
351        LOGICAL tempStepping        LOGICAL tempStepping
352        LOGICAL saltStepping        LOGICAL saltStepping
       LOGICAL tr1Stepping  
353        LOGICAL metricTerms        LOGICAL metricTerms
354        LOGICAL useConstantF        LOGICAL useConstantF
355        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
# Line 332  C     groundAtK1  :: put the surface(k=1 Line 362  C     groundAtK1  :: put the surface(k=1
362        LOGICAL upwindVorticity        LOGICAL upwindVorticity
363        LOGICAL highOrderVorticity        LOGICAL highOrderVorticity
364        LOGICAL useAbsVorticity        LOGICAL useAbsVorticity
365          LOGICAL upwindShear
366        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
367        LOGICAL implicitViscosity        LOGICAL implicitViscosity
368        LOGICAL tempImplVertAdv        LOGICAL tempImplVertAdv
# Line 344  C     groundAtK1  :: put the surface(k=1 Line 375  C     groundAtK1  :: put the surface(k=1
375        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
376        LOGICAL doTr1ClimRelax        LOGICAL doTr1ClimRelax
377        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
378          LOGICAL fluidIsAir
379          LOGICAL fluidIsWater
380        LOGICAL usingPCoords        LOGICAL usingPCoords
381        LOGICAL usingZCoords        LOGICAL usingZCoords
382        LOGICAL useDynP_inEos_Zc        LOGICAL useDynP_inEos_Zc
# Line 357  C     groundAtK1  :: put the surface(k=1 Line 390  C     groundAtK1  :: put the surface(k=1
390        LOGICAL groundAtK1        LOGICAL groundAtK1
391        LOGICAL usePickupBeforeC35        LOGICAL usePickupBeforeC35
392        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
393          LOGICAL startFromPickupAB2
394        LOGICAL debugMode        LOGICAL debugMode
395        LOGICAL readPickupWithTracer        LOGICAL pickup_read_mdsio, pickup_write_mdsio
396        LOGICAL writePickupWithTracer        LOGICAL pickup_write_immed
397          LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
398          LOGICAL outputTypesInclusive
399          LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
400          LOGICAL calendarDumps
401    
402  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
403  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 392  C     gBaro     :: Accel. due to gravity Line 430  C     gBaro     :: Accel. due to gravity
430  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil    :: Reference density for the linear equation of state
431  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density
432  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
433  C     startTime :: Start time for model ( s )  C     tRef      :: reference vertical profile for potential temperature
434    C     sRef      :: reference vertical profile for salinity/specific humidity
435  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
436  C     thetaMin  :: Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
437  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
# Line 406  C     omega     :: Angular velocity ( ra Line 445  C     omega     :: Angular velocity ( ra
445  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
446  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscAh    :: Eddy viscosity coeff. for mixing of
447  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
448    C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical
449    C                 momentum laterally, no effect for hydrostatic
450    C                 model, defaults to viscAh if unset ( m^2/s )
451  C     viscAr    :: Eddy viscosity coeff. for mixing of  C     viscAr    :: Eddy viscosity coeff. for mixing of
452  C                 momentum vertically ( units of r^2/s )  C                 momentum vertically ( units of r^2/s )
453  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4    :: Biharmonic viscosity coeff. for mixing of
454  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
455  C     viscC2leith :: Leith non-dimensional viscosity factor  C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical
456    C                 momentum laterally, no effect for hydrostatic
457    C                 model, defaults to viscA4 if unset ( m^2/s )
458    C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally
459    C                  (act on Divergence part) ( m^2/s )
460    C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally
461    C                  (act on Vorticity  part) ( m^2/s )
462    C     viscA4D   :: Biharmonic viscosity coeff. for mixing of momentum laterally
463    C                  (act on Divergence part) ( m^4/s )
464    C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally
465    C                  (act on Vorticity  part) ( m^4/s )
466    C     viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))
467    C     viscC2leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
468    C     viscC2smag  :: Smagorinsky non-dimensional viscosity factor
469  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of
470  C                 momentum laterally ( m^2/s )  C                 momentum laterally ( m^2/s )
471    C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
472    C     viscAhGridMin::  in terms of non-dimensional grid-size dependent viscosity
473  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
474  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
475  C     viscAhGrid:: non-dimensional grid-size dependent viscosity  C     viscAhGrid:: non-dimensional grid-size dependent viscosity
476  C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity  C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
477  C     viscC4leith :: Leith non-dimensional viscosity factor  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
478    C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity
479    C     viscC4leith :: Leith non-dimensional viscosity factor (grad(vort))
480    C     viscC4leithD :: Modified Leith non-dimensional viscosity factor (grad(div))
481  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
482  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
483  C     diffKrT   :: Laplacian diffusion coeff. for mixing of  C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
484  C                 heat vertically ( units of r^2/s )  C                 for mixing of heat vertically ( units of r^2/s )
485  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
486  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
487  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
488  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
489  C     diffKrS   :: Laplacian diffusion coeff. for mixing of  C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
490  C                 salt vertically ( units of r^2/s )  C                 for mixing of salt vertically ( units of r^2/s ),
491  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
492  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
493  C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979  C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
# Line 442  C                    it will be the deep Line 502  C                    it will be the deep
502  C                    Frequency of checkpointing and dumping of the model state  C                    Frequency of checkpointing and dumping of the model state
503  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
504  C     deltaTMom    :: Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
505  C     deltaTtracer :: Timestep for tracer equations ( s )  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k
506  C     deltaTfreesurf :: Timestep for free-surface equation ( s )  C     deltaTfreesurf :: Timestep for free-surface equation ( s )
507  C     freesurfFac  :: Parameter to turn implicit free surface term on or off  C     freesurfFac  :: Parameter to turn implicit free surface term on or off
508  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
509  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
510    C     abEps        :: Adams-Bashforth-2 stabilizing weight
511    C     alph_AB      :: Adams-Bashforth-3 primary factor
512    C     beta_AB      :: Adams-Bashforth-3 secondary factor
513  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
514  C                     Implicit part of Surface Pressure Gradient ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
515  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
# Line 459  C     hFacInf      :: Threshold (inf and Line 522  C     hFacInf      :: Threshold (inf and
522  C     hFacSup        that control vanishing and creating levels  C     hFacSup        that control vanishing and creating levels
523  C     tauCD        :: CD scheme coupling timescale ( 1/s )  C     tauCD        :: CD scheme coupling timescale ( 1/s )
524  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )  C     rCD          :: CD scheme normalised coupling parameter ( 0-1 )
525    C     baseTime      :: model base time (time origin) = time @ iteration zero
526  C     startTime     :: Starting time for this integration ( s ).  C     startTime     :: Starting time for this integration ( s ).
527  C     endTime       :: Ending time for this integration ( s ).  C     endTime       :: Ending time for this integration ( s ).
528  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
# Line 482  C     tave_lastIter :: (for state variab Line 546  C     tave_lastIter :: (for state variab
546  C                      step (of each taveFreq period) put in the time average.  C                      step (of each taveFreq period) put in the time average.
547  C                      (fraction for 1rst iter = 1 - tave_lastIter)  C                      (fraction for 1rst iter = 1 - tave_lastIter)
548  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).  C     tauThetaClimRelax :: Relaxation to climatology time scale ( s ).
 C     lambdaThetaClimRelax :: Inverse time scale for relaxation ( 1/s ).  
549  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).  C     tauSaltClimRelax :: Relaxation to climatology time scale ( s ).
 C     lambdaSaltClimRelax :: Inverse time scale for relaxation ( 1/s ).  
550  C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,  C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
551  C                         i.e. where |yC| <= latBandClimRelax  C                         i.e. where |yC| <= latBandClimRelax
552  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)  C     externForcingPeriod :: Is the period of which forcing varies (eg. 1 month)
# Line 495  C     convertFW2Salt :: salinity, used t Line 557  C     convertFW2Salt :: salinity, used t
557  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
558  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
559  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
 C     trac_EvPrRn :: tracer concentration in Rain & Evap.  
560  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
561  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
562  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 509  C      --"-"--  Quadratic  ( linear: 1/s Line 570  C      --"-"--  Quadratic  ( linear: 1/s
570        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
571       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
572       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
573       & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
574       & abeps, startTime,       & abEps, alph_AB, beta_AB,
575       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
576       & fCori, fCoriG, fCoriCos,       & viscAh, viscAhW, viscAhMax,
577       & viscAh,  viscAhMax, viscAhGrid, viscC2leith,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
578       & viscA4,  viscA4Max, viscA4Grid, viscC4leith,       & viscC2leith, viscC2leithD,
579       & viscAr, viscAstrain, viscAtension,       & viscC2smag,
580       & diffKhT, diffK4T, diffKrT,       & viscAhD, viscAhZ, viscA4D, viscA4Z,
581       & diffKhS, diffK4S, diffKrS,       & viscA4, viscA4W,
582         & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,
583         & viscC4leith, viscC4leithD, viscAr, viscAstrain, viscAtension,
584         & diffKhT, diffK4T, diffKrNrT,
585         & diffKhS, diffK4S, diffKrNrS,
586       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
587       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,       & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow,
588       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
589       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
590       & recip_rhoConst, rhoConst,       & recip_rhoConst, rhoConst,
591       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,
592       & endTime, chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,       & baseTime, startTime, endTime,
593       & diagFreq, taveFreq, tave_lastIter, monitorFreq,       & chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,
594         & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
595       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
596       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq, omega, rotationPeriod,
597       & tauThetaClimRelax, lambdaThetaClimRelax,       & tauThetaClimRelax,
598       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax,
599       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
600       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
601       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
602       & hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
603       & horiVertRatio, recip_horiVertRatio,       & horiVertRatio, recip_horiVertRatio,
604       & ivdc_kappa, Ro_SeaLevel,       & ivdc_kappa, Ro_SeaLevel,
605       & bottomDragLinear,bottomDragQuadratic,       & bottomDragLinear,bottomDragQuadratic,nh_Am2,
606       & tCyl       & tCylIn, tCylOut
607    
608          _RL nh_Am2
609        _RL cg2dTargetResidual        _RL cg2dTargetResidual
610        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
611        _RL cg3dTargetResidual        _RL cg3dTargetResidual
# Line 550  C      --"-"--  Quadratic  ( linear: 1/s Line 617  C      --"-"--  Quadratic  ( linear: 1/s
617        _RL deltaT        _RL deltaT
618        _RL deltaTClock        _RL deltaTClock
619        _RL deltaTmom        _RL deltaTmom
620        _RL deltaTtracer        _RL dTtracerLev(Nr)
621        _RL deltaTfreesurf        _RL deltaTfreesurf
622        _RL abeps        _RL abEps, alph_AB, beta_AB
623        _RL phiMin        _RL phiMin
624        _RL thetaMin        _RL thetaMin
625        _RL rSphere        _RL rSphere
# Line 569  C      --"-"--  Quadratic  ( linear: 1/s Line 636  C      --"-"--  Quadratic  ( linear: 1/s
636        _RL hFacSup        _RL hFacSup
637        _RL beta        _RL beta
638        _RL viscAh        _RL viscAh
639          _RL viscAhW
640          _RL viscAhD
641          _RL viscAhZ
642        _RL viscAhMax        _RL viscAhMax
643        _RL viscAhGrid        _RL viscAhGrid
644          _RL viscAhGridMax
645          _RL viscAhGridMin
646        _RL viscC2leith        _RL viscC2leith
647          _RL viscC2leithD
648          _RL viscC2smag
649        _RL viscAstrain        _RL viscAstrain
650        _RL viscAtension        _RL viscAtension
651        _RL viscAr        _RL viscAr
652        _RL viscA4        _RL viscA4
653          _RL viscA4W
654          _RL viscA4D
655          _RL viscA4Z
656        _RL viscA4Max        _RL viscA4Max
657        _RL viscA4Grid        _RL viscA4Grid, viscA4GridMax, viscA4GridMin
658        _RL viscC4leith        _RL viscC4leith
659          _RL viscC4leithD
660        _RL diffKhT        _RL diffKhT
661        _RL diffKrT        _RL diffKrNrT(Nr)
662        _RL diffK4T        _RL diffK4T
663        _RL diffKhS        _RL diffKhS
664        _RL diffKrS        _RL diffKrNrS(Nr)
665        _RL diffK4S        _RL diffK4S
666        _RL diffKrBL79surf        _RL diffKrBL79surf
667        _RL diffKrBL79deep        _RL diffKrBL79deep
# Line 603  C      --"-"--  Quadratic  ( linear: 1/s Line 681  C      --"-"--  Quadratic  ( linear: 1/s
681        _RL convertEmP2rUnit        _RL convertEmP2rUnit
682        _RL tRef(Nr)        _RL tRef(Nr)
683        _RL sRef(Nr)        _RL sRef(Nr)
684        _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RL baseTime
       _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)  
       _RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)  
685        _RL startTime        _RL startTime
686        _RL endTime        _RL endTime
687        _RL chkPtFreq        _RL chkPtFreq
# Line 616  C      --"-"--  Quadratic  ( linear: 1/s Line 692  C      --"-"--  Quadratic  ( linear: 1/s
692        _RL taveFreq        _RL taveFreq
693        _RL tave_lastIter        _RL tave_lastIter
694        _RL monitorFreq        _RL monitorFreq
695          _RL adjMonitorFreq
696        _RL afFacMom        _RL afFacMom
697        _RL vfFacMom        _RL vfFacMom
698        _RL pfFacMom        _RL pfFacMom
# Line 627  C      --"-"--  Quadratic  ( linear: 1/s Line 704  C      --"-"--  Quadratic  ( linear: 1/s
704        _RL omega        _RL omega
705        _RL rotationPeriod        _RL rotationPeriod
706        _RL tauThetaClimRelax        _RL tauThetaClimRelax
       _RL lambdaThetaClimRelax  
707        _RL tauSaltClimRelax        _RL tauSaltClimRelax
       _RL lambdaSaltClimRelax  
708        _RL tauTr1ClimRelax        _RL tauTr1ClimRelax
709        _RL lambdaTr1ClimRelax        _RL lambdaTr1ClimRelax
710        _RL latBandClimRelax        _RL latBandClimRelax
# Line 638  C      --"-"--  Quadratic  ( linear: 1/s Line 713  C      --"-"--  Quadratic  ( linear: 1/s
713        _RL convertFW2Salt        _RL convertFW2Salt
714        _RL temp_EvPrRn        _RL temp_EvPrRn
715        _RL salt_EvPrRn        _RL salt_EvPrRn
       _RL trac_EvPrRn  
716        _RL horiVertRatio        _RL horiVertRatio
717        _RL recip_horiVertRatio        _RL recip_horiVertRatio
718        _RL ivdc_kappa        _RL ivdc_kappa
719        _RL Ro_SeaLevel        _RL Ro_SeaLevel
720        _RL bottomDragLinear        _RL bottomDragLinear
721        _RL bottomDragQuadratic        _RL bottomDragQuadratic
722        _RL tCyl        _RL tCylIn
723          _RL tCylOut
724    
725  C--   COMMON /PARM_A/ Thermodynamics constants ?  C--   COMMON /PARM_A/ Thermodynamics constants ?
726        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp
# Line 673  C             derived from the orography Line 748  C             derived from the orography
748        INTEGER integr_GeoPot, selectFindRoSurf        INTEGER integr_GeoPot, selectFindRoSurf
749    
750  C Logical flags for selecting packages  C Logical flags for selecting packages
751          LOGICAL useOPPS
752        LOGICAL usePP81        LOGICAL usePP81
753        LOGICAL useMY82        LOGICAL useMY82
754          LOGICAL useGGL90
755        LOGICAL useKPP        LOGICAL useKPP
756        LOGICAL useGMRedi        LOGICAL useGMRedi
757        LOGICAL useOBCS        LOGICAL useOBCS
# Line 686  C Logical flags for selecting packages Line 763  C Logical flags for selecting packages
763        LOGICAL useZONAL_FILT        LOGICAL useZONAL_FILT
764        LOGICAL useFLT        LOGICAL useFLT
765        LOGICAL usePTRACERS        LOGICAL usePTRACERS
766          LOGICAL useGCHEM
767        LOGICAL useSBO        LOGICAL useSBO
768        LOGICAL useSEAICE        LOGICAL useSEAICE
769        LOGICAL useBulkForce        LOGICAL useBulkForce
# Line 694  C Logical flags for selecting packages Line 772  C Logical flags for selecting packages
772        LOGICAL usegridalt        LOGICAL usegridalt
773        LOGICAL usediagnostics        LOGICAL usediagnostics
774        LOGICAL useEBM        LOGICAL useEBM
775          LOGICAL useMNC
776          LOGICAL useMATRIX
777          LOGICAL useRunClock
778        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
779       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
780       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
781       &        usePTRACERS,  useSBO, useSEAICE, useThSIce, useBulkForce,       &        usePTRACERS, useGCHEM,
782       &        usefizhi,  usegridalt, usediagnostics, useEBM,       &        useSBO, useSEAICE, useThSIce, useBulkForce,
783       &        usePP81, useMY82       &        usefizhi, usegridalt, usediagnostics, useEBM, useMNC,
784         &        usePP81, useMY82, useOPPS, useGGL90, useMATRIX,
785  C     Run-time flags for early-initialization of MNC       &        useRunClock
       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  
       CHARACTER*(MAX_LEN_FNAM) the_run_name  
       COMMON /PARM_MNC/  
      &     useMNC,  
      &     mnc_use_indir, mnc_use_outdir, mnc_outdir_date,  
      &     mnc_echo_gvtypes, mnc_pickup_write, mnc_pickup_read,  
      &     mnc_use_for_mon,  
      &     mnc_outdir_str, mnc_indir_str,  
      &     the_run_name  
   
786    
787  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
788  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***

Legend:
Removed from v.1.122  
changed lines
  Added in v.1.159

  ViewVC Help
Powered by ViewVC 1.1.22