https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
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 >:
[legend]

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. More...
 
MaterialProperty< std::vector< std::vector< Real > > > *const _dtortuosity_dvar
 Derivative of tortuosity wrt PorousFlow variables. More...
 
MaterialProperty< std::vector< std::vector< Real > > > & _diffusion_coeff
 Diffusion coefficients of component k in fluid phase alpha. More...
 
MaterialProperty< std::vector< std::vector< std::vector< Real > > > > *const _ddiffusion_coeff_dvar
 Derivative of the diffusion coefficients wrt PorousFlow variables. More...
 
const std::vector< Real > _input_diffusion_coeff
 Input diffusion coefficients. 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

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.

31  : PorousFlowMaterialVectorBase(parameters),
32 
33  _tortuosity(declareGenericProperty<std::vector<Real>, is_ad>("PorousFlow_tortuosity_qp")),
34  _dtortuosity_dvar(
35  is_ad ? nullptr
36  : &declareProperty<std::vector<std::vector<Real>>>("dPorousFlow_tortuosity_qp_dvar")),
37  _diffusion_coeff(
38  declareProperty<std::vector<std::vector<Real>>>("PorousFlow_diffusion_coeff_qp")),
39  _ddiffusion_coeff_dvar(is_ad ? nullptr
40  : &declareProperty<std::vector<std::vector<std::vector<Real>>>>(
41  "dPorousFlow_diffusion_coeff_qp_dvar")),
42  _input_diffusion_coeff(getParam<std::vector<Real>>("diffusion_coeff"))
43 {
44  // Also, the number of diffusion coefficients must be equal to the num_phases * num_components
45  if (_input_diffusion_coeff.size() != _num_phases * _num_components)
46  this->paramError(
47  "diffusion_coeff",
48  "The number of diffusion coefficients entered is not equal to the number of phases "
49  "multiplied by the number of fluid components");
50 
51  if (_nodal_material == true)
52  mooseError("PorousFlowRelativeDiffusivity classes are only defined for at_nodes = false");
53 }
PorousFlowMaterialVectorBase::_num_phases
const unsigned int _num_phases
Number of phases.
Definition: PorousFlowMaterialVectorBase.h:27
PorousFlowDiffusivityBaseTempl::_dtortuosity_dvar
MaterialProperty< std::vector< std::vector< Real > > > *const _dtortuosity_dvar
Derivative of tortuosity wrt PorousFlow variables.
Definition: PorousFlowDiffusivityBase.h:30
mooseError
void mooseError(Args &&... args)
PorousFlowMaterialVectorBase::_num_components
const unsigned int _num_components
Number of fluid components.
Definition: PorousFlowMaterialVectorBase.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::_input_diffusion_coeff
const std::vector< Real > _input_diffusion_coeff
Input diffusion coefficients.
Definition: PorousFlowDiffusivityBase.h:39
PorousFlowMaterialVectorBase::PorousFlowMaterialVectorBase
PorousFlowMaterialVectorBase(const InputParameters &parameters)
Definition: PorousFlowMaterialVectorBase.C:21
PorousFlowDiffusivityBaseTempl::_diffusion_coeff
MaterialProperty< std::vector< std::vector< Real > > > & _diffusion_coeff
Diffusion coefficients of component k in fluid phase alpha.
Definition: PorousFlowDiffusivityBase.h:33
PorousFlowDiffusivityBaseTempl::_ddiffusion_coeff_dvar
MaterialProperty< std::vector< std::vector< std::vector< Real > > > > *const _ddiffusion_coeff_dvar
Derivative of the diffusion coefficients wrt PorousFlow variables.
Definition: PorousFlowDiffusivityBase.h:36

Member Function Documentation

◆ computeQpProperties()

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

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

Definition at line 57 of file PorousFlowDiffusivityBase.C.

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

58 {
59  _diffusion_coeff[_qp].resize(_num_phases);
60  _tortuosity[_qp].resize(_num_phases);
61 
62  if (!is_ad)
63  {
64  (*_ddiffusion_coeff_dvar)[_qp].resize(_num_phases);
65  (*_dtortuosity_dvar)[_qp].resize(_num_phases);
66  }
67 
68  for (unsigned int ph = 0; ph < _num_phases; ++ph)
69  {
70  _diffusion_coeff[_qp][ph].resize(_num_components);
71 
72  if (!is_ad)
73  {
74  (*_ddiffusion_coeff_dvar)[_qp][ph].resize(_num_components);
75  (*_dtortuosity_dvar)[_qp][ph].assign(_num_var, 0.0);
76  }
77 
78  for (unsigned int comp = 0; comp < _num_components; ++comp)
79  {
80  _diffusion_coeff[_qp][ph][comp] = _input_diffusion_coeff[ph + comp];
81 
82  if (!is_ad)
83  (*_ddiffusion_coeff_dvar)[_qp][ph][comp].assign(_num_var, 0.0);
84  }
85  }
86 }
PorousFlowMaterialVectorBase::_num_phases
const unsigned int _num_phases
Number of phases.
Definition: PorousFlowMaterialVectorBase.h:27
MaterialProperty::resize
virtual void resize(const std::size_t size) override final
PorousFlowMaterialVectorBase::_num_components
const unsigned int _num_components
Number of fluid components.
Definition: PorousFlowMaterialVectorBase.h:30
PorousFlowDiffusivityBaseTempl::_tortuosity
GenericMaterialProperty< std::vector< Real >, is_ad > & _tortuosity
Tortuosity tau_0 * tau_{alpha} for fluid phase alpha.
Definition: PorousFlowDiffusivityBase.h:27
PorousFlowMaterialVectorBase::_num_var
const unsigned int _num_var
Number of PorousFlow variables.
Definition: PorousFlowMaterialVectorBase.h:33
PorousFlowDiffusivityBaseTempl::_input_diffusion_coeff
const std::vector< Real > _input_diffusion_coeff
Input diffusion coefficients.
Definition: PorousFlowDiffusivityBase.h:39
PorousFlowDiffusivityBaseTempl::_diffusion_coeff
MaterialProperty< std::vector< std::vector< Real > > > & _diffusion_coeff
Diffusion coefficients of component k in fluid phase alpha.
Definition: PorousFlowDiffusivityBase.h:33

◆ validParams()

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

Definition at line 14 of file PorousFlowDiffusivityBase.C.

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

15 {
16  InputParameters params = PorousFlowMaterialVectorBase::validParams();
17  params.addRequiredParam<std::vector<Real>>(
18  "diffusion_coeff",
19  "List of diffusion coefficients. Order is i) component 0 in phase 0; ii) "
20  "component 1 in phase 0 ...; component 0 in phase 1; ... component k in "
21  "phase n (m^2/s");
22  params.addClassDescription("Base class for effective diffusivity for each phase");
23  params.set<bool>("at_nodes") = false;
24  params.addPrivateParam<std::string>("pf_material_type", "diffusivity");
25  return params;
26 }
InputParameters::addPrivateParam
void addPrivateParam(const std::string &name, const T &value)
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
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
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 PorousFlowVolumetricStrain::computeQpProperties(), PorousFlowAqueousPreDisChemistry::computeQpProperties(), PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties(), PorousFlowPorosityLinear::computeQpProperties(), PorousFlowPorosityHMBiotModulus::computeQpProperties(), PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity::computeQpProperties(), PorousFlowPorosityExponentialBase::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:
Generated on Fri Jul 18 2025 13:50:05 for https://mooseframework.inl.gov by   doxygen 1.8.14