File: MatAssemblyEnd.html

package info (click to toggle)
petsc 3.10.3%2Bdfsg1-5
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 209,064 kB
  • sloc: ansic: 587,333; python: 29,696; makefile: 12,445; fortran: 11,626; f90: 9,677; cpp: 8,768; sh: 1,027; xml: 621; objc: 445; csh: 194; java: 13
file content (117 lines) | stat: -rw-r--r-- 12,201 bytes parent folder | download
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
<!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/MatAssemblyEnd.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatAssemblyEnd</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/MatAssemblyEnd.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatAssemblyEnd"><H1>MatAssemblyEnd</H1></A>
Completes assembling the matrix.  This routine should be called after <A HREF="../Mat/MatAssemblyBegin.html#MatAssemblyBegin">MatAssemblyBegin</A>(). 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h" 
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Mat/MatAssemblyEnd.html#MatAssemblyEnd">MatAssemblyEnd</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">Options Database Keys</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_view ::ascii_info </B></TD><TD>- Prints info on matrix at conclusion of MatEndAssembly()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_view ::ascii_info_detail </B></TD><TD>- Prints more detailed info
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_view </B></TD><TD>- Prints matrix in ASCII format
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_view ::ascii_matlab </B></TD><TD>- Prints matrix in Matlab format
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_view draw </B></TD><TD>- PetscDraws nonzero structure of matrix, using <A HREF="../Mat/MatView.html#MatView">MatView</A>() and <A HREF="../Draw/PetscDrawOpenX.html#PetscDrawOpenX">PetscDrawOpenX</A>().
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-display &lt;name&gt; </B></TD><TD>- Sets display name (default is host)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-draw_pause &lt;sec&gt; </B></TD><TD>- Sets number of seconds to pause after display
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_view socket </B></TD><TD>- Sends matrix to socket, can be accessed from Matlab (See Users-Manual: <A HREF="../../manual.pdf#chapter.12">Chapter 12 Using MATLAB with PETSc</A> )
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-viewer_socket_machine &lt;machine&gt; </B></TD><TD>- Machine to use for socket
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-viewer_socket_port &lt;port&gt; </B></TD><TD>- Port number to use for socket
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_view binary:filename[:append] </B></TD><TD>- Save matrix to file in binary format
</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>
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>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../Mat/MatAssemblyBegin.html#MatAssemblyBegin">MatAssemblyBegin</A>(), <A HREF="../Mat/MatSetValues.html#MatSetValues">MatSetValues</A>(), <A HREF="../Draw/PetscDrawOpenX.html#PetscDrawOpenX">PetscDrawOpenX</A>(), <A HREF="../Draw/PetscDrawCreate.html#PetscDrawCreate">PetscDrawCreate</A>(), <A HREF="../Mat/MatView.html#MatView">MatView</A>(), <A HREF="../Mat/MatAssembled.html#MatAssembled">MatAssembled</A>(), <A HREF="../Viewer/PetscViewerSocketOpen.html#PetscViewerSocketOpen">PetscViewerSocketOpen</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#MatAssemblyEnd">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/dm/impls/da/hypre/mhyp.c.html#MatAssemblyEnd_HYPREStruct">MatAssemblyEnd_HYPREStruct in src/dm/impls/da/hypre/mhyp.c</A><BR>
<A HREF="../../../src/dm/impls/da/hypre/mhyp.c.html#MatAssemblyEnd_HYPRESStruct">MatAssemblyEnd_HYPRESStruct in src/dm/impls/da/hypre/mhyp.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/crl/mcrl.c.html#MatAssemblyEnd_MPIAIJCRL">MatAssemblyEnd_MPIAIJCRL in src/mat/impls/aij/mpi/crl/mcrl.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/mpiaij.c.html#MatAssemblyEnd_MPIAIJ">MatAssemblyEnd_MPIAIJ in src/mat/impls/aij/mpi/mpiaij.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/mpicusparse/mpiaijcusparse.cu.html#MatAssemblyEnd_MPIAIJCUSPARSE">MatAssemblyEnd_MPIAIJCUSPARSE in src/mat/impls/aij/mpi/mpicusparse/mpiaijcusparse.cu</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/mpiviennacl/mpiaijviennacl.cxx.html#MatAssemblyEnd_MPIAIJViennaCL">MatAssemblyEnd_MPIAIJViennaCL in src/mat/impls/aij/mpi/mpiviennacl/mpiaijviennacl.cxx</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aij.c.html#MatAssemblyEnd_SeqAIJ">MatAssemblyEnd_SeqAIJ in src/mat/impls/aij/seq/aij.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aijmkl/aijmkl.c.html#MatAssemblyEnd_SeqAIJMKL">MatAssemblyEnd_SeqAIJMKL in src/mat/impls/aij/seq/aijmkl/aijmkl.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aijperm/aijperm.c.html#MatAssemblyEnd_SeqAIJPERM">MatAssemblyEnd_SeqAIJPERM in src/mat/impls/aij/seq/aijperm/aijperm.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aijsell/aijsell.c.html#MatAssemblyEnd_SeqAIJSELL">MatAssemblyEnd_SeqAIJSELL in src/mat/impls/aij/seq/aijsell/aijsell.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/crl/crl.c.html#MatAssemblyEnd_SeqAIJCRL">MatAssemblyEnd_SeqAIJCRL in src/mat/impls/aij/seq/crl/crl.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/inode2.c.html#MatAssemblyEnd_SeqAIJ_Inode">MatAssemblyEnd_SeqAIJ_Inode in src/mat/impls/aij/seq/inode2.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/seqcusparse/aijcusparse.cu.html#MatAssemblyEnd_SeqAIJCUSPARSE">MatAssemblyEnd_SeqAIJCUSPARSE in src/mat/impls/aij/seq/seqcusparse/aijcusparse.cu</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/seqviennacl/aijviennacl.cxx.html#MatAssemblyEnd_SeqAIJViennaCL">MatAssemblyEnd_SeqAIJViennaCL in src/mat/impls/aij/seq/seqviennacl/aijviennacl.cxx</A><BR>
<A HREF="../../../src/mat/impls/baij/mpi/mpibaij.c.html#MatAssemblyEnd_MPIBAIJ">MatAssemblyEnd_MPIBAIJ in src/mat/impls/baij/mpi/mpibaij.c</A><BR>
<A HREF="../../../src/mat/impls/baij/seq/baij.c.html#MatAssemblyEnd_SeqBAIJ">MatAssemblyEnd_SeqBAIJ in src/mat/impls/baij/seq/baij.c</A><BR>
<A HREF="../../../src/mat/impls/baij/seq/baijmkl/baijmkl.c.html#MatAssemblyEnd_SeqBAIJMKL">MatAssemblyEnd_SeqBAIJMKL in src/mat/impls/baij/seq/baijmkl/baijmkl.c</A><BR>
<A HREF="../../../src/mat/impls/blockmat/seq/blockmat.c.html#MatAssemblyEnd_BlockMat">MatAssemblyEnd_BlockMat in src/mat/impls/blockmat/seq/blockmat.c</A><BR>
<A HREF="../../../src/mat/impls/composite/mcomposite.c.html#MatAssemblyEnd_Composite">MatAssemblyEnd_Composite in src/mat/impls/composite/mcomposite.c</A><BR>
<A HREF="../../../src/mat/impls/dense/mpi/mpidense.c.html#MatAssemblyEnd_MPIDense">MatAssemblyEnd_MPIDense in src/mat/impls/dense/mpi/mpidense.c</A><BR>
<A HREF="../../../src/mat/impls/dense/seq/dense.c.html#MatAssemblyEnd_SeqDense">MatAssemblyEnd_SeqDense in src/mat/impls/dense/seq/dense.c</A><BR>
<A HREF="../../../src/mat/impls/elemental/matelem.cxx.html#MatAssemblyEnd_Elemental">MatAssemblyEnd_Elemental in src/mat/impls/elemental/matelem.cxx</A><BR>
<A HREF="../../../src/mat/impls/hypre/mhypre.c.html#MatAssemblyEnd_HYPRE">MatAssemblyEnd_HYPRE in src/mat/impls/hypre/mhypre.c</A><BR>
<A HREF="../../../src/mat/impls/is/matis.c.html#MatAssemblyEnd_IS">MatAssemblyEnd_IS in src/mat/impls/is/matis.c</A><BR>
<A HREF="../../../src/mat/impls/mffd/mffd.c.html#MatAssemblyEnd_MFFD">MatAssemblyEnd_MFFD in src/mat/impls/mffd/mffd.c</A><BR>
<A HREF="../../../src/mat/impls/nest/matnest.c.html#MatAssemblyEnd_Nest">MatAssemblyEnd_Nest in src/mat/impls/nest/matnest.c</A><BR>
<A HREF="../../../src/mat/impls/preallocator/matpreallocator.c.html#MatAssemblyEnd_Preallocator">MatAssemblyEnd_Preallocator in src/mat/impls/preallocator/matpreallocator.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/mpi/mpisbaij.c.html#MatAssemblyEnd_MPISBAIJ">MatAssemblyEnd_MPISBAIJ in src/mat/impls/sbaij/mpi/mpisbaij.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/seq/sbaij.c.html#MatAssemblyEnd_SeqSBAIJ_SeqAIJ_Inode">MatAssemblyEnd_SeqSBAIJ_SeqAIJ_Inode in src/mat/impls/sbaij/seq/sbaij.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/seq/sbaij.c.html#MatAssemblyEnd_SeqSBAIJ">MatAssemblyEnd_SeqSBAIJ in src/mat/impls/sbaij/seq/sbaij.c</A><BR>
<A HREF="../../../src/mat/impls/sell/mpi/mpisell.c.html#MatAssemblyEnd_MPISELL">MatAssemblyEnd_MPISELL in src/mat/impls/sell/mpi/mpisell.c</A><BR>
<A HREF="../../../src/mat/impls/sell/seq/sell.c.html#MatAssemblyEnd_SeqSELL">MatAssemblyEnd_SeqSELL in src/mat/impls/sell/seq/sell.c</A><BR>
<A HREF="../../../src/mat/impls/shell/shell.c.html#MatAssemblyEnd_Shell">MatAssemblyEnd_Shell in src/mat/impls/shell/shell.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>