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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/PetscSF/PetscSFSetGraph.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscSFSetGraph</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/PetscSF/PetscSFSetGraph.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscSFSetGraph"><H1>PetscSFSetGraph</H1></A>
Set a parallel star forest
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsf.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../PetscSF/PetscSFSetGraph.html#PetscSFSetGraph">PetscSFSetGraph</A>(<A HREF="../PetscSF/PetscSF.html#PetscSF">PetscSF</A> sf,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> nroots,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> nleaves,const <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *ilocal,<A HREF="../Sys/PetscCopyMode.html#PetscCopyMode">PetscCopyMode</A> localmode,const <A HREF="../PetscSF/PetscSFNode.html#PetscSFNode">PetscSFNode</A> *iremote,<A HREF="../Sys/PetscCopyMode.html#PetscCopyMode">PetscCopyMode</A> remotemode)
</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>sf </B></TD><TD>- star forest
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>nroots </B></TD><TD>- number of root vertices on the current process (these are possible targets for other process to attach leaves)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>nleaves </B></TD><TD>- number of leaf vertices on the current process, each of these references a root on any process
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ilocal </B></TD><TD>- locations of leaves in leafdata buffers, pass NULL for contiguous storage
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>localmode </B></TD><TD>- copy mode for ilocal
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>iremote </B></TD><TD>- remote locations of root vertices for each leaf on the current process
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>remotemode </B></TD><TD>- copy mode for iremote
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
In Fortran you must use <A HREF="../Sys/PetscCopyMode.html#PetscCopyMode">PETSC_COPY_VALUES</A> for localmode and remotemode
<P>
Developers Note: Local indices which are the identity permutation in the range [0,nleaves) are discarded as they
encode contiguous storage. In such case, if localmode is <A HREF="../Sys/PetscCopyMode.html#PetscCopyMode">PETSC_OWN_POINTER</A>, the memory is deallocated as it is not
needed
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../PetscSF/PetscSFCreate.html#PetscSFCreate">PetscSFCreate</A>(), <A HREF="../PetscSF/PetscSFView.html#PetscSFView">PetscSFView</A>(), <A HREF="../PetscSF/PetscSFGetGraph.html#PetscSFGetGraph">PetscSFGetGraph</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/vec/is/sf/interface/sf.c.html#PetscSFSetGraph">src/vec/is/sf/interface/sf.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/vec/is/sf/examples/tutorials/ex1.c.html">src/vec/is/sf/examples/tutorials/ex1.c.html</A><BR>
<A HREF="../../../src/vec/is/sf/examples/tutorials/ex2.c.html">src/vec/is/sf/examples/tutorials/ex2.c.html</A><BR>
<A HREF="../../../src/vec/is/sf/examples/tutorials/ex1f.F90.html">src/vec/is/sf/examples/tutorials/ex1f.F90.html</A><BR>
<A HREF="../../../src/dm/examples/tutorials/swarm_ex3.c.html">src/dm/examples/tutorials/swarm_ex3.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex11.c.html">src/ts/examples/tutorials/ex11.c.html</A><BR>
<BR><A HREF="./index.html">Index of all PetscSF 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>
|
