dune-pdelab  2.5-dev
Public Types | Public Member Functions | List of all members
Dune::PDELab::GFSNeighborDataHandle< GFS, RankIndex > Class Template Reference

Data handle for collecting set of neighboring MPI ranks. More...

#include <dune/pdelab/gridfunctionspace/genericdatahandle.hh>

Inheritance diagram for Dune::PDELab::GFSNeighborDataHandle< GFS, RankIndex >:
Inheritance graph

Public Types

typedef RankIndex DataType
 
typedef GFS::Traits::SizeType size_type
 

Public Member Functions

 GFSNeighborDataHandle (const GFS &gfs, RankIndex rank, std::set< RankIndex > &neighbors)
 
bool contains (int dim, int codim) const
 
bool fixedsize (int dim, int codim) const
 
template<typename Entity >
size_type size (Entity &e) const
 
template<typename MessageBuffer , typename Entity >
void gather (MessageBuffer &buff, const Entity &e) const
 
template<typename MessageBuffer , typename Entity >
void scatter (MessageBuffer &buff, const Entity &e, size_type n)
 

Detailed Description

template<typename GFS, typename RankIndex>
class Dune::PDELab::GFSNeighborDataHandle< GFS, RankIndex >

Data handle for collecting set of neighboring MPI ranks.

This data handle collects the MPI ranks of all processes that share grid entities with attached DOFs.

Note
In order to work correctly, the data handle must be communicated on the Dune::All_All_Interface.

Member Typedef Documentation

◆ DataType

template<typename GFS , typename RankIndex >
typedef RankIndex Dune::PDELab::GFSNeighborDataHandle< GFS, RankIndex >::DataType

◆ size_type

template<typename GFS , typename RankIndex >
typedef GFS::Traits::SizeType Dune::PDELab::GFSNeighborDataHandle< GFS, RankIndex >::size_type

Constructor & Destructor Documentation

◆ GFSNeighborDataHandle()

template<typename GFS , typename RankIndex >
Dune::PDELab::GFSNeighborDataHandle< GFS, RankIndex >::GFSNeighborDataHandle ( const GFS &  gfs,
RankIndex  rank,
std::set< RankIndex > &  neighbors 
)
inline

Member Function Documentation

◆ contains()

template<typename GFS , typename RankIndex >
bool Dune::PDELab::GFSNeighborDataHandle< GFS, RankIndex >::contains ( int  dim,
int  codim 
) const
inline

◆ fixedsize()

template<typename GFS , typename RankIndex >
bool Dune::PDELab::GFSNeighborDataHandle< GFS, RankIndex >::fixedsize ( int  dim,
int  codim 
) const
inline

◆ gather()

template<typename GFS , typename RankIndex >
template<typename MessageBuffer , typename Entity >
void Dune::PDELab::GFSNeighborDataHandle< GFS, RankIndex >::gather ( MessageBuffer &  buff,
const Entity &  e 
) const
inline

◆ scatter()

template<typename GFS , typename RankIndex >
template<typename MessageBuffer , typename Entity >
void Dune::PDELab::GFSNeighborDataHandle< GFS, RankIndex >::scatter ( MessageBuffer &  buff,
const Entity &  e,
size_type  n 
)
inline

◆ size()

template<typename GFS , typename RankIndex >
template<typename Entity >
size_type Dune::PDELab::GFSNeighborDataHandle< GFS, RankIndex >::size ( Entity &  e) const
inline

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