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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/PetscThreadComm/PetscThreadCommGetInts.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscThreadCommGetInts</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.4.2 2013-07-02</b></div>
<A NAME="PetscThreadCommGetInts"><H1>PetscThreadCommGetInts</H1></A>
Gets pointers to locations for storing three PetscInts that may be passed to <A HREF="../PetscThreadComm/PetscThreadCommRunKernel.html#PetscThreadCommRunKernel">PetscThreadCommRunKernel</A> to ensure that the scalar values remain valid even after the main thread exits the calling function.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscthreadcomm.h"
PetscErrorCode PetscThreadCommGetInts(MPI_Comm comm,PetscInt **val1, PetscInt **val2, PetscInt **val3)
</PRE>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>comm </B></TD><TD>- the MPI communicator having the thread communicator
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>val1 </B></TD><TD>- pointer to store the first integer value
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>val2 </B></TD><TD>- pointer to store the second integer value
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>val3 </B></TD><TD>- pointer to store the third integer value
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
This is a utility function to ensure that any scalars passed to <A HREF="../PetscThreadComm/PetscThreadCommRunKernel.html#PetscThreadCommRunKernel">PetscThreadCommRunKernel</A> remain
valid even after the main thread exits the calling function. If any scalars need to passed to
<A HREF="../PetscThreadComm/PetscThreadCommRunKernel.html#PetscThreadCommRunKernel">PetscThreadCommRunKernel</A> then these should be first stored in the locations provided by <A HREF="../PetscThreadComm/PetscThreadCommGetInts.html#PetscThreadCommGetInts">PetscThreadCommGetInts</A>()
<P>
Pass NULL if any pointers are not needed.
<P>
Called by the main thread only, not from within kernels
<P>
<H3><FONT COLOR="#CC3333">Typical usage</FONT></H3>
<P>
<A HREF="../Sys/PetscScalar.html#PetscScalar">PetscScalar</A> *valptr;
<A HREF="../PetscThreadComm/PetscThreadCommGetScalars.html#PetscThreadCommGetScalars">PetscThreadCommGetScalars</A>(comm,&valptr,NULL,NULL);
*valptr = alpha; (alpha is the scalar you wish to pass in <A HREF="../PetscThreadComm/PetscThreadCommRunKernel.html#PetscThreadCommRunKernel">PetscThreadCommRunKernel</A>)
<P>
<A HREF="../PetscThreadComm/PetscThreadCommRunKernel.html#PetscThreadCommRunKernel">PetscThreadCommRunKernel</A>(comm,(PetscThreadKernel)kernel_func,3,x,y,valptr);
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../PetscThreadComm/PetscThreadCommRunKernel.html#PetscThreadCommRunKernel">PetscThreadCommRunKernel</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>developer
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/sys/threadcomm/interface/threadcomm.c.html#PetscThreadCommGetInts">src/sys/threadcomm/interface/threadcomm.c</A>
<BR><A HREF="./index.html">Index of all PetscThreadComm 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>
|
