/[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.269 by jmc, Mon May 6 23:01:50 2013 UTC revision 1.274 by jmc, Tue May 6 15:45:21 2014 UTC
# Line 14  C     here. Notes describing the paramet Line 14  C     here. Notes describing the paramet
14    
15  CEOP  CEOP
16    
 C     Macros for special grid options  
 #include "PARAMS_MACROS.h"  
   
17  C--   Contants  C--   Contants
18  C     Useful physical values  C     Useful physical values
19        Real*8 PI        Real*8 PI
# Line 52  C     bathyFile       :: File containing Line 49  C     bathyFile       :: File containing
49  C                        is taken from inline function.  C                        is taken from inline function.
50  C     topoFile        :: File containing the topography of the surface (unit=m)  C     topoFile        :: File containing the topography of the surface (unit=m)
51  C                        (mainly used for the atmosphere = ground height).  C                        (mainly used for the atmosphere = ground height).
52    C     addWwallFile    :: File containing 2-D additional Western  cell-edge wall
53    C     addSwallFile    :: File containing 2-D additional Southern cell-edge wall
54    C                        (e.g., to add "thin-wall" where it is =1)
55  C     hydrogThetaFile :: File containing initial hydrographic data (3-D)  C     hydrogThetaFile :: File containing initial hydrographic data (3-D)
56  C                        for potential temperature.  C                        for potential temperature.
57  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)
# Line 87  C     the_run_name    :: string identify Line 87  C     the_run_name    :: string identify
87       &                tRefFile, sRefFile, rhoRefFile,       &                tRefFile, sRefFile, rhoRefFile,
88       &                delRFile, delRcFile, hybSigmFile,       &                delRFile, delRcFile, hybSigmFile,
89       &                delXFile, delYFile, horizGridFile,       &                delXFile, delYFile, horizGridFile,
90       &                bathyFile, topoFile,       &                bathyFile, topoFile, addWwallFile, addSwallFile,
91       &                viscAhDfile, viscAhZfile,       &                viscAhDfile, viscAhZfile,
92       &                viscA4Dfile, viscA4Zfile,       &                viscA4Dfile, viscA4Zfile,
93       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
# Line 115  C     the_run_name    :: string identify Line 115  C     the_run_name    :: string identify
115        CHARACTER*(MAX_LEN_FNAM) delYFile        CHARACTER*(MAX_LEN_FNAM) delYFile
116        CHARACTER*(MAX_LEN_FNAM) horizGridFile        CHARACTER*(MAX_LEN_FNAM) horizGridFile
117        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
118          CHARACTER*(MAX_LEN_FNAM) addWwallFile, addSwallFile
119        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile
120        CHARACTER*(MAX_LEN_FNAM) diffKrFile        CHARACTER*(MAX_LEN_FNAM) diffKrFile
121        CHARACTER*(MAX_LEN_FNAM) viscAhDfile        CHARACTER*(MAX_LEN_FNAM) viscAhDfile
# Line 262  C     setCenterDr    :: set cell-Center Line 263  C     setCenterDr    :: set cell-Center
263  C- Momentum params:  C- Momentum params:
264  C     no_slip_sides  :: Impose "no-slip" at lateral boundaries.  C     no_slip_sides  :: Impose "no-slip" at lateral boundaries.
265  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.  C     no_slip_bottom :: Impose "no-slip" at bottom boundary.
266    C     useSmag3D      :: Use isotropic 3-D Smagorinsky
267  C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable  C     useFullLeith   :: Set to true to use full Leith viscosity(may be unstable
268  C                       on irregular grids)  C                       on irregular grids)
269  C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms  C     useStrainTensionVisc:: Set to true to use Strain-Tension viscous terms
# Line 348  C                        climatology is Line 350  C                        climatology is
350  C     balanceThetaClimRelax :: substract global mean effect at every time step  C     balanceThetaClimRelax :: substract global mean effect at every time step
351  C     balanceSaltClimRelax :: substract global mean effect at every time step  C     balanceSaltClimRelax :: substract global mean effect at every time step
352  C     allowFreezing  :: Allows surface water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
 C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  
353  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
354  C- I/O parameters -  C- I/O parameters -
355  C     globalFiles    :: Selects between "global" and "tiled" files.  C     globalFiles    :: Selects between "global" and "tiled" files.
# Line 376  C     printDomain     :: controls printi Line 377  C     printDomain     :: controls printi
377       & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,       & usingCartesianGrid, usingSphericalPolarGrid, rotateGrid,
378       & usingCylindricalGrid, usingCurvilinearGrid, hasWetCSCorners,       & usingCylindricalGrid, usingCurvilinearGrid, hasWetCSCorners,
379       & deepAtmosphere, setInterFDr, setCenterDr,       & deepAtmosphere, setInterFDr, setCenterDr,
380       & no_slip_sides, no_slip_bottom,       & no_slip_sides, no_slip_bottom, useSmag3D,
381       & useFullLeith, useStrainTensionVisc, useAreaViscLength,       & useFullLeith, useStrainTensionVisc, useAreaViscLength,
382       & momViscosity, momAdvection, momForcing,       & momViscosity, momAdvection, momForcing,
383       & momPressureForcing, metricTerms, useNHMTerms,       & momPressureForcing, metricTerms, useNHMTerms,
# Line 403  C     printDomain     :: controls printi Line 404  C     printDomain     :: controls printi
404       & balanceEmPmR, balanceQnet, balancePrintMean,       & balanceEmPmR, balanceQnet, balancePrintMean,
405       & balanceThetaClimRelax, balanceSaltClimRelax,       & balanceThetaClimRelax, balanceSaltClimRelax,
406       & doThetaClimRelax, doSaltClimRelax,       & doThetaClimRelax, doSaltClimRelax,
407       & allowFreezing, useOldFreezing,       & allowFreezing,
408       & periodicExternalForcing,       & periodicExternalForcing,
409       & globalFiles,       & globalFiles,
410       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
# Line 428  C     printDomain     :: controls printi Line 429  C     printDomain     :: controls printi
429    
430        LOGICAL no_slip_sides        LOGICAL no_slip_sides
431        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
432          LOGICAL useSmag3D
433        LOGICAL useFullLeith        LOGICAL useFullLeith
434        LOGICAL useStrainTensionVisc        LOGICAL useStrainTensionVisc
435        LOGICAL useAreaViscLength        LOGICAL useAreaViscLength
# Line 497  C     printDomain     :: controls printi Line 499  C     printDomain     :: controls printi
499        LOGICAL balanceThetaClimRelax        LOGICAL balanceThetaClimRelax
500        LOGICAL balanceSaltClimRelax        LOGICAL balanceSaltClimRelax
501        LOGICAL allowFreezing        LOGICAL allowFreezing
       LOGICAL useOldFreezing  
502        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
503        LOGICAL globalFiles        LOGICAL globalFiles
504        LOGICAL pickupStrictlyMatch        LOGICAL pickupStrictlyMatch
# Line 540  C                :: most cell face (Lat- Line 541  C                :: most cell face (Lat-
541  C                :: parameter but it makes geographical references simple.)  C                :: parameter but it makes geographical references simple.)
542  C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern  C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
543  C                :: most face (Lat-Lon grid).  C                :: most face (Lat-Lon grid).
544  C     gravity   :: Accel. due to gravity ( m/s^2 )  C     gravity    :: Accel. due to gravity ( m/s^2 )
545  C     recip_gravity and its inverse  C     recip_gravity and its inverse
546  C     gBaro     :: Accel. due to gravity used in barotropic equation ( m/s^2 )  C     gBaro      :: Accel. due to gravity used in barotropic equation ( m/s^2 )
547  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil     :: Reference density for the linear equation of state
548  C     rhoConst  :: Vertically constant reference density (Boussinesq)  C     rhoConst   :: Vertically constant reference density (Boussinesq)
549  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center  C     thetaConst :: Constant reference for potential temperature
550  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace  C     rhoFacC    :: normalized (by rhoConst) reference density at cell-Center
551    C     rhoFacF    :: normalized (by rhoConst) reference density at cell-interFace
552  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
553  C     rho1Ref   :: reference vertical profile for density  C     rho1Ref    :: reference vertical profile for density
554  C     tRef      :: reference vertical profile for potential temperature  C     tRef       :: reference vertical profile for potential temperature
555  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef       :: reference vertical profile for salinity/specific humidity
556  C     phiRef    :: reference potential (pressure/rho, geopotential) profile  C     phiRef     :: reference potential (pressure/rho, geopotential) profile
557  C     dBdrRef   :: vertical gradient of reference buoyancy  [(m/s/r)^2]:  C     dBdrRef    :: vertical gradient of reference buoyancy  [(m/s/r)^2]:
558  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]  C                :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
559  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]  C                :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
560  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
561  C                :: from r-coordinate vertical velocity to vertical velocity [m/s].  C                :: from r-coordinate vertical velocity to vertical velocity [m/s].
562  C                :: z-coord: = 1 ; p-coord: wSpeed [m/s] = rVel [Pa/s] * rVel2wUnit  C                :: z-coord: = 1 ; p-coord: wSpeed [m/s] = rVel [Pa/s] * rVel2wUnit
# Line 585  C     viscAh     :: Eddy viscosity coeff Line 587  C     viscAh     :: Eddy viscosity coeff
587  C                   momentum laterally ( m^2/s )  C                   momentum laterally ( m^2/s )
588  C     viscAhW    :: Eddy viscosity coeff. for mixing of vertical  C     viscAhW    :: Eddy viscosity coeff. for mixing of vertical
589  C                   momentum laterally, no effect for hydrostatic  C                   momentum laterally, no effect for hydrostatic
590  C                   model, defaults to viscAh if unset ( m^2/s )  C                   model, defaults to viscAhD if unset ( m^2/s )
591  C                   Not used if variable horiz. viscosity is used.  C                   Not used if variable horiz. viscosity is used.
592  C     viscA4     :: Biharmonic viscosity coeff. for mixing of  C     viscA4     :: Biharmonic viscosity coeff. for mixing of
593  C                   momentum laterally ( m^4/s )  C                   momentum laterally ( m^4/s )
594  C     viscA4W    :: Biharmonic viscosity coeff. for mixing of vertical  C     viscA4W    :: Biharmonic viscosity coeff. for mixing of vertical
595  C                   momentum laterally, no effect for hydrostatic  C                   momentum laterally, no effect for hydrostatic
596  C                   model, defaults to viscA4 if unset ( m^2/s )  C                   model, defaults to viscA4D if unset ( m^2/s )
597  C                   Not used if variable horiz. viscosity is used.  C                   Not used if variable horiz. viscosity is used.
598  C     viscAhD    :: Eddy viscosity coeff. for mixing of momentum laterally  C     viscAhD    :: Eddy viscosity coeff. for mixing of momentum laterally
599  C                   (act on Divergence part) ( m^2/s )  C                   (act on Divergence part) ( m^2/s )
# Line 601  C     viscA4D    :: Biharmonic viscosity Line 603  C     viscA4D    :: Biharmonic viscosity
603  C                   (act on Divergence part) ( m^4/s )  C                   (act on Divergence part) ( m^4/s )
604  C     viscA4Z    :: Biharmonic viscosity coeff. for mixing of momentum laterally  C     viscA4Z    :: Biharmonic viscosity coeff. for mixing of momentum laterally
605  C                   (act on Vorticity  part) ( m^4/s )  C                   (act on Vorticity  part) ( m^4/s )
606    C     smag3D_coeff :: Isotropic 3-D Smagorinsky coefficient (-)
607  C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))  C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))
608  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
609  C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))  C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))
# Line 747  C     psiEuler      :: Euler angle, rota Line 750  C     psiEuler      :: Euler angle, rota
750       & abEps, alph_AB, beta_AB,       & abEps, alph_AB, beta_AB,
751       & rSphere, recip_rSphere, radius_fromHorizGrid,       & rSphere, recip_rSphere, radius_fromHorizGrid,
752       & f0, beta, fPrime, omega, rotationPeriod,       & f0, beta, fPrime, omega, rotationPeriod,
753       & viscFacAdj, viscAh, viscAhW, viscAhMax,       & viscFacAdj, viscAh, viscAhW, smag3D_coeff,
754       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscAhMax, viscAhGrid, viscAhGridMax, viscAhGridMin,
755       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
756       & viscC2smag, viscC4smag,       & viscC2smag, viscC4smag,
757       & viscAhD, viscAhZ, viscA4D, viscA4Z,       & viscAhD, viscAhZ, viscA4D, viscA4Z,
# Line 765  C     psiEuler      :: Euler angle, rota Line 768  C     psiEuler      :: Euler angle, rota
768       & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,       & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,
769       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
770       & gravity, recip_gravity, gBaro,       & gravity, recip_gravity, gBaro,
771       & rhoNil, rhoConst, recip_rhoConst,       & rhoNil, rhoConst, recip_rhoConst, thetaConst,
772       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
773       & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,       & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,
774       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
# Line 823  C     psiEuler      :: Euler angle, rota Line 826  C     psiEuler      :: Euler angle, rota
826        _RL viscAhW        _RL viscAhW
827        _RL viscAhD        _RL viscAhD
828        _RL viscAhZ        _RL viscAhZ
829          _RL smag3D_coeff
830        _RL viscAhMax        _RL viscAhMax
831        _RL viscAhReMax        _RL viscAhReMax
832        _RL viscAhGrid, viscAhGridMax, viscAhGridMin        _RL viscAhGrid, viscAhGridMax, viscAhGridMin
# Line 862  C     psiEuler      :: Euler angle, rota Line 866  C     psiEuler      :: Euler angle, rota
866        _RL gBaro        _RL gBaro
867        _RL rhoNil        _RL rhoNil
868        _RL rhoConst,      recip_rhoConst        _RL rhoConst,      recip_rhoConst
869          _RL thetaConst
870        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
871        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
872        _RL rhoConstFresh        _RL rhoConstFresh
# Line 917  C     psiEuler      :: Euler angle, rota Line 922  C     psiEuler      :: Euler angle, rota
922        _RL phiEuler, thetaEuler, psiEuler        _RL phiEuler, thetaEuler, psiEuler
923    
924  C--   COMMON /PARM_A/ Thermodynamics constants ?  C--   COMMON /PARM_A/ Thermodynamics constants ?
925        COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp        COMMON /PARM_A/ HeatCapacity_Cp
926        _RL HeatCapacity_Cp        _RL HeatCapacity_Cp
       _RL recip_Cp  
927    
928  C--   COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)  C--   COMMON /PARM_ATM/ Atmospheric physical parameters (Ideal Gas EOS, ...)
929  C     celsius2K :: convert centigrade (Celsius) degree to Kelvin  C     celsius2K :: convert centigrade (Celsius) degree to Kelvin
Legend:
Removed from v.1.269  
changed lines
  Added in v.1.274
  ViewVC Help
Powered by ViewVC 1.1.22