PorousFlowPermeabilityKozenyCarman Class Reference

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

#include <PorousFlowPermeabilityKozenyCarman.h>

Inheritance diagram for PorousFlowPermeabilityKozenyCarman:

Public Member Functions
	PorousFlowPermeabilityKozenyCarman (const InputParameters &parameters)

Protected Types
enum	PoropermFunction { PoropermFunction::kozeny_carman_fd2, PoropermFunction::kozeny_carman_phi0 }
	Name of porosity-permeability relationship. More...

Protected Member Functions
void	computeQpProperties () override

Protected Attributes
const Real	_k0
	Reference scalar permeability in A = k0 * (1 - phi0)^m / phi0^n. More...
const Real	_phi0
	Reference porosity in A = k0 * (1 - phi0)^m / phi0^n. More...
const Real	_f
	Multiplying factor in A = f * d^2. More...
const Real	_d
	Grain diameter in A = f * d^2. More...
const Real	_m
	Exponent in k = k_ijk * A * phi^n / (1 - phi)^m. More...
const Real	_n
	Exponent in k = k_ijk * A * phi^n / (1 - phi)^m. 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 PorousFlowPermeabilityKozenyCarman::PoropermFunction	_poroperm_function
Real	_A
	Multiplying factor in k = k_ijk * A * phi^n / (1 - phi)^m. 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 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 and A is given in one of the following forms: A = k0 * (1 - phi0)^m / phi0^n where k0 and phi0 are a reference permeability and porosity, or A = f * d^2 where f is a scalar constant and d is grain diameter.

Definition at line 33 of file PorousFlowPermeabilityKozenyCarman.h.

Member Enumeration Documentation

PoropermFunction

enum PorousFlowPermeabilityKozenyCarman::PoropermFunction

strongprotected

Name of porosity-permeability relationship.

Enumerator
kozeny_carman_fd2
kozeny_carman_phi0

Definition at line 72 of file PorousFlowPermeabilityKozenyCarman.h.

{ kozeny_carman_fd2, kozeny_carman_phi0 } _poroperm_function;

Constructor & Destructor Documentation

PorousFlowPermeabilityKozenyCarman()

PorousFlowPermeabilityKozenyCarman::PorousFlowPermeabilityKozenyCarman

(

const InputParameters &

parameters

)

Definition at line 54 of file PorousFlowPermeabilityKozenyCarman.C.

  : PorousFlowPermeabilityBase(parameters),
    _k0(parameters.isParamValid("k0") ? getParam<Real>("k0") : -1),
    _phi0(parameters.isParamValid("phi0") ? getParam<Real>("phi0") : -1),
    _f(parameters.isParamValid("f") ? getParam<Real>("f") : -1),
    _d(parameters.isParamValid("d") ? getParam<Real>("d") : -1),
    _m(getParam<Real>("m")),
    _n(getParam<Real>("n")),
    _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::kozeny_carman_fd2:
      if (!(parameters.isParamValid("f") && parameters.isParamValid("d")))
        mooseError("You must specify f and d in order to use kozeny_carman_fd2 in "
                   "PorousFlowPermeabilityKozenyCarman");
      _A = _f * _d * _d;
      break;
 
    case PoropermFunction::kozeny_carman_phi0:
      if (!(parameters.isParamValid("k0") && parameters.isParamValid("phi0")))
        mooseError("You must specify k0 and phi0 in order to use kozeny_carman_phi0 in "
                   "PorousFlowPermeabilityKozenyCarman");
      _A = _k0 * std::pow(1.0 - _phi0, _m) / std::pow(_phi0, _n);
      break;
  }
 
  // Make sure that derivatives are included in the Jacobian calculations
  _dictator.usePermDerivs(true);
}

Member Function Documentation

computeQpProperties()

void PorousFlowPermeabilityKozenyCarman::computeQpProperties ( )

overrideprotected

Definition at line 94 of file PorousFlowPermeabilityKozenyCarman.C.

{
  _permeability_qp[_qp] =
      _k_anisotropy * _A * std::pow(_porosity_qp[_qp], _n) / std::pow(1.0 - _porosity_qp[_qp], _m);
 
  _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 (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] =
          _dporosity_qp_dgradvar[_qp][v](i) * _permeability_qp[_qp] *
          (_n / _porosity_qp[_qp] + _m / (1.0 - _porosity_qp[_qp]));
  }
}

Member Data Documentation

_A

Real PorousFlowPermeabilityKozenyCarman::_A

protected

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

Definition at line 75 of file PorousFlowPermeabilityKozenyCarman.h.

Referenced by computeQpProperties(), and PorousFlowPermeabilityKozenyCarman().

_d

const Real PorousFlowPermeabilityKozenyCarman::_d

protected

Grain diameter in A = f * d^2.

Definition at line 51 of file PorousFlowPermeabilityKozenyCarman.h.

Referenced by PorousFlowPermeabilityKozenyCarman().

_dpermeability_qp_dgradvar

MaterialProperty<std::vector<std::vector<RealTensorValue> > >& PorousFlowPermeabilityBase::_dpermeability_qp_dgradvar

protectedinherited

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

Definition at line 35 of file PorousFlowPermeabilityBase.h.

Referenced by PorousFlowPermeabilityConst::computeQpProperties(), PorousFlowPermeabilityTensorFromVar::computeQpProperties(), PorousFlowPermeabilityConstFromVar::computeQpProperties(), PorousFlowPermeabilityExponential::computeQpProperties(), and computeQpProperties().

_dpermeability_qp_dvar

MaterialProperty<std::vector<RealTensorValue> >& PorousFlowPermeabilityBase::_dpermeability_qp_dvar

protectedinherited

d(quadpoint permeability)/d(PorousFlow variable)

Definition at line 32 of file PorousFlowPermeabilityBase.h.

Referenced by PorousFlowPermeabilityConst::computeQpProperties(), PorousFlowPermeabilityTensorFromVar::computeQpProperties(), PorousFlowPermeabilityConstFromVar::computeQpProperties(), PorousFlowPermeabilityExponential::computeQpProperties(), and computeQpProperties().

_dporosity_qp_dgradvar

const MaterialProperty<std::vector<RealGradient> >& PorousFlowPermeabilityKozenyCarman::_dporosity_qp_dgradvar

protected

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

Definition at line 69 of file PorousFlowPermeabilityKozenyCarman.h.

Referenced by computeQpProperties().

_dporosity_qp_dvar

const MaterialProperty<std::vector<Real> >& PorousFlowPermeabilityKozenyCarman::_dporosity_qp_dvar

protected

d(quadpoint porosity)/d(PorousFlow variable)

Definition at line 66 of file PorousFlowPermeabilityKozenyCarman.h.

Referenced by computeQpProperties().

_f

const Real PorousFlowPermeabilityKozenyCarman::_f

protected

Multiplying factor in A = f * d^2.

Definition at line 48 of file PorousFlowPermeabilityKozenyCarman.h.

Referenced by PorousFlowPermeabilityKozenyCarman().

_k0

const Real PorousFlowPermeabilityKozenyCarman::_k0

protected

Reference scalar permeability in A = k0 * (1 - phi0)^m / phi0^n.

Definition at line 42 of file PorousFlowPermeabilityKozenyCarman.h.

Referenced by PorousFlowPermeabilityKozenyCarman().

_k_anisotropy

const RealTensorValue PorousFlowPermeabilityKozenyCarman::_k_anisotropy

protected

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

Definition at line 60 of file PorousFlowPermeabilityKozenyCarman.h.

Referenced by computeQpProperties().

_m

const Real PorousFlowPermeabilityKozenyCarman::_m

protected

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

Definition at line 54 of file PorousFlowPermeabilityKozenyCarman.h.

Referenced by computeQpProperties(), and PorousFlowPermeabilityKozenyCarman().

_n

const Real PorousFlowPermeabilityKozenyCarman::_n

protected

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

Definition at line 57 of file PorousFlowPermeabilityKozenyCarman.h.

Referenced by computeQpProperties(), and PorousFlowPermeabilityKozenyCarman().

_num_components

const unsigned int PorousFlowMaterialVectorBase::_num_components

protectedinherited

Number of fluid components.

Definition at line 33 of file PorousFlowMaterialVectorBase.h.

Referenced by PorousFlowDiffusivityBase::computeQpProperties(), PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties(), PorousFlowMassFraction::computeQpProperties(), PorousFlowAqueousPreDisChemistry::PorousFlowAqueousPreDisChemistry(), PorousFlowDiffusivityBase::PorousFlowDiffusivityBase(), and PorousFlowMassFraction::PorousFlowMassFraction().

_num_phases

const unsigned int PorousFlowMaterialVectorBase::_num_phases

protectedinherited

Number of phases.

Definition at line 30 of file PorousFlowMaterialVectorBase.h.

Referenced by PorousFlowDiffusivityBase::computeQpProperties(), PorousFlowDiffusivityMillingtonQuirk::computeQpProperties(), PorousFlowEffectiveFluidPressure::computeQpProperties(), PorousFlowMassFraction::computeQpProperties(), PorousFlowJoiner::computeQpProperties(), PorousFlowEffectiveFluidPressure::initQpStatefulProperties(), PorousFlowJoiner::initQpStatefulProperties(), PorousFlowDiffusivityBase::PorousFlowDiffusivityBase(), PorousFlowDiffusivityConst::PorousFlowDiffusivityConst(), PorousFlowJoiner::PorousFlowJoiner(), PorousFlowMassFraction::PorousFlowMassFraction(), PorousFlowThermalConductivityFromPorosity::PorousFlowThermalConductivityFromPorosity(), PorousFlowThermalConductivityIdeal::PorousFlowThermalConductivityIdeal(), and PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity::PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity().

_num_var

const unsigned int PorousFlowMaterialVectorBase::_num_var

protectedinherited

Number of PorousFlow variables.

Definition at line 36 of file PorousFlowMaterialVectorBase.h.

Referenced by PorousFlowDiffusivityBase::computeQpProperties(), PorousFlowPermeabilityConst::computeQpProperties(), PorousFlowVolumetricStrain::computeQpProperties(), PorousFlowDiffusivityMillingtonQuirk::computeQpProperties(), PorousFlowAqueousPreDisChemistry::computeQpProperties(), PorousFlowPorosityConst::computeQpProperties(), PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties(), PorousFlowThermalConductivityIdeal::computeQpProperties(), PorousFlowEffectiveFluidPressure::computeQpProperties(), PorousFlowPermeabilityTensorFromVar::computeQpProperties(), PorousFlowThermalConductivityFromPorosity::computeQpProperties(), PorousFlowMatrixInternalEnergy::computeQpProperties(), PorousFlowPorosityHMBiotModulus::computeQpProperties(), PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity::computeQpProperties(), PorousFlowPermeabilityConstFromVar::computeQpProperties(), PorousFlowPermeabilityExponential::computeQpProperties(), PorousFlowMassFraction::computeQpProperties(), computeQpProperties(), PorousFlowJoiner::computeQpProperties(), PorousFlowPorosityExponentialBase::computeQpProperties(), and PorousFlowAqueousPreDisChemistry::initQpStatefulProperties().

_permeability_qp

MaterialProperty<RealTensorValue>& PorousFlowPermeabilityBase::_permeability_qp

protectedinherited

Quadpoint permeability.

Definition at line 29 of file PorousFlowPermeabilityBase.h.

Referenced by PorousFlowPermeabilityConst::computeQpProperties(), PorousFlowPermeabilityTensorFromVar::computeQpProperties(), PorousFlowPermeabilityConstFromVar::computeQpProperties(), PorousFlowPermeabilityExponential::computeQpProperties(), and computeQpProperties().

_phi0

const Real PorousFlowPermeabilityKozenyCarman::_phi0

protected

Reference porosity in A = k0 * (1 - phi0)^m / phi0^n.

Definition at line 45 of file PorousFlowPermeabilityKozenyCarman.h.

Referenced by PorousFlowPermeabilityKozenyCarman().

_poroperm_function

enum PorousFlowPermeabilityKozenyCarman::PoropermFunction PorousFlowPermeabilityKozenyCarman::_poroperm_function

protected

Referenced by PorousFlowPermeabilityKozenyCarman().

_porosity_qp

const MaterialProperty<Real>& PorousFlowPermeabilityKozenyCarman::_porosity_qp

protected

Quadpoint porosity.

Definition at line 63 of file PorousFlowPermeabilityKozenyCarman.h.

Referenced by computeQpProperties().

---

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

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