https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
PorousFlowDiffusivityConstTempl< is_ad > Class Template Reference

Material designed to provide constant tortuosity and diffusion coefficents. More...

#include <PorousFlowDiffusivityConst.h>

Inheritance diagram for PorousFlowDiffusivityConstTempl< is_ad >:
[legend]

Public Types

typedef DerivativeMaterialPropertyNameInterface::SymbolName SymbolName
 

Public Member Functions

 PorousFlowDiffusivityConstTempl (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 std::vector< Real > _input_tortuosity
 Input tortuosity. More...
 
 usingPorousFlowDiffusivityBaseMembers
 
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 PorousFlowDiffusivityConstTempl< is_ad >

Material designed to provide constant tortuosity and diffusion coefficents.

Definition at line 16 of file PorousFlowDiffusivityConst.h.

Constructor & Destructor Documentation

◆ PorousFlowDiffusivityConstTempl()

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

Definition at line 28 of file PorousFlowDiffusivityConst.C.

30  : PorousFlowDiffusivityBaseTempl<is_ad>(parameters),
31  _input_tortuosity(this->template getParam<std::vector<Real>>("tortuosity"))
32 {
33  // Check that the number of tortuosities entered is equal to the number of phases
34  if (_input_tortuosity.size() != _num_phases)
35  this->paramError("tortuosity",
36  "The number of tortuosity values entered is not equal to the number of phases "
37  "specified in the Dictator");
38 
39  // Check that all tortuosities are (0, 1]
40  for (unsigned int i = 0; i < _num_phases; ++i)
41  if (_input_tortuosity[i] <= 0.0 || _input_tortuosity[i] > 1)
42  this->paramError(
43  "tortuosity",
44  "All tortuosities must be greater than zero and less than (or equal to) one"
45  ".\nNote: the definition of tortuosity used is l/le, where l is the straight line "
46  "length and le is the effective flow length");
47 }
PorousFlowMaterialVectorBase::_num_phases
const unsigned int _num_phases
Number of phases.
Definition: PorousFlowMaterialVectorBase.h:27
PorousFlowDiffusivityConstTempl::_input_tortuosity
const std::vector< Real > _input_tortuosity
Input tortuosity.
Definition: PorousFlowDiffusivityConst.h:27
PorousFlowDiffusivityBaseTempl
Base class Material designed to provide the tortuosity and diffusion coefficents. ...
Definition: PorousFlowDiffusivityBase.h:16

Member Function Documentation

◆ computeQpProperties()

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

Reimplemented from PorousFlowDiffusivityBaseTempl< is_ad >.

Definition at line 51 of file PorousFlowDiffusivityConst.C.

52 {
53  PorousFlowDiffusivityBaseTempl<is_ad>::computeQpProperties();
54 
55  for (unsigned int ph = 0; ph < _num_phases; ++ph)
56  _tortuosity[_qp][ph] = _input_tortuosity[ph];
57 }
PorousFlowMaterialVectorBase::_num_phases
const unsigned int _num_phases
Number of phases.
Definition: PorousFlowMaterialVectorBase.h:27
PorousFlowDiffusivityConstTempl::_input_tortuosity
const std::vector< Real > _input_tortuosity
Input tortuosity.
Definition: PorousFlowDiffusivityConst.h:27
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

◆ validParams()

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

Definition at line 17 of file PorousFlowDiffusivityConst.C.

18 {
19  InputParameters params = PorousFlowDiffusivityBaseTempl<is_ad>::validParams();
20  params.addRequiredParam<std::vector<Real>>(
21  "tortuosity", "List of tortuosities. Order is i) phase 0; ii) phase 1; etc");
22  params.addClassDescription(
23  "This Material provides constant tortuosity and diffusion coefficients");
24  return params;
25 }
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
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.

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

◆ _input_tortuosity

template<bool is_ad>
const std::vector<Real> PorousFlowDiffusivityConstTempl< is_ad >::_input_tortuosity
protected

Input tortuosity.

Definition at line 27 of file PorousFlowDiffusivityConst.h.

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

◆ _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
protectedinherited

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

Definition at line 27 of file PorousFlowDiffusivityBase.h.

◆ usingPorousFlowDiffusivityBaseMembers

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

Definition at line 29 of file PorousFlowDiffusivityConst.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