PorousFlowThermalConductivityIdeal.C

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#include "PorousFlowThermalConductivityIdeal.h"

registerMooseObject("PorousFlowApp", PorousFlowThermalConductivityIdeal);
registerMooseObject("PorousFlowApp", ADPorousFlowThermalConductivityIdeal);

template <bool is_ad>
InputParameters
PorousFlowThermalConductivityIdealTempl<is_ad>::validParams()
{
  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;
}

template <bool is_ad>
PorousFlowThermalConductivityIdealTempl<is_ad>::PorousFlowThermalConductivityIdealTempl(
    const InputParameters & parameters)
  : 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");
}

template <bool is_ad>
void
PorousFlowThermalConductivityIdealTempl<is_ad>::computeQpProperties()
{
  _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);
  }
}

template class PorousFlowThermalConductivityIdealTempl<false>;
template class PorousFlowThermalConductivityIdealTempl<true>;