File: MatOption.html

package info (click to toggle)
petsc 3.14.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 266,472 kB
  • sloc: ansic: 680,898; python: 33,303; cpp: 16,324; makefile: 14,022; f90: 13,731; javascript: 10,713; fortran: 9,581; sh: 1,373; xml: 619; objc: 445; csh: 192; pascal: 148; java: 13
file content (70 lines) | stat: -rw-r--r-- 5,131 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
<!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/MatOption.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatOption</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>petsc-3.14.5 2021-03-03</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.14.5 v3.14.5 docs/manualpages/Mat/MatOption.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatOption"><H1>MatOption</H1></A>
Options that may be set for a matrix and its behavior or storage 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
typedef enum {<A HREF="../Mat/MatOption.html#MatOption">MAT_OPTION_MIN</A> = -3,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_UNUSED_NONZERO_LOCATION_ERR</A> = -2,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_ROW_ORIENTED</A> = -1,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_SYMMETRIC</A> = 1,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_STRUCTURALLY_SYMMETRIC</A> = 2,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_NEW_DIAGONALS</A> = 3,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_IGNORE_OFF_PROC_ENTRIES</A> = 4,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_USE_HASH_TABLE</A> = 5,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_KEEP_NONZERO_PATTERN</A> = 6,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_IGNORE_ZERO_ENTRIES</A> = 7,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_USE_INODES</A> = 8,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_HERMITIAN</A> = 9,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_SYMMETRY_ETERNAL</A> = 10,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_NEW_NONZERO_LOCATION_ERR</A> = 11,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_IGNORE_LOWER_TRIANGULAR</A> = 12,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_ERROR_LOWER_TRIANGULAR</A> = 13,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_GETROW_UPPERTRIANGULAR</A> = 14,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_SPD</A> = 15,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_NO_OFF_PROC_ZERO_ROWS</A> = 16,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_NO_OFF_PROC_ENTRIES</A> = 17,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_NEW_NONZERO_LOCATIONS</A> = 18,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_NEW_NONZERO_ALLOCATION_ERR</A> = 19,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_SUBSET_OFF_PROC_ENTRIES</A> = 20,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_SUBMAT_SINGLEIS</A> = 21,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_STRUCTURE_ONLY</A> = 22,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_SORTED_FULL</A> = 23,
              <A HREF="../Mat/MatOption.html#MatOption">MAT_OPTION_MAX</A> = 24} <A HREF="../Mat/MatOption.html#MatOption">MatOption</A>;
</PRE>

<P>
Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
Any additions/changes here must also be made in src/mat/interface/dlregismat.c in MatOptions[]
<P>
<H3><FONT COLOR="#CC3333">Developer Notes</FONT></H3>
Entries that are negative need not be called collectively by all processes.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../Mat/MatSetOption.html#MatSetOption">MatSetOption</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>beginner<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/mat/../../include/petscmat.h.html#MatOption">src/mat/../../include/petscmat.h</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/mat/tutorials/ex4.c.html">src/mat/tutorials/ex4.c.html</A><BR>
<A HREF="../../../src/mat/tutorials/ex10.c.html">src/mat/tutorials/ex10.c.html</A><BR>
<A HREF="../../../src/mat/tutorials/ex12.c.html">src/mat/tutorials/ex12.c.html</A><BR>
<A HREF="../../../src/mat/tutorials/ex16.c.html">src/mat/tutorials/ex16.c.html</A><BR>
<A HREF="../../../src/mat/tutorials/ex4f.F90.html">src/mat/tutorials/ex4f.F90.html</A><BR>
<A HREF="../../../src/ksp/pc/tutorials/ex3.c.html">src/ksp/pc/tutorials/ex3.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex2.c.html">src/ksp/ksp/tutorials/ex2.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex4.c.html">src/ksp/ksp/tutorials/ex4.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex5.c.html">src/ksp/ksp/tutorials/ex5.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex6.c.html">src/ksp/ksp/tutorials/ex6.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex9.c.html">src/ksp/ksp/tutorials/ex9.c.html</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>