dune-grid 2.9.0
Classes | Public Types | Public Member Functions | Static Public Attributes | List of all members
Dune::YGridList< Coordinates > Class Template Reference

implements a collection of multiple std::deque<Intersection> Intersections with neighboring processors are stored as std::deque<Intersection>. Eachsuch intersection only holds one YGridComponent. To do all communication associated with one codimension, multiple such deques have to be concatenated. YGridList manges this concatenation. As for YGrids, YGridList doesn't hold any data, but an iterator range into a data array owned by YGridLevel. More...

#include <dune/grid/yaspgrid/ygrid.hh>

Classes

struct  Intersection
 type describing an intersection with a neighboring processor More...
 
class  Iterator
 

Public Types

typedef std::array< std::deque< Intersection >, Dune::power(2, dim)>::iterator DAI
 

Public Member Functions

Iterator begin () const
 return iterator pointing to the begin of the container More...
 
Iterator end () const
 return iterator pointing to the end of the container More...
 
void setBegin (typename std::array< std::deque< Intersection >, Dune::power(2, dim)>::iterator begin)
 set start iterator in the data array More...
 
DAI dataBegin () const
 get start iterator in the data array More...
 
DAI dataEnd () const
 get end iterator in the data array More...
 
int size () const
 return the size of the container, this is the sum of the sizes of all deques More...
 
void finalize (DAI end, const YGrid< Coordinates > &ygrid)
 finalize the YGridLIst More...
 

Static Public Attributes

static const int dim = Coordinates::dimension
 

Detailed Description

template<class Coordinates>
class Dune::YGridList< Coordinates >

implements a collection of multiple std::deque<Intersection> Intersections with neighboring processors are stored as std::deque<Intersection>. Eachsuch intersection only holds one YGridComponent. To do all communication associated with one codimension, multiple such deques have to be concatenated. YGridList manges this concatenation. As for YGrids, YGridList doesn't hold any data, but an iterator range into a data array owned by YGridLevel.

Member Typedef Documentation

◆ DAI

template<class Coordinates >
typedef std::array<std::deque<Intersection>,Dune::power(2,dim)>::iterator Dune::YGridList< Coordinates >::DAI

Member Function Documentation

◆ begin()

template<class Coordinates >
Iterator Dune::YGridList< Coordinates >::begin ( ) const
inline

return iterator pointing to the begin of the container

◆ dataBegin()

template<class Coordinates >
DAI Dune::YGridList< Coordinates >::dataBegin ( ) const
inline

get start iterator in the data array

◆ dataEnd()

template<class Coordinates >
DAI Dune::YGridList< Coordinates >::dataEnd ( ) const
inline

get end iterator in the data array

◆ end()

template<class Coordinates >
Iterator Dune::YGridList< Coordinates >::end ( ) const
inline

return iterator pointing to the end of the container

◆ finalize()

template<class Coordinates >
void Dune::YGridList< Coordinates >::finalize ( DAI  end,
const YGrid< Coordinates > &  ygrid 
)
inline

finalize the YGridLIst

set offsets allow the YGridComponents in the Intersctions to behave as YGrids

◆ setBegin()

template<class Coordinates >
void Dune::YGridList< Coordinates >::setBegin ( typename std::array< std::deque< Intersection >, Dune::power(2, dim)>::iterator  begin)
inline

set start iterator in the data array

◆ size()

template<class Coordinates >
int Dune::YGridList< Coordinates >::size ( ) const
inline

return the size of the container, this is the sum of the sizes of all deques

Member Data Documentation

◆ dim

template<class Coordinates >
const int Dune::YGridList< Coordinates >::dim = Coordinates::dimension
static

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