CMPISGBufferRoot Class Reference

Buffer for MPI scatter/gather, root component. More...

#include <mpisgbuf.h>

Inheritance diagram for CMPISGBufferRoot:

Collaboration diagram for CMPISGBufferRoot:

List of all members.

Public Member Functions
	CMPISGBufferRoot (MPI_Comm, int)
virtual void	clear ()
virtual void	gather ()
virtual void	scatter ()
virtual void	append (int, int)
virtual void	append (double, int)
virtual void	append (const char *, int)
virtual int	pop_int (int)
virtual double	pop_double (int)
virtual void	pop_doubles (int, double *, int)
Public Member Functions inherited from AMPISGBufferRoot
	AMPISGBufferRoot (MPI_Comm)
virtual void	append (const Vec3 &, int)
virtual Vec3	pop_vector (int)
const MPI_Status &	status ()

Additional Inherited Members
Protected Attributes inherited from AMPISGBufferRoot
MPI_Comm	m_comm
	the MPI communicator used for the scatter/gather operations
int	m_rank
	the rank in this communicator
int	m_size
	size of the communicator
int	m_int_increment
int	m_dbl_increment
	the "packing size" of int/double
MPI_Status	m_status

---

Detailed Description

Buffer for MPI scatter/gather, root component.

Author:

Steffen Abe $Revision$ $Date$

---

Constructor & Destructor Documentation

CMPISGBufferRoot::CMPISGBufferRoot	(	MPI_Comm	comm,
		int	buffersize
	)

Constructor for CMPISGBufferRoot

Parameters:

comm	the MPI communicator
buffersize	buffer size per slice

References AMPISGBufferRoot::m_size.

---

Member Function Documentation

void CMPISGBufferRoot::append ( int  i, int  nslice  )

virtual

Append an integer to a given slice of the buffer.

Parameters:

i	the integer
nslice	the nr. of the slice

Warning:

No check for overflow

Implements AMPISGBufferRoot.

References AMPISGBufferRoot::m_comm, and AMPISGBufferRoot::m_size.

void CMPISGBufferRoot::append ( double  d, int  nslice  )

virtual

Append an double to a given slice of the buffer.

Parameters:

d	the double
nslice	the nr. of the slice

Warning:

No check for overflow

Implements AMPISGBufferRoot.

References AMPISGBufferRoot::m_comm, and AMPISGBufferRoot::m_size.

void CMPISGBufferRoot::append ( const char *  str, int  nslice  )

virtual

Append an C string (char*) to a given slice of the buffer.

Parameters:

str	the string
nslice	the nr. of the slice

Warning:

No check for overflow

Implements AMPISGBufferRoot.

References AMPISGBufferRoot::m_comm, and AMPISGBufferRoot::m_size.

void CMPISGBufferRoot::gather ( )

virtual

Get data from all other members of the communicator, using MPI_Gather

Implements AMPISGBufferRoot.

References AMPISGBufferRoot::m_comm, and AMPISGBufferRoot::m_rank.

Referenced by CLatticeMaster::checkNeighbors().

Here is the caller graph for this function:

double CMPISGBufferRoot::pop_double ( int  nslice )

virtual

Pops an double from a given slice of the the buffer.

Parameters:

nslice

the nr. of the slice

Returns:

the double.

Warning:

No check for underflow

Implements AMPISGBufferRoot.

References AMPISGBufferRoot::m_comm.

int CMPISGBufferRoot::pop_int ( int  nslice )

virtual

Pops an integer from a given slice of the the buffer, i.e. it pops the last sizeof(MPI_INT) bytes of the buffer, interpreting them as an int.

Parameters:

nslice

the nr. of the slice

Returns:

the int.

Warning:

No check for underflow

Implements AMPISGBufferRoot.

References AMPISGBufferRoot::m_comm, and AMPISGBufferRoot::m_size.

Referenced by CLatticeMaster::checkNeighbors().

Here is the caller graph for this function:

void CMPISGBufferRoot::scatter ( )

virtual

Send data to all other members of the communicator, using MPI_Scatter

Implements AMPISGBufferRoot.

References AMPISGBufferRoot::m_comm, and AMPISGBufferRoot::m_rank.

---

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

• mpisgbuf.h
• mpisgbuf.cpp