Moose::Kokkos::JaggedArrayBase< T, inner, outer > Class Template Reference

The base class for Kokkos jagged arrays. More...

#include <KokkosJaggedArray.h>

Public Member Functions
void	create (const std::vector< dof_id_type > &n)
	Allocate outer array. More...
void	reserve (const std::array< dof_id_type, outer > &index, const std::array< dof_id_type, inner > &dimension)
	Reserve inner array for an outer array entry. More...
void	finalize ()
	Setup array structure. More...
void	copyToDevice ()
	Copy data from host to device. More...
void	copyToHost ()
	Copy data from device to host. More...
auto &	array ()
	Get the underlying data array. More...
KOKKOS_FUNCTION bool	isFinalized () const
	Get whether the array is finalized. More...
KOKKOS_FUNCTION dof_id_type	size () const
	Get the total data array size. More...
KOKKOS_FUNCTION dof_id_type	n () const
	Get the total outer array size. More...
KOKKOS_FUNCTION dof_id_type	n (unsigned int dim) const
	Get the size of a dimension of the outer array. More...
KOKKOS_FUNCTION auto	operator[] (dof_id_type i) const
	Get an inner array. More...

Protected Attributes
Array< T >	_data
	Sequential data array. More...
Array< JaggedArrayInnerDim< inner >, outer >	_dims
	Dimension information of each inner array. More...
Array< dof_id_type, outer >	_offsets
	Starting offset of each inner array into the sequential data array. More...
bool	_finalized
	Whether the array was finalized. More...

Detailed Description

template<typename T, unsigned int inner, unsigned int outer>
class Moose::Kokkos::JaggedArrayBase< T, inner, outer >

The base class for Kokkos jagged arrays.

A Kokkos jagged array aids in treating jagged arrays conveniently and efficiently by using a sequential data storage and providing multi-dimensional indexing using internal dope vectors. A jagged array is divided into the inner and outer arrays. The outer array is the regular part of a jagged array. Each entry of the outer array can hold an inner array, whose size can vary with each other. Calling create() will allocate the outer array, and inner arrays should be reserved one-by-one through reserve(). Once the array structure is set, finalize() should be called. A finalized array cannot be restructured unless it is reset completely by calling create() again. The inner array returned by operator() or operator[] using the outer array index is held in a temporary wrapper object. To avoid the overhead of temporary object creation, it is recommended to store the object locally.

Template Parameters

T	The data type
inner	The inner array dimension size
outer	The outer array dimension size

Definition at line 221 of file KokkosJaggedArray.h.

Member Function Documentation

array()

template<typename T, unsigned int inner, unsigned int outer>

auto& Moose::Kokkos::JaggedArrayBase< T, inner, outer >::array ( )

inline

Get the underlying data array.

Returns

The data array

Definition at line 263 of file KokkosJaggedArray.h.

{ return _data; }

copyToDevice()

template<typename T, unsigned int inner, unsigned int outer>

void Moose::Kokkos::JaggedArrayBase< T, inner, outer >::copyToDevice ( )

inline

Copy data from host to device.

Definition at line 244 of file KokkosJaggedArray.h.

  {
    mooseAssert(_finalized, "KokkosJaggedArray not finalized.");

    _data.copyToDevice();
  }

copyToHost()

template<typename T, unsigned int inner, unsigned int outer>

void Moose::Kokkos::JaggedArrayBase< T, inner, outer >::copyToHost ( )

inline

Copy data from device to host.

Definition at line 253 of file KokkosJaggedArray.h.

  {
    mooseAssert(_finalized, "KokkosJaggedArray not finalized.");

    _data.copyToHost();
  }

create()

template<typename T , unsigned int inner, unsigned int outer>

void Moose::Kokkos::JaggedArrayBase< T, inner, outer >::create

(

const std::vector< dof_id_type > &

n

)

Allocate outer array.

Parameters

n	The vector containing the size of each dimension for the outer array

Definition at line 328 of file KokkosJaggedArray.h.

Referenced by Moose::Kokkos::JaggedArray< T, inner, 1 >::create(), Moose::Kokkos::JaggedArray< T, inner, 2 >::create(), and Moose::Kokkos::JaggedArray< T, inner, 3 >::create().

{
  _data.destroy();
  _offsets.create(n);
  _dims.create(n);

  _finalized = false;
}

finalize()

template<typename T , unsigned int inner, unsigned int outer>

void Moose::Kokkos::JaggedArrayBase< T, inner, outer >::finalize

(

)

Setup array structure.

Definition at line 366 of file KokkosJaggedArray.h.

{
  mooseAssert(!_finalized, "KokkosJaggedArray already finalized.");

  dof_id_type stride = 1;

  for (dof_id_type o = 0; o < _offsets.size(); ++o)
  {
    stride = 1;

    for (unsigned int i = 0; i < inner; ++i)
      stride *= _dims[o][i];

    _offsets[o] = stride;
  }

  std::exclusive_scan(_offsets.begin(), _offsets.end(), _offsets.begin(), 0);

  _dims.copyToDevice();
  _offsets.copyToDevice();
  _data.create(_offsets.last() + stride);

  _finalized = true;
}

isFinalized()

template<typename T, unsigned int inner, unsigned int outer>

KOKKOS_FUNCTION bool Moose::Kokkos::JaggedArrayBase< T, inner, outer >::isFinalized ( ) const

inline

Get whether the array is finalized.

Returns

Whether the array is finalized

Definition at line 269 of file KokkosJaggedArray.h.

{ return _finalized; }

n() [1/2]

template<typename T, unsigned int inner, unsigned int outer>

KOKKOS_FUNCTION dof_id_type Moose::Kokkos::JaggedArrayBase< T, inner, outer >::n ( ) const

inline

Get the total outer array size.

Returns

The total outer array size

Definition at line 279 of file KokkosJaggedArray.h.

{ return _offsets.size(); }

n() [2/2]

template<typename T, unsigned int inner, unsigned int outer>

KOKKOS_FUNCTION dof_id_type Moose::Kokkos::JaggedArrayBase< T, inner, outer >::n ( unsigned int  dim ) const

inline

Get the size of a dimension of the outer array.

Parameters

dim	The dimension index

Returns

The size of the dimension of the outer array

Definition at line 285 of file KokkosJaggedArray.h.

{ return _offsets.n(dim); }

operator[]()

template<typename T, unsigned int inner, unsigned int outer>

KOKKOS_FUNCTION auto Moose::Kokkos::JaggedArrayBase< T, inner, outer >::operator[] ( dof_id_type  i ) const

inline

Get an inner array.

Parameters

i	The dimensionless outer array index

Returns

The inner array wrapper object

Definition at line 291 of file KokkosJaggedArray.h.

  {
    auto data = &_data[_offsets[i]];
    const auto & dim = _dims[i];

    return JaggedArrayInnerData<T, inner>(data, dim);
  }

reserve()

template<typename T , unsigned int inner, unsigned int outer>

void Moose::Kokkos::JaggedArrayBase< T, inner, outer >::reserve	(	const std::array< dof_id_type, outer > &	index,
		const std::array< dof_id_type, inner > &	dimension
	)

Reserve inner array for an outer array entry.

Parameters

index	The array containing the index for the outer array
dimension	The array containing the size of each dimension for the inner array

Definition at line 339 of file KokkosJaggedArray.h.

{
  mooseAssert(!_finalized, "KokkosJaggedArray already finalized.");

  dof_id_type idx = 0;
  dof_id_type stride = 1;

  for (unsigned int o = 0; o < outer; ++o)
  {
    idx += index[o] * stride;
    stride *= _offsets.n(o);
  }

  stride = 1;

  for (unsigned int i = 0; i < inner; ++i)
  {
    stride *= dimension[i];

    _dims[idx].dim[i] = dimension[i];
    _dims[idx].stride[i] = stride;
  }
}

size()

template<typename T, unsigned int inner, unsigned int outer>

KOKKOS_FUNCTION dof_id_type Moose::Kokkos::JaggedArrayBase< T, inner, outer >::size ( ) const

inline

Get the total data array size.

Returns

The total data array size

Definition at line 274 of file KokkosJaggedArray.h.

{ return _data.size(); }

Member Data Documentation

_data

template<typename T, unsigned int inner, unsigned int outer>

Array<T> Moose::Kokkos::JaggedArrayBase< T, inner, outer >::_data

protected

Sequential data array.

Definition at line 304 of file KokkosJaggedArray.h.

Referenced by Moose::Kokkos::JaggedArrayBase< T, inner, 1 >::array(), Moose::Kokkos::JaggedArrayBase< T, inner, 1 >::copyToDevice(), Moose::Kokkos::JaggedArrayBase< T, inner, 1 >::copyToHost(), Moose::Kokkos::JaggedArrayBase< T, inner, 1 >::operator[](), and Moose::Kokkos::JaggedArrayBase< T, inner, 1 >::size().

_dims

template<typename T, unsigned int inner, unsigned int outer>

Array<JaggedArrayInnerDim<inner>, outer> Moose::Kokkos::JaggedArrayBase< T, inner, outer >::_dims

protected

Dimension information of each inner array.

Definition at line 308 of file KokkosJaggedArray.h.

Referenced by Moose::Kokkos::JaggedArrayBase< T, inner, 1 >::operator[]().

_finalized

template<typename T, unsigned int inner, unsigned int outer>

bool Moose::Kokkos::JaggedArrayBase< T, inner, outer >::_finalized

protected

Whether the array was finalized.

Definition at line 316 of file KokkosJaggedArray.h.

Referenced by Moose::Kokkos::JaggedArrayBase< T, inner, 1 >::copyToDevice(), Moose::Kokkos::JaggedArrayBase< T, inner, 1 >::copyToHost(), and Moose::Kokkos::JaggedArrayBase< T, inner, 1 >::isFinalized().

_offsets

template<typename T, unsigned int inner, unsigned int outer>

Array<dof_id_type, outer> Moose::Kokkos::JaggedArrayBase< T, inner, outer >::_offsets

protected

Starting offset of each inner array into the sequential data array.

Definition at line 312 of file KokkosJaggedArray.h.

Referenced by Moose::Kokkos::JaggedArrayBase< T, inner, 1 >::n(), and Moose::Kokkos::JaggedArrayBase< T, inner, 1 >::operator[]().

---

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

• include/kokkos/base/KokkosJaggedArray.h