dune-istl  2.7.1
About: dune-istl - DUNE (Distributed and Unified Numerics Environment) is a modular toolbox for solving partial differential equations (PDEs) with grid-based methods: DUNE Iterative Solver Template Library.
  Fossies Dox: dune-istl-2.7.1.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

Dune::IndexInfoFromGrid< G, L > Class Template Reference

Information about the index distribution. More...

#include <owneroverlapcopy.hh>

Collaboration diagram for Dune::IndexInfoFromGrid< G, L >:
[legend]

Public Types

typedef G GlobalIdType
 The type of the global index. More...
 
typedef L LocalIdType
 The type of the local index. More...
 
typedef std::tuple< GlobalIdType, LocalIdType, int > IndexTripel
 A triple describing a local index. More...
 
typedef std::tuple< int, GlobalIdType, int > RemoteIndexTripel
 A triple describing a remote index. More...
 

Public Member Functions

void addLocalIndex (const IndexTripel &x)
 Add a new index triple to the set of local indices. More...
 
void addRemoteIndex (const RemoteIndexTripel &x)
 Add a new remote index triple to the set of remote indices. More...
 
const std::set< IndexTripel > & localIndices () const
 Get the set of indices local to the process. More...
 
const std::set< RemoteIndexTripel > & remoteIndices () const
 Get the set of remote indices. More...
 
void clear ()
 Remove all indices from the sets. More...
 

Private Attributes

std::set< IndexTripellocalindices
 The set of local indices. More...
 
std::set< RemoteIndexTripelremoteindices
 The set of remote indices. More...
 

Detailed Description

template<class G, class L>
class Dune::IndexInfoFromGrid< G, L >

Information about the index distribution.

This class contains information about indices local to the process together with information about on which processes those indices are also present together with the attribute they have there.

This information might be used to set up an IndexSet together with an RemoteIndices object needed for the ISTL communication classes.

Definition at line 75 of file owneroverlapcopy.hh.

Member Typedef Documentation

◆ GlobalIdType

template<class G , class L >
typedef G Dune::IndexInfoFromGrid< G, L >::GlobalIdType

The type of the global index.

Definition at line 79 of file owneroverlapcopy.hh.

◆ IndexTripel

template<class G , class L >
typedef std::tuple<GlobalIdType,LocalIdType,int> Dune::IndexInfoFromGrid< G, L >::IndexTripel

A triple describing a local index.

The triple consists of the global index and the local index and an attribute

Definition at line 90 of file owneroverlapcopy.hh.

◆ LocalIdType

template<class G , class L >
typedef L Dune::IndexInfoFromGrid< G, L >::LocalIdType

The type of the local index.

Definition at line 82 of file owneroverlapcopy.hh.

◆ RemoteIndexTripel

template<class G , class L >
typedef std::tuple<int,GlobalIdType,int> Dune::IndexInfoFromGrid< G, L >::RemoteIndexTripel

A triple describing a remote index.

The triple consists of a process number and the global index and the attribute of the index at the remote process.

Definition at line 97 of file owneroverlapcopy.hh.

Member Function Documentation

◆ addLocalIndex()

template<class G , class L >
void Dune::IndexInfoFromGrid< G, L >::addLocalIndex ( const IndexTripel x)
inline

Add a new index triple to the set of local indices.

Parameters
xThe index triple.

Definition at line 104 of file owneroverlapcopy.hh.

References Dune::OwnerOverlapCopyAttributeSet::copy, Dune::IndexInfoFromGrid< G, L >::localindices, Dune::OwnerOverlapCopyAttributeSet::overlap, and Dune::OwnerOverlapCopyAttributeSet::owner.

◆ addRemoteIndex()

template<class G , class L >
void Dune::IndexInfoFromGrid< G, L >::addRemoteIndex ( const RemoteIndexTripel x)
inline

Add a new remote index triple to the set of remote indices.

Parameters
xThe index triple to add.

Definition at line 118 of file owneroverlapcopy.hh.

References Dune::OwnerOverlapCopyAttributeSet::copy, Dune::OwnerOverlapCopyAttributeSet::overlap, Dune::OwnerOverlapCopyAttributeSet::owner, and Dune::IndexInfoFromGrid< G, L >::remoteindices.

◆ clear()

template<class G , class L >
void Dune::IndexInfoFromGrid< G, L >::clear ( )
inline

Remove all indices from the sets.

Definition at line 148 of file owneroverlapcopy.hh.

References Dune::IndexInfoFromGrid< G, L >::localindices, and Dune::IndexInfoFromGrid< G, L >::remoteindices.

◆ localIndices()

template<class G , class L >
const std::set<IndexTripel>& Dune::IndexInfoFromGrid< G, L >::localIndices ( ) const
inline

Get the set of indices local to the process.

Returns
The set of local indices.

Definition at line 131 of file owneroverlapcopy.hh.

References Dune::IndexInfoFromGrid< G, L >::localindices.

◆ remoteIndices()

template<class G , class L >
const std::set<RemoteIndexTripel>& Dune::IndexInfoFromGrid< G, L >::remoteIndices ( ) const
inline

Get the set of remote indices.

Returns
the set of remote indices.

Definition at line 140 of file owneroverlapcopy.hh.

References Dune::IndexInfoFromGrid< G, L >::remoteindices.

Member Data Documentation

◆ localindices

template<class G , class L >
std::set<IndexTripel> Dune::IndexInfoFromGrid< G, L >::localindices
private

◆ remoteindices

template<class G , class L >
std::set<RemoteIndexTripel> Dune::IndexInfoFromGrid< G, L >::remoteindices
private

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