--- MITgcm/model/inc/PARAMS.h 2008/08/21 19:35:21 1.221 +++ MITgcm/model/inc/PARAMS.h 2009/11/19 19:48:29 1.231 @@ -1,4 +1,4 @@ -C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/inc/PARAMS.h,v 1.221 2008/08/21 19:35:21 jmc Exp $ +C $Header: /home/ubuntu/mnt/e9_copy/MITgcm/model/inc/PARAMS.h,v 1.231 2009/11/19 19:48:29 jmc Exp $ C $Name: $ C @@ -46,8 +46,6 @@ C is taken from inline function. C topoFile :: File containing the topography of the surface (unit=m) C (mainly used for the atmosphere = ground height). -C shelfIceFile :: File containing the topography of the shelfice draught -C (unit=m) C hydrogThetaFile :: File containing initial hydrographic data (3-D) C for potential temperature. C hydrogSaltFile :: File containing initial hydrographic data (3-D) @@ -79,7 +77,7 @@ & tRefFile, sRefFile, rhoRefFile, & delRFile, delRcFile, & delXFile, delYFile, horizGridFile, - & bathyFile, topoFile, shelfIceFile, + & bathyFile, topoFile, & hydrogThetaFile, hydrogSaltFile, diffKrFile, & zonalWindFile, meridWindFile, thetaClimFile, & saltClimFile, @@ -102,7 +100,7 @@ CHARACTER*(MAX_LEN_FNAM) delXFile CHARACTER*(MAX_LEN_FNAM) delYFile CHARACTER*(MAX_LEN_FNAM) horizGridFile - CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile, shelfIceFile + CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile CHARACTER*(MAX_LEN_FNAM) diffKrFile CHARACTER*(MAX_LEN_FNAM) zonalWindFile @@ -145,6 +143,9 @@ C =0 Linear free surface ; >0 Non-linear C select_rStar :: option related to r* vertical coordinate C =0 (default) use r coord. ; > 0 use r* +C selectAddFluid :: option to add mass source/sink of fluid in the interior +C (3-D generalisation of oceanic real-fresh water flux) +C =0 off ; =1 add fluid ; =-1 virtual flux (no mass added) C momForcingOutAB :: =1: take momentum forcing contribution C out of (=0: in) Adams-Bashforth time stepping. C tracForcingOutAB :: =1: take tracer (Temp,Salt,pTracers) forcing contribution @@ -168,6 +169,7 @@ & writeStatePrec, & writeBinaryPrec, readBinaryPrec, & nonlinFreeSurf, select_rStar, + & selectAddFluid, & momForcingOutAB, tracForcingOutAB, & tempAdvScheme, tempVertAdvScheme, & saltAdvScheme, saltVertAdvScheme, @@ -186,6 +188,7 @@ INTEGER readBinaryPrec INTEGER nonlinFreeSurf INTEGER select_rStar + INTEGER selectAddFluid INTEGER momForcingOutAB, tracForcingOutAB INTEGER tempAdvScheme, tempVertAdvScheme INTEGER saltAdvScheme, saltVertAdvScheme @@ -259,10 +262,13 @@ C saltIsActiveTr :: Salinity is a dynamically active tracer C saltForcing :: Flag which turns external forcing of salinity on C and off. +C maskIniTemp :: apply mask to initial Pot.Temp. +C maskIniSalt :: apply mask to initial salinity +C checkIniTemp :: check for points with identically zero initial Pot.Temp. +C checkIniSalt :: check for points with identically zero initial salinity C useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux C as a real Fresh Water (=> changes the Sea Level) 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 C- Time-stepping params: C rigidLid :: Set to true to use rigid lid C implicitFreeSurface :: Set to true to use implicit free surface @@ -337,7 +343,8 @@ & momStepping, tempStepping, saltStepping, & tempAdvection, tempIsActiveTr, tempForcing, & saltAdvection, saltIsActiveTr, saltForcing, - & useRealFreshWaterFlux, useAddFluid, + & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt, + & useRealFreshWaterFlux, & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr, & uniformLin_PhiSurf, & quasiHydrostatic, nonHydrostatic, @@ -385,8 +392,11 @@ LOGICAL saltAdvection LOGICAL saltIsActiveTr LOGICAL saltForcing + LOGICAL maskIniTemp + LOGICAL maskIniSalt + LOGICAL checkIniTemp + LOGICAL checkIniSalt LOGICAL useRealFreshWaterFlux - LOGICAL useAddFluid LOGICAL useFullLeith LOGICAL useStrainTensionVisc LOGICAL useAreaViscLength @@ -479,6 +489,7 @@ C rhoFacC :: normalized (by rhoConst) reference density at cell-Center C rhoFacF :: normalized (by rhoConst) reference density at cell-interFace C rhoConstFresh :: Constant reference density for fresh water (rain) +C rho1Ref :: reference vertical profile for density C tRef :: reference vertical profile for potential temperature C sRef :: reference vertical profile for salinity/specific humidity C phiRef :: reference potential (pressure/rho, geopotential) profile @@ -499,39 +510,40 @@ C :: from vertical r-coordinate unit to mass per unit area [kg/m2]. C :: z-coord: = rhoConst ( [m] * rho = [kg/m2] ) ; C :: p-coord: = 1/gravity ( [Pa] / g = [kg/m2] ) ; -C phiMin :: Latitude of southern most cell face. -C thetaMin :: Longitude of western most cell face (this -C is an "inert" parameter but it is included -C to make geographical references simple.) -C rSphere :: Radius of sphere for a spherical polar grid ( m ). +C xgOrigin :: Origin of the X-axis (Cartesian Grid) / Longitude of Western +C :: most cell face (Lat-Lon grid) (Note: this is an "inert" +C :: parameter but it makes geographical references simple.) +C ygOrigin :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern +C :: most face (Lat-Lon grid). +C rSphere :: Radius of sphere for a spherical polar grid ( m ). C recip_rSphere :: Reciprocal radius of sphere ( m ). -C f0 :: Reference coriolis parameter ( 1/s ) -C ( Southern edge f for beta plane ) -C beta :: df/dy ( s^-1.m^-1 ) -C omega :: Angular velocity ( rad/s ) +C f0 :: Reference coriolis parameter ( 1/s ) +C ( Southern edge f for beta plane ) +C beta :: df/dy ( s^-1.m^-1 ) +C omega :: Angular velocity ( rad/s ) C rotationPeriod :: Rotation period (s) (= 2.pi/omega) -C viscAr :: Eddy viscosity coeff. for mixing of -C momentum vertically ( units of r^2/s ) -C viscAh :: Eddy viscosity coeff. for mixing of -C momentum laterally ( m^2/s ) -C viscAhW :: Eddy viscosity coeff. for mixing of vertical -C momentum laterally, no effect for hydrostatic -C model, defaults to viscAh if unset ( m^2/s ) -C Not used if variable horiz. viscosity is used. -C viscA4 :: Biharmonic viscosity coeff. for mixing of -C momentum laterally ( m^4/s ) -C viscA4W :: Biharmonic viscosity coeff. for mixing of vertical -C momentum laterally, no effect for hydrostatic -C model, defaults to viscA4 if unset ( m^2/s ) -C Not used if variable horiz. viscosity is used. -C viscAhD :: Eddy viscosity coeff. for mixing of momentum laterally -C (act on Divergence part) ( m^2/s ) -C viscAhZ :: Eddy viscosity coeff. for mixing of momentum laterally -C (act on Vorticity part) ( m^2/s ) -C viscA4D :: Biharmonic viscosity coeff. for mixing of momentum laterally -C (act on Divergence part) ( m^4/s ) -C viscA4Z :: Biharmonic viscosity coeff. for mixing of momentum laterally -C (act on Vorticity part) ( m^4/s ) +C viscArNr :: vertical profile of Eddy viscosity coeff. +C for vertical mixing of momentum ( units of r^2/s ) +C viscAh :: Eddy viscosity coeff. for mixing of +C momentum laterally ( m^2/s ) +C viscAhW :: Eddy viscosity coeff. for mixing of vertical +C momentum laterally, no effect for hydrostatic +C model, defaults to viscAh if unset ( m^2/s ) +C Not used if variable horiz. viscosity is used. +C viscA4 :: Biharmonic viscosity coeff. for mixing of +C momentum laterally ( m^4/s ) +C viscA4W :: Biharmonic viscosity coeff. for mixing of vertical +C momentum laterally, no effect for hydrostatic +C model, defaults to viscA4 if unset ( m^2/s ) +C Not used if variable horiz. viscosity is used. +C viscAhD :: Eddy viscosity coeff. for mixing of momentum laterally +C (act on Divergence part) ( m^2/s ) +C viscAhZ :: Eddy viscosity coeff. for mixing of momentum laterally +C (act on Vorticity part) ( m^2/s ) +C viscA4D :: Biharmonic viscosity coeff. for mixing of momentum laterally +C (act on Divergence part) ( m^4/s ) +C viscA4Z :: Biharmonic viscosity coeff. for mixing of momentum laterally +C (act on Vorticity part) ( m^4/s ) C viscC2leith :: Leith non-dimensional viscosity factor (grad(vort)) C viscC2leithD :: Modified Leith non-dimensional visc. factor (grad(div)) C viscC4leith :: Leith non-dimensional viscosity factor (grad(vort)) @@ -595,13 +607,14 @@ C implicDiv2Dflow :: parameter of the Crank-Nickelson time stepping : C Implicit part of barotropic flow Divergence ( 0-1 ) C hFacMin :: Minimum fraction size of a cell (affects hFacC etc...) -C hFacMinDz :: Minimum dimesional size of a cell (affects hFacC etc..., m) -C hFacMinDp :: Minimum dimesional size of a cell (affects hFacC etc..., Pa) -C hFacMinDr :: Minimum dimesional size of a cell (affects hFacC etc..., units of r) +C hFacMinDz :: Minimum dimensional size of a cell (affects hFacC etc..., m) +C hFacMinDp :: Minimum dimensional size of a cell (affects hFacC etc..., Pa) +C hFacMinDr :: Minimum dimensional size of a cell (-> hFacC etc..., r units) C hFacInf :: Threshold (inf and sup) for fraction size of surface cell -C hFacSup that control vanishing and creating levels -C tauCD :: CD scheme coupling timescale ( 1/s ) -C rCD :: CD scheme normalised coupling parameter ( 0-1 ) +C hFacSup that control vanishing and creating levels +C tauCD :: CD scheme coupling timescale ( s ) +C rCD :: CD scheme normalised coupling parameter (= 1 - deltaT/tauCD) +C epsAB_CD :: Adams-Bashforth-2 stabilizing weight used in CD scheme C baseTime :: model base time (time origin) = time @ iteration zero C startTime :: Starting time for this integration ( s ). C endTime :: Ending time for this integration ( s ). @@ -640,7 +653,9 @@ C (notes: a) tracer content of Rain/Evap only used if both C NonLin_FrSurf & useRealFreshWater are set. C b) use model surface (local) value if set to UNSET_RL) -C hMixCrit :: criteria for mixed-layer diagnostic +C hMixCriteria:: criteria for mixed-layer diagnostic +C dRhoSmall :: parameter for mixed-layer diagnostic +C hMixSmooth :: Smoothing parameter for mixed-layer diag (default=0=no smoothing) C ivdc_kappa :: implicit vertical diffusivity for convection [m^2/s] C Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as C starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel) @@ -662,7 +677,7 @@ & delR, delRc, delX, delY, & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock, & abEps, alph_AB, beta_AB, - & phiMin, thetaMin, rSphere, recip_RSphere, f0, beta, + & xgOrigin, ygOrigin, rSphere, recip_RSphere, f0, beta, & viscAh, viscAhW, viscAhMax, & viscAhGrid, viscAhGridMax, viscAhGridMin, & viscC2leith, viscC2leithD, @@ -671,18 +686,19 @@ & viscA4, viscA4W, viscA4Max, & viscA4Grid, viscA4GridMax, viscA4GridMin, & viscAhReMax, viscA4ReMax, - & viscC4leith, viscC4leithD, viscAr, + & viscC4leith, viscC4leithD, viscArNr, & diffKhT, diffK4T, diffKrNrT, & diffKhS, diffK4S, diffKrNrS, & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho, & BL79LatVary, & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo, - & delT, tauCD, rCD, freeSurfFac, implicSurfPress, implicDiv2Dflow, + & tauCD, rCD, epsAB_CD, + & freeSurfFac, implicSurfPress, implicDiv2Dflow, & hFacMin, hFacMinDz, hFacInf, hFacSup, & gravity, recip_gravity, gBaro, & rhonil, recip_rhonil, rhoConst, recip_rhoConst, & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF, - & rhoConstFresh, tRef, sRef, phiRef, dBdrRef, + & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef, & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass, & baseTime, startTime, endTime, & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq, @@ -693,7 +709,7 @@ & externForcingCycle, externForcingPeriod, & convertFW2Salt, temp_EvPrRn, salt_EvPrRn, & hFacMinDr, hFacMinDp, - & ivdc_kappa, hMixCriteria, Ro_SeaLevel, + & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth, Ro_SeaLevel, & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2, & smoothAbsFuncRange, & tCylIn, tCylOut, @@ -713,8 +729,8 @@ _RL dTtracerLev(Nr) _RL deltaTfreesurf _RL abEps, alph_AB, beta_AB - _RL phiMin - _RL thetaMin + _RL xgOrigin + _RL ygOrigin _RL rSphere _RL recip_rSphere _RL f0 @@ -728,7 +744,7 @@ _RL hFacInf _RL hFacSup _RL beta - _RL viscAr + _RL viscArNr(Nr) _RL viscAh _RL viscAhW _RL viscAhD @@ -764,9 +780,7 @@ _RL diffKrBLEQdeep _RL diffKrBLEQscl _RL diffKrBLEQHo - _RL delt - _RL tauCD - _RL rCD + _RL tauCD, rCD, epsAB_CD _RL gravity _RL recip_gravity _RL gBaro @@ -775,6 +789,7 @@ _RL rhoFacC(Nr), recip_rhoFacC(Nr) _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1) _RL rhoConstFresh + _RL rho1Ref(Nr) _RL tRef(Nr) _RL sRef(Nr) _RL phiRef(2*Nr+1) @@ -813,6 +828,8 @@ _RL salt_EvPrRn _RL ivdc_kappa _RL hMixCriteria + _RL dRhoSmall + _RL hMixSmooth _RL Ro_SeaLevel _RL sideDragFactor _RL bottomDragLinear @@ -866,6 +883,7 @@ LOGICAL useEBM LOGICAL useCheapAML LOGICAL useGrdchk + LOGICAL useSMOOTH LOGICAL useECCO LOGICAL useSBO LOGICAL useFLT @@ -885,6 +903,7 @@ LOGICAL useGridAlt LOGICAL useDiagnostics LOGICAL useREGRID + LOGICAL useLayers LOGICAL useMNC LOGICAL useRunClock LOGICAL useEMBED_FILES @@ -894,11 +913,11 @@ & useOPPS, usePP81, useMY82, useGGL90, useKPP, & useGMRedi, useDOWN_SLOPE, & useCAL, useEXF, useBulkForce, useEBM, useCheapAML, - & useGrdchk, useECCO, useSBO, useFLT, + & useGrdchk, useSMOOTH, useECCO, useSBO, useFLT, & usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX, & useSEAICE, useSALT_PLUME, useShelfIce, useThSIce, & useATM2D, useAIM, useLand, useFizhi, useGridAlt, - & useDiagnostics, useREGRID, useMNC, + & useDiagnostics, useREGRID, useLayers, useMNC, & useRunClock, useEMBED_FILES, & useMYPACKAGE CEH3 ;;; Local Variables: ***