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
|
<!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/MatGetLocalSubMatrix.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatGetLocalSubMatrix</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/MatGetLocalSubMatrix.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatGetLocalSubMatrix"><H1>MatGetLocalSubMatrix</H1></A>
Gets a reference to a submatrix specified in local numbering
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Mat/MatGetLocalSubMatrix.html#MatGetLocalSubMatrix">MatGetLocalSubMatrix</A>(<A HREF="../Mat/Mat.html#Mat">Mat</A> mat,<A HREF="../IS/IS.html#IS">IS</A> isrow,<A HREF="../IS/IS.html#IS">IS</A> iscol,<A HREF="../Mat/Mat.html#Mat">Mat</A> *submat)
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#CC3333">Input Arguments</FONT></H3>
mat - matrix to extract local submatrix from
isrow - local row indices for submatrix
iscol - local column indices for submatrix
<P>
<H3><FONT COLOR="#CC3333">Output Arguments</FONT></H3>
submat - the submatrix
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
The submat should be returned with <A HREF="../Mat/MatRestoreLocalSubMatrix.html#MatRestoreLocalSubMatrix">MatRestoreLocalSubMatrix</A>().
<P>
Depending on the format of mat, the returned submat may not implement <A HREF="../Mat/MatMult.html#MatMult">MatMult</A>(). Its communicator may be
the same as mat, it may be <A HREF="../Sys/PETSC_COMM_SELF.html#PETSC_COMM_SELF">PETSC_COMM_SELF</A>, or some other subcomm of mat's.
<P>
The submat always implements <A HREF="../Mat/MatSetValuesLocal.html#MatSetValuesLocal">MatSetValuesLocal</A>(). If isrow and iscol have the same block size, then
<A HREF="../Mat/MatSetValuesBlockedLocal.html#MatSetValuesBlockedLocal">MatSetValuesBlockedLocal</A>() will also be implemented.
<P>
The mat must have had a <A HREF="../IS/ISLocalToGlobalMapping.html#ISLocalToGlobalMapping">ISLocalToGlobalMapping</A> provided to it with <A HREF="../Mat/MatSetLocalToGlobalMapping.html#MatSetLocalToGlobalMapping">MatSetLocalToGlobalMapping</A>(). Note that
matrices obtained with <A HREF="../DM/DMCreateMatrix.html#DMCreateMatrix">DMCreateMatrix</A>() generally already have the local to global mapping provided.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Mat/MatRestoreLocalSubMatrix.html#MatRestoreLocalSubMatrix">MatRestoreLocalSubMatrix</A>(), <A HREF="../Mat/MatCreateLocalRef.html#MatCreateLocalRef">MatCreateLocalRef</A>(), <A HREF="../Mat/MatSetLocalToGlobalMapping.html#MatSetLocalToGlobalMapping">MatSetLocalToGlobalMapping</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#MatGetLocalSubMatrix">src/mat/interface/matrix.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/snes/examples/tutorials/ex28.c.html">src/snes/examples/tutorials/ex28.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex14.c.html">src/ts/examples/tutorials/ex14.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/mat/impls/is/matis.c.html#MatGetLocalSubMatrix_IS">MatGetLocalSubMatrix_IS in src/mat/impls/is/matis.c</A><BR>
<A HREF="../../../src/mat/impls/nest/matnest.c.html#MatGetLocalSubMatrix_Nest">MatGetLocalSubMatrix_Nest in src/mat/impls/nest/matnest.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>
|
