www.mooseframework.org
Functions
RichardsBorehole.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< RichardsBorehole > ()
 

Function Documentation

template<>
InputParameters validParams< RichardsBorehole > ( )

Definition at line 13 of file RichardsBorehole.C.

14 {
15  InputParameters params = validParams<PeacemanBorehole>();
16  params.addRequiredParam<UserObjectName>(
17  "richardsVarNames_UO", "The UserObject that holds the list of Richards variable names.");
18  params.addParam<std::vector<UserObjectName>>("relperm_UO",
19  "List of names of user objects that "
20  "define relative permeability. Only "
21  "needed if fully_upwind is used");
22  params.addParam<std::vector<UserObjectName>>(
23  "seff_UO",
24  "List of name of user objects that define effective saturation as a function of "
25  "pressure list. Only needed if fully_upwind is used");
26  params.addParam<std::vector<UserObjectName>>("density_UO",
27  "List of names of user objects that "
28  "define the fluid density. Only "
29  "needed if fully_upwind is used");
30  params.addParam<bool>("fully_upwind", false, "Fully upwind the flux");
31  params.addClassDescription("Approximates a borehole in the mesh with given bottomhole pressure, "
32  "and radii using a number of point sinks whose positions are read "
33  "from a file");
34  return params;
35 }
InputParameters validParams< PeacemanBorehole >()