AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
axom::bump::CoordsetSlicer< ExecSpace, CoordsetView > Class Template Reference

This class uses SliceData to generate a new sliced coordset (pulling out specific points from input coordset). More...

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

Public Member Functions

 CoordsetSlicer (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 (const SliceData &slice, const conduit::Node &n_input, conduit::Node &n_output)
 Execute the slice on the n_input coordset and store the new sliced coordset in n_output. More...
 

Detailed Description

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

This class uses SliceData to generate a new sliced coordset (pulling out specific points from input coordset).

Template Parameters
ExecSpaceThe execution space where the algorithm will run.
CoordsetViewThe coordset view type to be operated on.

Constructor & Destructor Documentation

◆ CoordsetSlicer()

template<typename ExecSpace , typename CoordsetView >
axom::bump::CoordsetSlicer< ExecSpace, CoordsetView >::CoordsetSlicer ( const CoordsetView &  coordsetView)
inline

Constructor.

Member Function Documentation

◆ setAllocatorID()

template<typename ExecSpace , typename CoordsetView >
void axom::bump::CoordsetSlicer< ExecSpace, CoordsetView >::setAllocatorID ( int  allocator_id)
inline

Set the allocator id to use when allocating memory.

Parameters
allocator_idThe allocator id to use when allocating memory.

References axom::isValidAllocatorID(), and SLIC_ERROR_IF.

◆ getAllocatorID()

template<typename ExecSpace , typename CoordsetView >
int axom::bump::CoordsetSlicer< ExecSpace, CoordsetView >::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 CoordsetView >
void axom::bump::CoordsetSlicer< ExecSpace, CoordsetView >::execute ( const SliceData slice,
const conduit::Node &  n_input,
conduit::Node &  n_output 
)
inline

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

Parameters
sliceThe slice data that indicates how the coordset will be sliced.
n_inputA Conduit node containing the coordset to be sliced.
n_outputA node that will contain the sliced coordset.
Note
We assume for now that n_input != n_output.

References AXOM_ANNOTATE_SCOPE, AXOM_LAMBDA, axom::sidre::ConduitMemory::axomAllocIdToConduit(), axom::bump::utilities::coordsetAxes(), axom::bump::CoordsetSlicer< ExecSpace, CoordsetView >::getAllocatorID(), SLIC_ASSERT, and axom::primal::slice().


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