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
|
<!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/MatFactorInfo.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatFactorInfo</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.7.5 2017-01-01</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.7.5 v3.7.5 docs/manualpages/Mat/MatFactorInfo.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatFactorInfo"><H1>MatFactorInfo</H1></A>
Data passed into the matrix factorization routines, and information about the resulting factorization
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
typedef struct {
<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> diagonal_fill; /* force diagonal to fill in if initially not filled */
<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> usedt;
<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> dt; /* drop tolerance */
<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> dtcol; /* tolerance for pivoting */
<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> dtcount; /* maximum nonzeros to be allowed per row */
<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> fill; /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> levels; /* ICC/ILU(levels) */
<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
factorization may be faster if do not pivot */
<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> zeropivot; /* pivot is called zero if less than this */
<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> shifttype; /* type of shift added to matrix factor to prevent zero pivots */
<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> shiftamount; /* how large the shift is */
} <A HREF="../Mat/MatFactorInfo.html#MatFactorInfo">MatFactorInfo</A>;
</PRE>
In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use
<pre>
<A HREF="../Mat/MatFactorInfo.html#MatFactorInfo">MatFactorInfo</A> info(MAT_FACTORINFO_SIZE)
</pre>
<P>
Notes: These are not usually directly used by users, instead use <A HREF="../PC/PC.html#PC">PC</A> type of LU, ILU, CHOLESKY or ICC.
<P>
You can use <A HREF="../Mat/MatFactorInfoInitialize.html#MatFactorInfoInitialize">MatFactorInfoInitialize</A>() to set default values.
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Mat/MatLUFactorSymbolic.html#MatLUFactorSymbolic">MatLUFactorSymbolic</A>(), <A HREF="../Mat/MatILUFactorSymbolic.html#MatILUFactorSymbolic">MatILUFactorSymbolic</A>(), <A HREF="../Mat/MatCholeskyFactorSymbolic.html#MatCholeskyFactorSymbolic">MatCholeskyFactorSymbolic</A>(), <A HREF="../Mat/MatICCFactorSymbolic.html#MatICCFactorSymbolic">MatICCFactorSymbolic</A>(), <A HREF="../Mat/MatICCFactor.html#MatICCFactor">MatICCFactor</A>(),
<BR><A HREF="../Mat/MatFactorInfoInitialize.html#MatFactorInfoInitialize">MatFactorInfoInitialize</A>()
<P>
<P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>developer
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/mat/../../include/petscmat.h.html#MatFactorInfo">src/mat/../../include/petscmat.h</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>
|
