KokkosTimeKernel.h

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

#pragma once

#include "KokkosKernel.h"

namespace Moose
{
namespace Kokkos
{

template <typename Derived>
class TimeKernel : public Kernel<Derived>
{
  usingKokkosKernelMembers(Derived);

public:
  static InputParameters validParams();

  TimeKernel(const InputParameters & parameters);

  KOKKOS_FUNCTION void computeResidualAdditional(const unsigned int /* ib */,
                                                 const unsigned int /* ie */,
                                                 ResidualDatum & /* datum */,
                                                 Real * /* local_re */) const
  {
  }

  KOKKOS_FUNCTION void computeResidualInternal(const Derived * kernel, ResidualDatum & datum) const;

protected:
  const VariableValue _u_dot;
  const Scalar<const Real> _du_dot_du;
};

template <typename Derived>
InputParameters
TimeKernel<Derived>::validParams()
{
  InputParameters params = Kernel<Derived>::validParams();

  params.set<MultiMooseEnum>("vector_tags") = "time";
  params.set<MultiMooseEnum>("matrix_tags") = "system time";

  return params;
}

template <typename Derived>
TimeKernel<Derived>::TimeKernel(const InputParameters & parameters)
  : Kernel<Derived>(parameters),
    _u_dot(_var, Moose::SOLUTION_DOT_TAG),
    _du_dot_du(_var.sys().duDotDu(_var.number()))
{
}

template <typename Derived>
KOKKOS_FUNCTION void
TimeKernel<Derived>::computeResidualInternal(const Derived * kernel, ResidualDatum & datum) const
{
  ResidualObject::computeResidualInternal(
      datum,
      [&](Real * local_re, const unsigned int ib, const unsigned int ie)
      {
        for (unsigned int qp = 0; qp < datum.n_qps(); ++qp)
        {
          datum.reinit();

          for (unsigned int i = ib; i < ie; ++i)
            local_re[i] += datum.JxW(qp) * kernel->computeQpResidual(i, qp, datum);
        }

        kernel->computeResidualAdditional(ib, ie, datum, local_re);
      });
}

} // namespace Kokkos
} // namespace Moose

#define usingKokkosTimeKernelMembers(T)                                                            \
  usingKokkosKernelMembers(T);                                                                     \
                                                                                                   \
protected:                                                                                         \
  using Moose::Kokkos::TimeKernel<T>::_u_dot;                                                      \
  using Moose::Kokkos::TimeKernel<T>::_du_dot_du