PorousFlowPermeabilityExponentialTempl< is_ad > Class Template Reference

Material designed to provide the permeability tensor which is calculated from porosity using the equation: permeability = k_ijk * k, with k = BB * exp(AA * phi) where k_ijk is a tensor providing the anisotropy, phi is porosity, and A and B are empirical constants. More...

#include <PorousFlowPermeabilityExponential.h>

Inheritance diagram for PorousFlowPermeabilityExponentialTempl< is_ad >:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	PorousFlowPermeabilityExponentialTempl (const InputParameters &parameters)
const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialProperty (const std::string &name)
const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialPropertyByName (const std::string &name)
Moose::Kokkos::MaterialProperty< U, dimension >	declareKokkosPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
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="")
Moose::Kokkos::MaterialProperty< U, dimension >	getKokkosMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
Moose::Kokkos::MaterialProperty< U, dimension >	getKokkosMaterialPropertyDerivative (const std::string &base, const SymbolName &c1)
Moose::Kokkos::MaterialProperty< U, dimension >	getKokkosMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)
Moose::Kokkos::MaterialProperty< U, dimension >	getKokkosMaterialPropertyDerivative (const std::string &base, const SymbolName &c1)
Moose::Kokkos::MaterialProperty< U, dimension >	getKokkosMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)
Moose::Kokkos::MaterialProperty< U, dimension >	getKokkosMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)
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 Types
enum class	PoropermFunction { log_k , ln_k , exp_k }
	Name of porosity-permeability relationship. More...

Protected Member Functions
void	computeQpProperties () override

Protected Attributes
const Real	_A
	Empirical constant A.
const Real	_B
	Empirical constant B.
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))
enum PorousFlowPermeabilityExponentialTempl::PoropermFunction	_poroperm_function
Real	_AA
	Empirical constant AA in k = k_ijk * BB * exp(AA * phi)
Real	_BB
	Empirical constant BB in k = k_ijk * BB * exp(AA * phi)
	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 PorousFlowPermeabilityExponentialTempl< is_ad >

Material designed to provide the permeability tensor which is calculated from porosity using the equation: permeability = k_ijk * k, with k = BB * exp(AA * phi) where k_ijk is a tensor providing the anisotropy, phi is porosity, and A and B are empirical constants.

The user can provide input for the equation expressed in any of the following 3 forms: log k = A * phi + B ln k = A * phi + B k = B * exp(A * phi) A and B are then converted to AA and BB.

Definition at line 28 of file PorousFlowPermeabilityExponential.h.

Member Enumeration Documentation

PoropermFunction

template<bool is_ad>

enum class PorousFlowPermeabilityExponentialTempl::PoropermFunction

strongprotected

Name of porosity-permeability relationship.

Enumerator
log_k
ln_k
exp_k

Definition at line 57 of file PorousFlowPermeabilityExponential.h.

{ log_k, ln_k, exp_k } _poroperm_function;

Constructor & Destructor Documentation

PorousFlowPermeabilityExponentialTempl()

template<bool is_ad>

PorousFlowPermeabilityExponentialTempl< is_ad >::PorousFlowPermeabilityExponentialTempl

(

const InputParameters &

parameters

)

Definition at line 43 of file PorousFlowPermeabilityExponential.C.

  : PorousFlowPermeabilityBaseTempl<is_ad>(parameters),
    _A(this->template getParam<Real>("A")),
    _B(this->template getParam<Real>("B")),
    _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")),
    _poroperm_function(this->template getParam<MooseEnum>("poroperm_function")
                           .template getEnum<PoropermFunction>())
{
  switch (_poroperm_function)
  {
    case PoropermFunction::log_k:
      _AA = _A * std::log(10.0);
      _BB = std::pow(10.0, _B);
      break;
 
    case PoropermFunction::ln_k:
      _AA = _A;
      _BB = std::exp(_B);
      break;
 
    case PoropermFunction::exp_k:
      _AA = _A;
      _BB = _B;
      break;
  }
 
  // Make sure that derivatives are included in the Jacobian calculations
  _dictator.usePermDerivs(true);
}

Member Function Documentation

computeQpProperties()

template<bool is_ad>

void PorousFlowPermeabilityExponentialTempl< is_ad >::computeQpProperties ( )

overrideprotected

Definition at line 85 of file PorousFlowPermeabilityExponential.C.

{
  using std::exp;
 
  _permeability_qp[_qp] = _k_anisotropy * _BB * exp(_porosity_qp[_qp] * _AA);
 
  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] =
          _AA * _permeability_qp[_qp] * (*_dporosity_qp_dvar)[_qp][v];
 
    (*_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] =
            _AA * _permeability_qp[_qp] * (*_dporosity_qp_dgradvar)[_qp][v](i);
    }
  }
}

validParams()

template<bool is_ad>

InputParameters PorousFlowPermeabilityExponentialTempl< is_ad >::validParams ( )

static

Definition at line 17 of file PorousFlowPermeabilityExponential.C.

{
  InputParameters params = PorousFlowPermeabilityBase::validParams();
  MooseEnum poroperm_function("log_k ln_k exp_k", "exp_k");
  params.addParam<MooseEnum>("poroperm_function",
                             poroperm_function,
                             "Form of the function relating porosity and permeability. The options "
                             "are: log_k (log k = A phi + B); ln_k (ln k = A phi + B); exp_k (k = "
                             "B exp(A phi)); where k is permeability, phi is porosity, A and B are "
                             "empirical constants.");
  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.addRequiredParam<Real>("A", "Empirical constant; see poroperm_function.");
  params.addRequiredParam<Real>("B", "Empirical constant; see poroperm_function.");
  params.addClassDescription(
      "This Material calculates the permeability tensor from an exponential function of porosity: "
      "k = k_ijk * BB exp(AA phi), where k_ijk is a tensor providing the anisotropy, phi is "
      "porosity, and AA and BB are empirical constants. The user can provide input for the "
      "function expressed in ln k, log k or exponential forms (see poroperm_function).");
  return params;
}

Member Data Documentation

_A

template<bool is_ad>

const Real PorousFlowPermeabilityExponentialTempl< is_ad >::_A

protected

Empirical constant A.

Definition at line 39 of file PorousFlowPermeabilityExponential.h.

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

_AA

template<bool is_ad>

Real PorousFlowPermeabilityExponentialTempl< is_ad >::_AA

protected

Empirical constant AA in k = k_ijk * BB * exp(AA * phi)

Definition at line 60 of file PorousFlowPermeabilityExponential.h.

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

_B

template<bool is_ad>

const Real PorousFlowPermeabilityExponentialTempl< is_ad >::_B

protected

Empirical constant B.

Definition at line 42 of file PorousFlowPermeabilityExponential.h.

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

_BB

template<bool is_ad>

Real PorousFlowPermeabilityExponentialTempl< is_ad >::_BB

protected

Empirical constant BB in k = k_ijk * BB * exp(AA * phi)

Definition at line 63 of file PorousFlowPermeabilityExponential.h.

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

_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 PorousFlowPermeabilityExponentialTempl< is_ad >::_dporosity_qp_dgradvar

protected

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

Definition at line 54 of file PorousFlowPermeabilityExponential.h.

_dporosity_qp_dvar

template<bool is_ad>

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

protected

d(quadpoint porosity)/d(PorousFlow variable)

Definition at line 51 of file PorousFlowPermeabilityExponential.h.

_k_anisotropy

template<bool is_ad>

const RealTensorValue PorousFlowPermeabilityExponentialTempl< is_ad >::_k_anisotropy

protected

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

Definition at line 45 of file PorousFlowPermeabilityExponential.h.

_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(), PorousFlowPorosityHMBiotModulus::computeQpProperties(), PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity::computeQpProperties(), PorousFlowPorosityLinear::computeUnboundedPorosityQp(), PorousFlowPorosityVinsomeWesterveld::computeUnboundedPorosityQp(), 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.

_poroperm_function

template<bool is_ad>

enum PorousFlowPermeabilityExponentialTempl::PoropermFunction PorousFlowPermeabilityExponentialTempl< is_ad >::_poroperm_function

protected

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

_porosity_qp

template<bool is_ad>

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

protected

Quadpoint porosity.

Definition at line 48 of file PorousFlowPermeabilityExponential.h.

usingPorousFlowPermeabilityBaseMembers

template<bool is_ad>

PorousFlowPermeabilityExponentialTempl< is_ad >::usingPorousFlowPermeabilityBaseMembers

protected

Definition at line 65 of file PorousFlowPermeabilityExponential.h.

---

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

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