File: STSetBalanceMatrix.html

package info (click to toggle)
slepc 3.23.1%2Bdfsg1-1exp2
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 48,276 kB
  • sloc: ansic: 103,363; python: 6,078; f90: 3,286; cpp: 1,528; makefile: 772; sh: 311
file content (44 lines) | stat: -rw-r--r-- 2,725 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
<!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/STSetBalanceMatrix.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>STSetBalanceMatrix</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/STSetBalanceMatrix.html "><small>Report Typos and Errors</small></a></div>
<H1>STSetBalanceMatrix</H1>
Sets the diagonal matrix to be used for balancing. 
<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/STSetBalanceMatrix.html#STSetBalanceMatrix">STSetBalanceMatrix</A>(<A HREF="../ST/ST.html#ST">ST</A> st,<A HREF="https://petsc.org/release/manualpages/Vec/Vec.html#Vec">Vec</A> D)
</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>&nbsp;- the spectral transformation context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>D  </B></TD><TD>&nbsp;- the diagonal matrix (represented as a vector)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
If this matrix is set, <A HREF="../ST/STApply.html#STApply">STApply</A> will effectively apply D*OP*D^{-1}. Use NULL
to reset a previously passed D.
<P>
Balancing is usually set via <A HREF="../EPS/EPSSetBalance.html#EPSSetBalance">EPSSetBalance</A>, but the advanced user may use
this function to bypass the usual balancing methods.
<P>

<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
 <A HREF="../EPS/EPSSetBalance.html#EPSSetBalance">EPSSetBalance</A>(), <A HREF="../ST/STApply.html#STApply">STApply</A>(), <A HREF="../ST/STGetBalanceMatrix.html#STGetBalanceMatrix">STGetBalanceMatrix</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/stfunc.c.html#STSetBalanceMatrix">src/sys/classes/st/interface/stfunc.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>