PorousFlowPolyLineSink.C File Reference

Go to the source code of this file.


InputParameters validParams< PorousFlowPolyLineSink > ()

Function Documentation

InputParameters validParams< PorousFlowPolyLineSink > ( )

Definition at line 12 of file PorousFlowPolyLineSink.C.

13 {
14  InputParameters params = validParams<PorousFlowLineSink>();
15  params.addRequiredParam<std::vector<Real>>(
16  "p_or_t_vals",
17  "Tuple of pressure (or temperature) values. Must be monotonically increasing.");
18  params.addRequiredParam<std::vector<Real>>(
19  "fluxes",
20  "Tuple of flux values (measured in kg.m^-1.s^-1 if no 'use_*' are employed). "
21  "These flux values are multiplied by the line-segment length to achieve a flux in "
22  "kg.s^-1. A piecewise-linear fit is performed to the (p_or_t_vals,flux) pairs to "
23  "obtain the flux at any arbitrary pressure (or temperature). If a quad-point "
24  "pressure is less than the first pressure value, the first flux value is used. If "
25  "quad-point pressure exceeds the final pressure value, the final flux value is "
26  "used. This flux is OUT of the medium: hence positive values of flux means this "
27  "will be a SINK, while negative values indicate this flux will be a SOURCE.");
28  params.addClassDescription("Approximates a polyline sink by using a number of point sinks with "
29  "given weighting whose positions are read from a file");
30  return params;
31 }
InputParameters validParams< PorousFlowLineSink >()