VTK  9.0.20210510
Public Member Functions | Static Public Member Functions | List of all members
vtkPPainterCommunicator Class Reference

#include <vtkPPainterCommunicator.h>

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

Public Member Functions

 vtkPPainterCommunicator ()
 
virtual ~vtkPPainterCommunicator ()
 
 vtkPPainterCommunicator (const vtkPPainterCommunicator &other)
 Copier and assignment operators. More...
 
vtkPPainterCommunicatoroperator= (const vtkPPainterCommunicator &other)
 
virtual void Copy (const vtkPainterCommunicator *other, bool ownership)
 Copy the communicator. More...
 
virtual void Duplicate (const vtkPainterCommunicator *other)
 Duplicate the communicator. More...
 
virtual bool GetMPIInitialized ()
 Querry MPI state. More...
 
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. More...
 
virtual int GetRank ()
 Querry MPI for information about the communicator. More...
 
virtual int GetSize ()
 Querry MPI for information about the communicator. More...
 
virtual bool GetIsNull ()
 Querry MPI for information about the communicator. More...
 
virtual int GetWorldRank ()
 Querry MPI for information about the world communicator. More...
 
virtual int GetWorldSize ()
 Querry MPI for information about the world communicator. More...
 
void SetCommunicator (vtkMPICommunicatorOpaqueComm *comm)
 Set/Get the communicator. More...
 
void GetCommunicator (vtkMPICommunicatorOpaqueComm *comm)
 Set/Get the communicator. More...
 
void * GetCommunicator ()
 Set/Get the communicator. More...
 
- Public Member Functions inherited from vtkPainterCommunicator
 vtkPainterCommunicator ()=default
 
virtual ~vtkPainterCommunicator ()=default
 
 vtkPainterCommunicator (const vtkPainterCommunicator &other)
 Copy and assignment operators. More...
 
vtkPainterCommunicatoroperator= (const vtkPainterCommunicator &other)
 

Static Public Member Functions

static bool MPIInitialized ()
 
static bool MPIFinalized ()
 
static vtkMPICommunicatorOpaqueComm * GetGlobalCommunicator ()
 Get VTK's world communicator. More...
 

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: