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 Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkSubGroup *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
int	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.
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
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkTypeBool	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 vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Public Attributes
int	tag

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkSubGroup ()
	~vtkSubGroup () override
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	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 51 of file vtkSubGroup.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkSubGroup::Superclass

Definition at line 54 of file vtkSubGroup.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
MINOP
MAXOP
SUMOP

Definition at line 59 of file vtkSubGroup.h.

Constructor & Destructor Documentation

vtkSubGroup()

vtkSubGroup::vtkSubGroup ( )

protected

~vtkSubGroup()

vtkSubGroup::~vtkSubGroup ( )

overrideprotected

Member Function Documentation

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool 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 vtkObjectBase.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkSubGroup::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkSubGroup * vtkSubGroup::NewInstance

(

)

const

PrintSelf()

void vtkSubGroup::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

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.

New()

static vtkSubGroup * vtkSubGroup::New ( )

static

Initialize()

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.

Gather() [1/3]

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

Gather() [2/3]

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

Gather() [3/3]

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

Broadcast() [1/4]

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

Broadcast() [2/4]

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

Broadcast() [3/4]

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

Broadcast() [4/4]

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

ReduceSum()

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

ReduceMax() [1/3]

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

ReduceMax() [2/3]

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

ReduceMax() [3/3]

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

ReduceMin() [1/3]

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

ReduceMin() [2/3]

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

ReduceMin() [3/3]

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

AllReduceUniqueList()

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

MergeSortedUnique()

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

setGatherPattern()

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

getLocalRank()

int vtkSubGroup::getLocalRank

(

int

processID

)

Barrier()

int vtkSubGroup::Barrier

(

)

PrintSubGroup()

void vtkSubGroup::PrintSubGroup

(

)

const

MakeSortedUnique()

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

static

Member Data Documentation

tag

int vtkSubGroup::tag

Definition at line 110 of file vtkSubGroup.h.

---

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

• Parallel/Core/vtkSubGroup.h