Public Member Functions | Private Attributes | List of all members
oomph::OomphCommunicator Class Reference

An oomph-lib wrapper to the MPI_Comm communicator object. Just contains an MPI_Comm object (which is a pointer) and wrappers to the MPI_... methods. More...

#include <communicator.h>

Public Member Functions

 OomphCommunicator (const MPI_Comm mpi_communicator, const bool &owns_mpi_comm=false)
 Construct a communicator from a MPI_Comm object. if the bool owns_mpi_comm is true then this communicator is responsible for the destruction of the mpi_communicator. The mpi comm will be freed when the destructor is called. More...
 
 OomphCommunicator ()
 Serial constructor. More...
 

Private Attributes

MPI_Comm Comm
 the MPI_Comm communicator More...
 
bool Owns_mpi_comm
 boolean indiacting whether this communicator owns the underlying MPI_Comm - if so the destructor will free the communicator More...
 
bool Serial_communicator
 boolean to indicate if this communicator is for serial problems. This is true when serial codes are compiled under MPI More...
 

Detailed Description

An oomph-lib wrapper to the MPI_Comm communicator object. Just contains an MPI_Comm object (which is a pointer) and wrappers to the MPI_... methods.

Definition at line 53 of file communicator.h.

Constructor & Destructor Documentation

◆ OomphCommunicator() [1/2]

oomph::OomphCommunicator::OomphCommunicator ( const MPI_Comm  mpi_communicator,
const bool &  owns_mpi_comm = false 
)
inline

Construct a communicator from a MPI_Comm object. if the bool owns_mpi_comm is true then this communicator is responsible for the destruction of the mpi_communicator. The mpi comm will be freed when the destructor is called.

Definition at line 61 of file communicator.h.

References Comm, and Owns_mpi_comm.

◆ OomphCommunicator() [2/2]

oomph::OomphCommunicator::OomphCommunicator ( )
inline

Serial constructor.

Definition at line 74 of file communicator.h.

Member Data Documentation

◆ Comm

MPI_Comm oomph::OomphCommunicator::Comm
private

the MPI_Comm communicator

Definition at line 354 of file communicator.h.

Referenced by OomphCommunicator().

◆ Owns_mpi_comm

bool oomph::OomphCommunicator::Owns_mpi_comm
private

boolean indiacting whether this communicator owns the underlying MPI_Comm - if so the destructor will free the communicator

Definition at line 359 of file communicator.h.

Referenced by OomphCommunicator().

◆ Serial_communicator

bool oomph::OomphCommunicator::Serial_communicator
private

boolean to indicate if this communicator is for serial problems. This is true when serial codes are compiled under MPI

Definition at line 363 of file communicator.h.

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