AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
Public Types | Public Member Functions | Static Public Member Functions | List of all members
axom::bump::views::VariableShape< ConnType > Struct Template Reference

This is a shape that can act as any of the other shapes. More...

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

Public Types

using ConnectivityStorage = axom::ArrayView< ConnType >
 
using ConnectivityStorageRef = ConnectivityStorage &
 
using ConnectivityStorageConstRef = const ConnectivityStorage &
 
using ConnectivityType = ConnType
 
using ConnectivityView = ConnectivityStorage
 

Public Member Functions

AXOM_HOST_DEVICE VariableShape (int shapeId, ConnectivityStorageConstRef ids)
 Constructor. More...
 
AXOM_HOST_DEVICE int id () const
 Returns the shape id of the actual shape represented by the variable shape. More...
 
AXOM_HOST_DEVICE IndexType dimension () const
 
AXOM_HOST_DEVICE IndexType numberOfNodes () const
 
AXOM_HOST_DEVICE IndexType numberOfNodesInFace (int faceIndex) const
 
AXOM_HOST_DEVICE IndexType numberOfFaces () const
 
AXOM_HOST_DEVICE void getFace (axom::IndexType faceIndex, ConnectivityType *ids, axom::IndexType &numIds) const
 
AXOM_HOST_DEVICE IndexType numberOfEdges () const
 
AXOM_HOST_DEVICE axom::StackArray< IndexType, 2 > getEdge (int edgeIndex) const
 
AXOM_HOST_DEVICE ConnectivityType getId (IndexType index) const
 Get a specific id that makes up this shape. More...
 
AXOM_HOST_DEVICE ConnectivityView getIds () const
 Get the ids that make 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...
 

Static Public Member Functions

constexpr static AXOM_HOST_DEVICE bool is_polyhedral ()
 
constexpr static AXOM_HOST_DEVICE bool is_variable_size ()
 
static constexpr AXOM_HOST_DEVICE IndexType maxNodesInFace ()
 
constexpr static AXOM_HOST_DEVICE const char * name ()
 

Detailed Description

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

This is a shape that can act as any of the other shapes.

Template Parameters
ConnTypetype of the connectivity values.
Note
This is a substitute for polymorphism so we can run on device.

Member Typedef Documentation

◆ ConnectivityStorage

template<typename ConnType >
using axom::bump::views::VariableShape< ConnType >::ConnectivityStorage = axom::ArrayView<ConnType>

◆ ConnectivityStorageRef

template<typename ConnType >
using axom::bump::views::VariableShape< ConnType >::ConnectivityStorageRef = ConnectivityStorage &

◆ ConnectivityStorageConstRef

template<typename ConnType >
using axom::bump::views::VariableShape< ConnType >::ConnectivityStorageConstRef = const ConnectivityStorage &

◆ ConnectivityType

template<typename ConnType >
using axom::bump::views::VariableShape< ConnType >::ConnectivityType = ConnType

◆ ConnectivityView

template<typename ConnType >
using axom::bump::views::VariableShape< ConnType >::ConnectivityView = ConnectivityStorage

Constructor & Destructor Documentation

◆ VariableShape()

template<typename ConnType >
AXOM_HOST_DEVICE axom::bump::views::VariableShape< ConnType >::VariableShape ( int  shapeId,
ConnectivityStorageConstRef  ids 
)
inline

Constructor.

Parameters
shapeIdThe shape id that describes the points.
idsThe ids that describe the shape.

References axom::bump::views::isValidShapeID(), and SLIC_ASSERT.

Member Function Documentation

◆ id()

template<typename ConnType >
AXOM_HOST_DEVICE int axom::bump::views::VariableShape< ConnType >::id ( ) const
inline

Returns the shape id of the actual shape represented by the variable shape.

Returns
The actual shape represented.

◆ is_polyhedral()

template<typename ConnType >
constexpr static AXOM_HOST_DEVICE bool axom::bump::views::VariableShape< ConnType >::is_polyhedral ( )
inlinestaticconstexpr

◆ is_variable_size()

template<typename ConnType >
constexpr static AXOM_HOST_DEVICE bool axom::bump::views::VariableShape< ConnType >::is_variable_size ( )
inlinestaticconstexpr

◆ dimension()

template<typename ConnType >
AXOM_HOST_DEVICE IndexType axom::bump::views::VariableShape< ConnType >::dimension ( ) const
inline

References axom::bump::views::shapeDimension().

◆ numberOfNodes()

template<typename ConnType >
AXOM_HOST_DEVICE IndexType axom::bump::views::VariableShape< ConnType >::numberOfNodes ( ) const
inline

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

◆ numberOfNodesInFace()

template<typename ConnType >
AXOM_HOST_DEVICE IndexType axom::bump::views::VariableShape< ConnType >::numberOfNodesInFace ( int  faceIndex) const
inline

References axom::bump::views::Hex_ShapeID, axom::bump::views::Line_ShapeID, axom::bump::views::PointTraits::numberOfNodesInFace(), axom::bump::views::LineTraits::numberOfNodesInFace(), axom::bump::views::TriTraits::numberOfNodesInFace(), axom::bump::views::QuadTraits::numberOfNodesInFace(), axom::bump::views::TetTraits::numberOfNodesInFace(), axom::bump::views::HexTraits::numberOfNodesInFace(), axom::bump::views::PyramidTraits::numberOfNodesInFace(), axom::bump::views::WedgeTraits::numberOfNodesInFace(), axom::bump::views::Point_ShapeID, axom::bump::views::Polygon_ShapeID, axom::bump::views::Pyramid_ShapeID, axom::bump::views::Quad_ShapeID, axom::ArrayView< T, DIM, SPACE >::size(), axom::bump::views::Tet_ShapeID, axom::bump::views::Tri_ShapeID, and axom::bump::views::Wedge_ShapeID.

◆ maxNodesInFace()

template<typename ConnType >
static constexpr AXOM_HOST_DEVICE IndexType axom::bump::views::VariableShape< ConnType >::maxNodesInFace ( )
inlinestaticconstexpr

References axom::utilities::max(), axom::bump::views::PointTraits::maxNodesInFace(), axom::bump::views::LineTraits::maxNodesInFace(), axom::bump::views::TriTraits::maxNodesInFace(), axom::bump::views::QuadTraits::maxNodesInFace(), axom::bump::views::TetTraits::maxNodesInFace(), axom::bump::views::PyramidTraits::maxNodesInFace(), axom::bump::views::WedgeTraits::maxNodesInFace(), axom::bump::views::HexTraits::maxNodesInFace(), and axom::bump::views::PolygonTraits::maxNodesInFace().

◆ numberOfFaces()

template<typename ConnType >
AXOM_HOST_DEVICE IndexType axom::bump::views::VariableShape< ConnType >::numberOfFaces ( ) const
inline

References axom::bump::views::Hex_ShapeID, axom::bump::views::Line_ShapeID, axom::bump::views::PointTraits::numberOfFaces(), axom::bump::views::LineTraits::numberOfFaces(), axom::bump::views::TriTraits::numberOfFaces(), axom::bump::views::QuadTraits::numberOfFaces(), axom::bump::views::TetTraits::numberOfFaces(), axom::bump::views::PyramidTraits::numberOfFaces(), axom::bump::views::WedgeTraits::numberOfFaces(), axom::bump::views::HexTraits::numberOfFaces(), axom::bump::views::Point_ShapeID, axom::bump::views::Polygon_ShapeID, axom::bump::views::Pyramid_ShapeID, axom::bump::views::Quad_ShapeID, axom::bump::views::Tet_ShapeID, axom::bump::views::Tri_ShapeID, and axom::bump::views::Wedge_ShapeID.

◆ getFace()

template<typename ConnType >
AXOM_HOST_DEVICE void axom::bump::views::VariableShape< ConnType >::getFace ( axom::IndexType  faceIndex,
ConnectivityType *  ids,
axom::IndexType &  numIds 
) const
inline

References axom::bump::views::TetTraits::getFace(), axom::bump::views::PyramidTraits::getFace(), axom::bump::views::WedgeTraits::getFace(), axom::bump::views::HexTraits::getFace(), axom::bump::views::Hex_ShapeID, axom::bump::views::Line_ShapeID, axom::bump::views::TetTraits::numberOfNodesInFace(), axom::bump::views::HexTraits::numberOfNodesInFace(), axom::bump::views::PyramidTraits::numberOfNodesInFace(), axom::bump::views::WedgeTraits::numberOfNodesInFace(), axom::bump::views::Point_ShapeID, axom::bump::views::Polygon_ShapeID, axom::bump::views::Pyramid_ShapeID, axom::bump::views::Quad_ShapeID, axom::ArrayView< T, DIM, SPACE >::size(), axom::bump::views::Tet_ShapeID, axom::bump::views::Tri_ShapeID, and axom::bump::views::Wedge_ShapeID.

◆ numberOfEdges()

template<typename ConnType >
AXOM_HOST_DEVICE IndexType axom::bump::views::VariableShape< ConnType >::numberOfEdges ( ) const
inline

References axom::bump::views::Hex_ShapeID, axom::bump::views::Line_ShapeID, axom::bump::views::PointTraits::numberOfEdges(), axom::bump::views::LineTraits::numberOfEdges(), axom::bump::views::TriTraits::numberOfEdges(), axom::bump::views::QuadTraits::numberOfEdges(), axom::bump::views::TetTraits::numberOfEdges(), axom::bump::views::PyramidTraits::numberOfEdges(), axom::bump::views::WedgeTraits::numberOfEdges(), axom::bump::views::HexTraits::numberOfEdges(), axom::bump::views::Point_ShapeID, axom::bump::views::Polygon_ShapeID, axom::bump::views::Pyramid_ShapeID, axom::bump::views::Quad_ShapeID, axom::ArrayView< T, DIM, SPACE >::size(), axom::bump::views::Tet_ShapeID, axom::bump::views::Tri_ShapeID, and axom::bump::views::Wedge_ShapeID.

◆ getEdge()

template<typename ConnType >
AXOM_HOST_DEVICE axom::StackArray<IndexType, 2> axom::bump::views::VariableShape< ConnType >::getEdge ( int  edgeIndex) const
inline

References axom::bump::views::PointTraits::getEdge(), axom::bump::views::TriTraits::getEdge(), axom::bump::views::QuadTraits::getEdge(), axom::bump::views::TetTraits::getEdge(), axom::bump::views::PyramidTraits::getEdge(), axom::bump::views::WedgeTraits::getEdge(), axom::bump::views::HexTraits::getEdge(), axom::bump::views::LineTraits::getEdge(), axom::bump::views::Hex_ShapeID, axom::bump::views::Line_ShapeID, axom::bump::views::Point_ShapeID, axom::bump::views::Polygon_ShapeID, axom::bump::views::Pyramid_ShapeID, axom::bump::views::Quad_ShapeID, axom::ArrayView< T, DIM, SPACE >::size(), axom::bump::views::Tet_ShapeID, axom::bump::views::Tri_ShapeID, and axom::bump::views::Wedge_ShapeID.

◆ getId()

template<typename ConnType >
AXOM_HOST_DEVICE ConnectivityType axom::bump::views::VariableShape< ConnType >::getId ( IndexType  index) const
inline

Get a specific id that makes up this shape.

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

◆ getIds()

template<typename ConnType >
AXOM_HOST_DEVICE ConnectivityView axom::bump::views::VariableShape< ConnType >::getIds ( ) const
inline

Get the ids that make up this shape.

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

◆ name()

template<typename ConnType >
constexpr static AXOM_HOST_DEVICE const char* axom::bump::views::VariableShape< ConnType >::name ( )
inlinestaticconstexpr

◆ getIdsStorage() [1/2]

template<typename ConnType >
AXOM_HOST_DEVICE ConnectivityStorageRef axom::bump::views::VariableShape< 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::VariableShape< 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.
The documentation for this struct was generated from the following file: