VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkMPI4PyCommunicator Class Reference

Class for bridging MPI4Py with vtkMPICommunicator. More...

#include <vtkMPI4PyCommunicator.h>

Inheritance diagram for vtkMPI4PyCommunicator:
[legend]
Collaboration diagram for vtkMPI4PyCommunicator:
[legend]

Public Types

typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkMPI4PyCommunicatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
 vtkMPI4PyCommunicator ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkMPI4PyCommunicatorSafeDownCast (vtkObjectBase *o)
 
static vtkMPI4PyCommunicatorNew ()
 
static PyObjectConvertToPython (vtkMPICommunicator *comm)
 
static vtkMPICommunicatorConvertToVTK (PyObject *comm)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Class for bridging MPI4Py with vtkMPICommunicator.

This class can be used to convert between VTK and MPI4Py communicators.

See also
vtkMPICommunicator

Definition at line 35 of file vtkMPI4PyCommunicator.h.

Member Typedef Documentation

Definition at line 39 of file vtkMPI4PyCommunicator.h.

Constructor & Destructor Documentation

vtkMPI4PyCommunicator::vtkMPI4PyCommunicator ( )

Member Function Documentation

static int vtkMPI4PyCommunicator::IsTypeOf ( const char *  type)
static
virtual int vtkMPI4PyCommunicator::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 vtkObject.

static vtkMPI4PyCommunicator* vtkMPI4PyCommunicator::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkMPI4PyCommunicator::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkObject.

vtkMPI4PyCommunicator* vtkMPI4PyCommunicator::NewInstance ( ) const
void vtkMPI4PyCommunicator::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.

static vtkMPI4PyCommunicator* vtkMPI4PyCommunicator::New ( )
static
static PyObject* vtkMPI4PyCommunicator::ConvertToPython ( vtkMPICommunicator comm)
static

Convert a VTK communicator into an mpi4py communicator.

static vtkMPICommunicator* vtkMPI4PyCommunicator::ConvertToVTK ( PyObject comm)
static

Convert an mpi4py communicator into a VTK communicator.


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