Dune::YGrid< Coordinates > Class Template Reference

implements a collection of YGridComponents which form a codimension Entities of given codimension c need to be represented by d choose c YgridComponents. All entities in one such component share the same set of spanning unit vectors. A YGrid is used to iterate over the entire set of components the codimension consists of. It doesn't hold any data, but instead holds an iterator range into an array of components (which is owned by YGridLevel). More...

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

Classes
class	Iterator
	Iterator over a collection o YGrids A YGrid::Iterator is the heart of an entity in YaspGrid. More...

Public Types
typedef YGridComponent< Coordinates > *	DAI
typedef std::array< int, dim >	iTupel

Public Member Functions
void	setBegin (DAI begin)
	set start iterator in the data array More...
int	shiftmapping (const std::bitset< dim > &shift) const
	get which component belongs to a given shift vector More...
DAI	dataBegin () const
	get start iterator in the data array More...
DAI	dataEnd () const
	get end iterator in the data array More...
bool	inside (const iTupel &coord, const std::bitset< dim > &shift=std::bitset< dim >()) const
	decide whether a coordinate is in the grid (depending on the component) More...
Iterator	begin () const
	return begin iterator for the codimension and partition the ygrid represents More...
Iterator	begin (const std::array< int, dim > &coord, int which=0) const
	return iterator pointint to a specified position More...
Iterator	end () const
	return end iterator for the codimension and partition the ygrid represents More...
int	superindex (const iTupel &coord, int which) const
void	finalize (const DAI &end, int artificialOffset=0)

Static Public Attributes
static const int	dim = Coordinates::dimension

Detailed Description

template<class Coordinates>
class Dune::YGrid< Coordinates >

implements a collection of YGridComponents which form a codimension Entities of given codimension c need to be represented by d choose c YgridComponents. All entities in one such component share the same set of spanning unit vectors. A YGrid is used to iterate over the entire set of components the codimension consists of. It doesn't hold any data, but instead holds an iterator range into an array of components (which is owned by YGridLevel).

Member Typedef Documentation

DAI

template<class Coordinates >

typedef YGridComponent<Coordinates>* Dune::YGrid< Coordinates >::DAI

iTupel

template<class Coordinates >

typedef std::array<int, dim> Dune::YGrid< Coordinates >::iTupel

Member Function Documentation

begin() [1/2]

template<class Coordinates >

Iterator Dune::YGrid< Coordinates >::begin ( ) const

inline

return begin iterator for the codimension and partition the ygrid represents

begin() [2/2]

template<class Coordinates >

Iterator Dune::YGrid< Coordinates >::begin ( const std::array< int, dim > &  coord, int  which = 0  ) const

inline

return iterator pointint to a specified position

dataBegin()

template<class Coordinates >

DAI Dune::YGrid< Coordinates >::dataBegin ( ) const

inline

get start iterator in the data array

dataEnd()

template<class Coordinates >

DAI Dune::YGrid< Coordinates >::dataEnd ( ) const

inline

get end iterator in the data array

end()

template<class Coordinates >

Iterator Dune::YGrid< Coordinates >::end ( ) const

inline

return end iterator for the codimension and partition the ygrid represents

finalize()

template<class Coordinates >

void Dune::YGrid< Coordinates >::finalize ( const DAI &  end, int  artificialOffset = 0  )

inline

inside()

template<class Coordinates >

bool Dune::YGrid< Coordinates >::inside ( const iTupel &  coord, const std::bitset< dim > &  shift = std::bitset<dim>()  ) const

inline

decide whether a coordinate is in the grid (depending on the component)

setBegin()

template<class Coordinates >

void Dune::YGrid< Coordinates >::setBegin ( DAI  begin )

inline

set start iterator in the data array

shiftmapping()

template<class Coordinates >

int Dune::YGrid< Coordinates >::shiftmapping ( const std::bitset< dim > &  shift ) const

inline

get which component belongs to a given shift vector

superindex()

template<class Coordinates >

int Dune::YGrid< Coordinates >::superindex ( const iTupel &  coord, int  which  ) const

inline

Member Data Documentation

dim

template<class Coordinates >

const int Dune::YGrid< Coordinates >::dim = Coordinates::dimension

static

---

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

• ygrid.hh