MpiCartesian Class Reference
[PEARL.mpi]

Stores information related to a virtual cartesian MPI topology. More...

#include <MpiCartesian.h>

Inheritance diagram for MpiCartesian:

List of all members.

Public Member Functions
Constructors & destructor
	MpiCartesian (ident_t id, const cart_dims &num_locations, const cart_period &is_periodic, MpiComm *communicator)
Get MPI cartesian topology information
MpiComm *	get_comm () const

---

Detailed Description

Note:

The Communicator object associated with a MPI topology is only referenced and not owned by the corresponding MpiCartesian object. Therefore, it will not be deleted if the MpiCartesian object is released.

---

Constructor & Destructor Documentation

MpiCartesian	(	ident_t	id,
		const cart_dims &	num_locations,
		const cart_period &	is_periodic,
		MpiComm *	communicator
	)

Creates a new instance and initializes its identifier and communicator to the given values id and communicator, respectively.

Parameters:

	id	Topology identifier
	num_locations	Contains the number of locations in each dimension
	is_periodic	Contains boolean values defining whether the corresponding dimension is periodic or not
	communicator	Associated MPI communicator

---

Member Function Documentation

MpiComm * get_comm

(

)

const

Returns the MPI communicator associated to this topology.

Returns:

Associated communicator