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
|
<!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/PetscSFGetWindow.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscSFGetWindow</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.7.5 2017-01-01</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.7.5 v3.7.5 docs/manualpages/PetscSF/PetscSFGetWindow.html "><small>Report Typos and Errors</small></a></div>
<A NAME="PetscSFGetWindow"><H1>PetscSFGetWindow</H1></A>
Get a window for use with a given data type
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsf.h"
static PetscErrorCode PetscSFGetWindow(PetscSF sf,MPI_Datatype unit,void *array,PetscBool epoch,PetscMPIInt fenceassert,PetscMPIInt postassert,PetscMPIInt startassert,MPI_Win *win)
</PRE>
Collective on <A HREF="../PetscSF/PetscSF.html#PetscSF">PetscSF</A>
<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>unit </B></TD><TD>- data type
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>array </B></TD><TD>- array to be sent
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>epoch </B></TD><TD>- <A HREF="../Sys/PETSC_TRUE.html#PETSC_TRUE">PETSC_TRUE</A> to acquire the window and start an epoch, <A HREF="../Sys/PETSC_FALSE.html#PETSC_FALSE">PETSC_FALSE</A> to just acquire the window
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>fenceassert </B></TD><TD>- assert parameter for call to MPI_Win_fence(), if PETSCSF_WINDOW_SYNC_FENCE
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>postassert </B></TD><TD>- assert parameter for call to MPI_Win_post(), if PETSCSF_WINDOW_SYNC_ACTIVE
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>startassert </B></TD><TD>- assert parameter for call to MPI_Win_start(), if PETSCSF_WINDOW_SYNC_ACTIVE
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Arguments</FONT></H3>
<DT><B>win </B> -window
<br>
<P>
<P>
<H3><FONT COLOR="#CC3333">Developer Notes</FONT></H3>
This currently always creates a new window. This is more synchronous than necessary. An alternative is to try to
reuse an existing window created with the same array. Another alternative is to maintain a cache of windows and reuse
whichever one is available, by copying the array into it if necessary.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../PetscSF/PetscSFGetRanks.html#PetscSFGetRanks">PetscSFGetRanks</A>(), <A HREF="../PetscSF/PetscSFWindowGetDataTypes.html#PetscSFWindowGetDataTypes">PetscSFWindowGetDataTypes</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>developer
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/vec/is/sf/impls/window/sfwindow.c.html#PetscSFGetWindow">src/vec/is/sf/impls/window/sfwindow.c</A>
<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>
|
