Files
cpp-thirdparty/linx64/mpi/openmpi/share/man/man3/shmem_finalize.3
Bassem Girgis 81b4b9e273 Initial commit
2018-12-20 17:34:07 -06:00

48 lines
1.5 KiB
Groff

.\" -*- nroff -*-
.\" Copyright (c) 2015 University of Houston. All rights reserved.
.\" Copyright (c) 2015 Mellanox Technologies, Inc.
.\" $COPYRIGHT$
.de Vb
.ft CW
.nf
..
.de Ve
.ft R
.fi
..
.TH "SHMEM\\_FINALIZE" "3" "Aug 22, 2018" "3.1.2" "Open MPI"
.SH NAME
shmem_finalize
\- A collective operation that releases resources used by the OpenSHMEM library.
This only terminates the Open-SHMEM portion of a program, not the entire program.
.SH SYNOPSIS
C or C++:
.Vb
#include <mpp/shmem.h>
void shmem_finalize(void);
.Ve
Fortran:
.Vb
include 'mpp/shmem.fh'
CALL SHMEM_FINALIZE
.Ve
.SH DESCRIPTION
shmem_finalize
is a collective operation that ends the OpenSHMEM portion of a program previously initialized
by shmem_init and releases resources used by the OpenSHMEM library. This collective operation requires
all PEs to participate in the call. There is an implicit global barrier in shmem_finalize so that pending
communication is completed, and no resources can be released until all PEs have entered shmem_finalize.
shmem_finalize must be the last OpenSHMEM library call encountered in the OpenSHMEM portion of
a program. A call to shmem_finalize will release any resources initialized by a corresponding call to
shmem_init. All processes and threads that represent the PEs will still exist after the call to shmem_finalize
returns, but they will no longer have access to any resources that have been released.
.SH SEE ALSO
\fIintro_shmem\fP(3),
\fIshmem_my_pe\fP(3),
\fIshmem_init\fP(3)