/[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.160 by jmc, Wed Jun 22 00:21:03 2005 UTC revision 1.170 by jmc, Mon Oct 24 22:38:49 2005 UTC
# Line 49  C     Checkpoint data Line 49  C     Checkpoint data
49    
50  C--   COMMON /PARM_C/ Character valued parameters used by the model.  C--   COMMON /PARM_C/ Character valued parameters used by the model.
51  C     checkPtSuff :: List of checkpoint file suffices  C     checkPtSuff :: List of checkpoint file suffices
52    C     delXFile      :: File containing X-spacing grid definition (1.D array)
53    C     delYFile      :: File containing Y-spacing grid definition (1.D array)
54    C     horizGridFile :: File containing horizontal-grid definition
55    C                        (only when using curvilinear_grid)
56  C     bathyFile   :: File containing bathymetry. If not defined bathymetry  C     bathyFile   :: File containing bathymetry. If not defined bathymetry
57  C                   is taken from inline function.  C                   is taken from inline function.
58  C     topoFile    :: File containing the topography of the surface (unit=m)  C     topoFile    :: File containing the topography of the surface (unit=m)
# Line 78  C     eosType         :: choose the equa Line 82  C     eosType         :: choose the equa
82  C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS  C                        LINEAR, POLY3, UNESCO, JMD95Z, JMD95P, MDJWF, IDEALGAS
83  C     the_run_name    :: string identifying the name of the model "run"  C     the_run_name    :: string identifying the name of the model "run"
84        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/ checkPtSuff,
85         &                delXFile, delYFile, horizGridFile,
86       &                bathyFile, topoFile,       &                bathyFile, topoFile,
87       &                hydrogThetaFile, hydrogSaltFile,       &                hydrogThetaFile, hydrogSaltFile,
88       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
# Line 92  C     the_run_name    :: string identify Line 97  C     the_run_name    :: string identify
97       &                mdsioLocalDir,       &                mdsioLocalDir,
98       &                the_run_name       &                the_run_name
99        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
100          CHARACTER*(MAX_LEN_FNAM) delXFile
101          CHARACTER*(MAX_LEN_FNAM) delYFile
102          CHARACTER*(MAX_LEN_FNAM) horizGridFile
103        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
104        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
105        CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
# Line 143  C                           =0 Linear fr Line 151  C                           =0 Linear fr
151  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
152  C                           =0 (default) use r coord. ; > 0 use r*  C                           =0 (default) use r coord. ; > 0 use r*
153  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
154  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
155  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
156  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector  C     saltVertAdvScheme   :: Salt. Vert. Advection scheme selector
157    C     selectKEscheme      :: Kinetic Energy scheme selector (Vector Inv.)
158  C     debugLevel          :: debug level selector: higher -> more writing  C     debugLevel          :: debug level selector: higher -> more writing
159    
160        COMMON /PARM_I/        COMMON /PARM_I/
# Line 160  C     debugLevel          :: debug level Line 169  C     debugLevel          :: debug level
169       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
170       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
171       &        saltAdvScheme, saltVertAdvScheme,       &        saltAdvScheme, saltVertAdvScheme,
172         &        selectKEscheme,
173       &        debugLevel       &        debugLevel
174        INTEGER cg2dMaxIters        INTEGER cg2dMaxIters
175        INTEGER cg2dChkResFreq        INTEGER cg2dChkResFreq
# Line 178  C     debugLevel          :: debug level Line 188  C     debugLevel          :: debug level
188        INTEGER select_rStar        INTEGER select_rStar
189        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
190        INTEGER saltAdvScheme, saltVertAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
191          INTEGER selectKEscheme
192        INTEGER debugLevel        INTEGER debugLevel
193    
194  C  C
# Line 218  C                     and off. Line 229  C                     and off.
229  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
230  C                         as a real Fresh Water (=> changes the Sea Level)  C                         as a real Fresh Water (=> changes the Sea Level)
231  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)
232  C     useFullLeith   :: Set to true to use full Leith viscosity (may be unstable  C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable
233  C                       on irregular grids)  C                       on irregular grids)
234  C     useAnisotropicViscAGridMax :: Set to true to use Alistair's latest  C     useAreaViscLength :: Set to true to use old scaling for viscous
235  C              anisotropic length scale.  It is used only for maximum viscosity  C              lengths, e.g., L2=Raz.  May be preferable for cube sphere.
236  C              calculations.  Alistair recommends a value of viscA*GridMax=.25  C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
237  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
238  C     implicitFreeSurface :: Set to true to use implcit free surface  C     implicitFreeSurface :: Set to true to use implcit free surface
239  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
# Line 249  C     saltImplVertAdv :: Turns on implic Line 260  C     saltImplVertAdv :: Turns on implic
260  C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum  C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
261  C     multiDimAdvection :: Flag that enable multi-dimension advection  C     multiDimAdvection :: Flag that enable multi-dimension advection
262  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
263  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution  C     forcing_In_AB     :: if False, put forcing (Temp,Salt,Tracers) contribution
264  C                      out off Adams-Bashforth time stepping.  C                          out off Adams-Bashforth time stepping.
265    C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always
266    C                          apply AB on tracer tendencies (rather than on Tracer)
267  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
268  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
269  C                        climatology is required.  C                        climatology is required.
# Line 287  C     calendarDumps :: When set, approxi Line 300  C     calendarDumps :: When set, approxi
300  C                      for parameters chkPtFreq, pChkPtFreq, taveFreq, SEAICE_taveFreq,  C                      for parameters chkPtFreq, pChkPtFreq, taveFreq, SEAICE_taveFreq,
301  C                      KPP_taveFreq, and freq in pkg/diagnostics are converted to exact  C                      KPP_taveFreq, and freq in pkg/diagnostics are converted to exact
302  C                      calendar months and years.  Requires pkg/cal.  C                      calendar months and years.  Requires pkg/cal.
303    C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
304    C                        & Last iteration, in addition multiple of dumpFreq iter.
305        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
306       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
307       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
# Line 296  C                      calendar months a Line 311  C                      calendar months a
311       & tempAdvection, tempForcing,       & tempAdvection, tempForcing,
312       & saltAdvection, saltForcing,       & saltAdvection, saltForcing,
313       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
314       & useFullLeith, useAnisotropicViscAGridMax,       & useFullLeith, useStrainTensionVisc,
315         & useAreaViscLength,
316       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
317       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
318       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
# Line 307  C                      calendar months a Line 323  C                      calendar months a
323       & useAbsVorticity, upwindShear,       & useAbsVorticity, upwindShear,
324       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
325       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
326       & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,       & multiDimAdvection, useMultiDimAdvec,
327         & forcing_In_AB, doAB_onGtGs,
328       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
329       & periodicExternalForcing,       & periodicExternalForcing,
330       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
# Line 317  C                      calendar months a Line 334  C                      calendar months a
334       & usePickupBeforeC35, usePickupBeforeC54, startFromPickupAB2,       & usePickupBeforeC35, usePickupBeforeC54, startFromPickupAB2,
335       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
336       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
337       & outputTypesInclusive, debugMode,       & outputTypesInclusive, dumpInitAndLast, debugMode,
338       & inAdMode, inAdTrue, inAdFalse, inAdExact,       & inAdMode, inAdTrue, inAdFalse, inAdExact,
339       & calendarDumps       & calendarDumps
340    
# Line 341  C                      calendar months a Line 358  C                      calendar months a
358        LOGICAL saltAdvection        LOGICAL saltAdvection
359        LOGICAL saltForcing        LOGICAL saltForcing
360        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
361        LOGICAL useFullLeith, useAnisotropicViscAGridMax        LOGICAL useFullLeith
362          LOGICAL useStrainTensionVisc
363          LOGICAL useAreaViscLength
364        LOGICAL rigidLid        LOGICAL rigidLid
365        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
366        LOGICAL exactConserv        LOGICAL exactConserv
# Line 370  C                      calendar months a Line 389  C                      calendar months a
389        LOGICAL multiDimAdvection        LOGICAL multiDimAdvection
390        LOGICAL useMultiDimAdvec        LOGICAL useMultiDimAdvec
391        LOGICAL forcing_In_AB        LOGICAL forcing_In_AB
392          LOGICAL doAB_onGtGs
393        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
394        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
395        LOGICAL doTr1ClimRelax        LOGICAL doTr1ClimRelax
# Line 389  C                      calendar months a Line 409  C                      calendar months a
409        LOGICAL usePickupBeforeC35        LOGICAL usePickupBeforeC35
410        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
411        LOGICAL startFromPickupAB2        LOGICAL startFromPickupAB2
412          LOGICAL dumpInitAndLast
413        LOGICAL debugMode        LOGICAL debugMode
414        LOGICAL pickup_read_mdsio, pickup_write_mdsio        LOGICAL pickup_read_mdsio, pickup_write_mdsio
415        LOGICAL pickup_write_immed        LOGICAL pickup_write_immed
# Line 462  C                  (act on Divergence pa Line 483  C                  (act on Divergence pa
483  C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally  C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally
484  C                  (act on Vorticity  part) ( m^4/s )  C                  (act on Vorticity  part) ( m^4/s )
485  C     viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))  C     viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))
486  C     viscC2leithD :: Modified Leith non-dimensional viscosity factor (grad(div))  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
487  C     viscC2smag  :: Smagorinsky non-dimensional viscosity factor  C     viscC2smag  :: Smagorinsky non-dimensional viscosity factor (harmonic)
488    C     viscC4smag  :: Smagorinsky non-dimensional viscosity factor (biharmonic)
489  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of
490  C                 momentum laterally ( m^2/s )  C                   momentum laterally ( m^2/s )
491    C     viscAhReMax :: Maximum gridscale Reynolds number for eddy viscosity
492    C                   coeff. for mixing of momentum laterally (non-dim)
493  C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...  C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
494  C     viscAhGridMin::  in terms of non-dimensional grid-size dependent viscosity  C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.
495  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
496  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
497    C     viscA4ReMax :: Maximum Gridscale Reynolds number for
498    C                  biharmonic viscosity coeff. momentum laterally (non-dim)
499  C     viscAhGrid:: non-dimensional grid-size dependent viscosity  C     viscAhGrid:: non-dimensional grid-size dependent viscosity
500  C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity  C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
501  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
# Line 563  C     recip_horiVertRatio  ( 1 if horiz Line 589  C     recip_horiVertRatio  ( 1 if horiz
589  C                          ( g*rho if horiz in m and vertical in Pa ).  C                          ( g*rho if horiz in m and vertical in Pa ).
590  C     Ro_SeaLevel        :: standard position of Sea-Level in "R" coordinate, used as  C     Ro_SeaLevel        :: standard position of Sea-Level in "R" coordinate, used as
591  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
592    C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
593    C                           (default=2: full drag ; =1: gives half-slip BC)
594  C     bottomDragLinear   :: Drag coefficient built in to core dynamics  C     bottomDragLinear   :: Drag coefficient built in to core dynamics
595  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )  C     bottomDragQuadratic   ( linear: 1/s, quadratic: 1/m )
596    C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales
597    C                      (i.e. allows convection at different Rayleigh numbers)
598        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
599       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
600       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
# Line 574  C      --"-"--  Quadratic  ( linear: 1/s Line 604  C      --"-"--  Quadratic  ( linear: 1/s
604       & viscAh, viscAhW, viscAhMax,       & viscAh, viscAhW, viscAhMax,
605       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
606       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
607       & viscC2smag,       & viscC2smag, viscC4smag,
608       & viscAhD, viscAhZ, viscA4D, viscA4Z,       & viscAhD, viscAhZ, viscA4D, viscA4Z,
609       & viscA4, viscA4W,       & viscA4, viscA4W,
610       & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,       & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,
611       & viscC4leith, viscC4leithD, viscAr, viscAstrain, viscAtension,       & viscAhRemax, viscA4Remax,
612         & viscC4leith, viscC4leithD, viscAr,
613       & diffKhT, diffK4T, diffKrNrT,       & diffKhT, diffK4T, diffKrNrT,
614       & diffKhS, diffK4S, diffKrNrS,       & diffKhS, diffK4S, diffKrNrS,
615       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
# Line 600  C      --"-"--  Quadratic  ( linear: 1/s Line 631  C      --"-"--  Quadratic  ( linear: 1/s
631       & hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
632       & horiVertRatio, recip_horiVertRatio,       & horiVertRatio, recip_horiVertRatio,
633       & ivdc_kappa, Ro_SeaLevel,       & ivdc_kappa, Ro_SeaLevel,
634       & bottomDragLinear,bottomDragQuadratic,nh_Am2,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
635       & tCylIn, tCylOut       & tCylIn, tCylOut
636    
       _RL nh_Am2  
637        _RL cg2dTargetResidual        _RL cg2dTargetResidual
638        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
639        _RL cg3dTargetResidual        _RL cg3dTargetResidual
# Line 638  C      --"-"--  Quadratic  ( linear: 1/s Line 668  C      --"-"--  Quadratic  ( linear: 1/s
668        _RL viscAhD        _RL viscAhD
669        _RL viscAhZ        _RL viscAhZ
670        _RL viscAhMax        _RL viscAhMax
671          _RL viscAhReMax
672        _RL viscAhGrid        _RL viscAhGrid
673        _RL viscAhGridMax        _RL viscAhGridMax
674        _RL viscAhGridMin        _RL viscAhGridMin
675        _RL viscC2leith        _RL viscC2leith
676        _RL viscC2leithD        _RL viscC2leithD
677        _RL viscC2smag        _RL viscC2smag
678        _RL viscAstrain        _RL viscC4smag
       _RL viscAtension  
679        _RL viscAr        _RL viscAr
680        _RL viscA4        _RL viscA4
681        _RL viscA4W        _RL viscA4W
682        _RL viscA4D        _RL viscA4D
683        _RL viscA4Z        _RL viscA4Z
684        _RL viscA4Max        _RL viscA4Max
685          _RL viscA4ReMax
686        _RL viscA4Grid, viscA4GridMax, viscA4GridMin        _RL viscA4Grid, viscA4GridMax, viscA4GridMin
687        _RL viscC4leith        _RL viscC4leith
688        _RL viscC4leithD        _RL viscC4leithD
# Line 715  C      --"-"--  Quadratic  ( linear: 1/s Line 746  C      --"-"--  Quadratic  ( linear: 1/s
746        _RL recip_horiVertRatio        _RL recip_horiVertRatio
747        _RL ivdc_kappa        _RL ivdc_kappa
748        _RL Ro_SeaLevel        _RL Ro_SeaLevel
749          _RL sideDragFactor
750        _RL bottomDragLinear        _RL bottomDragLinear
751        _RL bottomDragQuadratic        _RL bottomDragQuadratic
752          _RL nh_Am2
753        _RL tCylIn        _RL tCylIn
754        _RL tCylOut        _RL tCylOut
755    
Legend:
Removed from v.1.160  
changed lines
  Added in v.1.170
  ViewVC Help
Powered by ViewVC 1.1.22