Dune::ParallelLocalIndex< T > Class Template Reference
[Communication for distributed computing]

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

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

List of all members.

Public Types

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

Public Member Functions

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

Friends

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

Detailed Description

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

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


Member Typedef Documentation

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};
 

Constructor & Destructor Documentation

template<typename T>
Dune::ParallelLocalIndex< T >::ParallelLocalIndex ( const Attribute attribute,
bool  isPublic 
)

Constructor.

The local index will be initialized to 0.

Parameters:
attribute The attribute of the index.
isPublic True if the index might also be known to other processes.
template<typename T>
Dune::ParallelLocalIndex< T >::ParallelLocalIndex ( size_t  localIndex,
const Attribute attribute,
bool  isPublic = true 
)

Constructor.

Parameters:
localIndex The local index.
attribute The attribute of the index.
isPublic True if the index might also be known to other processes.

Friends And Related Function Documentation

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

Print the local index to a stream.

Parameters:
os The output stream to print to.
index The index to print.

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

Generated on Fri Apr 29 2011 with Doxygen (ver 1.7.1) [doxygen-log,error-log].