dune-fem 2.8.0
Loading...
Searching...
No Matches
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 <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
 
typedef Traits::Types Types
 geometry type range type
 

Public Member Functions

Types types (int codim) const
 return range of geometry types
 
template<class Entity >
bool contains (const Entity &entity) const
 return true if entity has index
 
IndexType size (GeometryType type) const
 return number of entities of given type
 
IndexType size (int codim) const
 return number of entities of given codimension
 
template<class Entity >
IndexType index (const Entity &entity) const
 return index for given entity
 
template<int codim>
IndexType index (const typename Codim< codim >::Entity &entity) const
 return index for given entity
 
template<class Entity >
IndexType subIndex (const Entity &entity, int i, unsigned int cd) const
 return index for given subentity
 
template<int codim>
IndexType subIndex (const typename Codim< codim >::Entity &entity, int i, unsigned int cd) const
 return index for given subentity
 
void requestCodimensions (const std::vector< int > &codimensions) const
 receive request for codimension support in case index set is adaptive
 

Static Public Attributes

static const int dimension = Traits::dimension
 grid dimension
 

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

◆ IndexType

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

index type

◆ Types

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

geometry type range type

Constructor & Destructor Documentation

◆ IndexSet()

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

Member Function Documentation

◆ contains()

template<class Traits >
template<class Entity >
bool Dune::Fem::IndexSet< Traits >::contains ( const Entity &  entity) const
inline

return true if entity has index

◆ impl()

template<class Traits >
const Traits::IndexSetType & Dune::Fem::IndexSet< Traits >::impl ( ) const
inlineprotected

◆ index() [1/2]

template<class Traits >
template<class Entity >
IndexType Dune::Fem::IndexSet< Traits >::index ( const Entity &  entity) const
inline

return index for given entity

◆ index() [2/2]

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

◆ requestCodimensions()

template<class Traits >
void Dune::Fem::IndexSet< Traits >::requestCodimensions ( const std::vector< int > &  codimensions) const
inline

receive request for codimension support in case index set is adaptive

◆ size() [1/2]

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

return number of entities of given type

◆ size() [2/2]

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

return number of entities of given codimension

◆ subIndex() [1/2]

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

◆ subIndex() [2/2]

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

◆ types()

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

return range of geometry types

Member Data Documentation

◆ dimension

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: