pearl::MpiGroup Class Reference

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

#include <pearl/MpiGroup.h>

Inheritance diagram for pearl::MpiGroup:

List of all members.

Public Member Functions
MPI_Group	getGroup ()
	Get MPI group handle.
Constructors & destructor
	MpiGroup (IdType id, const String &name, const RankContainer &ranks, bool isSelf, bool isWorld)
	Constructor.
virtual	~MpiGroup ()
	Destructor.
Friends
class	MpiComm

---

Detailed Description

Instances of the MpiGroup class provide information about MPI groups. In addition to the functionality of the base class ProcessGroup, they also provide a "real" MPI group handle resembling the one used in the target application.

---

Constructor & Destructor Documentation

pearl::MpiGroup::MpiGroup	(	IdType	id,
		const String &	name,
		const RankContainer &	ranks,
		bool	isSelf,
		bool	isWorld
	)

Creates a MPI group definition instance and initializes it with the given values. The flags isSelf and isWorld are mutually exclusive, except for single-process experiments.

Parameters:

id	Global MPI group identifier
name	MPI group name
ranks	Ordered list of global process identifiers (i.e., ranks) defining the group
isSelf	Indicates whether this group refers to 'SELF'
isWorld	Indicates whether this group refers to 'WORLD'

virtual pearl::MpiGroup::~MpiGroup

(

)

[virtual]

Releases all allocated resources and destroys the instance.

---

Member Function Documentation

MPI_Group pearl::MpiGroup::getGroup

(

)

Returns the MPI group handle associated with this group object. The MPI group is lazily created on first access and then cached until the instance is destructed.

Returns:

MPI group handle

---

Friends And Related Function Documentation

friend class MpiComm [friend]

---

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

• MpiGroup.h