File: VecGetValues.html

package info (click to toggle)
petsc 3.10.3%2Bdfsg1-5
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 209,064 kB
  • sloc: ansic: 587,333; python: 29,696; makefile: 12,445; fortran: 11,626; f90: 9,677; cpp: 8,768; sh: 1,027; xml: 621; objc: 445; csh: 194; java: 13
file content (58 lines) | stat: -rw-r--r-- 3,635 bytes parent folder | download
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
<!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/VecGetValues.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>VecGetValues</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>petsc-3.10.3 2018-12-18</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.10.3 v3.10.3 docs/manualpages/Vec/VecGetValues.html "><small>Report Typos and Errors</small></a></div>
<A NAME="VecGetValues"><H1>VecGetValues</H1></A>
Gets values from certain locations of a vector. Currently can only get values on the same processor 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscvec.h"   
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A>  <A HREF="../Vec/VecGetValues.html#VecGetValues">VecGetValues</A>(<A HREF="../Vec/Vec.html#Vec">Vec</A> x,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> ni,const <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> ix[],<A HREF="../Sys/PetscScalar.html#PetscScalar">PetscScalar</A> y[])
</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>x </B></TD><TD>- vector to get values from
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ni </B></TD><TD>- number of elements to get
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ix </B></TD><TD>- indices where to get them from (in global 1d numbering)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<DT><B>y </B> -array of values
<br>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
The user provides the allocated array y; it is NOT allocated in this routine
<P>
<A HREF="../Vec/VecGetValues.html#VecGetValues">VecGetValues</A>() gets y[i] = x[ix[i]], for i=0,...,ni-1.
<P>
<A HREF="../Vec/VecAssemblyBegin.html#VecAssemblyBegin">VecAssemblyBegin</A>() and <A HREF="../Vec/VecAssemblyEnd.html#VecAssemblyEnd">VecAssemblyEnd</A>()  MUST be called before calling this
<P>
<A HREF="../Vec/VecGetValues.html#VecGetValues">VecGetValues</A>() uses 0-based indices in Fortran as well as in C.
<P>
If you call <A HREF="../Vec/VecSetOption.html#VecSetOption">VecSetOption</A>(x, VEC_IGNORE_NEGATIVE_INDICES,<A HREF="../Sys/PETSC_TRUE.html#PETSC_TRUE">PETSC_TRUE</A>),
negative indices may be passed in ix. These rows are
simply ignored.
<P>

<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
  <A HREF="../Vec/VecAssemblyBegin.html#VecAssemblyBegin">VecAssemblyBegin</A>(), <A HREF="../Vec/VecAssemblyEnd.html#VecAssemblyEnd">VecAssemblyEnd</A>(), <A HREF="../Vec/VecSetValues.html#VecSetValues">VecSetValues</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/vec/vec/interface/rvector.c.html#VecGetValues">src/vec/vec/interface/rvector.c</A>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/vec/vec/impls/mpi/pdvec.c.html#VecGetValues_MPI">VecGetValues_MPI in src/vec/vec/impls/mpi/pdvec.c</A><BR>
<A HREF="../../../src/vec/vec/impls/seq/bvec2.c.html#VecGetValues_Seq">VecGetValues_Seq in src/vec/vec/impls/seq/bvec2.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>