PorousFlowLineGeometry Class Reference

Approximates a borehole by a sequence of Dirac Points. More...

#include <PorousFlowLineGeometry.h>

Inheritance diagram for PorousFlowLineGeometry:

Public Member Functions
	PorousFlowLineGeometry (const InputParameters &parameters)
	Creates a new PorousFlowLineGeometry This reads the file containing the lines of the form weight x y z that defines the line geometry. More...

Protected Member Functions
virtual void	addPoints () override
	Add Dirac Points to the line sink. More...
bool	parseNextLineReals (std::ifstream &ifs, std::vector< Real > &myvec)
	Reads a space-separated line of floats from ifs and puts in myvec. More...

Protected Attributes
const Real	_line_length
	Line length. This is only used if there is only one borehole point. More...
const RealVectorValue	_line_direction
	Line direction. This is only used if there is only one borehole point. More...
const std::string	_point_file
	File defining the geometry of the borehole. More...
std::vector< Real >	_rs
	Radii of the borehole. More...
std::vector< Real >	_xs
	x points of the borehole More...
std::vector< Real >	_ys
	y points of the borehole More...
std::vector< Real >	_zs
	z points of borehole More...
Point	_bottom_point
	The bottom point of the borehole (where bottom_pressure is defined) More...
std::vector< Real >	_half_seg_len
	0.5*(length of polyline segments between points) More...

Detailed Description

Approximates a borehole by a sequence of Dirac Points.

Definition at line 22 of file PorousFlowLineGeometry.h.

Constructor & Destructor Documentation

PorousFlowLineGeometry()

PorousFlowLineGeometry::PorousFlowLineGeometry

(

const InputParameters &

parameters

)

Creates a new PorousFlowLineGeometry This reads the file containing the lines of the form weight x y z that defines the line geometry.

It also calculates segment-lengths between the points

Definition at line 43 of file PorousFlowLineGeometry.C.

  : DiracKernel(parameters),
    _line_length(getParam<Real>("line_length")),
    _line_direction(getParam<RealVectorValue>("line_direction")),
    _point_file(getParam<std::string>("point_file"))
{
  statefulPropertiesAllowed(true);
 
  // open file
  std::ifstream file(_point_file.c_str());
  if (!file.good())
    mooseError("PorousFlowLineGeometry: Error opening file " + _point_file);
 
  // construct the arrays of weight, x, y and z
  std::vector<Real> scratch;
  while (parseNextLineReals(file, scratch))
  {
    if (scratch.size() >= 2)
    {
      _rs.push_back(scratch[0]);
      _xs.push_back(scratch[1]);
      if (scratch.size() >= 3)
        _ys.push_back(scratch[2]);
      else
        _ys.push_back(0.0);
      if (scratch.size() >= 4)
        _zs.push_back(scratch[3]);
      else
        _zs.push_back(0.0);
    }
  }
 
  file.close();
 
  const int num_pts = _zs.size();
  _bottom_point(0) = _xs[num_pts - 1];
  _bottom_point(1) = _ys[num_pts - 1];
  _bottom_point(2) = _zs[num_pts - 1];
 
  // construct the line-segment lengths between each point
  _half_seg_len.resize(std::max(num_pts - 1, 1));
  for (unsigned int i = 0; i + 1 < _xs.size(); ++i)
  {
    _half_seg_len[i] = 0.5 * std::sqrt(Utility::pow<2>(_xs[i + 1] - _xs[i]) +
                                       Utility::pow<2>(_ys[i + 1] - _ys[i]) +
                                       Utility::pow<2>(_zs[i + 1] - _zs[i]));
    if (_half_seg_len[i] == 0)
      mooseError("PorousFlowLineGeometry: zero-segment length detected at (x,y,z) = ",
                 _xs[i],
                 " ",
                 _ys[i],
                 " ",
                 _zs[i],
                 "\n");
  }
  if (num_pts == 1)
    _half_seg_len[0] = _line_length;
}

Member Function Documentation

addPoints()

void PorousFlowLineGeometry::addPoints ( )

overrideprotectedvirtual

Add Dirac Points to the line sink.

Reimplemented in PorousFlowLineSink.

Definition at line 125 of file PorousFlowLineGeometry.C.

{
  // Add point using the unique ID "i", let the DiracKernel take
  // care of the caching.  This should be fast after the first call,
  // as long as the points don't move around.
  for (unsigned int i = 0; i < _zs.size(); i++)
    addPoint(Point(_xs[i], _ys[i], _zs[i]), i);
}

Referenced by PorousFlowLineSink::addPoints().

parseNextLineReals()

bool PorousFlowLineGeometry::parseNextLineReals ( std::ifstream &  ifs, std::vector< Real > &  myvec  )

protected

Reads a space-separated line of floats from ifs and puts in myvec.

Definition at line 103 of file PorousFlowLineGeometry.C.

{
  std::string line;
  myvec.clear();
  bool gotline(false);
  if (getline(ifs, line))
  {
    gotline = true;
 
    // Harvest floats separated by whitespace
    std::istringstream iss(line);
    Real f;
    while (iss >> f)
    {
      myvec.push_back(f);
    }
  }
  return gotline;
}

Referenced by PorousFlowLineGeometry().

Member Data Documentation

_bottom_point

Point PorousFlowLineGeometry::_bottom_point

protected

The bottom point of the borehole (where bottom_pressure is defined)

Definition at line 61 of file PorousFlowLineGeometry.h.

Referenced by PorousFlowPeacemanBorehole::computeQpBaseOutflow(), PorousFlowPeacemanBorehole::computeQpBaseOutflowJacobian(), and PorousFlowLineGeometry().

_half_seg_len

std::vector<Real> PorousFlowLineGeometry::_half_seg_len

protected

0.5*(length of polyline segments between points)

Definition at line 64 of file PorousFlowLineGeometry.h.

Referenced by PorousFlowPolyLineSink::computeQpBaseOutflow(), PorousFlowPeacemanBorehole::computeQpBaseOutflow(), PorousFlowPolyLineSink::computeQpBaseOutflowJacobian(), PorousFlowPeacemanBorehole::computeQpBaseOutflowJacobian(), and PorousFlowLineGeometry().

_line_direction

const RealVectorValue PorousFlowLineGeometry::_line_direction

protected

Line direction. This is only used if there is only one borehole point.

Definition at line 39 of file PorousFlowLineGeometry.h.

Referenced by PorousFlowPeacemanBorehole::PorousFlowPeacemanBorehole().

_line_length

const Real PorousFlowLineGeometry::_line_length

protected

Line length. This is only used if there is only one borehole point.

Definition at line 36 of file PorousFlowLineGeometry.h.

Referenced by PorousFlowLineGeometry().

_point_file

const std::string PorousFlowLineGeometry::_point_file

protected

File defining the geometry of the borehole.

Each row has format weight x y z and the list of such points defines a polyline that is the line sink

Definition at line 46 of file PorousFlowLineGeometry.h.

Referenced by PorousFlowLineGeometry().

_rs

std::vector<Real> PorousFlowLineGeometry::_rs

protected

Radii of the borehole.

Definition at line 49 of file PorousFlowLineGeometry.h.

Referenced by PorousFlowPolyLineSink::computeQpBaseOutflow(), PorousFlowPeacemanBorehole::computeQpBaseOutflow(), PorousFlowPolyLineSink::computeQpBaseOutflowJacobian(), PorousFlowPeacemanBorehole::computeQpBaseOutflowJacobian(), and PorousFlowLineGeometry().

_xs

std::vector<Real> PorousFlowLineGeometry::_xs

protected

x points of the borehole

Definition at line 52 of file PorousFlowLineGeometry.h.

Referenced by addPoints(), PorousFlowLineGeometry(), and PorousFlowPeacemanBorehole::PorousFlowPeacemanBorehole().

_ys

std::vector<Real> PorousFlowLineGeometry::_ys

protected

y points of the borehole

Definition at line 55 of file PorousFlowLineGeometry.h.

Referenced by addPoints(), PorousFlowLineGeometry(), and PorousFlowPeacemanBorehole::PorousFlowPeacemanBorehole().

_zs

std::vector<Real> PorousFlowLineGeometry::_zs

protected

z points of borehole

Definition at line 58 of file PorousFlowLineGeometry.h.

Referenced by addPoints(), PorousFlowPolyLineSink::computeQpBaseOutflow(), PorousFlowPeacemanBorehole::computeQpBaseOutflow(), PorousFlowPolyLineSink::computeQpBaseOutflowJacobian(), PorousFlowPeacemanBorehole::computeQpBaseOutflowJacobian(), PorousFlowLineGeometry(), and PorousFlowPeacemanBorehole::PorousFlowPeacemanBorehole().

---

The documentation for this class was generated from the following files:

• porous_flow/include/dirackernels/PorousFlowLineGeometry.h
• porous_flow/src/dirackernels/PorousFlowLineGeometry.C