pearl::Cartesian Class Reference

Stores information related to cartesian grid topologies. More...

#include <pearl/Cartesian.h>

Inheritance diagram for pearl::Cartesian:

Public Types
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

Public Member Functions
Constructors & destructor
	Cartesian (uint32_t id, const cart_dims &num_locations, const cart_period &is_periodic)
Get & set cartesian topology information
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
Protected Member Functions inherited from pearl::Topology
	Topology (uint32_t id)

Detailed Description

The class Cartesian provides information related to virtual cartesian grid topologies. These grids can have arbitrary dimensions. In addition, each dimension can be periodic or not (e.g., to define a torus topology).

Member Typedef Documentation

cart_coords

typedef std::vector<uint32_t> pearl::Cartesian::cart_coords

cart_dims

typedef std::vector<uint32_t> pearl::Cartesian::cart_dims

cart_period

typedef std::vector<bool> pearl::Cartesian::cart_period

Constructor & Destructor Documentation

Cartesian()

pearl::Cartesian::Cartesian	(	uint32_t	id,
		const cart_dims &	num_locations,
		const cart_period &	is_periodic
	)

Member Function Documentation

get_coords()

void pearl::Cartesian::get_coords	(	const Location &	location,
		cart_coords &	coords
	)		const

get_dimensionv()

void pearl::Cartesian::get_dimensionv

(

cart_dims &

outv

)

const

get_periodv()

void pearl::Cartesian::get_periodv

(

cart_period &

outv

)

const

num_dimensions()

uint32_t pearl::Cartesian::num_dimensions

(

)

const

set_coords()

void pearl::Cartesian::set_coords	(	const Location &	location,
		const cart_coords &	coords
	)

---

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

• Cartesian.h