Description

S3L_declare creates an S3L array handle that describes an S3L parallel array . It supports calling arguments that enable the user to specify

• the array's rank (number of dimensions)

• the extent of each axis

• the array's data type

• which axes, if any, will be distributed locally

• how memory will be allocated for the array

Based on the argument-supplied specifications, a process grid size is internaly determined to distribute the array as evenly as possible.

An array subgrid is the set of array elements that is allocated to a particular process.

The axis_is_local argument specifies which array axes (if any) will be local to the process. It consists of an integer vector whose length is at least equal to the rank (number of dimensions) of the array. Each element of the vector indicates whether the corresponding axis is local or not: 1 = local, 0 = not local.

When axis_is_local is ignored, all array axes except the last will be local. The last axis will be block distributed.

For greater control over array distribution, use S3L_declare_detailed().

Upon successful completion, S3L_declare returns an S3L array handle, which subsequent S3L calls can use as an argument to gain access to that array.