Public Member Functions | List of all members
vtkMaterialInterfaceProcessRing Class Reference

Data structure used to distribute work amongst available processes. More...

#include <vtkMaterialInterfaceProcessRing.h>

Public Member Functions

 vtkMaterialInterfaceProcessRing ()
 
 ~vtkMaterialInterfaceProcessRing ()
 
void Clear ()
 Return the object to an empty state. More...
 
void Initialize (int nProcs)
 Size buffer and point to first element. More...
 
void Initialize (std::vector< vtkMaterialInterfaceProcessLoading > &Q, vtkIdType upperLoadingBound)
 Build from a process loading from a sorted vector of process loading items. More...
 
vtkIdType GetNextId ()
 Get the next process id from the ring. More...
 
void Print ()
 Print the state of the ring. More...
 

Detailed Description

Data structure used to distribute work amongst available processes.

The buffer can be initialized from a process priority queue such that only those processes with loading less than a specified tolerance are included.

Definition at line 20 of file vtkMaterialInterfaceProcessRing.h.

Constructor & Destructor Documentation

◆ vtkMaterialInterfaceProcessRing()

vtkMaterialInterfaceProcessRing::vtkMaterialInterfaceProcessRing ( )

◆ ~vtkMaterialInterfaceProcessRing()

vtkMaterialInterfaceProcessRing::~vtkMaterialInterfaceProcessRing ( )

Member Function Documentation

◆ Clear()

void vtkMaterialInterfaceProcessRing::Clear ( )

Return the object to an empty state.

◆ Initialize() [1/2]

void vtkMaterialInterfaceProcessRing::Initialize ( int  nProcs)

Size buffer and point to first element.

◆ Initialize() [2/2]

void vtkMaterialInterfaceProcessRing::Initialize ( std::vector< vtkMaterialInterfaceProcessLoading > &  Q,
vtkIdType  upperLoadingBound 
)

Build from a process loading from a sorted vector of process loading items.

◆ GetNextId()

vtkIdType vtkMaterialInterfaceProcessRing::GetNextId ( )

Get the next process id from the ring.

◆ Print()

void vtkMaterialInterfaceProcessRing::Print ( )

Print the state of the ring.


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