axom::bump::views::UnstructuredTopologyPolyhedralView< ConnType > Class Template Reference

This class implements a view for Blueprint polyhedral topologies. More...

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

Classes
struct	PolyhedronData
	This struct contains views that hold polyhedral connectivity. More...
struct	PolyhedronShape
	This struct provides data about Zone i's shape. More...

Public Types
using	ConnectivityType = ConnType
using	ConnectivityView = axom::ArrayView< ConnectivityType >
using	IndexingPolicy = BasicIndexing
using	ShapeType = PolyhedronShape

Public Member Functions
AXOM_HOST_DEVICE	UnstructuredTopologyPolyhedralView (const ConnectivityView &subelement_conn, const ConnectivityView &subelement_sizes, const ConnectivityView &subelement_offsets, const ConnectivityView &element_conn, const ConnectivityView &element_sizes, const ConnectivityView &element_offsets)
	Constructor. More...
AXOM_HOST_DEVICE IndexType	numberOfZones () const
	Return the number of zones in the mesh. More...
AXOM_HOST_DEVICE IndexType	connectivitySize () const
	Return the size of the connectivity. More...
AXOM_HOST_DEVICE const IndexingPolicy &	indexing () const
	Return the size of the connectivity. More...
AXOM_HOST_DEVICE ShapeType	zone (axom::IndexType zoneIndex) const
	Return a zone. More...

Static Public Member Functions
static constexpr AXOM_HOST_DEVICE int	dimension ()
	Return the dimension of the shape. More...

Detailed Description

template<typename ConnType>
class axom::bump::views::UnstructuredTopologyPolyhedralView< ConnType >

This class implements a view for Blueprint polyhedral topologies.

Member Typedef Documentation

ConnectivityType

template<typename ConnType >

using axom::bump::views::UnstructuredTopologyPolyhedralView< ConnType >::ConnectivityType = ConnType

ConnectivityView

template<typename ConnType >

using axom::bump::views::UnstructuredTopologyPolyhedralView< ConnType >::ConnectivityView = axom::ArrayView<ConnectivityType>

IndexingPolicy

template<typename ConnType >

using axom::bump::views::UnstructuredTopologyPolyhedralView< ConnType >::IndexingPolicy = BasicIndexing

ShapeType

template<typename ConnType >

using axom::bump::views::UnstructuredTopologyPolyhedralView< ConnType >::ShapeType = PolyhedronShape

Constructor & Destructor Documentation

UnstructuredTopologyPolyhedralView()

template<typename ConnType >

AXOM_HOST_DEVICE axom::bump::views::UnstructuredTopologyPolyhedralView< ConnType >::UnstructuredTopologyPolyhedralView ( const ConnectivityView &  subelement_conn, const ConnectivityView &  subelement_sizes, const ConnectivityView &  subelement_offsets, const ConnectivityView &  element_conn, const ConnectivityView &  element_sizes, const ConnectivityView &  element_offsets  )

inline

Constructor.

Member Function Documentation

numberOfZones()

template<typename ConnType >

AXOM_HOST_DEVICE IndexType axom::bump::views::UnstructuredTopologyPolyhedralView< ConnType >::numberOfZones ( ) const

inline

Return the number of zones in the mesh.

Returns

The number of zones.

References axom::bump::views::UnstructuredTopologyPolyhedralView< ConnType >::PolyhedronData::m_element_sizes, and axom::ArrayView< T, DIM, SPACE >::size().

connectivitySize()

template<typename ConnType >

AXOM_HOST_DEVICE IndexType axom::bump::views::UnstructuredTopologyPolyhedralView< ConnType >::connectivitySize ( ) const

inline

Return the size of the connectivity.

Returns

The size of the connectivity.

dimension()

template<typename ConnType >

static constexpr AXOM_HOST_DEVICE int axom::bump::views::UnstructuredTopologyPolyhedralView< ConnType >::dimension ( )

inlinestaticconstexpr

Return the dimension of the shape.

Returns

The dimension of the shape.

indexing()

template<typename ConnType >

AXOM_HOST_DEVICE const IndexingPolicy& axom::bump::views::UnstructuredTopologyPolyhedralView< ConnType >::indexing ( ) const

inline

Return the size of the connectivity.

Returns

The size of the connectivity.

References axom::bump::views::UnstructuredTopologyPolyhedralView< ConnType >::PolyhedronData::m_indexing.

zone()

template<typename ConnType >

AXOM_HOST_DEVICE ShapeType axom::bump::views::UnstructuredTopologyPolyhedralView< ConnType >::zone ( axom::IndexType  zoneIndex ) const

inline

Return a zone.

Parameters

zoneIndex

The requested zone.

Returns

The requested zone.

References axom::bump::views::UnstructuredTopologyPolyhedralView< ConnType >::numberOfZones(), and SLIC_ASSERT.

---

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

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