Partitions

Partitions related utilities. More...

Data Structures
struct	VMPI_Partition_desc
	Structure holding partitions descriptions. More...

Functions
static int	VMPI_Get_partition_id ()
	Returns the unique ID of the current partition. More...
static VMPI_Partition_desc *	VMPI_Get_desc ()
	Returns current partition's descriptions. More...
static int	VMPI_Get_partition_count ()
	Return the number of partitions. More...
static MPI_Comm	VMPI_Get_partition_comm ()
	Returns current partition's communicator. More...
static int	VMPI_Set_partition_name (char *name)
	Used to setup partition name for a given executable. More...
static VMPI_Partition_desc *	VMPI_Get_desc_by_name (char *name)
	Find a descriptions by its name. More...
static VMPI_Partition_desc *	VMPI_Get_desc_by_id (int id)
	Find a descriptions by its ID. More...
void	VMPI_Display_desc (VMPI_Partition_desc *desc)
	Prints all the fields of a partition descriptions. More...
void	VMPI_Display_descs ()
	Display all the partitions descriptions in order. More...

Detailed Description

Partitions related utilities.

Partitions represents the partitioning of MPI processes for a given program.

Function Documentation

void VMPI_Display_desc

(

VMPI_Partition_desc *

desc

)

Prints all the fields of a partition descriptions.

Parameters

desc	The description to be printed

Definition at line 56 of file VMPI.c.

Here is the caller graph for this function:

void VMPI_Display_descs

(

)

Display all the partitions descriptions in order.

Definition at line 69 of file VMPI.c.

Here is the call graph for this function:

Here is the caller graph for this function:

static VMPI_Partition_desc* VMPI_Get_desc ( )

inlinestatic

Returns current partition's descriptions.

Returns

The VMPI_Partition_desc corresponding to the current partition

Definition at line 153 of file VMPI.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static VMPI_Partition_desc* VMPI_Get_desc_by_id ( int  id )

inlinestatic

Find a descriptions by its ID.

Parameters

id	The wanted partition's ID

Returns

The VMPI_Partition_desc corresponding to the partition with ID "id". NULL if not found

Definition at line 247 of file VMPI.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static VMPI_Partition_desc* VMPI_Get_desc_by_name ( char *  name )

inlinestatic

Find a descriptions by its name.

Parameters

name	The wanted partition's name

Returns

The VMPI_Partition_desc corresponding to the partition named "name". NULL if not found

Definition at line 228 of file VMPI.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static MPI_Comm VMPI_Get_partition_comm ( )

inlinestatic

Returns current partition's communicator.

Returns

The MPI_Comm corresponding to the current partition

Definition at line 175 of file VMPI.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static int VMPI_Get_partition_count ( )

inlinestatic

Return the number of partitions.

Returns

The number of partitions

Definition at line 165 of file VMPI.h.

Here is the caller graph for this function:

static int VMPI_Get_partition_id ( )

inlinestatic

Returns the unique ID of the current partition.

Current partition ID is between 0 and VMPI_Get_partition_count()

Returns

The current partition unique ID

Definition at line 142 of file VMPI.h.

Here is the caller graph for this function:

static int VMPI_Set_partition_name ( char *  name )

inlinestatic

Used to setup partition name for a given executable.

IT MUST be called before MPI_Init which will dispatch this information to every processes.

Parameters

name	The new name for the current partition

Returns

VMPI_SUCCESS

Definition at line 189 of file VMPI.h.

Here is the caller graph for this function: