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
|
<!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/VecGetSubVector.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>VecGetSubVector</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/VecGetSubVector.html "><small>Report Typos and Errors</small></a></div>
<A NAME="VecGetSubVector"><H1>VecGetSubVector</H1></A>
Gets a vector representing part of another vector
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscvec.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Vec/VecGetSubVector.html#VecGetSubVector">VecGetSubVector</A>(<A HREF="../Vec/Vec.html#Vec">Vec</A> X,<A HREF="../IS/IS.html#IS">IS</A> is,<A HREF="../Vec/Vec.html#Vec">Vec</A> *Y)
</PRE>
Collective on X and <A HREF="../IS/IS.html#IS">IS</A>
<P>
<H3><FONT COLOR="#CC3333">Input Arguments</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>X </B></TD><TD>- vector from which to extract a subvector
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>is </B></TD><TD>- index set representing portion of X to extract
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Arguments</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>Y </B></TD><TD>- subvector corresponding to is
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
The subvector Y should be returned with <A HREF="../Vec/VecRestoreSubVector.html#VecRestoreSubVector">VecRestoreSubVector</A>().
X and is must be defined on the same communicator
<P>
This function may return a subvector without making a copy, therefore it is not safe to use the original vector while
modifying the subvector. Other non-overlapping subvectors can still be obtained from X using this function.
The resulting subvector inherits the block size from the <A HREF="../IS/IS.html#IS">IS</A> if greater than one. Otherwise, the block size is guessed from the block size of the original vec.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Mat/MatCreateSubMatrix.html#MatCreateSubMatrix">MatCreateSubMatrix</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/vec/vec/interface/rvector.c.html#VecGetSubVector">src/vec/vec/interface/rvector.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/snes/tutorials/ex70.c.html">src/snes/tutorials/ex70.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/vec/vec/impls/nest/vecnest.c.html#VecGetSubVector_Nest">VecGetSubVector_Nest in src/vec/vec/impls/nest/vecnest.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>
|
