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
|
<!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/MatILUFactorSymbolic.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatILUFactorSymbolic</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.14.5 2021-03-03</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.14.5 v3.14.5 docs/manualpages/Mat/MatILUFactorSymbolic.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatILUFactorSymbolic"><H1>MatILUFactorSymbolic</H1></A>
Performs symbolic ILU factorization of a matrix. Uses levels of fill only, not drop tolerance. Use <A HREF="../Mat/MatLUFactorNumeric.html#MatLUFactorNumeric">MatLUFactorNumeric</A>() to complete the factorization.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Mat/MatILUFactorSymbolic.html#MatILUFactorSymbolic">MatILUFactorSymbolic</A>(<A HREF="../Mat/Mat.html#Mat">Mat</A> fact,<A HREF="../Mat/Mat.html#Mat">Mat</A> mat,<A HREF="../IS/IS.html#IS">IS</A> row,<A HREF="../IS/IS.html#IS">IS</A> col,const <A HREF="../Mat/MatFactorInfo.html#MatFactorInfo">MatFactorInfo</A> *info)
</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>row </B></TD><TD>- row permutation
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>column </B></TD><TD>- column permutation
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>info </B></TD><TD>- structure containing
</TD></TR></TABLE>
<pre>
levels - number of levels of fill.
</pre>
<pre>
expected fill - as ratio of original fill.
</pre>
<pre>
1 or 0 - indicating force fill on diagonal (improves robustness for matrices
</pre>
missing diagonal entries)
<P>
<H3><FONT COLOR="#CC3333">Output Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>fact </B></TD><TD>- new matrix that has been symbolically factored
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
See Users-Manual: ch_mat for additional information about choosing the fill factor for better efficiency.
<P>
Most users should employ the simplified <A HREF="../KSP/KSP.html#KSP">KSP</A> interface for linear solvers
instead of working directly with matrix algebra routines such as this.
See, e.g., <A HREF="../KSP/KSPCreate.html#KSPCreate">KSPCreate</A>().
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Mat/MatLUFactorSymbolic.html#MatLUFactorSymbolic">MatLUFactorSymbolic</A>(), <A HREF="../Mat/MatLUFactorNumeric.html#MatLUFactorNumeric">MatLUFactorNumeric</A>(), <A HREF="../Mat/MatCholeskyFactor.html#MatCholeskyFactor">MatCholeskyFactor</A>()
<BR><A HREF="../MatOrderings/MatGetOrdering.html#MatGetOrdering">MatGetOrdering</A>(), <A HREF="../Mat/MatFactorInfo.html#MatFactorInfo">MatFactorInfo</A>
<P>
Note: this uses the definition of level of fill as in Y. Saad, 2003
<P>
Developer Note: fortran interface is not autogenerated as the f90
interface defintion cannot be generated correctly [due to <A HREF="../Mat/MatFactorInfo.html#MatFactorInfo">MatFactorInfo</A>]
<P>
<H3><FONT COLOR="#CC3333">References</FONT></H3>
Y. Saad, Iterative methods for sparse linear systems Philadelphia: Society for Industrial and Applied Mathematics, 2003
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>developer<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/mat/interface/matrix.c.html#MatILUFactorSymbolic">src/mat/interface/matrix.c</A>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/mat/impls/aij/seq/aijfact.c.html#MatILUFactorSymbolic_SeqAIJ_ilu0">MatILUFactorSymbolic_SeqAIJ_ilu0 in src/mat/impls/aij/seq/aijfact.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aijfact.c.html#MatILUFactorSymbolic_SeqAIJ">MatILUFactorSymbolic_SeqAIJ in src/mat/impls/aij/seq/aijfact.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aijfact.c.html#MatILUFactorSymbolic_SeqAIJ_inplace">MatILUFactorSymbolic_SeqAIJ_inplace in src/mat/impls/aij/seq/aijfact.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/seqcusparse/aijcusparse.cu.html#MatILUFactorSymbolic_SeqAIJCUSPARSE">MatILUFactorSymbolic_SeqAIJCUSPARSE in src/mat/impls/aij/seq/seqcusparse/aijcusparse.cu</A><BR>
<A HREF="../../../src/mat/impls/baij/seq/baijfact2.c.html#MatILUFactorSymbolic_SeqBAIJ_ilu0">MatILUFactorSymbolic_SeqBAIJ_ilu0 in src/mat/impls/baij/seq/baijfact2.c</A><BR>
<A HREF="../../../src/mat/impls/baij/seq/baijfact2.c.html#MatILUFactorSymbolic_SeqBAIJ">MatILUFactorSymbolic_SeqBAIJ in src/mat/impls/baij/seq/baijfact2.c</A><BR>
<A HREF="../../../src/mat/impls/baij/seq/baijfact2.c.html#MatILUFactorSymbolic_SeqBAIJ_inplace">MatILUFactorSymbolic_SeqBAIJ_inplace in src/mat/impls/baij/seq/baijfact2.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>
|
