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
|
<!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/MatDiagonalSet.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatDiagonalSet</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/MatDiagonalSet.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatDiagonalSet"><H1>MatDiagonalSet</H1></A>
Computes Y = Y + D, where D is a diagonal matrix that is represented as a vector. Or Y[i,i] = D[i] if <A HREF="../Sys/InsertMode.html#InsertMode">InsertMode</A> is <A HREF="../Sys/INSERT_VALUES.html#INSERT_VALUES">INSERT_VALUES</A>.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Mat/MatDiagonalSet.html#MatDiagonalSet">MatDiagonalSet</A>(<A HREF="../Mat/Mat.html#Mat">Mat</A> Y,<A HREF="../Vec/Vec.html#Vec">Vec</A> D,<A HREF="../Sys/InsertMode.html#InsertMode">InsertMode</A> is)
</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>Y </B></TD><TD>- the input matrix
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>D </B></TD><TD>- the diagonal matrix, represented as a vector
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>i </B></TD><TD>- <A HREF="../Sys/INSERT_VALUES.html#INSERT_VALUES">INSERT_VALUES</A> or <A HREF="../Sys/ADD_VALUES.html#ADD_VALUES">ADD_VALUES</A>
</TD></TR></TABLE>
<P>
Neighbor-wise Collective on <A HREF="../Mat/Mat.html#Mat">Mat</A> and <A HREF="../Vec/Vec.html#Vec">Vec</A>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
If the matrix Y is missing some diagonal entries this routine can be very slow. To make it fast one should initially
fill the matrix so that all diagonal entries have a value (with a value of zero for those locations that would not have an
entry).
<P>
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
matrix, add, shift, diagonal
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Mat/MatShift.html#MatShift">MatShift</A>(), <A HREF="../Mat/MatScale.html#MatScale">MatScale</A>(), <A HREF="../Mat/MatDiagonalScale.html#MatDiagonalScale">MatDiagonalScale</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/mat/utils/axpy.c.html#MatDiagonalSet">src/mat/utils/axpy.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/ts/examples/tutorials/ex50.c.html">src/ts/examples/tutorials/ex50.c.html</A><BR>
<A HREF="../../../src/tao/pde_constrained/examples/tutorials/elliptic.c.html">src/tao/pde_constrained/examples/tutorials/elliptic.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/mat/impls/aij/mpi/mpiaij.c.html#MatDiagonalSet_MPIAIJ">MatDiagonalSet_MPIAIJ in src/mat/impls/aij/mpi/mpiaij.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aij.c.html#MatDiagonalSet_SeqAIJ">MatDiagonalSet_SeqAIJ in src/mat/impls/aij/seq/aij.c</A><BR>
<A HREF="../../../src/mat/impls/is/matis.c.html#MatDiagonalSet_IS">MatDiagonalSet_IS in src/mat/impls/is/matis.c</A><BR>
<A HREF="../../../src/mat/impls/mffd/mffd.c.html#MatDiagonalSet_MFFD">MatDiagonalSet_MFFD in src/mat/impls/mffd/mffd.c</A><BR>
<A HREF="../../../src/mat/impls/nest/matnest.c.html#MatDiagonalSet_Nest">MatDiagonalSet_Nest in src/mat/impls/nest/matnest.c</A><BR>
<A HREF="../../../src/mat/impls/sell/mpi/mpisell.c.html#MatDiagonalSet_MPISELL">MatDiagonalSet_MPISELL in src/mat/impls/sell/mpi/mpisell.c</A><BR>
<A HREF="../../../src/mat/impls/shell/shell.c.html#MatDiagonalSet_Shell">MatDiagonalSet_Shell in src/mat/impls/shell/shell.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>
|
