File: KSPCreateVecs.html

package info (click to toggle)
petsc 3.7.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 163,864 kB
  • ctags: 618,438
  • sloc: ansic: 515,133; python: 29,793; makefile: 20,458; fortran: 18,998; cpp: 6,515; f90: 3,914; sh: 1,012; xml: 621; objc: 445; csh: 240; java: 13
file content (52 lines) | stat: -rw-r--r-- 2,971 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/KSP/KSPCreateVecs.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>KSPCreateVecs</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>petsc-3.7.5 2017-01-01</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.7.5 v3.7.5 docs/manualpages/KSP/KSPCreateVecs.html "><small>Report Typos and Errors</small></a></div>
<A NAME="KSPCreateVecs"><H1>KSPCreateVecs</H1></A>
Gets a number of work vectors. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscksp.h" 
PetscErrorCode KSPCreateVecs(KSP ksp,PetscInt rightn, Vec **right,PetscInt leftn,Vec **left)
</PRE>
<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>ksp  </B></TD><TD>- iterative context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>rightn  </B></TD><TD>- number of right work vectors
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>leftn   </B></TD><TD>- number of left work vectors to allocate
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>right </B></TD><TD>- the array of vectors created
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>left </B></TD><TD>- the array of left vectors
</TD></TR></TABLE>
<P>
Note: The right vector has as many elements as the matrix has columns. The left
vector has as many elements as the matrix has rows.
<P>
The vectors are new vectors that are not owned by the <A HREF="../KSP/KSP.html#KSP">KSP</A>, they should be destroyed with calls to <A HREF="../Vec/VecDestroyVecs.html#VecDestroyVecs">VecDestroyVecs</A>() when no longer needed.
<P>
Developers Note: First tries to duplicate the rhs and solution vectors of the <A HREF="../KSP/KSP.html#KSP">KSP</A>, if they do not exist tries to get them from the matrix, if
that does not exist tries to get them from the <A HREF="../DM/DM.html#DM">DM</A> (if it is provided).
<P>

<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
   <A HREF="../Mat/MatCreateVecs.html#MatCreateVecs">MatCreateVecs</A>(), <A HREF="../Vec/VecDestroyVecs.html#VecDestroyVecs">VecDestroyVecs</A>()
<BR>
<P>
<P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>advanced
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/ksp/ksp/interface/iterativ.c.html#KSPCreateVecs">src/ksp/ksp/interface/iterativ.c</A>
<BR><A HREF="./index.html">Index of all KSP 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>