Applies a fully-upwinded flux sink to a boundary The sink is a piecewise linear function of porepressure at the quad points. More...

#include <Q2PPiecewiseLinearSink.h>

Inheritance diagram for Q2PPiecewiseLinearSink:

[legend]

Public Member Functions
	Q2PPiecewiseLinearSink (const InputParameters &parameters)

Protected Member Functions
virtual void	computeResidual () override

virtual Real	computeQpResidual () override

virtual void	computeJacobian () override

virtual Real	computeQpJacobian () override

virtual void	computeJacobianBlock (MooseVariableFEBase &jvar) override

virtual Real	computeQpOffDiagJacobian (unsigned int jvar) override

void	prepareNodalValues ()
	calculates the nodal values of pressure, mobility, and derivatives thereof More...

Real	jac (unsigned int wrt_num)
	derivative of residual wrt the wrt_num variable More...

Protected Attributes
bool	_use_mobility
	whether to multiply the sink flux by permeability*density/viscosity More...

bool	_use_relperm
	whether to multiply the sink flux by relative permeability More...

LinearInterpolation	_sink_func
	piecewise-linear function of porepressure (this defines the strength of the sink) More...

const Function &	_m_func
	sink flux gets multiplied by this function More...

const RichardsDensity &	_density
	fluid density More...

const RichardsRelPerm &	_relperm
	fluid relative permeability More...

const VariableValue &	_other_var_nodal
	the other variable in the 2-phase system (this is saturation if Variable=porepressure, and viceversa) More...

unsigned int	_other_var_num
	the variable number of the other variable More...

bool	_var_is_pp
	whether the Variable for this BC is porepressure or not More...

Real	_viscosity
	viscosity More...

const MaterialProperty< RealTensorValue > &	_permeability
	permeability More...

unsigned int	_num_nodes
	number of nodes in this element. More...

std::vector< Real >	_pp
	nodal values of porepressure More...

std::vector< Real >	_sat
	nodal values of saturation More...

std::vector< Real >	_nodal_density
	nodal values of fluid density More...

std::vector< Real >	_dnodal_density_dp
	d(_nodal_density)/d(porepressure) More...

std::vector< Real >	_nodal_relperm
	nodal values of relative permeability More...

std::vector< Real >	_dnodal_relperm_ds
	d(_nodal_relperm)/d(saturation) More...

Detailed Description

Applies a fully-upwinded flux sink to a boundary The sink is a piecewise linear function of porepressure at the quad points.

This is specified by _sink_func. In addition, this sink can be multiplied by: (1) the relative permeability of the fluid at the quad point. (2) perm_nn*density/viscosity, where perm_nn is the permeability tensor projected in the normal direction. (3) a Function (which can be time-dependent, for instance) This is for use in Q2P models

Definition at line 36 of file Q2PPiecewiseLinearSink.h.

Constructor & Destructor Documentation

◆ Q2PPiecewiseLinearSink()

Q2PPiecewiseLinearSink::Q2PPiecewiseLinearSink ( const InputParameters & parameters )

Definition at line 75 of file Q2PPiecewiseLinearSink.C.

   : IntegratedBC(parameters),
     _use_mobility(getParam<bool>("use_mobility")),
     _use_relperm(getParam<bool>("use_relperm")),
     _sink_func(getParam<std::vector<Real>>("pressures"),
                getParam<std::vector<Real>>("bare_fluxes")),
     _m_func(getFunction("multiplying_fcn")),
     _density(getUserObject<RichardsDensity>("fluid_density")),
     _relperm(getUserObject<RichardsRelPerm>("fluid_relperm")),
     _other_var_nodal(coupledDofValues("other_var")),
     _other_var_num(coupled("other_var")),
     _var_is_pp(getParam<bool>("var_is_porepressure")),
     _viscosity(getParam<Real>("fluid_viscosity")),
     _permeability(getMaterialProperty<RealTensorValue>("permeability")),
     _num_nodes(0),
     _pp(0),
     _sat(0),
     _nodal_density(0),
     _dnodal_density_dp(0),
     _nodal_relperm(0),
     _dnodal_relperm_ds(0)
 {
 }

Member Function Documentation

◆ computeJacobian()

void Q2PPiecewiseLinearSink::computeJacobian ( )

overrideprotectedvirtual

Definition at line 178 of file Q2PPiecewiseLinearSink.C.

 {
   prepareNodalValues();
   IntegratedBC::computeJacobian();
 }

◆ computeJacobianBlock()

void Q2PPiecewiseLinearSink::computeJacobianBlock ( MooseVariableFEBase & jvar )

overrideprotectedvirtual

Definition at line 191 of file Q2PPiecewiseLinearSink.C.

 {
   prepareNodalValues();
   IntegratedBC::computeJacobianBlock(jvar);
 }

◆ computeQpJacobian()

Real Q2PPiecewiseLinearSink::computeQpJacobian ( )

overrideprotectedvirtual

Definition at line 185 of file Q2PPiecewiseLinearSink.C.

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

◆ computeQpOffDiagJacobian()

Real Q2PPiecewiseLinearSink::computeQpOffDiagJacobian ( unsigned int jvar )

overrideprotectedvirtual

Definition at line 198 of file Q2PPiecewiseLinearSink.C.

 {
   if (jvar == _var.number() || jvar == _other_var_num)
     return jac(jvar);
  
   return 0.0;
 }

◆ computeQpResidual()

Real Q2PPiecewiseLinearSink::computeQpResidual ( )

overrideprotectedvirtual

Definition at line 156 of file Q2PPiecewiseLinearSink.C.

 {
   Real flux = 0;
   Real k = 0;
  
   flux = _test[_i][_qp] * _sink_func.sample(_pp[_i]);
   if (_use_mobility)
   {
     k = (_permeability[0] * _normals[_qp]) * _normals[_qp]; // assume that _permeability is constant
                                                             // throughout element so doesn't need to
                                                             // be upwinded
     flux *= _nodal_density[_i] * k / _viscosity;
   }
   if (_use_relperm)
     flux *= _nodal_relperm[_i];
  
   flux *= _m_func.value(_t, _q_point[_qp]);
  
   return flux;
 }

◆ computeResidual()

void Q2PPiecewiseLinearSink::computeResidual ( )

overrideprotectedvirtual

Definition at line 149 of file Q2PPiecewiseLinearSink.C.

 {
   prepareNodalValues();
   IntegratedBC::computeResidual();
 }

◆ jac()

Real Q2PPiecewiseLinearSink::jac ( unsigned int wrt_num )

protected

derivative of residual wrt the wrt_num variable

Definition at line 207 of file Q2PPiecewiseLinearSink.C.

 {
   Real flux = 0;
   Real deriv = 0;
   Real k = 0;
   Real mob = 0;
   Real mobp = 0;
   Real phi = 1;
  
   if (_i != _j)
     return 0.0; // residual at node _i only depends on variables at that node
  
   flux = _sink_func.sample(_pp[_i]);
  
   if (_var_is_pp)
   {
     // derivative of the _sink_func
     if (wrt_num == _var.number())
       deriv = _sink_func.sampleDerivative(_pp[_i]);
     else
       deriv = 0;
  
     // add derivative of the mobility
     if (_use_mobility)
     {
       k = (_permeability[0] * _normals[_qp]) * _normals[_qp];
       mob = _nodal_density[_i] * k / _viscosity;
       if (wrt_num == _var.number())
         mobp = _dnodal_density_dp[_i] * k / _viscosity; // else mobp = 0
       deriv = mob * deriv + mobp * flux;
       flux *= mob;
     }
  
     // add derivative of the relperm
     if (_use_relperm)
     {
       if (wrt_num == _other_var_num)
         deriv = _nodal_relperm[_i] * deriv + _dnodal_relperm_ds[_i] * flux;
       else
         deriv = _nodal_relperm[_i] * deriv;
     }
   }
   else
   {
     // derivative of the _sink_func
     if (wrt_num == _other_var_num)
       deriv = _sink_func.sampleDerivative(_pp[_i]);
     else
       deriv = 0;
  
     // add derivative of the mobility
     if (_use_mobility)
     {
       k = (_permeability[0] * _normals[_qp]) * _normals[_qp];
       mob = _nodal_density[_i] * k / _viscosity;
       if (wrt_num == _other_var_num)
         mobp = _dnodal_density_dp[_i] * k / _viscosity; // else mobp = 0
       deriv = mob * deriv + mobp * flux;
       flux *= mob;
     }
  
     // add derivative of the relperm
     if (_use_relperm)
     {
       if (wrt_num == _var.number())
         deriv = _nodal_relperm[_i] * deriv + _dnodal_relperm_ds[_i] * flux;
       else
         deriv = _nodal_relperm[_i] * deriv;
     }
   }
  
   deriv *= _m_func.value(_t, _q_point[_qp]);
  
   return _test[_i][_qp] * deriv * phi;
 }

Referenced by computeQpJacobian(), and computeQpOffDiagJacobian().

◆ prepareNodalValues()

void Q2PPiecewiseLinearSink::prepareNodalValues ( )

protected

calculates the nodal values of pressure, mobility, and derivatives thereof

Definition at line 100 of file Q2PPiecewiseLinearSink.C.

 {
   _num_nodes = _other_var_nodal.size();
  
   // set _pp and _sat variables
   _pp.resize(_num_nodes);
   _sat.resize(_num_nodes);
   if (_var_is_pp)
   {
     for (unsigned int nodenum = 0; nodenum < _num_nodes; ++nodenum)
     {
       _pp[nodenum] = _var.dofValues()[nodenum];
       _sat[nodenum] = _other_var_nodal[nodenum];
     }
   }
   else
   {
     for (unsigned int nodenum = 0; nodenum < _num_nodes; ++nodenum)
     {
       _pp[nodenum] = _other_var_nodal[nodenum];
       _sat[nodenum] = _var.dofValues()[nodenum];
     }
   }
  
   // calculate derived things
   if (_use_mobility)
   {
     _nodal_density.resize(_num_nodes);
     _dnodal_density_dp.resize(_num_nodes);
     for (unsigned int nodenum = 0; nodenum < _num_nodes; ++nodenum)
     {
       _nodal_density[nodenum] = _density.density(_pp[nodenum]);
       _dnodal_density_dp[nodenum] = _density.ddensity(_pp[nodenum]);
     }
   }
  
   if (_use_relperm)
   {
     _nodal_relperm.resize(_num_nodes);
     _dnodal_relperm_ds.resize(_num_nodes);
     for (unsigned int nodenum = 0; nodenum < _num_nodes; ++nodenum)
     {
       _nodal_relperm[nodenum] = _relperm.relperm(_sat[nodenum]);
       _dnodal_relperm_ds[nodenum] = _relperm.drelperm(_sat[nodenum]);
     }
   }
 }

Referenced by computeJacobian(), computeJacobianBlock(), and computeResidual().

Member Data Documentation

◆ _density

const RichardsDensity& Q2PPiecewiseLinearSink::_density

protected

fluid density

Definition at line 68 of file Q2PPiecewiseLinearSink.h.

Referenced by prepareNodalValues().

◆ _dnodal_density_dp

std::vector<Real> Q2PPiecewiseLinearSink::_dnodal_density_dp

protected

d(_nodal_density)/d(porepressure)

Definition at line 101 of file Q2PPiecewiseLinearSink.h.

Referenced by jac(), and prepareNodalValues().

◆ _dnodal_relperm_ds

std::vector<Real> Q2PPiecewiseLinearSink::_dnodal_relperm_ds

protected

d(_nodal_relperm)/d(saturation)

Definition at line 107 of file Q2PPiecewiseLinearSink.h.

Referenced by jac(), and prepareNodalValues().

◆ _m_func

const Function& Q2PPiecewiseLinearSink::_m_func

protected

sink flux gets multiplied by this function

Definition at line 65 of file Q2PPiecewiseLinearSink.h.

Referenced by computeQpResidual(), and jac().

◆ _nodal_density

std::vector<Real> Q2PPiecewiseLinearSink::_nodal_density

protected

nodal values of fluid density

Definition at line 98 of file Q2PPiecewiseLinearSink.h.

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

◆ _nodal_relperm

std::vector<Real> Q2PPiecewiseLinearSink::_nodal_relperm

protected

nodal values of relative permeability

Definition at line 104 of file Q2PPiecewiseLinearSink.h.

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

◆ _num_nodes

unsigned int Q2PPiecewiseLinearSink::_num_nodes

protected

number of nodes in this element.

Definition at line 89 of file Q2PPiecewiseLinearSink.h.

Referenced by prepareNodalValues().

◆ _other_var_nodal

const VariableValue& Q2PPiecewiseLinearSink::_other_var_nodal

protected

the other variable in the 2-phase system (this is saturation if Variable=porepressure, and viceversa)

Definition at line 74 of file Q2PPiecewiseLinearSink.h.

Referenced by prepareNodalValues().

◆ _other_var_num

unsigned int Q2PPiecewiseLinearSink::_other_var_num

protected

the variable number of the other variable

Definition at line 77 of file Q2PPiecewiseLinearSink.h.

Referenced by computeQpOffDiagJacobian(), and jac().

◆ _permeability

const MaterialProperty<RealTensorValue>& Q2PPiecewiseLinearSink::_permeability

protected

permeability

Definition at line 86 of file Q2PPiecewiseLinearSink.h.

Referenced by computeQpResidual(), and jac().

◆ _pp

std::vector<Real> Q2PPiecewiseLinearSink::_pp

protected

nodal values of porepressure

Definition at line 92 of file Q2PPiecewiseLinearSink.h.

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

◆ _relperm

const RichardsRelPerm& Q2PPiecewiseLinearSink::_relperm

protected

fluid relative permeability

Definition at line 71 of file Q2PPiecewiseLinearSink.h.

Referenced by prepareNodalValues().

◆ _sat

std::vector<Real> Q2PPiecewiseLinearSink::_sat

protected

nodal values of saturation

Definition at line 95 of file Q2PPiecewiseLinearSink.h.

Referenced by prepareNodalValues().

◆ _sink_func

LinearInterpolation Q2PPiecewiseLinearSink::_sink_func

protected

piecewise-linear function of porepressure (this defines the strength of the sink)

Definition at line 62 of file Q2PPiecewiseLinearSink.h.

Referenced by computeQpResidual(), and jac().

◆ _use_mobility

bool Q2PPiecewiseLinearSink::_use_mobility

protected

whether to multiply the sink flux by permeability*density/viscosity

Definition at line 56 of file Q2PPiecewiseLinearSink.h.

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

◆ _use_relperm

bool Q2PPiecewiseLinearSink::_use_relperm

protected

whether to multiply the sink flux by relative permeability

Definition at line 59 of file Q2PPiecewiseLinearSink.h.

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

◆ _var_is_pp

bool Q2PPiecewiseLinearSink::_var_is_pp

protected

whether the Variable for this BC is porepressure or not

Definition at line 80 of file Q2PPiecewiseLinearSink.h.

Referenced by jac(), and prepareNodalValues().

◆ _viscosity

Real Q2PPiecewiseLinearSink::_viscosity

protected

viscosity

Definition at line 83 of file Q2PPiecewiseLinearSink.h.

Referenced by computeQpResidual(), and jac().

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

richards/include/bcs/Q2PPiecewiseLinearSink.h
richards/src/bcs/Q2PPiecewiseLinearSink.C

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Q2PPiecewiseLinearSink()

Member Function Documentation

◆ computeJacobian()

◆ computeJacobianBlock()

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

◆ computeResidual()

◆ jac()

◆ prepareNodalValues()

Member Data Documentation

◆ _density

◆ _dnodal_density_dp

◆ _dnodal_relperm_ds

◆ _m_func

◆ _nodal_density

◆ _nodal_relperm

◆ _num_nodes

◆ _other_var_nodal

◆ _other_var_num

◆ _permeability

◆ _pp

◆ _relperm

◆ _sat

◆ _sink_func

◆ _use_mobility

◆ _use_relperm

◆ _var_is_pp

◆ _viscosity