/[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.170 by jmc, Mon Oct 24 22:38:49 2005 UTC revision 1.179 by jmc, Thu Feb 23 16:43:52 2006 UTC
# Line 36  C     UNSET_xxx :: Used to indicate vari Line 36  C     UNSET_xxx :: Used to indicate vari
36        PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )        PARAMETER ( UNSET_FLOAT8 = 1.234567D5 )
37        Real*4 UNSET_FLOAT4        Real*4 UNSET_FLOAT4
38        PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )        PARAMETER ( UNSET_FLOAT4 = 1.234567E5 )
39        _RL    UNSET_RL            _RL    UNSET_RL
40        PARAMETER ( UNSET_RL     = 1.234567D5 )        PARAMETER ( UNSET_RL     = 1.234567D5 )
41        _RS    UNSET_RS            _RS    UNSET_RS
42        PARAMETER ( UNSET_RS     = 1.234567E5 )        PARAMETER ( UNSET_RS     = 1.234567E5 )
43        INTEGER UNSET_I        INTEGER UNSET_I
44        PARAMETER ( UNSET_I      = 123456789  )        PARAMETER ( UNSET_I      = 123456789  )
# Line 57  C     bathyFile   :: File containing bat Line 57  C     bathyFile   :: File containing bat
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).
60    C     shelfIceFile:: File containing the topography of the shelfice draught
61    C                    (unit=m)
62  C     hydrogThetaFile :: File containing initial hydrographic data for potential  C     hydrogThetaFile :: File containing initial hydrographic data for potential
63  C                       temperature.  C                       temperature.
64  C     hydrogSaltFile  :: File containing initial hydrographic data for salinity.  C     hydrogSaltFile  :: File containing initial hydrographic data for salinity.
# Line 83  C                        LINEAR, POLY3, Line 85  C                        LINEAR, POLY3,
85  C     the_run_name    :: string identifying the name of the model "run"  C     the_run_name    :: string identifying the name of the model "run"
86        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/ checkPtSuff,
87       &                delXFile, delYFile, horizGridFile,       &                delXFile, delYFile, horizGridFile,
88       &                bathyFile, topoFile,       &                bathyFile, topoFile, shelfIceFile,
89       &                hydrogThetaFile, hydrogSaltFile,       &                hydrogThetaFile, hydrogSaltFile,
90       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
91       &                saltClimFile, buoyancyRelation,       &                saltClimFile, buoyancyRelation,
# Line 100  C     the_run_name    :: string identify Line 102  C     the_run_name    :: string identify
102        CHARACTER*(MAX_LEN_FNAM) delXFile        CHARACTER*(MAX_LEN_FNAM) delXFile
103        CHARACTER*(MAX_LEN_FNAM) delYFile        CHARACTER*(MAX_LEN_FNAM) delYFile
104        CHARACTER*(MAX_LEN_FNAM) horizGridFile        CHARACTER*(MAX_LEN_FNAM) horizGridFile
105        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile, shelfIceFile
106        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
107        CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile
108        CHARACTER*(MAX_LEN_FNAM) zonalWindFile        CHARACTER*(MAX_LEN_FNAM) zonalWindFile
# Line 207  C                               spherica Line 209  C                               spherica
209  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
210  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.
211  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
 C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V  
212  C     momViscosity  :: Flag which turns momentum friction terms on and off.  C     momViscosity  :: Flag which turns momentum friction terms on and off.
213  C     momAdvection  :: Flag which turns advection of momentum on and off.  C     momAdvection  :: Flag which turns advection of momentum on and off.
214  C     momForcing    :: Flag which turns external forcing of momentum on  C     momForcing    :: Flag which turns external forcing of momentum on
# Line 235  C     useAreaViscLength :: Set to true t Line 236  C     useAreaViscLength :: Set to true t
236  C              lengths, e.g., L2=Raz.  May be preferable for cube sphere.  C              lengths, e.g., L2=Raz.  May be preferable for cube sphere.
237  C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms  C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
238  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
239  C     implicitFreeSurface :: Set to true to use implcit free surface  C     implicitFreeSurface :: Set to true to use implicit free surface
240  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
241  C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the  C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
242  C                           linear relation Phi_surf = Bo_surf*eta  C                           linear relation Phi_surf = Bo_surf*eta
243    C     use3Dsolver   :: set to true to use 3-D pressure solver
244    C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
245    C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
246  C     momStepping   :: Turns momentum equation time-stepping off  C     momStepping   :: Turns momentum equation time-stepping off
247  C     tempStepping  :: Turns temperature equation time-stepping off  C     tempStepping  :: Turns temperature equation time-stepping off
248  C     saltStepping  :: Turns salinity equation time-stepping off  C     saltStepping  :: Turns salinity equation time-stepping off
# Line 302  C                      KPP_taveFreq, and Line 306  C                      KPP_taveFreq, and
306  C                      calendar months and years.  Requires pkg/cal.  C                      calendar months and years.  Requires pkg/cal.
307  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
308  C                        & Last iteration, in addition multiple of dumpFreq iter.  C                        & Last iteration, in addition multiple of dumpFreq iter.
309    C     balanceEmPmR    :: substract global mean of EmPmR at every time step
310    C     balanceQnet     :: substract global mean of Qnet at every time step
311    C     balancePrintMean:: print substracted global means to STDOUT
312    
313        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
314       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
315       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
      & staggerTimeStep,  
316       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
317       & momPressureForcing, vectorInvariantMomentum,       & momPressureForcing, vectorInvariantMomentum,
318       & tempAdvection, tempForcing,       & tempAdvection, tempForcing,
# Line 314  C                        & Last iteratio Line 321  C                        & Last iteratio
321       & useFullLeith, useStrainTensionVisc,       & useFullLeith, useStrainTensionVisc,
322       & useAreaViscLength,       & useAreaViscLength,
323       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
324         & use3Dsolver, implicitIntGravWave, staggerTimeStep,
325       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
326       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
327       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
# Line 336  C                        & Last iteratio Line 344  C                        & Last iteratio
344       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
345       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast, debugMode,
346       & inAdMode, inAdTrue, inAdFalse, inAdExact,       & inAdMode, inAdTrue, inAdFalse, inAdExact,
347       & calendarDumps       & calendarDumps,
348         & balanceEmPmR, balanceQnet, balancePrintMean
349    
350        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
351        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
# Line 346  C                        & Last iteratio Line 355  C                        & Last iteratio
355        LOGICAL useNHMTerms        LOGICAL useNHMTerms
356        LOGICAL no_slip_sides        LOGICAL no_slip_sides
357        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
       LOGICAL staggerTimeStep  
358        LOGICAL momViscosity        LOGICAL momViscosity
359        LOGICAL momAdvection        LOGICAL momAdvection
360        LOGICAL momForcing        LOGICAL momForcing
# Line 365  C                        & Last iteratio Line 373  C                        & Last iteratio
373        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
374        LOGICAL exactConserv        LOGICAL exactConserv
375        LOGICAL uniformLin_PhiSurf        LOGICAL uniformLin_PhiSurf
376          LOGICAL use3Dsolver
377          LOGICAL implicitIntGravWave
378          LOGICAL staggerTimeStep
379        LOGICAL momStepping        LOGICAL momStepping
380        LOGICAL tempStepping        LOGICAL tempStepping
381        LOGICAL saltStepping        LOGICAL saltStepping
# Line 418  C                        & Last iteratio Line 429  C                        & Last iteratio
429        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
430        LOGICAL calendarDumps        LOGICAL calendarDumps
431    
432          LOGICAL balanceEmPmR
433          LOGICAL balanceQnet
434          LOGICAL balancePrintMean
435    
436  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
437  C     cg2dTargetResidual  C     cg2dTargetResidual
438  C          :: Target residual for cg2d solver; no unit (RHS normalisation)  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
# Line 451  C     rhoConst  :: Vertically constant r Line 466  C     rhoConst  :: Vertically constant r
466  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
467  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
468  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
469    C     phiRef    :: reference potential (pressure/rho, geopotential) profile
470    C     dBdrRef   :: vertical gradient of reference boyancy  [(m/s/r)^2)]:
471    C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
472    C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
473  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
474  C     thetaMin  :: Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
475  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
# Line 617  C                      (i.e. allows conv Line 636  C                      (i.e. allows conv
636       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
637       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
638       & recip_rhoConst, rhoConst,       & recip_rhoConst, rhoConst,
639       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,       & rhoConstFresh, convertEmP2rUnit, tRef, sRef, phiRef, dBdrRef,
640       & baseTime, startTime, endTime,       & baseTime, startTime, endTime,
641       & chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,       & chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,
642       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
643       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
644       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq, omega, rotationPeriod,
645       & tauThetaClimRelax,       & tauThetaClimRelax, tauSaltClimRelax,
      & tauSaltClimRelax,  
646       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
647       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
648       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
# Line 710  C                      (i.e. allows conv Line 728  C                      (i.e. allows conv
728        _RL convertEmP2rUnit        _RL convertEmP2rUnit
729        _RL tRef(Nr)        _RL tRef(Nr)
730        _RL sRef(Nr)        _RL sRef(Nr)
731          _RL phiRef(2*Nr+1)
732          _RL dBdrRef(Nr)
733        _RL baseTime        _RL baseTime
734        _RL startTime        _RL startTime
735        _RL endTime        _RL endTime
# Line 795  C Logical flags for selecting packages Line 815  C Logical flags for selecting packages
815        LOGICAL useFLT        LOGICAL useFLT
816        LOGICAL usePTRACERS        LOGICAL usePTRACERS
817        LOGICAL useGCHEM        LOGICAL useGCHEM
818          LOGICAL useRBCS
819        LOGICAL useSBO        LOGICAL useSBO
820        LOGICAL useSEAICE        LOGICAL useSEAICE
821          LOGICAL useShelfIce
822        LOGICAL useBulkForce        LOGICAL useBulkForce
823        LOGICAL useThSIce        LOGICAL useThSIce
824        LOGICAL usefizhi        LOGICAL usefizhi
825        LOGICAL usegridalt        LOGICAL usegridalt
826        LOGICAL usediagnostics        LOGICAL useDiagnostics
827        LOGICAL useEBM        LOGICAL useEBM
828        LOGICAL useMNC        LOGICAL useMNC
829        LOGICAL useMATRIX        LOGICAL useMATRIX
830        LOGICAL useRunClock        LOGICAL useRunClock
831          LOGICAL useEMBED_FILES
832        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
833       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
834       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
835       &        usePTRACERS, useGCHEM,       &        usePTRACERS, useGCHEM, useRBCS,
836       &        useSBO, useSEAICE, useThSIce, useBulkForce,       &        useSBO, useSEAICE, useShelfIce, useThSIce, useBulkForce,
837       &        usefizhi, usegridalt, usediagnostics, useEBM, useMNC,       &        usefizhi, usegridalt, useDiagnostics, useEBM, useMNC,
838       &        usePP81, useMY82, useOPPS, useGGL90, useMATRIX,       &        usePP81, useMY82, useOPPS, useGGL90, useMATRIX,
839       &        useRunClock       &        useRunClock, useEMBED_FILES
840    
841  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
842  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
Legend:
Removed from v.1.170  
changed lines
  Added in v.1.179
  ViewVC Help
Powered by ViewVC 1.1.22