Blame www/www3/MPI_Type_create_darray.html

Packit Service c5cf8c
Packit Service c5cf8c
<HTML>
Packit Service c5cf8c
<HEAD>
Packit Service c5cf8c
<META NAME="GENERATOR" CONTENT="DOCTEXT">
Packit Service c5cf8c
<TITLE>MPI_Type_create_darray</TITLE>
Packit Service c5cf8c
</HEAD>
Packit Service c5cf8c
<BODY BGCOLOR="FFFFFF">
Packit Service c5cf8c

MPI_Type_create_darray

Packit Service c5cf8c
Create a datatype representing a distributed array 
Packit Service c5cf8c

Synopsis

Packit Service c5cf8c
Packit Service c5cf8c
int MPI_Type_create_darray(int size,
Packit Service c5cf8c
                           int rank,
Packit Service c5cf8c
                           int ndims,
Packit Service c5cf8c
                           const int array_of_gsizes[],
Packit Service c5cf8c
                           const int array_of_distribs[],
Packit Service c5cf8c
                           const int array_of_dargs[],
Packit Service c5cf8c
                           const int array_of_psizes[],
Packit Service c5cf8c
                           int order, MPI_Datatype oldtype, MPI_Datatype * newtype)
Packit Service c5cf8c
Packit Service c5cf8c

Input Parameters

Packit Service c5cf8c
Packit Service c5cf8c
size
size of process group (positive integer)
Packit Service c5cf8c
Packit Service c5cf8c
rank
rank in process group (nonnegative integer)
Packit Service c5cf8c
Packit Service c5cf8c
ndims
number of array dimensions as well as process grid dimensions (positive integer)
Packit Service c5cf8c
Packit Service c5cf8c
array_of_gsizes
number of elements of type oldtype in each dimension of global array (array of positive integers)
Packit Service c5cf8c
Packit Service c5cf8c
array_of_distribs
distribution of array in each dimension (array of state)
Packit Service c5cf8c
Packit Service c5cf8c
array_of_dargs
distribution argument in each dimension (array of positive integers)
Packit Service c5cf8c
Packit Service c5cf8c
array_of_psizes
size of process grid in each dimension (array of positive integers)
Packit Service c5cf8c
Packit Service c5cf8c
order
array storage order flag (state)
Packit Service c5cf8c
Packit Service c5cf8c
oldtype
old datatype (handle)
Packit Service c5cf8c
Packit Service c5cf8c

Packit Service c5cf8c

Output Parameters

Packit Service c5cf8c
Packit Service c5cf8c
newtype
new datatype (handle)
Packit Service c5cf8c
Packit Service c5cf8c

Packit Service c5cf8c

Thread and Interrupt Safety

Packit Service c5cf8c

Packit Service c5cf8c
This routine is thread-safe.  This means that this routine may be
Packit Service c5cf8c
safely used by multiple threads without the need for any user-provided
Packit Service c5cf8c
thread locks.  However, the routine is not interrupt safe.  Typically,
Packit Service c5cf8c
this is due to the use of memory allocation routines such as <tt>malloc
Packit Service c5cf8c
</tt>or other non-MPICH runtime routines that are themselves not interrupt-safe.
Packit Service c5cf8c

Packit Service c5cf8c

Notes for Fortran

Packit Service c5cf8c
All MPI routines in Fortran (except for <tt>MPI_WTIME</tt> and <tt>MPI_WTICK</tt>) have
Packit Service c5cf8c
an additional argument <tt>ierr</tt> at the end of the argument list.  <tt>ierr
Packit Service c5cf8c
</tt>is an integer and has the same meaning as the return value of the routine
Packit Service c5cf8c
in C.  In Fortran, MPI routines are subroutines, and are invoked with the
Packit Service c5cf8c
<tt>call</tt> statement.
Packit Service c5cf8c

Packit Service c5cf8c
All MPI objects (e.g., <tt>MPI_Datatype</tt>, <tt>MPI_Comm</tt>) are of type <tt>INTEGER
Packit Service c5cf8c
</tt>in Fortran.
Packit Service c5cf8c

Packit Service c5cf8c

Errors

Packit Service c5cf8c

Packit Service c5cf8c
All MPI routines (except <tt>MPI_Wtime</tt> and <tt>MPI_Wtick</tt>) return an error value;
Packit Service c5cf8c
C routines as the value of the function and Fortran routines in the last
Packit Service c5cf8c
argument.  Before the value is returned, the current MPI error handler is
Packit Service c5cf8c
called.  By default, this error handler aborts the MPI job.  The error handler
Packit Service c5cf8c
may be changed with <tt>MPI_Comm_set_errhandler</tt> (for communicators),
Packit Service c5cf8c
<tt>MPI_File_set_errhandler</tt> (for files), and <tt>MPI_Win_set_errhandler</tt> (for
Packit Service c5cf8c
RMA windows).  The MPI-1 routine <tt>MPI_Errhandler_set</tt> may be used but
Packit Service c5cf8c
its use is deprecated.  The predefined error handler
Packit Service c5cf8c
<tt>MPI_ERRORS_RETURN</tt> may be used to cause error values to be returned.
Packit Service c5cf8c
Note that MPI does not guarentee that an MPI program can continue past
Packit Service c5cf8c
an error; however, MPI implementations will attempt to continue whenever
Packit Service c5cf8c
possible.
Packit Service c5cf8c

Packit Service c5cf8c
Packit Service c5cf8c
MPI_SUCCESS
No error; MPI routine completed successfully.
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
MPI_ERR_TYPE
Invalid datatype argument. Additionally, this error can
Packit Service c5cf8c
occur if an uncommitted MPI_Datatype (see <tt>MPI_Type_commit</tt>) is used
Packit Service c5cf8c
in a communication call.
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
MPI_ERR_ARG
Invalid argument. Some argument is invalid and is not
Packit Service c5cf8c
identified by a specific error class (e.g., <tt>MPI_ERR_RANK</tt>).
Packit Service c5cf8c
Packit Service c5cf8c
</BODY></HTML>