vtkMPIGroup Class Reference
#include <vtkMPIGroup.h>
Inheritance diagram for vtkMPIGroup:
[legend]Collaboration diagram for vtkMPIGroup:
[legend]List of all members.
Detailed Description
Class for creating MPI groups.
This class is used to create MPI groups. A vtkMPIGroup object has to be initialized by passing the controller. Then the group can be modified by adding, removing ids and copying the contents of another group.
- See also:
- vtkMPIController vtkMPICommunicator
- Created by:
-
- CVS contributions (if > 5%):
- Geveci, Berk (91%)
- Schroeder, Will (6%)
- CVS logs (CVSweb):
/Parallel/vtkMPIGroup.h)/Parallel/vtkMPIGroup.cxx)
- Tests:
- vtkMPIGroup (Tests)
Definition at line 50 of file vtkMPIGroup.h.
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkMPIGroup::vtkMPIGroup |
( |
|
) |
[protected] |
|
Member Function Documentation
| virtual const char* vtkMPIGroup::GetClassName |
( |
|
) |
[virtual] |
|
| int vtkMPIGroup::IsTypeOf |
( |
const char * |
type |
) |
[static] |
|
|
|
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject. |
| virtual int vtkMPIGroup::IsA |
( |
const char * |
type |
) |
[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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject. |
|
|
Construct a vtkMPIGroup with the following initial state: Processes = 0, MaximumNumberOfProcesses = 0.
Reimplemented from vtkObject. |
| virtual void vtkMPIGroup::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. |
|
|
Allocate memory for N process ids where N = controller->NumberOfProcesses |
| int vtkMPIGroup::AddProcessId |
( |
int |
processId |
) |
|
|
|
|
Add a process id to the end of the list (if it is not already in the group). Returns non-zero on success. This will not add a process id >= MaximumNumberOfProcessIds. |
| void vtkMPIGroup::RemoveProcessId |
( |
int |
processId |
) |
|
|
|
|
Remove the given process id from the list and shift all ids, starting from the position of the removed id, left by one. |
| int vtkMPIGroup::FindProcessId |
( |
int |
processId |
) |
|
|
|
|
Find the location of a process id in the group. Returns -1 if the process id is not on the list. |
| int vtkMPIGroup::GetProcessId |
( |
int |
pos |
) |
|
|
|
|
Get the process id at position pos. Returns -1 if pos >= max. available pos. |
| void vtkMPIGroup::CopyProcessIdsFrom |
( |
vtkMPIGroup * |
group |
) |
|
|
|
|
Copy the process ids from a given group. This will copy N ids, where N is the smallest MaximumNumberOfProcessIds. |
| int vtkMPIGroup::GetNumberOfProcessIds |
( |
|
) |
[inline] |
|
|
|
Returns the number of ids currently stored.
Definition at line 90 of file vtkMPIGroup.h. |
| void vtkMPIGroup::CopyFrom |
( |
vtkMPIGroup * |
group |
) |
[protected] |
|
|
|
Copies all the information from group, erasing previously stored data. Similar to copy constructor |
| void vtkMPIGroup::Initialize |
( |
int |
numProcIds |
) |
[protected] |
|
|
|
Allocate memory for numProcIds process ids |
Member Data Documentation
The documentation for this class was generated from the following file: