Kernel = grad(permeability*relativepermeability/viscosity * (grad(pressure) - density*gravity)) This is mass flow according to the Richards equation. More...

#include <RichardsFlux.h>

Inheritance diagram for RichardsFlux:

[legend]

Public Member Functions
	RichardsFlux (const InputParameters &parameters)

Protected Member Functions
virtual Real	computeQpResidual ()

virtual Real	computeQpJacobian ()

virtual Real	computeQpOffDiagJacobian (unsigned int jvar)

Real	computeQpJac (unsigned int wrt_num)
	Computes diagonal and off-diagonal jacobian entries. More...

Protected Attributes
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< RealVectorValue > > &	_flux
	Richards flux. More...

const MaterialProperty< std::vector< std::vector< RealVectorValue > > > &	_dflux_dv
	d(Richards flux_i)/d(variable_j), here flux_i is the i_th flux, which is itself a RealVectorValue More...

const MaterialProperty< std::vector< std::vector< RealTensorValue > > > &	_dflux_dgradv
	d(Richards flux_i)/d(grad(variable_j)), here flux_i is the i_th flux, which is itself a RealVectorValue More...

const MaterialProperty< std::vector< std::vector< std::vector< RealVectorValue > > > > &	_d2flux_dvdv
	d^2(Richards flux_i)/d(variable_j)/d(variable_k), here flux_i is the i_th flux, which is itself a RealVectorValue More...

const MaterialProperty< std::vector< std::vector< std::vector< RealTensorValue > > > > &	_d2flux_dgradvdv
	d^2(Richards flux_i)/d(grad(variable_j))/d(variable_k), here flux_i is the i_th flux, which is itself a RealVectorValue More...

const MaterialProperty< std::vector< std::vector< std::vector< RealTensorValue > > > > &	_d2flux_dvdgradv
	d^2(Richards flux_i)/d(variable_j)/d(grad(variable_k)), here flux_i is the i_th flux, which is itself a RealVectorValue More...

const VariableSecond &	_second_u
	grad_i grad_j porepressure. This is used in SUPG More...

const VariablePhiSecond &	_second_phi
	interpolation function for the _second_u More...

const MaterialProperty< std::vector< RealVectorValue > > &	_tauvel_SUPG
	SUPGtau*SUPGvel (a vector of these if multiphase) More...

const MaterialProperty< std::vector< std::vector< RealTensorValue > > > &	_dtauvel_SUPG_dgradv
	derivative of SUPGtau*SUPGvel_i wrt grad(variable_j) More...

const MaterialProperty< std::vector< std::vector< RealVectorValue > > > &	_dtauvel_SUPG_dv
	derivative of SUPGtau*SUPGvel_i wrt variable_j More...

Detailed Description

Kernel = grad(permeability*relativepermeability/viscosity * (grad(pressure) - density*gravity)) This is mass flow according to the Richards equation.

Definition at line 25 of file RichardsFlux.h.

Constructor & Destructor Documentation

◆ RichardsFlux()

RichardsFlux::RichardsFlux ( const InputParameters & parameters )

Definition at line 35 of file RichardsFlux.C.

   : Kernel(parameters),
     _richards_name_UO(getUserObject<RichardsVarNames>("richardsVarNames_UO")),
     _pvar(_richards_name_UO.richards_var_num(_var.number())),
  
     // This kernel gets lots of things from the material
     _flux(getMaterialProperty<std::vector<RealVectorValue>>("flux")),
     _dflux_dv(getMaterialProperty<std::vector<std::vector<RealVectorValue>>>("dflux_dv")),
     _dflux_dgradv(getMaterialProperty<std::vector<std::vector<RealTensorValue>>>("dflux_dgradv")),
     _d2flux_dvdv(
         getMaterialProperty<std::vector<std::vector<std::vector<RealVectorValue>>>>("d2flux_dvdv")),
     _d2flux_dgradvdv(getMaterialProperty<std::vector<std::vector<std::vector<RealTensorValue>>>>(
         "d2flux_dgradvdv")),
     _d2flux_dvdgradv(getMaterialProperty<std::vector<std::vector<std::vector<RealTensorValue>>>>(
         "d2flux_dvdgradv")),
  
     _second_u(getParam<bool>("linear_shape_fcns")
                   ? _second_zero
                   : (_is_implicit ? _var.secondSln() : _var.secondSlnOld())),
     _second_phi(getParam<bool>("linear_shape_fcns") ? _second_phi_zero : secondPhi()),
  
     _tauvel_SUPG(getMaterialProperty<std::vector<RealVectorValue>>("tauvel_SUPG")),
     _dtauvel_SUPG_dgradv(
         getMaterialProperty<std::vector<std::vector<RealTensorValue>>>("dtauvel_SUPG_dgradv")),
     _dtauvel_SUPG_dv(
         getMaterialProperty<std::vector<std::vector<RealVectorValue>>>("dtauvel_SUPG_dv"))
 {
 }

Member Function Documentation

◆ computeQpJac()

Real RichardsFlux::computeQpJac ( unsigned int wrt_num )

protected

Computes diagonal and off-diagonal jacobian entries.

Since the code is almost identical for both cases it's better to use just one function

Parameters

wrt_num take the derivative of the residual wrt this richards variable

Definition at line 87 of file RichardsFlux.C.

 {
   Real flux_prime = _grad_test[_i][_qp] * (_dflux_dgradv[_qp][_pvar][wrt_num] * _grad_phi[_j][_qp] +
                                            _dflux_dv[_qp][_pvar][wrt_num] * _phi[_j][_qp]);
  
   Real supg_test = _tauvel_SUPG[_qp][_pvar] * _grad_test[_i][_qp];
   Real supg_test_prime =
       _grad_phi[_j][_qp] * (_dtauvel_SUPG_dgradv[_qp][_pvar][wrt_num] * _grad_test[_i][_qp]) +
       _phi[_j][_qp] * _dtauvel_SUPG_dv[_qp][_pvar][wrt_num] * _grad_test[_i][_qp];
   Real supg_kernel = 0.0;
   Real supg_kernel_prime = 0.0;
  
   if (supg_test != 0)
   {
     // NOTE: since Libmesh does not correctly calculate grad(_grad_u) correctly, so following might
     // not be correct
     supg_kernel = -(_dflux_dgradv[_qp][_pvar][_pvar] * _second_u[_qp]).tr() -
                   _dflux_dv[_qp][_pvar][_pvar] * _grad_u[_qp];
  
     // NOTE: just like supg_kernel, this must be generalised for non-PPPP formulations
     supg_kernel_prime =
         -(_d2flux_dvdv[_qp][_pvar][_pvar][wrt_num] * _phi[_j][_qp] * _grad_u[_qp] +
           _phi[_j][_qp] * (_d2flux_dgradvdv[_qp][_pvar][_pvar][wrt_num] * _second_u[_qp]).tr() +
           (_d2flux_dvdgradv[_qp][_pvar][_pvar][wrt_num] * _grad_u[_qp]) * _grad_phi[_j][_qp]);
     if (wrt_num == _pvar)
       supg_kernel_prime -= _dflux_dv[_qp][_pvar][_pvar] * _grad_phi[_j][_qp];
     supg_kernel_prime -= (_dflux_dgradv[_qp][_pvar][_pvar] * _second_phi[_j][_qp]).tr();
   }
  
   return flux_prime + supg_test_prime * supg_kernel + supg_test * supg_kernel_prime;
 }

Referenced by computeQpJacobian(), and computeQpOffDiagJacobian().

◆ computeQpJacobian()

Real RichardsFlux::computeQpJacobian ( )

protectedvirtual

Definition at line 120 of file RichardsFlux.C.

 {
   return computeQpJac(_pvar);
 }

◆ computeQpOffDiagJacobian()

Real RichardsFlux::computeQpOffDiagJacobian ( unsigned int jvar )

protectedvirtual

Definition at line 126 of file RichardsFlux.C.

 {
   if (_richards_name_UO.not_richards_var(jvar))
     return 0.0;
   unsigned int dvar = _richards_name_UO.richards_var_num(jvar);
   return computeQpJac(dvar);
 }

◆ computeQpResidual()

Real RichardsFlux::computeQpResidual ( )

protectedvirtual

Definition at line 65 of file RichardsFlux.C.

 {
   Real flux_part = _grad_test[_i][_qp] * _flux[_qp][_pvar];
  
   Real supg_test = _tauvel_SUPG[_qp][_pvar] * _grad_test[_i][_qp];
   Real supg_kernel = 0.0;
   if (supg_test != 0)
     // NOTE: Libmesh does not correctly calculate grad(_grad_u) correctly, so following might not be
     // correct
     // NOTE: The following is -divergence(flux)
     // NOTE: The following must be generalised if a non PPPP formalism is used
     // NOTE: The generalisation will look like
     // supg_kernel = sum_j {-(_dflux_dgradv[_qp][_pvar][j]*_second_u[_qp][j]).tr() -
     // _dflux_dv[_qp][_pvar][j]*_grad_u[_qp][j]}
     // where _grad_u[_qp][j] is the gradient of the j^th variable at the quadpoint.
     supg_kernel = -(_dflux_dgradv[_qp][_pvar][_pvar] * _second_u[_qp]).tr() -
                   _dflux_dv[_qp][_pvar][_pvar] * _grad_u[_qp];
  
   return flux_part + supg_test * supg_kernel;
 }

Member Data Documentation

◆ _d2flux_dgradvdv

const MaterialProperty<std::vector<std::vector<std::vector<RealTensorValue> > > >& RichardsFlux::_d2flux_dgradvdv

protected

d^2(Richards flux_i)/d(grad(variable_j))/d(variable_k), here flux_i is the i_th flux, which is itself a RealVectorValue

Definition at line 65 of file RichardsFlux.h.

Referenced by computeQpJac().

◆ _d2flux_dvdgradv

const MaterialProperty<std::vector<std::vector<std::vector<RealTensorValue> > > >& RichardsFlux::_d2flux_dvdgradv

protected

d^2(Richards flux_i)/d(variable_j)/d(grad(variable_k)), here flux_i is the i_th flux, which is itself a RealVectorValue

Definition at line 68 of file RichardsFlux.h.

Referenced by computeQpJac().

◆ _d2flux_dvdv

const MaterialProperty<std::vector<std::vector<std::vector<RealVectorValue> > > >& RichardsFlux::_d2flux_dvdv

protected

d^2(Richards flux_i)/d(variable_j)/d(variable_k), here flux_i is the i_th flux, which is itself a RealVectorValue

Definition at line 62 of file RichardsFlux.h.

Referenced by computeQpJac().

◆ _dflux_dgradv

const MaterialProperty<std::vector<std::vector<RealTensorValue> > >& RichardsFlux::_dflux_dgradv

protected

d(Richards flux_i)/d(grad(variable_j)), here flux_i is the i_th flux, which is itself a RealVectorValue

Definition at line 59 of file RichardsFlux.h.

Referenced by computeQpJac(), and computeQpResidual().

◆ _dflux_dv

const MaterialProperty<std::vector<std::vector<RealVectorValue> > >& RichardsFlux::_dflux_dv

protected

d(Richards flux_i)/d(variable_j), here flux_i is the i_th flux, which is itself a RealVectorValue

Definition at line 56 of file RichardsFlux.h.

Referenced by computeQpJac(), and computeQpResidual().

◆ _dtauvel_SUPG_dgradv

const MaterialProperty<std::vector<std::vector<RealTensorValue> > >& RichardsFlux::_dtauvel_SUPG_dgradv

protected

derivative of SUPGtau*SUPGvel_i wrt grad(variable_j)

Definition at line 80 of file RichardsFlux.h.

Referenced by computeQpJac().

◆ _dtauvel_SUPG_dv

const MaterialProperty<std::vector<std::vector<RealVectorValue> > >& RichardsFlux::_dtauvel_SUPG_dv

protected

derivative of SUPGtau*SUPGvel_i wrt variable_j

Definition at line 83 of file RichardsFlux.h.

Referenced by computeQpJac().

◆ _flux

const MaterialProperty<std::vector<RealVectorValue> >& RichardsFlux::_flux

protected

Richards flux.

Definition at line 53 of file RichardsFlux.h.

Referenced by computeQpResidual().

◆ _pvar

unsigned int RichardsFlux::_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 50 of file RichardsFlux.h.

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

◆ _richards_name_UO

const RichardsVarNames& RichardsFlux::_richards_name_UO

protected

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

Definition at line 41 of file RichardsFlux.h.

Referenced by computeQpOffDiagJacobian().

◆ _second_phi

const VariablePhiSecond& RichardsFlux::_second_phi

protected

interpolation function for the _second_u

Definition at line 74 of file RichardsFlux.h.

Referenced by computeQpJac().

◆ _second_u

const VariableSecond& RichardsFlux::_second_u

protected

grad_i grad_j porepressure. This is used in SUPG

Definition at line 71 of file RichardsFlux.h.

Referenced by computeQpJac(), and computeQpResidual().

◆ _tauvel_SUPG

const MaterialProperty<std::vector<RealVectorValue> >& RichardsFlux::_tauvel_SUPG

protected

SUPGtau*SUPGvel (a vector of these if multiphase)

Definition at line 77 of file RichardsFlux.h.

Referenced by computeQpJac(), and computeQpResidual().

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

richards/include/kernels/RichardsFlux.h
richards/src/kernels/RichardsFlux.C

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RichardsFlux()

Member Function Documentation

◆ computeQpJac()

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

Member Data Documentation

◆ _d2flux_dgradvdv

◆ _d2flux_dvdgradv

◆ _d2flux_dvdv

◆ _dflux_dgradv

◆ _dflux_dv

◆ _dtauvel_SUPG_dgradv

◆ _dtauvel_SUPG_dv

◆ _flux

◆ _pvar

◆ _richards_name_UO

◆ _second_phi

◆ _second_u

◆ _tauvel_SUPG