File: STSetMatStructure.html

package info (click to toggle)
slepc 3.7.3%2Bdfsg1-5
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 23,788 kB
  • ctags: 100,221
  • sloc: ansic: 79,324; makefile: 3,897; python: 2,734; fortran: 1,139; f90: 225; sh: 100
file content (51 lines) | stat: -rw-r--r-- 2,775 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://slepc.upv.es/documentation/current/docs/manualpages/ST/STSetMatStructure.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>STSetMatStructure</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>slepc-3.7.3 2016-09-29</b></div>
   <div id="bugreport" align=right><a href="mailto:slepc-maint@upv.es?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: slepc-3.7.3 v3.7.3 docs/manualpages/ST/STSetMatStructure.html "><small>Report Typos and Errors</small></a></div>

<H1>STSetMatStructure</H1>
Sets an internal MatStructure attribute to indicate which is the relation of the sparsity pattern of all <A HREF="../ST/ST.html#ST">ST</A> matrices. 
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcst.h" 
PetscErrorCode STSetMatStructure(ST st,MatStructure str)
</PRE>
Logically Collective on <A HREF="../ST/ST.html#ST">ST</A>
<P>
<H3><FONT COLOR="#883300">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>st  </B></TD><TD>&nbsp;- the spectral transformation context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>str </B></TD><TD>&nbsp;- either SAME_NONZERO_PATTERN, DIFFERENT_NONZERO_PATTERN or
SUBSET_NONZERO_PATTERN
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Options Database Key</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0"><TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-st_matstructure &lt;str&gt; </B></TD><TD>&nbsp;- Indicates the structure flag, where &lt;str&gt; is one
of 'same' (matrices have the same nonzero pattern), 'different'
(different nonzero pattern) or 'subset' (pattern is a subset of the
first one).
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
By default, the sparsity patterns are assumed to be different. If the
patterns are equal or a subset then it is recommended to set this attribute
for efficiency reasons (in particular, for internal MatAXPY() operations).
<P>
This function has no effect in the case of standard eigenproblems.
<P>

<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
 <A HREF="../ST/STSetOperators.html#STSetOperators">STSetOperators</A>(), MatAXPY()
<BR><P><B><FONT COLOR="#883300">Location: </FONT></B><A HREF="../../../src/sys/classes/st/interface/stset.c.html#STSetMatStructure">src/sys/classes/st/interface/stset.c</A>
<BR><A HREF="./index.html">Index of all ST 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>