#include <deal.II/base/mpi.h>

Detailed Description

Helper class to automatically duplicate and free an MPI communicator.

This class duplicates the communicator given in the constructor using duplicate_communicator() and frees it automatically when this object gets destroyed by calling free_communicator(). You can access the wrapped communicator using operator*.

This class exists to easily allow duplicating communicators without having to worry when and how to free it after usage.

Definition at line 259 of file mpi.h.

Public Member Functions
	DuplicatedCommunicator (const MPI_Comm communicator)
	DuplicatedCommunicator (const DuplicatedCommunicator &)=delete
	~DuplicatedCommunicator ()
MPI_Comm	operator* () const
DuplicatedCommunicator &	operator= (const DuplicatedCommunicator &)=delete

Private Attributes
MPI_Comm	comm

Constructor & Destructor Documentation

◆ DuplicatedCommunicator() [1/2]

Utilities::MPI::DuplicatedCommunicator::DuplicatedCommunicator ( const MPI_Comm communicator )

inlineexplicit

Create a duplicate of the given communicator.

Definition at line 265 of file mpi.h.

◆ DuplicatedCommunicator() [2/2]

Utilities::MPI::DuplicatedCommunicator::DuplicatedCommunicator ( const DuplicatedCommunicator & )

delete

Do not allow making copies.

◆ ~DuplicatedCommunicator()

Utilities::MPI::DuplicatedCommunicator::~DuplicatedCommunicator ( )

inline

The destructor will free the communicator automatically.

Definition at line 277 of file mpi.h.

Member Function Documentation

◆ operator*()

MPI_Comm Utilities::MPI::DuplicatedCommunicator::operator* ( ) const

inline

Access the stored communicator.

Definition at line 286 of file mpi.h.

◆ operator=()

DuplicatedCommunicator & Utilities::MPI::DuplicatedCommunicator::operator= ( const DuplicatedCommunicator & )

delete

Do not allow assignment of this class.

Member Data Documentation

◆ comm

MPI_Comm Utilities::MPI::DuplicatedCommunicator::comm

private

The communicator of course.

Definition at line 302 of file mpi.h.

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

include/deal.II/base/mpi.h