axom::bump::FieldBlender< ExecSpace, SelectionPolicy, IndexingPolicy > Class Template Reference

This class uses BlendData to generate a new blended field from an input field. More...

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

Public Member Functions
	FieldBlender ()
	Constructor. More...
	FieldBlender (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 BlendData &blend, const conduit::Node &n_input, conduit::Node &n_output) const
	Create a new blended field from the n_input field and place it in n_output. More...

Detailed Description

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

This class uses BlendData to generate a new blended field from an input field.

Template Parameters

ExecSpace	The execution space where the work will occur.
SelectionPolicy	The selection policy to use.
IndexingPolicy	A class that provides operator[] that can transform node indices.

Constructor & Destructor Documentation

FieldBlender() [1/2]

template<typename ExecSpace , typename SelectionPolicy , typename IndexingPolicy = DirectIndexing>

axom::bump::FieldBlender< ExecSpace, SelectionPolicy, IndexingPolicy >::FieldBlender ( )

inline

Constructor.

FieldBlender() [2/2]

template<typename ExecSpace , typename SelectionPolicy , typename IndexingPolicy = DirectIndexing>

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

inline

Constructor.

Parameters

indexing

An object used to transform node indices.

Member Function Documentation

setAllocatorID()

template<typename ExecSpace , typename SelectionPolicy , typename IndexingPolicy = DirectIndexing>

void axom::bump::FieldBlender< ExecSpace, SelectionPolicy, 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 SelectionPolicy , typename IndexingPolicy = DirectIndexing>

int axom::bump::FieldBlender< ExecSpace, SelectionPolicy, 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 SelectionPolicy , typename IndexingPolicy = DirectIndexing>

void axom::bump::FieldBlender< ExecSpace, SelectionPolicy, IndexingPolicy >::execute ( const BlendData &  blend, const conduit::Node &  n_input, conduit::Node &  n_output  ) const

inline

Create a new blended field from the n_input field and place it in n_output.

Parameters

blend	The BlendData that will be used to make the new field.
n_input	The input field that we're blending.
n_output	The output node that will contain the new field.

---

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

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