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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
<!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/VecGetArray.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>VecGetArray</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/Vec/VecGetArray.html "><small>Report Typos and Errors</small></a></div>
<A NAME="VecGetArray"><H1>VecGetArray</H1></A>
Returns a pointer to a contiguous array that contains this processor's portion of the vector data. For the standard PETSc vectors, <A HREF="../Vec/VecGetArray.html#VecGetArray">VecGetArray</A>() returns a pointer to the local data array and does not use any copies. If the underlying vector data is not stored in a contiguous array this routine will copy the data to a contiguous array and return a pointer to that. You MUST call <A HREF="../Vec/VecRestoreArray.html#VecRestoreArray">VecRestoreArray</A>() when you no longer need access to the array.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscvec.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Vec/VecGetArray.html#VecGetArray">VecGetArray</A>(<A HREF="../Vec/Vec.html#Vec">Vec</A> x,<A HREF="../Sys/PetscScalar.html#PetscScalar">PetscScalar</A> **a)
</PRE>
Logically Collective on <A HREF="../Vec/Vec.html#Vec">Vec</A>
<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>x </B></TD><TD>- the vector
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>a </B></TD><TD>- location to put pointer to the array
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Fortran Note</FONT></H3>
This routine is used differently from Fortran 77
<pre>
<A HREF="../Vec/Vec.html#Vec">Vec</A> x
</pre>
<pre>
<A HREF="../Sys/PetscScalar.html#PetscScalar">PetscScalar</A> x_array(1)
</pre>
<pre>
<A HREF="../Sys/PetscOffset.html#PetscOffset">PetscOffset</A> i_x
</pre>
<pre>
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> ierr
</pre>
<pre>
call <A HREF="../Vec/VecGetArray.html#VecGetArray">VecGetArray</A>(x,x_array,i_x,ierr)
</pre>
<pre>
</pre>
<pre>
Access first local entry in vector with
</pre>
<pre>
value = x_array(i_x + 1)
</pre>
<pre>
</pre>
<pre>
...... other code
</pre>
<pre>
call <A HREF="../Vec/VecRestoreArray.html#VecRestoreArray">VecRestoreArray</A>(x,x_array,i_x,ierr)
</pre>
For Fortran 90 see <A HREF="../Vec/VecGetArrayF90.html#VecGetArrayF90">VecGetArrayF90</A>()
<P>
See the Fortran chapter of the users manual and
petsc/src/snes/tutorials/ex5f.F for details.
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Vec/VecRestoreArray.html#VecRestoreArray">VecRestoreArray</A>(), <A HREF="../Vec/VecGetArrayRead.html#VecGetArrayRead">VecGetArrayRead</A>(), <A HREF="../Vec/VecGetArrays.html#VecGetArrays">VecGetArrays</A>(), <A HREF="../Vec/VecGetArrayF90.html#VecGetArrayF90">VecGetArrayF90</A>(), <A HREF="../Vec/VecGetArrayReadF90.html#VecGetArrayReadF90">VecGetArrayReadF90</A>(), <A HREF="../Vec/VecPlaceArray.html#VecPlaceArray">VecPlaceArray</A>(), <A HREF="../Vec/VecGetArray2d.html#VecGetArray2d">VecGetArray2d</A>(),
<BR><A HREF="../Vec/VecGetArrayPair.html#VecGetArrayPair">VecGetArrayPair</A>(), <A HREF="../Vec/VecRestoreArrayPair.html#VecRestoreArrayPair">VecRestoreArrayPair</A>(), <A HREF="../Vec/VecGetArrayWrite.html#VecGetArrayWrite">VecGetArrayWrite</A>(), <A HREF="../Vec/VecRestoreArrayWrite.html#VecRestoreArrayWrite">VecRestoreArrayWrite</A>()
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>beginner<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/vec/vec/interface/rvector.c.html#VecGetArray">src/vec/vec/interface/rvector.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/vec/vec/utils/tagger/tutorials/ex1.c.html">src/vec/vec/utils/tagger/tutorials/ex1.c.html</A><BR>
<A HREF="../../../src/vec/vec/tutorials/ex3.c.html">src/vec/vec/tutorials/ex3.c.html</A><BR>
<A HREF="../../../src/vec/vec/tutorials/ex6.c.html">src/vec/vec/tutorials/ex6.c.html</A><BR>
<A HREF="../../../src/vec/vec/tutorials/ex9.c.html">src/vec/vec/tutorials/ex9.c.html</A><BR>
<A HREF="../../../src/vec/vec/tutorials/ex18.c.html">src/vec/vec/tutorials/ex18.c.html</A><BR>
<A HREF="../../../src/vec/vec/tutorials/ex19.c.html">src/vec/vec/tutorials/ex19.c.html</A><BR>
<A HREF="../../../src/vec/vec/tutorials/ex21.c.html">src/vec/vec/tutorials/ex21.c.html</A><BR>
<A HREF="../../../src/vec/vec/tutorials/ex4f.F.html">src/vec/vec/tutorials/ex4f.F.html</A><BR>
<A HREF="../../../src/vec/is/sf/tutorials/ex2.c.html">src/vec/is/sf/tutorials/ex2.c.html</A><BR>
<A HREF="../../../src/dm/tutorials/ex5.c.html">src/dm/tutorials/ex5.c.html</A><BR>
<A HREF="../../../src/dm/tutorials/ex6.c.html">src/dm/tutorials/ex6.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/vec/vec/impls/nest/vecnest.c.html#VecGetArray_Nest">VecGetArray_Nest in src/vec/vec/impls/nest/vecnest.c</A><BR>
<A HREF="../../../src/vec/vec/impls/node/vecnode.c.html#VecGetArray_Node">VecGetArray_Node in src/vec/vec/impls/node/vecnode.c</A><BR>
<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>
</BODY></HTML>
|
