www.mooseframework.org
Functions
RichardsSat.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< RichardsSat > ()
 

Function Documentation

template<>
InputParameters validParams< RichardsSat > ( )

Definition at line 14 of file RichardsSat.C.

15 {
16  InputParameters params = validParams<GeneralUserObject>();
17  params.addRequiredRangeCheckedParam<Real>(
18  "s_res",
19  "s_res >= 0 & s_res < 1",
20  "Residual fluid saturation for the phase. 0 <= s_res < 1.");
21  params.addRequiredRangeCheckedParam<Real>(
22  "sum_s_res",
23  "sum_s_res < 1",
24  "Sum of s_res over all phases. s_res <= sum_s_res < 1. It is "
25  "up to you to ensure the sum is done correctly.");
26  params.addClassDescription("User object yielding saturation for a phase as a function of "
27  "effective saturation of that phase");
28  return params;
29 }