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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMIGAVecGetArray</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<A NAME="DMIGAVecGetArray"><H1>DMIGAVecGetArray</H1></A>
Returns a multiple dimension array that shares data with the underlying vector and is indexed using the global dimensions.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscdmiga.h"
PetscErrorCode DMIGAVecGetArray(DM dm, Vec vec, void *array)
</PRE>
Not Collective
<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 IGA
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>vec </B></TD><TD>- the vector, either a vector the same size as one obtained with <A HREF="../DM/DMCreateGlobalVector.html#DMCreateGlobalVector">DMCreateGlobalVector</A>() or <A HREF="../DM/DMCreateLocalVector.html#DMCreateLocalVector">DMCreateLocalVector</A>()
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<DT><B>array </B> -the array
<br>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Call <A HREF="../DM/DMIGAVecRestoreArray.html#DMIGAVecRestoreArray">DMIGAVecRestoreArray</A>() once you have finished accessing the vector entries.
<P>
In C, the indexing is "backwards" from what expects: array[k][j][i] NOT array[i][j][k]!
<P>
If vec is a local vector (obtained with <A HREF="../DM/DMCreateLocalVector.html#DMCreateLocalVector">DMCreateLocalVector</A>() etc) then they ghost point locations are accessable. If it is
a global vector then the ghost points are not accessable. Of course with the local vector you will have had to do the
appropriate <A HREF="../DM/DMLocalToGlobalBegin.html#DMLocalToGlobalBegin">DMLocalToGlobalBegin</A>() and <A HREF="../DM/DMLocalToGlobalEnd.html#DMLocalToGlobalEnd">DMLocalToGlobalEnd</A>() to have correct values in the ghost locations.
<P>
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
distributed array, get, corners, nodes, local indices, coordinates
<BR>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../DM/DMIGAVecRestoreArray.html#DMIGAVecRestoreArray">DMIGAVecRestoreArray</A>(), <A HREF="../Vec/VecGetArray.html#VecGetArray">VecGetArray</A>(), <A HREF="../Vec/VecRestoreArray.html#VecRestoreArray">VecRestoreArray</A>(), <A HREF="../DM/DMDAVecRestoreArray.html#DMDAVecRestoreArray">DMDAVecRestoreArray</A>(), <A HREF="../DM/DMDAVecGetArray.html#DMDAVecGetArray">DMDAVecGetArray</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>intermediate
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/dm/impls/igaiga.c.html#DMIGAVecGetArray">src/dm/impls/igaiga.c</A>
<BR><A HREF="./index.html">Index of all DM 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/ts/examples/tutorials/ex18.c.html">src/ts/examples/tutorials/ex18.c.html</A><BR>
</BODY></HTML>
|