Moose::Kokkos::Dispatcher< Operation, Object > Class Template Reference

Class that dispatches a parallel loop operation of a Kokkos functor. More...

#include <KokkosDispatcher.h>

Inheritance diagram for Moose::Kokkos::Dispatcher< Operation, Object >:

Public Member Functions
	Dispatcher (const void *object)
	Constructor. More...
	Dispatcher (const Dispatcher &functor)
	Copy constructor for parallel dispatch. More...
void	parallelFor (const Policy &policy) override final
	Dispatch this functor with Kokkos parallel_for() given a Kokkos execution policy. More...
KOKKOS_FUNCTION void	operator() (const ThreadID tid) const
	The parallel computation entry function called by Kokkos::parallel_for. More...
virtual void	parallelReduce (const Policy &, ::Kokkos::View< Real *, ::Kokkos::HostSpace > &)
	Dispatch this functor with Kokkos parallel_reduce() given a Kokkos execution policy and result buffer. More...

Private Attributes
const Object &	_functor_host
	Reference of the functor on host. More...
const Object	_functor_device
	Copy of the functor on device. More...

Detailed Description

template<typename Operation, typename Object>
class Moose::Kokkos::Dispatcher< Operation, Object >

Class that dispatches a parallel loop operation of a Kokkos functor.

Calls operator() of the functor with a specified function tag.

Template Parameters

Operation	The function tag of operator() to be dispatched
Object	The functor class type

Definition at line 59 of file KokkosDispatcher.h.

Constructor & Destructor Documentation

Dispatcher() [1/2]

template<typename Operation , typename Object >

Moose::Kokkos::Dispatcher< Operation, Object >::Dispatcher ( const void *  object )

inline

Constructor.

Parameters

object

The pointer to the functor. This dispatcher is constructed by the base class of functors, and the actual type of functors is unknown by the base class. Therefore, it is passed as a void pointer and cast to the actual type here.

Definition at line 68 of file KokkosDispatcher.h.

    : _functor_host(*static_cast<const Object *>(object)), _functor_device(_functor_host)
  {
  }

Dispatcher() [2/2]

template<typename Operation , typename Object >

Moose::Kokkos::Dispatcher< Operation, Object >::Dispatcher ( const Dispatcher< Operation, Object > &  functor )

inline

Copy constructor for parallel dispatch.

Definition at line 75 of file KokkosDispatcher.h.

    : _functor_host(functor._functor_host), _functor_device(functor._functor_host)
  {
  }

Member Function Documentation

operator()()

template<typename Operation , typename Object >

KOKKOS_FUNCTION void Moose::Kokkos::Dispatcher< Operation, Object >::operator() ( const ThreadID  tid ) const

inline

The parallel computation entry function called by Kokkos::parallel_for.

Definition at line 89 of file KokkosDispatcher.h.

  {
    _functor_device(Operation{}, tid, _functor_device);
  }

parallelFor()

template<typename Operation , typename Object >

void Moose::Kokkos::Dispatcher< Operation, Object >::parallelFor ( const Policy &  )

inlinefinaloverridevirtual

Dispatch this functor with Kokkos parallel_for() given a Kokkos execution policy.

Parameters

policy

The Kokkos execution policy

Reimplemented from Moose::Kokkos::DispatcherBase.

Definition at line 80 of file KokkosDispatcher.h.

  {
    ::Kokkos::parallel_for(policy, *this);
    ::Kokkos::fence();
  }

parallelReduce()

virtual void Moose::Kokkos::DispatcherBase::parallelReduce ( const Policy &  , ::Kokkos::View< Real *, ::Kokkos::HostSpace > &    )

inlinevirtualinherited

Dispatch this functor with Kokkos parallel_reduce() given a Kokkos execution policy and result buffer.

Parameters

policy	The Kokkos execution policy
result	The result buffer

Reimplemented in Moose::Kokkos::Reducer< Operation, Object >.

Definition at line 45 of file KokkosDispatcher.h.

  {
    mooseError("parallelReduce() called for an instance that is not a reducer.");
  }

Member Data Documentation

_functor_device

template<typename Operation , typename Object >

const Object Moose::Kokkos::Dispatcher< Operation, Object >::_functor_device

private

Copy of the functor on device.

Definition at line 102 of file KokkosDispatcher.h.

Referenced by Moose::Kokkos::Dispatcher< Operation, Object >::operator()().

_functor_host

template<typename Operation , typename Object >

const Object& Moose::Kokkos::Dispatcher< Operation, Object >::_functor_host

private

Reference of the functor on host.

Definition at line 98 of file KokkosDispatcher.h.

---

The documentation for this class was generated from the following file:

• include/kokkos/base/KokkosDispatcher.h