DUNE PDELab (git)

An index present on the local process with an additional attribute flag. More...

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

Public Types

typedef T Attribute
 The type of the attributes. Normally this will be an enumeration like. More...
 

Public Member Functions

 ParallelLocalIndex (const Attribute &attribute, bool isPublic)
 Constructor. More...
 
 ParallelLocalIndex (size_t localIndex, const Attribute &attribute, bool isPublic=true)
 Constructor. More...
 
 ParallelLocalIndex ()
 Parameterless constructor. More...
 
const Attribute attribute () const
 Get the attribute of the index. More...
 
void setAttribute (const Attribute &attribute)
 Set the attribute of the index. More...
 
size_t local () const
 get the local index. More...
 
 operator size_t () const
 Convert to the local index represented by an int.
 
ParallelLocalIndex< Attribute > & operator= (size_t index)
 Assign a new local index. More...
 
bool isPublic () const
 Check whether the index might also be known other processes. More...
 
LocalIndexState state () const
 Get the state. More...
 
void setState (const LocalIndexState &state)
 Set the state. More...
 

Friends

std::ostream & operator<< (std::ostream &os, const ParallelLocalIndex< T > &index)
 Print the local index to a stream. More...
 

Detailed Description

template<typename T>
class Dune::ParallelLocalIndex< T >

An index present on the local process with an additional attribute flag.

Member Typedef Documentation

◆ Attribute

template<typename T >
typedef T Dune::ParallelLocalIndex< T >::Attribute

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

enum Attributes{owner, border, overlap};

Friends And Related Function Documentation

◆ operator<<

template<typename T >
std::ostream & operator<< ( std::ostream &  os,
const ParallelLocalIndex< T > &  index 
)
friend

Print the local index to a stream.

Parameters
osThe output stream to print to.
indexThe index to print.

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 (Nov 23, 23:29, 2024)