vtkPPainterCommunicator Class Reference

#include <vtkPPainterCommunicator.h>

Inheritance diagram for vtkPPainterCommunicator:

Collaboration diagram for vtkPPainterCommunicator:

Public Member Functions
	vtkPPainterCommunicator ()
virtual	~vtkPPainterCommunicator ()
	vtkPPainterCommunicator (const vtkPPainterCommunicator &other)
	Copier and assignment operators.
vtkPPainterCommunicator &	operator= (const vtkPPainterCommunicator &other)
virtual void	Copy (const vtkPainterCommunicator *other, bool ownership)
	Copy the communicator.
virtual void	Duplicate (const vtkPainterCommunicator *other)
	Duplicate the communicator.
virtual bool	GetMPIInitialized ()
	Querry MPI state.
virtual bool	GetMPIFinalized ()
void	SubsetCommunicator (vtkMPICommunicatorOpaqueComm *comm, int include)
	Creates a new communicator with/without the calling processes as indicated by the passed in flag, if not 0 the calling process is included in the new communicator.
virtual int	GetRank ()
	Querry MPI for information about the communicator.
virtual int	GetSize ()
	Querry MPI for information about the communicator.
virtual bool	GetIsNull ()
	Querry MPI for information about the communicator.
virtual int	GetWorldRank ()
	Querry MPI for information about the world communicator.
virtual int	GetWorldSize ()
	Querry MPI for information about the world communicator.
void	SetCommunicator (vtkMPICommunicatorOpaqueComm *comm)
	Set/Get the communicator.
void	GetCommunicator (vtkMPICommunicatorOpaqueComm *comm)
	Set/Get the communicator.
void *	GetCommunicator ()
	Set/Get the communicator.
Public Member Functions inherited from vtkPainterCommunicator
	vtkPainterCommunicator ()=default
virtual	~vtkPainterCommunicator ()=default
	vtkPainterCommunicator (const vtkPainterCommunicator &other)
	Copy and assignment operators.
vtkPainterCommunicator &	operator= (const vtkPainterCommunicator &other)
virtual void	Copy (const vtkPainterCommunicator *, bool)
	Copy the communicator, the flag indicates if ownership should be assumed.
virtual void	Duplicate (const vtkPainterCommunicator *)
	Duplicate the communicator.
virtual int	GetRank ()
	Querry MPI about the communicator.
virtual int	GetSize ()
virtual bool	GetIsNull ()
virtual int	GetWorldRank ()
	Querry MPI about the world communicator.
virtual int	GetWorldSize ()
virtual bool	GetMPIInitialized ()
	Querry MPI about its state.
virtual bool	GetMPIFinalized ()

Static Public Member Functions
static bool	MPIInitialized ()
static bool	MPIFinalized ()
static vtkMPICommunicatorOpaqueComm *	GetGlobalCommunicator ()
	Get VTK's world communicator.

Detailed Description

Definition at line 35 of file vtkPPainterCommunicator.h.

Constructor & Destructor Documentation

vtkPPainterCommunicator() [1/2]

vtkPPainterCommunicator::vtkPPainterCommunicator

(

)

~vtkPPainterCommunicator()

virtual vtkPPainterCommunicator::~vtkPPainterCommunicator ( )

virtual

vtkPPainterCommunicator() [2/2]

vtkPPainterCommunicator::vtkPPainterCommunicator ( const vtkPPainterCommunicator &  other )

inline

Copier and assignment operators.

Definition at line 44 of file vtkPPainterCommunicator.h.

Member Function Documentation

operator=()

vtkPPainterCommunicator & vtkPPainterCommunicator::operator= ( const vtkPPainterCommunicator &  other )

inline

Definition at line 50 of file vtkPPainterCommunicator.h.

Copy()

virtual void vtkPPainterCommunicator::Copy ( const vtkPainterCommunicator *  other, bool  ownership  )

virtual

Copy the communicator.

Reimplemented from vtkPainterCommunicator.

Duplicate()

virtual void vtkPPainterCommunicator::Duplicate ( const vtkPainterCommunicator *  other )

virtual

Duplicate the communicator.

Reimplemented from vtkPainterCommunicator.

GetRank()

virtual int vtkPPainterCommunicator::GetRank ( )

virtual

Querry MPI for information about the communicator.

Reimplemented from vtkPainterCommunicator.

GetSize()

virtual int vtkPPainterCommunicator::GetSize ( )

virtual

Querry MPI for information about the communicator.

Reimplemented from vtkPainterCommunicator.

GetIsNull()

virtual bool vtkPPainterCommunicator::GetIsNull ( )

virtual

Querry MPI for information about the communicator.

Reimplemented from vtkPainterCommunicator.

GetWorldRank()

virtual int vtkPPainterCommunicator::GetWorldRank ( )

virtual

Querry MPI for information about the world communicator.

Reimplemented from vtkPainterCommunicator.

GetWorldSize()

virtual int vtkPPainterCommunicator::GetWorldSize ( )

virtual

Querry MPI for information about the world communicator.

Reimplemented from vtkPainterCommunicator.

GetMPIInitialized()

virtual bool vtkPPainterCommunicator::GetMPIInitialized ( )

inlinevirtual

Querry MPI state.

Reimplemented from vtkPainterCommunicator.

Definition at line 86 of file vtkPPainterCommunicator.h.

GetMPIFinalized()

virtual bool vtkPPainterCommunicator::GetMPIFinalized ( )

inlinevirtual

Reimplemented from vtkPainterCommunicator.

Definition at line 87 of file vtkPPainterCommunicator.h.

MPIInitialized()

static bool vtkPPainterCommunicator::MPIInitialized ( )

static

MPIFinalized()

static bool vtkPPainterCommunicator::MPIFinalized ( )

static

SetCommunicator()

void vtkPPainterCommunicator::SetCommunicator

(

vtkMPICommunicatorOpaqueComm *

comm

)

Set/Get the communicator.

Ownership is not assumed thus caller must keep the commuicator alive while this class is in use and free the communicator when finished.

GetCommunicator() [1/2]

void vtkPPainterCommunicator::GetCommunicator

(

vtkMPICommunicatorOpaqueComm *

comm

)

Set/Get the communicator.

Ownership is not assumed thus caller must keep the commuicator alive while this class is in use and free the communicator when finished.

GetCommunicator() [2/2]

void * vtkPPainterCommunicator::GetCommunicator

(

)

Set/Get the communicator.

Ownership is not assumed thus caller must keep the commuicator alive while this class is in use and free the communicator when finished.

SubsetCommunicator()

void vtkPPainterCommunicator::SubsetCommunicator	(	vtkMPICommunicatorOpaqueComm *	comm,
		int	include
	)

Creates a new communicator with/without the calling processes as indicated by the passed in flag, if not 0 the calling process is included in the new communicator.

The new communicator is accessed via GetCommunicator. In parallel this call is mpi collective on the world communicator. In serial this is a no-op.

GetGlobalCommunicator()

static vtkMPICommunicatorOpaqueComm * vtkPPainterCommunicator::GetGlobalCommunicator ( )

static

Get VTK's world communicator.

Return's a null communictor if MPI was not yet initialized.

---

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

• Rendering/ParallelLIC/vtkPPainterCommunicator.h