al_sz_set.c File Reference

Miscellaneous functions to define the properties of the distributed array by setting various parameters via the isz descriptor. More...

#include "al_hidden.h"

Functions
int	AL_Set_comm (MPI_Comm comm, int isz)
int	AL_Set_dimensions (int ndim, int isz)
int	AL_Set_type (MPI_Datatype type, int nelem, int isz)
int	AL_Set_global_dim (int *gdims, int isz)
int	AL_Set_local_dim (int *ldims, int isz)
int	AL_Set_parallel_dim (int *pardims, int isz)
int	AL_Set_periodic_dim (int *periods, int isz)
int	AL_Set_staggered_dim (int *stagger, int isz)
int	AL_Set_ghosts (int *ghosts, int isz)

Detailed Description

Author

A. Malagoli (University of Chicago)

Date

Jul 17, 1999

Function Documentation

int AL_Set_comm	(	MPI_Comm	comm,
		int	isz
	)

Set the communicator for a distributed array

Parameters

[in]	comm	MPI communicator the array is associated with
[out]	isz	Integer pointer to the input array descriptor

Returns

AL_SUCCESS if the communicator is set correctly, AL_FAILURE otherwise.

int AL_Set_dimensions	(	int	ndim,
		int	isz
	)

Set the dimensions of a distributed array

Parameters

[in]	ndim	Number of dimensions (1 to 5)
[out]	isz	Integer pointer to the input array descriptor

Returns

AL_SUCCESS if the dimensions are set correctly, AL_FAILURE otherwise.

int AL_Set_ghosts	(	int *	ghosts,
		int	isz
	)

Set the ghost points of a distributed array

Parameters

[in]	ghost	Array of integers with size of ghost points in each dimension
[out]	isz	Integer pointer to the input array descriptor

Returns

AL_SUCCESS if the ghost points are set correctly, AL_FAILURE otherwise.

int AL_Set_global_dim	(	int *	gdims,
		int	isz
	)

Set the global dimensions of a distributed array

Parameters

[in]	gdims	Array of integers with global dimensions
[out]	isz	Integer pointer to the input array descriptor

Returns

AL_SUCCESS if the global dimension are set correctly, AL_FAILURE otherwise.

int AL_Set_local_dim	(	int *	ldims,
		int	isz
	)

Set the local dimensions of a distributed array

Parameters

[in]	ldims	Array of integers with local dimensions
[out]	isz	Integer pointer to the input array descriptor

Returns

AL_SUCCESS if the local dimension are set correctly, AL_FAILURE otherwise.

int AL_Set_parallel_dim	(	int *	pardims,
		int	isz
	)

Set the parallel dimensions of a distributed array

Parameters

[in]	pardims	Array of integers with parallel dimensions [AL_TRUE|AL_FALSE]
[out]	isz	Integer pointer to the input array descriptor

Returns

AL_SUCCESS if the parallel dimension are set correctly, AL_FAILURE otherwise.

int AL_Set_periodic_dim	(	int *	periods,
		int	isz
	)

Set the periodic dimensions of a distributed array

Parameters

[in]	periods	Array of integers with periodic dimensions [AL_TRUE|AL_FALSE]
[out]	isz	Integer pointer to the input array descriptor

Returns

AL_SUCCESS if the periodic dimension are set correctly, AL_FAILURE otherwise.

int AL_Set_staggered_dim	(	int *	stagger,
		int	isz
	)

Set the staggered dimensions of a distributed array

Parameters

[in]	stagger	Array of integers with staggered dimensions [AL_TRUE|AL_FALSE]
[out]	isz	Integer pointer to the input array descriptor

Returns

AL_SUCCESS if the staggered dimension are set correctly, AL_FAILURE otherwise.

int AL_Set_type	(	MPI_Datatype	type,
		int	nelem,
		int	isz
	)

Set the basic data type of a distributed array. The data types are identical to the MPI datatypes, and they can be defined as AL_<type> or MPI_<type> (e.g. AL_FLOAT or MPI_FLOAT).

Parameters

[in]	type	Datatype (AL_Datatype or MPI_Datatype)
[in]	nelem	Number of type 'type' elements in array elements
[out]	isz	Integer pointer to the input array descriptor

Returns

AL_SUCCESS if the type is set correctly, AL_FAILURE otherwise.