dox/Parallel/vtkMPIGroup.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkMPIGroup.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef __vtkMPIGroup_h
#define __vtkMPIGroup_h

#include "vtkObject.h"

class vtkMPIController;
class vtkMPICommunicator;
class vtkProcessGroup;

#ifndef VTK_REMOVE_LEGACY_CODE
class VTK_PARALLEL_EXPORT vtkMPIGroup : public vtkObject
{

public:

  vtkTypeMacro( vtkMPIGroup,vtkObject);
  
  static vtkMPIGroup* New();
  
  VTK_LEGACY(virtual void PrintSelf(ostream& os, vtkIndent indent));

  VTK_LEGACY(void Initialize(vtkMPIController* controller));

  VTK_LEGACY(int AddProcessId(int processId));

  VTK_LEGACY(void RemoveProcessId(int processId));

  VTK_LEGACY(int FindProcessId(int processId));

  VTK_LEGACY(int GetProcessId(int pos));

  VTK_LEGACY(void CopyProcessIdsFrom(vtkMPIGroup* group));

//BTX

  VTK_LEGACY(int GetNumberOfProcessIds());
//ETX

  void CopyInto(vtkProcessGroup *destination, vtkMPICommunicator *mpiComm);

//BTX

  friend class vtkMPICommunicator;

//ETX

protected:

  void CopyFrom(vtkMPIGroup* group);

  void Initialize(int numProcIds);

  int* ProcessIds;
  int MaximumNumberOfProcessIds;
  int Initialized;
  int CurrentPosition;

  vtkMPIGroup();
  ~vtkMPIGroup();

private:
  vtkMPIGroup(const vtkMPIGroup&);  // Not implemented.
  void operator=(const vtkMPIGroup&);  // Not implemented.
};
#endif

#endif