#include <chunk.hpp>

Inheritance diagram for ddc::Chunk< ElementType, SupportType, Allocator >:

Collaboration diagram for ddc::Chunk< ElementType, SupportType, Allocator >:

Public Types
using	span_type = ChunkSpan< ElementType, SupportType, Kokkos::layout_right, typename Allocator::memory_space >
	type of a span of this full chunk

using	view_type = ChunkSpan< ElementType const, SupportType, Kokkos::layout_right, typename Allocator::memory_space >
	type of a view of this full chunk

using	allocation_mdspan_type = typename base_type::allocation_mdspan_type
	The dereferenceable part of the co-domain but with indexing starting at 0.

using	const_allocation_mdspan_type = typename base_type::const_allocation_mdspan_type

using	discrete_domain_type = typename base_type::discrete_domain_type

using	memory_space = typename Allocator::memory_space

using	discrete_element_type = typename base_type::discrete_element_type

using	discrete_vector_type = typename base_type::discrete_vector_type

using	extents_type = typename base_type::extents_type

using	layout_type = typename base_type::layout_type

using	mapping_type = typename base_type::mapping_type

using	element_type = typename base_type::element_type

using	value_type = typename base_type::value_type

using	size_type = typename base_type::size_type

using	data_handle_type = typename base_type::data_handle_type

using	reference = typename base_type::reference

Public Types inherited from ddc::ChunkCommon< ElementType, SupportType, Kokkos::layout_right >
using	discrete_domain_type = SupportType

using	allocation_mdspan_type = Kokkos::mdspan< ElementType, Kokkos::dextents< std::size_t, SupportType::rank()>, Kokkos::layout_right >
	The dereferenceable part of the co-domain but with a different domain, starting at 0.

using	const_allocation_mdspan_type = Kokkos::mdspan< ElementType const, Kokkos::dextents< std::size_t, SupportType::rank()>, Kokkos::layout_right >

using	discrete_element_type = typename discrete_domain_type::discrete_element_type

using	discrete_vector_type = typename discrete_domain_type::discrete_vector_type

using	extents_type = typename allocation_mdspan_type::extents_type

using	layout_type = typename allocation_mdspan_type::layout_type

using	accessor_type = typename allocation_mdspan_type::accessor_type

using	mapping_type = typename allocation_mdspan_type::mapping_type

using	element_type = typename allocation_mdspan_type::element_type

using	value_type = typename allocation_mdspan_type::value_type

using	size_type = typename allocation_mdspan_type::size_type

using	data_handle_type = typename allocation_mdspan_type::data_handle_type

using	reference = typename allocation_mdspan_type::reference

Public Member Functions
	Chunk ()=default
	Empty Chunk.

	Chunk (std::string const &label, SupportType const &domain, Allocator allocator=Allocator())
	Construct a labeled Chunk on a domain with uninitialized values.

	Chunk (SupportType const &domain, Allocator allocator=Allocator())
	Construct a Chunk on a domain with uninitialized values.

	Chunk (Chunk const &other)=delete
	Deleted: use deepcopy instead.

	Chunk (Chunk &&other) noexcept
	Constructs a new Chunk by move.

	~Chunk () noexcept

Chunk &	operator= (Chunk const &other)=delete
	Deleted: use deepcopy instead.

Chunk &	operator= (Chunk &&other) noexcept
	Move-assigns a new value to this field.

template<class... QueryDDims>
auto	operator[] (DiscreteElement< QueryDDims... > const &slice_spec) const
	Slice out some dimensions.

template<class... QueryDDims>
auto	operator[] (DiscreteElement< QueryDDims... > const &slice_spec)
	Slice out some dimensions.

template<class... QueryDDims> requires (is_discrete_domain_v<SupportType>)
auto	operator[] (DiscreteDomain< QueryDDims... > const &odomain) const
	Slice out some dimensions.

template<class... QueryDDims> requires (is_discrete_domain_v<SupportType>)
auto	operator[] (DiscreteDomain< QueryDDims... > const &odomain)
	Slice out some dimensions.

template<concepts::discrete_element... DElems>
element_type const &	operator() (DElems const &... delems) const noexcept
	Element access using a list of DiscreteElement.

template<concepts::discrete_vector... DVects> requires (sizeof...(DVects) != 0)
element_type const &	operator() (DVects const &... dvects) const noexcept
	Element access using a list of DiscreteVector.

template<concepts::discrete_element... DElems>
element_type &	operator() (DElems const &... delems) noexcept
	Element access using a list of DiscreteElement.

template<concepts::discrete_vector... DVects> requires (sizeof...(DVects) != 0)
element_type &	operator() (DVects const &... dvects) noexcept
	Element access using a list of DiscreteVector.

char const *	label () const
	Returns the label of the Chunk.

ElementType const *	data_handle () const
	Access to the underlying allocation pointer.

ElementType *	data_handle ()
	Access to the underlying allocation pointer.

const_allocation_mdspan_type	allocation_mdspan () const
	Provide a mdspan on the memory allocation.

allocation_mdspan_type	allocation_mdspan ()
	Provide a mdspan on the memory allocation.

auto	allocation_kokkos_view ()
	Provide an unmanaged `Kokkos::View` on the memory allocation.

auto	allocation_kokkos_view () const
	Provide an unmanaged `Kokkos::View` on the memory allocation.

view_type	span_cview () const

view_type	span_view () const

span_type	span_view ()

Public Member Functions inherited from ddc::ChunkCommon< ElementType, SupportType, Kokkos::layout_right >
KOKKOS_FUNCTION constexpr accessor_type	accessor () const

KOKKOS_FUNCTION constexpr SupportType::discrete_vector_type	extents () const noexcept

KOKKOS_FUNCTION constexpr size_type	extent () const noexcept

KOKKOS_FUNCTION constexpr size_type	size () const noexcept

KOKKOS_FUNCTION constexpr mapping_type	mapping () const noexcept

KOKKOS_FUNCTION constexpr bool	is_unique () const noexcept

KOKKOS_FUNCTION constexpr bool	is_exhaustive () const noexcept

KOKKOS_FUNCTION constexpr bool	is_strided () const noexcept

KOKKOS_FUNCTION constexpr size_type	stride () const

KOKKOS_FUNCTION constexpr SupportType	domain () const noexcept
	Provide access to the domain on which this chunk is defined.

KOKKOS_FUNCTION constexpr DiscreteDomain< QueryDDims... >	domain () const noexcept
	Provide access to the domain on which this chunk is defined.

Protected Types
using	base_type = ChunkCommon< ElementType, SupportType, Kokkos::layout_right >

Friends
template<class , class , class >
class	Chunk

Additional Inherited Members
Static Public Member Functions inherited from ddc::ChunkCommon< ElementType, SupportType, Kokkos::layout_right >
static KOKKOS_FUNCTION constexpr int	rank () noexcept

static KOKKOS_FUNCTION constexpr int	rank_dynamic () noexcept

static KOKKOS_FUNCTION constexpr size_type	static_extent (std::size_t r) noexcept

static KOKKOS_FUNCTION constexpr bool	is_always_unique () noexcept

static KOKKOS_FUNCTION constexpr bool	is_always_exhaustive () noexcept

static KOKKOS_FUNCTION constexpr bool	is_always_strided () noexcept

Protected Member Functions inherited from ddc::ChunkCommon< ElementType, SupportType, Kokkos::layout_right >
KOKKOS_DEFAULTED_FUNCTION constexpr	ChunkCommon ()=default
	Empty ChunkCommon.

KOKKOS_FUNCTION constexpr	ChunkCommon (allocation_mdspan_type allocation_mdspan, SupportType const &domain) noexcept
	Constructs a new ChunkCommon from scratch.

KOKKOS_FUNCTION constexpr	ChunkCommon (ElementType *ptr, SupportType const &domain)
	Constructs a new ChunkCommon from scratch.

KOKKOS_DEFAULTED_FUNCTION constexpr	ChunkCommon (ChunkCommon const &other)=default
	Constructs a new ChunkCommon by copy, yields a new view to the same data.

KOKKOS_DEFAULTED_FUNCTION constexpr	ChunkCommon (ChunkCommon &&other) noexcept=default
	Constructs a new ChunkCommon by move.

KOKKOS_DEFAULTED_FUNCTION	~ChunkCommon () noexcept=default

KOKKOS_DEFAULTED_FUNCTION constexpr ChunkCommon &	operator= (ChunkCommon const &other)=default
	Copy-assigns a new value to this ChunkCommon, yields a new view to the same data.

KOKKOS_DEFAULTED_FUNCTION constexpr ChunkCommon &	operator= (ChunkCommon &&other) noexcept=default
	Move-assigns a new value to this ChunkCommon.

KOKKOS_FUNCTION constexpr ElementType *	data_handle () const
	Access to the underlying allocation pointer.

KOKKOS_FUNCTION constexpr allocation_mdspan_type	allocation_mdspan () const
	Provide a modifiable view of the data.

Protected Attributes inherited from ddc::ChunkCommon< ElementType, SupportType, Kokkos::layout_right >
allocation_mdspan_type	m_allocation_mdspan
	The raw view of the data.

SupportType	m_domain
	The mesh on which this chunk is defined.

Detailed Description

template<class ElementType, class SupportType, class Allocator>
class ddc::Chunk< ElementType, SupportType, Allocator >

Definition at line 31 of file chunk.hpp.

Member Typedef Documentation

◆ base_type

template<class ElementType , class SupportType , class Allocator >

using ddc::Chunk< ElementType, SupportType, Allocator >::base_type = ChunkCommon<ElementType, SupportType, Kokkos::layout_right>

protected

Definition at line 34 of file chunk.hpp.

◆ span_type

template<class ElementType , class SupportType , class Allocator >

using ddc::Chunk< ElementType, SupportType, Allocator >::span_type = ChunkSpan< ElementType, SupportType, Kokkos::layout_right, typename Allocator::memory_space>

type of a span of this full chunk

Definition at line 38 of file chunk.hpp.

◆ view_type

template<class ElementType , class SupportType , class Allocator >

using ddc::Chunk< ElementType, SupportType, Allocator >::view_type = ChunkSpan< ElementType const, SupportType, Kokkos::layout_right, typename Allocator::memory_space>

type of a view of this full chunk

Definition at line 45 of file chunk.hpp.

◆ allocation_mdspan_type

template<class ElementType , class SupportType , class Allocator >

using ddc::Chunk< ElementType, SupportType, Allocator >::allocation_mdspan_type = typename base_type::allocation_mdspan_type

The dereferenceable part of the co-domain but with indexing starting at 0.

Definition at line 52 of file chunk.hpp.

◆ const_allocation_mdspan_type

template<class ElementType , class SupportType , class Allocator >

using ddc::Chunk< ElementType, SupportType, Allocator >::const_allocation_mdspan_type = typename base_type::const_allocation_mdspan_type

Definition at line 54 of file chunk.hpp.

◆ discrete_domain_type

template<class ElementType , class SupportType , class Allocator >

using ddc::Chunk< ElementType, SupportType, Allocator >::discrete_domain_type = typename base_type::discrete_domain_type

Definition at line 56 of file chunk.hpp.

◆ memory_space

template<class ElementType , class SupportType , class Allocator >

using ddc::Chunk< ElementType, SupportType, Allocator >::memory_space = typename Allocator::memory_space

Definition at line 58 of file chunk.hpp.

◆ discrete_element_type

template<class ElementType , class SupportType , class Allocator >

using ddc::Chunk< ElementType, SupportType, Allocator >::discrete_element_type = typename base_type::discrete_element_type

Definition at line 60 of file chunk.hpp.

◆ discrete_vector_type

template<class ElementType , class SupportType , class Allocator >

using ddc::Chunk< ElementType, SupportType, Allocator >::discrete_vector_type = typename base_type::discrete_vector_type

Definition at line 62 of file chunk.hpp.

◆ extents_type

template<class ElementType , class SupportType , class Allocator >

using ddc::Chunk< ElementType, SupportType, Allocator >::extents_type = typename base_type::extents_type

Definition at line 64 of file chunk.hpp.

◆ layout_type

template<class ElementType , class SupportType , class Allocator >

using ddc::Chunk< ElementType, SupportType, Allocator >::layout_type = typename base_type::layout_type

Definition at line 66 of file chunk.hpp.

◆ mapping_type

template<class ElementType , class SupportType , class Allocator >

using ddc::Chunk< ElementType, SupportType, Allocator >::mapping_type = typename base_type::mapping_type

Definition at line 68 of file chunk.hpp.

◆ element_type

template<class ElementType , class SupportType , class Allocator >

using ddc::Chunk< ElementType, SupportType, Allocator >::element_type = typename base_type::element_type

Definition at line 70 of file chunk.hpp.

◆ value_type

template<class ElementType , class SupportType , class Allocator >

using ddc::Chunk< ElementType, SupportType, Allocator >::value_type = typename base_type::value_type

Definition at line 72 of file chunk.hpp.

◆ size_type

template<class ElementType , class SupportType , class Allocator >

using ddc::Chunk< ElementType, SupportType, Allocator >::size_type = typename base_type::size_type

Definition at line 74 of file chunk.hpp.

◆ data_handle_type

template<class ElementType , class SupportType , class Allocator >

using ddc::Chunk< ElementType, SupportType, Allocator >::data_handle_type = typename base_type::data_handle_type

Definition at line 76 of file chunk.hpp.

◆ reference

template<class ElementType , class SupportType , class Allocator >

using ddc::Chunk< ElementType, SupportType, Allocator >::reference = typename base_type::reference

Definition at line 78 of file chunk.hpp.

Constructor & Destructor Documentation

◆ Chunk() [1/5]

template<class ElementType , class SupportType , class Allocator >

ddc::Chunk< ElementType, SupportType, Allocator >::Chunk ( )

default

Empty Chunk.

◆ Chunk() [2/5]

template<class ElementType , class SupportType , class Allocator >

ddc::Chunk< ElementType, SupportType, Allocator >::Chunk	(	std::string const &	label,
		SupportType const &	domain,
		Allocator	allocator = `Allocator()`
	)

inlineexplicit

Construct a labeled Chunk on a domain with uninitialized values.

Definition at line 93 of file chunk.hpp.

◆ Chunk() [3/5]

template<class ElementType , class SupportType , class Allocator >

ddc::Chunk< ElementType, SupportType, Allocator >::Chunk	(	SupportType const &	domain,
		Allocator	allocator = `Allocator()`
	)

inlineexplicit

Construct a Chunk on a domain with uninitialized values.

Definition at line 104 of file chunk.hpp.

◆ Chunk() [4/5]

template<class ElementType , class SupportType , class Allocator >

ddc::Chunk< ElementType, SupportType, Allocator >::Chunk ( Chunk< ElementType, SupportType, Allocator > const & other )

delete

Deleted: use deepcopy instead.

◆ Chunk() [5/5]

template<class ElementType , class SupportType , class Allocator >

ddc::Chunk< ElementType, SupportType, Allocator >::Chunk ( Chunk< ElementType, SupportType, Allocator > && other )

inlinenoexcept

Constructs a new Chunk by move.

Parameters

other the Chunk to move

Definition at line 115 of file chunk.hpp.

◆ ~Chunk()

template<class ElementType , class SupportType , class Allocator >

ddc::Chunk< ElementType, SupportType, Allocator >::~Chunk ( )

inlinenoexcept

Definition at line 124 of file chunk.hpp.

Member Function Documentation

◆ operator=() [1/2]

template<class ElementType , class SupportType , class Allocator >

Chunk & ddc::Chunk< ElementType, SupportType, Allocator >::operator= ( Chunk< ElementType, SupportType, Allocator > const & other )

delete

Deleted: use deepcopy instead.

◆ operator=() [2/2]

template<class ElementType , class SupportType , class Allocator >

Chunk & ddc::Chunk< ElementType, SupportType, Allocator >::operator= ( Chunk< ElementType, SupportType, Allocator > && other )

inlinenoexcept

Move-assigns a new value to this field.

Parameters

other the Chunk to move

Returns: *this

Definition at line 138 of file chunk.hpp.

◆ operator[]() [1/4]

template<class ElementType , class SupportType , class Allocator >

template<class... QueryDDims>

auto ddc::Chunk< ElementType, SupportType, Allocator >::operator[] ( DiscreteElement< QueryDDims... > const & slice_spec ) const

inline

Slice out some dimensions.

Definition at line 154 of file chunk.hpp.

◆ operator[]() [2/4]

template<class ElementType , class SupportType , class Allocator >

template<class... QueryDDims>

auto ddc::Chunk< ElementType, SupportType, Allocator >::operator[] ( DiscreteElement< QueryDDims... > const & slice_spec )

inline

Slice out some dimensions.

Definition at line 161 of file chunk.hpp.

◆ operator[]() [3/4]

template<class ElementType , class SupportType , class Allocator >

template<class... QueryDDims>
requires (is_discrete_domain_v<SupportType>)

auto ddc::Chunk< ElementType, SupportType, Allocator >::operator[] ( DiscreteDomain< QueryDDims... > const & odomain ) const

inline

Slice out some dimensions.

Definition at line 168 of file chunk.hpp.

◆ operator[]() [4/4]

template<class ElementType , class SupportType , class Allocator >

template<class... QueryDDims>
requires (is_discrete_domain_v<SupportType>)

auto ddc::Chunk< ElementType, SupportType, Allocator >::operator[] ( DiscreteDomain< QueryDDims... > const & odomain )

inline

Slice out some dimensions.

Definition at line 176 of file chunk.hpp.

◆ operator()() [1/4]

template<class ElementType , class SupportType , class Allocator >

template<concepts::discrete_element... DElems>

element_type const & ddc::Chunk< ElementType, SupportType, Allocator >::operator() ( DElems const &... delems ) const

inlinenoexcept

Element access using a list of DiscreteElement.

Parameters

delems discrete coordinates

Returns: const-reference to this element

Definition at line 187 of file chunk.hpp.

◆ operator()() [2/4]

template<class ElementType , class SupportType , class Allocator >

template<concepts::discrete_vector... DVects>
requires (sizeof...(DVects) != 0)

element_type const & ddc::Chunk< ElementType, SupportType, Allocator >::operator() ( DVects const &... dvects ) const

inlinenoexcept

Element access using a list of DiscreteVector.

Parameters

dvects discrete vectors

Returns: reference to this element

Definition at line 203 of file chunk.hpp.

◆ operator()() [3/4]

template<class ElementType , class SupportType , class Allocator >

template<concepts::discrete_element... DElems>

element_type & ddc::Chunk< ElementType, SupportType, Allocator >::operator() ( DElems const &... delems )

inlinenoexcept

Element access using a list of DiscreteElement.

Parameters

delems discrete coordinates

Returns: reference to this element

Definition at line 219 of file chunk.hpp.

◆ operator()() [4/4]

template<class ElementType , class SupportType , class Allocator >

template<concepts::discrete_vector... DVects>
requires (sizeof...(DVects) != 0)

element_type & ddc::Chunk< ElementType, SupportType, Allocator >::operator() ( DVects const &... dvects )

inlinenoexcept

Element access using a list of DiscreteVector.

Parameters

dvects discrete vectors

Returns: reference to this element

Definition at line 235 of file chunk.hpp.

◆ label()

template<class ElementType , class SupportType , class Allocator >

char const * ddc::Chunk< ElementType, SupportType, Allocator >::label ( ) const

inline

Returns the label of the Chunk.

Returns: c-string

Definition at line 249 of file chunk.hpp.

◆ data_handle() [1/2]

template<class ElementType , class SupportType , class Allocator >

ElementType const * ddc::Chunk< ElementType, SupportType, Allocator >::data_handle ( ) const

inline

Access to the underlying allocation pointer.

Returns: read-only allocation pointer

Definition at line 257 of file chunk.hpp.

◆ data_handle() [2/2]

template<class ElementType , class SupportType , class Allocator >

ElementType * ddc::Chunk< ElementType, SupportType, Allocator >::data_handle ( )

inline

Access to the underlying allocation pointer.

Returns: allocation pointer

Definition at line 265 of file chunk.hpp.

◆ allocation_mdspan() [1/2]

template<class ElementType , class SupportType , class Allocator >

const_allocation_mdspan_type ddc::Chunk< ElementType, SupportType, Allocator >::allocation_mdspan ( ) const

inline

Provide a mdspan on the memory allocation.

Returns: read-only allocation mdspan

Definition at line 273 of file chunk.hpp.

◆ allocation_mdspan() [2/2]

template<class ElementType , class SupportType , class Allocator >

allocation_mdspan_type ddc::Chunk< ElementType, SupportType, Allocator >::allocation_mdspan ( )

inline

Provide a mdspan on the memory allocation.

Returns: allocation mdspan

Definition at line 281 of file chunk.hpp.

◆ allocation_kokkos_view() [1/2]

template<class ElementType , class SupportType , class Allocator >

auto ddc::Chunk< ElementType, SupportType, Allocator >::allocation_kokkos_view ( )

inline

Provide an unmanaged Kokkos::View on the memory allocation.

Returns: allocation Kokkos::View

Definition at line 289 of file chunk.hpp.

◆ allocation_kokkos_view() [2/2]

template<class ElementType , class SupportType , class Allocator >

auto ddc::Chunk< ElementType, SupportType, Allocator >::allocation_kokkos_view ( ) const

inline

Provide an unmanaged Kokkos::View on the memory allocation.

Returns: read-only allocation Kokkos::View

Definition at line 305 of file chunk.hpp.

◆ span_cview()

template<class ElementType , class SupportType , class Allocator >

view_type ddc::Chunk< ElementType, SupportType, Allocator >::span_cview ( ) const

inline

Definition at line 318 of file chunk.hpp.

◆ span_view() [1/2]

template<class ElementType , class SupportType , class Allocator >

view_type ddc::Chunk< ElementType, SupportType, Allocator >::span_view ( ) const

inline

Definition at line 323 of file chunk.hpp.

◆ span_view() [2/2]

template<class ElementType , class SupportType , class Allocator >

span_type ddc::Chunk< ElementType, SupportType, Allocator >::span_view ( )

inline

Definition at line 328 of file chunk.hpp.

Friends And Related Symbol Documentation

◆ Chunk

template<class ElementType , class SupportType , class Allocator >

template<class , class , class >

friend class Chunk

friend

Definition at line 81 of file chunk.hpp.

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

chunk.hpp

Public Types

Public Member Functions

Protected Types

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ base_type

◆ span_type

◆ view_type

◆ allocation_mdspan_type

◆ const_allocation_mdspan_type

◆ discrete_domain_type

◆ memory_space

◆ discrete_element_type

◆ discrete_vector_type

◆ extents_type

◆ layout_type

◆ mapping_type

◆ element_type

◆ value_type

◆ size_type

◆ data_handle_type

◆ reference

Constructor & Destructor Documentation

◆ Chunk() [1/5]

◆ Chunk() [2/5]

◆ Chunk() [3/5]

◆ Chunk() [4/5]

◆ Chunk() [5/5]

◆ ~Chunk()

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/4]

◆ operator[]() [2/4]

◆ operator[]() [3/4]

◆ operator[]() [4/4]

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ label()

◆ data_handle() [1/2]

◆ data_handle() [2/2]

◆ allocation_mdspan() [1/2]

◆ allocation_mdspan() [2/2]

◆ allocation_kokkos_view() [1/2]

◆ allocation_kokkos_view() [2/2]

◆ span_cview()

◆ span_view() [1/2]

◆ span_view() [2/2]

Friends And Related Symbol Documentation

◆ Chunk