dune-grid 2.9.0
Public Types | Public Member Functions | Static Public Attributes | List of all members
Dune::GeoGrid::IndexSet< Grid, HostIndexSet > Class Template Reference

#include <dune/grid/geometrygrid/indexsets.hh>

Inheritance diagram for Dune::GeoGrid::IndexSet< Grid, HostIndexSet >:
Inheritance graph

Public Types

typedef Base::IndexType IndexType
 
typedef Base::Types Types
 

Public Member Functions

 IndexSet ()=default
 
 IndexSet (const HostIndexSet &hostIndexSet)
 
 IndexSet (const This &)=delete
 
 IndexSet (This &&)=delete
 
IndexSetoperator= (const This &)=delete
 
IndexSetoperator= (This &&)=delete
 
template<int cc>
IndexType index (const typename Traits::template Codim< cc >::Entity &entity) const
 
template<int cc>
IndexType subIndex (const typename Traits::template Codim< cc >::Entity &entity, int i, unsigned int codim) const
 
std::size_t size (GeometryType type) const
 
std::size_t size (int codim) const
 
template<class Entity >
bool contains (const Entity &entity) const
 
Types types (int codim) const
 
const std::vector< GeometryType > & geomTypes (int codim) const
 
 operator bool () const
 
void reset ()
 
void reset (const HostIndexSet &hostIndexSet)
 
template<int cc>
IndexType index (const typename Traits::template Codim< cc >::Entity &e) const
 Map entity to index. The result of calling this method with an entity that is not in the index set is undefined. More...
 
template<class Entity >
IndexType index (const Entity &e) const
 Map entity to index. Easier to use than the above because codimension template parameter need not be supplied explicitly. The result of calling this method with an entity that is not in the index set is undefined. More...
 
template<int cc>
IndexType subIndex (const typename Traits::template Codim< cc >::Entity &e, int i, unsigned int codim) const
 Map a subentity to an index. More...
 
template<class Entity >
IndexType subIndex (const Entity &e, int i, unsigned int codim) const
 Map a subentity to an index. More...
 
Index access from entity
IndexType index (const typename Traits::template Codim< cc >::Entity &e) const
 Map entity to index. The result of calling this method with an entity that is not in the index set is undefined. More...
 
IndexType index (const Entity &e) const
 Map entity to index. Easier to use than the above because codimension template parameter need not be supplied explicitly. The result of calling this method with an entity that is not in the index set is undefined. More...
 
IndexType subIndex (const typename Traits::template Codim< cc >::Entity &e, int i, unsigned int codim) const
 Map a subentity to an index. More...
 
IndexType subIndex (const Entity &e, int i, unsigned int codim) const
 Map a subentity to an index. More...
 
Access to entity set
bool contains (const Entity &e) const
 Return true if the given entity is contained in $E$. More...
 

Static Public Attributes

static const int dimension = Traits::dimension
 

Member Typedef Documentation

◆ IndexType

template<class Grid , class HostIndexSet >
typedef Base::IndexType Dune::GeoGrid::IndexSet< Grid, HostIndexSet >::IndexType

◆ Types

template<class Grid , class HostIndexSet >
typedef Base::Types Dune::GeoGrid::IndexSet< Grid, HostIndexSet >::Types

Constructor & Destructor Documentation

◆ IndexSet() [1/4]

template<class Grid , class HostIndexSet >
Dune::GeoGrid::IndexSet< Grid, HostIndexSet >::IndexSet ( )
default

◆ IndexSet() [2/4]

template<class Grid , class HostIndexSet >
Dune::GeoGrid::IndexSet< Grid, HostIndexSet >::IndexSet ( const HostIndexSet< Grid, HostIndexSet > &  hostIndexSet)
inlineexplicit

◆ IndexSet() [3/4]

template<class Grid , class HostIndexSet >
Dune::GeoGrid::IndexSet< Grid, HostIndexSet >::IndexSet ( const This )
delete

◆ IndexSet() [4/4]

template<class Grid , class HostIndexSet >
Dune::GeoGrid::IndexSet< Grid, HostIndexSet >::IndexSet ( This &&  )
delete

Member Function Documentation

◆ contains() [1/2]

bool Dune::IndexSet< Grid , IndexSet< Grid, HostIndexSet > , HostIndexSet::IndexType , HostIndexSet::Types >::contains ( const Entity e) const
inlineinherited

Return true if the given entity is contained in $E$.

Note
If the input element e is not an element of the grid, then the result of contains() is undefined.

◆ contains() [2/2]

template<class Grid , class HostIndexSet >
template<class Entity >
bool Dune::GeoGrid::IndexSet< Grid, HostIndexSet >::contains ( const Entity entity) const
inline

◆ geomTypes()

template<class Grid , class HostIndexSet >
const std::vector< GeometryType > & Dune::GeoGrid::IndexSet< Grid, HostIndexSet >::geomTypes ( int  codim) const
inline

◆ index() [1/5]

IndexType Dune::IndexSet< Grid , IndexSet< Grid, HostIndexSet > , HostIndexSet::IndexType , HostIndexSet::Types >::index ( const Entity e) const
inlineinherited

Map entity to index. Easier to use than the above because codimension template parameter need not be supplied explicitly. The result of calling this method with an entity that is not in the index set is undefined.

Parameters
eReference to codim cc entity. Since entity knows its codimension, automatic extraction is possible.
Returns
An index in the range 0 ... Max number of entities in set - 1.

◆ index() [2/5]

template<class Grid , class HostIndexSet >
template<class Entity >
IndexType Dune::IndexSet< GridImp, IndexSetImp, IndexTypeImp, TypesImp >::index ( const Entity e) const
inline

Map entity to index. Easier to use than the above because codimension template parameter need not be supplied explicitly. The result of calling this method with an entity that is not in the index set is undefined.

Parameters
eReference to codim cc entity. Since entity knows its codimension, automatic extraction is possible.
Returns
An index in the range 0 ... Max number of entities in set - 1.

◆ index() [3/5]

IndexType Dune::IndexSet< Grid , IndexSet< Grid, HostIndexSet > , HostIndexSet::IndexType , HostIndexSet::Types >::index ( const typename Traits::template Codim< cc >::Entity &  e) const
inlineinherited

Map entity to index. The result of calling this method with an entity that is not in the index set is undefined.

Parameters
eReference to codim cc entity, where cc is the template parameter of the function.
Returns
An index in the range 0 ... Max number of entities in set - 1.

◆ index() [4/5]

template<class Grid , class HostIndexSet >
template<int cc>
IndexType Dune::IndexSet< GridImp, IndexSetImp, IndexTypeImp, TypesImp >::index ( const typename Traits::template Codim< cc >::Entity &  e) const
inline

Map entity to index. The result of calling this method with an entity that is not in the index set is undefined.

Parameters
eReference to codim cc entity, where cc is the template parameter of the function.
Returns
An index in the range 0 ... Max number of entities in set - 1.

◆ index() [5/5]

template<class Grid , class HostIndexSet >
template<int cc>
IndexType Dune::GeoGrid::IndexSet< Grid, HostIndexSet >::index ( const typename Traits::template Codim< cc >::Entity &  entity) const
inline

◆ operator bool()

template<class Grid , class HostIndexSet >
Dune::GeoGrid::IndexSet< Grid, HostIndexSet >::operator bool ( ) const
inlineexplicit

◆ operator=() [1/2]

template<class Grid , class HostIndexSet >
IndexSet & Dune::GeoGrid::IndexSet< Grid, HostIndexSet >::operator= ( const This )
delete

◆ operator=() [2/2]

template<class Grid , class HostIndexSet >
IndexSet & Dune::GeoGrid::IndexSet< Grid, HostIndexSet >::operator= ( This &&  )
delete

◆ reset() [1/2]

template<class Grid , class HostIndexSet >
void Dune::GeoGrid::IndexSet< Grid, HostIndexSet >::reset ( )
inline

◆ reset() [2/2]

template<class Grid , class HostIndexSet >
void Dune::GeoGrid::IndexSet< Grid, HostIndexSet >::reset ( const HostIndexSet< Grid, HostIndexSet > &  hostIndexSet)
inline

◆ size() [1/2]

template<class Grid , class HostIndexSet >
std::size_t Dune::GeoGrid::IndexSet< Grid, HostIndexSet >::size ( GeometryType  type) const
inline

◆ size() [2/2]

template<class Grid , class HostIndexSet >
std::size_t Dune::GeoGrid::IndexSet< Grid, HostIndexSet >::size ( int  codim) const
inline

◆ subIndex() [1/5]

IndexType Dune::IndexSet< Grid , IndexSet< Grid, HostIndexSet > , HostIndexSet::IndexType , HostIndexSet::Types >::subIndex ( const Entity e,
int  i,
unsigned int  codim 
) const
inlineinherited

Map a subentity to an index.

The result of calling this method with an entity that is not in the index set is undefined.

Note
This method exists for convenience only. It extracts the codimension from the type of the entity, which can be guessed by the compiler.
Template Parameters
Entitytype of entity (must be GridImp::Codim< cc >::Entity for some cc)
Parameters
[in]ereference to entity
[in]inumber subentity of e within the codimension
[in]codimcodimension of the subentity we're interested in
Note
The parameter codim denotes the codimension with respect to the grid, i.e., it must satisfy cc <= codim <= dimension.
Returns
An index in the range 0 ... Max number of entities in set - 1.

◆ subIndex() [2/5]

template<class Grid , class HostIndexSet >
template<class Entity >
IndexType Dune::IndexSet< GridImp, IndexSetImp, IndexTypeImp, TypesImp >::subIndex ( const Entity e,
int  i,
unsigned int  codim 
) const
inline

Map a subentity to an index.

The result of calling this method with an entity that is not in the index set is undefined.

Note
This method exists for convenience only. It extracts the codimension from the type of the entity, which can be guessed by the compiler.
Template Parameters
Entitytype of entity (must be GridImp::Codim< cc >::Entity for some cc)
Parameters
[in]ereference to entity
[in]inumber subentity of e within the codimension
[in]codimcodimension of the subentity we're interested in
Note
The parameter codim denotes the codimension with respect to the grid, i.e., it must satisfy cc <= codim <= dimension.
Returns
An index in the range 0 ... Max number of entities in set - 1.

◆ subIndex() [3/5]

IndexType Dune::IndexSet< Grid , IndexSet< Grid, HostIndexSet > , HostIndexSet::IndexType , HostIndexSet::Types >::subIndex ( const typename Traits::template Codim< cc >::Entity &  e,
int  i,
unsigned int  codim 
) const
inlineinherited

Map a subentity to an index.

The result of calling this method with an entity that is not in the index set is undefined.

Template Parameters
cccodimension of the entity
Parameters
[in]ereference to codimension cc entity
[in]inumber subentity of e within the codimension
[in]codimcodimension of the subentity we're interested in
Note
The parameter codim denotes the codimension with respect to the grid, i.e., it must satisfy cc <= codim <= dimension.
Returns
An index in the range 0 ... Max number of entities in set - 1.

◆ subIndex() [4/5]

template<class Grid , class HostIndexSet >
template<int cc>
IndexType Dune::IndexSet< GridImp, IndexSetImp, IndexTypeImp, TypesImp >::subIndex ( const typename Traits::template Codim< cc >::Entity &  e,
int  i,
unsigned int  codim 
) const
inline

Map a subentity to an index.

The result of calling this method with an entity that is not in the index set is undefined.

Template Parameters
cccodimension of the entity
Parameters
[in]ereference to codimension cc entity
[in]inumber subentity of e within the codimension
[in]codimcodimension of the subentity we're interested in
Note
The parameter codim denotes the codimension with respect to the grid, i.e., it must satisfy cc <= codim <= dimension.
Returns
An index in the range 0 ... Max number of entities in set - 1.

◆ subIndex() [5/5]

template<class Grid , class HostIndexSet >
template<int cc>
IndexType Dune::GeoGrid::IndexSet< Grid, HostIndexSet >::subIndex ( const typename Traits::template Codim< cc >::Entity &  entity,
int  i,
unsigned int  codim 
) const
inline

◆ types()

template<class Grid , class HostIndexSet >
Types Dune::GeoGrid::IndexSet< Grid, HostIndexSet >::types ( int  codim) const
inline

Member Data Documentation

◆ dimension

template<class Grid , class HostIndexSet >
const int Dune::GeoGrid::IndexSet< Grid, HostIndexSet >::dimension = Traits::dimension
static

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