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

Make a polyhedral unstructured representation of a topology. More...

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

Public Types

using ConnectivityType = typename TopologyView::ConnectivityType
 

Public Member Functions

 MakePolyhedralTopology (const TopologyView &topologyView)
 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_topo, conduit::Node &n_newTopo) const
 Make a polyhedral unstructured representation of a topology. More...
 

Public Attributes

TopologyView m_topologyView
 
int m_allocator_id
 

Detailed Description

template<typename ExecSpace, typename TopologyView>
class axom::bump::MakePolyhedralTopology< ExecSpace, TopologyView >

Make a polyhedral unstructured representation of a topology.

Template Parameters
ExecSpaceThe execution space where the algorithm runs.
TopologyViewThe topology view type.

Member Typedef Documentation

◆ ConnectivityType

template<typename ExecSpace , typename TopologyView >
using axom::bump::MakePolyhedralTopology< ExecSpace, TopologyView >::ConnectivityType = typename TopologyView::ConnectivityType

Constructor & Destructor Documentation

◆ MakePolyhedralTopology()

template<typename ExecSpace , typename TopologyView >
axom::bump::MakePolyhedralTopology< ExecSpace, TopologyView >::MakePolyhedralTopology ( const TopologyView &  topologyView)
inline

Constructor.

Parameters
topologyViewThe topology view that wraps the input topology.

Member Function Documentation

◆ setAllocatorID()

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

◆ getAllocatorID()

template<typename ExecSpace , typename TopologyView >
int axom::bump::MakePolyhedralTopology< ExecSpace, TopologyView >::getAllocatorID ( ) const
inline

Get the allocator id to use when allocating memory.

Returns
The allocator id to use when allocating memory.

References axom::bump::MakePolyhedralTopology< ExecSpace, TopologyView >::m_allocator_id.

◆ execute()

template<typename ExecSpace , typename TopologyView >
void axom::bump::MakePolyhedralTopology< ExecSpace, TopologyView >::execute ( const conduit::Node &  n_topo,
conduit::Node &  n_newTopo 
) const
inline

Make a polyhedral unstructured representation of a topology.

Template Parameters
ExecSpaceThe execution space where the work will be done.
Parameters
n_topoThe input topology to be turned polyhedral.
[out]n_newTopoThe node that will contain the new polyhedral topology.

References AXOM_ANNOTATE_BEGIN, AXOM_ANNOTATE_END, AXOM_ANNOTATE_SCOPE, AXOM_LAMBDA, axom::sidre::ConduitMemory::axomAllocIdToConduit(), axom::Array< T, DIM, SPACE, StoragePolicy >::clear(), axom::serial::reductions::ReduceSum< ExecSpace, T >::get(), axom::bump::MakePolyhedralTopology< ExecSpace, TopologyView >::getAllocatorID(), axom::bump::MakePolyhedralTopology< ExecSpace, TopologyView >::m_topologyView, SLIC_ERROR_IF, and axom::Array< T, DIM, SPACE, StoragePolicy >::view().

Member Data Documentation

◆ m_topologyView

template<typename ExecSpace , typename TopologyView >
TopologyView axom::bump::MakePolyhedralTopology< ExecSpace, TopologyView >::m_topologyView

◆ m_allocator_id

template<typename ExecSpace , typename TopologyView >
int axom::bump::MakePolyhedralTopology< ExecSpace, TopologyView >::m_allocator_id

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