dune-grid 2.9.0
Public Types | Static Public Attributes | List of all members
Dune::IndexSetDefaultImplementation< GridImp, IndexSetImp > Class Template Reference

Provide default implementation of method if IndexSet. More...

#include <dune/grid/common/indexidset.hh>

Inheritance diagram for Dune::IndexSetDefaultImplementation< GridImp, IndexSetImp >:
Inheritance graph

Public Types

typedef Base::IndexType IndexType
 The type used for the indices. More...
 
typedef Base::Types Types
 

Public Member Functions

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
auto size (GeometryType type) const
 Return total number of entities of given geometry type in entity set $E$. More...
 
bool contains (const Entity &e) const
 Return true if the given entity is contained in $E$. More...
 

Static Public Attributes

static const int dimension = Base::dimension
 dimension of the grid (maximum allowed codimension) More...
 

Access to entity set

Types types (int codim) const
 
auto size (const int codim) const
 Return total number of entities of given codim in the entity set $E$. This is simply a sum over all geometry types. More...
 

Detailed Description

template<class GridImp, class IndexSetImp>
class Dune::IndexSetDefaultImplementation< GridImp, IndexSetImp >

Provide default implementation of method if IndexSet.

Member Typedef Documentation

◆ IndexType

template<class GridImp , class IndexSetImp >
typedef Base::IndexType Dune::IndexSetDefaultImplementation< GridImp, IndexSetImp >::IndexType

The type used for the indices.

◆ Types

template<class GridImp , class IndexSetImp >
typedef Base::Types Dune::IndexSetDefaultImplementation< GridImp, IndexSetImp >::Types

Member Function Documentation

◆ contains()

bool Dune::IndexSet< GridImp, IndexSetImp, IndexTypeImp, TypesImp >::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.

◆ index() [1/2]

IndexType Dune::IndexSet< GridImp, IndexSetImp, IndexTypeImp, TypesImp >::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/2]

IndexType Dune::IndexSet< GridImp, IndexSetImp, IndexTypeImp, TypesImp >::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.

◆ size() [1/2]

template<class GridImp , class IndexSetImp >
auto Dune::IndexSetDefaultImplementation< GridImp, IndexSetImp >::size ( const int  codim) const
inline

Return total number of entities of given codim in the entity set $E$. This is simply a sum over all geometry types.

Parameters
[in]codimA valid codimension
Returns
number of entities (type is auto determined by the implementation. std::size_t is the expected return type).

◆ size() [2/2]

auto Dune::IndexSet< GridImp, IndexSetImp, IndexTypeImp, TypesImp >::size ( GeometryType  type) const
inlineinherited

Return total number of entities of given geometry type in entity set $E$.

Parameters
[in]typeA valid geometry type.
Returns
number of entities (type is auto determined by the implementation. std::size_t is the expected return type).

◆ subIndex() [1/2]

IndexType Dune::IndexSet< GridImp, IndexSetImp, IndexTypeImp, TypesImp >::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/2]

IndexType Dune::IndexSet< GridImp, IndexSetImp, IndexTypeImp, TypesImp >::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.

◆ types()

template<class GridImp , class IndexSetImp >
Types Dune::IndexSetDefaultImplementation< GridImp, IndexSetImp >::types ( int  codim) const
inline

Member Data Documentation

◆ dimension

template<class GridImp , class IndexSetImp >
const int Dune::IndexSetDefaultImplementation< GridImp, IndexSetImp >::dimension = Base::dimension
static

dimension of the grid (maximum allowed codimension)


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