File: MatGetOrdering.html

package info (click to toggle)
petsc 2.1.3-1.woody.1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 70,272 kB
  • ctags: 310,869
  • sloc: ansic: 257,275; sh: 9,870; makefile: 7,622; fortran: 6,211; cpp: 1,026; python: 416; csh: 41; asm: 9
file content (74 lines) | stat: -rw-r--r-- 3,309 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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatGetOrdering</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<A NAME="MatGetOrdering"><H1>MatGetOrdering</H1></A>
Gets a reordering for a matrix to reduce fill or to improve numerical stability of LU factorization. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
int MatGetOrdering(Mat mat,MatOrderingType type,IS *rperm,IS *cperm)
</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>- type of reordering, one of the following:
</TD></TR></TABLE>
<pre>
     MATORDERING_NATURAL - Natural
</pre>
<pre>
     MATORDERING_ND - Nested Dissection
</pre>
<pre>
     MATORDERING_1WD - One-way Dissection
</pre>
<pre>
     MATORDERING_RCM - Reverse Cuthill-McKee
</pre>
<pre>
     MATORDERING_QMD - Quotient Minimum Degree
</pre>
<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>rperm </B></TD><TD>- row permutation indices
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>cperm </B></TD><TD>- column permutation indices
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Options Database</FONT></H3>
<DT><B>-mat_view_ordering_draw </B> -plots matrix nonzero structure in new ordering
<br>
<P>

<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
This DOES NOT actually reorder the matrix; it merely returns two index sets
that define a reordering. This is usually not used directly, rather use the
options <A HREF="../PC/PCLUSetMatOrdering.html#PCLUSetMatOrdering">PCLUSetMatOrdering</A>() or <A HREF="../PC/PCILUSetMatOrdering.html#PCILUSetMatOrdering">PCILUSetMatOrdering</A>().
<P>
The user can define additional orderings; see <A HREF="../MatOrderings/MatOrderingRegisterDynamic.html#MatOrderingRegisterDynamic">MatOrderingRegisterDynamic</A>().
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
 matrix, set, ordering, factorization, direct, ILU, LU,
<BR>fill, reordering, natural, Nested Dissection,
One-way Dissection, Cholesky, Reverse Cuthill-McKee,
Quotient Minimum Degree
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
   <A HREF="../MatOrderings/MatOrderingRegisterDynamic.html#MatOrderingRegisterDynamic">MatOrderingRegisterDynamic</A>(), <A HREF="../PC/PCLUSetMatOrdering.html#PCLUSetMatOrdering">PCLUSetMatOrdering</A>(), <A HREF="../PC/PCILUSetMatOrdering.html#PCILUSetMatOrdering">PCILUSetMatOrdering</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>intermediate
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/mat/order/sorder.c.html#MatGetOrdering">src/mat/order/sorder.c</A>
<BR><A HREF="./index.html">Index of all MatOrderings 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>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/mat/examples/tutorials/ex1.c.html">src/mat/examples/tutorials/ex1.c.html</A><BR>
</BODY></HTML>