/[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.151 by heimbach, Wed Apr 6 20:18:19 2005 UTC revision 1.162 by jmc, Sun Jul 31 22:01:15 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 220  C                         as a real Fres Line 228  C                         as a real Fres
228  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)
229  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
230  C                       on irregular grids)  C                       on irregular grids)
231    C     useAnisotropicViscAGridMax :: Set to true to use Alistair's latest
232    C              anisotropic length scale.  It is used only for maximum viscosity
233    C              calculations.  Alistair recommends a value of viscA*GridMax=.25
234  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
235  C     implicitFreeSurface :: Set to true to use implcit free surface  C     implicitFreeSurface :: Set to true to use implcit free surface
236  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
# Line 236  C     useJamartWetPoints :: Use wet-poin Line 247  C     useJamartWetPoints :: Use wet-poin
247  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term  C     useJamartMomAdv :: Use wet-point method for V.I. non-linear term
248  C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny  C     SadournyCoriolis :: use the enstrophy conserving scheme by Sadourny
249  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term  C     upwindVorticity :: bias interpolation of vorticity in the Coriolis term
250  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity in Coriolis  C     highOrderVorticity :: use 3rd/4th order interp. of vorticity (V.I., advection)
251    C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
252  C     useAbsVorticity :: work with f+zeta in Coriolis terms  C     useAbsVorticity :: work with f+zeta in Coriolis terms
253  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
254  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
# Line 247  C     multiDimAdvection :: Flag that ena Line 259  C     multiDimAdvection :: Flag that ena
259  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
260  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
261  C                      out off Adams-Bashforth time stepping.  C                      out off Adams-Bashforth time stepping.
262    C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
263  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
264  C                        climatology is required.  C                        climatology is required.
265  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
# Line 272  C                       useSingleCpuIO i Line 285  C                       useSingleCpuIO i
285  C                       outputs from master mpi process only.  C                       outputs from master mpi process only.
286  C     allowFreezing  :: Allows surface water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
287  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
 C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)  
288  C     pickup_write_mdsio :: use mdsio to write pickups  C     pickup_write_mdsio :: use mdsio to write pickups
289  C     pickup_read_mdsio  :: use mdsio to read  pickups  C     pickup_read_mdsio  :: use mdsio to read  pickups
290  C     pickup_write_immed :: echo the pickup immediately (for conversion)  C     pickup_write_immed :: echo the pickup immediately (for conversion)
291  C     timeave_mdsio      :: use mdsio for timeave output  C     timeave_mdsio      :: use mdsio for timeave output
292  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output  C     snapshot_mdsio     :: use mdsio for "snapshot" (dumpfreq/diagfreq) output
 C     seaice_mdsio       :: use mdsio for seaice output  
293  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
294  C     calendarDumps :: When set, approximate months (30-31 days) and years (360-372 days)  C     calendarDumps :: When set, approximate months (30-31 days) and years (360-372 days)
295  C                      for parameters chkPtFreq, pChkPtFreq, taveFreq, SEAICE_taveFreq,  C                      for parameters chkPtFreq, pChkPtFreq, taveFreq, SEAICE_taveFreq,
# Line 293  C                      calendar months a Line 304  C                      calendar months a
304       & tempAdvection, tempForcing,       & tempAdvection, tempForcing,
305       & saltAdvection, saltForcing,       & saltAdvection, saltForcing,
306       & useRealFreshWaterFlux,       & useRealFreshWaterFlux,
307       & useFullLeith,       & useFullLeith, useAnisotropicViscAGridMax,
308       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
309       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
310       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
# Line 301  C                      calendar months a Line 312  C                      calendar months a
312       & useCDscheme,       & useCDscheme,
313       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
314       & SadournyCoriolis, upwindVorticity, highOrderVorticity,       & SadournyCoriolis, upwindVorticity, highOrderVorticity,
315       & useAbsVorticity,       & useAbsVorticity, upwindShear,
316       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
317       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
318       & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,       & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,
# Line 310  C                      calendar months a Line 321  C                      calendar months a
321       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
322       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,       & usingPCoords, usingZCoords, useDynP_inEos_Zc, setCenterDr,
323       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,       & nonHydrostatic, quasiHydrostatic, globalFiles, useSingleCpuIO,
324       & allowFreezing, useOldFreezing, groundAtK1,       & allowFreezing, useOldFreezing,
325       & usePickupBeforeC35, usePickupBeforeC54, debugMode,       & usePickupBeforeC35, usePickupBeforeC54, startFromPickupAB2,
      & readPickupWithTracer, writePickupWithTracer,  
326       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
327       & timeave_mdsio, snapshot_mdsio, monitor_stdio, seaice_mdsio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
328       & outputTypesInclusive,       & outputTypesInclusive, debugMode,
329       & inAdMode, inAdTrue, inAdFalse, inAdExact,       & inAdMode, inAdTrue, inAdFalse, inAdExact,
330       & calendarDumps       & calendarDumps
331    
# Line 339  C                      calendar months a Line 349  C                      calendar months a
349        LOGICAL saltAdvection        LOGICAL saltAdvection
350        LOGICAL saltForcing        LOGICAL saltForcing
351        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
352        LOGICAL useFullLeith        LOGICAL useFullLeith, useAnisotropicViscAGridMax
353        LOGICAL rigidLid        LOGICAL rigidLid
354        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
355        LOGICAL exactConserv        LOGICAL exactConserv
# Line 359  C                      calendar months a Line 369  C                      calendar months a
369        LOGICAL upwindVorticity        LOGICAL upwindVorticity
370        LOGICAL highOrderVorticity        LOGICAL highOrderVorticity
371        LOGICAL useAbsVorticity        LOGICAL useAbsVorticity
372          LOGICAL upwindShear
373        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
374        LOGICAL implicitViscosity        LOGICAL implicitViscosity
375        LOGICAL tempImplVertAdv        LOGICAL tempImplVertAdv
# Line 383  C                      calendar months a Line 394  C                      calendar months a
394        LOGICAL useSingleCpuIO        LOGICAL useSingleCpuIO
395        LOGICAL allowFreezing        LOGICAL allowFreezing
396        LOGICAL useOldFreezing        LOGICAL useOldFreezing
       LOGICAL groundAtK1  
397        LOGICAL usePickupBeforeC35        LOGICAL usePickupBeforeC35
398        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
399          LOGICAL startFromPickupAB2
400        LOGICAL debugMode        LOGICAL debugMode
       LOGICAL readPickupWithTracer  
       LOGICAL writePickupWithTracer  
401        LOGICAL pickup_read_mdsio, pickup_write_mdsio        LOGICAL pickup_read_mdsio, pickup_write_mdsio
402        LOGICAL pickup_write_immed        LOGICAL pickup_write_immed
403        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
       LOGICAL seaice_mdsio  
404        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
405        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
406        LOGICAL calendarDumps        LOGICAL calendarDumps
# Line 505  C     deltaTfreesurf :: Timestep for fre Line 513  C     deltaTfreesurf :: Timestep for fre
513  C     freesurfFac  :: Parameter to turn implicit free surface term on or off  C     freesurfFac  :: Parameter to turn implicit free surface term on or off
514  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
515  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
516    C     abEps        :: Adams-Bashforth-2 stabilizing weight
517    C     alph_AB      :: Adams-Bashforth-3 primary factor
518    C     beta_AB      :: Adams-Bashforth-3 secondary factor
519  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :  C     implicSurfPress :: parameter of the Crank-Nickelson time stepping :
520  C                     Implicit part of Surface Pressure Gradient ( 0-1 )  C                     Implicit part of Surface Pressure Gradient ( 0-1 )
521  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :  C     implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping :
# Line 541  C     tave_lastIter :: (for state variab Line 552  C     tave_lastIter :: (for state variab
552  C                      step (of each taveFreq period) put in the time average.  C                      step (of each taveFreq period) put in the time average.
553  C                      (fraction for 1rst iter = 1 - tave_lastIter)  C                      (fraction for 1rst iter = 1 - tave_lastIter)
554  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 ).  
555  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 ).  
556  C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,  C     latBandClimRelax :: latitude band where Relaxation to Clim. is applied,
557  C                         i.e. where |yC| <= latBandClimRelax  C                         i.e. where |yC| <= latBandClimRelax
558  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 568  C      --"-"--  Quadratic  ( linear: 1/s Line 577  C      --"-"--  Quadratic  ( linear: 1/s
577       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
578       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
579       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
580       & abeps,       & abEps, alph_AB, beta_AB,
581       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
582       & viscAh, viscAhW, viscAhMax,       & viscAh, viscAhW, viscAhMax,
583       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
# Line 591  C      --"-"--  Quadratic  ( linear: 1/s Line 600  C      --"-"--  Quadratic  ( linear: 1/s
600       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
601       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
602       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq, omega, rotationPeriod,
603       & tauThetaClimRelax, lambdaThetaClimRelax,       & tauThetaClimRelax,
604       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax,
605       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
606       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
607       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
608       & hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
609       & horiVertRatio, recip_horiVertRatio,       & horiVertRatio, recip_horiVertRatio,
610       & ivdc_kappa, Ro_SeaLevel,       & ivdc_kappa, Ro_SeaLevel,
611       & bottomDragLinear,bottomDragQuadratic,       & bottomDragLinear,bottomDragQuadratic,nh_Am2,
612       & tCylIn, tCylOut       & tCylIn, tCylOut
613    
614          _RL nh_Am2
615        _RL cg2dTargetResidual        _RL cg2dTargetResidual
616        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
617        _RL cg3dTargetResidual        _RL cg3dTargetResidual
# Line 615  C      --"-"--  Quadratic  ( linear: 1/s Line 625  C      --"-"--  Quadratic  ( linear: 1/s
625        _RL deltaTmom        _RL deltaTmom
626        _RL dTtracerLev(Nr)        _RL dTtracerLev(Nr)
627        _RL deltaTfreesurf        _RL deltaTfreesurf
628        _RL abeps        _RL abEps, alph_AB, beta_AB
629        _RL phiMin        _RL phiMin
630        _RL thetaMin        _RL thetaMin
631        _RL rSphere        _RL rSphere
# Line 677  C      --"-"--  Quadratic  ( linear: 1/s Line 687  C      --"-"--  Quadratic  ( linear: 1/s
687        _RL convertEmP2rUnit        _RL convertEmP2rUnit
688        _RL tRef(Nr)        _RL tRef(Nr)
689        _RL sRef(Nr)        _RL sRef(Nr)
       _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)  
       _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)  
       _RS fCoriCos(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)  
       _RS lambdaThetaClimRelax(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)  
       _RS lambdaSaltClimRelax(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)  
690        _RL baseTime        _RL baseTime
691        _RL startTime        _RL startTime
692        _RL endTime        _RL endTime
# Line 774  C Logical flags for selecting packages Line 779  C Logical flags for selecting packages
779        LOGICAL usediagnostics        LOGICAL usediagnostics
780        LOGICAL useEBM        LOGICAL useEBM
781        LOGICAL useMNC        LOGICAL useMNC
782          LOGICAL useMATRIX
783          LOGICAL useRunClock
784        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
785       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
786       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
787       &        usePTRACERS, useGCHEM,       &        usePTRACERS, useGCHEM,
788       &        useSBO, useSEAICE, useThSIce, useBulkForce,       &        useSBO, useSEAICE, useThSIce, useBulkForce,
789       &        usefizhi, usegridalt, usediagnostics, useEBM, useMNC,       &        usefizhi, usegridalt, usediagnostics, useEBM, useMNC,
790       &        usePP81, useMY82, useOPPS, useGGL90       &        usePP81, useMY82, useOPPS, useGGL90, useMATRIX,
791         &        useRunClock
792    
793  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
794  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
Legend:
Removed from v.1.151  
changed lines
  Added in v.1.162
  ViewVC Help
Powered by ViewVC 1.1.22