/[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.221 by jmc, Thu Aug 21 19:35:21 2008 UTC revision 1.227 by jmc, Tue Jan 27 15:35:27 2009 UTC
# Line 46  C     bathyFile       :: File containing Line 46  C     bathyFile       :: File containing
46  C                        is taken from inline function.  C                        is taken from inline function.
47  C     topoFile        :: File containing the topography of the surface (unit=m)  C     topoFile        :: File containing the topography of the surface (unit=m)
48  C                        (mainly used for the atmosphere = ground height).  C                        (mainly used for the atmosphere = ground height).
 C     shelfIceFile    :: File containing the topography of the shelfice draught  
 C                        (unit=m)  
49  C     hydrogThetaFile :: File containing initial hydrographic data (3-D)  C     hydrogThetaFile :: File containing initial hydrographic data (3-D)
50  C                        for potential temperature.  C                        for potential temperature.
51  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)
# Line 79  C     the_run_name    :: string identify Line 77  C     the_run_name    :: string identify
77       &                tRefFile, sRefFile, rhoRefFile,       &                tRefFile, sRefFile, rhoRefFile,
78       &                delRFile, delRcFile,       &                delRFile, delRcFile,
79       &                delXFile, delYFile, horizGridFile,       &                delXFile, delYFile, horizGridFile,
80       &                bathyFile, topoFile, shelfIceFile,       &                bathyFile, topoFile,
81       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
82       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
83       &                saltClimFile,       &                saltClimFile,
# Line 102  C     the_run_name    :: string identify Line 100  C     the_run_name    :: string identify
100        CHARACTER*(MAX_LEN_FNAM) delXFile        CHARACTER*(MAX_LEN_FNAM) delXFile
101        CHARACTER*(MAX_LEN_FNAM) delYFile        CHARACTER*(MAX_LEN_FNAM) delYFile
102        CHARACTER*(MAX_LEN_FNAM) horizGridFile        CHARACTER*(MAX_LEN_FNAM) horizGridFile
103        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile, shelfIceFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
104        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile
105        CHARACTER*(MAX_LEN_FNAM) diffKrFile        CHARACTER*(MAX_LEN_FNAM) diffKrFile
106        CHARACTER*(MAX_LEN_FNAM) zonalWindFile        CHARACTER*(MAX_LEN_FNAM) zonalWindFile
# Line 145  C     nonlinFreeSurf      :: option rela Line 143  C     nonlinFreeSurf      :: option rela
143  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
144  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
145  C                           =0 (default) use r coord. ; > 0 use r*  C                           =0 (default) use r coord. ; > 0 use r*
146    C     selectAddFluid      :: option to add mass source/sink of fluid in the interior
147    C                            (3-D generalisation of oceanic real-fresh water flux)
148    C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)
149  C     momForcingOutAB     :: =1: take momentum forcing contribution  C     momForcingOutAB     :: =1: take momentum forcing contribution
150  C                           out of (=0: in) Adams-Bashforth time stepping.  C                           out of (=0: in) Adams-Bashforth time stepping.
151  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
# Line 168  C     debugLevel          :: debug level Line 169  C     debugLevel          :: debug level
169       &        writeStatePrec,       &        writeStatePrec,
170       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
171       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
172         &        selectAddFluid,
173       &        momForcingOutAB, tracForcingOutAB,       &        momForcingOutAB, tracForcingOutAB,
174       &        tempAdvScheme, tempVertAdvScheme,       &        tempAdvScheme, tempVertAdvScheme,
175       &        saltAdvScheme, saltVertAdvScheme,       &        saltAdvScheme, saltVertAdvScheme,
# Line 186  C     debugLevel          :: debug level Line 188  C     debugLevel          :: debug level
188        INTEGER readBinaryPrec        INTEGER readBinaryPrec
189        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
190        INTEGER select_rStar        INTEGER select_rStar
191          INTEGER selectAddFluid
192        INTEGER momForcingOutAB, tracForcingOutAB        INTEGER momForcingOutAB, tracForcingOutAB
193        INTEGER tempAdvScheme, tempVertAdvScheme        INTEGER tempAdvScheme, tempVertAdvScheme
194        INTEGER saltAdvScheme, saltVertAdvScheme        INTEGER saltAdvScheme, saltVertAdvScheme
# Line 262  C                       and off. Line 265  C                       and off.
265  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
266  C                         as a real Fresh Water (=> changes the Sea Level)  C                         as a real Fresh Water (=> changes the Sea Level)
267  C                         if F, converts P+R-E to salt flux (no SL effect)  C                         if F, converts P+R-E to salt flux (no SL effect)
 C     useAddFluid    :: add mass source or sink of fluid in the interior  
268  C- Time-stepping params:  C- Time-stepping params:
269  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
270  C     implicitFreeSurface :: Set to true to use implicit free surface  C     implicitFreeSurface :: Set to true to use implicit free surface
# Line 337  C                        & Last iteratio Line 339  C                        & Last iteratio
339       & momStepping, tempStepping, saltStepping,       & momStepping, tempStepping, saltStepping,
340       & tempAdvection, tempIsActiveTr, tempForcing,       & tempAdvection, tempIsActiveTr, tempForcing,
341       & saltAdvection, saltIsActiveTr, saltForcing,       & saltAdvection, saltIsActiveTr, saltForcing,
342       & useRealFreshWaterFlux, useAddFluid,       & useRealFreshWaterFlux,
343       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,
344       & uniformLin_PhiSurf,       & uniformLin_PhiSurf,
345       & quasiHydrostatic, nonHydrostatic,       & quasiHydrostatic, nonHydrostatic,
# Line 386  C                        & Last iteratio Line 388  C                        & Last iteratio
388        LOGICAL saltIsActiveTr        LOGICAL saltIsActiveTr
389        LOGICAL saltForcing        LOGICAL saltForcing
390        LOGICAL useRealFreshWaterFlux        LOGICAL useRealFreshWaterFlux
       LOGICAL useAddFluid  
391        LOGICAL useFullLeith        LOGICAL useFullLeith
392        LOGICAL useStrainTensionVisc        LOGICAL useStrainTensionVisc
393        LOGICAL useAreaViscLength        LOGICAL useAreaViscLength
# Line 479  C     rhoConst  :: Vertically constant r Line 480  C     rhoConst  :: Vertically constant r
480  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center
481  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace
482  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
483    C     rho1Ref   :: reference vertical profile for density
484  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
485  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
486  C     phiRef    :: reference potential (pressure/rho, geopotential) profile  C     phiRef    :: reference potential (pressure/rho, geopotential) profile
# Line 499  C     rUnit2mass :: units conversion fac Line 501  C     rUnit2mass :: units conversion fac
501  C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].  C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].
502  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
503  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
504  C     phiMin    :: Latitude of southern most cell face.  C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
505  C     thetaMin  :: Longitude of western most cell face (this  C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"
506  C                 is an "inert" parameter but it is included  C                :: parameter but it makes geographical references simple.)
507  C                 to make geographical references simple.)  C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
508  C     rSphere   :: Radius of sphere for a spherical polar grid ( m ).  C                :: most face (Lat-Lon grid).
509    C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).
510  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
511  C     f0        :: Reference coriolis parameter ( 1/s )  C     f0         :: Reference coriolis parameter ( 1/s )
512  C                 ( Southern edge f for beta plane )  C                   ( Southern edge f for beta plane )
513  C     beta      :: df/dy ( s^-1.m^-1 )  C     beta       :: df/dy ( s^-1.m^-1 )
514  C     omega     :: Angular velocity ( rad/s )  C     omega      :: Angular velocity ( rad/s )
515  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
516  C     viscAr    :: Eddy viscosity coeff. for mixing of  C     viscAr     :: Eddy viscosity coeff. for mixing of
517  C                 momentum vertically ( units of r^2/s )  C                   momentum vertically ( units of r^2/s )
518  C     viscAh    :: Eddy viscosity coeff. for mixing of  C     viscAh     :: Eddy viscosity coeff. for mixing of
519  C                 momentum laterally ( m^2/s )  C                   momentum laterally ( m^2/s )
520  C     viscAhW   :: Eddy viscosity coeff. for mixing of vertical  C     viscAhW    :: Eddy viscosity coeff. for mixing of vertical
521  C                 momentum laterally, no effect for hydrostatic  C                   momentum laterally, no effect for hydrostatic
522  C                 model, defaults to viscAh if unset ( m^2/s )  C                   model, defaults to viscAh if unset ( m^2/s )
523  C                 Not used if variable horiz. viscosity is used.  C                   Not used if variable horiz. viscosity is used.
524  C     viscA4    :: Biharmonic viscosity coeff. for mixing of  C     viscA4     :: Biharmonic viscosity coeff. for mixing of
525  C                 momentum laterally ( m^4/s )  C                   momentum laterally ( m^4/s )
526  C     viscA4W   :: Biharmonic viscosity coeff. for mixing of vertical  C     viscA4W    :: Biharmonic viscosity coeff. for mixing of vertical
527  C                 momentum laterally, no effect for hydrostatic  C                   momentum laterally, no effect for hydrostatic
528  C                 model, defaults to viscA4 if unset ( m^2/s )  C                   model, defaults to viscA4 if unset ( m^2/s )
529  C                 Not used if variable horiz. viscosity is used.  C                   Not used if variable horiz. viscosity is used.
530  C     viscAhD   :: Eddy viscosity coeff. for mixing of momentum laterally  C     viscAhD    :: Eddy viscosity coeff. for mixing of momentum laterally
531  C                  (act on Divergence part) ( m^2/s )  C                   (act on Divergence part) ( m^2/s )
532  C     viscAhZ   :: Eddy viscosity coeff. for mixing of momentum laterally  C     viscAhZ    :: Eddy viscosity coeff. for mixing of momentum laterally
533  C                  (act on Vorticity  part) ( m^2/s )  C                   (act on Vorticity  part) ( m^2/s )
534  C     viscA4D   :: Biharmonic viscosity coeff. for mixing of momentum laterally  C     viscA4D    :: Biharmonic viscosity coeff. for mixing of momentum laterally
535  C                  (act on Divergence part) ( m^4/s )  C                   (act on Divergence part) ( m^4/s )
536  C     viscA4Z   :: Biharmonic viscosity coeff. for mixing of momentum laterally  C     viscA4Z    :: Biharmonic viscosity coeff. for mixing of momentum laterally
537  C                  (act on Vorticity  part) ( m^4/s )  C                   (act on Vorticity  part) ( m^4/s )
538  C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))  C     viscC2leith  :: Leith non-dimensional viscosity factor (grad(vort))
539  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))  C     viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div))
540  C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))  C     viscC4leith  :: Leith non-dimensional viscosity factor (grad(vort))
# Line 640  C     salt_EvPrRn :: salinity of Rain & Line 643  C     salt_EvPrRn :: salinity of Rain &
643  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
644  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
645  C                b) use model surface (local) value if set to UNSET_RL)  C                b) use model surface (local) value if set to UNSET_RL)
646  C     hMixCrit    :: criteria for mixed-layer diagnostic  C     hMixCriteria:: criteria for mixed-layer diagnostic
647    C     dRhoSmall   :: parameter for mixed-layer diagnostic
648    C     hMixSmooth  :: Smoothing parameter for mixed-layer diag (default=0=no smoothing)
649  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
650  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
651  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
# Line 662  C     psiEuler      :: Euler angle, rota Line 667  C     psiEuler      :: Euler angle, rota
667       & delR, delRc, delX, delY,       & delR, delRc, delX, delY,
668       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
669       & abEps, alph_AB, beta_AB,       & abEps, alph_AB, beta_AB,
670       & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta,       & xgOrigin, ygOrigin, rSphere, recip_RSphere, f0, beta,
671       & viscAh, viscAhW, viscAhMax,       & viscAh, viscAhW, viscAhMax,
672       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
673       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
# Line 682  C     psiEuler      :: Euler angle, rota Line 687  C     psiEuler      :: Euler angle, rota
687       & gravity, recip_gravity, gBaro,       & gravity, recip_gravity, gBaro,
688       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,
689       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
690       & rhoConstFresh, tRef, sRef, phiRef, dBdrRef,       & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,
691       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
692       & baseTime, startTime, endTime,       & baseTime, startTime, endTime,
693       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
# Line 693  C     psiEuler      :: Euler angle, rota Line 698  C     psiEuler      :: Euler angle, rota
698       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
699       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
700       & hFacMinDr, hFacMinDp,       & hFacMinDr, hFacMinDp,
701       & ivdc_kappa, hMixCriteria, Ro_SeaLevel,       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth, Ro_SeaLevel,
702       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
703       & smoothAbsFuncRange,       & smoothAbsFuncRange,
704       & tCylIn, tCylOut,       & tCylIn, tCylOut,
# Line 713  C     psiEuler      :: Euler angle, rota Line 718  C     psiEuler      :: Euler angle, rota
718        _RL dTtracerLev(Nr)        _RL dTtracerLev(Nr)
719        _RL deltaTfreesurf        _RL deltaTfreesurf
720        _RL abEps, alph_AB, beta_AB        _RL abEps, alph_AB, beta_AB
721        _RL phiMin        _RL xgOrigin
722        _RL thetaMin        _RL ygOrigin
723        _RL rSphere        _RL rSphere
724        _RL recip_rSphere        _RL recip_rSphere
725        _RL f0        _RL f0
# Line 775  C     psiEuler      :: Euler angle, rota Line 780  C     psiEuler      :: Euler angle, rota
780        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
781        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
782        _RL rhoConstFresh        _RL rhoConstFresh
783          _RL rho1Ref(Nr)
784        _RL tRef(Nr)        _RL tRef(Nr)
785        _RL sRef(Nr)        _RL sRef(Nr)
786        _RL phiRef(2*Nr+1)        _RL phiRef(2*Nr+1)
# Line 813  C     psiEuler      :: Euler angle, rota Line 819  C     psiEuler      :: Euler angle, rota
819        _RL salt_EvPrRn        _RL salt_EvPrRn
820        _RL ivdc_kappa        _RL ivdc_kappa
821        _RL hMixCriteria        _RL hMixCriteria
822          _RL dRhoSmall
823          _RL hMixSmooth
824        _RL Ro_SeaLevel        _RL Ro_SeaLevel
825        _RL sideDragFactor        _RL sideDragFactor
826        _RL bottomDragLinear        _RL bottomDragLinear
Legend:
Removed from v.1.221  
changed lines
  Added in v.1.227
  ViewVC Help
Powered by ViewVC 1.1.22