File: NEPGetEigenpair.html

package info (click to toggle)
slepc 3.4.2.dfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 15,584 kB
  • ctags: 66,037
  • sloc: ansic: 51,275; makefile: 2,762; python: 1,577; fortran: 785; f90: 186; sh: 9
file content (54 lines) | stat: -rw-r--r-- 2,902 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc/slepc.css" type="text/css">
<TITLE>NEPGetEigenpair</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">

<H1>NEPGetEigenpair</H1>
Gets the i-th solution of the eigenproblem as computed by <A HREF="../NEP/NEPSolve.html#NEPSolve">NEPSolve</A>(). The solution consists in both the eigenvalue and the eigenvector. 
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcnep.h" 
PetscErrorCode NEPGetEigenpair(NEP nep,PetscInt i,PetscScalar *eig,Vec V)
</PRE>
Logically Collective on <A HREF="../NEP/NEP.html#NEP">NEP</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>nep </B></TD><TD> - nonlinear eigensolver context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>i   </B></TD><TD> - 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>eig </B></TD><TD> - eigenvalue
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>V   </B></TD><TD> - eigenvector
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
If PETSc is configured with real scalars, then complex eigenpairs cannot
be obtained. Users should use a complex-scalar configuration. This
behaviour is different to other SLEPc solvers such as <A HREF="../EPS/EPS.html#EPS">EPS</A>.
<P>
The index i should be a value between 0 and nconv-1 (see <A HREF="../NEP/NEPGetConverged.html#NEPGetConverged">NEPGetConverged</A>()).
Eigenpairs are indexed according to the ordering criterion established
with <A HREF="../NEP/NEPSetWhichEigenpairs.html#NEPSetWhichEigenpairs">NEPSetWhichEigenpairs</A>().
<P>

<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
 <A HREF="../NEP/NEPSolve.html#NEPSolve">NEPSolve</A>(), <A HREF="../NEP/NEPGetConverged.html#NEPGetConverged">NEPGetConverged</A>(), <A HREF="../NEP/NEPSetWhichEigenpairs.html#NEPSetWhichEigenpairs">NEPSetWhichEigenpairs</A>()
<BR><P><B><FONT COLOR="#883300">Location: </FONT></B><A HREF="../../../src/nep/interface/nepsolve.c.html#NEPGetEigenpair">src/nep/interface/nepsolve.c</A>
<BR><A HREF="./index.html">Index of all NEP 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>
<P><H3><FONT COLOR="#883300">Examples</FONT></H3>
<A HREF="../../../src/nep/examples/tutorials/ex20.c.html">src/nep/examples/tutorials/ex20.c.html</A><BR>
<A HREF="../../../src/nep/examples/tutorials/ex21.c.html">src/nep/examples/tutorials/ex21.c.html</A><BR>
<A HREF="../../../src/nep/examples/tutorials/ex22.c.html">src/nep/examples/tutorials/ex22.c.html</A><BR>
</BODY></HTML>