pearl::MpiComm Class Reference

Stores information related to an MPI communicator. More...

#include <pearl/MpiComm.h>

Inheritance diagram for pearl::MpiComm:

List of all members.

Public Member Functions
MPI_Comm	getComm () const
	Get MPI communicator handle.
MpiComm *	duplicate () const
Constructors & destructor
	MpiComm (IdType id, const String &name, const MpiGroup &group, MpiComm *parent)
	Constructor.
virtual	~MpiComm ()
	Destructor.
	MpiComm (const MpiComm &comm)
	Copy constructor.

---

Detailed Description

Instances of the MpiComm class provide information about MPI communicators. In addition to the functionality of the base class Communicator, they also provide a "real" MPI communicator handle resembling the one used in the target application.

---

Constructor & Destructor Documentation

pearl::MpiComm::MpiComm	(	IdType	id,
		const String &	name,
		const MpiGroup &	group,
		MpiComm *	parent
	)

Creates a new MPI communicator definition instance and initializes it with the given values.

Parameters:

id	Global communicator identifier
name	Communicator name
group	Associated process group object
parent	Parent communicator (NULL for root communicators or when this information is not available)

virtual pearl::MpiComm::~MpiComm

(

)

[virtual]

Releases all allocated resources and destroys the instance.

pearl::MpiComm::MpiComm

(

const MpiComm &

comm

)

[protected]

Copies the given instance and duplicates the associated MPI communicator handle using MPI_Comm_dup. It is 'protected' to prevent accidental invocation; users need to call MpiComm::duplicate() explicitly to create a communicator copy.

Parameters:

comm	MPI communicator definition to duplicate

---

Member Function Documentation

MpiComm* pearl::MpiComm::duplicate

(

)

const

MPI_Comm pearl::MpiComm::getComm

(

)

const

Returns the MPI communicator handle associated with this communicator object.

Returns:

MPI communicator handle

---

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

• MpiComm.h