ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkDistributedGraphHelper Class Reference

vtkDistributedGraphHelper - helper for the vtkGraph class that allows the graph to be distributed across multiple memory spaces. More...

Inheritance diagram for Kitware.VTK.vtkDistributedGraphHelper:
[legend]
Collaboration diagram for Kitware.VTK.vtkDistributedGraphHelper:
[legend]

List of all members.

Public Member Functions

 vtkDistributedGraphHelper (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
virtual vtkDistributedGraphHelper Clone ()
 Clones the distributed graph helper, returning another distributed graph helper of the same kind that can be used in another vtkGraph.
int GetEdgeIndex (int e_id)
 Returns local index of edge with ID e_id, by masking off top ceil(log2 P) bits of e_id.
int GetEdgeOwner (int e_id)
 Returns owner of edge with ID e_id, by extracting top ceil(log2 P) bits of e_id.
int GetVertexIndex (int v)
 Returns local index of vertex v, by masking off top ceil(log2 P) bits of v.
int GetVertexOwner (int v)
 Returns owner of vertex v, by extracting top ceil(log2 P) bits of v.
override int IsA (string type)
 Undocumented Block.
int MakeDistributedId (int owner, int local)
 Builds a distributed ID consisting of the given owner and the local ID.
new vtkDistributedGraphHelper NewInstance ()
 Undocumented Block.
virtual void Synchronize ()
 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).

Static Public Member Functions

static vtkInformationIntegerKey DISTRIBUTEDEDGEIDS ()
 Information Keys that distributed graphs can append to attribute arrays to flag them as containing distributed IDs. These can be used to let routines that migrate vertices (either repartitioning or collecting graphs to single nodes) to also modify the ids contained in the attribute arrays to maintain consistency.
static vtkInformationIntegerKey DISTRIBUTEDVERTEXIDS ()
 Information Keys that distributed graphs can append to attribute arrays to flag them as containing distributed IDs. These can be used to let routines that migrate vertices (either repartitioning or collecting graphs to single nodes) to also modify the ids contained in the attribute arrays to maintain consistency.
static new int IsTypeOf (string type)
 Undocumented Block.
static new
vtkDistributedGraphHelper 
SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkDistributedGraphHelper"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "25vtkDistributedGraphHelper"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkDistributedGraphHelper_Clone_01 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkDistributedGraphHelper_DISTRIBUTEDEDGEIDS_02 (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkDistributedGraphHelper_DISTRIBUTEDVERTEXIDS_03 (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkDistributedGraphHelper_GetEdgeIndex_04 (HandleRef pThis, int e_id)
static internal int vtkDistributedGraphHelper_GetEdgeOwner_05 (HandleRef pThis, int e_id)
static internal int vtkDistributedGraphHelper_GetVertexIndex_06 (HandleRef pThis, int v)
static internal int vtkDistributedGraphHelper_GetVertexOwner_07 (HandleRef pThis, int v)
static internal int vtkDistributedGraphHelper_IsA_08 (HandleRef pThis, string type)
static internal int vtkDistributedGraphHelper_IsTypeOf_09 (string type)
static internal int vtkDistributedGraphHelper_MakeDistributedId_10 (HandleRef pThis, int owner, int local)
static internal IntPtr vtkDistributedGraphHelper_NewInstance_11 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkDistributedGraphHelper_SafeDownCast_12 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkDistributedGraphHelper_Synchronize_13 (HandleRef pThis)

Static Private Member Functions

static vtkDistributedGraphHelper ()
 Automatically generated type registration mechanics.

Detailed Description

vtkDistributedGraphHelper - helper for the vtkGraph class that allows the graph to be distributed across multiple memory spaces.

Description A distributed graph helper can be attached to an empty vtkGraph object to turn the vtkGraph into a distributed graph, whose vertices and edges are distributed across several different processors. vtkDistributedGraphHelper is an abstract class. Use a subclass of vtkDistributedGraphHelper, such as vtkPBGLDistributedGraphHelper, to build distributed graphs.

The distributed graph helper provides facilities used by vtkGraph to communicate with other processors that store other parts of the same distributed graph. The only user-level functionality provided by vtkDistributedGraphHelper involves this communication among processors and the ability to map between "distributed" vertex and edge IDs and their component parts (processor and local index). For example, the Synchronize() method provides a barrier that allows all processors to catch up to the same point in the code before any processor can leave that Synchronize() call. For example, one would call Synchronize() after adding many edges to a distributed graph, so that all processors can handle the addition of inter-processor edges and continue, after the Synchronize() call, with a consistent view of the distributed graph. For more information about manipulating (distributed) graphs, see the vtkGraph documentation.

vtkGraph


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkDistributedGraphHelper.vtkDistributedGraphHelper ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.


Member Function Documentation

Clones the distributed graph helper, returning another distributed graph helper of the same kind that can be used in another vtkGraph.

Here is the call graph for this function:

override void Kitware.VTK.vtkDistributedGraphHelper.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkObject.

Information Keys that distributed graphs can append to attribute arrays to flag them as containing distributed IDs. These can be used to let routines that migrate vertices (either repartitioning or collecting graphs to single nodes) to also modify the ids contained in the attribute arrays to maintain consistency.

Here is the call graph for this function:

Information Keys that distributed graphs can append to attribute arrays to flag them as containing distributed IDs. These can be used to let routines that migrate vertices (either repartitioning or collecting graphs to single nodes) to also modify the ids contained in the attribute arrays to maintain consistency.

Here is the call graph for this function:

Returns local index of edge with ID e_id, by masking off top ceil(log2 P) bits of e_id.

Returns owner of edge with ID e_id, by extracting top ceil(log2 P) bits of e_id.

Returns local index of vertex v, by masking off top ceil(log2 P) bits of v.

Returns owner of vertex v, by extracting top ceil(log2 P) bits of v.

override int Kitware.VTK.vtkDistributedGraphHelper.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

static new int Kitware.VTK.vtkDistributedGraphHelper.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

int Kitware.VTK.vtkDistributedGraphHelper.MakeDistributedId ( int  owner,
int  local 
)

Builds a distributed ID consisting of the given owner and the local ID.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Here is the call graph for this function:

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).

static internal IntPtr Kitware.VTK.vtkDistributedGraphHelper.vtkDistributedGraphHelper_Clone_01 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkDistributedGraphHelper.vtkDistributedGraphHelper_DISTRIBUTEDEDGEIDS_02 ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkDistributedGraphHelper.vtkDistributedGraphHelper_DISTRIBUTEDVERTEXIDS_03 ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkDistributedGraphHelper.vtkDistributedGraphHelper_GetEdgeIndex_04 ( HandleRef  pThis,
int  e_id 
) [private]
static internal int Kitware.VTK.vtkDistributedGraphHelper.vtkDistributedGraphHelper_GetEdgeOwner_05 ( HandleRef  pThis,
int  e_id 
) [private]
static internal int Kitware.VTK.vtkDistributedGraphHelper.vtkDistributedGraphHelper_GetVertexIndex_06 ( HandleRef  pThis,
int  v 
) [private]
static internal int Kitware.VTK.vtkDistributedGraphHelper.vtkDistributedGraphHelper_GetVertexOwner_07 ( HandleRef  pThis,
int  v 
) [private]
static internal int Kitware.VTK.vtkDistributedGraphHelper.vtkDistributedGraphHelper_IsA_08 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkDistributedGraphHelper.vtkDistributedGraphHelper_MakeDistributedId_10 ( HandleRef  pThis,
int  owner,
int  local 
) [private]
static internal IntPtr Kitware.VTK.vtkDistributedGraphHelper.vtkDistributedGraphHelper_NewInstance_11 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkDistributedGraphHelper.vtkDistributedGraphHelper_SafeDownCast_12 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkDistributedGraphHelper.vtkDistributedGraphHelper_Synchronize_13 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkDistributedGraphHelper.MRClassNameKey = "25vtkDistributedGraphHelper" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

new const string Kitware.VTK.vtkDistributedGraphHelper.MRFullTypeName = "Kitware.VTK.vtkDistributedGraphHelper"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.


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