VTK
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Friends
vtkPBGLDistributedGraphHelper Class Reference

end namespace boost::graph::distributed More...

#include <vtkPBGLDistributedGraphHelper.h>

Inheritance diagram for vtkPBGLDistributedGraphHelper:
Inheritance graph
[legend]
Collaboration diagram for vtkPBGLDistributedGraphHelper:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkDistributedGraphHelper Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkPBGLDistributedGraphHelperNewInstance () const
void Synchronize ()
vtkDistributedGraphHelperClone ()
void PrintSelf (ostream &os, vtkIndent indent)
boost::graph::distributed::mpi_process_group GetProcessGroup ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static
vtkPBGLDistributedGraphHelper
SafeDownCast (vtkObjectBase *o)
static
vtkPBGLDistributedGraphHelper
New ()

Public Attributes

vtkPBGLDistributedGraphHelperInternalsInternals

Protected Types

enum  Tags {
  FIND_VERTEX_TAG, FIND_EDGE_SOURCE_TARGET_TAG, ADD_VERTEX_NO_REPLY_TAG, ADD_VERTEX_WITH_REPLY_TAG,
  ADD_VERTEX_PROPS_NO_REPLY_TAG, ADD_VERTEX_PROPS_WITH_REPLY_TAG, ADD_DIRECTED_BACK_EDGE_TAG, ADD_UNDIRECTED_BACK_EDGE_TAG,
  ADD_DIRECTED_EDGE_NO_REPLY_TAG, ADD_UNDIRECTED_EDGE_NO_REPLY_TAG, ADD_DIRECTED_EDGE_WITH_REPLY_TAG, ADD_UNDIRECTED_EDGE_WITH_REPLY_TAG,
  ADD_DIRECTED_EDGE_NI_NO_REPLY_TAG, ADD_UNDIRECTED_EDGE_NI_NO_REPLY_TAG, ADD_DIRECTED_EDGE_NI_WITH_REPLY_TAG, ADD_UNDIRECTED_EDGE_NI_WITH_REPLY_TAG,
  ADD_DIRECTED_EDGE_IN_NO_REPLY_TAG, ADD_UNDIRECTED_EDGE_IN_NO_REPLY_TAG, ADD_DIRECTED_EDGE_NN_NO_REPLY_TAG, ADD_UNDIRECTED_EDGE_NN_NO_REPLY_TAG
}

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkPBGLDistributedGraphHelper ()
 ~vtkPBGLDistributedGraphHelper ()
void AddVertexInternal (const vtkVariant &pedigreeId, vtkIdType *vertex)
vtkIdType FindVertex (const vtkVariant &pedigreeId)
void AddVertexInternal (vtkVariantArray *propertyArr, vtkIdType *vertex)
void AddEdgeInternal (vtkIdType u, vtkIdType v, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)
void AddEdgeInternal (const vtkVariant &uPedigreeId, vtkIdType v, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)
void AddEdgeInternal (vtkIdType u, const vtkVariant &vPedigreeId, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)
void AddEdgeInternal (const vtkVariant &uPedigreeId, const vtkVariant &vPedigreeId, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)
void FindEdgeSourceAndTarget (vtkIdType id, vtkIdType *source, vtkIdType *target)
void AttachToGraph (vtkGraph *graph)

Friends

class vtkPBGLDistributedGraphHelperInternals

Detailed Description

end namespace boost::graph::distributed

helper for the vtkGraph class that provides support for the Parallel Boost Graph Library

vtkPBGLDistributedGraphHelper is a helper class that allows a vtkGraph object to be distributed across several different processors using the Parallel Boost Graph Library (Parallel BGL, or PBGL). When attached to a vtkGraph instance, vtkPBGLDistributedGraphHelper provides the necessary communication support to build and manipulate distributed graphs. To enable the use of this class, you will need to configure VTK with the VTK_USE_PARALLEL_BGL option.

.SEEALSO vtkGraph vtkDistributedGraphHelper

Tests:
vtkPBGLDistributedGraphHelper (Tests)

Definition at line 54 of file vtkPBGLDistributedGraphHelper.h.


Member Typedef Documentation

Reimplemented from vtkDistributedGraphHelper.

Definition at line 57 of file vtkPBGLDistributedGraphHelper.h.


Member Enumeration Documentation

Enumerator:
FIND_VERTEX_TAG 
FIND_EDGE_SOURCE_TARGET_TAG 
ADD_VERTEX_NO_REPLY_TAG 
ADD_VERTEX_WITH_REPLY_TAG 
ADD_VERTEX_PROPS_NO_REPLY_TAG 
ADD_VERTEX_PROPS_WITH_REPLY_TAG 
ADD_DIRECTED_BACK_EDGE_TAG 
ADD_UNDIRECTED_BACK_EDGE_TAG 
ADD_DIRECTED_EDGE_NO_REPLY_TAG 
ADD_UNDIRECTED_EDGE_NO_REPLY_TAG 
ADD_DIRECTED_EDGE_WITH_REPLY_TAG 
ADD_UNDIRECTED_EDGE_WITH_REPLY_TAG 
ADD_DIRECTED_EDGE_NI_NO_REPLY_TAG 
ADD_UNDIRECTED_EDGE_NI_NO_REPLY_TAG 
ADD_DIRECTED_EDGE_NI_WITH_REPLY_TAG 
ADD_UNDIRECTED_EDGE_NI_WITH_REPLY_TAG 
ADD_DIRECTED_EDGE_IN_NO_REPLY_TAG 
ADD_UNDIRECTED_EDGE_IN_NO_REPLY_TAG 
ADD_DIRECTED_EDGE_NN_NO_REPLY_TAG 
ADD_UNDIRECTED_EDGE_NN_NO_REPLY_TAG 

Definition at line 91 of file vtkPBGLDistributedGraphHelper.h.


Constructor & Destructor Documentation


Member Function Documentation

static int vtkPBGLDistributedGraphHelper::IsTypeOf ( const char *  name) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDistributedGraphHelper.

virtual int vtkPBGLDistributedGraphHelper::IsA ( const char *  name) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDistributedGraphHelper.

Reimplemented from vtkDistributedGraphHelper.

virtual vtkObjectBase* vtkPBGLDistributedGraphHelper::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkDistributedGraphHelper.

Reimplemented from vtkDistributedGraphHelper.

Creates an empty Parallel BGL distributed graph helper

Reimplemented from vtkObject.

Synchronizes all of the processors involved in this distributed graph, so that all processors have a consistent view of the distributed graph for the computation that follows. This routine should be invoked after adding new edges into the distributed graph, so that other processors will see those edges (or their corresponding back-edges).

Implements vtkDistributedGraphHelper.

Clones this distributed graph helper.

Implements vtkDistributedGraphHelper.

boost::graph::distributed::mpi_process_group vtkPBGLDistributedGraphHelper::GetProcessGroup ( )

Return the process group associated with this distributed graph.

void vtkPBGLDistributedGraphHelper::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkDistributedGraphHelper.

void vtkPBGLDistributedGraphHelper::AddVertexInternal ( vtkVariantArray propertyArr,
vtkIdType vertex 
) [protected, virtual]

Add a vertex, optionally with properties, to the distributed graph. If vertex is non-NULL, it will be set to the newly-added (or found) vertex. Note that if propertyArr is non-NULL and the vertex data contains pedigree IDs, a vertex will only be added if there is no vertex with that pedigree ID.

Implements vtkDistributedGraphHelper.

void vtkPBGLDistributedGraphHelper::AddVertexInternal ( const vtkVariant pedigreeId,
vtkIdType vertex 
) [protected, virtual]

Add a vertex with the given pedigree ID to the distributed graph. If vertex is non-NULL, it will receive the newly-created vertex.

Implements vtkDistributedGraphHelper.

void vtkPBGLDistributedGraphHelper::AddEdgeInternal ( vtkIdType  u,
vtkIdType  v,
bool  directed,
vtkVariantArray propertyArr,
vtkEdgeType edge 
) [protected, virtual]

Add an edge (u, v) to the distributed graph. The edge may be directed undirected. If edge is non-null, it will receive the newly-created edge. If propertyArr is non-null, it specifies the properties that will be attached to the newly-created edge.

Implements vtkDistributedGraphHelper.

void vtkPBGLDistributedGraphHelper::AddEdgeInternal ( const vtkVariant uPedigreeId,
vtkIdType  v,
bool  directed,
vtkVariantArray propertyArr,
vtkEdgeType edge 
) [protected, virtual]

Adds an edge (u, v) and returns the new edge. The graph edge may or may not be directed, depending on the given flag. If edge is non-null, it will receive the newly-created edge. uPedigreeId is the pedigree ID of vertex u, which will be added if no vertex by that pedigree ID exists. If propertyArr is non-null, it specifies the properties that will be attached to the newly-created edge.

Implements vtkDistributedGraphHelper.

void vtkPBGLDistributedGraphHelper::AddEdgeInternal ( vtkIdType  u,
const vtkVariant vPedigreeId,
bool  directed,
vtkVariantArray propertyArr,
vtkEdgeType edge 
) [protected, virtual]

Adds an edge (u, v) and returns the new edge. The graph edge may or may not be directed, depending on the given flag. If edge is non-null, it will receive the newly-created edge. vPedigreeId is the pedigree ID of vertex u, which will be added if no vertex with that pedigree ID exists. If propertyArr is non-null, it specifies the properties that will be attached to the newly-created edge.

Implements vtkDistributedGraphHelper.

void vtkPBGLDistributedGraphHelper::AddEdgeInternal ( const vtkVariant uPedigreeId,
const vtkVariant vPedigreeId,
bool  directed,
vtkVariantArray propertyArr,
vtkEdgeType edge 
) [protected, virtual]

Adds an edge (u, v) and returns the new edge. The graph edge may or may not be directed, depending on the given flag. If edge is non-null, it will receive the newly-created edge. uPedigreeId is the pedigree ID of vertex u and vPedigreeId is the pedigree ID of vertex u, each of which will be added if no vertex by that pedigree ID exists. If propertyArr is non-null, it specifies the properties that will be attached to the newly-created edge.

Implements vtkDistributedGraphHelper.

vtkIdType vtkPBGLDistributedGraphHelper::FindVertex ( const vtkVariant pedigreeId) [protected, virtual]

Try to find the vertex with the given pedigree ID. Returns true and fills in the vertex ID if the vertex is found, and returns false otherwise;

Implements vtkDistributedGraphHelper.

void vtkPBGLDistributedGraphHelper::FindEdgeSourceAndTarget ( vtkIdType  id,
vtkIdType source,
vtkIdType target 
) [protected, virtual]

Determine the source and target of the edge with the given ID. Used internally by vtkGraph::GetSourceVertex and vtkGraph::GetTargetVertex.

Implements vtkDistributedGraphHelper.

void vtkPBGLDistributedGraphHelper::AttachToGraph ( vtkGraph graph) [protected, virtual]

Attach this distributed graph helper to the given graph. This will be called as part of vtkGraph::SetDistributedGraphHelper.

Reimplemented from vtkDistributedGraphHelper.


Friends And Related Function Documentation

Definition at line 223 of file vtkPBGLDistributedGraphHelper.h.


Member Data Documentation

The Parallel BGL-specific internal information for this distributed graph. TODO: Make this protected

Definition at line 82 of file vtkPBGLDistributedGraphHelper.h.


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