3.2-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Types | Public Member Functions | Protected Attributes | List of all members
Dumux::VertexHandleSum< FieldType, Container, VertexMapper > Class Template Reference

#include <dumux/parallel/vertexhandles.hh>

Inheritance diagram for Dumux::VertexHandleSum< FieldType, Container, VertexMapper >:
Inheritance graph

Public Types

using DataType = typename Vector::value_type
 export type of data for message buffer More...
 

Public Member Functions

 VertexHandleSum (Container &container, const VertexMapper &mapper)
 
bool contains (int dim, int codim) const
 
bool fixedsize (int dim, int codim) const
 returns true if size per entity of given dim and codim is a constant More...
 
template<class Entity >
std::size_t size (Entity &entity) const
 how many objects of type DataType have to be sent for a given entity More...
 
template<class MessageBuffer , class Entity >
void gather (MessageBuffer &buff, const Entity &entity) const
 pack data from user to message buffer More...
 
template<class MessageBuffer , class Entity >
void scatter (MessageBuffer &buff, const Entity &entity, std::size_t n)
 unpack data from message buffer to user More...
 

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
inherited

export type of data for message buffer

Constructor & Destructor Documentation

◆ VertexHandleSum()

template<class FieldType , class Container , class VertexMapper >
Dumux::VertexHandleSum< FieldType, Container, VertexMapper >::VertexHandleSum ( Container &  container,
const VertexMapper &  mapper 
)
inline

Member Function Documentation

◆ contains()

template<class FieldType , class Container , class VertexMapper >
bool Dumux::VertexHandleSum< FieldType, Container, VertexMapper >::contains ( int  dim,
int  codim 
) const
inline

◆ fixedsize()

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

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
inlineinherited

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 
)
inlineinherited

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
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.

Member Data Documentation

◆ mapper_

template<class Mapper , class Vector , int entityCodim, class ScatterOperator >
const Mapper& Dumux::VectorCommDataHandle< Mapper, Vector, entityCodim, ScatterOperator >::mapper_
protectedinherited

◆ vector_

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

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