File: DMGetNeighbors.html

package info (click to toggle)
petsc 3.10.3%2Bdfsg1-5
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 209,064 kB
  • sloc: ansic: 587,333; python: 29,696; makefile: 12,445; fortran: 11,626; f90: 9,677; cpp: 8,768; sh: 1,027; xml: 621; objc: 445; csh: 194; java: 13
file content (43 lines) | stat: -rw-r--r-- 2,548 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
<!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.10.3 2018-12-18</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.10.3 v3.10.3 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>
. dm    - The <A HREF="../DM/DM.html#DM">DM</A>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
. nranks - the number of neighbours
. ranks - the neighbors ranks
<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/PetscSFGetRanks.html#PetscSFGetRanks">PetscSFGetRanks</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/examples/tutorials/swarm_ex3.c.html">src/dm/examples/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>
<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>