Moose::Kokkos::Thread< thread_id_type, max_dimension > Class Template Reference

The Kokkos thread object that aids in converting the one-dimensional thread index into multi-dimensional thread indices. More...

#include <KokkosThread.h>

Public Types
using	id_type = thread_id_type

Public Member Functions
template<typename... size_type>
void	resize (size_type... sizes)
	Set the thread pool size and dimension. More...
KOKKOS_FUNCTION thread_id_type	size () const
	Get the total thread pool size. More...
KOKKOS_FUNCTION thread_id_type	size (const unsigned int dim) const
	Get the size of each dimension. More...
KOKKOS_FUNCTION thread_id_type	operator() (const thread_id_type tid, const unsigned int dim) const
	Get the multi-dimensional thread index of a dimension given a one-dimensional thread index. More...

Protected Attributes
thread_id_type	_size = 0
	Total thread pool size. More...
unsigned int	_dim = 0
	Thread pool dimension. More...
thread_id_type	_dims [max_dimension]
	Thread pool size of each dimension. More...
thread_id_type	_strides [max_dimension]
	Thread pool stride of each dimension. More...

Detailed Description

template<typename thread_id_type = ThreadID, unsigned int max_dimension = 4>
class Moose::Kokkos::Thread< thread_id_type, max_dimension >

The Kokkos thread object that aids in converting the one-dimensional thread index into multi-dimensional thread indices.

Definition at line 29 of file KokkosThread.h.

Member Typedef Documentation

id_type

template<typename thread_id_type = ThreadID, unsigned int max_dimension = 4>

using Moose::Kokkos::Thread< thread_id_type, max_dimension >::id_type = thread_id_type

Definition at line 37 of file KokkosThread.h.

Member Function Documentation

operator()()

template<typename thread_id_type = ThreadID, unsigned int max_dimension = 4>

KOKKOS_FUNCTION thread_id_type Moose::Kokkos::Thread< thread_id_type, max_dimension >::operator() ( const thread_id_type  tid, const unsigned int  dim  ) const

inline

Get the multi-dimensional thread index of a dimension given a one-dimensional thread index.

Parameters

tid	The one-dimensional thread index
dim	for which the multi-dimensional thread index is to be returned

Returns

The multi-dimensional thread index of the dimension

Definition at line 68 of file KokkosThread.h.

  {
    KOKKOS_ASSERT(dim < _dim);

    return (tid / _strides[dim]) % _dims[dim];
  }

resize()

template<typename thread_id_type , unsigned int max_dimension>

template<typename... size_type>

void Moose::Kokkos::Thread< thread_id_type, max_dimension >::resize

(

size_type...

sizes

)

Set the thread pool size and dimension.

Parameters

sizes

The size of each dimension

Definition at line 99 of file KokkosThread.h.

{
  static_assert((std::is_convertible<size_type, thread_id_type>::value && ...),
                "All arguments must be convertible to thread_id_type");
  static_assert(sizeof...(sizes) <= max_dimension, "Number of arguments exceeds maximum dimension");

  std::vector<thread_id_type> dims;
  (dims.push_back(sizes), ...);

  uint64_t size = 1;
  _dim = dims.size();

  for (unsigned int dim = 0; dim < _dim; ++dim)
  {
    _dims[dim] = dims[dim];
    _strides[dim] = dim ? _strides[dim - 1] * dims[dim - 1] : 1;
    size *= dims[dim];
  }

  if (size > std::numeric_limits<thread_id_type>::max())
    mooseError("Kokkos thread error: the dimensions provided (",
               Moose::stringify(dims),
               ") has the total size of ",
               size,
               " which exceeds the limit of ",
               MooseUtils::prettyCppType<thread_id_type>(),
               ".");

  _size = size;
}

size() [1/2]

template<typename thread_id_type = ThreadID, unsigned int max_dimension = 4>

KOKKOS_FUNCTION thread_id_type Moose::Kokkos::Thread< thread_id_type, max_dimension >::size ( ) const

inline

Get the total thread pool size.

Returns

The total thread pool size

Definition at line 50 of file KokkosThread.h.

Referenced by Moose::Kokkos::ADKernel::operator()(), Moose::Kokkos::ADIntegratedBC::operator()(), Moose::Kokkos::Kernel::operator()(), and Moose::Kokkos::IntegratedBC::operator()().

{ return _size; }

size() [2/2]

template<typename thread_id_type = ThreadID, unsigned int max_dimension = 4>

KOKKOS_FUNCTION thread_id_type Moose::Kokkos::Thread< thread_id_type, max_dimension >::size ( const unsigned int  dim ) const

inline

Get the size of each dimension.

Parameters

dim	The dimension index

Returns

The dimension size

Definition at line 56 of file KokkosThread.h.

  {
    KOKKOS_ASSERT(dim < _dim);

    return _dims[dim];
  }

Member Data Documentation

_dim

template<typename thread_id_type = ThreadID, unsigned int max_dimension = 4>

unsigned int Moose::Kokkos::Thread< thread_id_type, max_dimension >::_dim = 0

protected

Thread pool dimension.

Definition at line 84 of file KokkosThread.h.

Referenced by Moose::Kokkos::Thread< thread_id_type, max_dimension >::operator()(), and Moose::Kokkos::Thread< thread_id_type, max_dimension >::size().

_dims

template<typename thread_id_type = ThreadID, unsigned int max_dimension = 4>

thread_id_type Moose::Kokkos::Thread< thread_id_type, max_dimension >::_dims[max_dimension]

protected

Thread pool size of each dimension.

Definition at line 88 of file KokkosThread.h.

Referenced by Moose::Kokkos::Thread< thread_id_type, max_dimension >::operator()(), and Moose::Kokkos::Thread< thread_id_type, max_dimension >::size().

_size

template<typename thread_id_type = ThreadID, unsigned int max_dimension = 4>

thread_id_type Moose::Kokkos::Thread< thread_id_type, max_dimension >::_size = 0

protected

Total thread pool size.

Definition at line 80 of file KokkosThread.h.

Referenced by Moose::Kokkos::Thread< thread_id_type, max_dimension >::size().

_strides

template<typename thread_id_type = ThreadID, unsigned int max_dimension = 4>

thread_id_type Moose::Kokkos::Thread< thread_id_type, max_dimension >::_strides[max_dimension]

protected

Thread pool stride of each dimension.

Definition at line 92 of file KokkosThread.h.

Referenced by Moose::Kokkos::Thread< thread_id_type, max_dimension >::operator()().

---

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

• include/kokkos/base/KokkosThread.h