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/MatZeroRowsLocal.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatZeroRowsLocal</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.4.2 2013-07-02</b></div>
<A NAME="MatZeroRowsLocal"><H1>MatZeroRowsLocal</H1></A>
Zeros all entries (except possibly the main diagonal) of a set of rows of a matrix; using local numbering of rows.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h"
PetscErrorCode MatZeroRowsLocal(Mat mat,PetscInt numRows,const PetscInt rows[],PetscScalar diag,Vec x,Vec b)
</PRE>
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>numRows </B></TD><TD>- the number of rows to remove
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>rows </B></TD><TD>- the global row indices
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>diag </B></TD><TD>- value put in all diagonals of eliminated rows
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>x </B></TD><TD>- optional vector of solutions for zeroed rows (other entries in vector are not used)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>b </B></TD><TD>- optional vector of right hand side, that will be adjusted by provided solution
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Before calling <A HREF="../Mat/MatZeroRowsLocal.html#MatZeroRowsLocal">MatZeroRowsLocal</A>(), the user must first set the
local-to-global mapping by calling <A HREF="../Mat/MatSetLocalToGlobalMapping.html#MatSetLocalToGlobalMapping">MatSetLocalToGlobalMapping</A>().
<P>
For the AIJ matrix formats this removes the old nonzero structure,
but does not release memory. For the dense and block diagonal
formats this does not alter the nonzero structure.
<P>
If the option <A HREF="../Mat/MatSetOption.html#MatSetOption">MatSetOption</A>(mat,MAT_KEEP_NONZERO_PATTERN,<A HREF="../Sys/PETSC_TRUE.html#PETSC_TRUE">PETSC_TRUE</A>) the nonzero structure
of the matrix is not changed (even for AIJ and BAIJ matrices) the values are
merely zeroed.
<P>
The user can set a value in the diagonal entry (or for the AIJ and
row formats can optionally remove the main diagonal entry from the
nonzero structure as well, by passing 0.0 as the final argument).
<P>
You can call <A HREF="../Mat/MatSetOption.html#MatSetOption">MatSetOption</A>(mat,MAT_NO_OFF_PROC_ZERO_ROWS,<A HREF="../Sys/PETSC_TRUE.html#PETSC_TRUE">PETSC_TRUE</A>) if each process indicates only rows it
owns that are to be zeroed. This saves a global synchronization in the implementation.
<P>
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Mat/MatZeroRows.html#MatZeroRows">MatZeroRows</A>(), <A HREF="../Mat/MatZeroRowsLocalIS.html#MatZeroRowsLocalIS">MatZeroRowsLocalIS</A>(), <A HREF="../Mat/MatZeroEntries.html#MatZeroEntries">MatZeroEntries</A>(), <A HREF="../Mat/MatZeroRows.html#MatZeroRows">MatZeroRows</A>(), <A HREF="../Mat/MatSetLocalToGlobalMapping.html#MatSetLocalToGlobalMapping">MatSetLocalToGlobalMapping</A>
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>intermediate
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/mat/interface/matrix.c.html#MatZeroRowsLocal">src/mat/interface/matrix.c</A>
<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>
|
