Distributed Memory / Helper functions

Distributed memory helper functions. More...

MPI communicator
void	starneig_mpi_set_comm (MPI_Comm comm)
	Sets a MPI communicator for the library. More...
MPI_Comm	starneig_mpi_get_comm ()
	Returns the library MPI communicator. More...

Broadcast
void	starneig_mpi_broadcast (int root, size_t size, void *buffer)
	Broadcast a buffer. More...
void	starneig_broadcast (int root, size_t size, void *buffer)
	Broadcast a buffer. Deprecated. More...

Detailed Description

Distributed memory helper functions.

Function Documentation

starneig_mpi_set_comm()

void starneig_mpi_set_comm

(

MPI_Comm

comm

)

Sets a MPI communicator for the library.

Should be called before the starneig_node_init() interface function.

Parameters

[in]

comm

The library MPI communicator.

starneig_mpi_get_comm()

MPI_Comm starneig_mpi_get_comm

(

)

Returns the library MPI communicator.

Returns

The library MPI communicator.

starneig_mpi_broadcast()

void starneig_mpi_broadcast	(	int	root,
		size_t	size,
		void *	buffer
	)

Broadcast a buffer.

Parameters

[in]	root	The rank that is going to broadcast the buffer.
[in]	size	The size of the buffer.
[in,out]	buffer	A pointer to the buffer.

starneig_broadcast()

void starneig_broadcast	(	int	root,
		size_t	size,
		void *	buffer
	)

Broadcast a buffer. Deprecated.

Deprecated:

The starneig_broadcast() function has been replaced with the starneig_mpi_broadcast() function. This function will be removed in a future release of the library.