Dune::GridPtr< GridType >::DataHandle Struct Reference

#include <dune/grid/io/file/dgfparser/gridptr.hh>

Inheritance diagram for Dune::GridPtr< GridType >::DataHandle:

List of all members.

Public Types
typedef double	DataType
	data type of data to communicate
Public Member Functions
	DataHandle (GridPtr &gridPtr)
	~DataHandle ()
CommDataHandleIF< DataHandle, double > &	interface ()
bool	contains (int dim, int codim) const
	returns true if data for given valid codim should be communicated
bool	fixedsize (int dim, int codim) const
	returns true if size of data per entity of given dim and codim is a constant
template<class EntityType >
size_t	size (const EntityType &e) const
	how many objects of type DataType have to be sent for a given entity
template<class MessageBufferImp , class EntityType >
void	gather (MessageBufferImp &buff, const EntityType &e) const
	pack data from user to message buffer
template<class MessageBufferImp , class EntityType >
void	scatter (MessageBufferImp &buff, const EntityType &e, size_t n)

template<class GridType>
struct Dune::GridPtr< GridType >::DataHandle

---

Member Typedef Documentation

typedef double Dune::CommDataHandleIF< DataHandle , double >::DataType [inherited]

data type of data to communicate

---

Constructor & Destructor Documentation

template<class GridType>

Dune::GridPtr< GridType >::DataHandle::DataHandle

(

GridPtr &

gridPtr

)

[inline]

References Dune::GridPtr< GridType >::dimension, Dune::GridPtr< GridType >::elParam_, Dune::GridView< ViewTraits >::indexSet(), Dune::Interior_Partition, Dune::GridPtr< GridType >::nofElParam_, Dune::GridPtr< GridType >::nofVtxParam_, and Dune::GridPtr< GridType >::vtxParam_.

template<class GridType>

Dune::GridPtr< GridType >::DataHandle::~DataHandle

(

)

[inline]

References Dune::All_Partition, Dune::GridPtr< GridType >::dimension, Dune::GridPtr< GridType >::elParam_, Dune::GridView< ViewTraits >::indexSet(), Dune::GridPtr< GridType >::nofElParam_, Dune::GridPtr< GridType >::nofVtxParam_, and Dune::GridPtr< GridType >::vtxParam_.

---

Member Function Documentation

template<class GridType>

bool Dune::GridPtr< GridType >::DataHandle::contains	(	int	dim,
		int	codim
	)		const [inline]

returns true if data for given valid codim should be communicated

Parameters:

dim	valid dimension (i.e. the grids dimension)
codim	valid codimension of the entity set for which data should be communicated

Reimplemented from Dune::CommDataHandleIF< DataHandle, double >.

template<class GridType>

bool Dune::GridPtr< GridType >::DataHandle::fixedsize	(	int	dim,
		int	codim
	)		const [inline]

returns true if size of data per entity of given dim and codim is a constant

Parameters:

dim	valid dimension (i.e. the grids dimension)
codim	valid codimension of the entity set for which data should be communicated

Reimplemented from Dune::CommDataHandleIF< DataHandle, double >.

template<class GridType>

template<class MessageBufferImp , class EntityType >

void Dune::GridPtr< GridType >::DataHandle::gather	(	MessageBufferImp &	buff,
		const EntityType &	e
	)		const [inline]

pack data from user to message buffer

Parameters:

buff	message buffer provided by the grid
e	entity for which date should be packed to buffer

Reimplemented from Dune::CommDataHandleIF< DataHandle, double >.

References Dune::GridPtr< GridType >::nofParameters().

template<class GridType>

CommDataHandleIF<DataHandle,double>& Dune::GridPtr< GridType >::DataHandle::interface

(

)

[inline]

Referenced by Dune::GridPtr< GridType >::loadBalance().

template<class GridType>

template<class MessageBufferImp , class EntityType >

void Dune::GridPtr< GridType >::DataHandle::scatter	(	MessageBufferImp &	buff,
		const EntityType &	e,
		size_t	n
	)		[inline]

unpack data from message buffer to user n is the number of objects sent by the sender

Parameters:

buff	message buffer provided by the grid
e	entity for which date should be unpacked from buffer
n	number of data written to buffer for this entity before

Reimplemented from Dune::CommDataHandleIF< DataHandle, double >.

References Dune::GridPtr< GridType >::setNofParams().

template<class GridType>

template<class EntityType >

size_t Dune::GridPtr< GridType >::DataHandle::size

(

const EntityType &

e

)

const [inline]

how many objects of type DataType have to be sent for a given entity

Note:

Only the sender side needs to know this size.

Parameters:

e	entity for which the size should be dertermined

Reimplemented from Dune::CommDataHandleIF< DataHandle, double >.

References Dune::GridPtr< GridType >::nofParameters().

---

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

• gridptr.hh