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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="https://slepc.upv.es/documentation/current//Users/jroman/tmp/slepc-3.23.1/docs/manualpages/ST/STMatSetUp.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>STMatSetUp</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>slepc-3.23.1 2025-05-01</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.23.1 v3.23.1 /Users/jroman/tmp/slepc-3.23.1/docs/manualpages/ST/STMatSetUp.html "><small>Report Typos and Errors</small></a></div>
<H1>STMatSetUp</H1>
Build the preconditioner matrix used in <A HREF="../ST/STMatSolve.html#STMatSolve">STMatSolve</A>().
<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/STMatSetUp.html#STMatSetUp">STMatSetUp</A>(<A HREF="../ST/ST.html#ST">ST</A> st,<A HREF="https://petsc.org/release/manualpages/Sys/PetscScalar.html#PetscScalar">PetscScalar</A> sigma,<A HREF="https://petsc.org/release/manualpages/Sys/PetscScalar.html#PetscScalar">PetscScalar</A> *coeffs)
</PRE>
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>sigma </B></TD><TD> - the shift
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>coeffs </B></TD><TD> - the coefficients (may be NULL)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Note</FONT></H3>
This function is not intended to be called by end users, but by SLEPc
solvers that use <A HREF="../ST/ST.html#ST">ST</A>. It builds matrix st->P as follows, then calls <A HREF="https://petsc.org/release/manualpages/KSP/KSPSetUp.html#KSPSetUp">KSPSetUp</A>().
<PRE>
If (coeffs) st->P = Sum_{i=0..nmat-1} coeffs[i]*sigma^i*A_i
else st->P = Sum_{i=0..nmat-1} sigma^i*A_i
</PRE>
<P>
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
<A HREF="../ST/STMatSolve.html#STMatSolve">STMatSolve</A>()
<BR><P><B></B><H3><FONT COLOR="#883300">Level</FONT></H3>developer<BR>
<H3><FONT COLOR="#883300">Location</FONT></H3>
</B><A HREF="../../../src/sys/classes/st/interface/stsolve.c.html#STMatSetUp">src/sys/classes/st/interface/stsolve.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>
|
