Moose::Kokkos::FunctorWrapperHost< Object > Class Template Reference

Host functor wrapper class that allocates a functor on device and creates its device wrapper. More...

#include <KokkosFunctorWrapper.h>

Inheritance diagram for Moose::Kokkos::FunctorWrapperHost< Object >:

Public Member Functions
	FunctorWrapperHost (const void *functor)
	Constructor.
	~FunctorWrapperHost ()
	Desturctor.
FunctorWrapperDeviceBase *	allocate () override final
	Allocate device functor and wrapper.
void	copyFunctor () override final
	Copy functor to device.
void	freeFunctor () override final
	Free host and device copies of functor.

Private Attributes
const Object &	_functor_host
	Reference of the functor on host.
std::unique_ptr< Object >	_functor_copy
	Copy of the functor on host.
Object *	_functor_device = nullptr
	Copy of the functor on device.

Detailed Description

template<typename Object>
class Moose::Kokkos::FunctorWrapperHost< Object >

Host functor wrapper class that allocates a functor on device and creates its device wrapper.

This class holds the actual device instance of the functor and manages its allocation and deallocation, and the device wrapper simply keeps a pointer to it.

Template Parameters

Object

The functor class type

Definition at line 93 of file KokkosFunctorWrapper.h.

Constructor & Destructor Documentation

FunctorWrapperHost()

template<typename Object >

Moose::Kokkos::FunctorWrapperHost< Object >::FunctorWrapperHost ( const void *  functor )

inline

Constructor.

Parameters

functor

Pointer to the functor

Definition at line 100 of file KokkosFunctorWrapper.h.

: _functor_host(*static_cast<const Object *>(functor)) {}

~FunctorWrapperHost()

template<typename Object >

Moose::Kokkos::FunctorWrapperHost< Object >::~FunctorWrapperHost

(

)

Desturctor.

Definition at line 168 of file KokkosFunctorWrapper.h.

{
  ::Kokkos::kokkos_free<ExecSpace::memory_space>(_functor_device);
}

Member Function Documentation

allocate()

template<typename Object >

FunctorWrapperDeviceBase * Moose::Kokkos::FunctorWrapperHost< Object >::allocate ( )

finaloverridevirtual

Allocate device functor and wrapper.

Returns

The pointer to the device wrapper

Implements Moose::Kokkos::FunctorWrapperHostBase.

Definition at line 127 of file KokkosFunctorWrapper.h.

{
  // Allocate storage for device wrapper on device
  auto wrapper_device = static_cast<FunctorWrapperDevice<Object> *>(
      ::Kokkos::kokkos_malloc<ExecSpace::memory_space>(sizeof(FunctorWrapperDevice<Object>)));
 
  // Allocate device wrapper on device using placement new to populate vtable with device pointers
  ::Kokkos::parallel_for(
      1, KOKKOS_LAMBDA(const int) { new (wrapper_device) FunctorWrapperDevice<Object>(); });
 
  // Allocate storage for functor on device
  _functor_device =
      static_cast<Object *>(::Kokkos::kokkos_malloc<ExecSpace::memory_space>(sizeof(Object)));
 
  // Let device wrapper point to the copy
  ::Kokkos::Impl::DeepCopy<MemSpace, ::Kokkos::HostSpace>(
      &(wrapper_device->_functor), &_functor_device, sizeof(Object *));
 
  return wrapper_device;
}

copyFunctor()

template<typename Object >

void Moose::Kokkos::FunctorWrapperHost< Object >::copyFunctor ( )

finaloverridevirtual

Copy functor to device.

Implements Moose::Kokkos::FunctorWrapperHostBase.

Definition at line 150 of file KokkosFunctorWrapper.h.

{
  // Make a copy of functor on host to trigger copy constructor
  _functor_copy = std::make_unique<Object>(_functor_host);
 
  // Copy functor to device
  ::Kokkos::Impl::DeepCopy<MemSpace, ::Kokkos::HostSpace>(
      _functor_device, _functor_copy.get(), sizeof(Object));
}

freeFunctor()

template<typename Object >

void Moose::Kokkos::FunctorWrapperHost< Object >::freeFunctor ( )

finaloverridevirtual

Free host and device copies of functor.

Implements Moose::Kokkos::FunctorWrapperHostBase.

Definition at line 162 of file KokkosFunctorWrapper.h.

{
  _functor_copy.reset();
}

Member Data Documentation

_functor_copy

template<typename Object >

std::unique_ptr<Object> Moose::Kokkos::FunctorWrapperHost< Object >::_functor_copy

private

Copy of the functor on host.

Definition at line 118 of file KokkosFunctorWrapper.h.

Referenced by Moose::Kokkos::FunctorWrapperHost< Object >::copyFunctor(), and Moose::Kokkos::FunctorWrapperHost< Object >::freeFunctor().

_functor_device

template<typename Object >

Object* Moose::Kokkos::FunctorWrapperHost< Object >::_functor_device = nullptr

private

Copy of the functor on device.

Definition at line 122 of file KokkosFunctorWrapper.h.

Referenced by Moose::Kokkos::FunctorWrapperHost< Object >::allocate(), Moose::Kokkos::FunctorWrapperHost< Object >::copyFunctor(), and Moose::Kokkos::FunctorWrapperHost< Object >::~FunctorWrapperHost().

_functor_host

template<typename Object >

const Object& Moose::Kokkos::FunctorWrapperHost< Object >::_functor_host

private

Reference of the functor on host.

Definition at line 114 of file KokkosFunctorWrapper.h.

Referenced by Moose::Kokkos::FunctorWrapperHost< Object >::copyFunctor().

---

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

• include/kokkos/base/KokkosFunctorWrapper.h