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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/DMDA/DMDAGetNeighbors.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMDAGetNeighbors</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/DMDA/DMDAGetNeighbors.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMDAGetNeighbors"><H1>DMDAGetNeighbors</H1></A>
Gets an array containing the MPI rank of all the current processes neighbors.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscdmda.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../DMDA/DMDAGetNeighbors.html#DMDAGetNeighbors">DMDAGetNeighbors</A>(<A HREF="../DM/DM.html#DM">DM</A> da,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>da </B></TD><TD>- the <A HREF="../DMDA/DMDA.html#DMDA">DMDA</A> object
</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>ranks </B></TD><TD>- the neighbors ranks, stored with the x index increasing most rapidly.
this process itself is in the list
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
In 2d the array is of length 9, in 3d of length 27
Not supported in 1d
Do not free the array, it is freed when the <A HREF="../DMDA/DMDA.html#DMDA">DMDA</A> is destroyed.
<P>
<H3><FONT COLOR="#CC3333">Fortran Notes</FONT></H3>
In fortran you must pass in an array of the appropriate length.
<P>
<P>
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/dm/impls/da/da.c.html#DMDAGetNeighbors">src/dm/impls/da/da.c</A>
<BR><A HREF="./index.html">Index of all DMDA 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>
|
