/[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.180 by jmc, Tue Mar 7 15:27:14 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 150  C     nonlinFreeSurf      :: option rela Line 152  C     nonlinFreeSurf      :: option rela
152  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
153  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
154  C                           =0 (default) use r coord. ; > 0 use r*  C                           =0 (default) use r coord. ; > 0 use r*
155    C     momForcingOutAB     :: =1: take momentum forcing contribution
156    C                           out of (=0: in) Adams-Bashforth time stepping.
157    C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
158    C                           out of (=0: in) Adams-Bashforth time stepping.
159  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
160  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
161  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
# Line 167  C     debugLevel          :: debug level Line 173  C     debugLevel          :: debug level
173       &        writeStatePrec, nCheckLev,       &        writeStatePrec, nCheckLev,
174       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
175       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
176         &        momForcingOutAB, tracForcingOutAB,
177       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
178       &        saltAdvScheme, saltVertAdvScheme,       &        saltAdvScheme, saltVertAdvScheme,
179       &        selectKEscheme,       &        selectKEscheme,
# Line 186  C     debugLevel          :: debug level Line 193  C     debugLevel          :: debug level
193        INTEGER nCheckLev        INTEGER nCheckLev
194        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
195        INTEGER select_rStar        INTEGER select_rStar
196          INTEGER momForcingOutAB, tracForcingOutAB
197        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
198        INTEGER saltAdvScheme, saltVertAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
199        INTEGER selectKEscheme        INTEGER selectKEscheme
# Line 207  C                               spherica Line 215  C                               spherica
215  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
216  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.
217  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  
218  C     momViscosity  :: Flag which turns momentum friction terms on and off.  C     momViscosity  :: Flag which turns momentum friction terms on and off.
219  C     momAdvection  :: Flag which turns advection of momentum on and off.  C     momAdvection  :: Flag which turns advection of momentum on and off.
220  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 242  C     useAreaViscLength :: Set to true t
242  C              lengths, e.g., L2=Raz.  May be preferable for cube sphere.  C              lengths, e.g., L2=Raz.  May be preferable for cube sphere.
243  C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms  C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
244  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
245  C     implicitFreeSurface :: Set to true to use implcit free surface  C     implicitFreeSurface :: Set to true to use implicit free surface
246  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
247  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
248  C                           linear relation Phi_surf = Bo_surf*eta  C                           linear relation Phi_surf = Bo_surf*eta
249    C     use3Dsolver   :: set to true to use 3-D pressure solver
250    C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
251    C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
252  C     momStepping   :: Turns momentum equation time-stepping off  C     momStepping   :: Turns momentum equation time-stepping off
253  C     tempStepping  :: Turns temperature equation time-stepping off  C     tempStepping  :: Turns temperature equation time-stepping off
254  C     saltStepping  :: Turns salinity equation time-stepping off  C     saltStepping  :: Turns salinity equation time-stepping off
# Line 260  C     saltImplVertAdv :: Turns on implic Line 270  C     saltImplVertAdv :: Turns on implic
270  C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum  C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
271  C     multiDimAdvection :: Flag that enable multi-dimension advection  C     multiDimAdvection :: Flag that enable multi-dimension advection
272  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
273  C     forcing_In_AB     :: if False, put forcing (Temp,Salt,Tracers) contribution  C     momDissip_In_AB   :: if False, put Dissipation tendency contribution
274  C                          out off Adams-Bashforth time stepping.  C                          out off Adams-Bashforth time stepping.
275  C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always  C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always
276  C                          apply AB on tracer tendencies (rather than on Tracer)  C                          apply AB on tracer tendencies (rather than on Tracer)
# Line 302  C                      KPP_taveFreq, and Line 312  C                      KPP_taveFreq, and
312  C                      calendar months and years.  Requires pkg/cal.  C                      calendar months and years.  Requires pkg/cal.
313  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
314  C                        & Last iteration, in addition multiple of dumpFreq iter.  C                        & Last iteration, in addition multiple of dumpFreq iter.
315    C     balanceEmPmR    :: substract global mean of EmPmR at every time step
316    C     balanceQnet     :: substract global mean of Qnet at every time step
317    C     balancePrintMean:: print substracted global means to STDOUT
318    
319        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
320       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
321       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
      & staggerTimeStep,  
322       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
323       & momPressureForcing, vectorInvariantMomentum,       & momPressureForcing, vectorInvariantMomentum,
324       & tempAdvection, tempForcing,       & tempAdvection, tempForcing,
# Line 314  C                        & Last iteratio Line 327  C                        & Last iteratio
327       & useFullLeith, useStrainTensionVisc,       & useFullLeith, useStrainTensionVisc,
328       & useAreaViscLength,       & useAreaViscLength,
329       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
330         & use3Dsolver, implicitIntGravWave, staggerTimeStep,
331       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
332       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
333       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
# Line 324  C                        & Last iteratio Line 338  C                        & Last iteratio
338       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
339       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
340       & multiDimAdvection, useMultiDimAdvec,       & multiDimAdvection, useMultiDimAdvec,
341       & forcing_In_AB, doAB_onGtGs,       & momDissip_In_AB, doAB_onGtGs,
342       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
343       & periodicExternalForcing,       & periodicExternalForcing,
344       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
# Line 336  C                        & Last iteratio Line 350  C                        & Last iteratio
350       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
351       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast, debugMode,
352       & inAdMode, inAdTrue, inAdFalse, inAdExact,       & inAdMode, inAdTrue, inAdFalse, inAdExact,
353       & calendarDumps       & calendarDumps,
354         & balanceEmPmR, balanceQnet, balancePrintMean
355    
356        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
357        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
# Line 346  C                        & Last iteratio Line 361  C                        & Last iteratio
361        LOGICAL useNHMTerms        LOGICAL useNHMTerms
362        LOGICAL no_slip_sides        LOGICAL no_slip_sides
363        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
       LOGICAL staggerTimeStep  
364        LOGICAL momViscosity        LOGICAL momViscosity
365        LOGICAL momAdvection        LOGICAL momAdvection
366        LOGICAL momForcing        LOGICAL momForcing
# Line 365  C                        & Last iteratio Line 379  C                        & Last iteratio
379        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
380        LOGICAL exactConserv        LOGICAL exactConserv
381        LOGICAL uniformLin_PhiSurf        LOGICAL uniformLin_PhiSurf
382          LOGICAL use3Dsolver
383          LOGICAL implicitIntGravWave
384          LOGICAL staggerTimeStep
385        LOGICAL momStepping        LOGICAL momStepping
386        LOGICAL tempStepping        LOGICAL tempStepping
387        LOGICAL saltStepping        LOGICAL saltStepping
# Line 388  C                        & Last iteratio Line 405  C                        & Last iteratio
405        LOGICAL momImplVertAdv        LOGICAL momImplVertAdv
406        LOGICAL multiDimAdvection        LOGICAL multiDimAdvection
407        LOGICAL useMultiDimAdvec        LOGICAL useMultiDimAdvec
408        LOGICAL forcing_In_AB        LOGICAL momDissip_In_AB
409        LOGICAL doAB_onGtGs        LOGICAL doAB_onGtGs
410        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
411        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
# Line 418  C                        & Last iteratio Line 435  C                        & Last iteratio
435        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
436        LOGICAL calendarDumps        LOGICAL calendarDumps
437    
438          LOGICAL balanceEmPmR
439          LOGICAL balanceQnet
440          LOGICAL balancePrintMean
441    
442  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
443  C     cg2dTargetResidual  C     cg2dTargetResidual
444  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 472  C     rhoConst  :: Vertically constant r
472  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
473  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
474  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
475    C     phiRef    :: reference potential (pressure/rho, geopotential) profile
476    C     dBdrRef   :: vertical gradient of reference boyancy  [(m/s/r)^2)]:
477    C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
478    C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
479  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
480  C     thetaMin  :: Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
481  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 642  C                      (i.e. allows conv
642       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
643       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
644       & recip_rhoConst, rhoConst,       & recip_rhoConst, rhoConst,
645       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,       & rhoConstFresh, convertEmP2rUnit, tRef, sRef, phiRef, dBdrRef,
646       & baseTime, startTime, endTime,       & baseTime, startTime, endTime,
647       & chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,       & chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,
648       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
649       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
650       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq, omega, rotationPeriod,
651       & tauThetaClimRelax,       & tauThetaClimRelax, tauSaltClimRelax,
      & tauSaltClimRelax,  
652       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
653       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
654       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
# Line 710  C                      (i.e. allows conv Line 734  C                      (i.e. allows conv
734        _RL convertEmP2rUnit        _RL convertEmP2rUnit
735        _RL tRef(Nr)        _RL tRef(Nr)
736        _RL sRef(Nr)        _RL sRef(Nr)
737          _RL phiRef(2*Nr+1)
738          _RL dBdrRef(Nr)
739        _RL baseTime        _RL baseTime
740        _RL startTime        _RL startTime
741        _RL endTime        _RL endTime
# Line 795  C Logical flags for selecting packages Line 821  C Logical flags for selecting packages
821        LOGICAL useFLT        LOGICAL useFLT
822        LOGICAL usePTRACERS        LOGICAL usePTRACERS
823        LOGICAL useGCHEM        LOGICAL useGCHEM
824          LOGICAL useRBCS
825        LOGICAL useSBO        LOGICAL useSBO
826        LOGICAL useSEAICE        LOGICAL useSEAICE
827          LOGICAL useShelfIce
828        LOGICAL useBulkForce        LOGICAL useBulkForce
829        LOGICAL useThSIce        LOGICAL useThSIce
830        LOGICAL usefizhi        LOGICAL usefizhi
831        LOGICAL usegridalt        LOGICAL usegridalt
832        LOGICAL usediagnostics        LOGICAL useDiagnostics
833        LOGICAL useEBM        LOGICAL useEBM
834        LOGICAL useMNC        LOGICAL useMNC
835        LOGICAL useMATRIX        LOGICAL useMATRIX
836        LOGICAL useRunClock        LOGICAL useRunClock
837          LOGICAL useEMBED_FILES
838        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
839       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
840       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
841       &        usePTRACERS, useGCHEM,       &        usePTRACERS, useGCHEM, useRBCS,
842       &        useSBO, useSEAICE, useThSIce, useBulkForce,       &        useSBO, useSEAICE, useShelfIce, useThSIce, useBulkForce,
843       &        usefizhi, usegridalt, usediagnostics, useEBM, useMNC,       &        usefizhi, usegridalt, useDiagnostics, useEBM, useMNC,
844       &        usePP81, useMY82, useOPPS, useGGL90, useMATRIX,       &        usePP81, useMY82, useOPPS, useGGL90, useMATRIX,
845       &        useRunClock       &        useRunClock, useEMBED_FILES
846    
847  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
848  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
Legend:
Removed from v.1.170  
changed lines
  Added in v.1.180
  ViewVC Help
Powered by ViewVC 1.1.22