Moose::Kokkos::JaggedArrayInnerDataBase< T, inner > Class Template Reference

The base class of the inner array wrapper. More...

#include <KokkosJaggedArray.h>

Public Member Functions
KOKKOS_FUNCTION	JaggedArrayInnerDataBase (T *data, JaggedArrayInnerDim< inner > dim)
	Constructor. More...
KOKKOS_FUNCTION dof_id_type	size () const
	Get the total inner array size. More...
KOKKOS_FUNCTION dof_id_type	n (unsigned int dim) const
	Get the size of a dimension of the inner array. More...
KOKKOS_FUNCTION T &	operator[] (dof_id_type i) const
	Get an array entry. More...

Protected Attributes
T *	_data
	Pointer to the inner array data. More...
JaggedArrayInnerDim< inner >	_dim
	Inner array dimension information. More...

Detailed Description

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

The base class of the inner array wrapper.

This object provides access to an inner array with local multi-dimensional indexing and is created as a temporary object by the jagged array class.

Template Parameters

T	The data type
inner	The inner array dimension size

Definition at line 53 of file KokkosJaggedArray.h.

Constructor & Destructor Documentation

JaggedArrayInnerDataBase()

template<typename T, unsigned int inner>

KOKKOS_FUNCTION Moose::Kokkos::JaggedArrayInnerDataBase< T, inner >::JaggedArrayInnerDataBase ( T *  data, JaggedArrayInnerDim< inner >  dim  )

inline

Constructor.

Parameters

data	The pointer to the inner array data
dim	The inner array dimension information

Definition at line 61 of file KokkosJaggedArray.h.

    : _data(data), _dim(dim)
  {
  }

Member Function Documentation

n()

template<typename T, unsigned int inner>

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

inline

Get the size of a dimension of the inner array.

Parameters

dim	The dimension index

Returns

The size of the dimension of the inner array

Definition at line 76 of file KokkosJaggedArray.h.

{ return _dim[dim]; }

operator[]()

template<typename T, unsigned int inner>

KOKKOS_FUNCTION T& Moose::Kokkos::JaggedArrayInnerDataBase< T, inner >::operator[] ( dof_id_type  i ) const

inline

Get an array entry.

Parameters

i	The dimensionless inner array index

Definition at line 81 of file KokkosJaggedArray.h.

  {
    KOKKOS_ASSERT(i < _dim.stride[inner - 1]);

    return _data[i];
  }

size()

template<typename T, unsigned int inner>

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

inline

Get the total inner array size.

Returns

The total inner array size

Definition at line 70 of file KokkosJaggedArray.h.

{ return _dim.stride[inner - 1]; }

Member Data Documentation

_data

template<typename T, unsigned int inner>

T* Moose::Kokkos::JaggedArrayInnerDataBase< T, inner >::_data

protected

Pointer to the inner array data.

Definition at line 92 of file KokkosJaggedArray.h.

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

_dim

template<typename T, unsigned int inner>

JaggedArrayInnerDim<inner> Moose::Kokkos::JaggedArrayInnerDataBase< T, inner >::_dim

protected

Inner array dimension information.

Definition at line 96 of file KokkosJaggedArray.h.

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

---

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

• include/kokkos/base/KokkosJaggedArray.h