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

Convert a field with one association type to a field of another association type using an o2mrelation. More...

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

Public Member Functions

 RecenterField ()
 
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 conduit::Node &field, const conduit::Node &relation, conduit::Node &out_field) const
 Convert the input field to a different association type using the o2mrelation and store the new field in the output field. More...
 

Detailed Description

template<typename ExecSpace>
class axom::bump::RecenterField< ExecSpace >

Convert a field with one association type to a field of another association type using an o2mrelation.

Template Parameters
ExecSpaceThe execution space where the algorithm runs.

Constructor & Destructor Documentation

◆ RecenterField()

template<typename ExecSpace >
axom::bump::RecenterField< ExecSpace >::RecenterField ( )
inline

Member Function Documentation

◆ setAllocatorID()

template<typename ExecSpace >
void axom::bump::RecenterField< ExecSpace >::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 >
int axom::bump::RecenterField< ExecSpace >::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 >
void axom::bump::RecenterField< ExecSpace >::execute ( const conduit::Node &  field,
const conduit::Node &  relation,
conduit::Node &  out_field 
) const
inline

Convert the input field to a different association type using the o2mrelation and store the new field in the output field.

Parameters
fieldThe input field.
relationThe node that contains an o2mrelation with nodes to zones.
out_field[out]The node that will contain the new field.

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