axom::bump::MakeZoneVolumes< ExecSpace, TopologyView, CoordsetView > Class Template Reference

Makes a new element field with zone areas or volumes (depending on dimension) using the input topology and coordset views. More...

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

Public Types
using	value_type = double

Public Member Functions
	MakeZoneVolumes (const TopologyView &topologyView, 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 conduit::Node &n_topology, const conduit::Node &AXOM_UNUSED_PARAM(n_coordset), conduit::Node &n_outputField) const
	Create a new field from the input topology and place it in n_output. More...

Detailed Description

template<typename ExecSpace, typename TopologyView, typename CoordsetView>
class axom::bump::MakeZoneVolumes< ExecSpace, TopologyView, CoordsetView >

Makes a new element field with zone areas or volumes (depending on dimension) using the input topology and coordset views.

Template Parameters

ExecSpace	The execution space for the algorithm.
TopologyView	The topology view type.
CoordsetView	The coordset view type.

Member Typedef Documentation

value_type

template<typename ExecSpace , typename TopologyView , typename CoordsetView >

using axom::bump::MakeZoneVolumes< ExecSpace, TopologyView, CoordsetView >::value_type = double

Constructor & Destructor Documentation

MakeZoneVolumes()

template<typename ExecSpace , typename TopologyView , typename CoordsetView >

axom::bump::MakeZoneVolumes< ExecSpace, TopologyView, CoordsetView >::MakeZoneVolumes ( const TopologyView &  topologyView, const CoordsetView &  coordsetView  )

inline

Constructor.

Parameters

topologyView	The view for the input topology.
coordsetView	The view for the input coordset.

Member Function Documentation

setAllocatorID()

template<typename ExecSpace , typename TopologyView , typename CoordsetView >

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

getAllocatorID()

template<typename ExecSpace , typename TopologyView , typename CoordsetView >

int axom::bump::MakeZoneVolumes< ExecSpace, TopologyView, 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 TopologyView , typename CoordsetView >

void axom::bump::MakeZoneVolumes< ExecSpace, TopologyView, CoordsetView >::execute ( const conduit::Node &  n_topology, const conduit::Node &  AXOM_UNUSED_PARAMn_coordset, conduit::Node &  n_outputField  ) const

inline

Create a new field from the input topology and place it in n_output.

Parameters

	n_topology	The node that contains the input topology.
	n_coordset	The input coordset that we're blending.
[out]	n_outputField	The output node that will contain the new field.

References AXOM_LAMBDA, axom::sidre::ConduitMemory::axomAllocIdToConduit(), and axom::bump::MakeZoneVolumes< ExecSpace, TopologyView, CoordsetView >::getAllocatorID().

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/main/src/axom/bump/MakeZoneVolumes.hpp