S3L_UnDefineArray

Description

S3L_UnDefineArray frees the array handle and the associated memory that were set up by a previous call to S3L_DefineArray.

S3L_UnDefineArray does not free the local (process-resident) memory, where the local part of a parallel array is stored. The user is responsible for deallocating local memory assigned to the parallel array before the parallel program exits.

Syntax

The C and Fortran syntax for S3L_UnDefineArray are shown below.

C/C++ Syntax

Example 7-17

#include <s3l/s3l-c.h>
#include <s3l/s3l_errno-c.h>
int
S3L_UnDefineArray(a)
    S3L_array_t         a

F77/F90 Syntax

Example 7-18

include `s3l/s3l-f.h
include `s3l/s3l_errno-f.h'
subroutine
S3L_UnDefineArray(a)
    integer*8          a

Input

S3L_UnDefineArray accepts the following argument as input:

• a - Handle for the parallel S3L array that is to be deallocated. This handle was returned by a previous call to S3L_DefineArray.

Error Handling

S3L_UnDefineArray does not return any value.

Examples

../examples/s3l/api
../examples/s3l/api.f
../examples/s3l/array_utils

Related Functions

S3L_DefineArray(3)
S3L_declare(3)
S3L_declare_detailed(3)
S3L_free(3)