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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/DM/DMGetNeighbors.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMGetNeighbors</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/DM/DMGetNeighbors.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMGetNeighbors"><H1>DMGetNeighbors</H1></A>
Gets an array containing the MPI rank of all the processes neighbors
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscdm.h"
#include "petscdmlabel.h"
#include "petscds.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../DM/DMGetNeighbors.html#DMGetNeighbors">DMGetNeighbors</A>(<A HREF="../DM/DM.html#DM">DM</A> dm,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *nranks,const <A HREF="../Sys/PetscMPIInt.html#PetscMPIInt">PetscMPIInt</A> *ranks[])
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>dm </B></TD><TD>- The <A HREF="../DM/DM.html#DM">DM</A>
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>nranks </B></TD><TD>- the number of neighbours
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ranks </B></TD><TD>- the neighbors ranks
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Do not free the array, it is freed when the <A HREF="../DM/DM.html#DM">DM</A> is destroyed.
<P>
<P>
.seealso: <A HREF="../DMDA/DMDAGetNeighbors.html#DMDAGetNeighbors">DMDAGetNeighbors</A>(), <A HREF="../PetscSF/PetscSFGetRootRanks.html#PetscSFGetRootRanks">PetscSFGetRootRanks</A>()
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>beginner<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/dm/interface/dm.c.html#DMGetNeighbors">src/dm/interface/dm.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/dm/tutorials/swarm_ex3.c.html">src/dm/tutorials/swarm_ex3.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/dm/impls/da/dacreate.c.html#DMGetNeighbors_DA">DMGetNeighbors_DA in src/dm/impls/da/dacreate.c</A><BR>
<A HREF="../../../src/dm/impls/plex/plexcreate.c.html#DMGetNeighbors_Plex">DMGetNeighbors_Plex in src/dm/impls/plex/plexcreate.c</A><BR>
<A HREF="../../../src/dm/impls/stag/stag.c.html#DMGetNeighbors_Stag">DMGetNeighbors_Stag in src/dm/impls/stag/stag.c</A><BR>
<BR><A HREF="./index.html">Index of all DM 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>
|
