KokkosFunction.h

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
 
#pragma once
 
#include "KokkosTypes.h"
#include "KokkosFunctionWrapper.h"
#include "KokkosFunctorRegistry.h"
 
#include "FunctionBase.h"
 
namespace Moose::Kokkos
{
 
class FunctionBase : public Moose::FunctionBase
{
public:
  static InputParameters validParams();
 
  FunctionBase(const InputParameters & parameters);
  FunctionBase(const FunctionBase & object);
 
  KOKKOS_FUNCTION Real value(Real /* t */, Real3 /* p */) const
  {
    KOKKOS_ASSERT(false);
    return 0;
  }
  KOKKOS_FUNCTION Real3 vectorValue(Real /* t */, Real3 /* p */) const
  {
    KOKKOS_ASSERT(false);
    return Real3(0);
  }
  KOKKOS_FUNCTION Real3 gradient(Real /* t */, Real3 /* p */) const
  {
    KOKKOS_ASSERT(false);
    return Real3(0);
  }
  KOKKOS_FUNCTION Real3 curl(Real /* t */, Real3 /* p */) const
  {
    KOKKOS_ASSERT(false);
    return Real3(0);
  }
  KOKKOS_FUNCTION Real div(Real /* t */, Real3 /* p */) const
  {
    KOKKOS_ASSERT(false);
    return 0;
  }
  KOKKOS_FUNCTION Real timeDerivative(Real /* t */, Real3 /* p */) const
  {
    KOKKOS_ASSERT(false);
    return 0;
  }
  KOKKOS_FUNCTION Real timeIntegral(Real /* t1 */, Real /* t2 */, Real3 /* p */) const
  {
    KOKKOS_ASSERT(false);
    return 0;
  }
  KOKKOS_FUNCTION Real integral() const
  {
    KOKKOS_ASSERT(false);
    return 0;
  }
  KOKKOS_FUNCTION Real average() const
  {
    KOKKOS_ASSERT(false);
    return 0;
  }
};
 
class Function final
{
public:
  Function() = default;
  Function(std::shared_ptr<FunctionWrapperHostBase> wrapper);
  Function(const Function & function);
  ~Function();
 
  Function & operator=(const Function & function) = default;
 
  KOKKOS_FUNCTION operator bool() const
  {
    KOKKOS_IF_ON_HOST(return static_cast<bool>(_wrapper_host);)
 
    return _wrapper_device != nullptr;
  }
 
  KOKKOS_FUNCTION Real value(Real t, Real3 p) const
  {
    KOKKOS_ASSERT(_wrapper_device);
 
    return _wrapper_device->value(t, p);
  }
  KOKKOS_FUNCTION Real3 vectorValue(Real t, Real3 p) const
  {
    KOKKOS_ASSERT(_wrapper_device);
 
    return _wrapper_device->vectorValue(t, p);
  }
  KOKKOS_FUNCTION Real3 gradient(Real t, Real3 p) const
  {
    KOKKOS_ASSERT(_wrapper_device);
 
    return _wrapper_device->gradient(t, p);
  }
  KOKKOS_FUNCTION Real3 curl(Real t, Real3 p) const
  {
    KOKKOS_ASSERT(_wrapper_device);
 
    return _wrapper_device->curl(t, p);
  }
  KOKKOS_FUNCTION Real div(Real t, Real3 p) const
  {
    KOKKOS_ASSERT(_wrapper_device);
 
    return _wrapper_device->div(t, p);
  }
  KOKKOS_FUNCTION Real timeDerivative(Real t, Real3 p) const
  {
    KOKKOS_ASSERT(_wrapper_device);
 
    return _wrapper_device->timeDerivative(t, p);
  }
  KOKKOS_FUNCTION Real timeIntegral(Real t1, Real t2, Real3 p) const
  {
    KOKKOS_ASSERT(_wrapper_device);
 
    return _wrapper_device->timeIntegral(t1, t2, p);
  }
  KOKKOS_FUNCTION Real integral() const
  {
    KOKKOS_ASSERT(_wrapper_device);
 
    return _wrapper_device->integral();
  }
  KOKKOS_FUNCTION Real average() const
  {
    KOKKOS_ASSERT(_wrapper_device);
 
    return _wrapper_device->average();
  }
 
private:
  std::shared_ptr<FunctionWrapperHostBase> _wrapper_host;
  FunctionWrapperDeviceBase * _wrapper_device = nullptr;
};
 
template <>
struct ArrayDeepCopy<Function>
{
  static constexpr bool value = true;
};
 
} // namespace Moose::Kokkos