Dumux::VectorCommDataHandle< Mapper, Vector, entityCodim, ScatterOperator > Class Template Reference

A data handle class to exchange entries of a vector. More...

#include <dumux/parallel/vectorcommdatahandle.hh>

Inheritance diagram for Dumux::VectorCommDataHandle< Mapper, Vector, entityCodim, ScatterOperator >:

Description

template<class Mapper, class Vector, int entityCodim, class ScatterOperator>
class Dumux::VectorCommDataHandle< Mapper, Vector, entityCodim, ScatterOperator >

A data handle class to exchange entries of a vector.

Public Types
using	DataType = typename Vector::value_type
	export type of data for message buffer

Public Member Functions
	VectorCommDataHandle (const Mapper &mapper, Vector &vector)
bool	contains (int dim, int codim) const
	returns true if data for this codim should be communicated
bool	fixedsize (int dim, int codim) const
	returns true if size per entity of given dim and codim is a constant
template<class Entity>
std::size_t	size (Entity &entity) const
	how many objects of type DataType have to be sent for a given entity
template<class MessageBuffer, class Entity>
void	gather (MessageBuffer &buff, const Entity &entity) const
	pack data from user to message buffer
template<class MessageBuffer, class Entity>
void	scatter (MessageBuffer &buff, const Entity &entity, std::size_t n)
	unpack data from message buffer to user

Protected Attributes
const Mapper &	mapper_
Vector &	vector_

Member Typedef Documentation

DataType

template<class Mapper, class Vector, int entityCodim, class ScatterOperator>

using Dumux::VectorCommDataHandle< Mapper, Vector, entityCodim, ScatterOperator >::DataType = typename Vector::value_type

export type of data for message buffer

Constructor & Destructor Documentation

VectorCommDataHandle()

template<class Mapper, class Vector, int entityCodim, class ScatterOperator>

Dumux::VectorCommDataHandle< Mapper, Vector, entityCodim, ScatterOperator >::VectorCommDataHandle ( const Mapper & mapper, Vector & vector )

inline

Member Function Documentation

contains()

template<class Mapper, class Vector, int entityCodim, class ScatterOperator>

bool Dumux::VectorCommDataHandle< Mapper, Vector, entityCodim, ScatterOperator >::contains ( int dim, int codim ) const

inline

returns true if data for this codim should be communicated

fixedsize()

template<class Mapper, class Vector, int entityCodim, class ScatterOperator>

bool Dumux::VectorCommDataHandle< Mapper, Vector, entityCodim, ScatterOperator >::fixedsize ( int dim, int codim ) const

inline

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

gather()

template<class Mapper, class Vector, int entityCodim, class ScatterOperator>

template<class MessageBuffer, class Entity>

void Dumux::VectorCommDataHandle< Mapper, Vector, entityCodim, ScatterOperator >::gather ( MessageBuffer & buff, const Entity & entity ) const

inline

pack data from user to message buffer

scatter()

template<class Mapper, class Vector, int entityCodim, class ScatterOperator>

template<class MessageBuffer, class Entity>

void Dumux::VectorCommDataHandle< Mapper, Vector, entityCodim, ScatterOperator >::scatter ( MessageBuffer & buff, const Entity & entity, std::size_t n )

inline

unpack data from message buffer to user

Note

n is the number of objects sent by the sender

size()

template<class Mapper, class Vector, int entityCodim, class ScatterOperator>

template<class Entity>

std::size_t Dumux::VectorCommDataHandle< Mapper, Vector, entityCodim, ScatterOperator >::size ( Entity & entity ) 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.

Member Data Documentation

mapper_

template<class Mapper, class Vector, int entityCodim, class ScatterOperator>

const Mapper& Dumux::VectorCommDataHandle< Mapper, Vector, entityCodim, ScatterOperator >::mapper_

protected

vector_

template<class Mapper, class Vector, int entityCodim, class ScatterOperator>

Vector& Dumux::VectorCommDataHandle< Mapper, Vector, entityCodim, ScatterOperator >::vector_

protected

---

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

• vectorcommdatahandle.hh