PorousFlowDiffusivityBaseTempl< is_ad > Class Template Reference

Base class Material designed to provide the tortuosity and diffusion coefficents. More...

#include <PorousFlowDiffusivityBase.h>

Inheritance diagram for PorousFlowDiffusivityBaseTempl< is_ad >:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	PorousFlowDiffusivityBaseTempl (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
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 PorousFlowDiffusivityBaseTempl< is_ad >

Base class Material designed to provide the tortuosity and diffusion coefficents.

Definition at line 16 of file PorousFlowDiffusivityBase.h.

Constructor & Destructor Documentation

PorousFlowDiffusivityBaseTempl()

template<bool is_ad>

PorousFlowDiffusivityBaseTempl< is_ad >::PorousFlowDiffusivityBaseTempl

(

const InputParameters &

parameters

)

Definition at line 29 of file PorousFlowDiffusivityBase.C.

  : PorousFlowMaterialVectorBase(parameters),
 
    _tortuosity(declareGenericProperty<std::vector<Real>, is_ad>("PorousFlow_tortuosity_qp")),
    _dtortuosity_dvar(
        is_ad ? nullptr
              : &declareProperty<std::vector<std::vector<Real>>>("dPorousFlow_tortuosity_qp_dvar")),
    _diffusion_coeff(
        declareProperty<std::vector<std::vector<Real>>>("PorousFlow_diffusion_coeff_qp")),
    _ddiffusion_coeff_dvar(is_ad ? nullptr
                                 : &declareProperty<std::vector<std::vector<std::vector<Real>>>>(
                                       "dPorousFlow_diffusion_coeff_qp_dvar")),
    _input_diffusion_coeff(getParam<std::vector<Real>>("diffusion_coeff"))
{
  // Also, the number of diffusion coefficients must be equal to the num_phases * num_components
  if (_input_diffusion_coeff.size() != _num_phases * _num_components)
    this->paramError(
        "diffusion_coeff",
        "The number of diffusion coefficients entered is not equal to the number of phases "
        "multiplied by the number of fluid components");
 
  if (_nodal_material == true)
    mooseError("PorousFlowRelativeDiffusivity classes are only defined for at_nodes = false");
}

Member Function Documentation

computeQpProperties()

template<bool is_ad>

void PorousFlowDiffusivityBaseTempl< is_ad >::computeQpProperties ( )

overrideprotectedvirtual

Reimplemented in PorousFlowDiffusivityConstTempl< is_ad >, and PorousFlowDiffusivityMillingtonQuirkTempl< is_ad >.

Definition at line 57 of file PorousFlowDiffusivityBase.C.

{
  _diffusion_coeff[_qp].resize(_num_phases);
  _tortuosity[_qp].resize(_num_phases);
 
  if (!is_ad)
  {
    (*_ddiffusion_coeff_dvar)[_qp].resize(_num_phases);
    (*_dtortuosity_dvar)[_qp].resize(_num_phases);
  }
 
  for (unsigned int ph = 0; ph < _num_phases; ++ph)
  {
    _diffusion_coeff[_qp][ph].resize(_num_components);
 
    if (!is_ad)
    {
      (*_ddiffusion_coeff_dvar)[_qp][ph].resize(_num_components);
      (*_dtortuosity_dvar)[_qp][ph].assign(_num_var, 0.0);
    }
 
    for (unsigned int comp = 0; comp < _num_components; ++comp)
    {
      _diffusion_coeff[_qp][ph][comp] = _input_diffusion_coeff[ph * _num_components + comp];
 
      if (!is_ad)
        (*_ddiffusion_coeff_dvar)[_qp][ph][comp].assign(_num_var, 0.0);
    }
  }
}

Referenced by PorousFlowDiffusivityConstTempl< is_ad >::computeQpProperties(), and PorousFlowDiffusivityMillingtonQuirkTempl< is_ad >::computeQpProperties().

validParams()

template<bool is_ad>

InputParameters PorousFlowDiffusivityBaseTempl< is_ad >::validParams ( )

static

Definition at line 14 of file PorousFlowDiffusivityBase.C.

{
  InputParameters params = PorousFlowMaterialVectorBase::validParams();
  params.addRequiredParam<std::vector<Real>>(
      "diffusion_coeff",
      "List of diffusion coefficients.  Order is i) component 0 in phase 0; ii) "
      "component 1 in phase 0 ...; component 0 in phase 1; ... component k in "
      "phase n (m^2/s");
  params.addClassDescription("Base class for effective diffusivity for each phase");
  params.set<bool>("at_nodes") = false;
  params.addPrivateParam<std::string>("pf_material_type", "diffusivity");
  return params;
}

Referenced by PorousFlowDiffusivityConstTempl< is_ad >::validParams(), and PorousFlowDiffusivityMillingtonQuirkTempl< is_ad >::validParams().

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

protected

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

protected

Diffusion coefficients of component k in fluid phase alpha.

Definition at line 33 of file PorousFlowDiffusivityBase.h.

_dtortuosity_dvar

template<bool is_ad>

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

protected

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

protected

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

_tortuosity

template<bool is_ad>

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

protected

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

Definition at line 27 of file PorousFlowDiffusivityBase.h.

---

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

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