/[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.67 by jmc, Tue Dec 11 14:54:04 2001 UTC revision 1.73 by mlosch, Wed Jul 31 16:38:30 2002 UTC
# Line 69  C     surfQfile       :: File containing Line 69  C     surfQfile       :: File containing
69  C     surfQswfile     :: File containing surface shortwave radiation  C     surfQswfile     :: File containing surface shortwave radiation
70  C     dQdTfile        :: File containing thermal relaxation coefficient  C     dQdTfile        :: File containing thermal relaxation coefficient
71  C     EmPmRfile       :: File containing surface fresh water flux  C     EmPmRfile       :: File containing surface fresh water flux
72    C     pLoadFile       :: File containing pressure loading
73  C     buoyancyRelation :: Flag used to indicate which relation to use to  C     buoyancyRelation :: Flag used to indicate which relation to use to
74  C                        get buoyancy.  C                        get buoyancy.
75        COMMON /PARM_C/ checkPtSuff,        COMMON /PARM_C/ checkPtSuff,
# Line 78  C                        get buoyancy. Line 79  C                        get buoyancy.
79       &                saltClimFile, buoyancyRelation,       &                saltClimFile, buoyancyRelation,
80       &                EmPmRfile, surfQfile, surfQswfile,       &                EmPmRfile, surfQfile, surfQswfile,
81       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
82       &                dQdTfile       &                dQdTfile, ploadFile
83        CHARACTER*(5) checkPtSuff(maxNoChkptLev)        CHARACTER*(5) checkPtSuff(maxNoChkptLev)
84        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
85        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile
# Line 95  C                        get buoyancy. Line 96  C                        get buoyancy.
96        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
97        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
98        CHARACTER*(MAX_LEN_FNAM) dQdTfile        CHARACTER*(MAX_LEN_FNAM) dQdTfile
99          CHARACTER*(MAX_LEN_FNAM) ploadFile
100    
101  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
102  C     cg2dMaxIters        :: Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
# Line 167  C     tempAdvection :: Flag which turns Line 169  C     tempAdvection :: Flag which turns
169  C                     and off.  C                     and off.
170  C     tempForcing   :: Flag which turns external forcing of temperature on  C     tempForcing   :: Flag which turns external forcing of temperature on
171  C                     and off.  C                     and off.
172  C     saltDiffusion :: Flag which turns diffusion of salinit on  C     saltDiffusion :: Flag which turns diffusion of salinity on
173  C                     and off.  C                     and off.
174  C     saltAdvection :: Flag which turns advection of salinit on  C     saltAdvection :: Flag which turns advection of salinity on
175  C                     and off.  C                     and off.
176  C     saltForcing   :: Flag which turns external forcing of salinit on  C     saltForcing   :: Flag which turns external forcing of salinity on
177  C                     and off.  C                     and off.
178    C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
179    C                         as a real Fresh Water (=> changes the Sea Level)
180    C                         if F, converts P+R-E to salt flux (no SL effect)
181  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
182  C     implicitFreeSurface :: Set to true to use implcit free surface  C     implicitFreeSurface :: Set to true to use implcit free surface
183  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
# Line 185  C     tr1Stepping   :: Turns passive tra Line 190  C     tr1Stepping   :: Turns passive tra
190  C     useConstantF  :: Coriolis parameter set to f0  C     useConstantF  :: Coriolis parameter set to f0
191  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y
192  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)  C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)
193    C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)
194  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
195  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
196    C     multiDimAdvection :: Flag that enable multi-dimension advection
197    C     forcing_In_AB :: if False, put forcing (Temp,Salt,Tracers) contribution
198    C                      out off Adams-Bashforth time stepping.
199  C     doThetaClimRelax :: Set true if relaxation to temperature  C     doThetaClimRelax :: Set true if relaxation to temperature
200  C                        climatology is required.  C                        climatology is required.
201  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
# Line 196  C     usingPCoords     :: Set to indicat Line 205  C     usingPCoords     :: Set to indicat
205  C                        coords.  C                        coords.
206  C     usingZCoords     :: Set to indicate that we are working in height  C     usingZCoords     :: Set to indicate that we are working in height
207  C                        coords.  C                        coords.
208    C     setCenterDr    :: set cell Center depth and put Interface at the middle
209  C     nonHydrostatic :: Using non-hydrostatic terms  C     nonHydrostatic :: Using non-hydrostatic terms
210  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files
211  C     allowFreezing  :: Allows water to freeze and form ice  C     allowFreezing  :: Allows water to freeze and form ice
212  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)  C     groundAtK1  :: put the surface(k=1) at the Lower Boundary (=ground)
 C     useJamartWetPoints :: Use wet-point method for Coriolis (Jamart and Ozer, 1986)  
213        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,        COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid,
214       & usingCurvilinearGrid,       & usingCurvilinearGrid,
215       & no_slip_sides,no_slip_bottom,       & no_slip_sides,no_slip_bottom,
# Line 209  C     useJamartWetPoints :: Use wet-poin Line 218  C     useJamartWetPoints :: Use wet-poin
218       & momPressureForcing, vectorInvariantMomentum,       & momPressureForcing, vectorInvariantMomentum,
219       & tempDiffusion, tempAdvection, tempForcing,       & tempDiffusion, tempAdvection, tempForcing,
220       & saltDiffusion, saltAdvection, saltForcing,       & saltDiffusion, saltAdvection, saltForcing,
221         & useRealFreshWaterFlux,
222       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,       & rigidLid, implicitFreeSurface, exactConserv, uniformLin_PhiSurf,
223       & momStepping, tempStepping, saltStepping, tr1Stepping,       & momStepping, tempStepping, saltStepping, tr1Stepping,
224       & metricTerms, usingSphericalPolarMTerms,       & metricTerms, usingSphericalPolarMTerms,
225       & useConstantF, useBetaPlaneF, useSphereF,       & useConstantF, useBetaPlaneF, useSphereF,
226         & useEnergyConservingCoriolis, useJamartWetPoints,
227       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
228         & multiDimAdvection, forcing_In_AB,
229       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,       & doThetaClimRelax, doSaltClimRelax, doTr1ClimRelax,
230       & periodicExternalForcing, usingPCoords, usingZCoords,       & periodicExternalForcing,
231         & usingPCoords, usingZCoords, setCenterDr,
232       & nonHydrostatic, globalFiles,       & nonHydrostatic, globalFiles,
233       & allowFreezing, groundAtK1,       & allowFreezing, groundAtK1,
234       & usePickupBeforeC35, debugMode,       & usePickupBeforeC35, debugMode,
235       & readPickupWithTracer, writePickupWithTracer,       & readPickupWithTracer, writePickupWithTracer
      & multiDimAdvection, useEnergyConservingCoriolis,  
      & useJamartWetPoints  
236        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
237        LOGICAL usingSphericalPolarGrid        LOGICAL usingSphericalPolarGrid
238        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid
# Line 241  C     useJamartWetPoints :: Use wet-poin Line 252  C     useJamartWetPoints :: Use wet-poin
252        LOGICAL saltDiffusion        LOGICAL saltDiffusion
253        LOGICAL saltAdvection        LOGICAL saltAdvection
254        LOGICAL saltForcing        LOGICAL saltForcing
255          LOGICAL useRealFreshWaterFlux
256        LOGICAL rigidLid        LOGICAL rigidLid
257        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
258        LOGICAL exactConserv        LOGICAL exactConserv
# Line 253  C     useJamartWetPoints :: Use wet-poin Line 265  C     useJamartWetPoints :: Use wet-poin
265        LOGICAL useConstantF        LOGICAL useConstantF
266        LOGICAL useBetaPlaneF        LOGICAL useBetaPlaneF
267        LOGICAL useSphereF        LOGICAL useSphereF
268          LOGICAL useEnergyConservingCoriolis
269          LOGICAL useJamartWetPoints
270        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
271        LOGICAL implicitViscosity        LOGICAL implicitViscosity
272          LOGICAL multiDimAdvection
273          LOGICAL forcing_In_AB
274        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
275        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
276        LOGICAL doTr1ClimRelax        LOGICAL doTr1ClimRelax
277        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
278        LOGICAL usingPCoords        LOGICAL usingPCoords
279        LOGICAL usingZCoords        LOGICAL usingZCoords
280          LOGICAL setCenterDr
281        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
282        LOGICAL globalFiles        LOGICAL globalFiles
283        LOGICAL allowFreezing        LOGICAL allowFreezing
# Line 269  C     useJamartWetPoints :: Use wet-poin Line 286  C     useJamartWetPoints :: Use wet-poin
286        LOGICAL debugMode        LOGICAL debugMode
287        LOGICAL readPickupWithTracer        LOGICAL readPickupWithTracer
288        LOGICAL writePickupWithTracer        LOGICAL writePickupWithTracer
       LOGICAL multiDimAdvection  
       LOGICAL useEnergyConservingCoriolis  
       LOGICAL useJamartWetPoints  
289    
290  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
291  C     gg2dTargetResidual  C     gg2dTargetResidual
# Line 297  C           defaults to 0.51 but can be Line 311  C           defaults to 0.51 but can be
311  C     delP      :: Vertical grid spacing ( Pa ).  C     delP      :: Vertical grid spacing ( Pa ).
312  C     delZ      :: Vertical grid spacing ( m  ).  C     delZ      :: Vertical grid spacing ( m  ).
313  C     delR      :: Vertical grid spacing ( units of r ).  C     delR      :: Vertical grid spacing ( units of r ).
314    C     delRc     :: Vertical grid spacing between cell centers (r unit).
315  C     delX      :: Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
316  C     delY        on input flags.  C     delY        on input flags.
317  C     gravity   :: Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
# Line 354  C                    Frequency of checkp Line 369  C                    Frequency of checkp
369  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
370  C     deltaTMom    :: Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
371  C     deltaTtracer :: Timestep for tracer equations ( s )  C     deltaTtracer :: Timestep for tracer equations ( s )
372    C     deltaTfreesurf :: Timestep for free-surface equation ( s )
373  C     freesurfFac  :: Parameter to turn implicit free surface term on or off  C     freesurfFac  :: Parameter to turn implicit free surface term on or off
374  C                    freesurfac = 1. uses implicit free surface  C                    freesurfac = 1. uses implicit free surface
375  C                    freesurfac = 0. uses rigid lid  C                    freesurfac = 0. uses rigid lid
# Line 396  C     externForcingPeriod :: Is the peri Line 412  C     externForcingPeriod :: Is the peri
412  C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)  C     externForcingCycle :: Is the repeat time of the forcing (eg. 1 year)
413  C                          (note: externForcingCycle must be an integer  C                          (note: externForcingCycle must be an integer
414  C                           number times externForcingPeriod)  C                           number times externForcingPeriod)
415    C     convertFW2Salt :: salinity, used to convert Fresh-Water Flux to Salt Flux
416    C                       (use model surface (local) value if set to -1)
417    C     temp_EvPrRn :: temperature of Rain & Evap.
418    C     salt_EvPrRn :: salinity of Rain & Evap.
419    C     trac_EvPrRn :: tracer concentration in Rain & Evap.
420    C        (notes: a) tracer content of Rain/Evap only used if both
421    C                     NonLin_FrSurf & useRealFreshWater are set.
422    C                b) use model surface (local) value if set to UNSET_RL)
423  C     horiVertRatio      :: Ratio on units in vertical to units in horizontal.  C     horiVertRatio      :: Ratio on units in vertical to units in horizontal.
424  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).  C     recip_horiVertRatio  ( 1 if horiz in m and vertical in m ).
425  C                          ( g*rho if horiz in m and vertical in Pa ).  C                          ( g*rho if horiz in m and vertical in Pa ).
# Line 405  C     bottomDragLinear   :: Drag coeffic Line 429  C     bottomDragLinear   :: Drag coeffic
429  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )  C      --"-"--  Quadratic  ( linear: 1/s, quadratic: 1/m )
430        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
431       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
432       & delP, delZ, delR, delX, delY,       & delP, delZ, delR, delRc, delX, delY,
433       & deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime,       & deltaT, deltaTmom, deltaTtracer, deltaTfreesurf, deltaTClock,
434         & abeps, startTime,
435       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,
436       & fCori, fCoriG,       & fCori, fCoriG,
437       & viscAh,  viscAz,  viscA4,  viscAr, viscAstrain, viscAtension,       & viscAh,  viscAz,  viscA4,  viscAr, viscAstrain, viscAtension,
# Line 424  C      --"-"--  Quadratic  ( linear: 1/s Line 449  C      --"-"--  Quadratic  ( linear: 1/s
449       & tauSaltClimRelax, lambdaSaltClimRelax,       & tauSaltClimRelax, lambdaSaltClimRelax,
450       & tauTr1ClimRelax, lambdaTr1ClimRelax,       & tauTr1ClimRelax, lambdaTr1ClimRelax,
451       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
452         & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, trac_EvPrRn,
453       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,       & viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp,
454       & theta_S, specVol_S, horiVertRatio, recip_horiVertRatio,       & horiVertRatio, recip_horiVertRatio,
455       & ivdc_kappa, Ro_SeaLevel,       & ivdc_kappa, Ro_SeaLevel,
456       & bottomDragLinear,bottomDragQuadratic       & bottomDragLinear,bottomDragQuadratic
457    
# Line 436  C      --"-"--  Quadratic  ( linear: 1/s Line 462  C      --"-"--  Quadratic  ( linear: 1/s
462        _RL delZ(Nr)        _RL delZ(Nr)
463        _RL delP(Nr)        _RL delP(Nr)
464        _RL delR(Nr)        _RL delR(Nr)
465          _RL delRc(Nr+1)
466        _RL delX(Nx)        _RL delX(Nx)
467        _RL delY(Ny)        _RL delY(Ny)
468        _RL deltaT        _RL deltaT
469        _RL deltaTClock        _RL deltaTClock
470        _RL deltaTmom        _RL deltaTmom
471        _RL deltaTtracer        _RL deltaTtracer
472          _RL deltaTfreesurf
473        _RL abeps        _RL abeps
474        _RL phiMin        _RL phiMin
475        _RL thetaMin        _RL thetaMin
# Line 485  C      --"-"--  Quadratic  ( linear: 1/s Line 513  C      --"-"--  Quadratic  ( linear: 1/s
513        _RL recip_rhonil        _RL recip_rhonil
514        _RL rhoConst        _RL rhoConst
515        _RL recip_rhoConst        _RL recip_rhoConst
       _RL specVol_S(Nr)  
516        _RL tRef(Nr)        _RL tRef(Nr)
       _RL theta_S(Nr)  
517        _RL sRef(Nr)        _RL sRef(Nr)
518        _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS fCori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
519        _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)        _RS fCoriG(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
# Line 516  C      --"-"--  Quadratic  ( linear: 1/s Line 542  C      --"-"--  Quadratic  ( linear: 1/s
542        _RL lambdaTr1ClimRelax        _RL lambdaTr1ClimRelax
543        _RL externForcingCycle        _RL externForcingCycle
544        _RL externForcingPeriod        _RL externForcingPeriod
545          _RL convertFW2Salt
546          _RL temp_EvPrRn
547          _RL salt_EvPrRn
548          _RL trac_EvPrRn
549        _RL horiVertRatio        _RL horiVertRatio
550        _RL recip_horiVertRatio        _RL recip_horiVertRatio
551        _RL ivdc_kappa        _RL ivdc_kappa
# Line 561  C Logical flags for selecting packages Line 591  C Logical flags for selecting packages
591        LOGICAL useSHAP_FILT        LOGICAL useSHAP_FILT
592        LOGICAL useZONAL_FILT        LOGICAL useZONAL_FILT
593        LOGICAL useFLT        LOGICAL useFLT
594          LOGICAL usePTRACERS
595        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
596       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,       &        useKPP, useGMRedi, useOBCS, useAIM, useECCO,
597       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT       &        useSHAP_FILT, useZONAL_FILT, useGrdchk, useFLT,
598         &        usePTRACERS
599    
Legend:
Removed from v.1.67  
changed lines
  Added in v.1.73
  ViewVC Help
Powered by ViewVC 1.1.22