www.mooseframework.org
Functions
RichardsPolyLineSink.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< RichardsPolyLineSink > ()
 

Function Documentation

template<>
InputParameters validParams< RichardsPolyLineSink > ( )

Definition at line 14 of file RichardsPolyLineSink.C.

15 {
16  InputParameters params = validParams<DiracKernel>();
17  params.addRequiredParam<std::vector<Real>>(
18  "pressures", "Tuple of pressure values. Must be monotonically increasing.");
19  params.addRequiredParam<std::vector<Real>>(
20  "fluxes",
21  "Tuple of flux values (measured in kg.m^-3.s^-1). A piecewise-linear fit is "
22  "performed to the (pressure,flux) pairs to obtain the flux at any arbitrary "
23  "pressure. If a quad-point pressure is less than the first pressure value, the "
24  "first flux value is used. If quad-point pressure exceeds the final pressure "
25  "value, the final flux value is used. This flux is OUT of the medium: hence "
26  "positive values of flux means this will be a SINK, while negative values indicate "
27  "this flux will be a SOURCE.");
28  params.addRequiredParam<FileName>(
29  "point_file",
30  "The file containing the coordinates of the point sinks that will approximate "
31  "the polyline. Each line in the file must contain a space-separated "
32  "coordinate. Note that you will get segementation faults if your points do "
33  "not lie within your mesh!");
34  params.addRequiredParam<UserObjectName>(
35  "SumQuantityUO",
36  "User Object of type=RichardsSumQuantity in which to place the total "
37  "outflow from the polylinesink for each time step.");
38  params.addRequiredParam<UserObjectName>(
39  "richardsVarNames_UO", "The UserObject that holds the list of Richards variable names.");
40  params.addClassDescription("Approximates a polyline sink in the mesh by using a number of point "
41  "sinks whose positions are read from a file");
42  return params;
43 }