A subgroup of processes from a communicator. More...

#include <vtkProcessGroup.h>

Inheritance diagram for vtkProcessGroup:

Collaboration diagram for vtkProcessGroup:

Public Types
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. More...

vtkProcessGroup *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	SetCommunicator (vtkCommunicator *communicator)
	Set the communicator. More...

int	GetProcessId (int pos)
	Given a position in the group, returns the id of the process in the communicator this group is based on. More...

int	GetLocalProcessId ()
	Get the process id for the local process (as defined by the group's communicator). More...

int	FindProcessId (int processId)
	Given a process id in the communicator, this method returns its location in the group or -1 if it is not in the group. More...

int	AddProcessId (int processId)
	Add a process id to the end of the group (if it is not already in the group). More...

int	RemoveProcessId (int processId)
	Remove the given process id from the group (assuming it is in the group). More...

void	RemoveAllProcessIds ()
	Removes all the processes ids from the group, leaving the group empty. More...

void	Copy (vtkProcessGroup *group)
	Copies the given group's communicator and process ids. More...


void	Initialize (vtkMultiProcessController *controller)
	Initialize the group to the given controller or communicator. More...

void	Initialize (vtkCommunicator *communicator)
	Initialize the group to the given controller or communicator. More...


virtual vtkCommunicator *	GetCommunicator ()
	Get the communicator on which this group is based on. More...


virtual int	GetNumberOfProcessIds ()
	Returns the size of this group (the number of processes defined in it). More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output. More...

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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

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

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

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes. More...

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

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

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not. More...

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkProcessGroup *	SafeDownCast (vtkObjectBase *o)

static vtkProcessGroup *	New ()

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

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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

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

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

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

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkProcessGroup ()

	~vtkProcessGroup () 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. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int *	ProcessIds

int	NumberOfProcessIds

vtkCommunicator *	Communicator

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

A subgroup of processes from a communicator.

This class is used for creating groups of processes. A vtkProcessGroup is initialized by passing the controller or communicator on which the group is based off of. You can then use the group to subset and reorder the processes. Eventually, you can pass the group object to the CreateSubController method of vtkMultiProcessController to create a controller for the defined group of processes. You must use the same controller (or attached communicator) from which this group was initialized with.

See also: vtkMultiProcessController, vtkCommunicator

Thanks:: This class was originally written by Kenneth Moreland (kmore.nosp@m.l@sa.nosp@m.ndia..nosp@m.gov) from Sandia National Laboratories.

Tests:: vtkProcessGroup (Tests)

Definition at line 42 of file vtkProcessGroup.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkProcessGroup::Superclass

Definition at line 45 of file vtkProcessGroup.h.

Constructor & Destructor Documentation

◆ vtkProcessGroup()

vtkProcessGroup::vtkProcessGroup ( )

protected

◆ ~vtkProcessGroup()

vtkProcessGroup::~vtkProcessGroup ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkProcessGroup::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 vtkProcessGroup* vtkProcessGroup::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkProcessGroup::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkProcessGroup* vtkProcessGroup::NewInstance ( ) const

◆ New()

static vtkProcessGroup* vtkProcessGroup::New ( )

static

◆ PrintSelf()

void vtkProcessGroup::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.

◆ Initialize() [1/2]

void vtkProcessGroup::Initialize ( vtkMultiProcessController * controller )

Initialize the group to the given controller or communicator.

The group will be set to contain all of the processes in the controller/communicator in the same order.

◆ Initialize() [2/2]

void vtkProcessGroup::Initialize ( vtkCommunicator * communicator )

Initialize the group to the given controller or communicator.

The group will be set to contain all of the processes in the controller/communicator in the same order.

◆ GetCommunicator()

virtual vtkCommunicator* vtkProcessGroup::GetCommunicator ( )

virtual

Get the communicator on which this group is based on.

◆ SetCommunicator()

void vtkProcessGroup::SetCommunicator ( vtkCommunicator * communicator )

Set the communicator.

This has the same effect as Initialize except that the contents of the group will not be modified (although they may be truncated if the new communicator is smaller than the current group). Note that this can lead to an invalid group if there are values in the group that are not valid in the new communicator.

◆ GetNumberOfProcessIds()

virtual int vtkProcessGroup::GetNumberOfProcessIds ( )

virtual

Returns the size of this group (the number of processes defined in it).

◆ GetProcessId()

int vtkProcessGroup::GetProcessId ( int pos )

inline

Given a position in the group, returns the id of the process in the communicator this group is based on.

For example, if this group contains {6, 2, 8, 1}, then GetProcessId(2) will return 8 and GetProcessId(3) will return 1.

Definition at line 88 of file vtkProcessGroup.h.

◆ GetLocalProcessId()

int vtkProcessGroup::GetLocalProcessId ( )

Get the process id for the local process (as defined by the group's communicator).

Returns -1 if the local process is not in the group.

◆ FindProcessId()

int vtkProcessGroup::FindProcessId ( int processId )

Given a process id in the communicator, this method returns its location in the group or -1 if it is not in the group.

For example, if this group contains {6, 2, 8, 1}, then FindProcessId(2) will return 1 and FindProcessId(3) will return -1.

◆ AddProcessId()

int vtkProcessGroup::AddProcessId ( int processId )

Add a process id to the end of the group (if it is not already in the group).

Returns the location where the id was stored.

◆ RemoveProcessId()

int vtkProcessGroup::RemoveProcessId ( int processId )

Remove the given process id from the group (assuming it is in the group).

All ids to the "right" of the removed id are shifted over. Returns 1 if the process id was removed, 0 if the process id was not in the group in the first place.

◆ RemoveAllProcessIds()

void vtkProcessGroup::RemoveAllProcessIds ( )

Removes all the processes ids from the group, leaving the group empty.

◆ Copy()

void vtkProcessGroup::Copy ( vtkProcessGroup * group )

Copies the given group's communicator and process ids.

Member Data Documentation

◆ ProcessIds

int* vtkProcessGroup::ProcessIds

protected

Definition at line 132 of file vtkProcessGroup.h.

◆ NumberOfProcessIds

int vtkProcessGroup::NumberOfProcessIds

protected

Definition at line 133 of file vtkProcessGroup.h.

◆ Communicator

vtkCommunicator* vtkProcessGroup::Communicator

protected

Definition at line 135 of file vtkProcessGroup.h.

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

Parallel/Core/vtkProcessGroup.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkProcessGroup()

◆ ~vtkProcessGroup()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ New()

◆ PrintSelf()

◆ Initialize() [1/2]

◆ Initialize() [2/2]

◆ GetCommunicator()

◆ SetCommunicator()

◆ GetNumberOfProcessIds()

◆ GetProcessId()

◆ GetLocalProcessId()

◆ FindProcessId()

◆ AddProcessId()

◆ RemoveProcessId()

◆ RemoveAllProcessIds()

◆ Copy()

Member Data Documentation

◆ ProcessIds

◆ NumberOfProcessIds

◆ Communicator