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
|
<!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/MatGetFactorAvailable.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatGetFactorAvailable</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/MatGetFactorAvailable.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatGetFactorAvailable"><H1>MatGetFactorAvailable</H1></A>
Returns a a flag if matrix supports particular package and factor type
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Mat/MatGetFactorAvailable.html#MatGetFactorAvailable">MatGetFactorAvailable</A>(<A HREF="../Mat/Mat.html#Mat">Mat</A> mat, <A HREF="../Mat/MatSolverType.html#MatSolverType">MatSolverType</A> type,<A HREF="../Mat/MatFactorType.html#MatFactorType">MatFactorType</A> ftype,<A HREF="../Sys/PetscBool.html#PetscBool">PetscBool</A> *flg)
</PRE>
Not Collective
<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>- name of solver type, for example, superlu, petsc (to use PETSc's default)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ftype </B></TD><TD>- factor type, <A HREF="../Mat/MatFactorType.html#MatFactorType">MAT_FACTOR_LU</A>, <A HREF="../Mat/MatFactorType.html#MatFactorType">MAT_FACTOR_CHOLESKY</A>, <A HREF="../Mat/MatFactorType.html#MatFactorType">MAT_FACTOR_ICC</A>, <A HREF="../Mat/MatFactorType.html#MatFactorType">MAT_FACTOR_ILU</A>,
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<DT><B>flg </B> -<A HREF="../Sys/PETSC_TRUE.html#PETSC_TRUE">PETSC_TRUE</A> if the factorization is available
<br>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Some PETSc matrix formats have alternative solvers available that are contained in alternative packages
such as pastix, superlu, mumps etc.
<P>
PETSc must have been ./configure to use the external solver, using the option --download-package
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Mat/MatCopy.html#MatCopy">MatCopy</A>(), <A HREF="../Mat/MatDuplicate.html#MatDuplicate">MatDuplicate</A>(), <A HREF="../Mat/MatGetFactor.html#MatGetFactor">MatGetFactor</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/mat/interface/matrix.c.html#MatGetFactorAvailable">src/mat/interface/matrix.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>
|
