Dumux::EntityExchanger< GridView, AmgTraits >::MatPatternExchange Class Reference

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

#include <dumux/linear/amgparallelhelpers.hh>

Inheritance diagram for Dumux::EntityExchanger< GridView, AmgTraits >::MatPatternExchange:

Description

template<class GridView, class AmgTraits>
class Dumux::EntityExchanger< GridView, AmgTraits >::MatPatternExchange

A DataHandle class to exchange matrix sparsity patterns.

We look at a 2D example with a nonoverlapping grid, two processes and no ghosts with Q1 discretization. Process 0 has the left part of the domain with three cells and eight vertices (1-8), Process 1 the right part with three cells and eight vertices (2,4,7-12).

 1 _ 2        2 _ 9 _ 10
 |   |        |   |   |
 3 _ 4 _ 7    4 _ 7 _ 11
 |   |   |        |   |
 5 _ 6 _ 8        8 _ 12
 

If we look at vertex 7 and the corresponding entries in the matrix for P0, there will be entries for (7,4) and (7,8), but not for (7,2). The MatPatternExchange class will find these entries and returns a vector "sparsity", that contains all missing connections.

Public Types
using	DataType = IdType
	Export type of data for message buffer. More...

Public Member Functions
	MatPatternExchange (const DofMapper &mapper, const std::map< IdType, int > &g2i, const std::map< int, IdType > &i2g, Matrix &A, const ParallelISTLHelper< GridView, AmgTraits > &helper)
	Constructor. More...
bool	contains (int dim, int codim) const
	Returns true if data for given valid codim should be communicated. More...
bool	fixedsize (int dim, int codim) const
	Returns true if size of data per entity of given dim and codim is a constant. More...
template<class EntityType >
size_t	size (EntityType &e) const
	How many objects of type DataType have to be sent for a given entity. More...
template<class MessageBuffer , class EntityType >
void	gather (MessageBuffer &buff, const EntityType &e) const
	Pack data from user to message buffer. More...
template<class MessageBuffer , class EntityType >
void	scatter (MessageBuffer &buff, const EntityType &e, size_t n)
	Unpack data from message buffer to user. More...
std::vector< std::set< int > > &	sparsity ()
	Get the communicated sparsity pattern. More...

Member Typedef Documentation

DataType

template<class GridView , class AmgTraits >

using Dumux::EntityExchanger< GridView, AmgTraits >::MatPatternExchange::DataType = IdType

Export type of data for message buffer.

Constructor & Destructor Documentation

MatPatternExchange()

template<class GridView , class AmgTraits >

Dumux::EntityExchanger< GridView, AmgTraits >::MatPatternExchange::MatPatternExchange ( const DofMapper &  mapper, const std::map< IdType, int > &  g2i, const std::map< int, IdType > &  i2g, Matrix &  A, const ParallelISTLHelper< GridView, AmgTraits > &  helper  )

inline

Constructor.

Parameters

[in]	mapper	The local dof mapper.
[in]	g2i	Global to local index map.
[in]	i2g	Local to global index map.
[in]	A	Matrix to operate on.
[in]	helper	parallel istl helper.

Member Function Documentation

contains()

template<class GridView , class AmgTraits >

bool Dumux::EntityExchanger< GridView, AmgTraits >::MatPatternExchange::contains ( int  dim, int  codim  ) const

inline

Returns true if data for given valid codim should be communicated.

fixedsize()

template<class GridView , class AmgTraits >

bool Dumux::EntityExchanger< GridView, AmgTraits >::MatPatternExchange::fixedsize ( int  dim, int  codim  ) const

inline

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

gather()

template<class GridView , class AmgTraits >

template<class MessageBuffer , class EntityType >

void Dumux::EntityExchanger< GridView, AmgTraits >::MatPatternExchange::gather ( MessageBuffer &  buff, const EntityType &  e  ) const

inline

Pack data from user to message buffer.

scatter()

template<class GridView , class AmgTraits >

template<class MessageBuffer , class EntityType >

void Dumux::EntityExchanger< GridView, AmgTraits >::MatPatternExchange::scatter ( MessageBuffer &  buff, const EntityType &  e, size_t  n  )

inline

Unpack data from message buffer to user.

size()

template<class GridView , class AmgTraits >

template<class EntityType >

size_t Dumux::EntityExchanger< GridView, AmgTraits >::MatPatternExchange::size ( EntityType &  e ) const

inline

How many objects of type DataType have to be sent for a given entity.

sparsity()

template<class GridView , class AmgTraits >

std::vector< std::set< int > > & Dumux::EntityExchanger< GridView, AmgTraits >::MatPatternExchange::sparsity ( )

inline

Get the communicated sparsity pattern.

Returns

the vector with the sparsity pattern

---

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

• amgparallelhelpers.hh