KokkosUserObject.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 "KokkosMesh.h"
#include "KokkosAssembly.h"
#include "KokkosFESystem.h"
#include "KokkosDispatcher.h"
 
#include "UserObjectBase.h"
 
namespace Moose::Kokkos
{
 
class UserObject : public ::UserObjectBase
{
public:
  static InputParameters validParams();
 
  UserObject(const InputParameters & params);
 
  UserObject(const UserObject & object);
 
  // Unused for Kokkos user objects because all subdomains are computed in parallel
  virtual void subdomainSetup() override final {}
 
  // Kokkos user objects are never threaded
  virtual bool needThreadedCopy() const override final { return false; }
 
  virtual void compute() = 0;
 
  struct DefaultLoop
  {
  };
 
  template <typename Derived>
  KOKKOS_FUNCTION void execute(Datum & /* datum */) const
  {
    ::Kokkos::abort("Default execute() should never be called. Make sure you properly redefined "
                    "this method in your class without typos.");
  }
 
  template <typename Derived>
  static auto defaultExecute()
  {
    return &UserObject::execute<Derived>;
  }
 
protected:
  virtual void computeUserObject();
  virtual ThreadID numUserObjectThreads() const = 0;
 
  std::unique_ptr<DispatcherBase> _user_object_dispatcher;
};
 
} // namespace Moose::Kokkos