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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="https://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.22.2 2024-12-02</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.22.2 v3.22.2 docs/manualpages/ST/STSetMatStructure.html "><small>Report Typos and Errors</small></a></div>
<H1>STSetMatStructure</H1>
Sets an internal <A HREF="https://petsc.org/release/manualpages/Mat/MatStructure.html#MatStructure">MatStructure</A> 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"
<A HREF="https://petsc.org/release/manualpages/Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../ST/STSetMatStructure.html#STSetMatStructure">STSetMatStructure</A>(<A HREF="../ST/ST.html#ST">ST</A> st,<A HREF="https://petsc.org/release/manualpages/Mat/MatStructure.html#MatStructure">MatStructure</A> str)
</PRE>
Logically Collective
<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> - the spectral transformation context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>str </B></TD><TD> - either <A HREF="https://petsc.org/release/manualpages/Mat/MatStructure.html#MatStructure">SAME_NONZERO_PATTERN</A>, <A HREF="https://petsc.org/release/manualpages/Mat/MatStructure.html#MatStructure">DIFFERENT_NONZERO_PATTERN</A>,
<A HREF="https://petsc.org/release/manualpages/Mat/MatStructure.html#MatStructure">SUBSET_NONZERO_PATTERN</A>, or <A HREF="https://petsc.org/release/manualpages/Mat/MatStructure.html#MatStructure">UNKNOWN_NONZERO_PATTERN</A>
</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 <str> </B></TD><TD> - Indicates the structure flag, where <str> is one
of 'same' (matrices have the same nonzero pattern), 'different'
(different nonzero pattern), 'subset' (pattern is a subset of the
first one), or 'unknown'.
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
If the sparsity pattern of the second matrix is equal or a subset of the
pattern of the first matrix then it is recommended to set this attribute
for efficiency reasons (in particular, for internal <A HREF="https://petsc.org/release/manualpages/Mat/MatAXPY.html#MatAXPY">MatAXPY</A>() operations).
If not set, the default is <A HREF="https://petsc.org/release/manualpages/Mat/MatStructure.html#MatStructure">UNKNOWN_NONZERO_PATTERN</A>, in which case the patterns
will be compared to determine if they are equal.
<P>
This function has no effect in the case of standard eigenproblems.
<P>
In case of polynomial eigenproblems, the flag applies to all matrices
relative to the first one.
<P>
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
<A HREF="../ST/STSetMatrices.html#STSetMatrices">STSetMatrices</A>(), <A HREF="https://petsc.org/release/manualpages/Mat/MatAXPY.html#MatAXPY">MatAXPY</A>()
<BR><P><B></B><H3><FONT COLOR="#883300">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#883300">Location</FONT></H3>
</B><A HREF="../../../src/sys/classes/st/interface/stset.c.html#STSetMatStructure">src/sys/classes/st/interface/stset.c</A>
<BR><BR><A HREF="./index.html">Index of all ST routines</A>
<BR><A HREF="../../../docs/manual.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
</BODY></HTML>
|
