This struct represents a polygon zone. More...

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

Inheritance diagram for axom::bump::views::PolygonShape< ConnType >:

Public Types
using	ConnectivityType = ConnType

using	ConnectivityView = axom::ArrayView< ConnectivityType >

using	ConnectivityStorage = ConnectivityType

using	ConnectivityStorageRef = ConnectivityView &

using	ConnectivityStorageConstRef = const ConnectivityView &

Public Member Functions
AXOM_HOST_DEVICE	PolygonShape (const ConnectivityView &ids)
	Construct a shape. More...

AXOM_HOST_DEVICE IndexType	numberOfNodes () const
	Return the number of nodes in the polygon. More...

AXOM_HOST_DEVICE ConnectivityType	getId (size_t index) const
	Get a specific id that makes up this shape. More...

AXOM_HOST_DEVICE ConnectivityStorageRef	getIdsStorage ()
	Get the storage for the ids that make up this shape. More...

AXOM_HOST_DEVICE ConnectivityStorageConstRef	getIdsStorage () const
	Get the storage for the ids that make up this shape. More...

AXOM_HOST_DEVICE ConnectivityView	getIds () const
	Get the ids that make up this shape. More...

AXOM_HOST_DEVICE void	getFace (int AXOM_UNUSED_PARAM(faceIndex), ConnectivityType *ids, axom::IndexType &numIds) const
	Get the ids for the requested face. More...

AXOM_HOST_DEVICE IndexType	numberOfEdges () const
	Return the number of edges in the polygon. More...

AXOM_HOST_DEVICE IndexType	numberOfNodesInFace (int) const
	Return the number of nodes in the face. More...

AXOM_HOST_DEVICE axom::StackArray< IndexType, 2 >	getEdge (int edgeIndex) const
	Return the specified edge. More...

Static Public Member Functions
constexpr static AXOM_HOST_DEVICE int	id ()

constexpr static AXOM_HOST_DEVICE bool	is_polyhedral ()

constexpr static AXOM_HOST_DEVICE bool	is_variable_size ()

constexpr static AXOM_HOST_DEVICE IndexType	dimension ()

constexpr static AXOM_HOST_DEVICE IndexType	numberOfFaces ()

constexpr static AXOM_HOST_DEVICE IndexType	maxNodesInFace ()

constexpr static AXOM_HOST_DEVICE const char *	name ()

Detailed Description

template<typename ConnType>
struct axom::bump::views::PolygonShape< ConnType >

This struct represents a polygon zone.

Member Typedef Documentation

◆ ConnectivityType

template<typename ConnType >

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

◆ ConnectivityView

template<typename ConnType >

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

◆ ConnectivityStorage

template<typename ConnType >

using axom::bump::views::PolygonShape< ConnType >::ConnectivityStorage = ConnectivityType

◆ ConnectivityStorageRef

template<typename ConnType >

using axom::bump::views::PolygonShape< ConnType >::ConnectivityStorageRef = ConnectivityView &

◆ ConnectivityStorageConstRef

template<typename ConnType >

using axom::bump::views::PolygonShape< ConnType >::ConnectivityStorageConstRef = const ConnectivityView &

Constructor & Destructor Documentation

◆ PolygonShape()

template<typename ConnType >

AXOM_HOST_DEVICE axom::bump::views::PolygonShape< ConnType >::PolygonShape ( const ConnectivityView & ids )

inline

Construct a shape.

Member Function Documentation

◆ numberOfNodes()

template<typename ConnType >

AXOM_HOST_DEVICE IndexType axom::bump::views::PolygonShape< ConnType >::numberOfNodes ( ) const

inline

Return the number of nodes in the polygon.

Returns: The number of nodes in the polygon.

References axom::ArrayView< T, DIM, SPACE >::size().

◆ getId()

template<typename ConnType >

AXOM_HOST_DEVICE ConnectivityType axom::bump::views::PolygonShape< ConnType >::getId ( size_t index ) const

inline

Get a specific id that makes up this shape.

Returns: The i'th id that makes up this shape.

References axom::ArrayView< T, DIM, SPACE >::size(), and SLIC_ASSERT.

◆ getIdsStorage() [1/2]

template<typename ConnType >

AXOM_HOST_DEVICE ConnectivityStorageRef axom::bump::views::PolygonShape< ConnType >::getIdsStorage ( )

inline

Get the storage for the ids that make up this shape.

Returns: The container for the ids that make up this shape.

◆ getIdsStorage() [2/2]

template<typename ConnType >

AXOM_HOST_DEVICE ConnectivityStorageConstRef axom::bump::views::PolygonShape< ConnType >::getIdsStorage ( ) const

inline

Get the storage for the ids that make up this shape.

Returns: The container for the ids that make up this shape.

◆ getIds()

template<typename ConnType >

AXOM_HOST_DEVICE ConnectivityView axom::bump::views::PolygonShape< ConnType >::getIds ( ) const

inline

Get the ids that make up this shape.

Returns: A view containing the ids that make up this shape.

◆ getFace()

template<typename ConnType >

AXOM_HOST_DEVICE void axom::bump::views::PolygonShape< ConnType >::getFace	(	int	AXOM_UNUSED_PARAMfaceIndex,
		ConnectivityType *	ids,
		axom::IndexType &	numIds
	)		const

inline

Get the ids for the requested face.

Parameters

	faceIndex	The index of the desired face.
[out]	ids	A buffer that will contain the ids.
[out]	numIds	The number of ids returned for the face.

References axom::ArrayView< T, DIM, SPACE >::size().

◆ numberOfEdges()

template<typename ConnType >

AXOM_HOST_DEVICE IndexType axom::bump::views::PolygonShape< ConnType >::numberOfEdges ( ) const

inline

Return the number of edges in the polygon.

Returns: The number of edges.

References axom::ArrayView< T, DIM, SPACE >::size().

◆ numberOfNodesInFace()

template<typename ConnType >

AXOM_HOST_DEVICE IndexType axom::bump::views::PolygonShape< ConnType >::numberOfNodesInFace ( int ) const

inline

Return the number of nodes in the face.

Returns: The number of nodes in the 1 face.

References axom::ArrayView< T, DIM, SPACE >::size().

◆ getEdge()

template<typename ConnType >

AXOM_HOST_DEVICE axom::StackArray<IndexType, 2> axom::bump::views::PolygonShape< ConnType >::getEdge ( int edgeIndex ) const

inline

Return the specified edge.

Parameters

edgeIndex The index of the edge to return.

Returns: The 2 point ids in the edge.

References axom::ArrayView< T, DIM, SPACE >::size().