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
|
<!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/MatGetDiagonal.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatGetDiagonal</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/MatGetDiagonal.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatGetDiagonal"><H1>MatGetDiagonal</H1></A>
Gets the diagonal of a matrix.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Mat/MatGetDiagonal.html#MatGetDiagonal">MatGetDiagonal</A>(<A HREF="../Mat/Mat.html#Mat">Mat</A> mat,<A HREF="../Vec/Vec.html#Vec">Vec</A> v)
</PRE>
Logically Collective on <A HREF="../Mat/Mat.html#Mat">Mat</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>mat </B></TD><TD>- the matrix
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>v </B></TD><TD>- the vector for storing the diagonal
</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>v </B></TD><TD>- the diagonal of the matrix
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Note</FONT></H3>
Currently only correct in parallel for square matrices.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Mat/MatGetRow.html#MatGetRow">MatGetRow</A>(), <A HREF="../Mat/MatCreateSubMatrices.html#MatCreateSubMatrices">MatCreateSubMatrices</A>(), <A HREF="../Mat/MatCreateSubMatrix.html#MatCreateSubMatrix">MatCreateSubMatrix</A>(), <A HREF="../Mat/MatGetRowMaxAbs.html#MatGetRowMaxAbs">MatGetRowMaxAbs</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/interface/matrix.c.html#MatGetDiagonal">src/mat/interface/matrix.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/ksp/pc/tutorials/ex1.c.html">src/ksp/pc/tutorials/ex1.c.html</A><BR>
<A HREF="../../../src/ksp/pc/tutorials/ex2.c.html">src/ksp/pc/tutorials/ex2.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex15.c.html">src/ksp/ksp/tutorials/ex15.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex52.c.html">src/ksp/ksp/tutorials/ex52.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex15f.F90.html">src/ksp/ksp/tutorials/ex15f.F90.html</A><BR>
<A HREF="../../../src/snes/tutorials/ex70.c.html">src/snes/tutorials/ex70.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/mat/impls/aij/mpi/mpiaij.c.html#MatGetDiagonal_MPIAIJ">MatGetDiagonal_MPIAIJ in src/mat/impls/aij/mpi/mpiaij.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/strumpack/strumpack.c.html#MatGetDiagonal_STRUMPACK">MatGetDiagonal_STRUMPACK in src/mat/impls/aij/mpi/strumpack/strumpack.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aij.c.html#MatGetDiagonal_SeqAIJ">MatGetDiagonal_SeqAIJ in src/mat/impls/aij/seq/aij.c</A><BR>
<A HREF="../../../src/mat/impls/baij/mpi/mpibaij.c.html#MatGetDiagonal_MPIBAIJ">MatGetDiagonal_MPIBAIJ in src/mat/impls/baij/mpi/mpibaij.c</A><BR>
<A HREF="../../../src/mat/impls/baij/seq/baij2.c.html#MatGetDiagonal_SeqBAIJ">MatGetDiagonal_SeqBAIJ in src/mat/impls/baij/seq/baij2.c</A><BR>
<A HREF="../../../src/mat/impls/cdiagonal/cdiagonal.c.html#MatGetDiagonal_ConstantDiagonal">MatGetDiagonal_ConstantDiagonal in src/mat/impls/cdiagonal/cdiagonal.c</A><BR>
<A HREF="../../../src/mat/impls/composite/mcomposite.c.html#MatGetDiagonal_Composite">MatGetDiagonal_Composite in src/mat/impls/composite/mcomposite.c</A><BR>
<A HREF="../../../src/mat/impls/dense/mpi/mpidense.c.html#MatGetDiagonal_MPIDense">MatGetDiagonal_MPIDense in src/mat/impls/dense/mpi/mpidense.c</A><BR>
<A HREF="../../../src/mat/impls/dense/seq/dense.c.html#MatGetDiagonal_SeqDense">MatGetDiagonal_SeqDense in src/mat/impls/dense/seq/dense.c</A><BR>
<A HREF="../../../src/mat/impls/elemental/matelem.cxx.html#MatGetDiagonal_Elemental">MatGetDiagonal_Elemental in src/mat/impls/elemental/matelem.cxx</A><BR>
<A HREF="../../../src/mat/impls/hypre/mhypre.c.html#MatGetDiagonal_HYPRE">MatGetDiagonal_HYPRE in src/mat/impls/hypre/mhypre.c</A><BR>
<A HREF="../../../src/mat/impls/is/matis.c.html#MatGetDiagonal_IS">MatGetDiagonal_IS in src/mat/impls/is/matis.c</A><BR>
<A HREF="../../../src/mat/impls/mffd/mffd.c.html#MatGetDiagonal_MFFD">MatGetDiagonal_MFFD in src/mat/impls/mffd/mffd.c</A><BR>
<A HREF="../../../src/mat/impls/nest/matnest.c.html#MatGetDiagonal_Nest">MatGetDiagonal_Nest in src/mat/impls/nest/matnest.c</A><BR>
<A HREF="../../../src/mat/impls/normal/normm.c.html#MatGetDiagonal_Normal">MatGetDiagonal_Normal in src/mat/impls/normal/normm.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/mpi/mpisbaij.c.html#MatGetDiagonal_MPISBAIJ">MatGetDiagonal_MPISBAIJ in src/mat/impls/sbaij/mpi/mpisbaij.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/seq/sbaij2.c.html#MatGetDiagonal_SeqSBAIJ">MatGetDiagonal_SeqSBAIJ in src/mat/impls/sbaij/seq/sbaij2.c</A><BR>
<A HREF="../../../src/mat/impls/scalapack/matscalapack.c.html#MatGetDiagonal_ScaLAPACK">MatGetDiagonal_ScaLAPACK in src/mat/impls/scalapack/matscalapack.c</A><BR>
<A HREF="../../../src/mat/impls/sell/mpi/mpisell.c.html#MatGetDiagonal_MPISELL">MatGetDiagonal_MPISELL in src/mat/impls/sell/mpi/mpisell.c</A><BR>
<A HREF="../../../src/mat/impls/sell/seq/sell.c.html#MatGetDiagonal_SeqSELL">MatGetDiagonal_SeqSELL in src/mat/impls/sell/seq/sell.c</A><BR>
<A HREF="../../../src/mat/impls/shell/shell.c.html#MatGetDiagonal_Shell">MatGetDiagonal_Shell in src/mat/impls/shell/shell.c</A><BR>
<A HREF="../../../src/mat/impls/shell/shellcnv.c.html#MatGetDiagonal_CF">MatGetDiagonal_CF in src/mat/impls/shell/shellcnv.c</A><BR>
<A HREF="../../../src/mat/impls/submat/submat.c.html#MatGetDiagonal_SubMatrix">MatGetDiagonal_SubMatrix in src/mat/impls/submat/submat.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>
|
