PorousFlow1PhaseP.C

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* 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 "PorousFlow1PhaseP.h"
#include "PorousFlowCapillaryPressure.h"

registerMooseObject("PorousFlowApp", PorousFlow1PhaseP);
registerMooseObject("PorousFlowApp", ADPorousFlow1PhaseP);

template <bool is_ad>
InputParameters
PorousFlow1PhasePTempl<is_ad>::validParams()
{
  InputParameters params = PorousFlowVariableBase::validParams();
  params.addRequiredCoupledVar("porepressure",
                               "Variable that represents the porepressure of the single phase");
  params.addRequiredParam<UserObjectName>("capillary_pressure",
                                          "Name of the UserObject defining the capillary pressure");
  params.addClassDescription("This Material is used for the partially saturated single-phase "
                             "situation where porepressure is the primary variable");
  return params;
}

template <bool is_ad>
PorousFlow1PhasePTempl<is_ad>::PorousFlow1PhasePTempl(const InputParameters & parameters)
  : PorousFlowVariableBaseTempl<is_ad>(parameters),
    _porepressure_var(_nodal_material ? this->template coupledGenericDofValue<is_ad>("porepressure")
                                      : this->template coupledGenericValue<is_ad>("porepressure")),
    _gradp_qp_var(this->template coupledGenericGradient<is_ad>("porepressure")),
    _porepressure_varnum(coupled("porepressure")),
    _p_var_num(_dictator.isPorousFlowVariable(_porepressure_varnum)
                   ? _dictator.porousFlowVariableNum(_porepressure_varnum)
                   : 0),
    _pc_uo(this->template getUserObject<PorousFlowCapillaryPressure>("capillary_pressure"))
{
  if (_num_phases != 1)
    mooseError("The Dictator proclaims that the number of phases is ",
               _dictator.numPhases(),
               " whereas PorousFlow1PhaseP can only be used for 1-phase simulations.  Be aware "
               "that the Dictator has noted your mistake.");
}

template <bool is_ad>
void
PorousFlow1PhasePTempl<is_ad>::initQpStatefulProperties()
{
  PorousFlowVariableBaseTempl<is_ad>::initQpStatefulProperties();
  buildQpPPSS();
}

template <bool is_ad>
void
PorousFlow1PhasePTempl<is_ad>::computeQpProperties()
{
  // size stuff correctly and prepare the derivative matrices with zeroes
  PorousFlowVariableBaseTempl<is_ad>::computeQpProperties();

  buildQpPPSS();

  const auto ds = _pc_uo.dSaturation(_porepressure_var[_qp]);

  if (!_nodal_material)
  {
    (*_gradp_qp)[_qp][0] = _gradp_qp_var[_qp];
    (*_grads_qp)[_qp][0] = ds * _gradp_qp_var[_qp];
  }

    // _porepressure is only dependent on _porepressure, and its derivative is 1
  if constexpr (!is_ad)
    if (_dictator.isPorousFlowVariable(_porepressure_varnum))
    {
      // _porepressure is a PorousFlow variable
      (*_dporepressure_dvar)[_qp][0][_p_var_num] = 1.0;
      (*_dsaturation_dvar)[_qp][0][_p_var_num] = ds;

      if (!_nodal_material)
      {
        (*_dgradp_qp_dgradv)[_qp][0][_p_var_num] = 1.0;
        (*_dgrads_qp_dgradv)[_qp][0][_p_var_num] = ds;
        (*_dgrads_qp_dv)[_qp][0][_p_var_num] =
            _pc_uo.d2Saturation(_porepressure_var[_qp]) * _gradp_qp_var[_qp];
      }
    }
}

template <bool is_ad>
void
PorousFlow1PhasePTempl<is_ad>::buildQpPPSS()
{
  _porepressure[_qp][0] = _porepressure_var[_qp];
  _saturation[_qp][0] = _pc_uo.saturation(_porepressure_var[_qp]);
}

template class PorousFlow1PhasePTempl<false>;
template class PorousFlow1PhasePTempl<true>;