dune-common 2.9.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
Dune::RemoteIndex< T1, T2 > Class Template Reference

Information about an index residing on another processor. More...

#include <dune/common/parallel/remoteindices.hh>

Public Types

typedef T1 GlobalIndex
 the type of the global index. This type has to provide at least a operator< for sorting.
 
typedef T2 Attribute
 The type of the attributes. Normally this will be an enumeration like.
 
typedef IndexPair< GlobalIndex, ParallelLocalIndex< Attribute > > PairType
 The type of the index pair.
 

Public Member Functions

const Attribute attribute () const
 Get the attribute of the index on the remote process.
 
const PairTypelocalIndexPair () const
 Get the corresponding local index pair.
 
 RemoteIndex ()
 Parameterless Constructor.
 
 RemoteIndex (const T2 &attribute, const PairType *local)
 Constructor.
 
 RemoteIndex (const T2 &attribute)
 Constructor. Private as it should only be called from within Indexset.
 
bool operator== (const RemoteIndex &ri) const
 
bool operator!= (const RemoteIndex &ri) const
 

Detailed Description

template<typename T1, typename T2>
class Dune::RemoteIndex< T1, T2 >

Information about an index residing on another processor.

Member Typedef Documentation

◆ Attribute

template<typename T1 , typename T2 >
typedef T2 Dune::RemoteIndex< T1, T2 >::Attribute

The type of the attributes. Normally this will be an enumeration like.

enum Attributes{owner, border, overlap}

e.g. OwnerOverlapCopyAttributes.

◆ GlobalIndex

template<typename T1 , typename T2 >
typedef T1 Dune::RemoteIndex< T1, T2 >::GlobalIndex

the type of the global index. This type has to provide at least a operator< for sorting.

◆ PairType

template<typename T1 , typename T2 >
typedef IndexPair<GlobalIndex,ParallelLocalIndex<Attribute> > Dune::RemoteIndex< T1, T2 >::PairType

The type of the index pair.

Constructor & Destructor Documentation

◆ RemoteIndex() [1/3]

template<typename T1 , typename T2 >
Dune::RemoteIndex< T1, T2 >::RemoteIndex ( )

Parameterless Constructor.

◆ RemoteIndex() [2/3]

template<typename T1 , typename T2 >
Dune::RemoteIndex< T1, T2 >::RemoteIndex ( const T2 &  attribute,
const PairType local 
)

Constructor.

Parameters
attributeThe attribute of the index on the remote processor.
localThe corresponding local index.

◆ RemoteIndex() [3/3]

template<typename T1 , typename T2 >
Dune::RemoteIndex< T1, T2 >::RemoteIndex ( const T2 &  attribute)

Constructor. Private as it should only be called from within Indexset.

Parameters
attributeThe attribute of the index on the remote processor.

Member Function Documentation

◆ attribute()

template<typename T1 , typename T2 >
const T2 Dune::RemoteIndex< T1, T2 >::attribute ( ) const
inline

Get the attribute of the index on the remote process.

Returns
The remote attribute.

◆ localIndexPair()

template<typename T1 , typename T2 >
const IndexPair< T1, ParallelLocalIndex< T2 > > & Dune::RemoteIndex< T1, T2 >::localIndexPair ( ) const
inline

Get the corresponding local index pair.

Returns
The corresponding local index pair.

◆ operator!=()

template<typename T1 , typename T2 >
bool Dune::RemoteIndex< T1, T2 >::operator!= ( const RemoteIndex< T1, T2 > &  ri) const
inline

◆ operator==()

template<typename T1 , typename T2 >
bool Dune::RemoteIndex< T1, T2 >::operator== ( const RemoteIndex< T1, T2 > &  ri) const
inline

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