VTK  9.3.20240725
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 ()
 
 ~vtkPPainterCommunicator () override
 
 vtkPPainterCommunicator (const vtkPPainterCommunicator &other)
 Copier and assignment operators.
 
vtkPPainterCommunicatoroperator= (const vtkPPainterCommunicator &other)
 
void Copy (const vtkPainterCommunicator *other, bool ownership) override
 Copy the communicator.
 
void Duplicate (const vtkPainterCommunicator *other) override
 Duplicate the communicator.
 
bool GetMPIInitialized () override
 Query MPI state.
 
bool GetMPIFinalized () override
 
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.
 
int GetRank () override
 Query MPI for information about the communicator.
 
int GetSize () override
 Query MPI for information about the communicator.
 
bool GetIsNull () override
 Query MPI for information about the communicator.
 
int GetWorldRank () override
 Query MPI for information about the world communicator.
 
int GetWorldSize () override
 Query 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.
 
vtkPainterCommunicatoroperator= (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 ()
 Query MPI about the communicator.
 
virtual int GetSize ()
 
virtual bool GetIsNull ()
 
virtual int GetWorldRank ()
 Query MPI about the world communicator.
 
virtual int GetWorldSize ()
 
virtual bool GetMPIInitialized ()
 Query 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 24 of file vtkPPainterCommunicator.h.

Constructor & Destructor Documentation

◆ vtkPPainterCommunicator() [1/2]

vtkPPainterCommunicator::vtkPPainterCommunicator ( )

◆ ~vtkPPainterCommunicator()

vtkPPainterCommunicator::~vtkPPainterCommunicator ( )
override

◆ vtkPPainterCommunicator() [2/2]

vtkPPainterCommunicator::vtkPPainterCommunicator ( const vtkPPainterCommunicator other)
inline

Copier and assignment operators.

Definition at line 33 of file vtkPPainterCommunicator.h.

Member Function Documentation

◆ operator=()

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

Definition at line 39 of file vtkPPainterCommunicator.h.

◆ Copy()

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

Copy the communicator.

Reimplemented from vtkPainterCommunicator.

◆ Duplicate()

void vtkPPainterCommunicator::Duplicate ( const vtkPainterCommunicator other)
overridevirtual

Duplicate the communicator.

Reimplemented from vtkPainterCommunicator.

◆ GetRank()

int vtkPPainterCommunicator::GetRank ( )
overridevirtual

Query MPI for information about the communicator.

Reimplemented from vtkPainterCommunicator.

◆ GetSize()

int vtkPPainterCommunicator::GetSize ( )
overridevirtual

Query MPI for information about the communicator.

Reimplemented from vtkPainterCommunicator.

◆ GetIsNull()

bool vtkPPainterCommunicator::GetIsNull ( )
overridevirtual

Query MPI for information about the communicator.

Reimplemented from vtkPainterCommunicator.

◆ GetWorldRank()

int vtkPPainterCommunicator::GetWorldRank ( )
overridevirtual

Query MPI for information about the world communicator.

Reimplemented from vtkPainterCommunicator.

◆ GetWorldSize()

int vtkPPainterCommunicator::GetWorldSize ( )
overridevirtual

Query MPI for information about the world communicator.

Reimplemented from vtkPainterCommunicator.

◆ GetMPIInitialized()

bool vtkPPainterCommunicator::GetMPIInitialized ( )
inlineoverridevirtual

Query MPI state.

Reimplemented from vtkPainterCommunicator.

Definition at line 75 of file vtkPPainterCommunicator.h.

◆ GetMPIFinalized()

bool vtkPPainterCommunicator::GetMPIFinalized ( )
inlineoverridevirtual

Reimplemented from vtkPainterCommunicator.

Definition at line 76 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: