/[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.168 by jmc, Wed Sep 28 01:34:01 2005 UTC revision 1.174 by heimbach, Tue Dec 13 19:45:19 2005 UTC
# Line 207  C                               spherica Line 207  C                               spherica
207  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
208  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.  C     no_slip_sides :: Impose "no-slip" at lateral boundaries.
209  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  
210  C     momViscosity  :: Flag which turns momentum friction terms on and off.  C     momViscosity  :: Flag which turns momentum friction terms on and off.
211  C     momAdvection  :: Flag which turns advection of momentum on and off.  C     momAdvection  :: Flag which turns advection of momentum on and off.
212  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 234  C     useAreaViscLength :: Set to true t
234  C              lengths, e.g., L2=Raz.  May be preferable for cube sphere.  C              lengths, e.g., L2=Raz.  May be preferable for cube sphere.
235  C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms  C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
236  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
237  C     implicitFreeSurface :: Set to true to use implcit free surface  C     implicitFreeSurface :: Set to true to use implicit free surface
238  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
239  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
240  C                           linear relation Phi_surf = Bo_surf*eta  C                           linear relation Phi_surf = Bo_surf*eta
241    C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
242    C     staggerTimeStep :: enable a Stagger time stepping T,S Rho then U,V
243  C     momStepping   :: Turns momentum equation time-stepping off  C     momStepping   :: Turns momentum equation time-stepping off
244  C     tempStepping  :: Turns temperature equation time-stepping off  C     tempStepping  :: Turns temperature equation time-stepping off
245  C     saltStepping  :: Turns salinity equation time-stepping off  C     saltStepping  :: Turns salinity equation time-stepping off
# Line 260  C     saltImplVertAdv :: Turns on implic Line 261  C     saltImplVertAdv :: Turns on implic
261  C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum  C     momImplVertAdv  :: Turns on implicit vertical advection for Momentum
262  C     multiDimAdvection :: Flag that enable multi-dimension advection  C     multiDimAdvection :: Flag that enable multi-dimension advection
263  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once  C     useMultiDimAdvec  :: True if multi-dim advection is used at least once
264  C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution  C     forcing_In_AB     :: if False, put forcing (Temp,Salt,Tracers) contribution
265  C                      out off Adams-Bashforth time stepping.  C                          out off Adams-Bashforth time stepping.
266    C     doAB_onGtGs       :: if the Adams-Bashforth time stepping is used, always
267    C                          apply AB on tracer tendencies (rather than on Tracer)
268  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
269  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
270  C                        climatology is required.  C                        climatology is required.
# Line 303  C                        & Last iteratio Line 306  C                        & Last iteratio
306        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
307       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCurvilinearGrid, usingCylindricalGrid,
308       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
      & staggerTimeStep,  
309       & momViscosity, momAdvection, momForcing, useCoriolis,       & momViscosity, momAdvection, momForcing, useCoriolis,
310       & momPressureForcing, vectorInvariantMomentum,       & momPressureForcing, vectorInvariantMomentum,
311       & tempAdvection, tempForcing,       & tempAdvection, tempForcing,
# Line 312  C                        & Last iteratio Line 314  C                        & Last iteratio
314       & useFullLeith, useStrainTensionVisc,       & useFullLeith, useStrainTensionVisc,
315       & useAreaViscLength,       & useAreaViscLength,
316       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
317         & implicitIntGravWave, staggerTimeStep,
318       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
319       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,       & metricTerms, usingSphericalPolarMTerms, useNHMTerms,
320       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
# Line 321  C                        & Last iteratio Line 324  C                        & Last iteratio
324       & useAbsVorticity, upwindShear,       & useAbsVorticity, upwindShear,
325       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
326       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
327       & multiDimAdvection, useMultiDimAdvec, forcing_In_AB,       & multiDimAdvection, useMultiDimAdvec,
328         & forcing_In_AB, doAB_onGtGs,
329       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
330       & periodicExternalForcing,       & periodicExternalForcing,
331       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
# Line 343  C                        & Last iteratio Line 347  C                        & Last iteratio
347        LOGICAL useNHMTerms        LOGICAL useNHMTerms
348        LOGICAL no_slip_sides        LOGICAL no_slip_sides
349        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
       LOGICAL staggerTimeStep  
350        LOGICAL momViscosity        LOGICAL momViscosity
351        LOGICAL momAdvection        LOGICAL momAdvection
352        LOGICAL momForcing        LOGICAL momForcing
# Line 362  C                        & Last iteratio Line 365  C                        & Last iteratio
365        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
366        LOGICAL exactConserv        LOGICAL exactConserv
367        LOGICAL uniformLin_PhiSurf        LOGICAL uniformLin_PhiSurf
368          LOGICAL implicitIntGravWave
369          LOGICAL staggerTimeStep
370        LOGICAL momStepping        LOGICAL momStepping
371        LOGICAL tempStepping        LOGICAL tempStepping
372        LOGICAL saltStepping        LOGICAL saltStepping
# Line 386  C                        & Last iteratio Line 391  C                        & Last iteratio
391        LOGICAL multiDimAdvection        LOGICAL multiDimAdvection
392        LOGICAL useMultiDimAdvec        LOGICAL useMultiDimAdvec
393        LOGICAL forcing_In_AB        LOGICAL forcing_In_AB
394          LOGICAL doAB_onGtGs
395        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
396        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
397        LOGICAL doTr1ClimRelax        LOGICAL doTr1ClimRelax
# Line 447  C     rhoConst  :: Vertically constant r Line 453  C     rhoConst  :: Vertically constant r
453  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
454  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
455  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
456    C     phiRef    :: reference potential (pressure/rho, geopotential) profile
457    C     dBdrRef   :: vertical gradient of reference boyancy  [(m/s/r)^2)]:
458    C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
459    C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
460  C     phiMin    :: Latitude of southern most cell face.  C     phiMin    :: Latitude of southern most cell face.
461  C     thetaMin  :: Longitude of western most cell face (this  C     thetaMin  :: Longitude of western most cell face (this
462  C                 is an "inert" parameter but it is included  C                 is an "inert" parameter but it is included
# Line 585  C     recip_horiVertRatio  ( 1 if horiz Line 595  C     recip_horiVertRatio  ( 1 if horiz
595  C                          ( g*rho if horiz in m and vertical in Pa ).  C                          ( g*rho if horiz in m and vertical in Pa ).
596  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
597  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                          starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
598    C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
599    C                           (default=2: full drag ; =1: gives half-slip BC)
600  C     bottomDragLinear   :: Drag coefficient built in to core dynamics  C     bottomDragLinear   :: Drag coefficient built in to core dynamics
601  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )  C     bottomDragQuadratic   ( linear: 1/s, quadratic: 1/m )
602    C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales
603    C                      (i.e. allows convection at different Rayleigh numbers)
604        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
605       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
606       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
# Line 609  C      --"-"--  Quadratic  ( linear: 1/s Line 623  C      --"-"--  Quadratic  ( linear: 1/s
623       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
624       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,       & gravity, recip_Gravity, gBaro, rhonil, recip_rhonil,
625       & recip_rhoConst, rhoConst,       & recip_rhoConst, rhoConst,
626       & rhoConstFresh, convertEmP2rUnit, tRef, sRef,       & rhoConstFresh, convertEmP2rUnit, tRef, sRef, phiRef, dBdrRef,
627       & baseTime, startTime, endTime,       & baseTime, startTime, endTime,
628       & chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,       & chkPtFreq, pchkPtFreq, dumpFreq, adjDumpFreq,
629       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
630       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
631       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq, omega, rotationPeriod,
632       & tauThetaClimRelax,       & tauThetaClimRelax, tauThetaClimRelax3Dim,
633       & tauSaltClimRelax,       & tauSaltClimRelax, tauSaltClimRelax3Dim,
634       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,       & tauTr1ClimRelax, lambdaTr1ClimRelax, latBandClimRelax,
635       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
636       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
637       & hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
638       & horiVertRatio, recip_horiVertRatio,       & horiVertRatio, recip_horiVertRatio,
639       & ivdc_kappa, Ro_SeaLevel,       & ivdc_kappa, Ro_SeaLevel,
640       & bottomDragLinear,bottomDragQuadratic,nh_Am2,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
641       & tCylIn, tCylOut       & tCylIn, tCylOut
642    
       _RL nh_Am2  
643        _RL cg2dTargetResidual        _RL cg2dTargetResidual
644        _RL cg2dTargetResWunit        _RL cg2dTargetResWunit
645        _RL cg3dTargetResidual        _RL cg3dTargetResidual
# Line 703  C      --"-"--  Quadratic  ( linear: 1/s Line 716  C      --"-"--  Quadratic  ( linear: 1/s
716        _RL convertEmP2rUnit        _RL convertEmP2rUnit
717        _RL tRef(Nr)        _RL tRef(Nr)
718        _RL sRef(Nr)        _RL sRef(Nr)
719          _RL phiRef(2*Nr+1)
720          _RL dBdrRef(Nr)
721        _RL baseTime        _RL baseTime
722        _RL startTime        _RL startTime
723        _RL endTime        _RL endTime
# Line 727  C      --"-"--  Quadratic  ( linear: 1/s Line 742  C      --"-"--  Quadratic  ( linear: 1/s
742        _RL rotationPeriod        _RL rotationPeriod
743        _RL tauThetaClimRelax        _RL tauThetaClimRelax
744        _RL tauSaltClimRelax        _RL tauSaltClimRelax
745          _RL tauThetaClimRelax3Dim
746          _RL tauSaltClimRelax3Dim
747        _RL tauTr1ClimRelax        _RL tauTr1ClimRelax
748        _RL lambdaTr1ClimRelax        _RL lambdaTr1ClimRelax
749        _RL latBandClimRelax        _RL latBandClimRelax
# Line 739  C      --"-"--  Quadratic  ( linear: 1/s Line 756  C      --"-"--  Quadratic  ( linear: 1/s
756        _RL recip_horiVertRatio        _RL recip_horiVertRatio
757        _RL ivdc_kappa        _RL ivdc_kappa
758        _RL Ro_SeaLevel        _RL Ro_SeaLevel
759          _RL sideDragFactor
760        _RL bottomDragLinear        _RL bottomDragLinear
761        _RL bottomDragQuadratic        _RL bottomDragQuadratic
762          _RL nh_Am2
763        _RL tCylIn        _RL tCylIn
764        _RL tCylOut        _RL tCylOut
765    
# Line 786  C Logical flags for selecting packages Line 805  C Logical flags for selecting packages
805        LOGICAL useFLT        LOGICAL useFLT
806        LOGICAL usePTRACERS        LOGICAL usePTRACERS
807        LOGICAL useGCHEM        LOGICAL useGCHEM
808          LOGICAL useRBCS
809        LOGICAL useSBO        LOGICAL useSBO
810        LOGICAL useSEAICE        LOGICAL useSEAICE
811        LOGICAL useBulkForce        LOGICAL useBulkForce
# Line 800  C Logical flags for selecting packages Line 820  C Logical flags for selecting packages
820        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
821       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useLand, useECCO,
822       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
823       &        usePTRACERS, useGCHEM,       &        usePTRACERS, useGCHEM, useRBCS,
824       &        useSBO, useSEAICE, useThSIce, useBulkForce,       &        useSBO, useSEAICE, useThSIce, useBulkForce,
825       &        usefizhi, usegridalt, usediagnostics, useEBM, useMNC,       &        usefizhi, usegridalt, usediagnostics, useEBM, useMNC,
826       &        usePP81, useMY82, useOPPS, useGGL90, useMATRIX,       &        usePP81, useMY82, useOPPS, useGGL90, useMATRIX,
Legend:
Removed from v.1.168  
changed lines
  Added in v.1.174
  ViewVC Help
Powered by ViewVC 1.1.22