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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/DMSTAG/DMStagVecGetArray.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMStagVecGetArray</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/DMSTAG/DMStagVecGetArray.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMStagVecGetArray"><H1>DMStagVecGetArray</H1></A>
get access to local array
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../DMSTAG/DMStagVecGetArray.html#DMStagVecGetArray">DMStagVecGetArray</A>(<A HREF="../DM/DM.html#DM">DM</A> dm,<A HREF="../Vec/Vec.html#Vec">Vec</A> vec,void *array)
</PRE>
Logically Collective
<P>
This function returns a (dim+1)-dimensional array for a dim-dimensional
DMStag.
<P>
The first 1-3 dimensions indicate an element in the global
numbering, using the standard C ordering.
<P>
The final dimension in this array corresponds to a degree
of freedom with respect to this element, for example corresponding to
the element or one of its neighboring faces, edges, or vertices.
<P>
For example, for a 3D DMStag, indexing is array[k][j][i][idx], where k is the
index in the z-direction, j is the index in the y-direction, and i is the
index in the x-direction.
<P>
"idx" is obtained with <A HREF="../DMSTAG/DMStagGetLocationSlot.html#DMStagGetLocationSlot">DMStagGetLocationSlot</A>(), since the correct offset
into the (dim+1)-dimensional C array depends on the grid size and the number
of dof stored at each location.
<P>
<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>dm </B></TD><TD>- the DMStag object
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>vec </B></TD><TD>- the <A HREF="../Vec/Vec.html#Vec">Vec</A> object
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>array </B></TD><TD>- the array
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
<A HREF="../DMSTAG/DMStagVecRestoreArray.html#DMStagVecRestoreArray">DMStagVecRestoreArray</A>() must be called, once finished with the array
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../DMSTAG/DMSTAG.html#DMSTAG">DMSTAG</A>, <A HREF="../DMSTAG/DMStagVecGetArrayRead.html#DMStagVecGetArrayRead">DMStagVecGetArrayRead</A>(), <A HREF="../DMSTAG/DMStagGetLocationSlot.html#DMStagGetLocationSlot">DMStagGetLocationSlot</A>(), <A HREF="../DM/DMGetLocalVector.html#DMGetLocalVector">DMGetLocalVector</A>(), <A HREF="../DM/DMCreateLocalVector.html#DMCreateLocalVector">DMCreateLocalVector</A>(), <A HREF="../DM/DMGetGlobalVector.html#DMGetGlobalVector">DMGetGlobalVector</A>(), <A HREF="../DM/DMCreateGlobalVector.html#DMCreateGlobalVector">DMCreateGlobalVector</A>(), <A HREF="../DMDA/DMDAVecGetArray.html#DMDAVecGetArray">DMDAVecGetArray</A>(), <A HREF="../DMDA/DMDAVecGetArrayDOF.html#DMDAVecGetArrayDOF">DMDAVecGetArrayDOF</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>beginner<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/dm/impls/stag/stagutils.c.html#DMStagVecGetArray">src/dm/impls/stag/stagutils.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/dm/impls/stag/tutorials/ex1.c.html">src/dm/impls/stag/tutorials/ex1.c.html</A><BR>
<A HREF="../../../src/dm/impls/stag/tutorials/ex2.c.html">src/dm/impls/stag/tutorials/ex2.c.html</A><BR>
<A HREF="../../../src/dm/impls/stag/tutorials/ex3.c.html">src/dm/impls/stag/tutorials/ex3.c.html</A><BR>
<A HREF="../../../src/dm/impls/stag/tutorials/ex4.c.html">src/dm/impls/stag/tutorials/ex4.c.html</A><BR>
<A HREF="../../../src/dm/impls/stag/tutorials/ex6.c.html">src/dm/impls/stag/tutorials/ex6.c.html</A><BR>
<BR><A HREF="./index.html">Index of all DMSTAG 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>
|
