RichardsRelPermMonomial.h File Reference

Go to the source code of this file.

Classes
class	RichardsRelPermMonomial
	Monomial form of relative permeability relperm = Seff^n for 0<Seff<=1, where S = (S - simm)/(1 - simm) relperm = 1 for Seff>1 relperm = 0 for Seff<0, except if n=0 then relperm = zero_to_the_zero. More...

Functions
template<>
InputParameters	validParams< RichardsRelPermMonomial > ()

Function Documentation

validParams< RichardsRelPermMonomial >()

template<>

InputParameters validParams< RichardsRelPermMonomial >

(

)

Definition at line 18 of file RichardsRelPermMonomial.C.

{
  InputParameters params = validParams<RichardsRelPerm>();
  params.addRequiredRangeCheckedParam<Real>(
      "simm",
      "simm >= 0 & simm < 1",
      "Immobile saturation.  Must be between 0 and 1.   Define s = "
      "(seff - simm)/(1 - simm).  Then relperm = s^n");
  params.addRequiredRangeCheckedParam<Real>(
      "n",
      "n >= 0",
      "Exponent.  Must be >= 0.   Define s = (seff - simm)/(1 - simm).  Then relperm = s^n");
  params.addParam<Real>(
      "zero_to_the_zero", 0.0, "If n=0, this is the value of relative permeability for s<=simm");
  params.addClassDescription("Monomial form of relative permeability.  Define s = (seff - simm)/(1 "
                             "- simm).  Then relperm = s^n if s<simm, otherwise relperm=1");
  return params;
}