waveblocks::wavepackets::shapes::ShapeEnumerator< D, MultiIndex > Class Template Reference

Enumerates nodes of a basis shape. More...

#include <shape_enumerator.hpp>

Public Member Functions
template<class Shape >
ShapeEnum< D, MultiIndex >	generate (const Shape &shape) const
std::shared_ptr< ShapeEnum< D, MultiIndex > >	enumerate (AbstractShape< D > const &shape) const
	Enumerates all nodes of a basis shape described by AbstractShape. More...
std::shared_ptr< ShapeEnum< D, MultiIndex > >	enumerate (AbstractShape< D > const *shape) const
	Enumerates all nodes of basis shape described by AbstractShape. More...

Detailed Description

template<dim_t D, class MultiIndex>
class waveblocks::wavepackets::shapes::ShapeEnumerator< D, MultiIndex >

Enumerates nodes of a basis shape.

This basis shape enumerator takes shape description of the form AbstractShape and converts the information to a ShapeEnum.

Template Parameters

D	The basis shape dimensionality.
MultiIndex	The type to represent a multi-index. TinyMultiIndex is a valid type.

Member Function Documentation

template<dim_t D, class MultiIndex >

std::shared_ptr<ShapeEnum<D,MultiIndex> > waveblocks::wavepackets::shapes::ShapeEnumerator< D, MultiIndex >::enumerate ( AbstractShape< D > const &  shape ) const

inline

Enumerates all nodes of a basis shape described by AbstractShape.

Parameters

shape

A reference to the basis shape description.

Returns

A shared pointer to the enumerated shape.

template<dim_t D, class MultiIndex >

std::shared_ptr<ShapeEnum<D,MultiIndex> > waveblocks::wavepackets::shapes::ShapeEnumerator< D, MultiIndex >::enumerate ( AbstractShape< D > const *  shape ) const

inline

Enumerates all nodes of basis shape described by AbstractShape.

Parameters

shape

A pointer to the basis shape description.

Returns

A shared pointer to the enumerated shape.

template<dim_t D, class MultiIndex >

template<class Shape >

ShapeEnum<D,MultiIndex> waveblocks::wavepackets::shapes::ShapeEnumerator< D, MultiIndex >::generate ( const Shape &  shape ) const

inline

---

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

• /userdata/raoulb/LWB/libwaveblocks/waveblocks/wavepackets/shapes/shape_enumerator.hpp