Dune::Amg::VertexPropertiesGraph< G, VP, VM > Class Template Reference
[Parallel Algebraic Multigrid]

#include <graph.hh>

List of all members.


Detailed Description

template<class G, class VP, class VM = IdentityMap>
class Dune::Amg::VertexPropertiesGraph< G, VP, VM >

Attaches properties to the vertices of a graph.

Public Types

typedef G Graph
 The graph we attach properties to.
typedef Graph::VertexDescriptor VertexDescriptor
 The vertex descriptor.
typedef Graph::EdgeDescriptor EdgeDescriptor
 The edge descritor.
typedef VP VertexProperties
 The type of the properties of the vertices.
typedef VM VertexMap
 The type of the map for converting the VertexDescriptor to std::size_t.
typedef Graph::EdgeIterator EdgeIterator
 The type of the mutable edge iterator.
typedef Graph::ConstEdgeIterator ConstEdgeIterator
 The type of the constant edge iterator.
typedef VertexIteratorT
< VertexPropertiesGraph< Graph,
VertexProperties, VM > > 
VertexIterator
 The type of the mutable Vertex iterator.
typedef VertexIteratorT< const
VertexPropertiesGraph< Graph,
VertexProperties, VM > > 
ConstVertexIterator
 The type of the constant Vertex iterator.

Public Member Functions

EdgeIterator beginEdges (const VertexDescriptor &source)
 Get the mutable edge iterator over edges starting at a vertex.
EdgeIterator endEdges (const VertexDescriptor &source)
 Get the mutable edge iterator over edges starting at a vertex.
ConstEdgeIterator beginEdges (const VertexDescriptor &source) const
 Get the mutable edge iterator over edges starting at a vertex.
ConstEdgeIterator endEdges (const VertexDescriptor &source) const
 Get the mutable edge iterator over edges starting at a vertex.
VertexIterator begin ()
 Get an iterator over the vertices.
VertexIterator end ()
 Get an iterator over the vertices.
ConstVertexIterator begin () const
 Get an iterator over the vertices.
ConstVertexIterator end () const
 Get an iterator over the vertices.
VertexPropertiesgetVertexProperties (const VertexDescriptor &vertex)
 Get the properties associated with a vertex.
const VertexPropertiesgetVertexProperties (const VertexDescriptor &vertex) const
 Get the properties associated with a vertex.
const Graphgraph () const
 Get the graph the properties are attached to.
int noVertices () const
 Get the number of vertices in the graph.
VertexDescriptor maxVertex () const
 Get the maximal vertex descriptor.
 VertexPropertiesGraph (Graph &graph, const VertexMap vmap=VertexMap())
 Constructor.

Member Typedef Documentation

template<class G, class VP, class VM = IdentityMap>
typedef VM Dune::Amg::VertexPropertiesGraph< G, VP, VM >::VertexMap

The type of the map for converting the VertexDescriptor to std::size_t.

Has to provide the following method: std::size_t operator[](const VertexDescriptor& vertex)

The following condition has to be met: Let v1 and v2 be two vertex descriptors with v1 < v2 and map be the index map. Then map[v1]<map[v2] has to hold.


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

Generated on Sun Nov 15 22:29:49 2009 for dune-istl by  doxygen 1.5.6