PorousFlowThermalConductivityIdealTempl< is_ad > Class Template Reference

This material computes thermal conductivity for a PorousMedium - fluid system, by using Thermal conductivity = dry_thermal_conductivity + S^exponent * (wet_thermal_conductivity - dry_thermal_conductivity), where S is the aqueous saturation. More...

#include <PorousFlowThermalConductivityIdeal.h>

Inheritance diagram for PorousFlowThermalConductivityIdealTempl< is_ad >:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	PorousFlowThermalConductivityIdealTempl (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_dry
	Dry thermal conductivity of rock. More...
const bool	_wet_and_dry_differ
	Whether _la_wet has been supplied. More...
const RealTensorValue	_la_wet
	Wet thermal conductivity of rock. More...
const Real	_exponent
	Exponent for saturation. More...
const bool	_aqueous_phase
	Whether this is a fluid simulation. More...
const unsigned	_aqueous_phase_number
	Phase number of the aqueous phase. More...
const GenericMaterialProperty< std::vector< Real >, is_ad > *const	_saturation_qp
	Saturation of the fluid phases at the quadpoints. More...
const MaterialProperty< std::vector< std::vector< Real > > > *const	_dsaturation_qp_dvar
	d(Saturation)/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 PorousFlowThermalConductivityIdealTempl< is_ad >

This material computes thermal conductivity for a PorousMedium - fluid system, by using Thermal conductivity = dry_thermal_conductivity + S^exponent * (wet_thermal_conductivity - dry_thermal_conductivity), where S is the aqueous saturation.

Definition at line 22 of file PorousFlowThermalConductivityIdeal.h.

Constructor & Destructor Documentation

PorousFlowThermalConductivityIdealTempl()

template<bool is_ad>

PorousFlowThermalConductivityIdealTempl< is_ad >::PorousFlowThermalConductivityIdealTempl

(

const InputParameters &

parameters

)

Definition at line 46 of file PorousFlowThermalConductivityIdeal.C.

  : PorousFlowThermalConductivityBaseTempl<is_ad>(parameters),
    _la_dry(this->template getParam<RealTensorValue>("dry_thermal_conductivity")),
    _wet_and_dry_differ(parameters.isParamValid("wet_thermal_conductivity")),
    _la_wet(_wet_and_dry_differ
                ? this->template getParam<RealTensorValue>("wet_thermal_conductivity")
                : this->template getParam<RealTensorValue>("dry_thermal_conductivity")),
    _exponent(this->template getParam<Real>("exponent")),
    _aqueous_phase(_num_phases > 0),
    _aqueous_phase_number(this->template getParam<unsigned>("aqueous_phase_number")),
    _saturation_qp(_aqueous_phase
                       ? &this->template getGenericMaterialProperty<std::vector<Real>, is_ad>(
                             "PorousFlow_saturation_qp")
                       : nullptr),
    _dsaturation_qp_dvar(_aqueous_phase && !is_ad
                             ? &this->template getMaterialProperty<std::vector<std::vector<Real>>>(
                                   "dPorousFlow_saturation_qp_dvar")
                             : nullptr)
{
  if (_aqueous_phase && (_aqueous_phase_number >= _num_phases))
    mooseError("PorousFlowThermalConductivityIdeal: Your aqueous phase number, ",
               _aqueous_phase_number,
               " must not exceed the number of fluid phases in the system, which is ",
               _num_phases,
               "\n");
}

Member Function Documentation

computeQpProperties()

template<bool is_ad>

void PorousFlowThermalConductivityIdealTempl< is_ad >::computeQpProperties ( )

overrideprotectedvirtual

Definition at line 76 of file PorousFlowThermalConductivityIdeal.C.

{
  _la_qp[_qp] = _la_dry;
  if (_aqueous_phase && _wet_and_dry_differ)
    _la_qp[_qp] +=
        std::pow((*_saturation_qp)[_qp][_aqueous_phase_number], _exponent) * (_la_wet - _la_dry);

  if constexpr (!is_ad)
  {
    (*_dla_qp_dvar)[_qp].assign(_num_var, RealTensorValue());
    if (_aqueous_phase && _wet_and_dry_differ)
      for (const auto v : make_range(_num_var))
        (*_dla_qp_dvar)[_qp][v] =
            _exponent * std::pow((*_saturation_qp)[_qp][_aqueous_phase_number], _exponent - 1.0) *
            (*_dsaturation_qp_dvar)[_qp][_aqueous_phase_number][v] * (_la_wet - _la_dry);
  }
}

validParams()

template<bool is_ad>

InputParameters PorousFlowThermalConductivityIdealTempl< is_ad >::validParams ( )

static

Definition at line 17 of file PorousFlowThermalConductivityIdeal.C.

{
  InputParameters params = PorousFlowThermalConductivityBaseTempl<is_ad>::validParams();
  params.addRequiredParam<RealTensorValue>(
      "dry_thermal_conductivity",
      "The thermal conductivity of the rock matrix when the aqueous saturation is zero");
  params.addParam<RealTensorValue>("wet_thermal_conductivity",
                                   "The thermal conductivity of the rock matrix when the aqueous "
                                   "saturation is unity.  This defaults to "
                                   "dry_thermal_conductivity.");
  params.addParam<Real>("exponent",
                        1.0,
                        "Exponent on saturation.  Thermal conductivity = "
                        "dry_thermal_conductivity + S^exponent * "
                        "(wet_thermal_conductivity - dry_thermal_conductivity), "
                        "where S is the aqueous saturation");
  params.addParam<unsigned>("aqueous_phase_number",
                            0,
                            "The phase number of the aqueous phase.  In simulations without "
                            "fluids, this parameter and the exponent parameter will not be "
                            "used: only the dry_thermal_conductivity will be used.");
  params.addClassDescription("This Material calculates rock-fluid combined thermal conductivity by "
                             "using a weighted sum.  Thermal conductivity = "
                             "dry_thermal_conductivity + S^exponent * (wet_thermal_conductivity - "
                             "dry_thermal_conductivity), where S is the aqueous saturation");
  return params;
}

Member Data Documentation

_aqueous_phase

template<bool is_ad>

const bool PorousFlowThermalConductivityIdealTempl< is_ad >::_aqueous_phase

protected

Whether this is a fluid simulation.

Definition at line 45 of file PorousFlowThermalConductivityIdeal.h.

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

_aqueous_phase_number

template<bool is_ad>

const unsigned PorousFlowThermalConductivityIdealTempl< is_ad >::_aqueous_phase_number

protected

Phase number of the aqueous phase.

Definition at line 48 of file PorousFlowThermalConductivityIdeal.h.

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

_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.

_dsaturation_qp_dvar

template<bool is_ad>

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowThermalConductivityIdealTempl< is_ad >::_dsaturation_qp_dvar

protected

d(Saturation)/d(PorousFlow variable)

Definition at line 54 of file PorousFlowThermalConductivityIdeal.h.

_exponent

template<bool is_ad>

const Real PorousFlowThermalConductivityIdealTempl< is_ad >::_exponent

protected

Exponent for saturation.

Definition at line 42 of file PorousFlowThermalConductivityIdeal.h.

_la_dry

template<bool is_ad>

const RealTensorValue PorousFlowThermalConductivityIdealTempl< is_ad >::_la_dry

protected

Dry thermal conductivity of rock.

Definition at line 33 of file PorousFlowThermalConductivityIdeal.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_wet

template<bool is_ad>

const RealTensorValue PorousFlowThermalConductivityIdealTempl< is_ad >::_la_wet

protected

Wet thermal conductivity of rock.

Definition at line 39 of file PorousFlowThermalConductivityIdeal.h.

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

_saturation_qp

template<bool is_ad>

const GenericMaterialProperty<std::vector<Real>, is_ad>* const PorousFlowThermalConductivityIdealTempl< is_ad >::_saturation_qp

protected

Saturation of the fluid phases at the quadpoints.

Definition at line 51 of file PorousFlowThermalConductivityIdeal.h.

_wet_and_dry_differ

template<bool is_ad>

const bool PorousFlowThermalConductivityIdealTempl< is_ad >::_wet_and_dry_differ

protected

Whether _la_wet has been supplied.

Definition at line 36 of file PorousFlowThermalConductivityIdeal.h.

usingPorousFlowThermalConductivityMembers

template<bool is_ad>

PorousFlowThermalConductivityIdealTempl< is_ad >::usingPorousFlowThermalConductivityMembers

protected

Definition at line 56 of file PorousFlowThermalConductivityIdeal.h.

---

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

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