axom::bump::FieldSlicer< ExecSpace, IndexingPolicy > Class Template Reference

This class uses SliceData to generate a new sliced field from an input field. More...

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

Public Member Functions
	FieldSlicer ()
	Constructor. More...
	FieldSlicer (const IndexingPolicy &indexing)
	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 (const SliceData &slice, const conduit::Node &n_input, conduit::Node &n_output)
	Execute the slice on the n_input field and store the new sliced field in n_output. More...

Detailed Description

template<typename ExecSpace, typename IndexingPolicy = DirectIndexing>
class axom::bump::FieldSlicer< ExecSpace, IndexingPolicy >

This class uses SliceData to generate a new sliced field from an input field.

Template Parameters

ExecSpace	The execution space where the algorithm will run.
IndexingPolicy	A class that provides operator[] that can transform zone indices.

Constructor & Destructor Documentation

FieldSlicer() [1/2]

template<typename ExecSpace , typename IndexingPolicy = DirectIndexing>

axom::bump::FieldSlicer< ExecSpace, IndexingPolicy >::FieldSlicer ( )

inline

Constructor.

FieldSlicer() [2/2]

template<typename ExecSpace , typename IndexingPolicy = DirectIndexing>

axom::bump::FieldSlicer< ExecSpace, IndexingPolicy >::FieldSlicer ( const IndexingPolicy &  indexing )

inline

Constructor.

Parameters

indexing

An object used to transform node indices.

Member Function Documentation

setAllocatorID()

template<typename ExecSpace , typename IndexingPolicy = DirectIndexing>

void axom::bump::FieldSlicer< ExecSpace, IndexingPolicy >::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(), and SLIC_ERROR_IF.

getAllocatorID()

template<typename ExecSpace , typename IndexingPolicy = DirectIndexing>

int axom::bump::FieldSlicer< ExecSpace, IndexingPolicy >::getAllocatorID ( ) const

inline

Get the allocator id to use when allocating memory.

Returns

The allocator id to use when allocating memory.

execute()

template<typename ExecSpace , typename IndexingPolicy = DirectIndexing>

void axom::bump::FieldSlicer< ExecSpace, IndexingPolicy >::execute ( const SliceData &  slice, const conduit::Node &  n_input, conduit::Node &  n_output  )

inline

Execute the slice on the n_input field and store the new sliced field in n_output.

Parameters

slice	The slice data that indicates how the field will be sliced.
n_input	A Conduit node containing the field to be sliced.
n_output	A node that will contain the sliced field.

Note

We assume for now that n_input != n_output.

References axom::primal::slice().

---

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

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