Classes | Functions
PorousFlowLineSink.h File Reference

Go to the source code of this file.


class  PorousFlowLineSink
 Approximates a line sink a sequence of Dirac Points. More...


InputParameters validParams< PorousFlowLineSink > ()

Function Documentation

InputParameters validParams< PorousFlowLineSink > ( )

Definition at line 13 of file PorousFlowLineSink.C.

Referenced by validParams< PorousFlowPeacemanBorehole >(), and validParams< PorousFlowPolyLineSink >().

14 {
15  InputParameters params = validParams<PorousFlowLineGeometry>();
16  MooseEnum p_or_t_choice("pressure=0 temperature=1", "pressure");
17  params.addParam<MooseEnum>("function_of",
18  p_or_t_choice,
19  "Modifying functions will be a function of either pressure and "
20  "permeability (eg, for boreholes that pump fluids) or "
21  "temperature and thermal conductivity (eg, for boreholes that "
22  "pump pure heat with no fluid flow)");
23  params.addRequiredParam<UserObjectName>(
24  "SumQuantityUO",
25  "User Object of type=PorousFlowSumQuantity in which to place the total "
26  "outflow from the line sink for each time step.");
27  params.addRequiredParam<UserObjectName>(
28  "PorousFlowDictator", "The UserObject that holds the list of PorousFlow variable names");
29  params.addParam<unsigned int>(
30  "fluid_phase",
31  0,
32  "The fluid phase whose pressure (and potentially mobility, enthalpy, etc) "
33  "controls the flux to the line sink. For p_or_t=temperature, and without "
34  "any use_*, this parameter is irrelevant");
35  params.addParam<unsigned int>("mass_fraction_component",
36  "The index corresponding to a fluid "
37  "component. If supplied, the flux will "
38  "be multiplied by the nodal mass "
39  "fraction for the component");
40  params.addParam<bool>(
41  "use_relative_permeability", false, "Multiply the flux by the fluid relative permeability");
42  params.addParam<bool>("use_mobility", false, "Multiply the flux by the fluid mobility");
43  params.addParam<bool>("use_enthalpy", false, "Multiply the flux by the fluid enthalpy");
44  params.addParam<bool>(
45  "use_internal_energy", false, "Multiply the flux by the fluid internal energy");
46  params.addClassDescription("Approximates a line sink in the mesh by a sequence of weighted Dirac "
47  "points whose positions are read from a file");
48  return params;
49 }
InputParameters validParams< PorousFlowLineGeometry >()