RichardsSat.h File Reference

Go to the source code of this file.

Classes
class	RichardsSat
	Saturation of a phase as a function of effective saturation of that phase, and its derivatives wrt effective saturation. More...

Functions
template<>
InputParameters	validParams< RichardsSat > ()

Function Documentation

validParams< RichardsSat >()

template<>

InputParameters validParams< RichardsSat >

(

)

Definition at line 18 of file RichardsSat.C.

{
  InputParameters params = validParams<GeneralUserObject>();
  params.addRequiredRangeCheckedParam<Real>(
      "s_res",
      "s_res >= 0 & s_res < 1",
      "Residual fluid saturation for the phase.  0 <= s_res < 1.");
  params.addRequiredRangeCheckedParam<Real>(
      "sum_s_res",
      "sum_s_res < 1",
      "Sum of s_res over all phases.  s_res <= sum_s_res < 1.  It is "
      "up to you to ensure the sum is done correctly.");
  params.addClassDescription("User object yielding saturation for a phase as a function of "
                             "effective saturation of that phase");
  return params;
}