PorousFlowPermeabilityKozenyCarmanBaseTempl< is_ad > Class Template Reference

Base class for material designed to provide the permeability tensor which is calculated from porosity using a form of the Kozeny-Carman equation (e.g. More...

#include <PorousFlowPermeabilityKozenyCarmanBase.h>

Inheritance diagram for PorousFlowPermeabilityKozenyCarmanBaseTempl< is_ad >:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	PorousFlowPermeabilityKozenyCarmanBaseTempl (const InputParameters &parameters)
const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialProperty (const std::string &name)
const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialPropertyByName (const std::string &name)
void	validateDerivativeMaterialPropertyBase (const std::string &base)
const MaterialPropertyName	derivativePropertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
const MaterialPropertyName	derivativePropertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
const MaterialPropertyName	derivativePropertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
const MaterialPropertyName	derivativePropertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const
GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)
const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")
void	validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)
void	validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
void	validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)
void	validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
void	validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
void	validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")
const MaterialPropertyName	propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
const MaterialPropertyName	propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const
const MaterialPropertyName	propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
const MaterialPropertyName	propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const
const MaterialPropertyName	propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
const MaterialPropertyName	propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const
const MaterialPropertyName	propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const
const MaterialPropertyName	propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
void	computeQpProperties () override
virtual Real	computeA () const =0
	function for returning A factor in Kozeny Carman equation

Protected Attributes
const Real	_m
	Exponent in k = k_ijk * A * phi^n / (1 - phi)^m.
const Real	_n
	Exponent in k = k_ijk * A * phi^n / (1 - phi)^m.
const RealTensorValue	_k_anisotropy
	Tensor multiplier k_ijk in k = k_ijk * A * phi^n / (1 - phi)^m.
const GenericMaterialProperty< Real, is_ad > &	_porosity_qp
	Quadpoint porosity.
const MaterialProperty< std::vector< Real > > *const	_dporosity_qp_dvar
	d(quadpoint porosity)/d(PorousFlow variable)
const MaterialProperty< std::vector< RealGradient > > *const	_dporosity_qp_dgradvar
	d(quadpoint porosity)/d(grad(PorousFlow variable))
	usingPorousFlowPermeabilityBaseMembers
GenericMaterialProperty< RealTensorValue, is_ad > &	_permeability_qp
	Quadpoint permeability.
MaterialProperty< std::vector< RealTensorValue > > *const	_dpermeability_qp_dvar
	d(quadpoint permeability)/d(PorousFlow variable)
MaterialProperty< std::vector< std::vector< RealTensorValue > > > *const	_dpermeability_qp_dgradvar
	d(quadpoint permeability)/d(grad(PorousFlow variable))
const unsigned int	_num_phases
	Number of phases.
const unsigned int	_num_components
	Number of fluid components.
const unsigned int	_num_var
	Number of PorousFlow variables.

Private Member Functions
bool	haveMaterialProperty (const std::string &prop_name)
std::vector< VariableName >	buildVariableVector (const VariableName &c1, const VariableName &c2, const VariableName &c3)
void	validateCouplingHelper (const MaterialPropertyName &base, const std::vector< VariableName > &c, const System &system, std::vector< VariableName > &missing)
bool	isNotObjectVariable (const VariableName &name)

Private Attributes
FEProblemBase &	_dmi_fe_problem

Detailed Description

template<bool is_ad>
class PorousFlowPermeabilityKozenyCarmanBaseTempl< is_ad >

Base class for material designed to provide the permeability tensor which is calculated from porosity using a form of the Kozeny-Carman equation (e.g.

Oelkers 1996: Reviews in Mineralogy v. 34, p. 131-192): k = k_ijk * A * phi^n / (1 - phi)^m where k_ijk is a tensor providing the anisotropy, phi is porosity, n and m are positive scalar constants. Methods for computing A are in the derived classes

Definition at line 24 of file PorousFlowPermeabilityKozenyCarmanBase.h.

Constructor & Destructor Documentation

PorousFlowPermeabilityKozenyCarmanBaseTempl()

template<bool is_ad>

PorousFlowPermeabilityKozenyCarmanBaseTempl< is_ad >::PorousFlowPermeabilityKozenyCarmanBaseTempl

(

const InputParameters &

parameters

)

Definition at line 34 of file PorousFlowPermeabilityKozenyCarmanBase.C.

  : PorousFlowPermeabilityBaseTempl<is_ad>(parameters),
    _m(this->template getParam<Real>("m")),
    _n(this->template getParam<Real>("n")),
    _k_anisotropy(parameters.isParamValid("k_anisotropy")
                      ? this->template getParam<RealTensorValue>("k_anisotropy")
                      : RealTensorValue(1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 1.0)),
    _porosity_qp(this->template getGenericMaterialProperty<Real, is_ad>("PorousFlow_porosity_qp")),
    _dporosity_qp_dvar(is_ad ? nullptr
                             : &this->template getMaterialProperty<std::vector<Real>>(
                                   "dPorousFlow_porosity_qp_dvar")),
    _dporosity_qp_dgradvar(is_ad ? nullptr
                                 : &this->template getMaterialProperty<std::vector<RealGradient>>(
                                       "dPorousFlow_porosity_qp_dgradvar"))
{
  // Make sure that derivatives are included in the Jacobian calculations
  _dictator.usePermDerivs(true);
}

Member Function Documentation

computeA()

template<bool is_ad>

virtual Real PorousFlowPermeabilityKozenyCarmanBaseTempl< is_ad >::computeA ( ) const

protectedpure virtual

function for returning A factor in Kozeny Carman equation

Implemented in PorousFlowPermeabilityKozenyCarmanTempl< is_ad >, and PorousFlowPermeabilityKozenyCarmanFromVarTempl< is_ad >.

computeQpProperties()

template<bool is_ad>

void PorousFlowPermeabilityKozenyCarmanBaseTempl< is_ad >::computeQpProperties ( )

overrideprotected

Definition at line 56 of file PorousFlowPermeabilityKozenyCarmanBase.C.

{
  using std::pow;
 
  Real A = computeA();
  _permeability_qp[_qp] =
      _k_anisotropy * A * pow(_porosity_qp[_qp], _n) / pow(1.0 - _porosity_qp[_qp], _m);
 
  if constexpr (!is_ad)
  {
    (*_dpermeability_qp_dvar)[_qp].resize(_num_var, RealTensorValue());
    for (unsigned int v = 0; v < _num_var; ++v)
      (*_dpermeability_qp_dvar)[_qp][v] = (*_dporosity_qp_dvar)[_qp][v] * _permeability_qp[_qp] *
                                          (_n / _porosity_qp[_qp] + _m / (1.0 - _porosity_qp[_qp]));
 
    (*_dpermeability_qp_dgradvar)[_qp].resize(LIBMESH_DIM);
    for (const auto i : make_range(Moose::dim))
    {
      (*_dpermeability_qp_dgradvar)[_qp][i].resize(_num_var, RealTensorValue());
      for (unsigned int v = 0; v < _num_var; ++v)
        (*_dpermeability_qp_dgradvar)[_qp][i][v] =
            (*_dporosity_qp_dgradvar)[_qp][v](i) * _permeability_qp[_qp] *
            (_n / _porosity_qp[_qp] + _m / (1.0 - _porosity_qp[_qp]));
    }
  }
}

validParams()

template<bool is_ad>

InputParameters PorousFlowPermeabilityKozenyCarmanBaseTempl< is_ad >::validParams ( )

static

Definition at line 14 of file PorousFlowPermeabilityKozenyCarmanBase.C.

{
  InputParameters params = PorousFlowPermeabilityBase::validParams();
  params.addParam<RealTensorValue>("k_anisotropy",
                                   "A tensor to multiply the calculated scalar "
                                   "permeability, in order to obtain anisotropy if "
                                   "required. Defaults to isotropic permeability "
                                   "if not specified.");
  params.addRequiredRangeCheckedParam<Real>("n", "n >= 0", "Porosity exponent");
  params.addRequiredRangeCheckedParam<Real>("m", "m >= 0", "(1-porosity) exponent");
  params.addClassDescription(
      "Base class for material that calculates the permeability tensor from a form of the "
      "Kozeny-Carman equation, "
      "k = k_ijk * A * phi^n / (1 - phi)^m, where k_ijk is a tensor providing the anisotropy, phi "
      "is porosity, n and m are positive scalar constants.  Method for computing A is given in the "
      "derived classes.");
  return params;
}

Referenced by PorousFlowPermeabilityKozenyCarmanTempl< is_ad >::validParams(), and PorousFlowPermeabilityKozenyCarmanFromVarTempl< is_ad >::validParams().

Member Data Documentation

_dpermeability_qp_dgradvar

template<bool is_ad>

MaterialProperty<std::vector<std::vector<RealTensorValue> > >* const PorousFlowPermeabilityBaseTempl< is_ad >::_dpermeability_qp_dgradvar

protectedinherited

d(quadpoint permeability)/d(grad(PorousFlow variable))

Definition at line 33 of file PorousFlowPermeabilityBase.h.

_dpermeability_qp_dvar

template<bool is_ad>

MaterialProperty<std::vector<RealTensorValue> >* const PorousFlowPermeabilityBaseTempl< is_ad >::_dpermeability_qp_dvar

protectedinherited

d(quadpoint permeability)/d(PorousFlow variable)

Definition at line 30 of file PorousFlowPermeabilityBase.h.

_dporosity_qp_dgradvar

template<bool is_ad>

const MaterialProperty<std::vector<RealGradient> >* const PorousFlowPermeabilityKozenyCarmanBaseTempl< is_ad >::_dporosity_qp_dgradvar

protected

d(quadpoint porosity)/d(grad(PorousFlow variable))

Definition at line 53 of file PorousFlowPermeabilityKozenyCarmanBase.h.

_dporosity_qp_dvar

template<bool is_ad>

const MaterialProperty<std::vector<Real> >* const PorousFlowPermeabilityKozenyCarmanBaseTempl< is_ad >::_dporosity_qp_dvar

protected

d(quadpoint porosity)/d(PorousFlow variable)

Definition at line 50 of file PorousFlowPermeabilityKozenyCarmanBase.h.

_k_anisotropy

template<bool is_ad>

const RealTensorValue PorousFlowPermeabilityKozenyCarmanBaseTempl< is_ad >::_k_anisotropy

protected

Tensor multiplier k_ijk in k = k_ijk * A * phi^n / (1 - phi)^m.

Definition at line 44 of file PorousFlowPermeabilityKozenyCarmanBase.h.

_m

template<bool is_ad>

const Real PorousFlowPermeabilityKozenyCarmanBaseTempl< is_ad >::_m

protected

Exponent in k = k_ijk * A * phi^n / (1 - phi)^m.

Definition at line 38 of file PorousFlowPermeabilityKozenyCarmanBase.h.

Referenced by PorousFlowPermeabilityKozenyCarmanTempl< is_ad >::PorousFlowPermeabilityKozenyCarmanTempl().

_n

template<bool is_ad>

const Real PorousFlowPermeabilityKozenyCarmanBaseTempl< is_ad >::_n

protected

Exponent in k = k_ijk * A * phi^n / (1 - phi)^m.

Definition at line 41 of file PorousFlowPermeabilityKozenyCarmanBase.h.

Referenced by PorousFlowPermeabilityKozenyCarmanTempl< is_ad >::PorousFlowPermeabilityKozenyCarmanTempl().

_num_components

const unsigned int PorousFlowMaterialVectorBase::_num_components

protectedinherited

Number of fluid components.

Definition at line 30 of file PorousFlowMaterialVectorBase.h.

Referenced by PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties(), PorousFlowAqueousPreDisChemistry::PorousFlowAqueousPreDisChemistry(), PorousFlowDiffusivityBaseTempl< is_ad >::PorousFlowDiffusivityBaseTempl(), and PorousFlowMassFractionTempl< is_ad >::PorousFlowMassFractionTempl().

_num_phases

const unsigned int PorousFlowMaterialVectorBase::_num_phases

protectedinherited

Number of phases.

Definition at line 27 of file PorousFlowMaterialVectorBase.h.

Referenced by PorousFlowDiffusivityBaseTempl< is_ad >::PorousFlowDiffusivityBaseTempl(), PorousFlowDiffusivityConstTempl< is_ad >::PorousFlowDiffusivityConstTempl(), PorousFlowJoinerTempl< is_ad >::PorousFlowJoinerTempl(), PorousFlowMassFractionTempl< is_ad >::PorousFlowMassFractionTempl(), PorousFlowThermalConductivityFromPorosityTempl< is_ad >::PorousFlowThermalConductivityFromPorosityTempl(), PorousFlowThermalConductivityIdealTempl< is_ad >::PorousFlowThermalConductivityIdealTempl(), and PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity::PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity().

_num_var

const unsigned int PorousFlowMaterialVectorBase::_num_var

protectedinherited

Number of PorousFlow variables.

Definition at line 33 of file PorousFlowMaterialVectorBase.h.

Referenced by PorousFlowAqueousPreDisChemistry::computeQpProperties(), PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties(), PorousFlowPorosityExponentialBase::computeQpProperties(), PorousFlowPorosityHMBiotModulus::computeQpProperties(), PorousFlowPorosityLinear::computeQpProperties(), PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity::computeQpProperties(), PorousFlowVolumetricStrain::computeQpProperties(), PorousFlowAqueousPreDisChemistry::initQpStatefulProperties(), and PorousFlowPorosityLinear::initQpStatefulProperties().

_permeability_qp

template<bool is_ad>

GenericMaterialProperty<RealTensorValue, is_ad>& PorousFlowPermeabilityBaseTempl< is_ad >::_permeability_qp

protectedinherited

Quadpoint permeability.

Definition at line 27 of file PorousFlowPermeabilityBase.h.

_porosity_qp

template<bool is_ad>

const GenericMaterialProperty<Real, is_ad>& PorousFlowPermeabilityKozenyCarmanBaseTempl< is_ad >::_porosity_qp

protected

Quadpoint porosity.

Definition at line 47 of file PorousFlowPermeabilityKozenyCarmanBase.h.

usingPorousFlowPermeabilityBaseMembers

template<bool is_ad>

PorousFlowPermeabilityKozenyCarmanBaseTempl< is_ad >::usingPorousFlowPermeabilityBaseMembers

protected

Definition at line 55 of file PorousFlowPermeabilityKozenyCarmanBase.h.

---

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

• porous_flow/include/materials/PorousFlowPermeabilityKozenyCarmanBase.h
• porous_flow/src/materials/PorousFlowPermeabilityKozenyCarmanBase.C