vtkMPI4PyCommunicator.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkMPI4PyCommunicator_h
#define vtkMPI4PyCommunicator_h
// This class should only be wrapped for Python. The hierarchy "wrapping" also
// needs to see the class for use in the Python wrappers.
#if !defined(__VTK_WRAP__) || defined(__VTK_WRAP_HIERARCHY__) || defined(__VTK_WRAP_PYTHON__)
 
#include "vtkPython.h" // For PyObject*; must be first
 
#include "vtkObject.h"
#include "vtkParallelMPI4PyModule.h" // For export macro
 
VTK_ABI_NAMESPACE_BEGIN
class vtkMPICommunicator;
 
class VTKPARALLELMPI4PY_EXPORT vtkMPI4PyCommunicator : public vtkObject
{
public:
  vtkTypeMacro(vtkMPI4PyCommunicator, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  static vtkMPI4PyCommunicator* New();
  vtkMPI4PyCommunicator();

  static PyObject* ConvertToPython(vtkMPICommunicator* comm);

  static vtkMPICommunicator* ConvertToVTK(PyObject* comm);
 
private:
  vtkMPI4PyCommunicator(const vtkMPI4PyCommunicator&) = delete;
  void operator=(const vtkMPI4PyCommunicator&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif
#endif