vtkPBGLDistributedGraphHelper Class Reference
#include <vtkPBGLDistributedGraphHelper.h>
Detailed Description
end namespace boost::graph::distributedhelper 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
Definition at line 53 of file vtkPBGLDistributedGraphHelper.h.
Member Typedef Documentation
Reimplemented from vtkDistributedGraphHelper.
Definition at line 57 of file vtkPBGLDistributedGraphHelper.h.
Member Enumeration Documentation
enum vtkPBGLDistributedGraphHelper::Tags [protected] |
- Enumerator:
Definition at line 89 of file vtkPBGLDistributedGraphHelper.h.
Constructor & Destructor Documentation
| vtkPBGLDistributedGraphHelper::vtkPBGLDistributedGraphHelper | ( | ) | [protected] |
| vtkPBGLDistributedGraphHelper::~vtkPBGLDistributedGraphHelper | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkPBGLDistributedGraphHelper::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkDistributedGraphHelper.
| 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 vtkTypeRevisionMacro 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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkDistributedGraphHelper.
| static vtkPBGLDistributedGraphHelper* vtkPBGLDistributedGraphHelper::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkDistributedGraphHelper.
| static vtkPBGLDistributedGraphHelper* vtkPBGLDistributedGraphHelper::New | ( | ) | [static] |
Creates an empty Parallel BGL distributed graph helper
Reimplemented from vtkObject.
| void vtkPBGLDistributedGraphHelper::Synchronize | ( | ) | [virtual] |
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.
| vtkDistributedGraphHelper* vtkPBGLDistributedGraphHelper::Clone | ( | ) | [virtual] |
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::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] |
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.
| 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
friend class vtkPBGLDistributedGraphHelperInternals [friend] |
Definition at line 211 of file vtkPBGLDistributedGraphHelper.h.
Member Data Documentation
| vtkPBGLDistributedGraphHelperInternals* vtkPBGLDistributedGraphHelper::Internals |
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:
- dox/Parallel/vtkPBGLDistributedGraphHelper.h
