#include <chunk_common.hpp>

Inheritance diagram for ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >:

Collaboration diagram for ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >:

Public Types
using	discrete_domain_type = SupportType

using	allocation_mdspan_type = Kokkos::mdspan< ElementType, Kokkos::dextents< std::size_t, SupportType::rank()>, LayoutStridedPolicy >
	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()>, LayoutStridedPolicy >

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
KOKKOS_FUNCTION constexpr accessor_type	accessor () const

KOKKOS_FUNCTION constexpr SupportType::discrete_vector_type	extents () const noexcept

template<class QueryDDim >
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

template<class QueryDDim >
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.

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

Static Public Member Functions
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
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.

template<class Mapping = mapping_type, std::enable_if_t< std::is_constructible_v< Mapping, extents_type >, int > = 0>
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
allocation_mdspan_type	m_allocation_mdspan
	The raw view of the data.

SupportType	m_domain
	The mesh on which this chunk is defined.

Friends
template<class , class , class >
class	ChunkCommon

template<class , class , class , class >
class	ChunkSpan

template<class , class , class >
class	Chunk

Detailed Description

template<class ElementType, class SupportType, class LayoutStridedPolicy>
class ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >

Definition at line 33 of file chunk_common.hpp.

Member Typedef Documentation

◆ discrete_domain_type

template<class ElementType , class SupportType , class LayoutStridedPolicy >

using ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::discrete_domain_type = SupportType

Definition at line 36 of file chunk_common.hpp.

◆ allocation_mdspan_type

template<class ElementType , class SupportType , class LayoutStridedPolicy >

using ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::allocation_mdspan_type = Kokkos::mdspan< ElementType, Kokkos::dextents<std::size_t, SupportType::rank()>, LayoutStridedPolicy>

The dereferenceable part of the co-domain but with a different domain, starting at 0.

Definition at line 39 of file chunk_common.hpp.

◆ const_allocation_mdspan_type

template<class ElementType , class SupportType , class LayoutStridedPolicy >

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

Definition at line 44 of file chunk_common.hpp.

◆ discrete_element_type

template<class ElementType , class SupportType , class LayoutStridedPolicy >

using ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::discrete_element_type = typename discrete_domain_type::discrete_element_type

Definition at line 49 of file chunk_common.hpp.

◆ discrete_vector_type

template<class ElementType , class SupportType , class LayoutStridedPolicy >

using ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::discrete_vector_type = typename discrete_domain_type::discrete_vector_type

Definition at line 51 of file chunk_common.hpp.

◆ extents_type

template<class ElementType , class SupportType , class LayoutStridedPolicy >

using ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::extents_type = typename allocation_mdspan_type::extents_type

Definition at line 53 of file chunk_common.hpp.

◆ layout_type

template<class ElementType , class SupportType , class LayoutStridedPolicy >

using ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::layout_type = typename allocation_mdspan_type::layout_type

Definition at line 55 of file chunk_common.hpp.

◆ accessor_type

template<class ElementType , class SupportType , class LayoutStridedPolicy >

using ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::accessor_type = typename allocation_mdspan_type::accessor_type

Definition at line 57 of file chunk_common.hpp.

◆ mapping_type

template<class ElementType , class SupportType , class LayoutStridedPolicy >

using ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::mapping_type = typename allocation_mdspan_type::mapping_type

Definition at line 59 of file chunk_common.hpp.

◆ element_type

template<class ElementType , class SupportType , class LayoutStridedPolicy >

using ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::element_type = typename allocation_mdspan_type::element_type

Definition at line 61 of file chunk_common.hpp.

◆ value_type

template<class ElementType , class SupportType , class LayoutStridedPolicy >

using ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::value_type = typename allocation_mdspan_type::value_type

Definition at line 63 of file chunk_common.hpp.

◆ size_type

template<class ElementType , class SupportType , class LayoutStridedPolicy >

using ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::size_type = typename allocation_mdspan_type::size_type

Definition at line 65 of file chunk_common.hpp.

◆ data_handle_type

template<class ElementType , class SupportType , class LayoutStridedPolicy >

using ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::data_handle_type = typename allocation_mdspan_type::data_handle_type

Definition at line 67 of file chunk_common.hpp.

◆ reference

template<class ElementType , class SupportType , class LayoutStridedPolicy >

using ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::reference = typename allocation_mdspan_type::reference

Definition at line 69 of file chunk_common.hpp.

Constructor & Destructor Documentation

◆ ChunkCommon() [1/5]

template<class ElementType , class SupportType , class LayoutStridedPolicy >

KOKKOS_DEFAULTED_FUNCTION constexpr ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::ChunkCommon ( )

constexprprotecteddefault

Empty ChunkCommon.

◆ ChunkCommon() [2/5]

template<class ElementType , class SupportType , class LayoutStridedPolicy >

KOKKOS_FUNCTION constexpr ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::ChunkCommon	(	allocation_mdspan_type	allocation_mdspan,
		SupportType const &	domain
	)

inlineconstexprprotectednoexcept

Constructs a new ChunkCommon from scratch.

Parameters

allocation_mdspan
domain

Definition at line 203 of file chunk_common.hpp.

◆ ChunkCommon() [3/5]

template<class ElementType , class SupportType , class LayoutStridedPolicy >

template<class Mapping = mapping_type, std::enable_if_t< std::is_constructible_v< Mapping, extents_type >, int > = 0>

KOKKOS_FUNCTION constexpr ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::ChunkCommon	(	ElementType *	ptr,
		SupportType const &	domain
	)

inlineconstexprprotected

Constructs a new ChunkCommon from scratch.

Parameters

ptr	the allocation pointer to the data
domain	the domain that sustains the view

Definition at line 218 of file chunk_common.hpp.

◆ ChunkCommon() [4/5]

template<class ElementType , class SupportType , class LayoutStridedPolicy >

KOKKOS_DEFAULTED_FUNCTION constexpr ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::ChunkCommon ( ChunkCommon< ElementType, SupportType, LayoutStridedPolicy > const & other )

constexprprotecteddefault

Constructs a new ChunkCommon by copy, yields a new view to the same data.

Parameters

other the ChunkCommon to copy

◆ ChunkCommon() [5/5]

template<class ElementType , class SupportType , class LayoutStridedPolicy >

KOKKOS_DEFAULTED_FUNCTION constexpr ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::ChunkCommon ( ChunkCommon< ElementType, SupportType, LayoutStridedPolicy > && other )

constexprprotecteddefaultnoexcept

Constructs a new ChunkCommon by move.

Parameters

other the ChunkCommon to move

◆ ~ChunkCommon()

template<class ElementType , class SupportType , class LayoutStridedPolicy >

KOKKOS_DEFAULTED_FUNCTION ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::~ChunkCommon ( )

protecteddefaultnoexcept

Member Function Documentation

◆ rank()

template<class ElementType , class SupportType , class LayoutStridedPolicy >

static KOKKOS_FUNCTION constexpr int ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::rank ( )

inlinestaticconstexprnoexcept

Definition at line 91 of file chunk_common.hpp.

◆ rank_dynamic()

template<class ElementType , class SupportType , class LayoutStridedPolicy >

static KOKKOS_FUNCTION constexpr int ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::rank_dynamic ( )

inlinestaticconstexprnoexcept

Definition at line 96 of file chunk_common.hpp.

◆ static_extent()

template<class ElementType , class SupportType , class LayoutStridedPolicy >

static KOKKOS_FUNCTION constexpr size_type ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::static_extent ( std::size_t r )

inlinestaticconstexprnoexcept

Definition at line 101 of file chunk_common.hpp.

◆ is_always_unique()

template<class ElementType , class SupportType , class LayoutStridedPolicy >

static KOKKOS_FUNCTION constexpr bool ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::is_always_unique ( )

inlinestaticconstexprnoexcept

Definition at line 106 of file chunk_common.hpp.

◆ is_always_exhaustive()

template<class ElementType , class SupportType , class LayoutStridedPolicy >

static KOKKOS_FUNCTION constexpr bool ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::is_always_exhaustive ( )

inlinestaticconstexprnoexcept

Definition at line 111 of file chunk_common.hpp.

◆ is_always_strided()

template<class ElementType , class SupportType , class LayoutStridedPolicy >

static KOKKOS_FUNCTION constexpr bool ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::is_always_strided ( )

inlinestaticconstexprnoexcept

Definition at line 116 of file chunk_common.hpp.

◆ accessor()

template<class ElementType , class SupportType , class LayoutStridedPolicy >

KOKKOS_FUNCTION constexpr accessor_type ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::accessor ( ) const

inlineconstexpr

Definition at line 131 of file chunk_common.hpp.

◆ extents()

template<class ElementType , class SupportType , class LayoutStridedPolicy >

KOKKOS_FUNCTION constexpr SupportType::discrete_vector_type ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::extents ( ) const

inlineconstexprnoexcept

Definition at line 136 of file chunk_common.hpp.

◆ extent()

template<class ElementType , class SupportType , class LayoutStridedPolicy >

template<class QueryDDim >

KOKKOS_FUNCTION constexpr size_type ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::extent ( ) const

inlineconstexprnoexcept

Definition at line 142 of file chunk_common.hpp.

◆ size()

template<class ElementType , class SupportType , class LayoutStridedPolicy >

KOKKOS_FUNCTION constexpr size_type ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::size ( ) const

inlineconstexprnoexcept

Definition at line 147 of file chunk_common.hpp.

◆ mapping()

template<class ElementType , class SupportType , class LayoutStridedPolicy >

KOKKOS_FUNCTION constexpr mapping_type ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::mapping ( ) const

inlineconstexprnoexcept

Definition at line 152 of file chunk_common.hpp.

◆ is_unique()

template<class ElementType , class SupportType , class LayoutStridedPolicy >

KOKKOS_FUNCTION constexpr bool ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::is_unique ( ) const

inlineconstexprnoexcept

Definition at line 157 of file chunk_common.hpp.

◆ is_exhaustive()

template<class ElementType , class SupportType , class LayoutStridedPolicy >

KOKKOS_FUNCTION constexpr bool ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::is_exhaustive ( ) const

inlineconstexprnoexcept

Definition at line 162 of file chunk_common.hpp.

◆ is_strided()

template<class ElementType , class SupportType , class LayoutStridedPolicy >

KOKKOS_FUNCTION constexpr bool ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::is_strided ( ) const

inlineconstexprnoexcept

Definition at line 167 of file chunk_common.hpp.

◆ stride()

template<class ElementType , class SupportType , class LayoutStridedPolicy >

template<class QueryDDim >

KOKKOS_FUNCTION constexpr size_type ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::stride ( ) const

inlineconstexpr

Definition at line 173 of file chunk_common.hpp.

◆ domain() [1/2]

template<class ElementType , class SupportType , class LayoutStridedPolicy >

KOKKOS_FUNCTION constexpr SupportType ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::domain ( ) const

inlineconstexprnoexcept

Provide access to the domain on which this chunk is defined.

Returns: the domain on which this chunk is defined

Definition at line 181 of file chunk_common.hpp.

◆ domain() [2/2]

template<class ElementType , class SupportType , class LayoutStridedPolicy >

template<class... QueryDDims>

KOKKOS_FUNCTION constexpr DiscreteDomain< QueryDDims... > ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::domain ( ) const

inlineconstexprnoexcept

Provide access to the domain on which this chunk is defined.

Returns: the domain on which this chunk is defined

Definition at line 190 of file chunk_common.hpp.

◆ operator=() [1/2]

template<class ElementType , class SupportType , class LayoutStridedPolicy >

KOKKOS_DEFAULTED_FUNCTION constexpr ChunkCommon & ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::operator= ( ChunkCommon< ElementType, SupportType, LayoutStridedPolicy > const & other )

constexprprotecteddefault

Copy-assigns a new value to this ChunkCommon, yields a new view to the same data.

Parameters

other the ChunkCommon to copy

Returns: *this

◆ operator=() [2/2]

template<class ElementType , class SupportType , class LayoutStridedPolicy >

KOKKOS_DEFAULTED_FUNCTION constexpr ChunkCommon & ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::operator= ( ChunkCommon< ElementType, SupportType, LayoutStridedPolicy > && other )

constexprprotecteddefaultnoexcept

Move-assigns a new value to this ChunkCommon.

Parameters

other the ChunkCommon to move

Returns: *this

◆ data_handle()

template<class ElementType , class SupportType , class LayoutStridedPolicy >

KOKKOS_FUNCTION constexpr ElementType * ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::data_handle ( ) const

inlineconstexprprotected

Access to the underlying allocation pointer.

Returns: allocation pointer

Definition at line 254 of file chunk_common.hpp.

◆ allocation_mdspan()

template<class ElementType , class SupportType , class LayoutStridedPolicy >

KOKKOS_FUNCTION constexpr allocation_mdspan_type ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::allocation_mdspan ( ) const

inlineconstexprprotected

Provide a modifiable view of the data.

Returns: a modifiable view of the data

Definition at line 262 of file chunk_common.hpp.

Friends And Related Symbol Documentation

◆ ChunkCommon

template<class ElementType , class SupportType , class LayoutStridedPolicy >

template<class , class , class >

friend class ChunkCommon

friend

Definition at line 73 of file chunk_common.hpp.

◆ ChunkSpan

template<class ElementType , class SupportType , class LayoutStridedPolicy >

template<class , class , class , class >

friend class ChunkSpan

friend

Definition at line 76 of file chunk_common.hpp.

◆ Chunk

template<class ElementType , class SupportType , class LayoutStridedPolicy >

template<class , class , class >

friend class Chunk

friend

Definition at line 79 of file chunk_common.hpp.

Member Data Documentation

◆ m_allocation_mdspan

template<class ElementType , class SupportType , class LayoutStridedPolicy >

allocation_mdspan_type ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::m_allocation_mdspan

protected

The raw view of the data.

Definition at line 85 of file chunk_common.hpp.

◆ m_domain

template<class ElementType , class SupportType , class LayoutStridedPolicy >

SupportType ddc::ChunkCommon< ElementType, SupportType, LayoutStridedPolicy >::m_domain

protected

The mesh on which this chunk is defined.

Definition at line 88 of file chunk_common.hpp.

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

chunk_common.hpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ discrete_domain_type

◆ allocation_mdspan_type

◆ const_allocation_mdspan_type

◆ discrete_element_type

◆ discrete_vector_type

◆ extents_type

◆ layout_type

◆ accessor_type

◆ mapping_type

◆ element_type

◆ value_type

◆ size_type

◆ data_handle_type

◆ reference

Constructor & Destructor Documentation

◆ ChunkCommon() [1/5]

◆ ChunkCommon() [2/5]

◆ ChunkCommon() [3/5]

◆ ChunkCommon() [4/5]

◆ ChunkCommon() [5/5]

◆ ~ChunkCommon()

Member Function Documentation

◆ rank()

◆ rank_dynamic()

◆ static_extent()

◆ is_always_unique()

◆ is_always_exhaustive()

◆ is_always_strided()

◆ accessor()

◆ extents()

◆ extent()

◆ size()

◆ mapping()

◆ is_unique()

◆ is_exhaustive()

◆ is_strided()

◆ stride()

◆ domain() [1/2]

◆ domain() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ data_handle()

◆ allocation_mdspan()

Friends And Related Symbol Documentation

◆ ChunkCommon

◆ ChunkSpan

◆ Chunk

Member Data Documentation

◆ m_allocation_mdspan

◆ m_domain