version 3.8
Dumux::EntityMap< GridView, codim > Class Template Reference

A map from indices to entities using grid entity seeds.

#include <dumux/common/entitymap.hh>

Public Types

using Grid = typename GridView::Traits::Grid
 
using Entity = typename Grid::template Codim< codim >::Entity
 
using EntitySeed = typename Grid::template Codim< codim >::EntitySeed
 

Public Member Functions

 EntityMap (const Grid &grid, std::vector< EntitySeed > &&seeds)
 constructor moving a ready seed list in here More...
 
template<class Mapper >
 EntityMap (const Grid &grid, const Mapper &mapper)
 constructor with all entities of codim More...
 
void update (std::vector< EntitySeed > &&seeds)
 update the map after the grid changed More...
 
template<class Mapper >
void update (const Mapper &mapper)
 update the map after the grid changed More...
 
Entity operator[] (std::size_t i) const
 get an element from an index i More...
 
std::size_t size () const
 get the size of the map More...
 

Member Typedef Documentation

◆ Entity

template<class GridView , int codim = 0>
using Dumux::EntityMap< GridView, codim >::Entity = typename Grid::template Codim<codim>::Entity

◆ EntitySeed

template<class GridView , int codim = 0>
using Dumux::EntityMap< GridView, codim >::EntitySeed = typename Grid::template Codim<codim>::EntitySeed

◆ Grid

template<class GridView , int codim = 0>
using Dumux::EntityMap< GridView, codim >::Grid = typename GridView::Traits::Grid

Constructor & Destructor Documentation

◆ EntityMap() [1/2]

template<class GridView , int codim = 0>
Dumux::EntityMap< GridView, codim >::EntityMap ( const Grid grid,
std::vector< EntitySeed > &&  seeds 
)
inline

◆ EntityMap() [2/2]

template<class GridView , int codim = 0>
template<class Mapper >
Dumux::EntityMap< GridView, codim >::EntityMap ( const Grid grid,
const Mapper &  mapper 
)
inline

Member Function Documentation

◆ operator[]()

template<class GridView , int codim = 0>
Entity Dumux::EntityMap< GridView, codim >::operator[] ( std::size_t  i) const
inline

◆ size()

template<class GridView , int codim = 0>
std::size_t Dumux::EntityMap< GridView, codim >::size ( ) const
inline

◆ update() [1/2]

template<class GridView , int codim = 0>
template<class Mapper >
void Dumux::EntityMap< GridView, codim >::update ( const Mapper &  mapper)
inline

◆ update() [2/2]

template<class GridView , int codim = 0>
void Dumux::EntityMap< GridView, codim >::update ( std::vector< EntitySeed > &&  seeds)
inline

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