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
|
<!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/VecGetArray3dWrite.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>VecGetArray3dWrite</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/VecGetArray3dWrite.html "><small>Report Typos and Errors</small></a></div>
<A NAME="VecGetArray3dWrite"><H1>VecGetArray3dWrite</H1></A>
Returns a pointer to a 3d contiguous array that will contain this processor's portion of the vector data. You MUST call <A HREF="../Vec/VecRestoreArray3dWrite.html#VecRestoreArray3dWrite">VecRestoreArray3dWrite</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/VecGetArray3dWrite.html#VecGetArray3dWrite">VecGetArray3dWrite</A>(<A HREF="../Vec/Vec.html#Vec">Vec</A> x,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> m,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> n,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> p,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> mstart,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> nstart,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> pstart,<A HREF="../Sys/PetscScalar.html#PetscScalar">PetscScalar</A> ***a[])
</PRE>
Logically Collective
<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>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>m </B></TD><TD>- first dimension of three dimensional array
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>n </B></TD><TD>- second dimension of three dimensional array
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>p </B></TD><TD>- third dimension of three dimensional array
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>mstart </B></TD><TD>- first index you will use in first coordinate direction (often 0)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>nstart </B></TD><TD>- first index in the second coordinate direction (often 0)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>pstart </B></TD><TD>- first index in the third coordinate direction (often 0)
</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>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
For a vector obtained from <A HREF="../DM/DMCreateLocalVector.html#DMCreateLocalVector">DMCreateLocalVector</A>() mstart, nstart, and pstart are likely
obtained from the corner indices obtained from <A HREF="../DMDA/DMDAGetGhostCorners.html#DMDAGetGhostCorners">DMDAGetGhostCorners</A>() while for
<A HREF="../DM/DMCreateGlobalVector.html#DMCreateGlobalVector">DMCreateGlobalVector</A>() they are the corner indices from <A HREF="../DMDA/DMDAGetCorners.html#DMDAGetCorners">DMDAGetCorners</A>(). In both cases
the arguments from DMDAGet[Ghost]Corners() are reversed in the call to <A HREF="../Vec/VecGetArray3d.html#VecGetArray3d">VecGetArray3d</A>().
<P>
For standard PETSc vectors this is an inexpensive call; it does not copy the vector values.
<P>
Concepts: vector^accessing local values as 3d array
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Vec/VecGetArray.html#VecGetArray">VecGetArray</A>(), <A HREF="../Vec/VecRestoreArray.html#VecRestoreArray">VecRestoreArray</A>(), <A HREF="../Vec/VecGetArrays.html#VecGetArrays">VecGetArrays</A>(), <A HREF="../Vec/VecGetArrayF90.html#VecGetArrayF90">VecGetArrayF90</A>(), <A HREF="../Vec/VecPlaceArray.html#VecPlaceArray">VecPlaceArray</A>(),
<BR><A HREF="../Vec/VecRestoreArray2d.html#VecRestoreArray2d">VecRestoreArray2d</A>(), DMDAVecGetarray(), <A HREF="../DMDA/DMDAVecRestoreArray.html#DMDAVecRestoreArray">DMDAVecRestoreArray</A>(), <A HREF="../Vec/VecGetArray3d.html#VecGetArray3d">VecGetArray3d</A>(), <A HREF="../Vec/VecRestoreArray3d.html#VecRestoreArray3d">VecRestoreArray3d</A>(),
<A HREF="../Vec/VecGetArray1d.html#VecGetArray1d">VecGetArray1d</A>(), <A HREF="../Vec/VecRestoreArray1d.html#VecRestoreArray1d">VecRestoreArray1d</A>(), <A HREF="../Vec/VecGetArray4d.html#VecGetArray4d">VecGetArray4d</A>(), <A HREF="../Vec/VecRestoreArray4d.html#VecRestoreArray4d">VecRestoreArray4d</A>()
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>developer<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/vec/vec/interface/rvector.c.html#VecGetArray3dWrite">src/vec/vec/interface/rvector.c</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>
</BODY></HTML>
|
