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

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

#include <KokkosFunctionWrapper.h>

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

Public Member Functions
	FunctionWrapperHost (const void *function)
	Constructor. More...
	~FunctionWrapperHost ()
	Destructor. More...
FunctionWrapperDeviceBase *	allocate () override final
	Allocate device function and wrapper. More...
void	copyFunction () override final
	Copy function to device. More...
void	freeFunction () override final
	Free host and device copies of function. More...

Private Attributes
const Object &	_function_host
	Reference of the function on host. More...
std::unique_ptr< Object >	_function_copy
	Copy of the function on host. More...
Object *	_function_device = nullptr
	Copy of the function on device. More...

Detailed Description

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

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

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

Template Parameters

Object

The function class type

Definition at line 20 of file KokkosFunctionWrapper.h.

Constructor & Destructor Documentation

FunctionWrapperHost()

template<typename Object >

Moose::Kokkos::FunctionWrapperHost< Object >::FunctionWrapperHost ( const void *  function )

inline

Constructor.

Parameters

function

Pointer to the function

Definition at line 142 of file KokkosFunctionWrapper.h.

    : _function_host(*static_cast<const Object *>(function))
  {
  }

~FunctionWrapperHost()

template<typename Object >

Moose::Kokkos::FunctionWrapperHost< Object >::~FunctionWrapperHost

(

)

Destructor.

Definition at line 213 of file KokkosFunctionWrapper.h.

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

Member Function Documentation

allocate()

template<typename Object >

FunctionWrapperDeviceBase * Moose::Kokkos::FunctionWrapperHost< Object >::allocate ( )

finaloverridevirtual

Allocate device function and wrapper.

Returns

The pointer to the device wrapper

Implements Moose::Kokkos::FunctionWrapperHostBase.

Definition at line 172 of file KokkosFunctionWrapper.h.

{
  // Allocate storage for device wrapper on device
  auto wrapper_device = static_cast<FunctionWrapperDevice<Object> *>(
      ::Kokkos::kokkos_malloc<ExecSpace::memory_space>(sizeof(FunctionWrapperDevice<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) FunctionWrapperDevice<Object>(); });

  // Allocate storage for function on device
  _function_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->_function), &_function_device, sizeof(Object *));

  return wrapper_device;
}

copyFunction()

template<typename Object >

void Moose::Kokkos::FunctionWrapperHost< Object >::copyFunction ( )

finaloverridevirtual

Copy function to device.

Implements Moose::Kokkos::FunctionWrapperHostBase.

Definition at line 195 of file KokkosFunctionWrapper.h.

{
  // Make a copy of function on host to trigger copy constructor
  _function_copy = std::make_unique<Object>(_function_host);

  // Copy function to device
  ::Kokkos::Impl::DeepCopy<MemSpace, ::Kokkos::HostSpace>(
      _function_device, _function_copy.get(), sizeof(Object));
}

freeFunction()

template<typename Object >

void Moose::Kokkos::FunctionWrapperHost< Object >::freeFunction ( )

finaloverridevirtual

Free host and device copies of function.

Implements Moose::Kokkos::FunctionWrapperHostBase.

Definition at line 207 of file KokkosFunctionWrapper.h.

{
  _function_copy.reset();
}

Member Data Documentation

_function_copy

template<typename Object >

std::unique_ptr<Object> Moose::Kokkos::FunctionWrapperHost< Object >::_function_copy

private

Copy of the function on host.

Definition at line 163 of file KokkosFunctionWrapper.h.

Referenced by Moose::Kokkos::FunctionWrapperHost< Object >::copyFunction(), and Moose::Kokkos::FunctionWrapperHost< Object >::freeFunction().

_function_device

template<typename Object >

Object* Moose::Kokkos::FunctionWrapperHost< Object >::_function_device = nullptr

private

Copy of the function on device.

Definition at line 167 of file KokkosFunctionWrapper.h.

Referenced by Moose::Kokkos::FunctionWrapperHost< Object >::allocate(), Moose::Kokkos::FunctionWrapperHost< Object >::copyFunction(), and Moose::Kokkos::FunctionWrapperHost< Object >::~FunctionWrapperHost().

_function_host

template<typename Object >

const Object& Moose::Kokkos::FunctionWrapperHost< Object >::_function_host

private

Reference of the function on host.

Definition at line 159 of file KokkosFunctionWrapper.h.

Referenced by Moose::Kokkos::FunctionWrapperHost< Object >::copyFunction().

---

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

• include/kokkos/functions/KokkosFunctionWrapper.h