vtkSubGroup Class Reference

scalable collective communication for a subset of members of a parallel VTK application More...

#include <vtkSubGroup.h>

Inheritance diagram for vtkSubGroup:

Collaboration diagram for vtkSubGroup:

Public Types
enum	{ MINOP = 1, MAXOP = 2, SUMOP = 3 }
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkSubGroup *	NewInstance () const
virtual void	PrintSelf (ostream &os, vtkIndent indent)
int	Initialize (int p0, int p1, int me, int tag, vtkCommunicator *c)
int	Gather (int *data, int *to, int length, int root)
int	Gather (char *data, char *to, int length, int root)
int	Gather (float *data, float *to, int length, int root)
int	Broadcast (float *data, int length, int root)
int	Broadcast (double *data, int length, int root)
int	Broadcast (int *data, int length, int root)
int	Broadcast (char *data, int length, int root)
int	ReduceSum (int *data, int *to, int length, int root)
int	ReduceMax (float *data, float *to, int length, int root)
int	ReduceMax (double *data, double *to, int length, int root)
int	ReduceMax (int *data, int *to, int length, int root)
int	ReduceMin (float *data, float *to, int length, int root)
int	ReduceMin (double *data, double *to, int length, int root)
int	ReduceMin (int *data, int *to, int length, int root)
int	AllReduceUniqueList (int *list, int len, int **newList)
int	MergeSortedUnique (int *list1, int len1, int *list2, int len2, int **newList)
void	setGatherPattern (int root, int length)
int	getLocalRank (int processID)
int	Barrier ()
void	PrintSubGroup () const
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkSubGroup *	SafeDownCast (vtkObjectBase *o)
static vtkSubGroup *	New ()
static int	MakeSortedUnique (int *list, int len, int **newList)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Public Attributes
int	tag

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkSubGroup ()
	~vtkSubGroup ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

scalable collective communication for a subset of members of a parallel VTK application

This class provides scalable broadcast, reduce, etc. using only a vtkMultiProcessController. It does not require MPI. Users are vtkPKdTree and vtkDistributedDataFilter.

Attention

This class will be deprecated soon. Instead of using this class, use the collective and subgrouping operations now built into vtkMultiProcessController. The only reason this class is not deprecated already is because vtkPKdTree relies heavily on this class in ways that are not easy to work around. Since vtkPKdTree is due for a major overhaul anyway, we are leaving things the way they are for now.

See also

vtkPKdTree vtkDistributedDataFilter

Definition at line 50 of file vtkSubGroup.h.

Member Typedef Documentation

typedef vtkObject vtkSubGroup::Superclass

Definition at line 53 of file vtkSubGroup.h.

Member Enumeration Documentation

anonymous enum

Enumerator
MINOP
MAXOP
SUMOP

Definition at line 59 of file vtkSubGroup.h.

Constructor & Destructor Documentation

vtkSubGroup::vtkSubGroup ( )

protected

vtkSubGroup::~vtkSubGroup ( )

protected

Member Function Documentation

static int vtkSubGroup::IsTypeOf ( const char *  type )

static

virtual int vtkSubGroup::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 vtkObject.

static vtkSubGroup* vtkSubGroup::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkSubGroup::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkSubGroup* vtkSubGroup::NewInstance

(

)

const

virtual void vtkSubGroup::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 vtkObject.

static vtkSubGroup* vtkSubGroup::New ( )

static

int vtkSubGroup::Initialize	(	int	p0,
		int	p1,
		int	me,
		int	tag,
		vtkCommunicator *	c
	)

Initialize a communication subgroup for the processes with rank p0 through p1 of the given communicator. (So vtkSubGroup is limited to working with subgroups that are identified by a contiguous set of rank IDs.) The third argument is the callers rank, which must in the range from p0 through p1.

int vtkSubGroup::Gather	(	int *	data,
		int *	to,
		int	length,
		int	root
	)

int vtkSubGroup::Gather	(	char *	data,
		char *	to,
		int	length,
		int	root
	)

int vtkSubGroup::Gather	(	float *	data,
		float *	to,
		int	length,
		int	root
	)

int vtkSubGroup::Broadcast	(	float *	data,
		int	length,
		int	root
	)

int vtkSubGroup::Broadcast	(	double *	data,
		int	length,
		int	root
	)

int vtkSubGroup::Broadcast	(	int *	data,
		int	length,
		int	root
	)

int vtkSubGroup::Broadcast	(	char *	data,
		int	length,
		int	root
	)

int vtkSubGroup::ReduceSum	(	int *	data,
		int *	to,
		int	length,
		int	root
	)

int vtkSubGroup::ReduceMax	(	float *	data,
		float *	to,
		int	length,
		int	root
	)

int vtkSubGroup::ReduceMax	(	double *	data,
		double *	to,
		int	length,
		int	root
	)

int vtkSubGroup::ReduceMax	(	int *	data,
		int *	to,
		int	length,
		int	root
	)

int vtkSubGroup::ReduceMin	(	float *	data,
		float *	to,
		int	length,
		int	root
	)

int vtkSubGroup::ReduceMin	(	double *	data,
		double *	to,
		int	length,
		int	root
	)

int vtkSubGroup::ReduceMin	(	int *	data,
		int *	to,
		int	length,
		int	root
	)

int vtkSubGroup::AllReduceUniqueList	(	int *	list,
		int	len,
		int **	newList
	)

int vtkSubGroup::MergeSortedUnique	(	int *	list1,
		int	len1,
		int *	list2,
		int	len2,
		int **	newList
	)

void vtkSubGroup::setGatherPattern	(	int	root,
		int	length
	)

int vtkSubGroup::getLocalRank

(

int

processID

)

int vtkSubGroup::Barrier

(

)

void vtkSubGroup::PrintSubGroup

(

)

const

static int vtkSubGroup::MakeSortedUnique ( int *  list, int  len, int **  newList  )

static

Member Data Documentation

int vtkSubGroup::tag

Definition at line 102 of file vtkSubGroup.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Parallel/Core/vtkSubGroup.h