Darcy advective flux for a fully-saturated, single-phase, multi-component fluid. More...

#include <PorousFlowFullySaturatedDarcyFlow.h>

Inheritance diagram for PorousFlowFullySaturatedDarcyFlow:

Public Member Functions
	PorousFlowFullySaturatedDarcyFlow (const InputParameters &parameters)

Protected Member Functions
virtual Real	mobility () const override
	The mobility of the fluid = mass_fraction * density / viscosity. More...

virtual Real	dmobility (unsigned pvar) const override
	The derivative of the mobility with respect to the PorousFlow variable pvar. More...

virtual Real	computeQpResidual () override

virtual Real	computeQpJacobian () override

virtual Real	computeQpOffDiagJacobian (unsigned int jvar) override

Protected Attributes
const MaterialProperty< std::vector< std::vector< Real > > > &	_mfrac
	mass fraction of the components in the phase More...

const MaterialProperty< std::vector< std::vector< std::vector< Real > > > > &	_dmfrac_dvar
	Derivative of mass fraction wrt wrt PorousFlow variables. More...

const unsigned int	_fluid_component
	The fluid component for this Kernel. More...

const bool	_multiply_by_density
	If true then the mobility contains the fluid density, otherwise it doesn't. More...

const MaterialProperty< RealTensorValue > &	_permeability
	Permeability of porous material. More...

const MaterialProperty< std::vector< RealTensorValue > > &	_dpermeability_dvar
	d(permeabiity)/d(PorousFlow variable) More...

const MaterialProperty< std::vector< std::vector< RealTensorValue > > > &	_dpermeability_dgradvar
	d(permeabiity)/d(grad(PorousFlow variable)) More...

const MaterialProperty< std::vector< Real > > &	_density
	Fluid density for each phase (at the qp) More...

const MaterialProperty< std::vector< std::vector< Real > > > &	_ddensity_dvar
	Derivative of the fluid density for each phase wrt PorousFlow variables (at the qp) More...

const MaterialProperty< std::vector< Real > > &	_viscosity
	Viscosity of the fluid at the qp. More...

const MaterialProperty< std::vector< std::vector< Real > > > &	_dviscosity_dvar
	Derivative of the fluid viscosity wrt PorousFlow variables. More...

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

const MaterialProperty< std::vector< RealGradient > > &	_grad_p
	Gradient of the pore pressure in each phase. More...

const MaterialProperty< std::vector< std::vector< Real > > > &	_dgrad_p_dgrad_var
	Derivative of Grad porepressure in each phase wrt grad(PorousFlow variables) More...

const MaterialProperty< std::vector< std::vector< RealGradient > > > &	_dgrad_p_dvar
	Derivative of Grad porepressure in each phase wrt PorousFlow variables. More...

const PorousFlowDictator &	_dictator
	PorousFlowDictator UserObject. More...

const RealVectorValue	_gravity
	Gravity pointing downwards. More...

const bool	_perm_derivs
	Flag to check whether permeabiity derivatives are non-zero. More...

Detailed Description

Darcy advective flux for a fully-saturated, single-phase, multi-component fluid.

No upwinding or relative-permeability is used.

Definition at line 24 of file PorousFlowFullySaturatedDarcyFlow.h.

Constructor & Destructor Documentation

◆ PorousFlowFullySaturatedDarcyFlow()

PorousFlowFullySaturatedDarcyFlow::PorousFlowFullySaturatedDarcyFlow ( const InputParameters & parameters )

Definition at line 26 of file PorousFlowFullySaturatedDarcyFlow.C.

   : PorousFlowFullySaturatedDarcyBase(parameters),
     _mfrac(getMaterialProperty<std::vector<std::vector<Real>>>("PorousFlow_mass_frac_qp")),
     _dmfrac_dvar(getMaterialProperty<std::vector<std::vector<std::vector<Real>>>>(
         "dPorousFlow_mass_frac_qp_dvar")),
     _fluid_component(getParam<unsigned int>("fluid_component"))
 {
   if (_fluid_component >= _dictator.numComponents())
     paramError(
         "fluid_component",
         "The Dictator proclaims that the maximum fluid component index in this simulation is ",
         _dictator.numComponents() - 1,
         " whereas you have used ",
         _fluid_component,
         ". Remember that indexing starts at 0. Happiness equals perfection.");
 }

Member Function Documentation

◆ computeQpJacobian()

Real PorousFlowFullySaturatedDarcyBase::computeQpJacobian ( )

overrideprotectedvirtualinherited

Definition at line 77 of file PorousFlowFullySaturatedDarcyBase.C.

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

◆ computeQpOffDiagJacobian()

Real PorousFlowFullySaturatedDarcyBase::computeQpOffDiagJacobian ( unsigned int jvar )

overrideprotectedvirtualinherited

Definition at line 83 of file PorousFlowFullySaturatedDarcyBase.C.

 {
   if (_dictator.notPorousFlowVariable(jvar))
     return 0.0;
  
   const unsigned ph = 0;
   const unsigned pvar = _dictator.porousFlowVariableNum(jvar);
  
   const Real mob = mobility();
   const Real dmob = dmobility(pvar) * _phi[_j][_qp];
  
   const RealVectorValue flow =
       _permeability[_qp] * (_grad_p[_qp][ph] - _density[_qp][ph] * _gravity);
  
   RealVectorValue dflow =
       _permeability[_qp] * (_grad_phi[_j][_qp] * _dgrad_p_dgrad_var[_qp][ph][pvar] -
                             _phi[_j][_qp] * _ddensity_dvar[_qp][ph][pvar] * _gravity);
   dflow += _permeability[_qp] * (_dgrad_p_dvar[_qp][ph][pvar] * _phi[_j][_qp]);
  
   if (_perm_derivs)
   {
     dflow += _dpermeability_dvar[_qp][pvar] * _phi[_j][_qp] *
              (_grad_p[_qp][ph] - _density[_qp][ph] * _gravity);
     for (unsigned int i = 0; i < LIBMESH_DIM; ++i)
       dflow += _dpermeability_dgradvar[_qp][i][pvar] * _grad_phi[_j][_qp](i) *
                (_grad_p[_qp][ph] - _density[_qp][ph] * _gravity);
   }
  
   return _grad_test[_i][_qp] * (dmob * flow + mob * dflow);
 }

Referenced by PorousFlowFullySaturatedDarcyBase::computeQpJacobian().

◆ computeQpResidual()

Real PorousFlowFullySaturatedDarcyBase::computeQpResidual ( )

overrideprotectedvirtualinherited

Definition at line 67 of file PorousFlowFullySaturatedDarcyBase.C.

 {
   const unsigned ph = 0;
   const Real mob = mobility();
   const RealVectorValue flow =
       _permeability[_qp] * (_grad_p[_qp][ph] - _density[_qp][ph] * _gravity);
   return _grad_test[_i][_qp] * mob * flow;
 }

◆ dmobility()

Real PorousFlowFullySaturatedDarcyFlow::dmobility ( unsigned pvar ) const

overrideprotectedvirtual

The derivative of the mobility with respect to the PorousFlow variable pvar.

Parameters

pvar	Take the derivative with respect to this PorousFlow variable

Reimplemented from PorousFlowFullySaturatedDarcyBase.

Definition at line 52 of file PorousFlowFullySaturatedDarcyFlow.C.

 {
   const unsigned ph = 0;
   const Real darcy_mob = PorousFlowFullySaturatedDarcyBase::mobility();
   const Real ddarcy_mob = PorousFlowFullySaturatedDarcyBase::dmobility(pvar);
   return _dmfrac_dvar[_qp][ph][_fluid_component][pvar] * darcy_mob +
          _mfrac[_qp][ph][_fluid_component] * ddarcy_mob;
 }

◆ mobility()

Real PorousFlowFullySaturatedDarcyFlow::mobility ( ) const

overrideprotectedvirtual

The mobility of the fluid = mass_fraction * density / viscosity.

Reimplemented from PorousFlowFullySaturatedDarcyBase.

Definition at line 45 of file PorousFlowFullySaturatedDarcyFlow.C.

 {
   const unsigned ph = 0;
   return _mfrac[_qp][ph][_fluid_component] * PorousFlowFullySaturatedDarcyBase::mobility();
 }

Member Data Documentation

◆ _ddensity_dvar

const MaterialProperty<std::vector<std::vector<Real> > >& PorousFlowFullySaturatedDarcyBase::_ddensity_dvar

protectedinherited

Derivative of the fluid density for each phase wrt PorousFlow variables (at the qp)

Definition at line 62 of file PorousFlowFullySaturatedDarcyBase.h.

Referenced by PorousFlowFullySaturatedDarcyBase::computeQpOffDiagJacobian(), and PorousFlowFullySaturatedDarcyBase::dmobility().

◆ _density

const MaterialProperty<std::vector<Real> >& PorousFlowFullySaturatedDarcyBase::_density

protectedinherited

Fluid density for each phase (at the qp)

Definition at line 59 of file PorousFlowFullySaturatedDarcyBase.h.

Referenced by PorousFlowFullySaturatedDarcyBase::computeQpOffDiagJacobian(), PorousFlowFullySaturatedDarcyBase::computeQpResidual(), PorousFlowFullySaturatedDarcyBase::dmobility(), and PorousFlowFullySaturatedDarcyBase::mobility().

◆ _dgrad_p_dgrad_var

const MaterialProperty<std::vector<std::vector<Real> > >& PorousFlowFullySaturatedDarcyBase::_dgrad_p_dgrad_var

protectedinherited

Derivative of Grad porepressure in each phase wrt grad(PorousFlow variables)

Definition at line 77 of file PorousFlowFullySaturatedDarcyBase.h.

Referenced by PorousFlowFullySaturatedDarcyBase::computeQpOffDiagJacobian().

◆ _dgrad_p_dvar

const MaterialProperty<std::vector<std::vector<RealGradient> > >& PorousFlowFullySaturatedDarcyBase::_dgrad_p_dvar

protectedinherited

Derivative of Grad porepressure in each phase wrt PorousFlow variables.

Definition at line 80 of file PorousFlowFullySaturatedDarcyBase.h.

Referenced by PorousFlowFullySaturatedDarcyBase::computeQpOffDiagJacobian().

◆ _dictator

const PorousFlowDictator& PorousFlowFullySaturatedDarcyBase::_dictator

protectedinherited

PorousFlowDictator UserObject.

Definition at line 83 of file PorousFlowFullySaturatedDarcyBase.h.

Referenced by PorousFlowFullySaturatedDarcyBase::computeQpOffDiagJacobian(), PorousFlowFullySaturatedDarcyBase::PorousFlowFullySaturatedDarcyBase(), and PorousFlowFullySaturatedDarcyFlow().

◆ _dmfrac_dvar

const MaterialProperty<std::vector<std::vector<std::vector<Real> > > >& PorousFlowFullySaturatedDarcyFlow::_dmfrac_dvar

protected

Derivative of mass fraction wrt wrt PorousFlow variables.

Definition at line 45 of file PorousFlowFullySaturatedDarcyFlow.h.

Referenced by dmobility().

◆ _dpermeability_dgradvar

const MaterialProperty<std::vector<std::vector<RealTensorValue> > >& PorousFlowFullySaturatedDarcyBase::_dpermeability_dgradvar

protectedinherited

d(permeabiity)/d(grad(PorousFlow variable))

Definition at line 56 of file PorousFlowFullySaturatedDarcyBase.h.

Referenced by PorousFlowFullySaturatedDarcyBase::computeQpOffDiagJacobian().

◆ _dpermeability_dvar

const MaterialProperty<std::vector<RealTensorValue> >& PorousFlowFullySaturatedDarcyBase::_dpermeability_dvar

protectedinherited

d(permeabiity)/d(PorousFlow variable)

Definition at line 53 of file PorousFlowFullySaturatedDarcyBase.h.

Referenced by PorousFlowFullySaturatedDarcyBase::computeQpOffDiagJacobian().

◆ _dviscosity_dvar

const MaterialProperty<std::vector<std::vector<Real> > >& PorousFlowFullySaturatedDarcyBase::_dviscosity_dvar

protectedinherited

Derivative of the fluid viscosity wrt PorousFlow variables.

Definition at line 68 of file PorousFlowFullySaturatedDarcyBase.h.

Referenced by PorousFlowFullySaturatedDarcyBase::dmobility().

◆ _fluid_component

const unsigned int PorousFlowFullySaturatedDarcyFlow::_fluid_component

protected

The fluid component for this Kernel.

Definition at line 48 of file PorousFlowFullySaturatedDarcyFlow.h.

Referenced by dmobility(), mobility(), and PorousFlowFullySaturatedDarcyFlow().

◆ _grad_p

const MaterialProperty<std::vector<RealGradient> >& PorousFlowFullySaturatedDarcyBase::_grad_p

protectedinherited

Gradient of the pore pressure in each phase.

Definition at line 74 of file PorousFlowFullySaturatedDarcyBase.h.

Referenced by PorousFlowFullySaturatedDarcyBase::computeQpOffDiagJacobian(), and PorousFlowFullySaturatedDarcyBase::computeQpResidual().

◆ _gravity

const RealVectorValue PorousFlowFullySaturatedDarcyBase::_gravity

protectedinherited

Gravity pointing downwards.

Definition at line 86 of file PorousFlowFullySaturatedDarcyBase.h.

Referenced by PorousFlowFullySaturatedDarcyBase::computeQpOffDiagJacobian(), and PorousFlowFullySaturatedDarcyBase::computeQpResidual().

◆ _mfrac

const MaterialProperty<std::vector<std::vector<Real> > >& PorousFlowFullySaturatedDarcyFlow::_mfrac

protected

mass fraction of the components in the phase

Definition at line 42 of file PorousFlowFullySaturatedDarcyFlow.h.

Referenced by dmobility(), and mobility().

◆ _multiply_by_density

const bool PorousFlowFullySaturatedDarcyBase::_multiply_by_density

protectedinherited

If true then the mobility contains the fluid density, otherwise it doesn't.

Definition at line 47 of file PorousFlowFullySaturatedDarcyBase.h.

Referenced by PorousFlowFullySaturatedDarcyBase::dmobility(), and PorousFlowFullySaturatedDarcyBase::mobility().

◆ _perm_derivs

const bool PorousFlowFullySaturatedDarcyBase::_perm_derivs

protectedinherited

Flag to check whether permeabiity derivatives are non-zero.

Definition at line 89 of file PorousFlowFullySaturatedDarcyBase.h.

Referenced by PorousFlowFullySaturatedDarcyBase::computeQpOffDiagJacobian().

◆ _permeability

const MaterialProperty<RealTensorValue>& PorousFlowFullySaturatedDarcyBase::_permeability

protectedinherited

Permeability of porous material.

Definition at line 50 of file PorousFlowFullySaturatedDarcyBase.h.

Referenced by PorousFlowFullySaturatedDarcyBase::computeQpOffDiagJacobian(), and PorousFlowFullySaturatedDarcyBase::computeQpResidual().

◆ _pp

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

protectedinherited

Quadpoint pore pressure in each phase.

Definition at line 71 of file PorousFlowFullySaturatedDarcyBase.h.

◆ _viscosity

const MaterialProperty<std::vector<Real> >& PorousFlowFullySaturatedDarcyBase::_viscosity

protectedinherited

Viscosity of the fluid at the qp.

Definition at line 65 of file PorousFlowFullySaturatedDarcyBase.h.

Referenced by PorousFlowFullySaturatedDarcyBase::dmobility(), and PorousFlowFullySaturatedDarcyBase::mobility().

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

porous_flow/include/kernels/PorousFlowFullySaturatedDarcyFlow.h
porous_flow/src/kernels/PorousFlowFullySaturatedDarcyFlow.C

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PorousFlowFullySaturatedDarcyFlow()

Member Function Documentation

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

◆ dmobility()

◆ mobility()

Member Data Documentation

◆ _ddensity_dvar

◆ _density

◆ _dgrad_p_dgrad_var

◆ _dgrad_p_dvar

◆ _dictator

◆ _dmfrac_dvar

◆ _dpermeability_dgradvar

◆ _dpermeability_dvar

◆ _dviscosity_dvar

◆ _fluid_component

◆ _grad_p

◆ _gravity

◆ _mfrac

◆ _multiply_by_density

◆ _perm_derivs

◆ _permeability

◆ _pp

◆ _viscosity