Approximates a polyline by a sequence of Dirac Points the mass flux from each Dirac Point is _sink_func as a function of porepressure at the Dirac Point. More...

#include <RichardsPolyLineSink.h>

Inheritance diagram for RichardsPolyLineSink:

[legend]

Public Member Functions
	RichardsPolyLineSink (const InputParameters &parameters)

virtual void	addPoints ()

virtual Real	computeQpResidual ()

virtual Real	computeQpJacobian ()

virtual Real	computeQpOffDiagJacobian (unsigned int jvar)
	Computes the off-diagonal part of the jacobian Note: at March2014 this is never called since moose does not have this functionality. More...

Protected Member Functions
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
RichardsSumQuantity &	_total_outflow_mass
	This is used to hold the total fluid flowing into the sink Hence, it is positive for sinks where fluid is flowing from porespace into the borehole and removed from the model. More...

LinearInterpolation	_sink_func
	mass flux = _sink_func as a function of porepressure More...

std::string	_point_file
	contains rows of the form x y z (space separated) More...

const RichardsVarNames &	_richards_name_UO
	Defines the richards variables in the simulation. More...

unsigned int	_pvar
	The moose internal variable number of the richards variable of this Dirac Kernel. More...

const MaterialProperty< std::vector< Real > > &	_pp
	fluid porepressure (or porepressures in case of multiphase) More...

const MaterialProperty< std::vector< std::vector< Real > > > &	_dpp_dv
	d(porepressure_i)/d(variable_j) More...

std::vector< Real >	_xs
	vector of Dirac Points' x positions More...

std::vector< Real >	_ys
	vector of Dirac Points' y positions More...

std::vector< Real >	_zs
	vector of Dirac Points' z positions More...

Detailed Description

Approximates a polyline by a sequence of Dirac Points the mass flux from each Dirac Point is _sink_func as a function of porepressure at the Dirac Point.

Definition at line 28 of file RichardsPolyLineSink.h.

Constructor & Destructor Documentation

◆ RichardsPolyLineSink()

RichardsPolyLineSink::RichardsPolyLineSink ( const InputParameters & parameters )

Definition at line 49 of file RichardsPolyLineSink.C.

   : DiracKernel(parameters),
     _total_outflow_mass(
         const_cast<RichardsSumQuantity &>(getUserObject<RichardsSumQuantity>("SumQuantityUO"))),
     _sink_func(getParam<std::vector<Real>>("pressures"), getParam<std::vector<Real>>("fluxes")),
     _point_file(getParam<FileName>("point_file")),
     _richards_name_UO(getUserObject<RichardsVarNames>("richardsVarNames_UO")),
     _pvar(_richards_name_UO.richards_var_num(_var.number())),
     _pp(getMaterialProperty<std::vector<Real>>("porepressure")),
     _dpp_dv(getMaterialProperty<std::vector<std::vector<Real>>>("dporepressure_dv"))
 {
   // open file
   std::ifstream file(_point_file.c_str());
   if (!file.good())
     mooseError("Error opening file '" + _point_file + "' from RichardsPolyLineSink.");
  
   std::vector<Real> scratch;
   while (parseNextLineReals(file, scratch))
   {
     if (scratch.size() >= 1)
     {
       _xs.push_back(scratch[0]);
       if (scratch.size() >= 2)
         _ys.push_back(scratch[1]);
       else
         _ys.push_back(0.0);
  
       if (scratch.size() >= 3)
         _zs.push_back(scratch[2]);
       else
         _zs.push_back(0.0);
     }
   }
  
   file.close();
  
   // To correctly compute the Jacobian terms,
   // tell MOOSE that this DiracKernel depends on all the Richards Vars
   const std::vector<MooseVariableFEBase *> & coupled_vars = _richards_name_UO.getCoupledMooseVars();
   for (unsigned int i = 0; i < coupled_vars.size(); i++)
     addMooseVariableDependency(coupled_vars[i]);
 }

Member Function Documentation

◆ addPoints()

void RichardsPolyLineSink::addPoints ( )

virtual

Definition at line 115 of file RichardsPolyLineSink.C.

 {
   _total_outflow_mass.zero();
  
   // 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);
 }

◆ computeQpJacobian()

Real RichardsPolyLineSink::computeQpJacobian ( )

virtual

Definition at line 136 of file RichardsPolyLineSink.C.

 {
   Real test_fcn = _test[_i][_qp];
   return test_fcn * _sink_func.sampleDerivative(_pp[_qp][_pvar]) * _dpp_dv[_qp][_pvar][_pvar] *
          _phi[_j][_qp];
 }

◆ computeQpOffDiagJacobian()

Real RichardsPolyLineSink::computeQpOffDiagJacobian ( unsigned int jvar )

virtual

Computes the off-diagonal part of the jacobian Note: at March2014 this is never called since moose does not have this functionality.

Hence as of March2014 this has never been tested.

Definition at line 144 of file RichardsPolyLineSink.C.

 {
   if (_richards_name_UO.not_richards_var(jvar))
     return 0.0;
   unsigned int dvar = _richards_name_UO.richards_var_num(jvar);
   Real test_fcn = _test[_i][_qp];
   return test_fcn * _sink_func.sampleDerivative(_pp[_qp][_pvar]) * _dpp_dv[_qp][_pvar][dvar] *
          _phi[_j][_qp];
 }

◆ computeQpResidual()

Real RichardsPolyLineSink::computeQpResidual ( )

virtual

Definition at line 127 of file RichardsPolyLineSink.C.

 {
   Real test_fcn = _test[_i][_qp];
   Real flow = test_fcn * _sink_func.sample(_pp[_qp][_pvar]);
   _total_outflow_mass.add(flow * _dt);
   return flow;
 }

◆ parseNextLineReals()

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

protected

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

Parameters

ifs	the file stream
myvec	upon return will contain the space-separated flows encountered in ifs

Definition at line 93 of file RichardsPolyLineSink.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 RichardsPolyLineSink().

Member Data Documentation

◆ _dpp_dv

const MaterialProperty<std::vector<std::vector<Real> > >& RichardsPolyLineSink::_dpp_dv

protected

d(porepressure_i)/d(variable_j)

Definition at line 69 of file RichardsPolyLineSink.h.

Referenced by computeQpJacobian(), and computeQpOffDiagJacobian().

◆ _point_file

std::string RichardsPolyLineSink::_point_file

protected

contains rows of the form x y z (space separated)

Definition at line 57 of file RichardsPolyLineSink.h.

Referenced by RichardsPolyLineSink().

◆ _pp

const MaterialProperty<std::vector<Real> >& RichardsPolyLineSink::_pp

protected

fluid porepressure (or porepressures in case of multiphase)

Definition at line 66 of file RichardsPolyLineSink.h.

Referenced by computeQpJacobian(), computeQpOffDiagJacobian(), and computeQpResidual().

◆ _pvar

unsigned int RichardsPolyLineSink::_pvar

protected

The moose internal variable number of the richards variable of this Dirac Kernel.

Definition at line 63 of file RichardsPolyLineSink.h.

Referenced by computeQpJacobian(), computeQpOffDiagJacobian(), and computeQpResidual().

◆ _richards_name_UO

const RichardsVarNames& RichardsPolyLineSink::_richards_name_UO

protected

Defines the richards variables in the simulation.

Definition at line 60 of file RichardsPolyLineSink.h.

Referenced by computeQpOffDiagJacobian(), and RichardsPolyLineSink().

◆ _sink_func

LinearInterpolation RichardsPolyLineSink::_sink_func

protected

mass flux = _sink_func as a function of porepressure

Definition at line 54 of file RichardsPolyLineSink.h.

Referenced by computeQpJacobian(), computeQpOffDiagJacobian(), and computeQpResidual().

◆ _total_outflow_mass

RichardsSumQuantity& RichardsPolyLineSink::_total_outflow_mass

protected

This is used to hold the total fluid flowing into the sink Hence, it is positive for sinks where fluid is flowing from porespace into the borehole and removed from the model.

Definition at line 51 of file RichardsPolyLineSink.h.

Referenced by addPoints(), and computeQpResidual().

◆ _xs

std::vector<Real> RichardsPolyLineSink::_xs

protected

vector of Dirac Points' x positions

Definition at line 72 of file RichardsPolyLineSink.h.

Referenced by addPoints(), and RichardsPolyLineSink().

◆ _ys

std::vector<Real> RichardsPolyLineSink::_ys

protected

vector of Dirac Points' y positions

Definition at line 75 of file RichardsPolyLineSink.h.

Referenced by addPoints(), and RichardsPolyLineSink().

◆ _zs

std::vector<Real> RichardsPolyLineSink::_zs

protected

vector of Dirac Points' z positions

Definition at line 78 of file RichardsPolyLineSink.h.

Referenced by addPoints(), and RichardsPolyLineSink().

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

richards/include/dirackernels/RichardsPolyLineSink.h
richards/src/dirackernels/RichardsPolyLineSink.C

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RichardsPolyLineSink()

Member Function Documentation

◆ addPoints()

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

◆ parseNextLineReals()

Member Data Documentation

◆ _dpp_dv

◆ _point_file

◆ _pp

◆ _pvar

◆ _richards_name_UO

◆ _sink_func

◆ _total_outflow_mass

◆ _xs

◆ _ys

◆ _zs