dune-grid 2.10
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Attributes | List of all members
Dune::AlbertaGridIndexSet< dim, dimworld > Class Template Reference

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

Inheritance diagram for Dune::AlbertaGridIndexSet< dim, dimworld >:
Inheritance graph

Public Types

typedef AlbertaGrid< dim, dimworld > Grid
 
typedef Base::IndexType IndexType
 
typedef Base::Types Types
 
typedef Alberta::ElementInfo< dimension > ElementInfo
 
typedef Alberta::HierarchyDofNumbering< dimension > DofNumbering
 

Public Member Functions

 AlbertaGridIndexSet (const DofNumbering &dofNumbering)
 
 ~AlbertaGridIndexSet ()
 
template<class Entity >
bool contains (const Entity &entity) const
 
template<int cc>
IndexType index (const typename Traits::template Codim< cc >::Entity &entity) const
 return hierarchic index of given entity
 
template<int cc>
IndexType subIndex (const typename Traits::template Codim< cc >::Entity &entity, int i, unsigned int codim) const
 return subIndex of given enitiy's sub entity
 
std::size_t size (const GeometryType &type) const
 
std::size_t size (int codim) const
 
Types types (int codim) const
 
template<class Iterator >
void update (const Iterator &begin, const Iterator &end)
 
Index access from 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.
 
IndexType subIndex (const Entity &e, int i, unsigned int codim) const
 Map a subentity to an index.
 
Access to entity set
auto size (GeometryType type) const
 Return total number of entities of given geometry type in entity set $E$.
 

Static Public Attributes

static const int dimension = Grid::dimension
 

Member Typedef Documentation

◆ DofNumbering

template<int dim, int dimworld>
typedef Alberta::HierarchyDofNumbering< dimension > Dune::AlbertaGridIndexSet< dim, dimworld >::DofNumbering

◆ ElementInfo

template<int dim, int dimworld>
typedef Alberta::ElementInfo< dimension > Dune::AlbertaGridIndexSet< dim, dimworld >::ElementInfo

◆ Grid

template<int dim, int dimworld>
typedef AlbertaGrid< dim, dimworld > Dune::AlbertaGridIndexSet< dim, dimworld >::Grid

◆ IndexType

template<int dim, int dimworld>
typedef Base::IndexType Dune::AlbertaGridIndexSet< dim, dimworld >::IndexType

◆ Types

template<int dim, int dimworld>
typedef Base::Types Dune::AlbertaGridIndexSet< dim, dimworld >::Types

Constructor & Destructor Documentation

◆ AlbertaGridIndexSet()

template<int dim, int dimworld>
Dune::AlbertaGridIndexSet< dim, dimworld >::AlbertaGridIndexSet ( const DofNumbering &  dofNumbering)
inlineexplicit

◆ ~AlbertaGridIndexSet()

template<int dim, int dimworld>
Dune::AlbertaGridIndexSet< dim, dimworld >::~AlbertaGridIndexSet ( )
inline

Member Function Documentation

◆ contains()

template<int dim, int dimworld>
template<class Entity >
bool Dune::AlbertaGridIndexSet< dim, dimworld >::contains ( const Entity &  entity) const
inline

◆ index() [1/2]

IndexType Dune::IndexSet< AlbertaGrid< dim, dimworld > , AlbertaGridIndexSet< dim, dimworld > , int , std::array< GeometryType, 1 > >::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]

template<int dim, int dimworld>
template<int cc>
IndexType Dune::AlbertaGridIndexSet< dim, dimworld >::index ( const typename Traits::template Codim< cc >::Entity &  entity) const
inline

return hierarchic index of given entity

◆ size() [1/3]

template<int dim, int dimworld>
std::size_t Dune::AlbertaGridIndexSet< dim, dimworld >::size ( const GeometryType &  type) const
inline

◆ size() [2/3]

auto Dune::IndexSet< AlbertaGrid< dim, dimworld > , AlbertaGridIndexSet< dim, dimworld > , int , std::array< GeometryType, 1 > >::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).

◆ size() [3/3]

template<int dim, int dimworld>
std::size_t Dune::AlbertaGridIndexSet< dim, dimworld >::size ( int  codim) const
inline

◆ subIndex() [1/2]

IndexType Dune::IndexSet< AlbertaGrid< dim, dimworld > , AlbertaGridIndexSet< dim, dimworld > , int , std::array< GeometryType, 1 > >::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]

template<int dim, int dimworld>
template<int cc>
IndexType Dune::AlbertaGridIndexSet< dim, dimworld >::subIndex ( const typename Traits::template Codim< cc >::Entity &  entity,
int  i,
unsigned int  codim 
) const
inline

return subIndex of given enitiy's sub entity

◆ types()

template<int dim, int dimworld>
Types Dune::AlbertaGridIndexSet< dim, dimworld >::types ( int  codim) const
inline

◆ update()

template<int dim, int dimworld>
template<class Iterator >
void Dune::AlbertaGridIndexSet< dim, dimworld >::update ( const Iterator &  begin,
const Iterator &  end 
)
inline

Member Data Documentation

◆ dimension

template<int dim, int dimworld>
const int Dune::AlbertaGridIndexSet< dim, dimworld >::dimension = Grid::dimension
static
The documentation for this class was generated from the following files:
Generated by doxygen 1.9.8