nm_mpi_communicator.h File Reference

declarations for MPI communicators More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
Functions: Communicators
int	MPI_Comm_size (MPI_Comm comm, int *size)
	This function indicates the number of processes involved in a an intracommunicator.
int	MPI_Comm_rank (MPI_Comm comm, int *rank)
	This function gives the rank of the process in the particular communicator's group.
int	MPI_Keyval_create (MPI_Copy_function *copy_fn, MPI_Delete_function *delete_fn, int *keyval, void *extra_state)
int	MPI_Keyval_free (int *keyval)
int	MPI_Attr_get (MPI_Comm comm, int keyval, void *attr_value, int *flag)
	This function returns attributes values from communicators.
int	MPI_Attr_put (MPI_Comm comm, int keyval, void *attr_value)
	Stores attribute value associated with a key.
int	MPI_Attr_delete (MPI_Comm comm, int keyval)
int	MPI_Comm_create_keyval (MPI_Comm_copy_attr_function *comm_copy_attr_fn, MPI_Comm_delete_attr_function *comm_delete_attr_fn, int *comm_keyval, void *extra_state)
int	MPI_Comm_free_keyval (int *comm_keyval)
int	MPI_Comm_get_attr (MPI_Comm comm, int comm_keyval, void *attr_value, int *flag)
int	MPI_Comm_set_attr (MPI_Comm comm, int comm_keyval, void *attr_value)
int	MPI_Comm_delete_attr (MPI_Comm comm, int comm_keyval)
int	MPI_Comm_set_info (MPI_Comm comm, MPI_Info info)
int	MPI_Comm_get_info (MPI_Comm comm, MPI_Info *info_used)
int	MPI_Comm_create (MPI_Comm comm, MPI_Group group, MPI_Comm *newcomm)
	Creates a new communicator.
int	MPI_Comm_create_group (MPI_Comm comm, MPI_Group group, int tag, MPI_Comm *newcomm)
int	MPI_Comm_create_from_group (MPI_Group group, const char *stringtag, MPI_Info info, MPI_Errhandler errhandler, MPI_Comm *newcomm)
int	MPI_Comm_group (MPI_Comm comm, MPI_Group *group)
	Returns a handle to the group of the given communicator.
int	MPI_Comm_split (MPI_Comm comm, int color, int key, MPI_Comm *newcomm)
	Partitions the group associated to the communicator into disjoint subgroups, one for each value of color.
int	MPI_Comm_split_type (MPI_Comm comm, int split_type, int key, MPI_Info info, MPI_Comm *newcomm)
	Partitions the group associated to the communicator into disjoint subgroups, based on the type specified by split_type.
int	MPI_Comm_dup (MPI_Comm comm, MPI_Comm *newcomm)
	Creates a new intracommunicator with the same fixed attributes as the input intracommunicator.
int	MPI_Comm_dup_with_info (MPI_Comm comm, MPI_Info info, MPI_Comm *newcomm)
int	MPI_Comm_free (MPI_Comm *comm)
	Marks the communication object for deallocation.
int	MPI_Comm_test_inter (MPI_Comm comm, int *flag)
	Tests to see if a comm is an inter-communicator.
int	MPI_Comm_set_name (MPI_Comm comm, char *comm_name)
int	MPI_Comm_get_name (MPI_Comm comm, char *comm_name, int *resultlen)
int	MPI_Comm_get_parent (MPI_Comm *parent)
int	MPI_Comm_remote_group (MPI_Comm comm, MPI_Group *group)
int	MPI_Comm_remote_size (MPI_Comm comm, int *size)
int	MPI_Intercomm_create (MPI_Comm local_comm, int local_leader, MPI_Comm peer_comm, int remote_leader, int tag, MPI_Comm *newintercomm)
int	MPI_Intercomm_merge (MPI_Comm intercomm, int high, MPI_Comm *newcomm)
int	MPI_Comm_compare (MPI_Comm comm1, MPI_Comm comm2, int *result)
	Compares two communicators.

Detailed Description

declarations for MPI communicators

Definition in file nm_mpi_communicator.h.

Function Documentation

MPI_Attr_delete()

int MPI_Attr_delete	(	MPI_Comm	comm,
		int	keyval
	)

MPI_Attr_get()

int MPI_Attr_get	(	MPI_Comm	comm,
		int	keyval,
		void *	attr_value,
		int *	flag
	)

This function returns attributes values from communicators.

MPI_Attr_put()

int MPI_Attr_put	(	MPI_Comm	comm,
		int	keyval,
		void *	attr_value
	)

Stores attribute value associated with a key.

MPI_Comm_compare()

int MPI_Comm_compare	(	MPI_Comm	comm1,
		MPI_Comm	comm2,
		int *	result
	)

Compares two communicators.

MPI_Comm_create()

int MPI_Comm_create	(	MPI_Comm	comm,
		MPI_Group	group,
		MPI_Comm *	newcomm
	)

Creates a new communicator.

Parameters

comm	communicator
group	group, which is a subset of the group of comm
newcomm	new communicator

MPI_Comm_create_from_group()

int MPI_Comm_create_from_group	(	MPI_Group	group,
		const char *	stringtag,
		MPI_Info	info,
		MPI_Errhandler	errhandler,
		MPI_Comm *	newcomm
	)

MPI_Comm_create_group()

int MPI_Comm_create_group	(	MPI_Comm	comm,
		MPI_Group	group,
		int	tag,
		MPI_Comm *	newcomm
	)

MPI_Comm_create_keyval()

int MPI_Comm_create_keyval	(	MPI_Comm_copy_attr_function *	comm_copy_attr_fn,
		MPI_Comm_delete_attr_function *	comm_delete_attr_fn,
		int *	comm_keyval,
		void *	extra_state
	)

MPI_Comm_delete_attr()

int MPI_Comm_delete_attr	(	MPI_Comm	comm,
		int	comm_keyval
	)

MPI_Comm_dup()

int MPI_Comm_dup	(	MPI_Comm	comm,
		MPI_Comm *	newcomm
	)

Creates a new intracommunicator with the same fixed attributes as the input intracommunicator.

Parameters

comm	communicator
newcomm	copy of comm

Returns

MPI status

MPI_Comm_dup_with_info()

int MPI_Comm_dup_with_info	(	MPI_Comm	comm,
		MPI_Info	info,
		MPI_Comm *	newcomm
	)

MPI_Comm_free()

int MPI_Comm_free

(

MPI_Comm *

comm

)

Marks the communication object for deallocation.

Parameters

comm	communicator to be destroyed

Returns

MPI status

MPI_Comm_free_keyval()

int MPI_Comm_free_keyval

(

int *

comm_keyval

)

MPI_Comm_get_attr()

int MPI_Comm_get_attr	(	MPI_Comm	comm,
		int	comm_keyval,
		void *	attr_value,
		int *	flag
	)

MPI_Comm_get_info()

int MPI_Comm_get_info	(	MPI_Comm	comm,
		MPI_Info *	info_used
	)

MPI_Comm_get_name()

int MPI_Comm_get_name	(	MPI_Comm	comm,
		char *	comm_name,
		int *	resultlen
	)

MPI_Comm_get_parent()

int MPI_Comm_get_parent

(

MPI_Comm *

parent

)

MPI_Comm_group()

int MPI_Comm_group	(	MPI_Comm	comm,
		MPI_Group *	group
	)

Returns a handle to the group of the given communicator.

Parameters

comm	communicator
group	group corresponding to comm

Returns

MPI status

MPI_Comm_rank()

int MPI_Comm_rank	(	MPI_Comm	comm,
		int *	rank
	)

This function gives the rank of the process in the particular communicator's group.

Parameters

comm	communicator
rank	rank of the calling process in group of comm

Returns

MPI status

MPI_Comm_remote_group()

int MPI_Comm_remote_group	(	MPI_Comm	comm,
		MPI_Group *	group
	)

MPI_Comm_remote_size()

int MPI_Comm_remote_size	(	MPI_Comm	comm,
		int *	size
	)

MPI_Comm_set_attr()

int MPI_Comm_set_attr	(	MPI_Comm	comm,
		int	comm_keyval,
		void *	attr_value
	)

MPI_Comm_set_info()

int MPI_Comm_set_info	(	MPI_Comm	comm,
		MPI_Info	info
	)

MPI_Comm_set_name()

int MPI_Comm_set_name	(	MPI_Comm	comm,
		char *	comm_name
	)

MPI_Comm_size()

int MPI_Comm_size	(	MPI_Comm	comm,
		int *	size
	)

This function indicates the number of processes involved in a an intracommunicator.

Parameters

comm	communicator
size	number of processes in the group of comm

Returns

MPI status

MPI_Comm_split()

int MPI_Comm_split	(	MPI_Comm	comm,
		int	color,
		int	key,
		MPI_Comm *	newcomm
	)

Partitions the group associated to the communicator into disjoint subgroups, one for each value of color.

Parameters

comm	communicator
color	control of subset assignment
key	control of rank assigment
newcomm	new communicator

Returns

MPI status

MPI_Comm_split_type()

int MPI_Comm_split_type	(	MPI_Comm	comm,
		int	split_type,
		int	key,
		MPI_Info	info,
		MPI_Comm *	newcomm
	)

Partitions the group associated to the communicator into disjoint subgroups, based on the type specified by split_type.

Each subgroup contains all processes of the same type.

Parameters

comm	communicator
split_type	control of subset assignment
key	control of rank assigment
info	info argument
newcomm	new communicator

Returns

MPI status

MPI_Comm_test_inter()

int MPI_Comm_test_inter	(	MPI_Comm	comm,
		int *	flag
	)

Tests to see if a comm is an inter-communicator.

Parameters

comm	communicator to test
flag	true if this is an inter-communicator

MPI_Intercomm_create()

int MPI_Intercomm_create	(	MPI_Comm	local_comm,
		int	local_leader,
		MPI_Comm	peer_comm,
		int	remote_leader,
		int	tag,
		MPI_Comm *	newintercomm
	)

MPI_Intercomm_merge()

int MPI_Intercomm_merge	(	MPI_Comm	intercomm,
		int	high,
		MPI_Comm *	newcomm
	)

MPI_Keyval_create()

int MPI_Keyval_create	(	MPI_Copy_function *	copy_fn,
		MPI_Delete_function *	delete_fn,
		int *	keyval,
		void *	extra_state
	)

MPI_Keyval_free()

int MPI_Keyval_free

(

int *

keyval

)