File: PetscCommBuildTwoSided.html

package info (click to toggle)
petsc 3.14.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 266,472 kB
  • sloc: ansic: 680,898; python: 33,303; cpp: 16,324; makefile: 14,022; f90: 13,731; javascript: 10,713; fortran: 9,581; sh: 1,373; xml: 619; objc: 445; csh: 192; pascal: 148; java: 13
file content (70 lines) | stat: -rw-r--r-- 5,106 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Sys/PetscCommBuildTwoSided.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscCommBuildTwoSided</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>petsc-3.14.5 2021-03-03</b></div>
   <div id="bugreport" align=right><a href="mailto:petsc-maint@mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: petsc-3.14.5 v3.14.5 docs/manualpages/Sys/PetscCommBuildTwoSided.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscCommBuildTwoSided"><H1>PetscCommBuildTwoSided</H1></A>
discovers communicating ranks given one-sided information, moving constant-sized data in the process (often message lengths) 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsys.h"  
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Sys/PetscCommBuildTwoSided.html#PetscCommBuildTwoSided">PetscCommBuildTwoSided</A>(<A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A> comm,<A HREF="../Sys/PetscMPIInt.html#PetscMPIInt">PetscMPIInt</A> count,MPI_Datatype dtype,<A HREF="../Sys/PetscMPIInt.html#PetscMPIInt">PetscMPIInt</A> nto,const <A HREF="../Sys/PetscMPIInt.html#PetscMPIInt">PetscMPIInt</A> *toranks,const void *todata,<A HREF="../Sys/PetscMPIInt.html#PetscMPIInt">PetscMPIInt</A> *nfrom,<A HREF="../Sys/PetscMPIInt.html#PetscMPIInt">PetscMPIInt</A> **fromranks,void *fromdata)
</PRE>
Collective
<P>
<H3><FONT COLOR="#CC3333">Input Arguments</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>comm </B></TD><TD>- communicator
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>count </B></TD><TD>- number of entries to send/receive (must match on all ranks)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>dtype </B></TD><TD>- datatype to send/receive from each rank (must match on all ranks)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>nto </B></TD><TD>- number of ranks to send data to
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>toranks </B></TD><TD>- ranks to send to (array of length nto)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>todata </B></TD><TD>- data to send to each rank (packed)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Arguments</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>nfrom </B></TD><TD>- number of ranks receiving messages from
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>fromranks </B></TD><TD>- ranks receiving messages from (length nfrom; caller should <A HREF="../Sys/PetscFree.html#PetscFree">PetscFree</A>())
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>fromdata </B></TD><TD>- packed data from each rank, each with count entries of type dtype (length nfrom, caller responsible for <A HREF="../Sys/PetscFree.html#PetscFree">PetscFree</A>())
</TD></TR></TABLE>
<P>

<P>
<H3><FONT COLOR="#CC3333">Options Database Keys</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-build_twosided &lt;allreduce|ibarrier|redscatter&gt; </B></TD><TD>- algorithm to set up two-sided communication. Default is allreduce for communicators with &lt;= 1024 ranks, otherwise ibarrier.
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
This memory-scalable interface is an alternative to calling <A HREF="../Sys/PetscGatherNumberOfMessages.html#PetscGatherNumberOfMessages">PetscGatherNumberOfMessages</A>() and
<A HREF="../Sys/PetscGatherMessageLengths.html#PetscGatherMessageLengths">PetscGatherMessageLengths</A>(), possibly with a subsequent round of communication to send other constant-size data.
<P>
Basic data types as well as contiguous types are supported, but non-contiguous (e.g., strided) types are not.
<P>
<H3><FONT COLOR="#CC3333">References</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>1. </B></TD><TD>- Hoefler, Siebert and Lumsdaine, The MPI_Ibarrier implementation uses the algorithm in
Scalable communication protocols for dynamic sparse data exchange, 2010.
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../Sys/PetscGatherNumberOfMessages.html#PetscGatherNumberOfMessages">PetscGatherNumberOfMessages</A>(), <A HREF="../Sys/PetscGatherMessageLengths.html#PetscGatherMessageLengths">PetscGatherMessageLengths</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>developer<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/sys/utils/mpits.c.html#PetscCommBuildTwoSided">src/sys/utils/mpits.c</A>
<BR><A HREF="./index.html">Index of all Sys routines</A>
<BR><A HREF="../../index.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
</BODY></HTML>