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
|
<!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/MatGetFactor.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatGetFactor</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/MatGetFactor.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatGetFactor"><H1>MatGetFactor</H1></A>
Returns a matrix suitable to calls to MatXXFactorSymbolic()
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Mat/MatGetFactor.html#MatGetFactor">MatGetFactor</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="../Mat/Mat.html#Mat">Mat</A> *f)
</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>- 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 Parameters</FONT></H3>
<DT><B>f </B> -the factor matrix used with MatXXFactorSymbolic() calls
<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/MatGetFactorAvailable.html#MatGetFactorAvailable">MatGetFactorAvailable</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#MatGetFactor">src/mat/interface/matrix.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex52.c.html">src/ksp/ksp/examples/tutorials/ex52.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/mat/impls/aij/mpi/clique/clique.cxx.html#MatGetFactor_aij_sparseelemental">MatGetFactor_aij_sparseelemental in src/mat/impls/aij/mpi/clique/clique.cxx</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/mkl_cpardiso/mkl_cpardiso.c.html#MatGetFactor_mpiaij_mkl_cpardiso">MatGetFactor_mpiaij_mkl_cpardiso in src/mat/impls/aij/mpi/mkl_cpardiso/mkl_cpardiso.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/mumps/mumps.c.html#MatGetFactor_aij_mumps">MatGetFactor_aij_mumps in src/mat/impls/aij/mpi/mumps/mumps.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/mumps/mumps.c.html#MatGetFactor_sbaij_mumps">MatGetFactor_sbaij_mumps in src/mat/impls/aij/mpi/mumps/mumps.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/mumps/mumps.c.html#MatGetFactor_baij_mumps">MatGetFactor_baij_mumps in src/mat/impls/aij/mpi/mumps/mumps.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/mumps/mumps.c.html#MatGetFactor_sell_mumps">MatGetFactor_sell_mumps in src/mat/impls/aij/mpi/mumps/mumps.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/pastix/pastix.c.html#MatGetFactor_seqaij_pastix">MatGetFactor_seqaij_pastix in src/mat/impls/aij/mpi/pastix/pastix.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/pastix/pastix.c.html#MatGetFactor_mpiaij_pastix">MatGetFactor_mpiaij_pastix in src/mat/impls/aij/mpi/pastix/pastix.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/pastix/pastix.c.html#MatGetFactor_seqsbaij_pastix">MatGetFactor_seqsbaij_pastix in src/mat/impls/aij/mpi/pastix/pastix.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/pastix/pastix.c.html#MatGetFactor_mpisbaij_pastix">MatGetFactor_mpisbaij_pastix in src/mat/impls/aij/mpi/pastix/pastix.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/strumpack/strumpack.c.html#MatGetFactor_aij_strumpack">MatGetFactor_aij_strumpack in src/mat/impls/aij/mpi/strumpack/strumpack.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/superlu_dist/superlu_dist.c.html#MatGetFactor_aij_superlu_dist">MatGetFactor_aij_superlu_dist in src/mat/impls/aij/mpi/superlu_dist/superlu_dist.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aijfact.c.html#MatGetFactor_seqaij_petsc">MatGetFactor_seqaij_petsc in src/mat/impls/aij/seq/aijfact.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/bas/basfactor.c.html#MatGetFactor_seqaij_bas">MatGetFactor_seqaij_bas in src/mat/impls/aij/seq/bas/basfactor.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/cholmod/aijcholmod.c.html#MatGetFactor_seqaij_cholmod">MatGetFactor_seqaij_cholmod in src/mat/impls/aij/seq/cholmod/aijcholmod.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/essl/essl.c.html#MatGetFactor_seqaij_essl">MatGetFactor_seqaij_essl in src/mat/impls/aij/seq/essl/essl.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/klu/klu.c.html#MatGetFactor_seqaij_klu">MatGetFactor_seqaij_klu in src/mat/impls/aij/seq/klu/klu.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/lusol/lusol.c.html#MatGetFactor_seqaij_lusol">MatGetFactor_seqaij_lusol in src/mat/impls/aij/seq/lusol/lusol.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/matlab/aijmatlab.c.html#MatGetFactor_seqaij_matlab">MatGetFactor_seqaij_matlab in src/mat/impls/aij/seq/matlab/aijmatlab.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/mkl_pardiso/mkl_pardiso.c.html#MatGetFactor_aij_mkl_pardiso">MatGetFactor_aij_mkl_pardiso in src/mat/impls/aij/seq/mkl_pardiso/mkl_pardiso.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/seqcusparse/aijcusparse.cu.html#MatGetFactor_seqaijcusparse_cusparse">MatGetFactor_seqaijcusparse_cusparse in src/mat/impls/aij/seq/seqcusparse/aijcusparse.cu</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/superlu/superlu.c.html#MatGetFactor_seqaij_superlu">MatGetFactor_seqaij_superlu in src/mat/impls/aij/seq/superlu/superlu.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/superlu/superlu.c.html#MatGetFactor_seqsell_superlu">MatGetFactor_seqsell_superlu in src/mat/impls/aij/seq/superlu/superlu.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/umfpack/umfpack.c.html#MatGetFactor_seqaij_umfpack">MatGetFactor_seqaij_umfpack in src/mat/impls/aij/seq/umfpack/umfpack.c</A><BR>
<A HREF="../../../src/mat/impls/baij/seq/baijfact.c.html#MatGetFactor_seqbaij_petsc">MatGetFactor_seqbaij_petsc in src/mat/impls/baij/seq/baijfact.c</A><BR>
<A HREF="../../../src/mat/impls/dense/seq/dense.c.html#MatGetFactor_seqdense_petsc">MatGetFactor_seqdense_petsc in src/mat/impls/dense/seq/dense.c</A><BR>
<A HREF="../../../src/mat/impls/elemental/matelem.cxx.html#MatGetFactor_elemental_elemental">MatGetFactor_elemental_elemental in src/mat/impls/elemental/matelem.cxx</A><BR>
<A HREF="../../../src/mat/impls/sbaij/seq/cholmod/sbaijcholmod.c.html#MatGetFactor_seqsbaij_cholmod">MatGetFactor_seqsbaij_cholmod in src/mat/impls/sbaij/seq/cholmod/sbaijcholmod.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/seq/sbaij.c.html#MatGetFactor_seqsbaij_petsc">MatGetFactor_seqsbaij_petsc in src/mat/impls/sbaij/seq/sbaij.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>
|
