axom::bump::views::BasicIndexing Class Reference

A basic indexing class that provides methods for indexing transforms that have no effect. This is provided for topology view compatibility in algorithms that might use structured/unstructured topologies where index transforms are important. More...

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

Public Member Functions
AXOM_HOST_DEVICE axom::IndexType	size () const
	Return the size. More...
AXOM_HOST_DEVICE axom::IndexType	localToLocal (axom::IndexType index) const
	No-effect indexing transforms. More...
AXOM_HOST_DEVICE axom::IndexType	localToGlobal (axom::IndexType index) const
AXOM_HOST_DEVICE axom::IndexType	globalToLocal (axom::IndexType index) const
AXOM_HOST_DEVICE axom::IndexType	globalToGlobal (axom::IndexType index) const
AXOM_HOST_DEVICE bool	contains (axom::IndexType index) const
	Determines whether the indexing contains the supplied index. More...
AXOM_HOST_DEVICE axom::IndexType	clamp (axom::IndexType index) const
AXOM_HOST_DEVICE	BasicIndexing ()
AXOM_HOST_DEVICE	BasicIndexing (axom::IndexType size)

Public Attributes
axom::IndexType	m_size {0}

Detailed Description

A basic indexing class that provides methods for indexing transforms that have no effect. This is provided for topology view compatibility in algorithms that might use structured/unstructured topologies where index transforms are important.

Template Parameters

IndexT

The type used for indices.

Constructor & Destructor Documentation

BasicIndexing() [1/2]

AXOM_HOST_DEVICE axom::bump::views::BasicIndexing::BasicIndexing ( )

inline

Constructors

BasicIndexing() [2/2]

AXOM_HOST_DEVICE axom::bump::views::BasicIndexing::BasicIndexing ( axom::IndexType  size )

inline

Member Function Documentation

size()

AXOM_HOST_DEVICE axom::IndexType axom::bump::views::BasicIndexing::size ( ) const

inline

Return the size.

Returns

Returns the size.

References m_size.

localToLocal()

AXOM_HOST_DEVICE axom::IndexType axom::bump::views::BasicIndexing::localToLocal ( axom::IndexType  index ) const

inline

No-effect indexing transforms.

localToGlobal()

AXOM_HOST_DEVICE axom::IndexType axom::bump::views::BasicIndexing::localToGlobal ( axom::IndexType  index ) const

inline

globalToLocal()

AXOM_HOST_DEVICE axom::IndexType axom::bump::views::BasicIndexing::globalToLocal ( axom::IndexType  index ) const

inline

globalToGlobal()

AXOM_HOST_DEVICE axom::IndexType axom::bump::views::BasicIndexing::globalToGlobal ( axom::IndexType  index ) const

inline

contains()

AXOM_HOST_DEVICE bool axom::bump::views::BasicIndexing::contains ( axom::IndexType  index ) const

inline

Determines whether the indexing contains the supplied index.

Parameters

index

The index being tested.

Returns

True if the index is within the index, false otherwise.

References m_size.

clamp()

AXOM_HOST_DEVICE axom::IndexType axom::bump::views::BasicIndexing::clamp ( axom::IndexType  index ) const

inline

References axom::utilities::clampVal(), and m_size.

Member Data Documentation

m_size

axom::IndexType axom::bump::views::BasicIndexing::m_size {0}

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/bump/views/BasicIndexing.hpp