File: MATSOLVERCHOLMOD.html

package info (click to toggle)
petsc 3.7.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 163,864 kB
  • ctags: 618,438
  • sloc: ansic: 515,133; python: 29,793; makefile: 20,458; fortran: 18,998; cpp: 6,515; f90: 3,914; sh: 1,012; xml: 621; objc: 445; csh: 240; java: 13
file content (57 lines) | stat: -rw-r--r-- 4,450 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
 
<!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/MATSOLVERCHOLMOD.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MATSOLVERCHOLMOD</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/MATSOLVERCHOLMOD.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MATSOLVERCHOLMOD"><H1>MATSOLVERCHOLMOD</H1></A>
"cholmod" - A matrix type providing direct solvers (Cholesky) for sequential matrices via the external package CHOLMOD. Use ./configure --download-suitesparse to install PETSc to use CHOLMOD
<P>
Use -pc_type lu -pc_factor_mat_solver_package cholmod to use this direct solver
<P>
Consult CHOLMOD documentation for more information about the Common parameters
which correspond to the options database keys below.
<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_cholmod_dbound &lt;0&gt;          </B></TD><TD>- Minimum absolute value of diagonal entries of D (None)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_cholmod_grow0 &lt;1.2&gt;         </B></TD><TD>- Global growth ratio when factors are modified (None)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_cholmod_grow1 &lt;1.2&gt;         </B></TD><TD>- Column growth ratio when factors are modified (None)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_cholmod_grow2 &lt;5&gt;           </B></TD><TD>- Affine column growth constant when factors are modified (None)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_cholmod_maxrank &lt;8&gt;         </B></TD><TD>- Max rank of update, larger values are faster but use more memory [2,4,8] (None)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_cholmod_factor &lt;AUTO&gt;       </B></TD><TD>- (choose one of) SIMPLICIAL AUTO SUPERNODAL
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_cholmod_supernodal_switch &lt;40&gt; </B></TD><TD>- flop/nnz_L threshold for switching to supernodal factorization (None)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_cholmod_final_asis &lt;TRUE&gt;   </B></TD><TD>- Leave factors "as is" (None)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_cholmod_final_pack &lt;TRUE&gt;   </B></TD><TD>- Pack the columns when finished (use FALSE if the factors will be updated later) (None)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_cholmod_zrelax &lt;0.8&gt;        </B></TD><TD>- 3 real supernodal relaxed amalgamation parameters (None)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_cholmod_nrelax &lt;4&gt;          </B></TD><TD>- 3 size_t supernodal relaxed amalgamation parameters (None)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_cholmod_prefer_upper &lt;TRUE&gt; </B></TD><TD>- Work with upper triangular form (faster when using fill-reducing ordering, slower in natural ordering) (None)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_cholmod_print &lt;3&gt;           </B></TD><TD>- Verbosity level (None)
</TD></TR></TABLE>
<P>

<P>
Note: CHOLMOD is part of SuiteSparse <a href="http://faculty.cse.tamu.edu/davis/suitesparse.html">http://faculty.cse.tamu.edu/davis/suitesparse.html </a> <P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../PC/PCCHOLESKY.html#PCCHOLESKY">PCCHOLESKY</A>, <A HREF="../PC/PCFactorSetMatSolverPackage.html#PCFactorSetMatSolverPackage">PCFactorSetMatSolverPackage</A>(), <A HREF="../Mat/MatSolverPackage.html#MatSolverPackage">MatSolverPackage</A>
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>beginner
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/mat/impls/sbaij/seq/cholmod/sbaijcholmod.c.html#MATSOLVERCHOLMOD">src/mat/impls/sbaij/seq/cholmod/sbaijcholmod.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>
</BODY></HTML>