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

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

#include <KokkosDispatcher.h>

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

Public Types
using	value_type = Real[]
using	size_type = ::Kokkos::View< Real * >::size_type

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

Public Attributes
size_type	value_count

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::Reducer< Operation, Object >

Class that dispatches a parallel reduction 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 113 of file KokkosDispatcher.h.

Member Typedef Documentation

size_type

template<typename Operation , typename Object >

using Moose::Kokkos::Reducer< Operation, Object >::size_type = ::Kokkos::View<Real *>::size_type

Definition at line 146 of file KokkosDispatcher.h.

value_type

template<typename Operation , typename Object >

using Moose::Kokkos::Reducer< Operation, Object >::value_type = Real[]

Definition at line 145 of file KokkosDispatcher.h.

Constructor & Destructor Documentation

Reducer() [1/2]

template<typename Operation , typename Object >

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

inline

Constructor.

Parameters

object

The pointer to the functor. This reducer 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 122 of file KokkosDispatcher.h.

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

Reducer() [2/2]

template<typename Operation , typename Object >

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

inline

Copy constructor for parallel dispatch.

Definition at line 129 of file KokkosDispatcher.h.

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

Member Function Documentation

init()

template<typename Operation , typename Object >

KOKKOS_FUNCTION void Moose::Kokkos::Reducer< Operation, Object >::init ( value_type  result ) const

inline

Definition at line 166 of file KokkosDispatcher.h.

  {
    _functor_device.template init<Object>(result);
  }

join()

template<typename Operation , typename Object >

KOKKOS_FUNCTION void Moose::Kokkos::Reducer< Operation, Object >::join ( value_type  result, const value_type  source  ) const

inline

Functions required by the reducer concept of Kokkos.

Definition at line 162 of file KokkosDispatcher.h.

  {
    _functor_device.template join<Object>(result, source);
  }

operator()()

template<typename Operation , typename Object >

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

inline

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

Definition at line 153 of file KokkosDispatcher.h.

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

parallelFor()

virtual void Moose::Kokkos::DispatcherBase::parallelFor ( const Policy &  )

inlinevirtualinherited

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

Parameters

policy

The Kokkos execution policy

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

Definition at line 36 of file KokkosDispatcher.h.

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

parallelReduce()

template<typename Operation , typename Object >

void Moose::Kokkos::Reducer< Operation, Object >::parallelReduce ( const Policy &  , ::Kokkos::View< Real *, ::Kokkos::HostSpace > &    )

inlinefinaloverridevirtual

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 from Moose::Kokkos::DispatcherBase.

Definition at line 136 of file KokkosDispatcher.h.

  {
    value_count = result.size();

    ::Kokkos::parallel_reduce(policy, *this, result);
    ::Kokkos::fence();
  }

Member Data Documentation

_functor_device

template<typename Operation , typename Object >

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

private

Copy of the functor on device.

Definition at line 180 of file KokkosDispatcher.h.

Referenced by Moose::Kokkos::Reducer< Operation, Object >::init(), and Moose::Kokkos::Reducer< Operation, Object >::operator()().

_functor_host

template<typename Operation , typename Object >

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

private

Reference of the functor on host.

Definition at line 176 of file KokkosDispatcher.h.

value_count

template<typename Operation , typename Object >

size_type Moose::Kokkos::Reducer< Operation, Object >::value_count

Definition at line 148 of file KokkosDispatcher.h.

Referenced by Moose::Kokkos::Reducer< Operation, Object >::parallelReduce().

---

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

• include/kokkos/base/KokkosDispatcher.h