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
63
64
65
66
67
68
69
70
71
72
73
74
75
|
<!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/MatCreateComposite.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatCreateComposite</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/Mat/MatCreateComposite.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatCreateComposite"><H1>MatCreateComposite</H1></A>
Creates a matrix as the sum of zero or more matrices
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Mat/MatCreateComposite.html#MatCreateComposite">MatCreateComposite</A>(<A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A> comm,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> nmat,const <A HREF="../Mat/Mat.html#Mat">Mat</A> *mats,<A HREF="../Mat/Mat.html#Mat">Mat</A> *mat)
</PRE>
Collective on <A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A>
<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>comm </B></TD><TD>- MPI communicator
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>nmat </B></TD><TD>- number of matrices to put in
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>mats </B></TD><TD>- the matrices
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<DT><B>mat </B> -the matrix
<br>
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Alternative construction
<pre>
<A HREF="../Mat/MatCreate.html#MatCreate">MatCreate</A>(comm,&mat);
</pre>
<pre>
<A HREF="../Mat/MatSetSizes.html#MatSetSizes">MatSetSizes</A>(mat,m,n,M,N);
</pre>
<pre>
<A HREF="../Mat/MatSetType.html#MatSetType">MatSetType</A>(mat,<A HREF="../Mat/MATCOMPOSITE.html#MATCOMPOSITE">MATCOMPOSITE</A>);
</pre>
<pre>
<A HREF="../Mat/MatCompositeAddMat.html#MatCompositeAddMat">MatCompositeAddMat</A>(mat,mats[0]);
</pre>
<pre>
....
</pre>
<pre>
<A HREF="../Mat/MatCompositeAddMat.html#MatCompositeAddMat">MatCompositeAddMat</A>(mat,mats[nmat-1]);
</pre>
<pre>
<A HREF="../Mat/MatAssemblyBegin.html#MatAssemblyBegin">MatAssemblyBegin</A>(mat,<A HREF="../Mat/MatAssemblyType.html#MatAssemblyType">MAT_FINAL_ASSEMBLY</A>);
</pre>
<pre>
<A HREF="../Mat/MatAssemblyEnd.html#MatAssemblyEnd">MatAssemblyEnd</A>(mat,<A HREF="../Mat/MatAssemblyType.html#MatAssemblyType">MAT_FINAL_ASSEMBLY</A>);
</pre>
<P>
For the multiplicative form the product is mat[nmat-1]*mat[nmat-2]*....*mat[0]
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Mat/MatDestroy.html#MatDestroy">MatDestroy</A>(), <A HREF="../Mat/MatMult.html#MatMult">MatMult</A>(), <A HREF="../Mat/MatCompositeAddMat.html#MatCompositeAddMat">MatCompositeAddMat</A>(), <A HREF="../Mat/MatCompositeMerge.html#MatCompositeMerge">MatCompositeMerge</A>(), <A HREF="../Mat/MatCompositeSetType.html#MatCompositeSetType">MatCompositeSetType</A>(), MatCompositeType
<BR>
<P>
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/mat/impls/composite/mcomposite.c.html#MatCreateComposite">src/mat/impls/composite/mcomposite.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/mat/examples/tutorials/ex9.c.html">src/mat/examples/tutorials/ex9.c.html</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>
|
