axom::bump::CoordsetExtents< ExecSpace, CoordsetView > Class Template Reference

Compute coordset extents. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/bump/CoordsetExtents.hpp>

Public Member Functions
	CoordsetExtents (const CoordsetView &coordsetView)
	Constructor. More...
void	setAllocatorID (int allocator_id)
	Set the allocator id to use when allocating memory. More...
int	getAllocatorID () const
	Get the allocator id to use when allocating memory. More...
void	execute (double extents[NVALUES]) const
	Compute the spatial extents of the coordset and bring results to the host. More...
void	computeExtents (axom::ArrayView< double > extentsView) const
	Compute the spatial extents of the coordset into a device array. More...

Public Attributes
CoordsetView	m_coordsetView
int	m_allocator_id

Static Public Attributes
static constexpr int	NVALUES = CoordsetView::dimension() * 2

Detailed Description

template<typename ExecSpace, typename CoordsetView>
class axom::bump::CoordsetExtents< ExecSpace, CoordsetView >

Compute coordset extents.

Template Parameters

ExecSpace	The execution space where the algorithm runs.
CoordsetView	The coordset view type.

Constructor & Destructor Documentation

CoordsetExtents()

template<typename ExecSpace , typename CoordsetView >

axom::bump::CoordsetExtents< ExecSpace, CoordsetView >::CoordsetExtents ( const CoordsetView &  coordsetView )

inline

Constructor.

Parameters

coordsetView

The coordset view that wraps the coordset to be examined.

Member Function Documentation

setAllocatorID()

template<typename ExecSpace , typename CoordsetView >

void axom::bump::CoordsetExtents< ExecSpace, CoordsetView >::setAllocatorID ( int  allocator_id )

inline

Set the allocator id to use when allocating memory.

Parameters

allocator_id

The allocator id to use when allocating memory.

References axom::isValidAllocatorID(), axom::bump::CoordsetExtents< ExecSpace, CoordsetView >::m_allocator_id, and SLIC_ERROR_IF.

getAllocatorID()

template<typename ExecSpace , typename CoordsetView >

int axom::bump::CoordsetExtents< ExecSpace, CoordsetView >::getAllocatorID ( ) const

inline

Get the allocator id to use when allocating memory.

Returns

The allocator id to use when allocating memory.

References axom::bump::CoordsetExtents< ExecSpace, CoordsetView >::m_allocator_id.

execute()

template<typename ExecSpace , typename CoordsetView >

void axom::bump::CoordsetExtents< ExecSpace, CoordsetView >::execute ( double  extents[NVALUES] ) const

inline

Compute the spatial extents of the coordset and bring results to the host.

Parameters

[out]

extents

The extents on the host.

References axom::bump::CoordsetExtents< ExecSpace, CoordsetView >::computeExtents(), axom::copy(), axom::bump::CoordsetExtents< ExecSpace, CoordsetView >::getAllocatorID(), axom::bump::CoordsetExtents< ExecSpace, CoordsetView >::NVALUES, and axom::Array< T, DIM, SPACE, StoragePolicy >::view().

computeExtents()

template<typename ExecSpace , typename CoordsetView >

void axom::bump::CoordsetExtents< ExecSpace, CoordsetView >::computeExtents ( axom::ArrayView< double >  extentsView ) const

inline

Compute the spatial extents of the coordset into a device array.

Parameters

[out]

extentsView

A view on the device that contains extents, stored: xmin, xmax, ymin, ymax, zmin, zmax.

References AXOM_ANNOTATE_SCOPE, AXOM_LAMBDA, axom::bump::CoordsetExtents< ExecSpace, CoordsetView >::m_coordsetView, and axom::ArrayView< T, DIM, SPACE >::size().

Member Data Documentation

NVALUES

template<typename ExecSpace , typename CoordsetView >

constexpr int axom::bump::CoordsetExtents< ExecSpace, CoordsetView >::NVALUES = CoordsetView::dimension() * 2

staticconstexpr

m_coordsetView

template<typename ExecSpace , typename CoordsetView >

CoordsetView axom::bump::CoordsetExtents< ExecSpace, CoordsetView >::m_coordsetView

m_allocator_id

template<typename ExecSpace , typename CoordsetView >

int axom::bump::CoordsetExtents< ExecSpace, CoordsetView >::m_allocator_id

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/bump/CoordsetExtents.hpp