DUNE PDELab (2.7)

Dune::PDELab::NonOverlappingBorderDOFExchanger< GridOperator >::PatternExtender< Pattern > Class Template Reference

A DataHandle class to exchange matrix sparsity patterns. More...

#include <dune/pdelab/gridoperator/common/borderdofexchanger.hh>

Public Types

typedef PatternMPIData DataType
 Export type of data for message buffer.
 

Public Member Functions

template<typename Entity >
size_type size (Entity &e) const
 How many objects of type DataType have to be sent for a given entity.
 
template<typename MessageBuffer , typename Entity >
void gather (MessageBuffer &buff, const Entity &e) const
 Pack data from user to message buffer.
 
template<typename MessageBuffer , typename Entity >
void scatter (MessageBuffer &buff, const Entity &e, size_t n)
 Unpack data from message buffer to user.
 
int fixedsize (int dim, int codim) const
 returns true if size of data per entity of given dim and codim is a constant More...
 
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...
 

Detailed Description

template<typename GridOperator>
template<typename Pattern>
class Dune::PDELab::NonOverlappingBorderDOFExchanger< GridOperator >::PatternExtender< Pattern >

A DataHandle class to exchange matrix sparsity patterns.

Member Function Documentation

◆ fixedsize()

int Dune::CommDataHandleIF< PatternExtender< Pattern > , PatternMPIData >::fixedsize ( int  dim,
int  codim 
) const
inlineinherited

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

Parameters
dimvalid dimension (i.e. the grids dimension)
codimvalid 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!

◆ gather()

void Dune::CommDataHandleIF< PatternExtender< Pattern > , PatternMPIData >::gather ( MessageBufferImp &  buff,
const EntityType &  e 
) const
inlineinherited

pack data from user to message buffer

Parameters
buffmessage buffer provided by the grid
eentity for which date should be packed to buffer

◆ scatter()

void Dune::CommDataHandleIF< PatternExtender< Pattern > , PatternMPIData >::scatter ( MessageBufferImp &  buff,
const EntityType &  e,
size_t  n 
)
inlineinherited

unpack data from message buffer to user.

Parameters
buffmessage buffer provided by the grid. This is not const, because the buffer has an internal iterator that gets advanced when reading from the buffer.
eentity for which date should be unpacked from buffer
nnumber of data written to buffer for this entity before

◆ size()

size_t Dune::CommDataHandleIF< PatternExtender< Pattern > , PatternMPIData >::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
eentity for which the size should be determined

The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.111.3 (Jul 15, 22:36, 2024)