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 PorousFlowPermeabilityExponential:

[legend]

Public Member Functions
	PorousFlowPermeabilityExponential (const InputParameters &parameters)

Protected Types
enum	PoropermFunction { PoropermFunction::log_k, PoropermFunction::ln_k, PoropermFunction::exp_k }
	Name of porosity-permeability relationship. More...

Protected Member Functions
void	computeQpProperties () override

Protected Attributes
const Real	_A
	Empirical constant A. More...

const Real	_B
	Empirical constant B. More...

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

const MaterialProperty< Real > &	_porosity_qp
	Quadpoint porosity. More...

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

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

enum PorousFlowPermeabilityExponential::PoropermFunction	_poroperm_function

Real	_AA
	Empirical constant AA in k = k_ijk * BB * exp(AA * phi) More...

Real	_BB
	Empirical constant BB in k = k_ijk * BB * exp(AA * phi) More...

MaterialProperty< RealTensorValue > &	_permeability_qp
	Quadpoint permeability. More...

MaterialProperty< std::vector< RealTensorValue > > &	_dpermeability_qp_dvar
	d(quadpoint permeability)/d(PorousFlow variable) More...

MaterialProperty< std::vector< std::vector< RealTensorValue > > > &	_dpermeability_qp_dgradvar
	d(quadpoint permeability)/d(grad(PorousFlow variable)) More...

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

const unsigned int	_num_components
	Number of fluid components. More...

const unsigned int	_num_var
	Number of PorousFlow variables. More...

Detailed Description

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 32 of file PorousFlowPermeabilityExponential.h.

Member Enumeration Documentation

◆ PoropermFunction

enum PorousFlowPermeabilityExponential::PoropermFunction

strongprotected

Name of porosity-permeability relationship.

Enumerator
log_k
ln_k
exp_k

Definition at line 59 of file PorousFlowPermeabilityExponential.h.

59 { log_k, ln_k, exp_k } _poroperm_function;

Constructor & Destructor Documentation

◆ PorousFlowPermeabilityExponential()

PorousFlowPermeabilityExponential::PorousFlowPermeabilityExponential ( const InputParameters & parameters )

Definition at line 41 of file PorousFlowPermeabilityExponential.C.

   : PorousFlowPermeabilityBase(parameters),
     _A(getParam<Real>("A")),
     _B(getParam<Real>("B")),
     _k_anisotropy(parameters.isParamValid("k_anisotropy")
                       ? 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(getMaterialProperty<Real>("PorousFlow_porosity_qp")),
     _dporosity_qp_dvar(getMaterialProperty<std::vector<Real>>("dPorousFlow_porosity_qp_dvar")),
     _dporosity_qp_dgradvar(
         getMaterialProperty<std::vector<RealGradient>>("dPorousFlow_porosity_qp_dgradvar")),
     _poroperm_function(getParam<MooseEnum>("poroperm_function").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()

void PorousFlowPermeabilityExponential::computeQpProperties ( )

overrideprotected

Definition at line 78 of file PorousFlowPermeabilityExponential.C.

 {
   _permeability_qp[_qp] = _k_anisotropy * _BB * std::exp(_porosity_qp[_qp] * _AA);
  
   _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 (unsigned i = 0; i < LIBMESH_DIM; ++i)
   {
     _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);
   }
 }