/[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.161 by jmc, Tue Jul 12 16:30:53 2005 UTC revision 1.169 by jmc, Tue Oct 11 21:27:20 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)
59  C                   (mainly used for the atmosphere = ground height).  C                   (mainly used for the atmosphere = ground height).
 C     horizGridFile   :: File containing horizontal-grid definition  
 C                        (only when using curvilinear_grid)  
60  C     hydrogThetaFile :: File containing initial hydrographic data for potential  C     hydrogThetaFile :: File containing initial hydrographic data for potential
61  C                       temperature.  C                       temperature.
62  C     hydrogSaltFile  :: File containing initial hydrographic data for salinity.  C     hydrogSaltFile  :: File containing initial hydrographic data for salinity.
# Line 80  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       &                bathyFile, topoFile, horizGridFile,       &                delXFile, delYFile, horizGridFile,
86         &                bathyFile, topoFile,
87       &                hydrogThetaFile, hydrogSaltFile,       &                hydrogThetaFile, hydrogSaltFile,
88       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
89       &                saltClimFile, buoyancyRelation,       &                saltClimFile, buoyancyRelation,
# Line 94  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) bathyFile, topoFile        CHARACTER*(MAX_LEN_FNAM) delXFile
101          CHARACTER*(MAX_LEN_FNAM) delYFile
102        CHARACTER*(MAX_LEN_FNAM) horizGridFile        CHARACTER*(MAX_LEN_FNAM) horizGridFile
103          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
106        CHARACTER*(MAX_LEN_FNAM) zonalWindFile        CHARACTER*(MAX_LEN_FNAM) zonalWindFile
# Line 146  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 163  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 181  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 221  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 290  C     calendarDumps :: When set, approxi Line 298  C     calendarDumps :: When set, approxi
298  C                      for parameters chkPtFreq, pChkPtFreq, taveFreq, SEAICE_taveFreq,  C                      for parameters chkPtFreq, pChkPtFreq, taveFreq, SEAICE_taveFreq,
299  C                      KPP_taveFreq, and freq in pkg/diagnostics are converted to exact  C                      KPP_taveFreq, and freq in pkg/diagnostics are converted to exact
300  C                      calendar months and years.  Requires pkg/cal.  C                      calendar months and years.  Requires pkg/cal.
301    C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
302    C                        & Last iteration, in addition multiple of dumpFreq iter.
303        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
304       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
305       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
# Line 299  C                      calendar months a Line 309  C                      calendar months a
309       & tempAdvection, tempForcing,       & tempAdvection, tempForcing,
310       & saltAdvection, saltForcing,       & saltAdvection, saltForcing,
311       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
312       & useFullLeith, useAnisotropicViscAGridMax,       & useFullLeith, useStrainTensionVisc,
313         & useAreaViscLength,
314       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
315       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
316       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
# Line 320  C                      calendar months a Line 331  C                      calendar months a
331       & usePickupBeforeC35, usePickupBeforeC54, startFromPickupAB2,       & usePickupBeforeC35, usePickupBeforeC54, startFromPickupAB2,
332       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
333       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
334       & outputTypesInclusive, debugMode,       & outputTypesInclusive, dumpInitAndLast, debugMode,
335       & inAdMode, inAdTrue, inAdFalse, inAdExact,       & inAdMode, inAdTrue, inAdFalse, inAdExact,
336       & calendarDumps       & calendarDumps
337    
# Line 344  C                      calendar months a Line 355  C                      calendar months a
355        LOGICAL saltAdvection        LOGICAL saltAdvection
356        LOGICAL saltForcing        LOGICAL saltForcing
357        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
358        LOGICAL useFullLeith, useAnisotropicViscAGridMax        LOGICAL useFullLeith
359          LOGICAL useStrainTensionVisc
360          LOGICAL useAreaViscLength
361        LOGICAL rigidLid        LOGICAL rigidLid
362        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
363        LOGICAL exactConserv        LOGICAL exactConserv
# Line 392  C                      calendar months a Line 405  C                      calendar months a
405        LOGICAL usePickupBeforeC35        LOGICAL usePickupBeforeC35
406        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
407        LOGICAL startFromPickupAB2        LOGICAL startFromPickupAB2
408          LOGICAL dumpInitAndLast
409        LOGICAL debugMode        LOGICAL debugMode
410        LOGICAL pickup_read_mdsio, pickup_write_mdsio        LOGICAL pickup_read_mdsio, pickup_write_mdsio
411        LOGICAL pickup_write_immed        LOGICAL pickup_write_immed
# Line 465  C                  (act on Divergence pa Line 479  C                  (act on Divergence pa
479  C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally  C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally
480  C                  (act on Vorticity  part) ( m^4/s )  C                  (act on Vorticity  part) ( m^4/s )
481  C     viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))  C     viscC2leith :: Leith non-dimensional viscosity factor (grad(vort))
482  C     viscC2leithD :: Modified Leith non-dimensional viscosity factor (grad(div))  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
483  C     viscC2smag  :: Smagorinsky non-dimensional viscosity factor  C     viscC2smag  :: Smagorinsky non-dimensional viscosity factor (harmonic)
484    C     viscC4smag  :: Smagorinsky non-dimensional viscosity factor (biharmonic)
485  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of  C     viscAhMax :: Maximum eddy viscosity coeff. for mixing of
486  C                 momentum laterally ( m^2/s )  C                   momentum laterally ( m^2/s )
487    C     viscAhReMax :: Maximum gridscale Reynolds number for eddy viscosity
488    C                   coeff. for mixing of momentum laterally (non-dim)
489  C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...  C     viscAhGridMax:: maximum and minimum harmonic viscosity coefficients ...
490  C     viscAhGridMin::  in terms of non-dimensional grid-size dependent viscosity  C     viscAhGridMin::  in terms of non-dimensional grid-size dependent visc.
491  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of  C     viscA4Max :: Maximum biharmonic viscosity coeff. for mixing of
492  C                 momentum laterally ( m^4/s )  C                 momentum laterally ( m^4/s )
493    C     viscA4ReMax :: Maximum Gridscale Reynolds number for
494    C                  biharmonic viscosity coeff. momentum laterally (non-dim)
495  C     viscAhGrid:: non-dimensional grid-size dependent viscosity  C     viscAhGrid:: non-dimensional grid-size dependent viscosity
496  C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity  C     viscA4Grid:: non-dimensional grid-size dependent bi-harmonic viscosity
497  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...  C     viscA4GridMax:: maximum and minimum biharmonic viscosity coefficients ...
# Line 566  C     recip_horiVertRatio  ( 1 if horiz Line 585  C     recip_horiVertRatio  ( 1 if horiz
585  C                          ( g*rho if horiz in m and vertical in Pa ).  C                          ( g*rho if horiz in m and vertical in Pa ).
586  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
587  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
588    C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
589    C                           (default=2: full drag ; =1: gives half-slip BC)
590  C     bottomDragLinear   :: Drag coefficient built in to core dynamics  C     bottomDragLinear   :: Drag coefficient built in to core dynamics
591  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )  C     bottomDragQuadratic   ( linear: 1/s, quadratic: 1/m )
592    C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales
593    C                      (i.e. allows convection at different Rayleigh numbers)
594        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
595       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
596       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
# Line 577  C      --"-"--  Quadratic  ( linear: 1/s Line 600  C      --"-"--  Quadratic  ( linear: 1/s
600       & viscAh, viscAhW, viscAhMax,       & viscAh, viscAhW, viscAhMax,
601       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
602       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
603       & viscC2smag,       & viscC2smag, viscC4smag,
604       & viscAhD, viscAhZ, viscA4D, viscA4Z,       & viscAhD, viscAhZ, viscA4D, viscA4Z,
605       & viscA4, viscA4W,       & viscA4, viscA4W,
606       & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,       & viscA4Max, viscA4Grid, viscA4GridMax, viscA4GridMin,
607       & viscC4leith, viscC4leithD, viscAr, viscAstrain, viscAtension,       & viscAhRemax, viscA4Remax,
608         & viscC4leith, viscC4leithD, viscAr,
609       & diffKhT, diffK4T, diffKrNrT,       & diffKhT, diffK4T, diffKrNrT,
610       & diffKhS, diffK4S, diffKrNrS,       & diffKhS, diffK4S, diffKrNrS,
611       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
# Line 603  C      --"-"--  Quadratic  ( linear: 1/s Line 627  C      --"-"--  Quadratic  ( linear: 1/s
627       & hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
628       & horiVertRatio, recip_horiVertRatio,       & horiVertRatio, recip_horiVertRatio,
629       & ivdc_kappa, Ro_SeaLevel,       & ivdc_kappa, Ro_SeaLevel,
630       & bottomDragLinear,bottomDragQuadratic,nh_Am2,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
631       & tCylIn, tCylOut       & tCylIn, tCylOut
632    
       _RL nh_Am2  
633        _RL cg2dTargetResidual        _RL cg2dTargetResidual
634        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
635        _RL cg3dTargetResidual        _RL cg3dTargetResidual
# Line 641  C      --"-"--  Quadratic  ( linear: 1/s Line 664  C      --"-"--  Quadratic  ( linear: 1/s
664        _RL viscAhD        _RL viscAhD
665        _RL viscAhZ        _RL viscAhZ
666        _RL viscAhMax        _RL viscAhMax
667          _RL viscAhReMax
668        _RL viscAhGrid        _RL viscAhGrid
669        _RL viscAhGridMax        _RL viscAhGridMax
670        _RL viscAhGridMin        _RL viscAhGridMin
671        _RL viscC2leith        _RL viscC2leith
672        _RL viscC2leithD        _RL viscC2leithD
673        _RL viscC2smag        _RL viscC2smag
674        _RL viscAstrain        _RL viscC4smag
       _RL viscAtension  
675        _RL viscAr        _RL viscAr
676        _RL viscA4        _RL viscA4
677        _RL viscA4W        _RL viscA4W
678        _RL viscA4D        _RL viscA4D
679        _RL viscA4Z        _RL viscA4Z
680        _RL viscA4Max        _RL viscA4Max
681          _RL viscA4ReMax
682        _RL viscA4Grid, viscA4GridMax, viscA4GridMin        _RL viscA4Grid, viscA4GridMax, viscA4GridMin
683        _RL viscC4leith        _RL viscC4leith
684        _RL viscC4leithD        _RL viscC4leithD
# Line 718  C      --"-"--  Quadratic  ( linear: 1/s Line 742  C      --"-"--  Quadratic  ( linear: 1/s
742        _RL recip_horiVertRatio        _RL recip_horiVertRatio
743        _RL ivdc_kappa        _RL ivdc_kappa
744        _RL Ro_SeaLevel        _RL Ro_SeaLevel
745          _RL sideDragFactor
746        _RL bottomDragLinear        _RL bottomDragLinear
747        _RL bottomDragQuadratic        _RL bottomDragQuadratic
748          _RL nh_Am2
749        _RL tCylIn        _RL tCylIn
750        _RL tCylOut        _RL tCylOut
751    
Legend:
Removed from v.1.161  
changed lines
  Added in v.1.169
  ViewVC Help
Powered by ViewVC 1.1.22