S3L_free_process_grid

Description

S3L_free_process_grid frees the process grid handle returned by a previous call to S3L_set_process_grid.

Syntax

The C and Fortran syntax for S3L_DefineArray are shown below.

C/C++ Syntax

Example 7-13

#include <s3l/s3l-c.h>
#include <s3l/s3l_errno-c.h>
int
S3L_free_process_grid
    S3L_pgrid_t        *pgrid

F77/F90 Syntax

Example 7-14

include `s3l/s3l-f.h'
include `s3l/s3l_errno-f.h'
subroutine
S3L_free_process_grid(pgrid, ier)
    integer*8          pgrid
    integer*4          ier

Input

S3L_free_process_grid accepts the following arguments as input:

• pgrid - The process grid handle returned by a previous call to S3L_set_process_grid.

Output

S3L_free_process_grid uses the following arguments for output:

• ier (Fortran only) - When called from a Fortran program, S3L_free_process_grid returns error status in ier.

Error Handling

On success, S3L_free_process_grid returns S3L_SUCCESS.

On error, the following error code may be returned:

• S3L_PGRID_ERR_NULL - An invalid process grid argument was supplied.

Examples

../examples/s3l/utils/scalapack_conv.c
../examples/s3l/utils-f/scalapack_conv.f

Related Functions

S3L_set_process_grid(3)