PINSFVEnergyTimeDerivative.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 "PINSFVEnergyTimeDerivative.h"
#include "INSFVEnergyVariable.h"

#include "NS.h"

registerMooseObject("NavierStokesApp", PINSFVEnergyTimeDerivative);

InputParameters
PINSFVEnergyTimeDerivative::validParams()
{
  InputParameters params = FVFunctorTimeKernel::validParams();
  params.addClassDescription(
      "Adds the time derivative term to the Navier-Stokes energy equation: "
      "for fluids: d(eps * rho * cp * T)/dt, for solids: (1 - eps) * d(rho * cp * T)/dt"
      "Material property derivatives are ignored if not provided.");
  params.addRequiredParam<MooseFunctorName>(NS::density, "Density");
  params.addParam<MooseFunctorName>(NS::time_deriv(NS::density), "Density time derivative functor");
  params.addParam<MooseFunctorName>(NS::cp, "Specific heat capacity");
  params.addParam<MooseFunctorName>(NS::specific_enthalpy, "Specific enthalpy");
  params.addParam<MooseFunctorName>(NS::time_deriv(NS::specific_enthalpy),
                                    "Time derivative of the specific enthalpy");
  params.addRequiredParam<MooseFunctorName>(NS::porosity, "Porosity");

  params.addRequiredParam<bool>("is_solid", "Whether this kernel acts on the solid temperature");
  params.addRangeCheckedParam<Real>("scaling",
                                    1,
                                    "scaling >= 0.0",
                                    "scaling factor to reduce the thermal mass during pseudo "
                                    "transients; this can accelerate convergence to steady state");
  return params;
}

PINSFVEnergyTimeDerivative::PINSFVEnergyTimeDerivative(const InputParameters & params)
  : FVFunctorTimeKernel(params),
    _rho(getFunctor<ADReal>(NS::density)),
    _rho_dot(isParamValid(NS::time_deriv(NS::density))
                 ? &getFunctor<ADReal>(NS::time_deriv(NS::density))
                 : nullptr),
    _cp(isParamValid(NS::cp) ? &getFunctor<ADReal>(NS::cp) : nullptr),
    _h(isParamValid(NS::specific_enthalpy) ? &getFunctor<ADReal>(NS::specific_enthalpy) : nullptr),
    _h_dot(isParamValid(NS::time_deriv(NS::specific_enthalpy))
               ? &getFunctor<ADReal>(NS::time_deriv(NS::specific_enthalpy))
               : nullptr),
    _eps(getFunctor<ADReal>(NS::porosity)),
    _is_solid(getParam<bool>("is_solid")),
    _scaling(getParam<Real>("scaling")),
    _zero_scaling(_scaling < 1e-8)
{
  if (_h_dot && _cp)
    paramError(NS::time_deriv(NS::specific_enthalpy),
               "If specifying the specific enthalpy time derivative, no need to specify the "
               "specific heat");
  if (!_h_dot && !_cp)
    paramError(
        NS::time_deriv(NS::specific_enthalpy),
        "One of either the specific heat or the time derivative of the enthalpy must be specified");
  if (_rho_dot && (!_cp && !_h))
    paramError(NS::time_deriv(NS::density),
               "If specifying the time derivative of the density, either the specific heat or the "
               "specific enthalpy must be specified");
}

ADReal
PINSFVEnergyTimeDerivative::computeQpResidual()
{
  if (_zero_scaling)
    return 0.0;
  else
  {
    auto elem_arg = makeElemArg(_current_elem);
    const auto state = determineState();
    ADReal time_derivative;
    if (_h_dot)
    {
      time_derivative = _rho(elem_arg, state) * (*_h_dot)(elem_arg, state);
      if (_rho_dot)
        time_derivative += (*_rho_dot)(elem_arg, state) * (*_h)(elem_arg, state);
    }
    else
    {
      time_derivative = _rho(elem_arg, state) * (*_cp)(elem_arg, state) * _var.dot(elem_arg, state);
      if (_rho_dot)
        time_derivative +=
            (*_rho_dot)(elem_arg, state) * (*_cp)(elem_arg, state) * _var(elem_arg, state);
    }

    return _scaling * (_is_solid ? 1 - _eps(elem_arg, state) : _eps(elem_arg, state)) *
           time_derivative;
  }
}