Dune Core Modules (2.5.2)
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. More... | |
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. More... | |
const PairType & | localIndexPair () const |
Get the corresponding local index pair. More... | |
RemoteIndex () | |
Parameterless Constructor. | |
RemoteIndex (const T2 &attribute, const PairType *local) | |
Constructor. More... | |
RemoteIndex (const T2 &attribute) | |
Constructor. Private as it should only be called from within Indexset. More... | |
Detailed Description
template<typename T1, typename T2>
class Dune::RemoteIndex< T1, 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.
Constructor & Destructor Documentation
◆ RemoteIndex() [1/2]
template<typename T1 , typename T2 >
Dune::RemoteIndex< T1, T2 >::RemoteIndex | ( | const T2 & | attribute, |
const PairType * | local | ||
) |
Constructor.
- Parameters
-
attribute The attribute of the index on the remote processor. local The corresponding local index.
◆ RemoteIndex() [2/2]
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
-
attribute The attribute of the index on the remote processor.
Member Function Documentation
◆ attribute()
template<typename T1 , typename T2 >
|
inline |
Get the attribute of the index on the remote process.
- Returns
- The remote attribute.
◆ localIndexPair()
template<typename T1 , typename T2 >
|
inline |
Get the corresponding local index pair.
- Returns
- The corresponding local index pair.
The documentation for this class was generated from the following file:
- dune/common/parallel/remoteindices.hh
|
Legal Statements / Impressum |
Hosted by TU Dresden |
generated with Hugo v0.111.3
(Nov 12, 23:30, 2024)