www.mooseframework.org
Classes | Functions
PorousFlowSink.h File Reference

Go to the source code of this file.

Classes

class  PorousFlowSink
 Applies a flux sink to a boundary. More...
 

Functions

template<>
InputParameters validParams< PorousFlowSink > ()
 

Function Documentation

template<>
InputParameters validParams< PorousFlowSink > ( )

Definition at line 20 of file PorousFlowSink.C.

Referenced by validParams< PorousFlowSinkPTDefiner >().

21 {
22  InputParameters params = validParams<IntegratedBC>();
23  params.addRequiredParam<UserObjectName>(
24  "PorousFlowDictator", "The UserObject that holds the list of PorousFlow variable names");
25  params.addParam<unsigned int>("fluid_phase",
26  "If supplied, then this BC will potentially be a function of fluid "
27  "pressure, and you can use mass_fraction_component, use_mobility, "
28  "use_relperm, use_enthalpy and use_energy. If not supplied, then "
29  "this BC can only be a function of temperature");
30  params.addParam<unsigned int>("mass_fraction_component",
31  "The index corresponding to a fluid "
32  "component. If supplied, the flux will "
33  "be multiplied by the nodal mass "
34  "fraction for the component");
35  params.addParam<bool>("use_mobility",
36  false,
37  "If true, then fluxes are multiplied by "
38  "(density*permeability_nn/viscosity), where the "
39  "'_nn' indicates the component normal to the "
40  "boundary. In this case bare_flux is measured in "
41  "Pa.m^-1. This can be used in conjunction with "
42  "other use_*");
43  params.addParam<bool>("use_relperm",
44  false,
45  "If true, then fluxes are multiplied by relative "
46  "permeability. This can be used in conjunction with "
47  "other use_*");
48  params.addParam<bool>("use_enthalpy",
49  false,
50  "If true, then fluxes are multiplied by enthalpy. "
51  "In this case bare_flux is measured in kg.m^-2.s^-1 "
52  "/ (J.kg). This can be used in conjunction with "
53  "other use_*");
54  params.addParam<bool>("use_internal_energy",
55  false,
56  "If true, then fluxes are multiplied by fluid internal energy. "
57  " In this case bare_flux is measured in kg.m^-2.s^-1 / (J.kg). "
58  " This can be used in conjunction with other use_*");
59  params.addParam<bool>("use_thermal_conductivity",
60  false,
61  "If true, then fluxes are multiplied by "
62  "thermal conductivity projected onto "
63  "the normal direction. This can be "
64  "used in conjunction with other use_*");
65  params.addParam<FunctionName>(
66  "flux_function",
67  1.0,
68  "The flux. The flux is OUT of the medium: hence positive values of "
69  "this function means this BC will act as a SINK, while negative values "
70  "indicate this flux will be a SOURCE. The functional form is useful "
71  "for spatially or temporally varying sinks. Without any use_*, this "
72  "function is measured in kg.m^-2.s^-1 (or J.m^-2.s^-1 for the case "
73  "with only heat and no fluids)");
74  params.addClassDescription("Applies a flux sink to a boundary.");
75  return params;
76 }