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
|
<!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/MatAssemblyBegin.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatAssemblyBegin</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/MatAssemblyBegin.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatAssemblyBegin"><H1>MatAssemblyBegin</H1></A>
Begins assembling the matrix. This routine should be called after completing all calls to <A HREF="../Mat/MatSetValues.html#MatSetValues">MatSetValues</A>().
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Mat/MatAssemblyBegin.html#MatAssemblyBegin">MatAssemblyBegin</A>(<A HREF="../Mat/Mat.html#Mat">Mat</A> mat,<A HREF="../Mat/MatAssemblyType.html#MatAssemblyType">MatAssemblyType</A> type)
</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>type </B></TD><TD>- type of assembly, either <A HREF="../Mat/MatAssemblyType.html#MatAssemblyType">MAT_FLUSH_ASSEMBLY</A> or <A HREF="../Mat/MatAssemblyType.html#MatAssemblyType">MAT_FINAL_ASSEMBLY</A>
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
<A HREF="../Mat/MatSetValues.html#MatSetValues">MatSetValues</A>() generally caches the values. The matrix is ready to
use only after <A HREF="../Mat/MatAssemblyBegin.html#MatAssemblyBegin">MatAssemblyBegin</A>() and <A HREF="../Mat/MatAssemblyEnd.html#MatAssemblyEnd">MatAssemblyEnd</A>() have been called.
Use <A HREF="../Mat/MatAssemblyType.html#MatAssemblyType">MAT_FLUSH_ASSEMBLY</A> when switching between <A HREF="../Sys/ADD_VALUES.html#ADD_VALUES">ADD_VALUES</A> and <A HREF="../Sys/INSERT_VALUES.html#INSERT_VALUES">INSERT_VALUES</A>
in <A HREF="../Mat/MatSetValues.html#MatSetValues">MatSetValues</A>(); use <A HREF="../Mat/MatAssemblyType.html#MatAssemblyType">MAT_FINAL_ASSEMBLY</A> for the final assembly before
using the matrix.
<P>
ALL processes that share a matrix MUST call <A HREF="../Mat/MatAssemblyBegin.html#MatAssemblyBegin">MatAssemblyBegin</A>() and <A HREF="../Mat/MatAssemblyEnd.html#MatAssemblyEnd">MatAssemblyEnd</A>() the SAME NUMBER of times, and each time with the
same flag of <A HREF="../Mat/MatAssemblyType.html#MatAssemblyType">MAT_FLUSH_ASSEMBLY</A> or <A HREF="../Mat/MatAssemblyType.html#MatAssemblyType">MAT_FINAL_ASSEMBLY</A> for all processes. Thus you CANNOT locally change from <A HREF="../Sys/ADD_VALUES.html#ADD_VALUES">ADD_VALUES</A> to <A HREF="../Sys/INSERT_VALUES.html#INSERT_VALUES">INSERT_VALUES</A>, that is
a global collective operation requring all processes that share the matrix.
<P>
Space for preallocated nonzeros that is not filled by a call to <A HREF="../Mat/MatSetValues.html#MatSetValues">MatSetValues</A>() or a related routine are compressed
out by assembly. If you intend to use that extra space on a subsequent assembly, be sure to insert explicit zeros
before <A HREF="../Mat/MatAssemblyType.html#MatAssemblyType">MAT_FINAL_ASSEMBLY</A> so the space is not compressed out.
<P>
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Mat/MatAssemblyEnd.html#MatAssemblyEnd">MatAssemblyEnd</A>(), <A HREF="../Mat/MatSetValues.html#MatSetValues">MatSetValues</A>(), <A HREF="../Mat/MatAssembled.html#MatAssembled">MatAssembled</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>beginner<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/mat/interface/matrix.c.html#MatAssemblyBegin">src/mat/interface/matrix.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/mat/examples/tutorials/ex2.c.html">src/mat/examples/tutorials/ex2.c.html</A><BR>
<A HREF="../../../src/mat/examples/tutorials/ex4.c.html">src/mat/examples/tutorials/ex4.c.html</A><BR>
<A HREF="../../../src/mat/examples/tutorials/ex5.c.html">src/mat/examples/tutorials/ex5.c.html</A><BR>
<A HREF="../../../src/mat/examples/tutorials/ex8.c.html">src/mat/examples/tutorials/ex8.c.html</A><BR>
<A HREF="../../../src/mat/examples/tutorials/ex12.c.html">src/mat/examples/tutorials/ex12.c.html</A><BR>
<A HREF="../../../src/mat/examples/tutorials/ex15.c.html">src/mat/examples/tutorials/ex15.c.html</A><BR>
<A HREF="../../../src/mat/examples/tutorials/ex16.c.html">src/mat/examples/tutorials/ex16.c.html</A><BR>
<A HREF="../../../src/mat/examples/tutorials/ex17.c.html">src/mat/examples/tutorials/ex17.c.html</A><BR>
<A HREF="../../../src/ksp/pc/examples/tutorials/ex1.c.html">src/ksp/pc/examples/tutorials/ex1.c.html</A><BR>
<A HREF="../../../src/ksp/pc/examples/tutorials/ex2.c.html">src/ksp/pc/examples/tutorials/ex2.c.html</A><BR>
<A HREF="../../../src/ksp/pc/examples/tutorials/ex3.c.html">src/ksp/pc/examples/tutorials/ex3.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/mat/impls/aij/mpi/mpiaij.c.html#MatAssemblyBegin_MPIAIJ">MatAssemblyBegin_MPIAIJ in src/mat/impls/aij/mpi/mpiaij.c</A><BR>
<A HREF="../../../src/mat/impls/baij/mpi/mpibaij.c.html#MatAssemblyBegin_MPIBAIJ">MatAssemblyBegin_MPIBAIJ in src/mat/impls/baij/mpi/mpibaij.c</A><BR>
<A HREF="../../../src/mat/impls/dense/mpi/mpidense.c.html#MatAssemblyBegin_MPIDense">MatAssemblyBegin_MPIDense in src/mat/impls/dense/mpi/mpidense.c</A><BR>
<A HREF="../../../src/mat/impls/dense/seq/dense.c.html#MatAssemblyBegin_SeqDense">MatAssemblyBegin_SeqDense in src/mat/impls/dense/seq/dense.c</A><BR>
<A HREF="../../../src/mat/impls/elemental/matelem.cxx.html#MatAssemblyBegin_Elemental">MatAssemblyBegin_Elemental in src/mat/impls/elemental/matelem.cxx</A><BR>
<A HREF="../../../src/mat/impls/hypre/mhypre.c.html#MatAssemblyBegin_HYPRE">MatAssemblyBegin_HYPRE in src/mat/impls/hypre/mhypre.c</A><BR>
<A HREF="../../../src/mat/impls/is/matis.c.html#MatAssemblyBegin_IS">MatAssemblyBegin_IS in src/mat/impls/is/matis.c</A><BR>
<A HREF="../../../src/mat/impls/nest/matnest.c.html#MatAssemblyBegin_Nest">MatAssemblyBegin_Nest in src/mat/impls/nest/matnest.c</A><BR>
<A HREF="../../../src/mat/impls/preallocator/matpreallocator.c.html#MatAssemblyBegin_Preallocator">MatAssemblyBegin_Preallocator in src/mat/impls/preallocator/matpreallocator.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/mpi/mpisbaij.c.html#MatAssemblyBegin_MPISBAIJ">MatAssemblyBegin_MPISBAIJ in src/mat/impls/sbaij/mpi/mpisbaij.c</A><BR>
<A HREF="../../../src/mat/impls/sell/mpi/mpisell.c.html#MatAssemblyBegin_MPISELL">MatAssemblyBegin_MPISELL in src/mat/impls/sell/mpi/mpisell.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>
|
