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

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

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

Public Types
typedef char	DataType
	data type of data to communicate More...

Public Member Functions
	DataHandle (GridPtr &gridPtr)
	DataHandle (const DataHandle &)=delete
	DataHandle (DataHandle &&)=delete
	~DataHandle ()
CommDataHandleIF< DataHandle, char > &	interface ()
bool	contains (int dim, int codim) const
bool	fixedSize (int, int) const
template<class Entity >
std::size_t	size (const Entity &entity) const
template<class Buffer , class Entity >
void	gather (Buffer &buffer, const Entity &entity) const
template<class Buffer , class Entity >
void	scatter (Buffer &buffer, const Entity &entity, std::size_t n)
int	fixedsize (int dim, int codim) const
	returns true if size of data per entity of given dim and codim is a constant More...
bool	overloaded_deprecated_fixedsize (int dim, int codim) const
size_t	size (const EntityType &e) const
	how many objects of type DataType have to be sent for a given entity More...
void	gather (MessageBufferImp &buff, const EntityType &e) const
	pack data from user to message buffer More...
void	scatter (MessageBufferImp &buff, const EntityType &e, size_t n)
	unpack data from message buffer to user. More...

Member Typedef Documentation

DataType

typedef char Dune::CommDataHandleIF< DataHandle , char >::DataType

inherited

data type of data to communicate

Constructor & Destructor Documentation

DataHandle() [1/3]

template<class GridType >

Dune::GridPtr< GridType >::DataHandle::DataHandle ( GridPtr &  gridPtr )

inlineexplicit

DataHandle() [2/3]

template<class GridType >

Dune::GridPtr< GridType >::DataHandle::DataHandle ( const DataHandle &  )

delete

DataHandle() [3/3]

template<class GridType >

Dune::GridPtr< GridType >::DataHandle::DataHandle ( DataHandle &&  )

delete

~DataHandle()

template<class GridType >

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

inline

Member Function Documentation

contains()

template<class GridType >

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

inline

fixedsize()

int Dune::CommDataHandleIF< DataHandle , char >::fixedsize ( int  dim, int  codim  ) const

inlineinherited

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

This method calls 'fixedSize' (with a capital S) of the derived class, if it exists in the derived class. Otherwise, it calls 'fixedsize'.

Deprecated:

This method (with the lower-case 's') is deprecated. Use 'fixedSize' instead!

fixedSize()

template<class GridType >

bool Dune::GridPtr< GridType >::DataHandle::fixedSize ( int  , int    ) const

inline

gather() [1/2]

template<class GridType >

template<class Buffer , class Entity >

void Dune::GridPtr< GridType >::DataHandle::gather ( Buffer &  buffer, const Entity &  entity  ) const

inline

gather() [2/2]

void Dune::CommDataHandleIF< DataHandle , char >::gather ( MessageBufferImp &  buff, const EntityType &  e  ) const

inlineinherited

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

interface()

template<class GridType >

CommDataHandleIF< DataHandle, char > & Dune::GridPtr< GridType >::DataHandle::interface ( )

inline

overloaded_deprecated_fixedsize()

bool Dune::CommDataHandleIF< DataHandle , char >::overloaded_deprecated_fixedsize ( int  dim, int  codim  ) const

inlineinherited

scatter() [1/2]

template<class GridType >

template<class Buffer , class Entity >

void Dune::GridPtr< GridType >::DataHandle::scatter ( Buffer &  buffer, const Entity &  entity, std::size_t  n  )

inline

scatter() [2/2]

void Dune::CommDataHandleIF< DataHandle , char >::scatter ( MessageBufferImp &  buff, const EntityType &  e, size_t  n  )

inlineinherited

unpack data from message buffer to user.

Parameters

buff	message buffer provided by the grid. This is not const, because the buffer has an internal iterator that gets advanced when reading from the buffer.
e	entity for which date should be unpacked from buffer
n	number of data written to buffer for this entity before

size() [1/2]

template<class GridType >

template<class Entity >

std::size_t Dune::GridPtr< GridType >::DataHandle::size ( const Entity &  entity ) const

inline

size() [2/2]

size_t Dune::CommDataHandleIF< DataHandle , char >::size ( const EntityType &  e ) const

inlineinherited

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 determined

---

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

• gridptr.hh