RichardsLumpedMassChange Class Reference

d(fluid mass in porespace)/dt with the fluid mass being lumped to the nodes. More...

#include <RichardsLumpedMassChange.h>

Inheritance diagram for RichardsLumpedMassChange:

Public Member Functions
	RichardsLumpedMassChange (const InputParameters &parameters)

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

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	_num_p
	number of richards variables More...
unsigned int	_pvar
	the index of this variable in the list of Richards variables held by _richards_name_UO. More...
const MaterialProperty< Real > &	_porosity
	current value of the porosity More...
const MaterialProperty< Real > &	_porosity_old
	value of the porosity at the start of the timestep More...
const RichardsSeff *	_seff_UO
	The userobject that computes effective saturation (as a function of porepressure(s)) for this variable. More...
const RichardsSat *	_sat_UO
	The userobject that computes saturation (as a function of effective saturation) for this variable. More...
const RichardsDensity *	_density_UO
	The userobject that computes fluid density (as a function of the porepressure) More...
std::vector< const VariableValue * >	_ps_at_nodes
	Holds the values of pressures at all the nodes of the element Eg: _ps_at_nodes[_pvar] is a pointer to this variable's nodal porepressure values So: (*_ps_at_nodes[_pvar])[i] = _var.dofValues()[i]. More...
std::vector< const VariableValue * >	_ps_old_at_nodes
	Holds the nodal values of pressures at timestep_begin, in same way as _ps_at_nodes. More...
std::vector< Real >	_dseff
	holds nodal values of d(Seff)/dP_i More...

Detailed Description

d(fluid mass in porespace)/dt with the fluid mass being lumped to the nodes.

Usually this is better to use than a non-lumped version because it prevents unphysical oscillations.

Definition at line 31 of file RichardsLumpedMassChange.h.

Constructor & Destructor Documentation

RichardsLumpedMassChange()

RichardsLumpedMassChange::RichardsLumpedMassChange

(

const InputParameters &

parameters

)

Definition at line 43 of file RichardsLumpedMassChange.C.

  : TimeKernel(parameters),
    _richards_name_UO(getUserObject<RichardsVarNames>("richardsVarNames_UO")),
    _num_p(_richards_name_UO.num_v()),
    _pvar(_richards_name_UO.richards_var_num(_var.number())),
 
    _porosity(getMaterialProperty<Real>("porosity")),
    _porosity_old(getMaterialProperty<Real>("porosity_old")),
 
    // in the following:  first get the userobject names that were inputted, then get the _pvar one
    // of these, then get the actual userobject that this corresponds to, then finally & gives
    // pointer to RichardsDensity (or whatever) object.
    _seff_UO(&getUserObjectByName<RichardsSeff>(
        getParam<std::vector<UserObjectName>>("seff_UO")[_pvar])),
    _sat_UO(
        &getUserObjectByName<RichardsSat>(getParam<std::vector<UserObjectName>>("sat_UO")[_pvar])),
    _density_UO(&getUserObjectByName<RichardsDensity>(
        getParam<std::vector<UserObjectName>>("density_UO")[_pvar]))
{
  _ps_at_nodes.resize(_num_p);
  _ps_old_at_nodes.resize(_num_p);
 
  for (unsigned int pnum = 0; pnum < _num_p; ++pnum)
  {
    _ps_at_nodes[pnum] = _richards_name_UO.nodal_var(pnum);
    _ps_old_at_nodes[pnum] = _richards_name_UO.nodal_var_old(pnum);
  }
 
  _dseff.resize(_num_p);
}

Member Function Documentation

computeQpJacobian()

Real RichardsLumpedMassChange::computeQpJacobian ( )

protectedvirtual

Definition at line 93 of file RichardsLumpedMassChange.C.

{
  if (_i != _j)
    return 0.0;
 
  const Real density = (*_density_UO).density((*_ps_at_nodes[_pvar])[_i]);
  const Real ddensity = (*_density_UO).ddensity((*_ps_at_nodes[_pvar])[_i]);
 
  const Real seff = (*_seff_UO).seff(_ps_at_nodes, _i);
  (*_seff_UO).dseff(_ps_at_nodes, _i, _dseff);
 
  const Real sat = (*_sat_UO).sat(seff);
  const Real dsat = (*_sat_UO).dsat(seff);
 
  const Real mass_prime = _porosity[_qp] * (ddensity * sat + density * _dseff[_pvar] * dsat);
 
  return _test[_i][_qp] * mass_prime / _dt;
}

computeQpOffDiagJacobian()

Real RichardsLumpedMassChange::computeQpOffDiagJacobian ( unsigned int  jvar )

protectedvirtual

Definition at line 113 of file RichardsLumpedMassChange.C.

{
  if (_richards_name_UO.not_richards_var(jvar))
    return 0.0;
  if (_i != _j)
    return 0.0;
  const unsigned int dvar = _richards_name_UO.richards_var_num(jvar);
 
  const Real density = (*_density_UO).density((*_ps_at_nodes[_pvar])[_i]);
 
  const Real seff = (*_seff_UO).seff(_ps_at_nodes, _i);
  (*_seff_UO).dseff(_ps_at_nodes, _i, _dseff);
 
  const Real dsat = (*_sat_UO).dsat(seff);
 
  const Real mass_prime = _porosity[_qp] * density * _dseff[dvar] * dsat;
 
  return _test[_i][_qp] * mass_prime / _dt;
}

computeQpResidual()

Real RichardsLumpedMassChange::computeQpResidual ( )

protectedvirtual

Definition at line 75 of file RichardsLumpedMassChange.C.

{
  // current values:
  const Real density = (*_density_UO).density((*_ps_at_nodes[_pvar])[_i]);
  const Real seff = (*_seff_UO).seff(_ps_at_nodes, _i);
  const Real sat = (*_sat_UO).sat(seff);
  const Real mass = _porosity[_qp] * density * sat;
 
  // old values:
  const Real density_old = (*_density_UO).density((*_ps_old_at_nodes[_pvar])[_i]);
  const Real seff_old = (*_seff_UO).seff(_ps_old_at_nodes, _i);
  const Real sat_old = (*_sat_UO).sat(seff_old);
  const Real mass_old = _porosity_old[_qp] * density_old * sat_old;
 
  return _test[_i][_qp] * (mass - mass_old) / _dt;
}

Member Data Documentation

_density_UO

const RichardsDensity* RichardsLumpedMassChange::_density_UO

protected

The userobject that computes fluid density (as a function of the porepressure)

Definition at line 74 of file RichardsLumpedMassChange.h.

_dseff

std::vector<Real> RichardsLumpedMassChange::_dseff

protected

holds nodal values of d(Seff)/dP_i

Definition at line 88 of file RichardsLumpedMassChange.h.

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

_num_p

unsigned int RichardsLumpedMassChange::_num_p

protected

number of richards variables

Definition at line 50 of file RichardsLumpedMassChange.h.

Referenced by RichardsLumpedMassChange().

_porosity

const MaterialProperty<Real>& RichardsLumpedMassChange::_porosity

protected

current value of the porosity

Definition at line 62 of file RichardsLumpedMassChange.h.

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

_porosity_old

const MaterialProperty<Real>& RichardsLumpedMassChange::_porosity_old

protected

value of the porosity at the start of the timestep

Definition at line 65 of file RichardsLumpedMassChange.h.

Referenced by computeQpResidual().

_ps_at_nodes

std::vector<const VariableValue *> RichardsLumpedMassChange::_ps_at_nodes

protected

Holds the values of pressures at all the nodes of the element Eg: _ps_at_nodes[_pvar] is a pointer to this variable's nodal porepressure values So: (*_ps_at_nodes[_pvar])[i] = _var.dofValues()[i].

Definition at line 82 of file RichardsLumpedMassChange.h.

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

_ps_old_at_nodes

std::vector<const VariableValue *> RichardsLumpedMassChange::_ps_old_at_nodes

protected

Holds the nodal values of pressures at timestep_begin, in same way as _ps_at_nodes.

Definition at line 85 of file RichardsLumpedMassChange.h.

Referenced by computeQpResidual(), and RichardsLumpedMassChange().

_pvar

unsigned int RichardsLumpedMassChange::_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 seff_UO, sat_UO, density_UO, etc.

Definition at line 59 of file RichardsLumpedMassChange.h.

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

_richards_name_UO

const RichardsVarNames& RichardsLumpedMassChange::_richards_name_UO

protected

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

Definition at line 47 of file RichardsLumpedMassChange.h.

Referenced by computeQpOffDiagJacobian(), and RichardsLumpedMassChange().

_sat_UO

const RichardsSat* RichardsLumpedMassChange::_sat_UO

protected

The userobject that computes saturation (as a function of effective saturation) for this variable.

Definition at line 71 of file RichardsLumpedMassChange.h.

_seff_UO

const RichardsSeff* RichardsLumpedMassChange::_seff_UO

protected

The userobject that computes effective saturation (as a function of porepressure(s)) for this variable.

Definition at line 68 of file RichardsLumpedMassChange.h.

---

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

• richards/include/kernels/RichardsLumpedMassChange.h
• richards/src/kernels/RichardsLumpedMassChange.C