MPI_COMM_DUP_FN(3)

1MPI_COMM_DUP_FN(3)                  LAM/MPI                 MPI_COMM_DUP_FN(3)
2
3
4

NAME

6       MPI_COMM_DUP_FN -  Built-in MPI function to simple-mindedly copy commu‐
7       nicator attributes.
8

SYNOPSIS

10       #include <mpi.h>
11       int MPI_COMM_DUP_FN(MPI_Comm comm, int key, void *extra,
12                          void *attrin, void *attrout, int *flag)
13

INPUT PARAMETERS

15       comm   - communicator (handle)
16       key    - key value (integer)
17       extra  - extra state
18       attrin - in value for attribute
19
20

OUTPUT PARAMETERS

22       attrout
23              - out value for attribute
24       flag   - 1 if attribute copied successfully, 0 otherwise (logical)
25
26

NOTES

28       This function blindly byte-copies attributes on communicators.   It  is
29       the  default  atrribute-copying function for communicators.  This func‐
30       tion will always return MPI_SUCCESS , and flag will always be set to 1.
31
32       The actual copy is performed by the code
33
34       *((void **) attrout) = attrin;
35
36
37       If this simple assignment is not sufficient for  your  attributes,  you
38       will  need  to reassign the attribute-copying function on relevant key‐
39       vals on communicators with the MPI_Comm_keyval_create function.
40
41

NOTES FOR FORTRAN

43       All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK )  have
44       an  additional  argument ierr at the end of the argument list.  ierr is
45       an integer and has the same meaning as the return value of the  routine
46       in  C.   In Fortran, MPI routines are subroutines, and are invoked with
47       the call statement.
48
49       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
50       Fortran.
51
52

MORE INFORMATION

58       For more information, please see the official MPI Forum web site, which
59       contains the text of both the MPI-1 and MPI-2 standards.   These  docu‐
60       ments  contain  detailed  information  about each MPI function (most of
61       which is not duplicated in these man pages).
62
63       http://www.mpi-forum.org/
64
65
66

ACKNOWLEDGEMENTS

68       The LAM Team would like the thank the MPICH Team for the handy  program
69       to  generate  man  pages ("doctext" from ftp://ftp.mcs.anl.gov/pub/sow‐
70       ing/sowing.tar.gz ), the initial formatting, and some initial text  for
71       most of the MPI-1 man pages.
72

LOCATION

74       dupfn.c
75
76
77
78LAM/MPI 7.1.2                      2/23/2006                MPI_COMM_DUP_FN(3)