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

#include <pearl/MpiCartesian.h>

Inheritance diagram for pearl::MpiCartesian:

Public Member Functions
Constructors & destructor
	MpiCartesian (uint32_t id, const cart_dims &num_locations, const cart_period &is_periodic, MpiComm *communicator)

Get MPI cartesian topology information
MpiComm *	get_comm () const

Public Member Functions inherited from pearl::Cartesian
	Cartesian (uint32_t id, const cart_dims &num_locations, const cart_period &is_periodic)

uint32_t	num_dimensions () const

void	get_dimensionv (cart_dims &outv) const

void	get_periodv (cart_period &outv) const

void	get_coords (const Location &location, cart_coords &coords) const

void	set_coords (const Location &location, const cart_coords &coords)

Public Member Functions inherited from pearl::Topology
uint32_t	get_id () const

virtual	~Topology ()

Additional Inherited Members
Public Types inherited from pearl::Cartesian
typedef std::vector< uint32_t >	cart_dims
	Container type for topology dimensions. More...

typedef std::vector< bool >	cart_period
	Container type for topology periodicity. More...

typedef std::vector< uint32_t >	cart_coords

Protected Member Functions inherited from pearl::Topology
	Topology (uint32_t id)

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

pearl::MpiCartesian::MpiCartesian	(	uint32_t	id,
		const cart_dims &	num_locations,
		const cart_period &	is_periodic,
		MpiComm *	communicator
	)

MpiComm* pearl::MpiCartesian::get_comm ( ) const

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