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

55 lines
1.1 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\\_PE\\_ACCESSIBLE" "3" "Aug 22, 2018" "3.1.2" "Open MPI"
.SH NAME
shmem_pe_accessible \- Determines whether a processing element (PE) is accessible via
SHMEM data transfer operations.
.SH SYNOPSIS
C:
.Vb
#include <mpp/shmem.h>
int shmem_pe_accessible(int pe);
.Ve
Fortran:
.Vb
INCLUDE "mpp/shmem.fh"
LOGICAL LOG, SHMEM_PE_ACCESSIBLE
INTEGER pe
LOG = SHMEM_PE_ACCESSIBLE(pe)
.Ve
.SH DESCRIPTION
shmem_pe_accessible returns a value that indicates whether the calling PE is able to perform
OpenSHMEM communication operations with the remote PE.
.SH RETURN VALUES
.TP
C/C++
The return value is 1 if the specified PE is a valid remote PE for SHMEM functions;
otherwise,it is 0.
.TP
Fortran
The return value is \&.TRUE. if the specified PE is a valid remote PE for SHMEM
functions; otherwise, it is \&.FALSE..
.PP
.SH SEE ALSO
\fIintro_shmem\fP(3),
\fIshmem_addr_accessible\fP(3)