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

Classes
class	Iterator

Public Types
typedef Coordinates::ctype	ct

typedef std::array< int, d >	iTupel

typedef FieldVector< ct, d >	fTupel

Public Member Functions
	YGridComponent ()
	make uninitialized ygrid

	YGridComponent (iTupel origin, iTupel size)
	make ygrid without coordinate information

	YGridComponent (iTupel origin, iTupel size, const YGridComponent< Coordinates > &enclosing)
	make a subgrid by taking coordinates from a larger grid

	YGridComponent (iTupel origin, std::bitset< d > shift, Coordinates *coords, iTupel size, iTupel offset, iTupel supersize)
	Make YGridComponent by giving all parameters.

int	origin (int i) const
	Return origin in direction i.

const iTupel &	origin () const
	return reference to origin

bool	shift (int i) const
	Return shift in direction i.

const std::bitset< d > &	shift () const
	Return shift tuple.

Coordinates *	getCoords () const

int	offset (int i) const
	Return offset to origin of enclosing grid.

const iTupel &	offset () const
	Return offset to origin of enclosing grid.

int	supersize (int i) const
	return size of enclosing grid

const iTupel &	supersize () const
	return size of enclosing grid

int	size (int i) const
	return size in direction i

iTupel	size () const
	return size

int	totalsize () const
	Return total size of index set which is the product of all size per direction.

int	min (int i) const
	Return minimum index in direction i.

int	max (int i) const
	Return maximum index in direction i.

bool	empty () const
	Return true if YGrid is empty, i.e. has size 0 in all directions.

bool	inside (const iTupel &coord) const
	given a coordinate, return true if it is in the grid

int	index (const iTupel &coord) const
	given a tuple compute its index in the lexicographic numbering

YGridComponent< Coordinates >	move (iTupel v) const
	return grid moved by the vector v

YGridComponent< Coordinates >	intersection (const YGridComponent< Coordinates > &r) const
	Return YGridComponent of supergrid of self which is the intersection of self and another YGridComponent.

int	superindex (iTupel coord) const

int	superincrement (int i) const

Iterator	begin () const
	return iterator to first element of index set

Iterator	begin (const iTupel &co) const
	return iterator to given element of index set

Iterator	end () const
	return subiterator to last element of index set

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

Detailed Description

template<class Coordinates>
class Dune::YGridComponent< Coordinates >

The YGrid considered here describes a finite set $d$ -tupels of the form

$G = \{ (k_0,\ldots,k_{d-1}) | o_i \leq k_i < o_i+s_i \}$

together with an affine mapping.

A YGrid is characterized by the following quantities:

The origin $o=(o_0,\ldots,o_{d-1}) \in Z^d$ ,
the size $s=(s_0,\ldots,s_{d-1}) \in Z^d$ ,
The shift $r=(r_0,\ldots,r_{d-1}) \in R^d$ .
a coordinate container, that gives the mapping of the index to global coordinates (see coordinates.hh)

The shift can be used to interpret the points of a grid as midpoints of cells, faces, edges, etc.

Here is a graphical illustration of a grid:

A YGrid.

A YGrid allows to iterate over all its cells with an Iterator class.

A YGrid is always considered as being embedded in a larger grid. This embedding is characterized by an offset and an enclosing grid as shown in the following picture:

The SubYGrid is shown in red, blue is the enclosing grid.

The iterator provides also a mapping to the consecutive index in the enclosing grid.

Note: as of november 2013 there are only YGrid and YGrid::Iterator. These represent the functionality of former SubYGrid and SubYGrid::TransformingSubIterator. All other classes in the hierarchy have not been used.

Member Typedef Documentation

◆ ct

template<class Coordinates >

typedef Coordinates::ctype Dune::YGridComponent< Coordinates >::ct

◆ fTupel

template<class Coordinates >

typedef FieldVector<ct,d> Dune::YGridComponent< Coordinates >::fTupel

◆ iTupel

template<class Coordinates >

typedef std::array<int, d> Dune::YGridComponent< Coordinates >::iTupel

Constructor & Destructor Documentation

◆ YGridComponent() [1/4]

template<class Coordinates >

Dune::YGridComponent< Coordinates >::YGridComponent ( )

inline

make uninitialized ygrid

◆ YGridComponent() [2/4]

template<class Coordinates >

Dune::YGridComponent< Coordinates >::YGridComponent	(	iTupel	origin,
		iTupel	size
	)

inline

make ygrid without coordinate information

Parameters

origin	origin of the grid in global coordinates
size	size of the grid Such grid has no coordinate information stored but can be used to determine an intersection with a grid with coordinate information. This avoids sending coordinates in the parallel case.

◆ YGridComponent() [3/4]

template<class Coordinates >

Dune::YGridComponent< Coordinates >::YGridComponent	(	iTupel	origin,
		iTupel	size,
		const YGridComponent< Coordinates > &	enclosing
	)

inline

make a subgrid by taking coordinates from a larger grid

Parameters

origin	origin of the grid to be constructed
size	size of the grid to be constructed
enclosing	the grid to take coordinates and shift vector from

◆ YGridComponent() [4/4]

template<class Coordinates >

Dune::YGridComponent< Coordinates >::YGridComponent	(	iTupel	origin,
		std::bitset< d >	shift,
		Coordinates *	coords,
		iTupel	size,
		iTupel	offset,
		iTupel	supersize
	)

inline

Make YGridComponent by giving all parameters.

Parameters

origin	the origin of the grid in global coordinates
shift	the shift vector
coords	the coordinate vectors to be used
size	the size vector
offset	the offset in the enclosing grid
supersize	size of the enclosing grid

Member Function Documentation

◆ begin() [1/2]

template<class Coordinates >

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

inline

return iterator to first element of index set

◆ begin() [2/2]

template<class Coordinates >

Iterator Dune::YGridComponent< Coordinates >::begin ( const iTupel & co ) const

inline

return iterator to given element of index set

◆ empty()

template<class Coordinates >

bool Dune::YGridComponent< Coordinates >::empty ( ) const

inline

Return true if YGrid is empty, i.e. has size 0 in all directions.

◆ end()

template<class Coordinates >

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

inline

return subiterator to last element of index set

◆ getCoords()

template<class Coordinates >

Coordinates * Dune::YGridComponent< Coordinates >::getCoords ( ) const

inline

◆ index()

template<class Coordinates >

int Dune::YGridComponent< Coordinates >::index ( const iTupel & coord ) const

inline

given a tuple compute its index in the lexicographic numbering

◆ inside()

template<class Coordinates >

bool Dune::YGridComponent< Coordinates >::inside ( const iTupel & coord ) const

inline

given a coordinate, return true if it is in the grid

◆ intersection()

template<class Coordinates >

YGridComponent< Coordinates > Dune::YGridComponent< Coordinates >::intersection ( const YGridComponent< Coordinates > & r ) const

inline

Return YGridComponent of supergrid of self which is the intersection of self and another YGridComponent.

◆ max()

template<class Coordinates >

int Dune::YGridComponent< Coordinates >::max ( int i ) const

inline

Return maximum index in direction i.

◆ min()

template<class Coordinates >

int Dune::YGridComponent< Coordinates >::min ( int i ) const

inline

Return minimum index in direction i.

◆ move()

template<class Coordinates >

YGridComponent< Coordinates > Dune::YGridComponent< Coordinates >::move ( iTupel v ) const

inline

return grid moved by the vector v

◆ offset() [1/2]

template<class Coordinates >

const iTupel & Dune::YGridComponent< Coordinates >::offset ( ) const

inline

Return offset to origin of enclosing grid.

◆ offset() [2/2]

template<class Coordinates >

int Dune::YGridComponent< Coordinates >::offset ( int i ) const

inline

Return offset to origin of enclosing grid.

◆ origin() [1/2]

template<class Coordinates >

const iTupel & Dune::YGridComponent< Coordinates >::origin ( ) const

inline

return reference to origin

◆ origin() [2/2]

template<class Coordinates >

int Dune::YGridComponent< Coordinates >::origin ( int i ) const

inline

Return origin in direction i.

◆ shift() [1/2]

template<class Coordinates >

const std::bitset< d > & Dune::YGridComponent< Coordinates >::shift ( ) const

inline

Return shift tuple.

◆ shift() [2/2]

template<class Coordinates >

bool Dune::YGridComponent< Coordinates >::shift ( int i ) const

inline

Return shift in direction i.

◆ size() [1/2]

template<class Coordinates >

iTupel Dune::YGridComponent< Coordinates >::size ( ) const

inline

return size

◆ size() [2/2]

template<class Coordinates >

int Dune::YGridComponent< Coordinates >::size ( int i ) const

inline

return size in direction i

◆ superincrement()

template<class Coordinates >

int Dune::YGridComponent< Coordinates >::superincrement ( int i ) const

inline

◆ superindex()

template<class Coordinates >

int Dune::YGridComponent< Coordinates >::superindex ( iTupel coord ) const

inline

◆ supersize() [1/2]

template<class Coordinates >

const iTupel & Dune::YGridComponent< Coordinates >::supersize ( ) const

inline

return size of enclosing grid

◆ supersize() [2/2]

template<class Coordinates >

int Dune::YGridComponent< Coordinates >::supersize ( int i ) const

inline

return size of enclosing grid

◆ totalsize()

template<class Coordinates >

int Dune::YGridComponent< Coordinates >::totalsize ( ) const

inline

Return total size of index set which is the product of all size per direction.

Member Data Documentation

◆ d

template<class Coordinates >

const int Dune::YGridComponent< Coordinates >::d = Coordinates::dimension

static

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

ygrid.hh

Classes

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ ct

◆ fTupel

◆ iTupel

Constructor & Destructor Documentation

◆ YGridComponent() [1/4]

◆ YGridComponent() [2/4]

◆ YGridComponent() [3/4]

◆ YGridComponent() [4/4]

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ empty()

◆ end()

◆ getCoords()

◆ index()

◆ inside()

◆ intersection()

◆ max()

◆ min()

◆ move()

◆ offset() [1/2]

◆ offset() [2/2]

◆ origin() [1/2]

◆ origin() [2/2]

◆ shift() [1/2]

◆ shift() [2/2]

◆ size() [1/2]

◆ size() [2/2]

◆ superincrement()

◆ superindex()

◆ supersize() [1/2]

◆ supersize() [2/2]

◆ totalsize()

Member Data Documentation

◆ d