amrex::GpuArray< T, N > Class Template Reference

Fixed-size array that can be used on GPU. More...

#include <AMReX_Array.H>

Public Types
using	value_type = T
using	reference_type = T &

Public Member Functions
__host__ __device__ const T &	operator[] (int i) const noexcept
__host__ __device__ T &	operator[] (int i) noexcept
__host__ __device__ const T *	data () const noexcept
__host__ __device__ T *	data () noexcept
__host__ __device__ const T *	begin () const noexcept
__host__ __device__ const T *	end () const noexcept
__host__ __device__ T *	begin () noexcept
__host__ __device__ T *	end () noexcept
__host__ __device__ void	fill (const T &value) noexcept
__host__ __device__ constexpr T	sum () const noexcept
__host__ __device__ T	product () const noexcept
__host__ __device__ GpuArray< T, N > &	operator+= (GpuArray< T, N > const &a) noexcept

Static Public Member Functions
__host__ static __device__ constexpr unsigned int	size () noexcept

Public Attributes
T	arr [amrex::max(N, 1U)]

Detailed Description

template<class T, unsigned int N>
class amrex::GpuArray< T, N >

Fixed-size array that can be used on GPU.

Member Typedef Documentation

reference_type

template<class T , unsigned int N>

using amrex::GpuArray< T, N >::reference_type = T&

value_type

template<class T , unsigned int N>

using amrex::GpuArray< T, N >::value_type = T

Member Function Documentation

begin() [1/2]

template<class T , unsigned int N>

__host__ __device__ const T * amrex::GpuArray< T, N >::begin ( ) const

inlinenoexcept

Returns a const pointer address to the first element of the GpuArray object.

begin() [2/2]

template<class T , unsigned int N>

__host__ __device__ T * amrex::GpuArray< T, N >::begin ( )

inlinenoexcept

Returns a pointer address to the first element of the GpuArray object.

data() [1/2]

template<class T , unsigned int N>

__host__ __device__ const T * amrex::GpuArray< T, N >::data ( ) const

inlinenoexcept

Returns a const pointer to the underlying data of a GpuArray object.

data() [2/2]

template<class T , unsigned int N>

__host__ __device__ T * amrex::GpuArray< T, N >::data ( )

inlinenoexcept

Returns a pointer to the underlying data of a GpuArray object.

end() [1/2]

template<class T , unsigned int N>

__host__ __device__ const T * amrex::GpuArray< T, N >::end ( ) const

inlinenoexcept

Returns a const pointer address right after the last element of the GpuArray object.

end() [2/2]

template<class T , unsigned int N>

__host__ __device__ T * amrex::GpuArray< T, N >::end ( )

inlinenoexcept

Returns a pointer address right after the last element of the GpuArray object.

fill()

template<class T , unsigned int N>

__host__ __device__ void amrex::GpuArray< T, N >::fill ( const T &  value )

inlinenoexcept

Fills in all of the elements in the GpuArray object to the same value.

Parameters

value

The fill value

operator+=()

template<class T , unsigned int N>

__host__ __device__ GpuArray< T, N > & amrex::GpuArray< T, N >::operator+= ( GpuArray< T, N > const &  a )

inlinenoexcept

operator[]() [1/2]

template<class T , unsigned int N>

__host__ __device__ const T & amrex::GpuArray< T, N >::operator[] ( int  i ) const

inlinenoexcept

GpuArray elements are indexed using square brackets, as with any other array.

operator[]() [2/2]

template<class T , unsigned int N>

__host__ __device__ T & amrex::GpuArray< T, N >::operator[] ( int  i )

inlinenoexcept

GpuArray elements are indexed using square brackets, as with any other array.

product()

template<class T , unsigned int N>

__host__ __device__ T amrex::GpuArray< T, N >::product ( ) const

inlinenoexcept

Returns the product of all elements in the GpuArray object.

size()

template<class T , unsigned int N>

__host__ static __device__ constexpr unsigned int amrex::GpuArray< T, N >::size ( )

inlinestaticconstexprnoexcept

Returns the number of elements in the GpuArray object as an unsigned integer.

sum()

template<class T , unsigned int N>

__host__ __device__ constexpr T amrex::GpuArray< T, N >::sum ( ) const

inlineconstexprnoexcept

Returns the sum of all elements in the GpuArray object.

Member Data Documentation

arr

template<class T , unsigned int N>

T amrex::GpuArray< T, N >::arr[amrex::max(N, 1U)]

---

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

• /home/runner/work/amrex/amrex/Src/Base/AMReX_Array.H