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

registerMooseObject("MooseApp", TimeDerivativeAux);

InputParameters
TimeDerivativeAux::validParams()
{
  InputParameters params = AuxKernel::validParams();
  params.addClassDescription(
      "Returns the time derivative of the specified variable/functor as an auxiliary variable.");

  params.addParam<MooseFunctorName>("functor", "Functor to take the time derivative of");
  params.addParam<MooseFunctorName>("factor", 1, "Factor to multiply the time derivative by");

  return params;
}

TimeDerivativeAux::TimeDerivativeAux(const InputParameters & parameters)
  : AuxKernel(parameters),
    _functor(getFunctor<Real>("functor")),
    _factor(getFunctor<Real>("factor")),
    _use_qp_arg(dynamic_cast<MooseVariableFE<Real> *>(&_var))
{
  const auto functor_name = getParam<MooseFunctorName>("functor");
  if (_subproblem.hasVariable(functor_name))
  {
    const auto * functor_var = &_subproblem.getVariable(_tid, functor_name);
    if (dynamic_cast<const MooseVariableFE<Real> *>(&_var) &&
        !dynamic_cast<const MooseVariableFE<Real> *>(functor_var))
      mooseWarning("'variable' argument is a finite element variable but 'functor' is not.");
    if (!dynamic_cast<const MooseVariableFE<Real> *>(&_var) &&
        dynamic_cast<const MooseVariableFE<Real> *>(functor_var))
      mooseWarning("'functor' argument is a finite element variable but 'variable' is not.");
  }
  if (isNodal())
    paramError("variable", "This AuxKernel only supports Elemental fields");
}

Real
TimeDerivativeAux::computeValue()
{
  if (_use_qp_arg)
  {
    const Moose::ElemQpArg qp_arg = {_current_elem, _qp, _qrule, _q_point[_qp]};
    return _factor(qp_arg, determineState()) * _functor.dot(qp_arg, determineState());
  }
  else
  {
    const auto elem_arg = makeElemArg(_current_elem);
    return _factor(elem_arg, determineState()) * _functor.dot(elem_arg, determineState());
  }
}