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/Vec/VecCUSPGetArrayRead.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>VecCUSPGetArrayRead</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/Vec/VecCUSPGetArrayRead.html "><small>Report Typos and Errors</small></a></div>
<A NAME="VecCUSPGetArrayRead"><H1>VecCUSPGetArrayRead</H1></A>
Provides read access to the CUSP device vector inside a vector.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
PETSC_EXTERN PetscErrorCode VecCUSPGetArrayRead(Vec v, CUSPARRAY **a)
</PRE>
This function is analogous to <A HREF="../Vec/VecGetArrayRead.html#VecGetArrayRead">VecGetArrayRead</A>(): The CUSP vector
returned by this function points to a consistent view of the vector
data. This may involve a copy operation of data from the host to the
device if the data on the device is out of date. If the device
memory hasn't been allocated previously it will be allocated as part
of this function call. <A HREF="../Vec/VecCUSPGetArrayRead.html#VecCUSPGetArrayRead">VecCUSPGetArrayRead</A>() assumes that the user
will not modify the vector data. This is analogous to intent(in) in
Fortran.
<P>
The CUSP device vector has to be released by calling
<A HREF="../Vec/VecCUSPRestoreArrayRead.html#VecCUSPRestoreArrayRead">VecCUSPRestoreArrayRead</A>(). If the data on the host side was
previously up to date it will remain so, i.e. data on both the device
and the host is up to date. Accessing data on the host side does not
incur a device to host data transfer.
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<DT><B>v </B> -the vector
<br>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<DT><B>a </B> -the CUSP device vector
<br>
<P>
<H3><FONT COLOR="#CC3333">Fortran note</FONT></H3>
This function is not currently available from Fortran.
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Vec/VecCUSPRestoreArrayRead.html#VecCUSPRestoreArrayRead">VecCUSPRestoreArrayRead</A>(), <A HREF="../Vec/VecCUSPGetArrayReadWrite.html#VecCUSPGetArrayReadWrite">VecCUSPGetArrayReadWrite</A>(), <A HREF="../Vec/VecCUSPGetArrayWrite.html#VecCUSPGetArrayWrite">VecCUSPGetArrayWrite</A>(), <A HREF="../Vec/VecCUSPGetArrayReadWrite.html#VecCUSPGetArrayReadWrite">VecCUSPGetArrayReadWrite</A>(), <A HREF="../Vec/VecGetArray.html#VecGetArray">VecGetArray</A>(), <A HREF="../Vec/VecGetArrayRead.html#VecGetArrayRead">VecGetArrayRead</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>intermediate
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/vec/vec/impls/seq/seqcusp/veccusp2.cu#VecCUSPGetArrayRead">src/vec/vec/impls/seq/seqcusp/veccusp2.cu</A>
<BR><A HREF="./index.html">Index of all Vec 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>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/snes/examples/tutorials/ex47cu.cu.html">src/snes/examples/tutorials/ex47cu.cu.html</A><BR>
</BODY></HTML>
|
