RichardsHalfGaussianSink Class Reference

Applies a fluid sink to the boundary. More...

#include <RichardsHalfGaussianSink.h>

Inheritance diagram for RichardsHalfGaussianSink:

Public Member Functions
	RichardsHalfGaussianSink (const InputParameters &parameters)

Protected Member Functions
virtual Real	computeQpResidual ()
virtual Real	computeQpJacobian ()
virtual Real	computeQpOffDiagJacobian (unsigned int jvar)

Protected Attributes
Real	_maximum
	maximum of the Gaussian sink More...
Real	_sd
	standard deviation of the Gaussian sink More...
Real	_centre
	centre of the Gaussian sink More...
const Function &	_m_func
	multiplying function: all fluxes will be multiplied by this More...
const RichardsVarNames &	_richards_name_UO
	holds info regarding the names of the Richards variables and methods for extracting values of these variables More...
unsigned int	_pvar
	the index of this variable in the list of Richards variables held by _richards_name_UO. More...
const MaterialProperty< std::vector< Real > > &	_pp
	porepressure (or porepressure vector for multiphase problems) More...
const MaterialProperty< std::vector< std::vector< Real > > > &	_dpp_dv
	d(porepressure_i)/dvariable_j More...

Detailed Description

Applies a fluid sink to the boundary.

The sink has strength _maximum*exp(-(0.5*(p - c)/_sd)^2)*_m_func for p<c _maximum*_m_func for p>=c This is typically used for modelling evapotranspiration from the top of a groundwater model

Definition at line 29 of file RichardsHalfGaussianSink.h.

Constructor & Destructor Documentation

RichardsHalfGaussianSink()

RichardsHalfGaussianSink::RichardsHalfGaussianSink

(

const InputParameters &

parameters

)

Definition at line 50 of file RichardsHalfGaussianSink.C.

  : IntegratedBC(parameters),
    _maximum(getParam<Real>("max")),
    _sd(getParam<Real>("sd")),
    _centre(getParam<Real>("centre")),
    _m_func(getFunction("multiplying_fcn")),
    _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"))
{
}

Member Function Documentation

computeQpJacobian()

Real RichardsHalfGaussianSink::computeQpJacobian ( )

protectedvirtual

Definition at line 76 of file RichardsHalfGaussianSink.C.

{
  if (_pp[_qp][_pvar] >= _centre)
    return 0.0;
 
  const Real test_fcn_f = _test[_i][_qp] * _m_func.value(_t, _q_point[_qp]);
  return -test_fcn_f * _maximum * (_pp[_qp][_pvar] - _centre) / Utility::pow<2>(_sd) *
         std::exp(-0.5 * Utility::pow<2>((_pp[_qp][_pvar] - _centre) / _sd)) * _phi[_j][_qp] *
         _dpp_dv[_qp][_pvar][_pvar];
}

computeQpOffDiagJacobian()

Real RichardsHalfGaussianSink::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtual

Definition at line 88 of file RichardsHalfGaussianSink.C.

{
  if (_richards_name_UO.not_richards_var(jvar))
    return 0.0;
 
  if (_pp[_qp][_pvar] >= _centre)
    return 0.0;
 
  const Real test_fcn_f = _test[_i][_qp] * _m_func.value(_t, _q_point[_qp]);
  const unsigned int dvar = _richards_name_UO.richards_var_num(jvar);
  return -test_fcn_f * _maximum * (_pp[_qp][_pvar] - _centre) / Utility::pow<2>(_sd) *
         std::exp(-0.5 * Utility::pow<2>((_pp[_qp][_pvar] - _centre) / _sd)) * _phi[_j][_qp] *
         _dpp_dv[_qp][_pvar][dvar];
}

computeQpResidual()

Real RichardsHalfGaussianSink::computeQpResidual ( )

protectedvirtual

Definition at line 64 of file RichardsHalfGaussianSink.C.

{
  const Real test_fcn_f = _test[_i][_qp] * _m_func.value(_t, _q_point[_qp]);
 
  if (_pp[_qp][_pvar] >= _centre)
    return test_fcn_f * _maximum;
 
  return test_fcn_f * _maximum *
         std::exp(-0.5 * Utility::pow<2>((_pp[_qp][_pvar] - _centre) / _sd));
}

Member Data Documentation

_centre

Real RichardsHalfGaussianSink::_centre

protected

centre of the Gaussian sink

Definition at line 48 of file RichardsHalfGaussianSink.h.

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

_dpp_dv

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

protected

d(porepressure_i)/dvariable_j

Definition at line 72 of file RichardsHalfGaussianSink.h.

Referenced by computeQpJacobian(), and computeQpOffDiagJacobian().

_m_func

const Function& RichardsHalfGaussianSink::_m_func

protected

multiplying function: all fluxes will be multiplied by this

Definition at line 51 of file RichardsHalfGaussianSink.h.

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

_maximum

Real RichardsHalfGaussianSink::_maximum

protected

maximum of the Gaussian sink

Definition at line 42 of file RichardsHalfGaussianSink.h.

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

_pp

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

protected

porepressure (or porepressure vector for multiphase problems)

Definition at line 69 of file RichardsHalfGaussianSink.h.

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

_pvar

unsigned int RichardsHalfGaussianSink::_pvar

protected

the index of this variable in the list of Richards variables held by _richards_name_UO.

Eg if richards_vars = 'pwater pgas poil' in the _richards_name_UO and this kernel has variable = pgas, then _pvar = 1 This is used to index correctly into _viscosity, _seff, etc

Definition at line 66 of file RichardsHalfGaussianSink.h.

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

_richards_name_UO

const RichardsVarNames& RichardsHalfGaussianSink::_richards_name_UO

protected

holds info regarding the names of the Richards variables and methods for extracting values of these variables

Definition at line 57 of file RichardsHalfGaussianSink.h.

Referenced by computeQpOffDiagJacobian().

_sd

Real RichardsHalfGaussianSink::_sd

protected

standard deviation of the Gaussian sink

Definition at line 45 of file RichardsHalfGaussianSink.h.

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

---

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

• richards/include/bcs/RichardsHalfGaussianSink.h
• richards/src/bcs/RichardsHalfGaussianSink.C