PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity.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 "PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity.h"

registerMooseObject("PorousFlowApp", PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity);

InputParameters
PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity::validParams()
{
  InputParameters params = PorousFlowTotalGravitationalDensityBase::validParams();
  params.addRequiredRangeCheckedParam<Real>(
      "rho_s", "rho_s >= 0", "The density of the solid matrix");
  params.addClassDescription(
      "This Material calculates the porous medium density from the porosity, solid density "
      "(assumed constant) and fluid density, for the fully-saturated single fluid phase case, "
      "using a linear weighted average. "
      "density = phi * rho_f + (1 - phi) * rho_s, where phi is porosity and rho_f, rho_s are "
      "the densities of the fluid and solid phases.");
  return params;
}

PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity::
    PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity(
        const InputParameters & parameters)
  : PorousFlowTotalGravitationalDensityBase(parameters),
    _rho_s(getParam<Real>("rho_s")),
    _rho_f_qp(getMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_density_qp")),
    _porosity_qp(getMaterialProperty<Real>("PorousFlow_porosity_qp")),
    _drho_f_qp_dvar(getMaterialProperty<std::vector<std::vector<Real>>>(
        "dPorousFlow_fluid_phase_density_qp_dvar")),
    _dporosity_qp_dvar(getMaterialProperty<std::vector<Real>>("dPorousFlow_porosity_qp_dvar"))
{
  if (_num_phases != 1)
    mooseError("The Dictator proclaims that the number of phases is ",
               _dictator.numPhases(),
               " whereas PorousFlowThermalConductivityFromPorosity can only be used for 1-phase "
               "simulations. Be aware that the Dictator has noted your mistake.");

  if (_nodal_material == true)
    mooseError("PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity is only defined for "
               "at_nodes = false");
}

void
PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity::initQpStatefulProperties()
{
  const unsigned ph = 0;
  _gravdensity[_qp] = _rho_s * (1.0 - _porosity_qp[_qp]) + _rho_f_qp[_qp][ph] * _porosity_qp[_qp];
}

void
PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity::computeQpProperties()
{
  const unsigned ph = 0;
  _gravdensity[_qp] = _rho_s * (1.0 - _porosity_qp[_qp]) + _rho_f_qp[_qp][ph] * _porosity_qp[_qp];

  _dgravdensity_dvar[_qp].resize(_num_var);
  for (unsigned int v = 0; v < _num_var; ++v)
  {
    _dgravdensity_dvar[_qp][v] = _dporosity_qp_dvar[_qp][v] * (_rho_f_qp[_qp][ph] - _rho_s) +
                                 _drho_f_qp_dvar[_qp][ph][v] * _porosity_qp[_qp];
  }
}