PorousFlowLineGeometry.h File Reference

Go to the source code of this file.

Classes
class	PorousFlowLineGeometry
	Approximates a borehole by a sequence of Dirac Points. More...

Functions
template<>
InputParameters	validParams< PorousFlowLineGeometry > ()

Function Documentation

validParams< PorousFlowLineGeometry >()

template<>

InputParameters validParams< PorousFlowLineGeometry >

(

)

Definition at line 17 of file PorousFlowLineGeometry.C.

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

Referenced by validParams< PorousFlowLineSink >().