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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
<!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/MatSetValuesBlocked.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatSetValuesBlocked</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.4.2 2013-07-02</b></div>
<A NAME="MatSetValuesBlocked"><H1>MatSetValuesBlocked</H1></A>
Inserts or adds a block of values into a matrix.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h"
PetscErrorCode MatSetValuesBlocked(Mat mat,PetscInt m,const PetscInt idxm[],PetscInt n,const PetscInt idxn[],const PetscScalar v[],InsertMode addv)
</PRE>
Not Collective
<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>- a logically two-dimensional array of values
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>m, idxm </B></TD><TD>- the number of block rows and their global block indices
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>n, idxn </B></TD><TD>- the number of block columns and their global block indices
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>addv </B></TD><TD>- either <A HREF="../Sys/ADD_VALUES.html#ADD_VALUES">ADD_VALUES</A> or <A HREF="../Sys/INSERT_VALUES.html#INSERT_VALUES">INSERT_VALUES</A>, where
<A HREF="../Sys/ADD_VALUES.html#ADD_VALUES">ADD_VALUES</A> adds values to any existing entries, and
<A HREF="../Sys/INSERT_VALUES.html#INSERT_VALUES">INSERT_VALUES</A> replaces existing entries with new values
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
If you create the matrix yourself (that is not with a call to <A HREF="../DM/DMCreateMatrix.html#DMCreateMatrix">DMCreateMatrix</A>()) then you MUST call
MatXXXXSetPreallocation() or <A HREF="../Mat/MatSetUp.html#MatSetUp">MatSetUp</A>() before using this routine.
<P>
The m and n count the NUMBER of blocks in the row direction and column direction,
NOT the total number of rows/columns; for example, if the block size is 2 and
you are passing in values for rows 2,3,4,5 then m would be 2 (not 4).
The values in idxm would be 1 2; that is the first index for each block divided by
the block size.
<P>
Note that you must call <A HREF="../Mat/MatSetBlockSize.html#MatSetBlockSize">MatSetBlockSize</A>() when constructing this matrix (after
preallocating it).
<P>
By default the values, v, are row-oriented, so the layout of
v is the same as for <A HREF="../Mat/MatSetValues.html#MatSetValues">MatSetValues</A>(). See <A HREF="../Mat/MatSetOption.html#MatSetOption">MatSetOption</A>() for other options.
<P>
Calls to <A HREF="../Mat/MatSetValuesBlocked.html#MatSetValuesBlocked">MatSetValuesBlocked</A>() with the <A HREF="../Sys/INSERT_VALUES.html#INSERT_VALUES">INSERT_VALUES</A> and <A HREF="../Sys/ADD_VALUES.html#ADD_VALUES">ADD_VALUES</A>
options cannot be mixed without intervening calls to the assembly
routines.
<P>
<A HREF="../Mat/MatSetValuesBlocked.html#MatSetValuesBlocked">MatSetValuesBlocked</A>() uses 0-based row and column numbers in Fortran
as well as in C.
<P>
Negative indices may be passed in idxm and idxn, these rows and columns are
simply ignored. This allows easily inserting element stiffness matrices
with homogeneous Dirchlet boundary conditions that you don't want represented
in the matrix.
<P>
Each time an entry is set within a sparse matrix via <A HREF="../Mat/MatSetValues.html#MatSetValues">MatSetValues</A>(),
internal searching must be done to determine where to place the the
data in the matrix storage space. By instead inserting blocks of
entries via <A HREF="../Mat/MatSetValuesBlocked.html#MatSetValuesBlocked">MatSetValuesBlocked</A>(), the overhead of matrix assembly is
reduced.
<P>
<H3><FONT COLOR="#CC3333">Example</FONT></H3>
<pre>
Suppose m=n=2 and block size(bs) = 2 The array is
</pre>
<pre>
</pre>
<pre>
1 2 | 3 4
</pre>
<pre>
5 6 | 7 8
</pre>
<pre>
- - - | - - -
</pre>
<pre>
9 10 | 11 12
</pre>
<pre>
13 14 | 15 16
</pre>
<pre>
</pre>
<pre>
v[] should be passed in like
</pre>
<pre>
v[] = [1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16]
</pre>
<pre>
</pre>
<pre>
If you are not using row oriented storage of v (that is you called <A HREF="../Mat/MatSetOption.html#MatSetOption">MatSetOption</A>(mat,MAT_ROW_ORIENTED,<A HREF="../Sys/PETSC_FALSE.html#PETSC_FALSE">PETSC_FALSE</A>)) then
</pre>
<pre>
v[] = [1,5,9,13,2,6,10,14,3,7,11,15,4,8,12,16]
</pre>
<P>
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Mat/MatSetBlockSize.html#MatSetBlockSize">MatSetBlockSize</A>(), <A HREF="../Mat/MatSetOption.html#MatSetOption">MatSetOption</A>(), <A HREF="../Mat/MatAssemblyBegin.html#MatAssemblyBegin">MatAssemblyBegin</A>(), <A HREF="../Mat/MatAssemblyEnd.html#MatAssemblyEnd">MatAssemblyEnd</A>(), <A HREF="../Mat/MatSetValues.html#MatSetValues">MatSetValues</A>(), <A HREF="../Mat/MatSetValuesBlockedLocal.html#MatSetValuesBlockedLocal">MatSetValuesBlockedLocal</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#MatSetValuesBlocked">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>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex55.c.html">src/ksp/ksp/examples/tutorials/ex55.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex56.c.html">src/ksp/ksp/examples/tutorials/ex56.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex9.c.html">src/ts/examples/tutorials/ex9.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex10.c.html">src/ts/examples/tutorials/ex10.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex22.c.html">src/ts/examples/tutorials/ex22.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex25.c.html">src/ts/examples/tutorials/ex25.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex30.cxx.html">src/ts/examples/tutorials/ex30.cxx.html</A><BR>
</BODY></HTML>
|
