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>VecGhostGetLocalForm</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<A NAME="VecGhostGetLocalForm"><H1>VecGhostGetLocalForm</H1></A>
Obtains the local ghosted representation of a parallel vector created with <A HREF="../Vec/VecCreateGhost.html#VecCreateGhost">VecCreateGhost</A>().
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscvec.h"
int VecGhostGetLocalForm(Vec g,Vec *l)
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<DT><B>g </B> -the global vector. Vector must be have been obtained with either
<A HREF="../Vec/VecCreateGhost.html#VecCreateGhost">VecCreateGhost</A>(), <A HREF="../Vec/VecCreateGhostWithArray.html#VecCreateGhostWithArray">VecCreateGhostWithArray</A>() or <A HREF="../Vec/VecCreateSeq.html#VecCreateSeq">VecCreateSeq</A>().
<br>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<DT><B>l </B> -the local (ghosted) representation
<br>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
This routine does not actually update the ghost values, but rather it
returns a sequential vector that includes the locations for the ghost
values and their current values. The returned vector and the original
vector passed in share the same array that contains the actual vector data.
<P>
One should call <A HREF="../Vec/VecGhostRestoreLocalForm.html#VecGhostRestoreLocalForm">VecGhostRestoreLocalForm</A>() or <A HREF="../Vec/VecDestroy.html#VecDestroy">VecDestroy</A>() once one is
finished using the object.
<P>
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Vec/VecCreateGhost.html#VecCreateGhost">VecCreateGhost</A>(), <A HREF="../Vec/VecGhostRestoreLocalForm.html#VecGhostRestoreLocalForm">VecGhostRestoreLocalForm</A>(), <A HREF="../Vec/VecCreateGhostWithArray.html#VecCreateGhostWithArray">VecCreateGhostWithArray</A>()
<BR>
<P>
<P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>advanced
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/vec/impls/mpi/pbvec.c.html#VecGhostGetLocalForm">src/vec/impls/mpi/pbvec.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>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/vec/examples/tutorials/ex9.c.html">src/vec/examples/tutorials/ex9.c.html</A><BR>
<A HREF="../../../src/vec/examples/tutorials/ex9f.F.html">src/vec/examples/tutorials/ex9f.F.html</A><BR>
<A HREF="../../../src/vec/examples/tutorials/ex14f.F.html">src/vec/examples/tutorials/ex14f.F.html</A><BR>
</BODY></HTML>
|
