/[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.262 by gforget, Fri Jun 22 02:03:02 2012 UTC revision 1.266 by jmc, Fri Nov 9 22:29:32 2012 UTC
# Line 78  C                 m/s when using externa Line 78  C                 m/s when using externa
78  C                 to kg/m2/s by multiplying by rhoConstFresh.  C                 to kg/m2/s by multiplying by rhoConstFresh.
79  C     saltFluxFile    :: File containing surface salt flux  C     saltFluxFile    :: File containing surface salt flux
80  C     pLoadFile       :: File containing pressure loading  C     pLoadFile       :: File containing pressure loading
81    C     addMassFile     :: File containing source/sink of fluid in the interior
82  C     eddyPsiXFile    :: File containing zonal Eddy streamfunction data  C     eddyPsiXFile    :: File containing zonal Eddy streamfunction data
83  C     eddyPsiYFile    :: File containing meridional Eddy streamfunction data  C     eddyPsiYFile    :: File containing meridional Eddy streamfunction data
84  C     the_run_name    :: string identifying the name of the model "run"  C     the_run_name    :: string identifying the name of the model "run"
# Line 97  C     the_run_name    :: string identify Line 98  C     the_run_name    :: string identify
98       &                surfQfile, surfQnetFile, surfQswFile,       &                surfQfile, surfQnetFile, surfQswFile,
99       &                lambdaThetaFile, lambdaSaltFile,       &                lambdaThetaFile, lambdaSaltFile,
100       &                uVelInitFile, vVelInitFile, pSurfInitFile,       &                uVelInitFile, vVelInitFile, pSurfInitFile,
101       &                dQdTfile, ploadFile,       &                dQdTfile, pLoadFile, addMassFile,
102       &                eddyPsiXFile, eddyPsiYFile,       &                eddyPsiXFile, eddyPsiYFile,
103       &                the_run_name       &                the_run_name
104        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation        CHARACTER*(MAX_LEN_FNAM) buoyancyRelation
# Line 134  C     the_run_name    :: string identify Line 135  C     the_run_name    :: string identify
135        CHARACTER*(MAX_LEN_FNAM) vVelInitFile        CHARACTER*(MAX_LEN_FNAM) vVelInitFile
136        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile        CHARACTER*(MAX_LEN_FNAM) pSurfInitFile
137        CHARACTER*(MAX_LEN_FNAM) dQdTfile        CHARACTER*(MAX_LEN_FNAM) dQdTfile
138        CHARACTER*(MAX_LEN_FNAM) ploadFile        CHARACTER*(MAX_LEN_FNAM) pLoadFile
139          CHARACTER*(MAX_LEN_FNAM) addMassFile
140        CHARACTER*(MAX_LEN_FNAM) eddyPsiXFile        CHARACTER*(MAX_LEN_FNAM) eddyPsiXFile
141        CHARACTER*(MAX_LEN_FNAM) eddyPsiYFile        CHARACTER*(MAX_LEN_FNAM) eddyPsiYFile
142        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile        CHARACTER*(MAX_LEN_FNAM) lambdaThetaFile
# Line 241  C     usingPCoords     :: Set to indicat Line 243  C     usingPCoords     :: Set to indicat
243  C                         type coordinate (p or p*).  C                         type coordinate (p or p*).
244  C     usingZCoords     :: Set to indicate that we are working in a height  C     usingZCoords     :: Set to indicate that we are working in a height
245  C                         type coordinate (z or z*)  C                         type coordinate (z or z*)
246  C     useDynP_inEos_Zc   :: use the dynamical pressure in EOS (with Z-coord.)  C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)
247  C                           this requires specific code for restart & exchange  C                         this requires specific code for restart & exchange
248  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
249  C                           coordinate frame.  C                           coordinate frame.
250  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
251  C                                spherical polar frame.  C                                spherical polar frame.
252  C     rotateGrid      :: rotate grid coordinates to geographical coordinates  C     rotateGrid      :: rotate grid coordinates to geographical coordinates
253  C                        according to Euler angles phiEuler, thetaEuler, psiEuler  C                        according to Euler angles phiEuler, thetaEuler, psiEuler
 C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)  
254  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical  C     usingCylindricalGrid :: If TRUE grid generation will be Cylindrical
255    C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
256    C     hasWetCSCorners :: domain contains CS-type corners where dynamics is solved
257  C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)  C     deepAtmosphere :: deep model (drop the shallow-atmosphere approximation)
258  C     setInterFDr    :: set Interface depth (put cell-Center at the middle)  C     setInterFDr    :: set Interface depth (put cell-Center at the middle)
259  C     setCenterDr    :: set cell-Center depth (put Interface at the middle)  C     setCenterDr    :: set cell-Center depth (put Interface at the middle)
# Line 284  C     upwindShear        :: use 1rst ord Line 287  C     upwindShear        :: use 1rst ord
287  C     momStepping    :: Turns momentum equation time-stepping off  C     momStepping    :: Turns momentum equation time-stepping off
288  C     calc_wVelocity :: Turns of vertical velocity calculation off  C     calc_wVelocity :: Turns of vertical velocity calculation off
289  C- Temp. & Salt params:  C- Temp. & Salt params:
290  C     tempStepping   :: Turns temperature equation time-stepping off  C     tempStepping   :: Turns temperature equation time-stepping on/off
291  C     saltStepping   :: Turns salinity equation time-stepping off  C     saltStepping   :: Turns salinity equation time-stepping on/off
292    C     addFrictionHeating :: account for frictional heating
293  C     tempAdvection  :: Flag which turns advection of temperature on and off.  C     tempAdvection  :: Flag which turns advection of temperature on and off.
294  C     tempVertDiff4  :: use vertical bi-harmonic diffusion for temperature  C     tempVertDiff4  :: use vertical bi-harmonic diffusion for temperature
295  C     tempIsActiveTr :: Pot.Temp. is a dynamically active tracer  C     tempIsActiveTr :: Pot.Temp. is a dynamically active tracer
296  C     tempForcing    :: Flag which turns external forcing of temperature on  C     tempForcing    :: Flag which turns external forcing of temperature on/off
 C                       and off.  
297  C     saltAdvection  :: Flag which turns advection of salinity on and off.  C     saltAdvection  :: Flag which turns advection of salinity on and off.
298  C     saltVertDiff4  :: use vertical bi-harmonic diffusion for salinity  C     saltVertDiff4  :: use vertical bi-harmonic diffusion for salinity
299  C     saltIsActiveTr :: Salinity  is a dynamically active tracer  C     saltIsActiveTr :: Salinity  is a dynamically active tracer
300  C     saltForcing    :: Flag which turns external forcing of salinity on  C     saltForcing    :: Flag which turns external forcing of salinity on/off
 C                       and off.  
301  C     maskIniTemp    :: apply mask to initial Pot.Temp.  C     maskIniTemp    :: apply mask to initial Pot.Temp.
302  C     maskIniSalt    :: apply mask to initial salinity  C     maskIniSalt    :: apply mask to initial salinity
303  C     checkIniTemp   :: check for points with identically zero initial Pot.Temp.  C     checkIniTemp   :: check for points with identically zero initial Pot.Temp.
# Line 341  C     doThetaClimRelax :: Set true if re Line 343  C     doThetaClimRelax :: Set true if re
343  C                        climatology is required.  C                        climatology is required.
344  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
345  C                        climatology is required.  C                        climatology is required.
346    C     balanceThetaClimRelax :: substract global mean effect at every time step
347    C     balanceSaltClimRelax :: substract global mean effect at every time step
348  C     allowFreezing  :: Allows surface water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
349  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
350  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
# Line 368  C     printDomain     :: controls printi Line 372  C     printDomain     :: controls printi
372       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
373       & usingPCoords, usingZCoords, useDynP_inEos_Zc,       & usingPCoords, usingZCoords, useDynP_inEos_Zc,
374       & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,       & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,
375       & usingCurvilinearGrid, usingCylindricalGrid,       & usingCylindricalGrid, usingCurvilinearGrid, hasWetCSCorners,
376       & deepAtmosphere, setInterFDr, setCenterDr,       & deepAtmosphere, setInterFDr, setCenterDr,
377       & no_slip_sides, no_slip_bottom,       & no_slip_sides, no_slip_bottom,
378       & useFullLeith, useStrainTensionVisc, useAreaViscLength,       & useFullLeith, useStrainTensionVisc, useAreaViscLength,
# Line 380  C     printDomain     :: controls printi Line 384  C     printDomain     :: controls printi
384       & upwindVorticity, highOrderVorticity,       & upwindVorticity, highOrderVorticity,
385       & useAbsVorticity, upwindShear,       & useAbsVorticity, upwindShear,
386       & momStepping, calc_wVelocity, tempStepping, saltStepping,       & momStepping, calc_wVelocity, tempStepping, saltStepping,
387         & addFrictionHeating,
388       & tempAdvection, tempVertDiff4, tempIsActiveTr, tempForcing,       & tempAdvection, tempVertDiff4, tempIsActiveTr, tempForcing,
389       & saltAdvection, saltVertDiff4, saltIsActiveTr, saltForcing,       & saltAdvection, saltVertDiff4, saltIsActiveTr, saltForcing,
390       & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,       & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
# Line 394  C     printDomain     :: controls printi Line 399  C     printDomain     :: controls printi
399       & multiDimAdvection, useMultiDimAdvec,       & multiDimAdvection, useMultiDimAdvec,
400       & momDissip_In_AB, doAB_onGtGs,       & momDissip_In_AB, doAB_onGtGs,
401       & balanceEmPmR, balanceQnet, balancePrintMean,       & balanceEmPmR, balanceQnet, balancePrintMean,
402         & balanceThetaClimRelax, balanceSaltClimRelax,
403       & doThetaClimRelax, doSaltClimRelax,       & doThetaClimRelax, doSaltClimRelax,
404       & allowFreezing, useOldFreezing,       & allowFreezing, useOldFreezing,
405       & periodicExternalForcing,       & periodicExternalForcing,
# Line 403  C     printDomain     :: controls printi Line 409  C     printDomain     :: controls printi
409       & writePickupAtEnd,       & writePickupAtEnd,
410       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
411       & outputTypesInclusive, dumpInitAndLast,       & outputTypesInclusive, dumpInitAndLast,
412       & printDomain,       & printDomain
      & inAdMode, inAdTrue, inAdFalse, inAdExact  
413    
414        LOGICAL fluidIsAir        LOGICAL fluidIsAir
415        LOGICAL fluidIsWater        LOGICAL fluidIsWater
# Line 414  C     printDomain     :: controls printi Line 419  C     printDomain     :: controls printi
419        LOGICAL usingCartesianGrid        LOGICAL usingCartesianGrid
420        LOGICAL usingSphericalPolarGrid, rotateGrid        LOGICAL usingSphericalPolarGrid, rotateGrid
421        LOGICAL usingCylindricalGrid        LOGICAL usingCylindricalGrid
422        LOGICAL usingCurvilinearGrid        LOGICAL usingCurvilinearGrid, hasWetCSCorners
423        LOGICAL deepAtmosphere        LOGICAL deepAtmosphere
424        LOGICAL setInterFDr        LOGICAL setInterFDr
425        LOGICAL setCenterDr        LOGICAL setCenterDr
426        LOGICAL useNHMTerms  
427        LOGICAL no_slip_sides        LOGICAL no_slip_sides
428        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
429        LOGICAL useFullLeith        LOGICAL useFullLeith
# Line 428  C     printDomain     :: controls printi Line 433  C     printDomain     :: controls printi
433        LOGICAL momAdvection        LOGICAL momAdvection
434        LOGICAL momForcing        LOGICAL momForcing
435        LOGICAL momPressureForcing        LOGICAL momPressureForcing
436          LOGICAL metricTerms
437          LOGICAL useNHMTerms
438    
439        LOGICAL useCoriolis        LOGICAL useCoriolis
440          LOGICAL use3dCoriolis
441          LOGICAL useCDscheme
442        LOGICAL vectorInvariantMomentum        LOGICAL vectorInvariantMomentum
443          LOGICAL useEnergyConservingCoriolis
444          LOGICAL useJamartWetPoints
445          LOGICAL useJamartMomAdv
446          LOGICAL upwindVorticity
447          LOGICAL highOrderVorticity
448          LOGICAL useAbsVorticity
449          LOGICAL upwindShear
450          LOGICAL momStepping
451          LOGICAL calc_wVelocity
452          LOGICAL tempStepping
453          LOGICAL saltStepping
454          LOGICAL addFrictionHeating
455        LOGICAL tempAdvection        LOGICAL tempAdvection
456        LOGICAL tempVertDiff4        LOGICAL tempVertDiff4
457        LOGICAL tempIsActiveTr        LOGICAL tempIsActiveTr
# Line 456  C     printDomain     :: controls printi Line 478  C     printDomain     :: controls printi
478        LOGICAL implicitIntGravWave        LOGICAL implicitIntGravWave
479        LOGICAL staggerTimeStep        LOGICAL staggerTimeStep
480        LOGICAL doResetHFactors        LOGICAL doResetHFactors
       LOGICAL momStepping  
       LOGICAL calc_wVelocity  
       LOGICAL tempStepping  
       LOGICAL saltStepping  
       LOGICAL metricTerms  
       LOGICAL use3dCoriolis  
       LOGICAL useCDscheme  
       LOGICAL useEnergyConservingCoriolis  
       LOGICAL useJamartWetPoints  
       LOGICAL useJamartMomAdv  
       LOGICAL upwindVorticity  
       LOGICAL highOrderVorticity  
       LOGICAL useAbsVorticity  
       LOGICAL upwindShear  
481        LOGICAL implicitDiffusion        LOGICAL implicitDiffusion
482        LOGICAL implicitViscosity        LOGICAL implicitViscosity
483        LOGICAL tempImplVertAdv        LOGICAL tempImplVertAdv
# Line 484  C     printDomain     :: controls printi Line 492  C     printDomain     :: controls printi
492        LOGICAL balancePrintMean        LOGICAL balancePrintMean
493        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
494        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
495          LOGICAL balanceThetaClimRelax
496          LOGICAL balanceSaltClimRelax
497        LOGICAL allowFreezing        LOGICAL allowFreezing
498        LOGICAL useOldFreezing        LOGICAL useOldFreezing
499        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
# Line 497  C     printDomain     :: controls printi Line 507  C     printDomain     :: controls printi
507        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
508        LOGICAL dumpInitAndLast        LOGICAL dumpInitAndLast
509        LOGICAL printDomain        LOGICAL printDomain
       LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact  
510    
511  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
512  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 645  C                    Frequency of checkp Line 654  C                    Frequency of checkp
654  C                    are referenced to this clock. ( s )  C                    are referenced to this clock. ( s )
655  C     deltaTMom    :: Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
656  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k
657  C     deltaTfreesurf :: Timestep for free-surface equation ( s )  C     deltaTFreeSurf :: Timestep for free-surface equation ( s )
658  C     freeSurfFac  :: Parameter to turn implicit free surface term on or off  C     freeSurfFac  :: Parameter to turn implicit free surface term on or off
659  C                     freeSurFac = 1. uses implicit free surface  C                     freeSurFac = 1. uses implicit free surface
660  C                     freeSurFac = 0. uses rigid lid  C                     freeSurFac = 0. uses rigid lid
# Line 724  C                           is to be rep Line 733  C                           is to be rep
733  C                           (affects myabs, mymin, mymax)  C                           (affects myabs, mymin, mymax)
734  C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales  C     nh_Am2        :: scales the non-hydrostatic terms and changes internal scales
735  C                      (i.e. allows convection at different Rayleigh numbers)  C                      (i.e. allows convection at different Rayleigh numbers)
736    C     tCylIn        :: Temperature of the cylinder inner boundary
737    C     tCylOut       :: Temperature of the cylinder outer boundary
738  C     phiEuler      :: Euler angle, rotation about original z-axis  C     phiEuler      :: Euler angle, rotation about original z-axis
739  C     thetaEuler    :: Euler angle, rotation about new x-axis  C     thetaEuler    :: Euler angle, rotation about new x-axis
740  C     psiEuler      :: Euler angle, rotation about new z-axis  C     psiEuler      :: Euler angle, rotation about new z-axis
741        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
742       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
743       & delR, delRc, xgOrigin, ygOrigin,       & delR, delRc, xgOrigin, ygOrigin,
744       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTMom, dTtracerLev, deltaTFreeSurf, deltaTClock,
745       & abEps, alph_AB, beta_AB,       & abEps, alph_AB, beta_AB,
746       & rSphere, recip_rSphere, radius_fromHorizGrid,       & rSphere, recip_rSphere, radius_fromHorizGrid,
747       & f0, beta, fPrime, omega, rotationPeriod,       & f0, beta, fPrime, omega, rotationPeriod,
# Line 782  C     psiEuler      :: Euler angle, rota Line 793  C     psiEuler      :: Euler angle, rota
793        _RL ygOrigin        _RL ygOrigin
794        _RL deltaT        _RL deltaT
795        _RL deltaTClock        _RL deltaTClock
796        _RL deltaTmom        _RL deltaTMom
797        _RL dTtracerLev(Nr)        _RL dTtracerLev(Nr)
798        _RL deltaTfreesurf        _RL deltaTFreeSurf
799        _RL abEps, alph_AB, beta_AB        _RL abEps, alph_AB, beta_AB
800        _RL rSphere        _RL rSphere
801        _RL recip_rSphere        _RL recip_rSphere
# Line 900  C     psiEuler      :: Euler angle, rota Line 911  C     psiEuler      :: Euler angle, rota
911        _RL bottomDragQuadratic        _RL bottomDragQuadratic
912        _RL smoothAbsFuncRange        _RL smoothAbsFuncRange
913        _RL nh_Am2        _RL nh_Am2
914        _RL tCylIn        _RL tCylIn, tCylOut
       _RL tCylOut  
915        _RL phiEuler, thetaEuler, psiEuler        _RL phiEuler, thetaEuler, psiEuler
916    
917  C--   COMMON /PARM_A/ Thermodynamics constants ?  C--   COMMON /PARM_A/ Thermodynamics constants ?
# Line 991  C Logical flags for selecting packages Line 1001  C Logical flags for selecting packages
1001       &        useRunClock, useEMBED_FILES,       &        useRunClock, useEMBED_FILES,
1002       &        useMYPACKAGE       &        useMYPACKAGE
1003    
 C     Logical flags for turning off parts of the code in adjoint mode  
       LOGICAL useKPPinAdMode, useKPPinFwdMode  
       LOGICAL useGMrediInAdMode, useGMrediInFwdMode  
       LOGICAL useSEAICEinAdMode, useSEAICEinFwdMode  
       COMMON /PARM_PACKAGES_ADJ/  
      &       useKPPinAdMode, useKPPinFwdMode,  
      &       useGMrediInAdMode, useGMrediInFwdMode,  
      &       useSEAICEinAdMode, useSEAICEinFwdMode  
   
1004  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
1005  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
1006  CEH3 ;;; End: ***  CEH3 ;;; End: ***
Legend:
Removed from v.1.262  
changed lines
  Added in v.1.266
  ViewVC Help
Powered by ViewVC 1.1.22