Q2PBorehole.C File Reference

Go to the source code of this file.


InputParameters validParams< Q2PBorehole > ()

Function Documentation

InputParameters validParams< Q2PBorehole > ( )

Definition at line 13 of file Q2PBorehole.C.

14 {
15  InputParameters params = validParams<PeacemanBorehole>();
16  params.addRequiredParam<UserObjectName>(
17  "fluid_density",
18  "A RichardsDensity UserObject that defines the fluid density as a function of pressure.");
19  params.addRequiredParam<UserObjectName>(
20  "fluid_relperm",
21  "A RichardsRelPerm UserObject (eg RichardsRelPermPower) that defines the "
22  "fluid relative permeability as a function of the saturation Variable.");
23  params.addRequiredCoupledVar("other_var",
24  "The other variable in the 2-phase system. If "
25  "Variable=porepressure, the other_var=saturation, and "
26  "vice-versa.");
27  params.addRequiredParam<bool>("var_is_porepressure",
28  "This flag is needed to correctly calculate the Jacobian entries. "
29  "If set to true, this Sink will extract fluid from the phase with "
30  "porepressure as its Variable (usually the liquid phase). If set "
31  "to false, this Sink will extract fluid from the phase with "
32  "saturation as its variable (usually the gas phase)");
33  params.addRequiredParam<Real>("fluid_viscosity", "The fluid dynamic viscosity");
34  params.addClassDescription("Approximates a borehole in the mesh with given bottomhole pressure, "
35  "and radii using a number of point sinks whose positions are read "
36  "from a file. This DiracKernel is for use by Q2P models");
37  return params;
38 }
InputParameters validParams< PeacemanBorehole >()