/[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.174 by heimbach, Tue Dec 13 19:45:19 2005 UTC revision 1.182 by jmc, Fri Mar 17 23:29:37 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 214  C                     and off. Line 222  C                     and off.
222  C     momPressureForcing :: Flag which turns pressure term in momentum equation  C     momPressureForcing :: Flag which turns pressure term in momentum equation
223  C                          on and off.  C                          on and off.
224  C     metricTerms   :: Flag which turns metric terms on or off.  C     metricTerms   :: Flag which turns metric terms on or off.
225  C     usingSphericalPolarMTerms :: If TRUE use spherical polar metric terms.  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.
 C     useNHMTerms :: If TRUE use non-hydrostatic metric terms.  
226  C     useCoriolis   :: Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
227  C     tempAdvection :: Flag which turns advection of temperature on  C     tempAdvection :: Flag which turns advection of temperature on
228  C                     and off.  C                     and off.
# Line 238  C     implicitFreeSurface :: Set to true Line 245  C     implicitFreeSurface :: Set to true
245  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
246  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
247  C                           linear relation Phi_surf = Bo_surf*eta  C                           linear relation Phi_surf = Bo_surf*eta
248    C     use3Dsolver   :: set to true to use 3-D pressure solver
249  C     implicitIntGravWave :: treat Internal Gravity Wave implicitly  C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
250  C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V  C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
251  C     momStepping   :: Turns momentum equation time-stepping off  C     momStepping   :: Turns momentum equation time-stepping off
# Line 261  C     saltImplVertAdv :: Turns on implic Line 269  C     saltImplVertAdv :: Turns on implic
269  C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum  C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
270  C     multiDimAdvection :: Flag that enable multi-dimension advection  C     multiDimAdvection :: Flag that enable multi-dimension advection
271  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
272  C     forcing_In_AB     :: if False, put forcing (Temp,Salt,Tracers) contribution  C     momDissip_In_AB   :: if False, put Dissipation tendency contribution
273  C                          out off Adams-Bashforth time stepping.  C                          out off Adams-Bashforth time stepping.
274  C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always  C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always
275  C                          apply AB on tracer tendencies (rather than on Tracer)  C                          apply AB on tracer tendencies (rather than on Tracer)
# Line 303  C                      KPP_taveFreq, and Line 311  C                      KPP_taveFreq, and
311  C                      calendar months and years.  Requires pkg/cal.  C                      calendar months and years.  Requires pkg/cal.
312  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
313  C                        & Last iteration, in addition multiple of dumpFreq iter.  C                        & Last iteration, in addition multiple of dumpFreq iter.
314    C     balanceEmPmR    :: substract global mean of EmPmR at every time step
315    C     balanceQnet     :: substract global mean of Qnet at every time step
316    C     balancePrintMean:: print substracted global means to STDOUT
317    
318        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
319       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
320       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
# Line 314  C                        & Last iteratio Line 326  C                        & Last iteratio
326       & useFullLeith, useStrainTensionVisc,       & useFullLeith, useStrainTensionVisc,
327       & useAreaViscLength,       & useAreaViscLength,
328       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
329       & implicitIntGravWave, staggerTimeStep,       & use3Dsolver, implicitIntGravWave, staggerTimeStep,
330       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
331       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & metricTerms, useNHMTerms,
332       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
333       & useCDscheme,       & useCDscheme,
334       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
# Line 325  C                        & Last iteratio Line 337  C                        & Last iteratio
337       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
338       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
339       & multiDimAdvection, useMultiDimAdvec,       & multiDimAdvection, useMultiDimAdvec,
340       & forcing_In_AB, doAB_onGtGs,       & momDissip_In_AB, doAB_onGtGs,
341       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
342       & periodicExternalForcing,       & periodicExternalForcing,
343       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
# Line 337  C                        & Last iteratio Line 349  C                        & Last iteratio
349       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
350       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast, debugMode,
351       & inAdMode, inAdTrue, inAdFalse, inAdExact,       & inAdMode, inAdTrue, inAdFalse, inAdExact,
352       & calendarDumps       & calendarDumps,
353         & balanceEmPmR, balanceQnet, balancePrintMean
354    
355        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
356        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
357        LOGICAL usingCylindricalGrid        LOGICAL usingCylindricalGrid
358        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
       LOGICAL usingSphericalPolarMTerms  
359        LOGICAL useNHMTerms        LOGICAL useNHMTerms
360        LOGICAL no_slip_sides        LOGICAL no_slip_sides
361        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
# Line 365  C                        & Last iteratio Line 377  C                        & Last iteratio
377        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
378        LOGICAL exactConserv        LOGICAL exactConserv
379        LOGICAL uniformLin_PhiSurf        LOGICAL uniformLin_PhiSurf
380          LOGICAL use3Dsolver
381        LOGICAL implicitIntGravWave        LOGICAL implicitIntGravWave
382        LOGICAL staggerTimeStep        LOGICAL staggerTimeStep
383        LOGICAL momStepping        LOGICAL momStepping
# Line 390  C                        & Last iteratio Line 403  C                        & Last iteratio
403        LOGICAL momImplVertAdv        LOGICAL momImplVertAdv
404        LOGICAL multiDimAdvection        LOGICAL multiDimAdvection
405        LOGICAL useMultiDimAdvec        LOGICAL useMultiDimAdvec
406        LOGICAL forcing_In_AB        LOGICAL momDissip_In_AB
407        LOGICAL doAB_onGtGs        LOGICAL doAB_onGtGs
408        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
409        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
# Line 420  C                        & Last iteratio Line 433  C                        & Last iteratio
433        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
434        LOGICAL calendarDumps        LOGICAL calendarDumps
435    
436          LOGICAL balanceEmPmR
437          LOGICAL balanceQnet
438          LOGICAL balancePrintMean
439    
440  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
441  C     cg2dTargetResidual  C     cg2dTargetResidual
442  C          :: Target residual for cg2d solver; no unit (RHS normalisation)  C          :: Target residual for cg2d solver; no unit (RHS normalisation)
# Line 629  C                      (i.e. allows conv Line 646  C                      (i.e. allows conv
646       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
647       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
648       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq, omega, rotationPeriod,
649       & tauThetaClimRelax, tauThetaClimRelax3Dim,       & tauThetaClimRelax, tauSaltClimRelax,
      & tauSaltClimRelax, tauSaltClimRelax3Dim,  
650       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
651       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
652       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
# Line 735  C                      (i.e. allows conv Line 751  C                      (i.e. allows conv
751        _RL pfFacMom        _RL pfFacMom
752        _RL cfFacMom        _RL cfFacMom
753        _RL foFacMom        _RL foFacMom
754        _RL mTFacMom        _RL mtFacMom
755        _RL cosPower        _RL cosPower
756        _RL cAdjFreq        _RL cAdjFreq
757        _RL omega        _RL omega
758        _RL rotationPeriod        _RL rotationPeriod
759        _RL tauThetaClimRelax        _RL tauThetaClimRelax
760        _RL tauSaltClimRelax        _RL tauSaltClimRelax
       _RL tauThetaClimRelax3Dim  
       _RL tauSaltClimRelax3Dim  
761        _RL tauTr1ClimRelax        _RL tauTr1ClimRelax
762        _RL lambdaTr1ClimRelax        _RL lambdaTr1ClimRelax
763        _RL latBandClimRelax        _RL latBandClimRelax
# Line 806  C Logical flags for selecting packages Line 820  C Logical flags for selecting packages
820        LOGICAL usePTRACERS        LOGICAL usePTRACERS
821        LOGICAL useGCHEM        LOGICAL useGCHEM
822        LOGICAL useRBCS        LOGICAL useRBCS
823          LOGICAL useOffLine
824        LOGICAL useSBO        LOGICAL useSBO
825        LOGICAL useSEAICE        LOGICAL useSEAICE
826          LOGICAL useShelfIce
827        LOGICAL useBulkForce        LOGICAL useBulkForce
828        LOGICAL useThSIce        LOGICAL useThSIce
829        LOGICAL usefizhi        LOGICAL usefizhi
830        LOGICAL usegridalt        LOGICAL usegridalt
831        LOGICAL usediagnostics        LOGICAL useDiagnostics
832        LOGICAL useEBM        LOGICAL useEBM
833        LOGICAL useMNC        LOGICAL useMNC
834        LOGICAL useMATRIX        LOGICAL useMATRIX
835        LOGICAL useRunClock        LOGICAL useRunClock
836          LOGICAL useEMBED_FILES
837        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
838       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
839       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
840       &        usePTRACERS, useGCHEM, useRBCS,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine,
841       &        useSBO, useSEAICE, useThSIce, useBulkForce,       &        useSBO, useSEAICE, useShelfIce, useThSIce, useBulkForce,
842       &        usefizhi, usegridalt, usediagnostics, useEBM, useMNC,       &        usefizhi, usegridalt, useDiagnostics, useEBM, useMNC,
843       &        usePP81, useMY82, useOPPS, useGGL90, useMATRIX,       &        usePP81, useMY82, useOPPS, useGGL90, useMATRIX,
844       &        useRunClock       &        useRunClock, useEMBED_FILES
845    
846  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
847  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***

Legend:
Removed from v.1.174  
changed lines
  Added in v.1.182

  ViewVC Help
Powered by ViewVC 1.1.22