Approximates a line sink a sequence of Dirac Points. More...

#include <PorousFlowLineSink.h>

Inheritance diagram for PorousFlowLineSink:

Public Member Functions
	PorousFlowLineSink (const InputParameters &parameters)

Protected Types
enum	PorTchoice { PorTchoice::pressure, PorTchoice::temperature }
	whether the flux is a function of pressure or temperature More...

Protected Member Functions
virtual Real	computeQpResidual () override

virtual Real	computeQpJacobian () override

virtual Real	computeQpOffDiagJacobian (unsigned int jvar) override

virtual void	addPoints () override
	Add Dirac Points to the borehole. More...

Real	jac (unsigned int jvar)
	Jacobian contribution for the derivative wrt the variable jvar. More...

Real	ptqp () const
	If _p_or_t==0, then returns the quadpoint porepressure, else returns the quadpoint temperature. More...

Real	dptqp (unsigned pvar) const
	If _p_or_t==0, then returns d(quadpoint porepressure)/d(PorousFlow variable), else returns d(quadpoint temperature)/d(PorousFlow variable) More...

virtual Real	computeQpBaseOutflow (unsigned current_dirac_ptid) const =0
	Returns the flux from the line sink (before modification by mobility, etc). Derived classes should override this. More...

virtual void	computeQpBaseOutflowJacobian (unsigned jvar, unsigned current_dirac_ptid, Real &outflow, Real &outflowp) const =0
	Calculates the BaseOutflow as well as its derivative wrt jvar. Derived classes should override this. 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 PorousFlowDictator &	_dictator
	PorousFlowDictator UserObject. More...

PorousFlowSumQuantity &	_total_outflow_mass
	This is used to hold the total fluid flowing into the line sink for each time step. More...

const bool	_has_porepressure
	Whether a quadpoint porepressure material exists (for error checking) More...

const bool	_has_temperature
	Whether a quadpoint temperature material exists (for error checking) More...

const bool	_has_mass_fraction
	Whether a mass_fraction material exists (for error checking) More...

const bool	_has_relative_permeability
	Whether a relative permeability material exists (for error checking) More...

const bool	_has_mobility
	Whether enough materials exist to form the mobility (for error checking) More...

const bool	_has_enthalpy
	Whether an enthalpy material exists (for error checking) More...

const bool	_has_internal_energy
	Whether an internal-energy material exists (for error checking) More...

enum PorousFlowLineSink::PorTchoice	_p_or_t

const bool	_use_mass_fraction
	Whether the flux will be multiplied by the mass fraction. More...

const bool	_use_relative_permeability
	Whether the flux will be multiplied by the relative permeability. More...

const bool	_use_mobility
	Whether the flux will be multiplied by the mobility. More...

const bool	_use_enthalpy
	Whether the flux will be multiplied by the enthalpy. More...

const bool	_use_internal_energy
	Whether the flux will be multiplied by the internal-energy. More...

const unsigned int	_ph
	The phase number. More...

const unsigned int	_sp
	The component number (only used if _use_mass_fraction==true) More...

const MaterialProperty< std::vector< Real > > *const	_pp
	Quadpoint pore pressure in each phase. More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_dpp_dvar
	d(quadpoint pore pressure in each phase)/d(PorousFlow variable) More...

const MaterialProperty< Real > *const	_temperature
	Quadpoint temperature. More...

const MaterialProperty< std::vector< Real > > *const	_dtemperature_dvar
	d(quadpoint temperature)/d(PorousFlow variable) More...

const MaterialProperty< std::vector< Real > > *const	_fluid_density_node
	Fluid density for each phase (at the node) More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_dfluid_density_node_dvar
	d(Fluid density for each phase (at the node))/d(PorousFlow variable) More...

const MaterialProperty< std::vector< Real > > *const	_fluid_viscosity
	Viscosity of each component in each phase. More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_dfluid_viscosity_dvar
	d(Viscosity of each component in each phase)/d(PorousFlow variable) More...

const MaterialProperty< std::vector< Real > > *const	_relative_permeability
	Relative permeability of each phase. More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_drelative_permeability_dvar
	d(Relative permeability of each phase)/d(PorousFlow variable) More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_mass_fractions
	Mass fraction of each component in each phase. More...

const MaterialProperty< std::vector< std::vector< std::vector< Real > > > > *const	_dmass_fractions_dvar
	d(Mass fraction of each component in each phase)/d(PorousFlow variable) More...

const MaterialProperty< std::vector< Real > > *const	_enthalpy
	Enthalpy of each phase. More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_denthalpy_dvar
	d(enthalpy of each phase)/d(PorousFlow variable) More...

const MaterialProperty< std::vector< Real > > *const	_internal_energy
	Internal_Energy of each phase. More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_dinternal_energy_dvar
	d(internal_energy of each phase)/d(PorousFlow variable) More...

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 line sink a sequence of Dirac Points.

Definition at line 25 of file PorousFlowLineSink.h.

Member Enumeration Documentation

◆ PorTchoice

enum PorousFlowLineSink::PorTchoice

strongprotected

whether the flux is a function of pressure or temperature

Enumerator
pressure
temperature

Definition at line 92 of file PorousFlowLineSink.h.

92 { pressure, temperature } _p_or_t;

NS::temperature

const std::string temperature

Definition: NS.h:27

NS::pressure

const std::string pressure

Definition: NS.h:26

PorousFlowLineSink::_p_or_t

enum PorousFlowLineSink::PorTchoice _p_or_t

Constructor & Destructor Documentation

◆ PorousFlowLineSink()

PorousFlowLineSink::PorousFlowLineSink ( const InputParameters & parameters )

Definition at line 53 of file PorousFlowLineSink.C.

   : PorousFlowLineGeometry(parameters),
     _dictator(getUserObject<PorousFlowDictator>("PorousFlowDictator")),
     _total_outflow_mass(
         const_cast<PorousFlowSumQuantity &>(getUserObject<PorousFlowSumQuantity>("SumQuantityUO"))),
 
     _has_porepressure(
         hasMaterialProperty<std::vector<Real>>("PorousFlow_porepressure_qp") &&
         hasMaterialProperty<std::vector<std::vector<Real>>>("dPorousFlow_porepressure_qp_dvar")),
     _has_temperature(hasMaterialProperty<Real>("PorousFlow_temperature_qp") &&
                      hasMaterialProperty<std::vector<Real>>("dPorousFlow_temperature_qp_dvar")),
     _has_mass_fraction(
         hasMaterialProperty<std::vector<std::vector<Real>>>("PorousFlow_mass_frac_nodal") &&
         hasMaterialProperty<std::vector<std::vector<std::vector<Real>>>>(
             "dPorousFlow_mass_frac_nodal_dvar")),
     _has_relative_permeability(
         hasMaterialProperty<std::vector<Real>>("PorousFlow_relative_permeability_nodal") &&
         hasMaterialProperty<std::vector<std::vector<Real>>>(
             "dPorousFlow_relative_permeability_nodal_dvar")),
     _has_mobility(
         hasMaterialProperty<std::vector<Real>>("PorousFlow_relative_permeability_nodal") &&
         hasMaterialProperty<std::vector<std::vector<Real>>>(
             "dPorousFlow_relative_permeability_nodal_dvar") &&
         hasMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_density_nodal") &&
         hasMaterialProperty<std::vector<std::vector<Real>>>(
             "dPorousFlow_fluid_phase_density_nodal_dvar") &&
         hasMaterialProperty<std::vector<Real>>("PorousFlow_viscosity_nodal") &&
         hasMaterialProperty<std::vector<std::vector<Real>>>("dPorousFlow_viscosity_nodal_dvar")),
     _has_enthalpy(hasMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_enthalpy_nodal") &&
                   hasMaterialProperty<std::vector<std::vector<Real>>>(
                       "dPorousFlow_fluid_phase_enthalpy_nodal_dvar")),
     _has_internal_energy(
         hasMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_internal_energy_nodal") &&
         hasMaterialProperty<std::vector<std::vector<Real>>>(
             "dPorousFlow_fluid_phase_internal_energy_nodal_dvar")),
 
     _p_or_t(getParam<MooseEnum>("function_of").getEnum<PorTchoice>()),
     _use_mass_fraction(isParamValid("mass_fraction_component")),
     _use_relative_permeability(getParam<bool>("use_relative_permeability")),
     _use_mobility(getParam<bool>("use_mobility")),
     _use_enthalpy(getParam<bool>("use_enthalpy")),
     _use_internal_energy(getParam<bool>("use_internal_energy")),
 
     _ph(getParam<unsigned int>("fluid_phase")),
     _sp(_use_mass_fraction ? getParam<unsigned int>("mass_fraction_component") : 0),
 
     _pp((_p_or_t == PorTchoice::pressure && _has_porepressure)
             ? &getMaterialProperty<std::vector<Real>>("PorousFlow_porepressure_qp")
             : nullptr),
     _dpp_dvar((_p_or_t == PorTchoice::pressure && _has_porepressure)
                   ? &getMaterialProperty<std::vector<std::vector<Real>>>(
                         "dPorousFlow_porepressure_qp_dvar")
                   : nullptr),
     _temperature((_p_or_t == PorTchoice::temperature && _has_temperature)
                      ? &getMaterialProperty<Real>("PorousFlow_temperature_qp")
                      : nullptr),
     _dtemperature_dvar(
         (_p_or_t == PorTchoice::temperature && _has_temperature)
             ? &getMaterialProperty<std::vector<Real>>("dPorousFlow_temperature_qp_dvar")
             : nullptr),
     _fluid_density_node(
         (_use_mobility && _has_mobility)
             ? &getMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_density_nodal")
             : nullptr),
     _dfluid_density_node_dvar((_use_mobility && _has_mobility)
                                   ? &getMaterialProperty<std::vector<std::vector<Real>>>(
                                         "dPorousFlow_fluid_phase_density_nodal_dvar")
                                   : nullptr),
     _fluid_viscosity((_use_mobility && _has_mobility)
                          ? &getMaterialProperty<std::vector<Real>>("PorousFlow_viscosity_nodal")
                          : nullptr),
     _dfluid_viscosity_dvar((_use_mobility && _has_mobility)
                                ? &getMaterialProperty<std::vector<std::vector<Real>>>(
                                      "dPorousFlow_viscosity_nodal_dvar")
                                : nullptr),
     _relative_permeability(
         ((_use_mobility && _has_mobility) ||
          (_use_relative_permeability && _has_relative_permeability))
             ? &getMaterialProperty<std::vector<Real>>("PorousFlow_relative_permeability_nodal")
             : nullptr),
     _drelative_permeability_dvar(((_use_mobility && _has_mobility) ||
                                   (_use_relative_permeability && _has_relative_permeability))
                                      ? &getMaterialProperty<std::vector<std::vector<Real>>>(
                                            "dPorousFlow_relative_permeability_nodal_dvar")
                                      : nullptr),
     _mass_fractions(
         (_use_mass_fraction && _has_mass_fraction)
             ? &getMaterialProperty<std::vector<std::vector<Real>>>("PorousFlow_mass_frac_nodal")
             : nullptr),
     _dmass_fractions_dvar((_use_mass_fraction && _has_mass_fraction)
                               ? &getMaterialProperty<std::vector<std::vector<std::vector<Real>>>>(
                                     "dPorousFlow_mass_frac_nodal_dvar")
                               : nullptr),
     _enthalpy(_has_enthalpy ? &getMaterialPropertyByName<std::vector<Real>>(
                                   "PorousFlow_fluid_phase_enthalpy_nodal")
                             : nullptr),
     _denthalpy_dvar(_has_enthalpy ? &getMaterialPropertyByName<std::vector<std::vector<Real>>>(
                                         "dPorousFlow_fluid_phase_enthalpy_nodal_dvar")
                                   : nullptr),
     _internal_energy(_has_internal_energy ? &getMaterialPropertyByName<std::vector<Real>>(
                                                 "PorousFlow_fluid_phase_internal_energy_nodal")
                                           : nullptr),
     _dinternal_energy_dvar(_has_internal_energy
                                ? &getMaterialPropertyByName<std::vector<std::vector<Real>>>(
                                      "dPorousFlow_fluid_phase_internal_energy_nodal_dvar")
                                : nullptr)
 {
   // zero the outflow mass
   _total_outflow_mass.zero();
 
   if (_ph >= _dictator.numPhases())
     paramError("fluid_phase",
                "The Dictator proclaims that the maximum phase index in this simulation is ",
                _dictator.numPhases() - 1,
                " whereas you have used ",
                _ph,
                ". Remember that indexing starts at 0. You must try harder.");
 
   if (_use_mass_fraction && _sp >= _dictator.numComponents())
     paramError(
         "mass_fraction_component",
         "The Dictator proclaims that the maximum fluid component index in this simulation is ",
         _dictator.numComponents() - 1,
         " whereas you have used ",
         _sp,
         ". Remember that indexing starts at 0. Please be assured that the Dictator has noted your "
         "error.");
 
   if (_p_or_t == PorTchoice::pressure && !_has_porepressure)
     mooseError("PorousFlowLineSink: You have specified function_of=porepressure, but you do not "
                "have a quadpoint porepressure material");
 
   if (_p_or_t == PorTchoice::temperature && !_has_temperature)
     mooseError("PorousFlowLineSink: You have specified function_of=temperature, but you do not "
                "have a quadpoint temperature material");
 
   if (_use_mass_fraction && !_has_mass_fraction)
     mooseError("PorousFlowLineSink: You have specified a fluid component, but do not have a nodal "
                "mass-fraction material");
 
   if (_use_relative_permeability && !_has_relative_permeability)
     mooseError("PorousFlowLineSink: You have set use_relative_permeability=true, but do not have a "
                "nodal relative permeability material");
 
   if (_use_mobility && !_has_mobility)
     mooseError("PorousFlowLineSink: You have set use_mobility=true, but do not have nodal density, "
                "relative permeability or viscosity material");
 
   if (_use_enthalpy && !_has_enthalpy)
     mooseError("PorousFlowLineSink: You have set use_enthalpy=true, but do not have a nodal "
                "enthalpy material");
 
   if (_use_internal_energy && !_has_internal_energy)
     mooseError("PorousFlowLineSink: You have set use_internal_energy=true, but do not have a nodal "
                "internal-energy material");
 
   // To correctly compute the Jacobian terms,
   // tell MOOSE that this DiracKernel depends on all the PorousFlow Variables
   const std::vector<MooseVariableFEBase *> & coupled_vars = _dictator.getCoupledMooseVars();
   for (unsigned int i = 0; i < coupled_vars.size(); i++)
     addMooseVariableDependency(coupled_vars[i]);
 }

Member Function Documentation

◆ addPoints()

void PorousFlowLineSink::addPoints ( )

overrideprotectedvirtual

Add Dirac Points to the borehole.

Reimplemented from PorousFlowLineGeometry.

Definition at line 217 of file PorousFlowLineSink.C.

 {
   // This function gets called just before the DiracKernel is evaluated
   // so this is a handy place to zero this out.
   _total_outflow_mass.zero();
 
   PorousFlowLineGeometry::addPoints();
 }

◆ computeQpBaseOutflow()

virtual Real PorousFlowLineSink::computeQpBaseOutflow ( unsigned current_dirac_ptid ) const

protectedpure virtual

Returns the flux from the line sink (before modification by mobility, etc). Derived classes should override this.

Implemented in PorousFlowPeacemanBorehole, and PorousFlowPolyLineSink.

Referenced by computeQpResidual().

◆ computeQpBaseOutflowJacobian()

virtual void PorousFlowLineSink::computeQpBaseOutflowJacobian	(	unsigned	jvar,
		unsigned	current_dirac_ptid,
		Real &	outflow,
		Real &	outflowp
	)		const

protectedpure virtual

Calculates the BaseOutflow as well as its derivative wrt jvar. Derived classes should override this.

Implemented in PorousFlowPeacemanBorehole, and PorousFlowPolyLineSink.

Referenced by jac().

◆ computeQpJacobian()

Real PorousFlowLineSink::computeQpJacobian ( )

overrideprotectedvirtual

Definition at line 258 of file PorousFlowLineSink.C.

 {
   return jac(_var.number());
 }

◆ computeQpOffDiagJacobian()

Real PorousFlowLineSink::computeQpOffDiagJacobian ( unsigned int jvar )

overrideprotectedvirtual

Definition at line 264 of file PorousFlowLineSink.C.

 {
   return jac(jvar);
 }

◆ computeQpResidual()

Real PorousFlowLineSink::computeQpResidual ( )

overrideprotectedvirtual

Definition at line 227 of file PorousFlowLineSink.C.

 {
   // Get the ID we initially assigned to this point
   const unsigned current_dirac_ptid = currentPointCachedID();
   Real outflow = computeQpBaseOutflow(current_dirac_ptid);
   if (outflow == 0.0)
     return 0.0;
 
   if (_use_relative_permeability)
     outflow *= (*_relative_permeability)[_i][_ph];
 
   if (_use_mobility)
     outflow *= (*_relative_permeability)[_i][_ph] * (*_fluid_density_node)[_i][_ph] /
                (*_fluid_viscosity)[_i][_ph];
 
   if (_use_mass_fraction)
     outflow *= (*_mass_fractions)[_i][_ph][_sp];
 
   if (_use_enthalpy)
     outflow *= (*_enthalpy)[_i][_ph];
 
   if (_use_internal_energy)
     outflow *= (*_internal_energy)[_i][_ph];
 
   _total_outflow_mass.add(
       outflow * _dt); // this is not thread safe, but DiracKernel's aren't currently threaded
 
   return outflow;
 }

◆ dptqp()

Real PorousFlowLineSink::dptqp ( unsigned pvar ) const

protected

If _p_or_t==0, then returns d(quadpoint porepressure)/d(PorousFlow variable), else returns d(quadpoint temperature)/d(PorousFlow variable)

Parameters

pvar	The PorousFlow variable number

Definition at line 341 of file PorousFlowLineSink.C.

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

 {
   return (_p_or_t == PorTchoice::pressure ? (*_dpp_dvar)[_qp][_ph][pvar]
                                           : (*_dtemperature_dvar)[_qp][pvar]);
 }

◆ jac()

Real PorousFlowLineSink::jac ( unsigned int jvar )

protected

Jacobian contribution for the derivative wrt the variable jvar.

Definition at line 270 of file PorousFlowLineSink.C.

Referenced by computeQpJacobian(), and computeQpOffDiagJacobian().

 {
   if (_dictator.notPorousFlowVariable(jvar))
     return 0.0;
   const unsigned pvar = _dictator.porousFlowVariableNum(jvar);
 
   Real outflow;
   Real outflowp;
   const unsigned current_dirac_ptid = currentPointCachedID();
   computeQpBaseOutflowJacobian(jvar, current_dirac_ptid, outflow, outflowp);
   if (outflow == 0.0 && outflowp == 0.0)
     return 0.0;
 
   if (_use_relative_permeability)
   {
     const Real relperm_prime = (_i != _j ? 0.0 : (*_drelative_permeability_dvar)[_i][_ph][pvar]);
     outflowp = (*_relative_permeability)[_i][_ph] * outflowp + relperm_prime * outflow;
     outflow *= (*_relative_permeability)[_i][_ph];
   }
 
   if (_use_mobility)
   {
     const Real mob = (*_relative_permeability)[_i][_ph] * (*_fluid_density_node)[_i][_ph] /
                      (*_fluid_viscosity)[_i][_ph];
     const Real mob_prime =
         (_i != _j
              ? 0.0
              : (*_drelative_permeability_dvar)[_i][_ph][pvar] * (*_fluid_density_node)[_i][_ph] /
                        (*_fluid_viscosity)[_i][_ph] +
                    (*_relative_permeability)[_i][_ph] *
                        (*_dfluid_density_node_dvar)[_i][_ph][pvar] / (*_fluid_viscosity)[_i][_ph] -
                    (*_relative_permeability)[_i][_ph] * (*_fluid_density_node)[_i][_ph] *
                        (*_dfluid_viscosity_dvar)[_i][_ph][pvar] /
                        Utility::pow<2>((*_fluid_viscosity)[_i][_ph]));
     outflowp = mob * outflowp + mob_prime * outflow;
     outflow *= mob;
   }
 
   if (_use_mass_fraction)
   {
     const Real mass_fractions_prime =
         (_i != _j ? 0.0 : (*_dmass_fractions_dvar)[_i][_ph][_sp][pvar]);
     outflowp = (*_mass_fractions)[_i][_ph][_sp] * outflowp + mass_fractions_prime * outflow;
     outflow *= (*_mass_fractions)[_i][_ph][_sp];
   }
 
   if (_use_enthalpy)
   {
     const Real enthalpy_prime = (_i != _j ? 0.0 : (*_denthalpy_dvar)[_i][_ph][pvar]);
     outflowp = (*_enthalpy)[_i][_ph] * outflowp + enthalpy_prime * outflow;
     outflow *= (*_enthalpy)[_i][_ph];
   }
 
   if (_use_internal_energy)
   {
     const Real internal_energy_prime = (_i != _j ? 0.0 : (*_dinternal_energy_dvar)[_i][_ph][pvar]);
     outflowp = (*_internal_energy)[_i][_ph] * outflowp + internal_energy_prime * outflow;
     // this multiplication was performed, but the code does not need to know: outflow *=
     // (*_internal_energy)[_i][_ph];
   }
 
   return outflowp;
 }

◆ parseNextLineReals()

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

protectedinherited

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

Definition at line 103 of file PorousFlowLineGeometry.C.

Referenced by PorousFlowLineGeometry::PorousFlowLineGeometry().

 {
   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;
 }

◆ ptqp()

Real PorousFlowLineSink::ptqp ( ) const

protected

If _p_or_t==0, then returns the quadpoint porepressure, else returns the quadpoint temperature.

Definition at line 335 of file PorousFlowLineSink.C.

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

 {
   return (_p_or_t == PorTchoice::pressure ? (*_pp)[_qp][_ph] : (*_temperature)[_qp]);
 }

Member Data Documentation

◆ _bottom_point

Point PorousFlowLineGeometry::_bottom_point

protectedinherited

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

Definition at line 62 of file PorousFlowLineGeometry.h.

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

◆ _denthalpy_dvar

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowLineSink::_denthalpy_dvar

protected

d(enthalpy of each phase)/d(PorousFlow variable)

Definition at line 155 of file PorousFlowLineSink.h.

◆ _dfluid_density_node_dvar

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowLineSink::_dfluid_density_node_dvar

protected

d(Fluid density for each phase (at the node))/d(PorousFlow variable)

Definition at line 131 of file PorousFlowLineSink.h.

◆ _dfluid_viscosity_dvar

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowLineSink::_dfluid_viscosity_dvar

protected

d(Viscosity of each component in each phase)/d(PorousFlow variable)

Definition at line 137 of file PorousFlowLineSink.h.

◆ _dictator

const PorousFlowDictator& PorousFlowLineSink::_dictator

protected

PorousFlowDictator UserObject.

Definition at line 61 of file PorousFlowLineSink.h.

Referenced by PorousFlowPolyLineSink::computeQpBaseOutflowJacobian(), PorousFlowPeacemanBorehole::computeQpBaseOutflowJacobian(), jac(), and PorousFlowLineSink().

◆ _dinternal_energy_dvar

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowLineSink::_dinternal_energy_dvar

protected

d(internal_energy of each phase)/d(PorousFlow variable)

Definition at line 161 of file PorousFlowLineSink.h.

◆ _dmass_fractions_dvar

const MaterialProperty<std::vector<std::vector<std::vector<Real> > > >* const PorousFlowLineSink::_dmass_fractions_dvar

protected

d(Mass fraction of each component in each phase)/d(PorousFlow variable)

Definition at line 149 of file PorousFlowLineSink.h.

◆ _dpp_dvar

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowLineSink::_dpp_dvar

protected

d(quadpoint pore pressure in each phase)/d(PorousFlow variable)

Definition at line 119 of file PorousFlowLineSink.h.

Referenced by dptqp().

◆ _drelative_permeability_dvar

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowLineSink::_drelative_permeability_dvar

protected

d(Relative permeability of each phase)/d(PorousFlow variable)

Definition at line 143 of file PorousFlowLineSink.h.

◆ _dtemperature_dvar

const MaterialProperty<std::vector<Real> >* const PorousFlowLineSink::_dtemperature_dvar

protected

d(quadpoint temperature)/d(PorousFlow variable)

Definition at line 125 of file PorousFlowLineSink.h.

Referenced by dptqp().

◆ _enthalpy

const MaterialProperty<std::vector<Real> >* const PorousFlowLineSink::_enthalpy

protected

Enthalpy of each phase.

Definition at line 152 of file PorousFlowLineSink.h.

◆ _fluid_density_node

const MaterialProperty<std::vector<Real> >* const PorousFlowLineSink::_fluid_density_node

protected

Fluid density for each phase (at the node)

Definition at line 128 of file PorousFlowLineSink.h.

◆ _fluid_viscosity

const MaterialProperty<std::vector<Real> >* const PorousFlowLineSink::_fluid_viscosity

protected

Viscosity of each component in each phase.

Definition at line 134 of file PorousFlowLineSink.h.

◆ _half_seg_len

std::vector<Real> PorousFlowLineGeometry::_half_seg_len

protectedinherited

0.5*(length of polyline segments between points)

Definition at line 65 of file PorousFlowLineGeometry.h.

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

◆ _has_enthalpy

const bool PorousFlowLineSink::_has_enthalpy

protected

Whether an enthalpy material exists (for error checking)

Definition at line 86 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink().

◆ _has_internal_energy

const bool PorousFlowLineSink::_has_internal_energy

protected

Whether an internal-energy material exists (for error checking)

Definition at line 89 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink().

◆ _has_mass_fraction

const bool PorousFlowLineSink::_has_mass_fraction

protected

Whether a mass_fraction material exists (for error checking)

Definition at line 77 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink().

◆ _has_mobility

const bool PorousFlowLineSink::_has_mobility

protected

Whether enough materials exist to form the mobility (for error checking)

Definition at line 83 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink().

◆ _has_porepressure

const bool PorousFlowLineSink::_has_porepressure

protected

Whether a quadpoint porepressure material exists (for error checking)

Definition at line 71 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink().

◆ _has_relative_permeability

const bool PorousFlowLineSink::_has_relative_permeability

protected

Whether a relative permeability material exists (for error checking)

Definition at line 80 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink().

◆ _has_temperature

const bool PorousFlowLineSink::_has_temperature

protected

Whether a quadpoint temperature material exists (for error checking)

Definition at line 74 of file PorousFlowLineSink.h.

Referenced by PorousFlowLineSink().

◆ _internal_energy

const MaterialProperty<std::vector<Real> >* const PorousFlowLineSink::_internal_energy

protected

Internal_Energy of each phase.

Definition at line 158 of file PorousFlowLineSink.h.

◆ _line_direction

const RealVectorValue PorousFlowLineGeometry::_line_direction

protectedinherited

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

Definition at line 40 of file PorousFlowLineGeometry.h.

Referenced by PorousFlowPeacemanBorehole::PorousFlowPeacemanBorehole().

◆ _line_length

const Real PorousFlowLineGeometry::_line_length

protectedinherited

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

Definition at line 37 of file PorousFlowLineGeometry.h.

Referenced by PorousFlowLineGeometry::PorousFlowLineGeometry().

◆ _mass_fractions

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowLineSink::_mass_fractions

protected

Mass fraction of each component in each phase.

Definition at line 146 of file PorousFlowLineSink.h.

◆ _p_or_t

enum PorousFlowLineSink::PorTchoice PorousFlowLineSink::_p_or_t

protected

Referenced by dptqp(), PorousFlowLineSink(), PorousFlowPeacemanBorehole::PorousFlowPeacemanBorehole(), and ptqp().

◆ _ph

const unsigned int PorousFlowLineSink::_ph

protected

The phase number.

Definition at line 110 of file PorousFlowLineSink.h.

Referenced by computeQpResidual(), dptqp(), jac(), PorousFlowLineSink(), and ptqp().

◆ _point_file

const std::string PorousFlowLineGeometry::_point_file

protectedinherited

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 47 of file PorousFlowLineGeometry.h.

Referenced by PorousFlowLineGeometry::PorousFlowLineGeometry().

◆ _pp

const MaterialProperty<std::vector<Real> >* const PorousFlowLineSink::_pp

protected

Quadpoint pore pressure in each phase.

Definition at line 116 of file PorousFlowLineSink.h.

Referenced by ptqp().

◆ _relative_permeability

const MaterialProperty<std::vector<Real> >* const PorousFlowLineSink::_relative_permeability

protected

Relative permeability of each phase.

Definition at line 140 of file PorousFlowLineSink.h.

◆ _rs

std::vector<Real> PorousFlowLineGeometry::_rs

protectedinherited

Radii of the borehole.

Definition at line 50 of file PorousFlowLineGeometry.h.

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

◆ _sp

const unsigned int PorousFlowLineSink::_sp

protected

The component number (only used if _use_mass_fraction==true)

Definition at line 113 of file PorousFlowLineSink.h.

Referenced by computeQpResidual(), jac(), and PorousFlowLineSink().

◆ _temperature

const MaterialProperty<Real>* const PorousFlowLineSink::_temperature

protected

Quadpoint temperature.

Definition at line 122 of file PorousFlowLineSink.h.

Referenced by ptqp().

◆ _total_outflow_mass

PorousFlowSumQuantity& PorousFlowLineSink::_total_outflow_mass

protected

This is used to hold the total fluid flowing into the line sink for each time step.

Hence, it is positive for production wells where fluid is flowing from porespace into the line sink (and hence removed from the model)

Definition at line 68 of file PorousFlowLineSink.h.

Referenced by addPoints(), computeQpResidual(), and PorousFlowLineSink().

◆ _use_enthalpy

const bool PorousFlowLineSink::_use_enthalpy

protected

Whether the flux will be multiplied by the enthalpy.

Definition at line 104 of file PorousFlowLineSink.h.

Referenced by computeQpResidual(), jac(), and PorousFlowLineSink().

◆ _use_internal_energy

const bool PorousFlowLineSink::_use_internal_energy

protected

Whether the flux will be multiplied by the internal-energy.

Definition at line 107 of file PorousFlowLineSink.h.

Referenced by computeQpResidual(), jac(), and PorousFlowLineSink().

◆ _use_mass_fraction

const bool PorousFlowLineSink::_use_mass_fraction

protected

Whether the flux will be multiplied by the mass fraction.

Definition at line 95 of file PorousFlowLineSink.h.

Referenced by computeQpResidual(), jac(), and PorousFlowLineSink().

◆ _use_mobility

const bool PorousFlowLineSink::_use_mobility

protected

Whether the flux will be multiplied by the mobility.

Definition at line 101 of file PorousFlowLineSink.h.

Referenced by computeQpResidual(), jac(), and PorousFlowLineSink().

◆ _use_relative_permeability

const bool PorousFlowLineSink::_use_relative_permeability

protected

Whether the flux will be multiplied by the relative permeability.

Definition at line 98 of file PorousFlowLineSink.h.

Referenced by computeQpResidual(), jac(), and PorousFlowLineSink().

◆ _xs

std::vector<Real> PorousFlowLineGeometry::_xs

protectedinherited

x points of the borehole

Definition at line 53 of file PorousFlowLineGeometry.h.

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

◆ _ys

std::vector<Real> PorousFlowLineGeometry::_ys

protectedinherited

y points of the borehole

Definition at line 56 of file PorousFlowLineGeometry.h.

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

◆ _zs

std::vector<Real> PorousFlowLineGeometry::_zs

protectedinherited

z points of borehole

Definition at line 59 of file PorousFlowLineGeometry.h.

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

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

porous_flow/include/dirackernels/PorousFlowLineSink.h
porous_flow/src/dirackernels/PorousFlowLineSink.C

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ PorTchoice

Constructor & Destructor Documentation

◆ PorousFlowLineSink()

Member Function Documentation

◆ addPoints()

◆ computeQpBaseOutflow()

◆ computeQpBaseOutflowJacobian()

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

◆ dptqp()

◆ jac()

◆ parseNextLineReals()

◆ ptqp()

Member Data Documentation

◆ _bottom_point

◆ _denthalpy_dvar

◆ _dfluid_density_node_dvar

◆ _dfluid_viscosity_dvar

◆ _dictator

◆ _dinternal_energy_dvar

◆ _dmass_fractions_dvar

◆ _dpp_dvar

◆ _drelative_permeability_dvar

◆ _dtemperature_dvar

◆ _enthalpy

◆ _fluid_density_node

◆ _fluid_viscosity

◆ _half_seg_len

◆ _has_enthalpy

◆ _has_internal_energy

◆ _has_mass_fraction

◆ _has_mobility

◆ _has_porepressure

◆ _has_relative_permeability

◆ _has_temperature

◆ _internal_energy

◆ _line_direction

◆ _line_length

◆ _mass_fractions

◆ _p_or_t

◆ _ph

◆ _point_file

◆ _pp

◆ _relative_permeability

◆ _rs

◆ _sp

◆ _temperature

◆ _total_outflow_mass

◆ _use_enthalpy

◆ _use_internal_energy

◆ _use_mass_fraction

◆ _use_mobility

◆ _use_relative_permeability

◆ _xs

◆ _ys

◆ _zs