Kernel = _decay_rate * masscomponent where mass_component = porosity*sum_phases(density_phase*saturation_phase*massfrac_phase^component) It is lumped to the nodes. More...

#include <PorousFlowMassRadioactiveDecay.h>

Inheritance diagram for PorousFlowMassRadioactiveDecay:

[legend]

Public Member Functions
	PorousFlowMassRadioactiveDecay (const InputParameters &parameters)

Protected Member Functions
virtual Real	computeQpResidual () override

virtual Real	computeQpJacobian () override

virtual Real	computeQpOffDiagJacobian (unsigned int jvar) override

Real	computeQpJac (unsigned int pvar)
	Derivative of residual with respect to PorousFlow variable number pvar This is used by both computeQpJacobian and computeQpOffDiagJacobian. More...

Protected Attributes
const Real	_decay_rate
	The decay rate. More...

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...

const unsigned int	_num_phases
	Number of fluid phases. More...

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

const MaterialProperty< Real > &	_porosity
	Porosity at the nodes, but it can depend on grad(variables) which are actually evaluated at the qps. More...

const MaterialProperty< std::vector< Real > > &	_dporosity_dvar
	d(porosity)/d(PorousFlow variable) - these derivatives will be wrt variables at the nodes More...

const MaterialProperty< std::vector< RealGradient > > &	_dporosity_dgradvar
	d(porosity)/d(grad PorousFlow variable) - remember these derivatives will be wrt grad(vars) at qps More...

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

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

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

const MaterialProperty< std::vector< Real > > &	_fluid_saturation_nodal
	Nodal fluid saturation. More...

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

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

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

Detailed Description

Kernel = _decay_rate * masscomponent where mass_component = porosity*sum_phases(density_phase*saturation_phase*massfrac_phase^component) It is lumped to the nodes.

Definition at line 26 of file PorousFlowMassRadioactiveDecay.h.

Constructor & Destructor Documentation

◆ PorousFlowMassRadioactiveDecay()

PorousFlowMassRadioactiveDecay::PorousFlowMassRadioactiveDecay ( const InputParameters & parameters )

Definition at line 42 of file PorousFlowMassRadioactiveDecay.C.

   : TimeKernel(parameters),
     _decay_rate(getParam<Real>("decay_rate")),
     _fluid_component(getParam<unsigned int>("fluid_component")),
     _dictator(getUserObject<PorousFlowDictator>("PorousFlowDictator")),
     _var_is_porflow_var(_dictator.isPorousFlowVariable(_var.number())),
     _num_phases(_dictator.numPhases()),
     _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_nodal(getMaterialProperty<std::vector<Real>>("PorousFlow_saturation_nodal")),
     _dfluid_saturation_nodal_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"))
 {
   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. The Dictator does not take such mistakes lightly.");
 }

Member Function Documentation

◆ computeQpJac()

Real PorousFlowMassRadioactiveDecay::computeQpJac ( unsigned int pvar )

protected

Derivative of residual with respect to PorousFlow variable number pvar This is used by both computeQpJacobian and computeQpOffDiagJacobian.

Parameters

pvar	take the derivative of the residual wrt this PorousFlow variable

Definition at line 107 of file PorousFlowMassRadioactiveDecay.C.

 {
   const unsigned nearest_qp = (_strain_at_nearest_qp ? (*_nearest_qp)[_i] : _i);
  
   // porosity is dependent on variables that are lumped to the nodes,
   // but it can depend on the gradient
   // of variables, which are NOT lumped to the nodes, hence:
   Real dmass = 0.0;
   for (unsigned ph = 0; ph < _num_phases; ++ph)
     dmass += _fluid_density[_i][ph] * _fluid_saturation_nodal[_i][ph] *
              _mass_frac[_i][ph][_fluid_component] * _dporosity_dgradvar[_i][pvar] *
              _grad_phi[_j][nearest_qp];
  
   if (_i != _j)
     return _test[_i][_qp] * _decay_rate * dmass;
  
   // As the fluid mass is lumped to the nodes, only non-zero terms are for _i==_j
   for (unsigned ph = 0; ph < _num_phases; ++ph)
   {
     dmass += _dfluid_density_dvar[_i][ph][pvar] * _fluid_saturation_nodal[_i][ph] *
              _mass_frac[_i][ph][_fluid_component] * _porosity[_i];
     dmass += _fluid_density[_i][ph] * _dfluid_saturation_nodal_dvar[_i][ph][pvar] *
              _mass_frac[_i][ph][_fluid_component] * _porosity[_i];
     dmass += _fluid_density[_i][ph] * _fluid_saturation_nodal[_i][ph] *
              _dmass_frac_dvar[_i][ph][_fluid_component][pvar] * _porosity[_i];
     dmass += _fluid_density[_i][ph] * _fluid_saturation_nodal[_i][ph] *
              _mass_frac[_i][ph][_fluid_component] * _dporosity_dvar[_i][pvar];
   }
   return _test[_i][_qp] * _decay_rate * dmass;
 }

Referenced by computeQpJacobian(), and computeQpOffDiagJacobian().

◆ computeQpJacobian()

Real PorousFlowMassRadioactiveDecay::computeQpJacobian ( )

overrideprotectedvirtual

Definition at line 89 of file PorousFlowMassRadioactiveDecay.C.

 {
   // If the variable is not a PorousFlow variable (very unusual), the diag Jacobian terms are 0
   if (!_var_is_porflow_var)
     return 0.0;
   return computeQpJac(_dictator.porousFlowVariableNum(_var.number()));
 }

◆ computeQpOffDiagJacobian()

Real PorousFlowMassRadioactiveDecay::computeQpOffDiagJacobian ( unsigned int jvar )

overrideprotectedvirtual

Definition at line 98 of file PorousFlowMassRadioactiveDecay.C.

 {
   // If the variable is not a PorousFlow variable, the OffDiag Jacobian terms are 0
   if (_dictator.notPorousFlowVariable(jvar))
     return 0.0;
   return computeQpJac(_dictator.porousFlowVariableNum(jvar));
 }

◆ computeQpResidual()

Real PorousFlowMassRadioactiveDecay::computeQpResidual ( )

overrideprotectedvirtual

Definition at line 78 of file PorousFlowMassRadioactiveDecay.C.

 {
   Real mass = 0.0;
   for (unsigned ph = 0; ph < _num_phases; ++ph)
     mass += _fluid_density[_i][ph] * _fluid_saturation_nodal[_i][ph] *
             _mass_frac[_i][ph][_fluid_component];
  
   return _test[_i][_qp] * _decay_rate * _porosity[_i] * mass;
 }

Member Data Documentation

◆ _decay_rate

const Real PorousFlowMassRadioactiveDecay::_decay_rate

protected

The decay rate.

Definition at line 37 of file PorousFlowMassRadioactiveDecay.h.

Referenced by computeQpJac(), and computeQpResidual().

◆ _dfluid_density_dvar

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

protected

d(nodal fluid density)/d(PorousFlow variable)

Definition at line 70 of file PorousFlowMassRadioactiveDecay.h.

Referenced by computeQpJac().

◆ _dfluid_saturation_nodal_dvar

const MaterialProperty<std::vector<std::vector<Real> > >& PorousFlowMassRadioactiveDecay::_dfluid_saturation_nodal_dvar

protected

d(nodal fluid saturation)/d(PorousFlow variable)

Definition at line 76 of file PorousFlowMassRadioactiveDecay.h.

Referenced by computeQpJac().

◆ _dictator

const PorousFlowDictator& PorousFlowMassRadioactiveDecay::_dictator

protected

PorousFlowDictator UserObject.

Definition at line 43 of file PorousFlowMassRadioactiveDecay.h.

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

◆ _dmass_frac_dvar

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

protected

d(nodal mass fraction)/d(PorousFlow variable)

Definition at line 82 of file PorousFlowMassRadioactiveDecay.h.

Referenced by computeQpJac().

◆ _dporosity_dgradvar

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

protected

d(porosity)/d(grad PorousFlow variable) - remember these derivatives will be wrt grad(vars) at qps

Definition at line 61 of file PorousFlowMassRadioactiveDecay.h.

Referenced by computeQpJac().

◆ _dporosity_dvar

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

protected

d(porosity)/d(PorousFlow variable) - these derivatives will be wrt variables at the nodes

Definition at line 58 of file PorousFlowMassRadioactiveDecay.h.

Referenced by computeQpJac().

◆ _fluid_component

const unsigned int PorousFlowMassRadioactiveDecay::_fluid_component

protected

The fluid component index.

Definition at line 40 of file PorousFlowMassRadioactiveDecay.h.

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

◆ _fluid_density

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

protected

Nodal fluid density.

Definition at line 67 of file PorousFlowMassRadioactiveDecay.h.

Referenced by computeQpJac(), and computeQpResidual().

◆ _fluid_saturation_nodal

const MaterialProperty<std::vector<Real> >& PorousFlowMassRadioactiveDecay::_fluid_saturation_nodal

protected

Nodal fluid saturation.

Definition at line 73 of file PorousFlowMassRadioactiveDecay.h.

Referenced by computeQpJac(), and computeQpResidual().

◆ _mass_frac

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

protected

Nodal mass fraction.

Definition at line 79 of file PorousFlowMassRadioactiveDecay.h.

Referenced by computeQpJac(), and computeQpResidual().

◆ _nearest_qp

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

protected

The nearest qp to the node.

Definition at line 64 of file PorousFlowMassRadioactiveDecay.h.

◆ _num_phases

const unsigned int PorousFlowMassRadioactiveDecay::_num_phases

protected

Number of fluid phases.

Definition at line 49 of file PorousFlowMassRadioactiveDecay.h.

Referenced by computeQpJac(), and computeQpResidual().

◆ _porosity

const MaterialProperty<Real>& PorousFlowMassRadioactiveDecay::_porosity

protected

Porosity at the nodes, but it can depend on grad(variables) which are actually evaluated at the qps.

Definition at line 55 of file PorousFlowMassRadioactiveDecay.h.

Referenced by computeQpJac(), and computeQpResidual().

◆ _strain_at_nearest_qp

const bool PorousFlowMassRadioactiveDecay::_strain_at_nearest_qp

protected

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

Definition at line 52 of file PorousFlowMassRadioactiveDecay.h.

Referenced by computeQpJac().

◆ _var_is_porflow_var

const bool PorousFlowMassRadioactiveDecay::_var_is_porflow_var

protected

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

Definition at line 46 of file PorousFlowMassRadioactiveDecay.h.

Referenced by computeQpJacobian().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PorousFlowMassRadioactiveDecay()

Member Function Documentation

◆ computeQpJac()

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

Member Data Documentation

◆ _decay_rate

◆ _dfluid_density_dvar

◆ _dfluid_saturation_nodal_dvar

◆ _dictator

◆ _dmass_frac_dvar

◆ _dporosity_dgradvar

◆ _dporosity_dvar

◆ _fluid_component

◆ _fluid_density

◆ _fluid_saturation_nodal

◆ _mass_frac

◆ _nearest_qp

◆ _num_phases

◆ _porosity

◆ _strain_at_nearest_qp

◆ _var_is_porflow_var