File: EPSGetLeftEigenvector.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 (63 lines) | stat: -rw-r--r-- 4,281 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
<!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/EPS/EPSGetLeftEigenvector.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>EPSGetLeftEigenvector</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/EPS/EPSGetLeftEigenvector.html "><small>Report Typos and Errors</small></a></div>
<H1>EPSGetLeftEigenvector</H1>
Gets the i-th left eigenvector as computed by <A HREF="../EPS/EPSSolve.html#EPSSolve">EPSSolve</A>(). 
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepceps.h" 
<A HREF="https://petsc.org/release/manualpages/Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../EPS/EPSGetLeftEigenvector.html#EPSGetLeftEigenvector">EPSGetLeftEigenvector</A>(<A HREF="../EPS/EPS.html#EPS">EPS</A> eps,<A HREF="https://petsc.org/release/manualpages/Sys/PetscInt.html#PetscInt">PetscInt</A> i,<A HREF="https://petsc.org/release/manualpages/Vec/Vec.html#Vec">Vec</A> Wr,<A HREF="https://petsc.org/release/manualpages/Vec/Vec.html#Vec">Vec</A> Wi)
</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>eps </B></TD><TD>&nbsp;- eigensolver context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>i   </B></TD><TD>&nbsp;- index of the solution
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Output Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>Wr   </B></TD><TD>&nbsp;- real part of left eigenvector
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>Wi   </B></TD><TD>&nbsp;- imaginary part of left eigenvector
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
The caller must provide valid <A HREF="https://petsc.org/release/manualpages/Vec/Vec.html#Vec">Vec</A> objects, i.e., they must be created
by the calling program with e.g. <A HREF="https://petsc.org/release/manualpages/Mat/MatCreateVecs.html#MatCreateVecs">MatCreateVecs</A>().
<P>
If the corresponding eigenvalue is real, then Wi is set to zero. If PETSc is
configured with complex scalars the eigenvector is stored directly in Wr
(Wi is set to zero). In any case, the user can pass NULL in Wr or Wi if
one of them is not required.
<P>
The index i should be a value between 0 and nconv-1 (see <A HREF="../EPS/EPSGetConverged.html#EPSGetConverged">EPSGetConverged</A>()).
Eigensolutions are indexed according to the ordering criterion established
with <A HREF="../EPS/EPSSetWhichEigenpairs.html#EPSSetWhichEigenpairs">EPSSetWhichEigenpairs</A>().
<P>
Left eigenvectors are available only if the twosided flag was set, see
<A HREF="../EPS/EPSSetTwoSided.html#EPSSetTwoSided">EPSSetTwoSided</A>().
<P>

<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
 <A HREF="../EPS/EPSGetEigenvector.html#EPSGetEigenvector">EPSGetEigenvector</A>(), <A HREF="../EPS/EPSGetConverged.html#EPSGetConverged">EPSGetConverged</A>(), <A HREF="../EPS/EPSSetWhichEigenpairs.html#EPSSetWhichEigenpairs">EPSSetWhichEigenpairs</A>(), <A HREF="../EPS/EPSSetTwoSided.html#EPSSetTwoSided">EPSSetTwoSided</A>()
<BR><P><B></B><H3><FONT COLOR="#883300">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#883300">Location</FONT></H3>
</B><A HREF="../../../src/eps/interface/epssolve.c.html#EPSGetLeftEigenvector">src/eps/interface/epssolve.c</A>
<P><H3><FONT COLOR="#883300">Examples</FONT></H3>
<A HREF="../../../src/eps/tutorials/ex41.c.html">src/eps/tutorials/ex41.c</A><BR>
<A HREF="../../../src/eps/tutorials/ex55.c.html">src/eps/tutorials/ex55.c</A><BR>
<BR><BR><A HREF="./index.html">Index of all EPS 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>