dune-fem  2.4.1-rc
Classes | Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
Dune::Fem::IndexSet< Traits > Class Template Reference

interface documentation for (grid part) index sets More...

#include </local/tomalk/somewhere/tmp/dune-fem/dune/fem/gridpart/common/indexset.hh>

Inheritance diagram for Dune::Fem::IndexSet< Traits >:
Inheritance graph

Classes

struct  Codim
 

Public Types

typedef Traits::IndexType IndexType
 index type More...
 
typedef Traits::Types Types
 geometry type range type More...
 

Public Member Functions

Types types (int codim) const
 return range of geometry types More...
 
const std::vector< GeometryType > & geomTypes (int codim) const
 return vector of geometry types used of given codimension More...
 
template<class Entity >
bool contains (const Entity &entity) const
 return true if entity has index More...
 
IndexType size (GeometryType type) const
 return number of entities of given type More...
 
IndexType size (int codim) const
 return number of entities of given codimension More...
 
template<class Entity >
IndexType index (const Entity &entity) const
 return index for given entity More...
 
template<int codim>
IndexType index (const typename Codim< codim >::Entity &entity) const
 return index for given entity More...
 
template<class Entity >
IndexType subIndex (const Entity &entity, int i, unsigned int cd) const
 return index for given subentity More...
 
template<int codim>
IndexType subIndex (const typename Codim< codim >::Entity &entity, int i, unsigned int cd) const
 return index for given subentity More...
 

Static Public Attributes

static const int dimension = Traits::dimension
 grid dimension More...
 

Protected Member Functions

 IndexSet ()=default
 
const Traits::IndexSetType & impl () const
 

Detailed Description

template<class Traits>
class Dune::Fem::IndexSet< Traits >

interface documentation for (grid part) index sets

Note
This interface is a direct copy of index sets as used in dune-grid.

Member Typedef Documentation

template<class Traits>
typedef Traits::IndexType Dune::Fem::IndexSet< Traits >::IndexType

index type

template<class Traits>
typedef Traits::Types Dune::Fem::IndexSet< Traits >::Types

geometry type range type

Constructor & Destructor Documentation

template<class Traits>
Dune::Fem::IndexSet< Traits >::IndexSet ( )
protecteddefault

Member Function Documentation

template<class Traits>
template<class Entity >
bool Dune::Fem::IndexSet< Traits >::contains ( const Entity &  entity) const
inline
template<class Traits>
const std::vector< GeometryType >& Dune::Fem::IndexSet< Traits >::geomTypes ( int  codim) const
inline

return vector of geometry types used of given codimension

Deprecated:
"IndexSet::geomTypes(codim) is deprecated, use IndexSet::types(codim) instead"
template<class Traits>
const Traits::IndexSetType& Dune::Fem::IndexSet< Traits >::impl ( ) const
inlineprotected
template<class Traits>
template<class Entity >
IndexType Dune::Fem::IndexSet< Traits >::index ( const Entity &  entity) const
inline
template<class Traits>
template<int codim>
IndexType Dune::Fem::IndexSet< Traits >::index ( const typename Codim< codim >::Entity &  entity) const
inline

return index for given entity

template<class Traits>
IndexType Dune::Fem::IndexSet< Traits >::size ( GeometryType  type) const
inline

return number of entities of given type

template<class Traits>
IndexType Dune::Fem::IndexSet< Traits >::size ( int  codim) const
inline

return number of entities of given codimension

template<class Traits>
template<class Entity >
IndexType Dune::Fem::IndexSet< Traits >::subIndex ( const Entity &  entity,
int  i,
unsigned int  cd 
) const
inline

return index for given subentity

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

return index for given subentity

template<class Traits>
Types Dune::Fem::IndexSet< Traits >::types ( int  codim) const
inline

return range of geometry types

Member Data Documentation

template<class Traits>
const int Dune::Fem::IndexSet< Traits >::dimension = Traits::dimension
static

grid dimension


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