https://mooseframework.inl.gov
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
PorousFlowDiffusivityMillingtonQuirkTempl< is_ad > Class Template Reference

Material to provide saturation dependent diffusivity using the model of Millington and Quirk, from Millington and Quirk, Permeability of Porous Solids, Trans. More...

#include <PorousFlowDiffusivityMillingtonQuirk.h>

Inheritance diagram for PorousFlowDiffusivityMillingtonQuirkTempl< is_ad >:
[legend]

Public Types

typedef DerivativeMaterialPropertyNameInterface::SymbolName SymbolName
 

Public Member Functions

 PorousFlowDiffusivityMillingtonQuirkTempl (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

virtual void computeQpProperties () override
 

Protected Attributes

const GenericMaterialProperty< Real, is_ad > & _porosity_qp
 Porosity at the qps.
 
const MaterialProperty< std::vector< Real > > *const _dporosity_qp_dvar
 Derivative of porosity wrt PorousFlow variables (at the qps)
 
const GenericMaterialProperty< std::vector< Real >, is_ad > & _saturation_qp
 Saturation of each phase at the qps.
 
const MaterialProperty< std::vector< std::vector< Real > > > *const _dsaturation_qp_dvar
 Derivative of saturation of each phase wrt PorousFlow variables (at the qps)
 
 usingPorousFlowDiffusivityBaseMembers
 
GenericMaterialProperty< std::vector< Real >, is_ad > & _tortuosity
 Tortuosity tau_0 * tau_{alpha} for fluid phase alpha.
 
MaterialProperty< std::vector< std::vector< Real > > > *const _dtortuosity_dvar
 Derivative of tortuosity wrt PorousFlow variables.
 
MaterialProperty< std::vector< std::vector< Real > > > & _diffusion_coeff
 Diffusion coefficients of component k in fluid phase alpha.
 
MaterialProperty< std::vector< std::vector< std::vector< Real > > > > *const _ddiffusion_coeff_dvar
 Derivative of the diffusion coefficients wrt PorousFlow variables.
 
const std::vector< Real > _input_diffusion_coeff
 Input diffusion coefficients.
 
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 PorousFlowDiffusivityMillingtonQuirkTempl< is_ad >

Material to provide saturation dependent diffusivity using the model of Millington and Quirk, from Millington and Quirk, Permeability of Porous Solids, Trans.

Faraday Soc., 57, 1200- 1207, 1961

Definition at line 21 of file PorousFlowDiffusivityMillingtonQuirk.h.

Constructor & Destructor Documentation

◆ PorousFlowDiffusivityMillingtonQuirkTempl()

template<bool is_ad>
PorousFlowDiffusivityMillingtonQuirkTempl< is_ad >::PorousFlowDiffusivityMillingtonQuirkTempl ( const InputParameters &  parameters)

Definition at line 26 of file PorousFlowDiffusivityMillingtonQuirk.C.

28 : PorousFlowDiffusivityBaseTempl<is_ad>(parameters),
29 _porosity_qp(this->template getGenericMaterialProperty<Real, is_ad>("PorousFlow_porosity_qp")),
30 _dporosity_qp_dvar(is_ad ? nullptr
31 : &this->template getMaterialProperty<std::vector<Real>>(
32 "dPorousFlow_porosity_qp_dvar")),
33 _saturation_qp(this->template getGenericMaterialProperty<std::vector<Real>, is_ad>(
34 "PorousFlow_saturation_qp")),
35 _dsaturation_qp_dvar(is_ad
36 ? nullptr
37 : &this->template getMaterialProperty<std::vector<std::vector<Real>>>(
38 "dPorousFlow_saturation_qp_dvar"))
39{
40}
PorousFlowDiffusivityBaseTempl
Base class Material designed to provide the tortuosity and diffusion coefficents.
Definition PorousFlowDiffusivityBase.h:17
PorousFlowDiffusivityMillingtonQuirkTempl::_porosity_qp
const GenericMaterialProperty< Real, is_ad > & _porosity_qp
Porosity at the qps.
Definition PorousFlowDiffusivityMillingtonQuirk.h:32
PorousFlowDiffusivityMillingtonQuirkTempl::_dporosity_qp_dvar
const MaterialProperty< std::vector< Real > > *const _dporosity_qp_dvar
Derivative of porosity wrt PorousFlow variables (at the qps)
Definition PorousFlowDiffusivityMillingtonQuirk.h:34
PorousFlowDiffusivityMillingtonQuirkTempl::_saturation_qp
const GenericMaterialProperty< std::vector< Real >, is_ad > & _saturation_qp
Saturation of each phase at the qps.
Definition PorousFlowDiffusivityMillingtonQuirk.h:36
PorousFlowDiffusivityMillingtonQuirkTempl::_dsaturation_qp_dvar
const MaterialProperty< std::vector< std::vector< Real > > > *const _dsaturation_qp_dvar
Derivative of saturation of each phase wrt PorousFlow variables (at the qps)
Definition PorousFlowDiffusivityMillingtonQuirk.h:38
libMesh::Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

Member Function Documentation

◆ computeQpProperties()

template<bool is_ad>
void PorousFlowDiffusivityMillingtonQuirkTempl< is_ad >::computeQpProperties ( )
overrideprotectedvirtual

Reimplemented from PorousFlowDiffusivityBaseTempl< is_ad >.

Definition at line 44 of file PorousFlowDiffusivityMillingtonQuirk.C.

45{
46 PorousFlowDiffusivityBaseTempl<is_ad>::computeQpProperties();
47
48 using std::cbrt, std::pow;
49
50 for (unsigned int ph = 0; ph < _num_phases; ++ph)
51 {
52 _tortuosity[_qp][ph] = cbrt(_porosity_qp[_qp]) * pow(_saturation_qp[_qp][ph], 10.0 / 3.0);
53
54 if (!is_ad)
55 for (unsigned int var = 0; var < _num_var; ++var)
56 (*_dtortuosity_dvar)[_qp][ph][var] = MetaPhysicL::raw_value(
57 1.0 / 3.0 * cbrt(_porosity_qp[_qp]) * pow(_saturation_qp[_qp][ph], 7.0 / 3.0) *
58 (_saturation_qp[_qp][ph] / _porosity_qp[_qp] * (*_dporosity_qp_dvar)[_qp][var] +
59 10.0 * (*_dsaturation_qp_dvar)[_qp][ph][var]));
60 }
61}
pow
ExpressionBuilder::EBTerm pow(const ExpressionBuilder::EBTerm &left, T exponent)
Definition ExpressionBuilder.h:690
PorousFlowDiffusivityBaseTempl::_dtortuosity_dvar
MaterialProperty< std::vector< std::vector< Real > > > *const _dtortuosity_dvar
Derivative of tortuosity wrt PorousFlow variables.
Definition PorousFlowDiffusivityBase.h:30
PorousFlowDiffusivityBaseTempl::_tortuosity
GenericMaterialProperty< std::vector< Real >, is_ad > & _tortuosity
Tortuosity tau_0 * tau_{alpha} for fluid phase alpha.
Definition PorousFlowDiffusivityBase.h:27
PorousFlowDiffusivityBaseTempl::computeQpProperties
virtual void computeQpProperties() override
Definition PorousFlowDiffusivityBase.C:57
PorousFlowMaterialVectorBase::_num_phases
const unsigned int _num_phases
Number of phases.
Definition PorousFlowMaterialVectorBase.h:27
PorousFlowMaterialVectorBase::_num_var
const unsigned int _num_var
Number of PorousFlow variables.
Definition PorousFlowMaterialVectorBase.h:33
MetaPhysicL::raw_value
auto raw_value(const Eigen::Map< T > &in)

◆ validParams()

template<bool is_ad>
InputParameters PorousFlowDiffusivityMillingtonQuirkTempl< is_ad >::validParams ( )
static

Definition at line 17 of file PorousFlowDiffusivityMillingtonQuirk.C.

18{
19 InputParameters params = PorousFlowDiffusivityBaseTempl<is_ad>::validParams();
20 params.addClassDescription(
21 "This Material provides saturation-dependent diffusivity using the Millington-Quirk model");
22 return params;
23}
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _ddiffusion_coeff_dvar

template<bool is_ad>
MaterialProperty<std::vector<std::vector<std::vector<Real> > > >* const PorousFlowDiffusivityBaseTempl< is_ad >::_ddiffusion_coeff_dvar
protectedinherited

Derivative of the diffusion coefficients wrt PorousFlow variables.

Definition at line 36 of file PorousFlowDiffusivityBase.h.

◆ _diffusion_coeff

template<bool is_ad>
MaterialProperty<std::vector<std::vector<Real> > >& PorousFlowDiffusivityBaseTempl< is_ad >::_diffusion_coeff
protectedinherited

Diffusion coefficients of component k in fluid phase alpha.

Definition at line 33 of file PorousFlowDiffusivityBase.h.

◆ _dporosity_qp_dvar

template<bool is_ad>
const MaterialProperty<std::vector<Real> >* const PorousFlowDiffusivityMillingtonQuirkTempl< is_ad >::_dporosity_qp_dvar
protected

Derivative of porosity wrt PorousFlow variables (at the qps)

Definition at line 34 of file PorousFlowDiffusivityMillingtonQuirk.h.

◆ _dsaturation_qp_dvar

template<bool is_ad>
const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowDiffusivityMillingtonQuirkTempl< is_ad >::_dsaturation_qp_dvar
protected

Derivative of saturation of each phase wrt PorousFlow variables (at the qps)

Definition at line 38 of file PorousFlowDiffusivityMillingtonQuirk.h.

◆ _dtortuosity_dvar

template<bool is_ad>
MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowDiffusivityBaseTempl< is_ad >::_dtortuosity_dvar
protectedinherited

Derivative of tortuosity wrt PorousFlow variables.

Definition at line 30 of file PorousFlowDiffusivityBase.h.

◆ _input_diffusion_coeff

template<bool is_ad>
const std::vector<Real> PorousFlowDiffusivityBaseTempl< is_ad >::_input_diffusion_coeff
protectedinherited

Input diffusion coefficients.

Definition at line 39 of file PorousFlowDiffusivityBase.h.

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

◆ _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().

◆ _porosity_qp

template<bool is_ad>
const GenericMaterialProperty<Real, is_ad>& PorousFlowDiffusivityMillingtonQuirkTempl< is_ad >::_porosity_qp
protected

Porosity at the qps.

Definition at line 32 of file PorousFlowDiffusivityMillingtonQuirk.h.

◆ _saturation_qp

template<bool is_ad>
const GenericMaterialProperty<std::vector<Real>, is_ad>& PorousFlowDiffusivityMillingtonQuirkTempl< is_ad >::_saturation_qp
protected

Saturation of each phase at the qps.

Definition at line 36 of file PorousFlowDiffusivityMillingtonQuirk.h.

◆ _tortuosity

template<bool is_ad>
GenericMaterialProperty<std::vector<Real>, is_ad>& PorousFlowDiffusivityBaseTempl< is_ad >::_tortuosity
protectedinherited

Tortuosity tau_0 * tau_{alpha} for fluid phase alpha.

Definition at line 27 of file PorousFlowDiffusivityBase.h.

◆ usingPorousFlowDiffusivityBaseMembers

template<bool is_ad>
PorousFlowDiffusivityMillingtonQuirkTempl< is_ad >::usingPorousFlowDiffusivityBaseMembers
protected

Definition at line 40 of file PorousFlowDiffusivityMillingtonQuirk.h.

The documentation for this class was generated from the following files:
Generated on Fri Aug 21 2026 13:43:36 for https://mooseframework.inl.gov by doxygen 1.9.8