Kernel = mass_component * d(volumetric_strain)/dt where mass_component = porosity*sum_phases(density_phase*saturation_phase*massfrac_phase^component) which is lumped to the nodes. More...

#include <PorousFlowMassVolumetricExpansion.h>

Inheritance diagram for PorousFlowMassVolumetricExpansion:

[legend]

Public Member Functions
	PorousFlowMassVolumetricExpansion (const InputParameters &parameters)

Protected Member Functions
virtual Real	computeQpResidual () override

virtual Real	computeQpJacobian () override

virtual Real	computeQpOffDiagJacobian (unsigned int jvar) override

Real	computedMassQpJac (unsigned int jvar) const
	Derivative of mass part of the residual with respect to the Variable with variable number jvar. More...

Real	computedVolQpJac (unsigned int jvar) const
	Derivative of volumetric-strain part of the residual with respect to the Variable with variable number jvar. More...

Protected Attributes
const unsigned int	_fluid_component
	The fluid component index. More...

const PorousFlowDictator &	_dictator
	PorousFlowDictator UserObject. More...

const bool	_var_is_porflow_var
	Whether the Variable for this Kernel is a PorousFlow variable according to the Dictator. More...

unsigned int	_ndisp
	Number of displacement variables. More...

std::vector< unsigned int >	_disp_var_num
	Variable number of the displacements variables. More...

const bool	_strain_at_nearest_qp
	Whether the porosity uses the volumetric strain at the closest quadpoint. More...

const MaterialProperty< Real > &	_porosity
	Porosity. More...

const MaterialProperty< std::vector< Real > > &	_dporosity_dvar
	d(porosity)/d(PorousFlow variable) More...

const MaterialProperty< std::vector< RealGradient > > &	_dporosity_dgradvar
	d(porosity)/d(grad PorousFlow variable) More...

const MaterialProperty< unsigned int > *const	_nearest_qp
	The nearest qp to the node. More...

const MaterialProperty< std::vector< Real > > &	_fluid_density
	Fluid density. More...

const MaterialProperty< std::vector< std::vector< Real > > > &	_dfluid_density_dvar
	d(fluid density)/d(PorousFlow variable) More...

const MaterialProperty< std::vector< Real > > &	_fluid_saturation
	Fluid saturation. More...

const MaterialProperty< std::vector< std::vector< Real > > > &	_dfluid_saturation_dvar
	d(fluid saturation)/d(PorousFlow variable) More...

const MaterialProperty< std::vector< std::vector< Real > > > &	_mass_frac
	Mass fraction. More...

const MaterialProperty< std::vector< std::vector< std::vector< Real > > > > &	_dmass_frac_dvar
	d(mass fraction)/d(PorousFlow variable) More...

const MaterialProperty< Real > &	_strain_rate_qp
	Strain rate. More...

const MaterialProperty< std::vector< RealGradient > > &	_dstrain_rate_qp_dvar
	d(strain rate)/d(PorousFlow variable) More...

Detailed Description

Kernel = mass_component * d(volumetric_strain)/dt where mass_component = porosity*sum_phases(density_phase*saturation_phase*massfrac_phase^component) which is lumped to the nodes.

Definition at line 27 of file PorousFlowMassVolumetricExpansion.h.

Constructor & Destructor Documentation

◆ PorousFlowMassVolumetricExpansion()

PorousFlowMassVolumetricExpansion::PorousFlowMassVolumetricExpansion ( const InputParameters & parameters )

Definition at line 36 of file PorousFlowMassVolumetricExpansion.C.

   : TimeKernel(parameters),
     _fluid_component(getParam<unsigned int>("fluid_component")),
     _dictator(getUserObject<PorousFlowDictator>("PorousFlowDictator")),
     _var_is_porflow_var(!_dictator.notPorousFlowVariable(_var.number())),
     _strain_at_nearest_qp(getParam<bool>("strain_at_nearest_qp")),
     _porosity(getMaterialProperty<Real>("PorousFlow_porosity_nodal")),
     _dporosity_dvar(getMaterialProperty<std::vector<Real>>("dPorousFlow_porosity_nodal_dvar")),
     _dporosity_dgradvar(
         getMaterialProperty<std::vector<RealGradient>>("dPorousFlow_porosity_nodal_dgradvar")),
     _nearest_qp(_strain_at_nearest_qp
                     ? &getMaterialProperty<unsigned int>("PorousFlow_nearestqp_nodal")
                     : nullptr),
     _fluid_density(getMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_density_nodal")),
     _dfluid_density_dvar(getMaterialProperty<std::vector<std::vector<Real>>>(
         "dPorousFlow_fluid_phase_density_nodal_dvar")),
     _fluid_saturation(getMaterialProperty<std::vector<Real>>("PorousFlow_saturation_nodal")),
     _dfluid_saturation_dvar(
         getMaterialProperty<std::vector<std::vector<Real>>>("dPorousFlow_saturation_nodal_dvar")),
     _mass_frac(getMaterialProperty<std::vector<std::vector<Real>>>("PorousFlow_mass_frac_nodal")),
     _dmass_frac_dvar(getMaterialProperty<std::vector<std::vector<std::vector<Real>>>>(
         "dPorousFlow_mass_frac_nodal_dvar")),
     _strain_rate_qp(getMaterialProperty<Real>("PorousFlow_volumetric_strain_rate_qp")),
     _dstrain_rate_qp_dvar(getMaterialProperty<std::vector<RealGradient>>(
         "dPorousFlow_volumetric_strain_rate_qp_dvar"))
 {
   if (_fluid_component >= _dictator.numComponents())
     mooseError("The Dictator proclaims that the number of components in this simulation is ",
                _dictator.numComponents(),
                " whereas you have used the Kernel PorousFlowComponetMassVolumetricExpansion with "
                "component = ",
                _fluid_component,
                ".  The Dictator is watching you");
 }

Member Function Documentation

◆ computedMassQpJac()

Real PorousFlowMassVolumetricExpansion::computedMassQpJac ( unsigned int jvar ) const

protected

Derivative of mass part of the residual with respect to the Variable with variable number jvar.

This is used by both computeQpJacobian and computeQpOffDiagJacobian

Parameters

jvar	take the derivative of the mass part of the residual wrt this variable number

Definition at line 126 of file PorousFlowMassVolumetricExpansion.C.

 {
   if (_dictator.notPorousFlowVariable(jvar))
     return 0.0;
  
   const unsigned int pvar = _dictator.porousFlowVariableNum(jvar);
   const unsigned nearest_qp = (_strain_at_nearest_qp ? (*_nearest_qp)[_i] : _i);
  
   const unsigned int num_phases = _fluid_density[_i].size();
   Real dmass = 0.0;
   for (unsigned ph = 0; ph < num_phases; ++ph)
     dmass += _fluid_density[_i][ph] * _fluid_saturation[_i][ph] *
              _mass_frac[_i][ph][_fluid_component] * _dporosity_dgradvar[_i][pvar] *
              _grad_phi[_j][nearest_qp];
  
   if (_i != _j)
     return _test[_i][_qp] * dmass * _strain_rate_qp[_qp];
  
   for (unsigned ph = 0; ph < num_phases; ++ph)
   {
     dmass += _dfluid_density_dvar[_i][ph][pvar] * _fluid_saturation[_i][ph] *
              _mass_frac[_i][ph][_fluid_component] * _porosity[_i];
     dmass += _fluid_density[_i][ph] * _dfluid_saturation_dvar[_i][ph][pvar] *
              _mass_frac[_i][ph][_fluid_component] * _porosity[_i];
     dmass += _fluid_density[_i][ph] * _fluid_saturation[_i][ph] *
              _dmass_frac_dvar[_i][ph][_fluid_component][pvar] * _porosity[_i];
     dmass += _fluid_density[_i][ph] * _fluid_saturation[_i][ph] *
              _mass_frac[_i][ph][_fluid_component] * _dporosity_dvar[_i][pvar];
   }
  
   return _test[_i][_qp] * dmass * _strain_rate_qp[_qp];
 }

Referenced by computeQpJacobian(), and computeQpOffDiagJacobian().

◆ computedVolQpJac()

Real PorousFlowMassVolumetricExpansion::computedVolQpJac ( unsigned int jvar ) const

protected

Derivative of volumetric-strain part of the residual with respect to the Variable with variable number jvar.

This is used by both computeQpJacobian and computeQpOffDiagJacobian

Parameters

jvar	take the derivative of the volumetric-strain part of the residual wrt this variable number

Definition at line 108 of file PorousFlowMassVolumetricExpansion.C.

 {
   if (_dictator.notPorousFlowVariable(jvar))
     return 0.0;
  
   const unsigned int pvar = _dictator.porousFlowVariableNum(jvar);
  
   unsigned int num_phases = _fluid_density[_i].size();
   Real mass = 0.0;
   for (unsigned ph = 0; ph < num_phases; ++ph)
     mass +=
         _fluid_density[_i][ph] * _fluid_saturation[_i][ph] * _mass_frac[_i][ph][_fluid_component];
  
   Real dvol = _dstrain_rate_qp_dvar[_qp][pvar] * _grad_phi[_j][_qp];
  
   return _test[_i][_qp] * mass * _porosity[_i] * dvol;
 }

Referenced by computeQpJacobian(), and computeQpOffDiagJacobian().

◆ computeQpJacobian()

Real PorousFlowMassVolumetricExpansion::computeQpJacobian ( )

overrideprotectedvirtual

Definition at line 96 of file PorousFlowMassVolumetricExpansion.C.

 {
   return computedMassQpJac(_var.number()) + computedVolQpJac(_var.number());
 }

◆ computeQpOffDiagJacobian()

Real PorousFlowMassVolumetricExpansion::computeQpOffDiagJacobian ( unsigned int jvar )

overrideprotectedvirtual

Definition at line 102 of file PorousFlowMassVolumetricExpansion.C.

 {
   return computedMassQpJac(jvar) + computedVolQpJac(jvar);
 }

◆ computeQpResidual()

Real PorousFlowMassVolumetricExpansion::computeQpResidual ( )

overrideprotectedvirtual

Definition at line 73 of file PorousFlowMassVolumetricExpansion.C.

 {
   mooseAssert(_fluid_component < _mass_frac[_i][0].size(),
               "PorousFlowMassVolumetricExpansion: fluid_component is given as "
                   << _fluid_component
                   << " which must be less than the number of fluid components described by the "
                      "mass-fraction matrix, which is "
                   << _mass_frac[_i][0].size());
   unsigned int num_phases = _fluid_density[_i].size();
   mooseAssert(num_phases == _fluid_saturation[_i].size(),
               "PorousFlowMassVolumetricExpansion: Size of fluid density = "
                   << num_phases << " size of fluid saturation = " << _fluid_saturation[_i].size()
                   << " but both these must be equal to the number of phases in the system");
  
   Real mass = 0.0;
   for (unsigned ph = 0; ph < num_phases; ++ph)
     mass +=
         _fluid_density[_i][ph] * _fluid_saturation[_i][ph] * _mass_frac[_i][ph][_fluid_component];
  
   return _test[_i][_qp] * mass * _porosity[_i] * _strain_rate_qp[_qp];
 }

Member Data Documentation

◆ _dfluid_density_dvar

const MaterialProperty<std::vector<std::vector<Real> > >& PorousFlowMassVolumetricExpansion::_dfluid_density_dvar

protected

d(fluid density)/d(PorousFlow variable)

Definition at line 71 of file PorousFlowMassVolumetricExpansion.h.

Referenced by computedMassQpJac().

◆ _dfluid_saturation_dvar

const MaterialProperty<std::vector<std::vector<Real> > >& PorousFlowMassVolumetricExpansion::_dfluid_saturation_dvar

protected

d(fluid saturation)/d(PorousFlow variable)

Definition at line 77 of file PorousFlowMassVolumetricExpansion.h.

Referenced by computedMassQpJac().

◆ _dictator

const PorousFlowDictator& PorousFlowMassVolumetricExpansion::_dictator

protected

PorousFlowDictator UserObject.

Definition at line 41 of file PorousFlowMassVolumetricExpansion.h.

Referenced by computedMassQpJac(), computedVolQpJac(), and PorousFlowMassVolumetricExpansion().

◆ _disp_var_num

std::vector<unsigned int> PorousFlowMassVolumetricExpansion::_disp_var_num

protected

Variable number of the displacements variables.

Definition at line 50 of file PorousFlowMassVolumetricExpansion.h.

◆ _dmass_frac_dvar

const MaterialProperty<std::vector<std::vector<std::vector<Real> > > >& PorousFlowMassVolumetricExpansion::_dmass_frac_dvar

protected

d(mass fraction)/d(PorousFlow variable)

Definition at line 83 of file PorousFlowMassVolumetricExpansion.h.

Referenced by computedMassQpJac().

◆ _dporosity_dgradvar

const MaterialProperty<std::vector<RealGradient> >& PorousFlowMassVolumetricExpansion::_dporosity_dgradvar

protected

d(porosity)/d(grad PorousFlow variable)

Definition at line 62 of file PorousFlowMassVolumetricExpansion.h.

Referenced by computedMassQpJac().

◆ _dporosity_dvar

const MaterialProperty<std::vector<Real> >& PorousFlowMassVolumetricExpansion::_dporosity_dvar

protected

d(porosity)/d(PorousFlow variable)

Definition at line 59 of file PorousFlowMassVolumetricExpansion.h.

Referenced by computedMassQpJac().

◆ _dstrain_rate_qp_dvar

const MaterialProperty<std::vector<RealGradient> >& PorousFlowMassVolumetricExpansion::_dstrain_rate_qp_dvar

protected

d(strain rate)/d(PorousFlow variable)

Definition at line 89 of file PorousFlowMassVolumetricExpansion.h.

Referenced by computedVolQpJac().

◆ _fluid_component

const unsigned int PorousFlowMassVolumetricExpansion::_fluid_component

protected

The fluid component index.

Definition at line 38 of file PorousFlowMassVolumetricExpansion.h.

Referenced by computedMassQpJac(), computedVolQpJac(), computeQpResidual(), and PorousFlowMassVolumetricExpansion().

◆ _fluid_density

const MaterialProperty<std::vector<Real> >& PorousFlowMassVolumetricExpansion::_fluid_density

protected

Fluid density.

Definition at line 68 of file PorousFlowMassVolumetricExpansion.h.

Referenced by computedMassQpJac(), computedVolQpJac(), and computeQpResidual().

◆ _fluid_saturation

const MaterialProperty<std::vector<Real> >& PorousFlowMassVolumetricExpansion::_fluid_saturation

protected

Fluid saturation.

Definition at line 74 of file PorousFlowMassVolumetricExpansion.h.

Referenced by computedMassQpJac(), computedVolQpJac(), and computeQpResidual().

◆ _mass_frac

const MaterialProperty<std::vector<std::vector<Real> > >& PorousFlowMassVolumetricExpansion::_mass_frac

protected

Mass fraction.

Definition at line 80 of file PorousFlowMassVolumetricExpansion.h.

Referenced by computedMassQpJac(), computedVolQpJac(), and computeQpResidual().

◆ _ndisp

unsigned int PorousFlowMassVolumetricExpansion::_ndisp

protected

Number of displacement variables.

Definition at line 47 of file PorousFlowMassVolumetricExpansion.h.

◆ _nearest_qp

const MaterialProperty<unsigned int>* const PorousFlowMassVolumetricExpansion::_nearest_qp

protected

The nearest qp to the node.

Definition at line 65 of file PorousFlowMassVolumetricExpansion.h.

◆ _porosity

const MaterialProperty<Real>& PorousFlowMassVolumetricExpansion::_porosity

protected

Porosity.

Definition at line 56 of file PorousFlowMassVolumetricExpansion.h.

Referenced by computedMassQpJac(), computedVolQpJac(), and computeQpResidual().

◆ _strain_at_nearest_qp

const bool PorousFlowMassVolumetricExpansion::_strain_at_nearest_qp

protected

Whether the porosity uses the volumetric strain at the closest quadpoint.

Definition at line 53 of file PorousFlowMassVolumetricExpansion.h.

Referenced by computedMassQpJac().

◆ _strain_rate_qp

const MaterialProperty<Real>& PorousFlowMassVolumetricExpansion::_strain_rate_qp

protected

Strain rate.

Definition at line 86 of file PorousFlowMassVolumetricExpansion.h.

Referenced by computedMassQpJac(), and computeQpResidual().

◆ _var_is_porflow_var

const bool PorousFlowMassVolumetricExpansion::_var_is_porflow_var

protected

Whether the Variable for this Kernel is a PorousFlow variable according to the Dictator.

Definition at line 44 of file PorousFlowMassVolumetricExpansion.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PorousFlowMassVolumetricExpansion()

Member Function Documentation

◆ computedMassQpJac()

◆ computedVolQpJac()

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

Member Data Documentation

◆ _dfluid_density_dvar

◆ _dfluid_saturation_dvar

◆ _dictator

◆ _disp_var_num

◆ _dmass_frac_dvar

◆ _dporosity_dgradvar

◆ _dporosity_dvar

◆ _dstrain_rate_qp_dvar

◆ _fluid_component

◆ _fluid_density

◆ _fluid_saturation

◆ _mass_frac

◆ _ndisp

◆ _nearest_qp

◆ _porosity

◆ _strain_at_nearest_qp

◆ _strain_rate_qp

◆ _var_is_porflow_var