The Kokkos wrapper class for standard map. More...

#include <KokkosMap.h>

Public Member Functions
auto	begin ()
	Get the beginning writeable iterator of the host map.

auto	begin () const
	Get the beginning const iterator of the host map.

auto	end ()
	Get the end writeable iterator of the host map.

auto	end () const
	Get the end const iterator of the host map.

auto &	get ()
	Get the underlying writeable host map.

const auto &	get () const
	Get the underlying const host map.

void	clear ()
	Clear the underlying data.

T2 &	operator[] (const T1 &key)
	Call host map's operator[].

void	copyToDevice ()
	Copy host map to device.

void	copyToDeviceNested ()
	Copy host map to device, perform nested copy for Kokkos arrays.

void	swap (MapBase< T1, T2, MapType > &map)
	Swap with another Kokkos map.

KOKKOS_FUNCTION dof_id_type	size () const
	Get the size of map.

KOKKOS_FUNCTION dof_id_type	find (const T1 &key) const
	Find the index of a key.

KOKKOS_FUNCTION bool	exists (const T1 &key) const
	Get whether a key exists.

KOKKOS_FUNCTION const T1 &	key (dof_id_type idx) const
	Get the key of an index.

KOKKOS_FUNCTION const T2 &	value (dof_id_type idx) const
	Get the value of an index.


KOKKOS_FUNCTION const T2 &	operator[] (const T1 &key) const
	Get the value corresponding to a key.

KOKKOS_FUNCTION const T2 &	operator() (const T1 &key) const

Static Public Attributes
static const dof_id_type	invalid_id = libMesh::DofObject::invalid_id

Private Member Functions
void	copy ()
	Internal method to copy host map to device.

Private Attributes
std::shared_ptr< MapType< T1, T2 > >	_map_host
	Standard map on host Stored as a shared pointer to avoid deep copy.

Array< T1 >	_keys
	Keys on device.

Array< T2 >	_values
	Values on device.

Array< dof_id_type >	_offset
	Beginning offset into device arrays of each bucket.

Friends
void	dataStore (std::ostream &, MapBase< T1, T2, MapType > &, void *)

void	dataLoad (std::istream &, MapBase< T1, T2, MapType > &, void *)

Detailed Description

template<typename T1, typename T2, template< typename... > class MapType>
class Moose::Kokkos::MapBase< T1, T2, MapType >

The Kokkos wrapper class for standard map.

The map can only be populated on host. Make sure to call copyToDevice() or copyToDeviceNested() after populating the map on host.

Definition at line 71 of file KokkosMap.h.

Member Function Documentation

◆ begin() [1/2]

template<typename T1 , typename T2 , template< typename... > class MapType>

auto Moose::Kokkos::MapBase< T1, T2, MapType >::begin ( )

inline

Get the beginning writeable iterator of the host map.

Returns: The beginning iterator

Definition at line 78 of file KokkosMap.h.

78{ return get().begin(); }

Moose::Kokkos::MapBase::get

auto & get()

Get the underlying writeable host map.

Definition KokkosMap.h:98

◆ begin() [2/2]

template<typename T1 , typename T2 , template< typename... > class MapType>

auto Moose::Kokkos::MapBase< T1, T2, MapType >::begin ( ) const

inline

Get the beginning const iterator of the host map.

Returns: The beginning iterator

Definition at line 83 of file KokkosMap.h.

83{ return get().cbegin(); }

◆ clear()

template<typename T1 , typename T2 , template< typename... > class MapType>

void Moose::Kokkos::MapBase< T1, T2, MapType >::clear ( )

Clear the underlying data.

Definition at line 244 of file KokkosMap.h.

{
  get().clear();
 
  _keys.destroy();
  _values.destroy();
  _offset.destroy();
}

◆ copy()

template<typename T1 , typename T2 , template< typename... > class MapType>

void Moose::Kokkos::MapBase< T1, T2, MapType >::copy ( )

private

Internal method to copy host map to device.

Definition at line 256 of file KokkosMap.h.

{
  _keys.create(size());
  _values.create(size());
  _offset.create(size() + 1);
  _offset = 0;
 
  for (const auto & [key, value] : get())
  {
    auto bucket = fnv1aHash(key) % size();
 
    _offset[bucket]++;
  }
 
  std::exclusive_scan(_offset.begin(), _offset.end(), _offset.begin(), 0);
 
  _offset.copyToDevice();
 
  std::vector<dof_id_type> idx(size(), 0);
 
  for (const auto & [key, value] : get())
  {
    auto bucket = fnv1aHash(key) % size();
 
    _keys[_offset[bucket] + idx[bucket]] = key;
    _values[_offset[bucket] + idx[bucket]] = value;
    idx[bucket]++;
  }
}

◆ copyToDevice()

template<typename T1 , typename T2 , template< typename... > class MapType>

void Moose::Kokkos::MapBase< T1, T2, MapType >::copyToDevice ( )

Copy host map to device.

Definition at line 288 of file KokkosMap.h.

{
  copy();
 
  _keys.copyToDevice();
  _values.copyToDevice();
}

◆ copyToDeviceNested()

template<typename T1 , typename T2 , template< typename... > class MapType>

void Moose::Kokkos::MapBase< T1, T2, MapType >::copyToDeviceNested ( )

Copy host map to device, perform nested copy for Kokkos arrays.

Definition at line 298 of file KokkosMap.h.

{
  copy();
 
  _keys.copyToDeviceNested();
  _values.copyToDeviceNested();
}

◆ end() [1/2]

template<typename T1 , typename T2 , template< typename... > class MapType>

auto Moose::Kokkos::MapBase< T1, T2, MapType >::end ( )

inline

Get the end writeable iterator of the host map.

Returns: The end iterator

Definition at line 88 of file KokkosMap.h.

88{ return get().end(); }

◆ end() [2/2]

template<typename T1 , typename T2 , template< typename... > class MapType>

auto Moose::Kokkos::MapBase< T1, T2, MapType >::end ( ) const

inline

Get the end const iterator of the host map.

Returns: The end iterator

Definition at line 93 of file KokkosMap.h.

93{ return get().cend(); }

◆ exists()

template<typename T1 , typename T2 , template< typename... > class MapType>

KOKKOS_FUNCTION bool Moose::Kokkos::MapBase< T1, T2, MapType >::exists ( const T1 & key ) const

inline

Get whether a key exists.

Parameters

key The key

Returns: Whether the key exists

Definition at line 163 of file KokkosMap.h.

163{ return find(key) != invalid_id; }

Moose::Kokkos::MapBase::invalid_id

static const dof_id_type invalid_id

Definition KokkosMap.h:210

Moose::Kokkos::MapBase::find

KOKKOS_FUNCTION dof_id_type find(const T1 &key) const

Find the index of a key.

Definition KokkosMap.h:318

◆ find()

template<typename T1 , typename T2 , template< typename... > class MapType>

KOKKOS_FUNCTION dof_id_type Moose::Kokkos::MapBase< T1, T2, MapType >::find ( const T1 & key ) const

Find the index of a key.

Parameters

key The key

Returns: The index of the key, invalid_id if the key does not exist

Definition at line 318 of file KokkosMap.h.

{
  if (!size())
    return invalid_id;
 
  auto bucket = fnv1aHash(key) % size();
  auto begin = _offset[bucket];
  auto end = _offset[bucket + 1];
 
  for (dof_id_type i = begin; i < end; ++i)
    if (_keys[i] == key)
      return i;
 
  return invalid_id;
}

Referenced by Moose::Kokkos::MapBase< T1, T2, MapType >::exists(), and Moose::Kokkos::MapBase< T1, T2, MapType >::operator[]().

◆ get() [1/2]

template<typename T1 , typename T2 , template< typename... > class MapType>

auto & Moose::Kokkos::MapBase< T1, T2, MapType >::get ( )

inline

Get the underlying writeable host map.

Returns: The writeable host map

Definition at line 98 of file KokkosMap.h.

  {
    if (!_map_host)
      _map_host = std::make_shared<MapType<T1, T2>>();
 
    return *_map_host;
  }

Referenced by Moose::Kokkos::MapBase< T1, T2, MapType >::begin(), Moose::Kokkos::MapBase< T1, T2, MapType >::begin(), Moose::Kokkos::MapBase< T1, T2, MapType >::end(), Moose::Kokkos::MapBase< T1, T2, MapType >::end(), Moose::Kokkos::MapBase< T1, T2, MapType >::operator[](), Moose::Kokkos::MapBase< T1, T2, MapType >::operator[](), Moose::Kokkos::MapBase< T1, T2, MapType >::size(), and Moose::Kokkos::MapBase< T1, T2, MapType >::swap().

◆ get() [2/2]

template<typename T1 , typename T2 , template< typename... > class MapType>

const auto & Moose::Kokkos::MapBase< T1, T2, MapType >::get ( ) const

inline

Get the underlying const host map.

Returns: The const host map

Definition at line 109 of file KokkosMap.h.

  {
    if (!_map_host)
      _map_host = std::make_shared<MapType<T1, T2>>();
 
    return *_map_host;
  }

◆ key()

template<typename T1 , typename T2 , template< typename... > class MapType>

KOKKOS_FUNCTION const T1 & Moose::Kokkos::MapBase< T1, T2, MapType >::key ( dof_id_type idx ) const

inline

Get the key of an index.

Parameters

idx	The index returned by find()

Returns: The const reference of the key

Definition at line 169 of file KokkosMap.h.

  {
    KOKKOS_ASSERT(idx != invalid_id);
 
    return _keys[idx];
  }

Referenced by Moose::Kokkos::MapBase< T1, T2, MapType >::exists(), Moose::Kokkos::MapBase< T1, T2, MapType >::operator()(), Moose::Kokkos::MapBase< T1, T2, MapType >::operator[](), and Moose::Kokkos::MapBase< T1, T2, MapType >::operator[]().

◆ operator()()

template<typename T1 , typename T2 , template< typename... > class MapType>

KOKKOS_FUNCTION const T2 & Moose::Kokkos::MapBase< T1, T2, MapType >::operator() ( const T1 & key ) const

inline

Definition at line 206 of file KokkosMap.h.

206{ return operator[](key); }

Moose::Kokkos::MapBase::operator[]

T2 & operator[](const T1 &key)

Call host map's operator[].

Definition KokkosMap.h:125

◆ operator[]() [1/2]

template<typename T1 , typename T2 , template< typename... > class MapType>

T2 & Moose::Kokkos::MapBase< T1, T2, MapType >::operator[] ( const T1 & key )

inline

Call host map's operator[].

Parameters

key The key

Returns: The writeable reference of the value

Definition at line 125 of file KokkosMap.h.

125{ return get()[key]; }

Referenced by Moose::Kokkos::MapBase< T1, T2, MapType >::operator()().

◆ operator[]() [2/2]

template<typename T1 , typename T2 , template< typename... > class MapType>

KOKKOS_FUNCTION const T2 & Moose::Kokkos::MapBase< T1, T2, MapType >::operator[] ( const T1 & key ) const

inline

Get the value corresponding to a key.

Parameters

key The key

Returns: The const reference of the value

Definition at line 192 of file KokkosMap.h.

  {
    KOKKOS_IF_ON_HOST(return get().at(key);)
 
    auto idx = find(key);
 
    KOKKOS_ASSERT(idx != invalid_id);
 
    return _values[idx];
  }

◆ size()

template<typename T1 , typename T2 , template< typename... > class MapType>

KOKKOS_FUNCTION dof_id_type Moose::Kokkos::MapBase< T1, T2, MapType >::size ( ) const

inline

Get the size of map.

Returns: The size of map

Definition at line 146 of file KokkosMap.h.

  {
    KOKKOS_IF_ON_HOST(return get().size();)
 
    return _keys.size();
  }

Referenced by Moose::Kokkos::MapBase< T1, T2, MapType >::size().

◆ swap()

template<typename T1 , typename T2 , template< typename... > class MapType>

void Moose::Kokkos::MapBase< T1, T2, MapType >::swap ( MapBase< T1, T2, MapType > & map )

Swap with another Kokkos map.

Parameters

map	The Kokkos map to be swapped

Definition at line 308 of file KokkosMap.h.

{
  get().swap(map.get());
  _keys.swap(map._keys);
  _values.swap(map._values);
  _offset.swap(map._offset);
}

◆ value()

template<typename T1 , typename T2 , template< typename... > class MapType>

KOKKOS_FUNCTION const T2 & Moose::Kokkos::MapBase< T1, T2, MapType >::value ( dof_id_type idx ) const

inline

Get the value of an index.

Parameters

idx	The index returned by find()

Returns: The const reference of the value

Definition at line 180 of file KokkosMap.h.

  {
    KOKKOS_ASSERT(idx != invalid_id);
 
    return _values[idx];
  }

Friends And Related Symbol Documentation

◆ dataLoad

template<typename T1 , typename T2 , template< typename... > class MapType>

void dataLoad	(	std::istream &	stream,
		MapBase< T1, T2, MapType > &	map,
		void *	context
	)

friend

Definition at line 348 of file KokkosMap.h.

{
  using ::dataLoad;
 
  dataLoad(stream, map.get(), context);
  dataLoad(stream, map._keys, context);
  dataLoad(stream, map._values, context);
  dataLoad(stream, map._offset, context);
}

◆ dataStore

template<typename T1 , typename T2 , template< typename... > class MapType>

void dataStore	(	std::ostream &	stream,
		MapBase< T1, T2, MapType > &	map,
		void *	context
	)

friend

Definition at line 336 of file KokkosMap.h.

{
  using ::dataStore;
 
  dataStore(stream, map.get(), context);
  dataStore(stream, map._keys, context);
  dataStore(stream, map._values, context);
  dataStore(stream, map._offset, context);
}

Member Data Documentation

◆ _keys

template<typename T1 , typename T2 , template< typename... > class MapType>

Array<T1> Moose::Kokkos::MapBase< T1, T2, MapType >::_keys

private

Keys on device.

Definition at line 228 of file KokkosMap.h.

Referenced by Moose::Kokkos::MapBase< T1, T2, MapType >::key(), Moose::Kokkos::MapBase< T1, T2, MapType >::size(), and Moose::Kokkos::MapBase< T1, T2, MapType >::swap().

◆ _map_host

template<typename T1 , typename T2 , template< typename... > class MapType>

std::shared_ptr<MapType<T1, T2> > Moose::Kokkos::MapBase< T1, T2, MapType >::_map_host

mutableprivate

Standard map on host Stored as a shared pointer to avoid deep copy.

Definition at line 224 of file KokkosMap.h.

Referenced by Moose::Kokkos::MapBase< T1, T2, MapType >::get(), and Moose::Kokkos::MapBase< T1, T2, MapType >::get().

◆ _offset

template<typename T1 , typename T2 , template< typename... > class MapType>

Array<dof_id_type> Moose::Kokkos::MapBase< T1, T2, MapType >::_offset

private

Beginning offset into device arrays of each bucket.

Definition at line 236 of file KokkosMap.h.

Referenced by Moose::Kokkos::MapBase< T1, T2, MapType >::swap().

◆ _values

template<typename T1 , typename T2 , template< typename... > class MapType>

Array<T2> Moose::Kokkos::MapBase< T1, T2, MapType >::_values

private

Values on device.

Definition at line 232 of file KokkosMap.h.

Referenced by Moose::Kokkos::MapBase< T1, T2, MapType >::operator[](), Moose::Kokkos::MapBase< T1, T2, MapType >::swap(), and Moose::Kokkos::MapBase< T1, T2, MapType >::value().

◆ invalid_id

template<typename T1 , typename T2 , template< typename... > class MapType>

const dof_id_type Moose::Kokkos::MapBase< T1, T2, MapType >::invalid_id = libMesh::DofObject::invalid_id

static

Definition at line 210 of file KokkosMap.h.

Referenced by Moose::Kokkos::MapBase< T1, T2, MapType >::exists(), Moose::Kokkos::MapBase< T1, T2, MapType >::key(), Moose::Kokkos::MapBase< T1, T2, MapType >::operator[](), and Moose::Kokkos::MapBase< T1, T2, MapType >::value().

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

include/kokkos/base/KokkosMap.h

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ clear()

◆ copy()

◆ copyToDevice()

◆ copyToDeviceNested()

◆ end() [1/2]

◆ end() [2/2]

◆ exists()

◆ find()

◆ get() [1/2]

◆ get() [2/2]

◆ key()

◆ operator()()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ size()

◆ swap()

◆ value()

Friends And Related Symbol Documentation

◆ dataLoad

◆ dataStore

Member Data Documentation

◆ _keys

◆ _map_host

◆ _offset

◆ _values

◆ invalid_id