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

This Material calculates rock-fluid combined thermal conductivity for the single phase, fully saturated case by using a linear weighted average. More...

#include <PorousFlowThermalConductivityFromPorosity.h>

Inheritance diagram for PorousFlowThermalConductivityFromPorosityTempl< is_ad >:
[legend]

Public Types

typedef DerivativeMaterialPropertyNameInterface::SymbolName SymbolName
 

Public Member Functions

 PorousFlowThermalConductivityFromPorosityTempl (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 RealTensorValue _la_s
 Thermal conductivity of the solid phase. More...
 
const RealTensorValue _la_f
 Thermal conductivity of the single fluid phase. More...
 
const GenericMaterialProperty< Real, is_ad > & _porosity_qp
 Quadpoint porosity. More...
 
const MaterialProperty< std::vector< Real > > *const _dporosity_qp_dvar
 d(quadpoint porosity)/d(PorousFlow variable) More...
 
 usingPorousFlowThermalConductivityMembers
 
GenericMaterialProperty< RealTensorValue, is_ad > & _la_qp
 Thermal conducitivity at the qps. More...
 
MaterialProperty< std::vector< RealTensorValue > > *const _dla_qp_dvar
 d(thermal conductivity at the qps)/d(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

template<bool is_ad>
class PorousFlowThermalConductivityFromPorosityTempl< is_ad >

This Material calculates rock-fluid combined thermal conductivity for the single phase, fully saturated case by using a linear weighted average.

Thermal conductivity = phi * lambda_f + (1 - phi) * lambda_s, where phi is porosity, and lambda_f, lambda_s are thermal conductivities of the fluid and solid (assumed constant)

Definition at line 23 of file PorousFlowThermalConductivityFromPorosity.h.

Constructor & Destructor Documentation

◆ PorousFlowThermalConductivityFromPorosityTempl()

Definition at line 35 of file PorousFlowThermalConductivityFromPorosity.C.

37  _la_s(this->template getParam<RealTensorValue>("lambda_s")),
38  _la_f(this->template getParam<RealTensorValue>("lambda_f")),
39  _porosity_qp(this->template getGenericMaterialProperty<Real, is_ad>("PorousFlow_porosity_qp")),
40  _dporosity_qp_dvar(is_ad ? nullptr
41  : &this->template getMaterialProperty<std::vector<Real>>(
42  "dPorousFlow_porosity_qp_dvar"))
43 {
44  if (_num_phases != 1)
45  this->paramError("fluid_phase",
46  "The Dictator proclaims that the number of phases is ",
47  _dictator.numPhases(),
48  " whereas this material can only be used for single phase "
49  "simulations. Be aware that the Dictator has noted your mistake.");
50 }
const MaterialProperty< std::vector< Real > > *const _dporosity_qp_dvar
d(quadpoint porosity)/d(PorousFlow variable)
const unsigned int _num_phases
Number of phases.
const GenericMaterialProperty< Real, is_ad > & _porosity_qp
Quadpoint porosity.
const RealTensorValue _la_s
Thermal conductivity of the solid phase.
const RealTensorValue _la_f
Thermal conductivity of the single fluid phase.
Base class for materials that provide thermal conducitivity.

Member Function Documentation

◆ computeQpProperties()

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

Definition at line 54 of file PorousFlowThermalConductivityFromPorosity.C.

55 {
56  _la_qp[_qp] = _la_s * (1.0 - _porosity_qp[_qp]) + _la_f * _porosity_qp[_qp];
57 
58  if constexpr (!is_ad)
59  {
60  (*_dla_qp_dvar)[_qp].assign(_num_var, RealTensorValue());
61  for (const auto v : make_range(_num_var))
62  (*_dla_qp_dvar)[_qp][v] = (_la_f - _la_s) * (*_dporosity_qp_dvar)[_qp][v];
63  }
64 }
const MaterialProperty< std::vector< Real > > *const _dporosity_qp_dvar
d(quadpoint porosity)/d(PorousFlow variable)
const GenericMaterialProperty< Real, is_ad > & _porosity_qp
Quadpoint porosity.
const RealTensorValue _la_s
Thermal conductivity of the solid phase.
TensorValue< Real > RealTensorValue
GenericMaterialProperty< RealTensorValue, is_ad > & _la_qp
Thermal conducitivity at the qps.
const RealTensorValue _la_f
Thermal conductivity of the single fluid phase.
const unsigned int _num_var
Number of PorousFlow variables.
static const std::string v
Definition: NS.h:84
IntRange< T > make_range(T beg, T end)

◆ validParams()

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

Definition at line 17 of file PorousFlowThermalConductivityFromPorosity.C.

18 {
20  params.addRequiredParam<RealTensorValue>("lambda_s",
21  "The thermal conductivity of the solid matrix material");
22  params.addRequiredParam<RealTensorValue>("lambda_f",
23  "The thermal conductivity of the single fluid phase");
24  params.addClassDescription("This Material calculates rock-fluid combined thermal conductivity "
25  "for the single phase, fully saturated case by using a linear "
26  "weighted average. "
27  "Thermal conductivity = phi * lambda_f + (1 - phi) * lambda_s, "
28  "where phi is porosity, and lambda_f, lambda_s are "
29  "thermal conductivities of the fluid and solid (assumed constant)");
30  return params;
31 }
void addRequiredParam(const std::string &name, const std::string &doc_string)
TensorValue< Real > RealTensorValue
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _dla_qp_dvar

template<bool is_ad>
MaterialProperty<std::vector<RealTensorValue> >* const PorousFlowThermalConductivityBaseTempl< is_ad >::_dla_qp_dvar
protectedinherited

d(thermal conductivity at the qps)/d(PorousFlow variable)

Definition at line 30 of file PorousFlowThermalConductivityBase.h.

◆ _dporosity_qp_dvar

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

d(quadpoint porosity)/d(PorousFlow variable)

Definition at line 44 of file PorousFlowThermalConductivityFromPorosity.h.

◆ _la_f

template<bool is_ad>
const RealTensorValue PorousFlowThermalConductivityFromPorosityTempl< is_ad >::_la_f
protected

Thermal conductivity of the single fluid phase.

Definition at line 38 of file PorousFlowThermalConductivityFromPorosity.h.

◆ _la_qp

template<bool is_ad>
GenericMaterialProperty<RealTensorValue, is_ad>& PorousFlowThermalConductivityBaseTempl< is_ad >::_la_qp
protectedinherited

Thermal conducitivity at the qps.

Definition at line 27 of file PorousFlowThermalConductivityBase.h.

◆ _la_s

template<bool is_ad>
const RealTensorValue PorousFlowThermalConductivityFromPorosityTempl< is_ad >::_la_s
protected

Thermal conductivity of the solid phase.

Definition at line 35 of file PorousFlowThermalConductivityFromPorosity.h.

◆ _num_components

const unsigned int PorousFlowMaterialVectorBase::_num_components
protectedinherited

◆ _num_phases

const unsigned int PorousFlowMaterialVectorBase::_num_phases
protectedinherited

◆ _num_var

const unsigned int PorousFlowMaterialVectorBase::_num_var
protectedinherited

◆ _porosity_qp

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

Quadpoint porosity.

Definition at line 41 of file PorousFlowThermalConductivityFromPorosity.h.

◆ usingPorousFlowThermalConductivityMembers

template<bool is_ad>
PorousFlowThermalConductivityFromPorosityTempl< is_ad >::usingPorousFlowThermalConductivityMembers
protected

Definition at line 46 of file PorousFlowThermalConductivityFromPorosity.h.


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