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
59
60
61
62
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Mat/MatCreateVecs.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatCreateVecs</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/Mat/MatCreateVecs.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatCreateVecs"><H1>MatCreateVecs</H1></A>
Get vector(s) compatible with the matrix, i.e. with the same parallel layout
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Mat/MatCreateVecs.html#MatCreateVecs">MatCreateVecs</A>(<A HREF="../Mat/Mat.html#Mat">Mat</A> mat,<A HREF="../Vec/Vec.html#Vec">Vec</A> *right,<A HREF="../Vec/Vec.html#Vec">Vec</A> *left)
</PRE>
Collective on <A HREF="../Mat/Mat.html#Mat">Mat</A>
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>mat </B></TD><TD>- the matrix
</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>- (optional) vector that the matrix can be multiplied against
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>left </B></TD><TD>- (optional) vector that the matrix vector product can be stored in
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
The blocksize of the returned vectors is determined by the row and column block sizes set with <A HREF="../Mat/MatSetBlockSizes.html#MatSetBlockSizes">MatSetBlockSizes</A>() or the single blocksize (same for both) set by <A HREF="../Mat/MatSetBlockSize.html#MatSetBlockSize">MatSetBlockSize</A>().
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
These are new vectors which are not owned by the <A HREF="../Mat/Mat.html#Mat">Mat</A>, they should be destroyed in <A HREF="../Vec/VecDestroy.html#VecDestroy">VecDestroy</A>() when no longer needed
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Mat/MatCreate.html#MatCreate">MatCreate</A>(), <A HREF="../Vec/VecDestroy.html#VecDestroy">VecDestroy</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/mat/interface/matrix.c.html#MatCreateVecs">src/mat/interface/matrix.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/mat/tutorials/ex9.c.html">src/mat/tutorials/ex9.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex4.c.html">src/ksp/ksp/tutorials/ex4.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex6.c.html">src/ksp/ksp/tutorials/ex6.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex10.c.html">src/ksp/ksp/tutorials/ex10.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex21.c.html">src/ksp/ksp/tutorials/ex21.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex42.c.html">src/ksp/ksp/tutorials/ex42.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex49.c.html">src/ksp/ksp/tutorials/ex49.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex54.c.html">src/ksp/ksp/tutorials/ex54.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex56.c.html">src/ksp/ksp/tutorials/ex56.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex59.c.html">src/ksp/ksp/tutorials/ex59.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex64.c.html">src/ksp/ksp/tutorials/ex64.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/mat/impls/nest/matnest.c.html#MatCreateVecs_Nest">MatCreateVecs_Nest in src/mat/impls/nest/matnest.c</A><BR>
<A HREF="../../../src/mat/impls/transpose/htransm.c.html#MatCreateVecs_HT">MatCreateVecs_HT in src/mat/impls/transpose/htransm.c</A><BR>
<A HREF="../../../src/mat/impls/transpose/transm.c.html#MatCreateVecs_Transpose">MatCreateVecs_Transpose in src/mat/impls/transpose/transm.c</A><BR>
<BR><A HREF="./index.html">Index of all Mat 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>
|
