VTK  9.1.20211024
vtkDistributedGraphHelper.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkDistributedGraphHelper.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 /*
16  * Copyright (C) 2008 The Trustees of Indiana University.
17  * Use, modification and distribution is subject to the Boost Software
18  * License, Version 1.0. (See http://www.boost.org/LICENSE_1_0.txt)
19  */
20 
53 #ifndef vtkDistributedGraphHelper_h
54 #define vtkDistributedGraphHelper_h
55 
56 #include "vtkCommonDataModelModule.h" // For export macro
57 #include "vtkObject.h"
58 
59 class vtkDistributedGraphHelperInternals;
60 struct vtkEdgeType;
61 class vtkGraph;
62 class vtkVariant;
63 class vtkVariantArray;
65 
66 // .NAME vtkVertexPedigreeIdDistributionFunction - The type of a
67 // function used to determine how to distribute vertex pedigree IDs
68 // across processors in a vtkGraph. The pedigree ID distribution
69 // function takes the pedigree ID of the vertex and a user-supplied
70 // void pointer and returns a hash value V. A vertex with that
71 // pedigree ID will reside on processor V % P, where P is the number
72 // of processors. This type is used in conjunction with the
73 // vtkDistributedGraphHelper class.
74 typedef vtkIdType (*vtkVertexPedigreeIdDistribution)(const vtkVariant& pedigreeId, void* userData);
75 
76 class VTKCOMMONDATAMODEL_EXPORT vtkDistributedGraphHelper : public vtkObject
77 {
78 public:
80  void PrintSelf(ostream& os, vtkIndent indent) override;
81 
86 
91 
96 
102 
107 
116 
121 
130  virtual void Synchronize() = 0;
131 
138 
140 
150 
151 protected:
154 
162  virtual void AddVertexInternal(vtkVariantArray* propertyArr, vtkIdType* vertex) = 0;
163 
168  virtual void AddVertexInternal(const vtkVariant& pedigreeId, vtkIdType* vertex) = 0;
169 
176  virtual void AddEdgeInternal(
177  vtkIdType u, vtkIdType v, bool directed, vtkVariantArray* propertyArr, vtkEdgeType* edge) = 0;
178 
187  virtual void AddEdgeInternal(const vtkVariant& uPedigreeId, vtkIdType v, bool directed,
188  vtkVariantArray* propertyArr, vtkEdgeType* edge) = 0;
189 
198  virtual void AddEdgeInternal(vtkIdType u, const vtkVariant& vPedigreeId, bool directed,
199  vtkVariantArray* propertyArr, vtkEdgeType* edge) = 0;
200 
210  virtual void AddEdgeInternal(const vtkVariant& uPedigreeId, const vtkVariant& vPedigreeId,
211  bool directed, vtkVariantArray* propertyArr, vtkEdgeType* edge) = 0;
212 
218  virtual vtkIdType FindVertex(const vtkVariant& pedigreeId) = 0;
219 
226 
231  virtual void AttachToGraph(vtkGraph* graph);
232 
237 
242 
247 
252 
257 
261  int procBits;
262 
267 
268 private:
270  void operator=(const vtkDistributedGraphHelper&) = delete;
271 
272  friend class vtkGraph;
273 };
274 
275 #endif // vtkDistributedGraphHelper_h
helper for the vtkGraph class that allows the graph to be distributed across multiple memory spaces.
vtkIdType GetEdgeOwner(vtkIdType e_id) const
Returns owner of edge with ID e_id, by extracting top ceil(log2 P) bits of e_id.
virtual vtkDistributedGraphHelper * Clone()=0
Clones the distributed graph helper, returning another distributed graph helper of the same kind that...
virtual void FindEdgeSourceAndTarget(vtkIdType id, vtkIdType *source, vtkIdType *target)=0
Determine the source and target of the edge with the given ID.
vtkIdType MakeDistributedId(int owner, vtkIdType local)
Builds a distributed ID consisting of the given owner and the local ID.
vtkIdType GetVertexOwner(vtkIdType v) const
Returns owner of vertex v, by extracting top ceil(log2 P) bits of v.
virtual void AddVertexInternal(vtkVariantArray *propertyArr, vtkIdType *vertex)=0
Add a vertex, optionally with properties, to the distributed graph.
static vtkInformationIntegerKey * DISTRIBUTEDEDGEIDS()
Information Keys that distributed graphs can append to attribute arrays to flag them as containing di...
virtual void AddEdgeInternal(vtkIdType u, vtkIdType v, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)=0
Add an edge (u, v) to the distributed graph.
vtkIdType GetEdgeIndex(vtkIdType e_id) const
Returns local index of edge with ID e_id, by masking off top ceil(log2 P) bits of e_id.
virtual void AddEdgeInternal(const vtkVariant &uPedigreeId, const vtkVariant &vPedigreeId, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)=0
Adds an edge (u, v) and returns the new edge.
virtual void AddEdgeInternal(const vtkVariant &uPedigreeId, vtkIdType v, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)=0
Adds an edge (u, v) and returns the new edge.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkVertexPedigreeIdDistribution VertexDistribution
The distribution function used to map a pedigree ID to a processor.
void SetVertexPedigreeIdDistribution(vtkVertexPedigreeIdDistribution Func, void *userData)
Set the pedigreeId -> processor distribution function that determines how vertices are distributed wh...
virtual void AttachToGraph(vtkGraph *graph)
Attach this distributed graph helper to the given graph.
virtual void AddVertexInternal(const vtkVariant &pedigreeId, vtkIdType *vertex)=0
Add a vertex with the given pedigreeId to the distributed graph.
vtkIdType GetVertexOwnerByPedigreeId(const vtkVariant &pedigreeId)
Determine which processor owns the vertex with the given pedigree ID.
virtual void AddEdgeInternal(vtkIdType u, const vtkVariant &vPedigreeId, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)=0
Adds an edge (u, v) and returns the new edge.
vtkIdType signBitMask
Bit mask to speed up decoding graph info {owner,index}.
vtkIdType GetVertexIndex(vtkIdType v) const
Returns local index of vertex v, by masking off top ceil(log2 P) bits of v.
int procBits
Number of bits required to represent # of processors (owner)
virtual vtkIdType FindVertex(const vtkVariant &pedigreeId)=0
Try to find the vertex with the given pedigree ID.
static vtkInformationIntegerKey * DISTRIBUTEDVERTEXIDS()
Information Keys that distributed graphs can append to attribute arrays to flag them as containing di...
void * VertexDistributionUserData
Extra, user-specified data to be passed into the distribution function.
~vtkDistributedGraphHelper() override
vtkGraph * Graph
The graph to which this distributed graph helper is already attached.
vtkIdType highBitShiftMask
Bit mask to speed up decoding graph info {owner,index}.
int indexBits
Number of bits required to represent {vertex,edge} index.
virtual void Synchronize()=0
Synchronizes all of the processors involved in this distributed graph, so that all processors have a ...
Base class for graph data types.
Definition: vtkGraph.h:339
a simple class to control print indentation
Definition: vtkIndent.h:113
Key for integer values in vtkInformation.
abstract base class for most VTK objects
Definition: vtkObject.h:82
An array holding vtkVariants.
A atomic type representing the union of many types.
Definition: vtkVariant.h:155
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
boost::graph_traits< vtkGraph * >::vertex_descriptor target(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
vtkIdType(* vtkVertexPedigreeIdDistribution)(const vtkVariant &pedigreeId, void *userData)
int vtkIdType
Definition: vtkType.h:332