PorousFlowLineGeometry.C File Reference

Go to the source code of this file.


InputParameters validParams< PorousFlowLineGeometry > ()

Function Documentation

InputParameters validParams< PorousFlowLineGeometry > ( )

Definition at line 15 of file PorousFlowLineGeometry.C.

Referenced by validParams< PorousFlowLineSink >().

16 {
17  InputParameters params = validParams<DiracKernel>();
18  params.addRequiredParam<std::string>(
19  "point_file",
20  "The file containing the coordinates of the points and their weightings that approximate the "
21  "line sink. The physical meaning of the weightings depend on the scenario, eg, they may be "
22  "borehole radii. Each line in the file must contain a space-separated weight and "
23  "coordinate, viz r x y z. For boreholes, the last point in the file is defined as the "
24  "borehole bottom, where the borehole pressure is bottom_pressure. If your file contains "
25  "just one point, you must also specify the line_length and line_direction parameters. Note "
26  "that you will get segementation faults if your points do not lie within your mesh!");
27  params.addRangeCheckedParam<Real>(
28  "line_length",
29  0.0,
30  "line_length>=0",
31  "Line length. Note this is only used if there is only one point in the point_file.");
32  params.addParam<RealVectorValue>(
33  "line_direction",
34  RealVectorValue(0.0, 0.0, 1.0),
35  "Line direction. Note this is only used if there is only one point in the point_file.");
36  params.addClassDescription("Approximates a polyline sink in the mesh using a number of Dirac "
37  "point sinks with given weightings that are read from a file");
38  return params;
39 }