File: KSPComputeEigenvaluesExplicitly.html

package info (click to toggle)
petsc 3.14.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 266,472 kB
  • sloc: ansic: 680,898; python: 33,303; cpp: 16,324; makefile: 14,022; f90: 13,731; javascript: 10,713; fortran: 9,581; sh: 1,373; xml: 619; objc: 445; csh: 192; pascal: 148; java: 13
file content (57 lines) | stat: -rw-r--r-- 4,069 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/KSP/KSPComputeEigenvaluesExplicitly.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>KSPComputeEigenvaluesExplicitly</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>petsc-3.14.5 2021-03-03</b></div>
   <div id="bugreport" align=right><a href="mailto:petsc-maint@mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: petsc-3.14.5 v3.14.5 docs/manualpages/KSP/KSPComputeEigenvaluesExplicitly.html "><small>Report Typos and Errors</small></a></div>
<A NAME="KSPComputeEigenvaluesExplicitly"><H1>KSPComputeEigenvaluesExplicitly</H1></A>
Computes all of the eigenvalues of the preconditioned operator using LAPACK. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscksp.h" 
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A>  <A HREF="../KSP/KSPComputeEigenvaluesExplicitly.html#KSPComputeEigenvaluesExplicitly">KSPComputeEigenvaluesExplicitly</A>(<A HREF="../KSP/KSP.html#KSP">KSP</A> ksp,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> nmax,<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> r[],<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> c[])
</PRE>
Collective on ksp
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ksp </B></TD><TD>- iterative context obtained from <A HREF="../KSP/KSPCreate.html#KSPCreate">KSPCreate</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>n </B></TD><TD>- size of arrays r and c
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>r </B></TD><TD>- real part of computed eigenvalues, provided by user with a dimension at least of n
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>c </B></TD><TD>- complex part of computed eigenvalues, provided by user with a dimension at least of n
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
This approach is very slow but will generally provide accurate eigenvalue
estimates.  This routine explicitly forms a dense matrix representing
the preconditioned operator, and thus will run only for relatively small
problems, say n &lt; 500.
<P>
Many users may just want to use the monitoring routine
<A HREF="../KSP/KSPMonitorSingularValue.html#KSPMonitorSingularValue">KSPMonitorSingularValue</A>() (which can be set with option -ksp_monitor_singular_value)
to print the singular values at each iteration of the linear solve.
<P>
The preconditoner operator, rhs vector, solution vectors should be
set before this routine is called. i.e use <A HREF="../KSP/KSPSetOperators.html#KSPSetOperators">KSPSetOperators</A>(),<A HREF="../KSP/KSPSolve.html#KSPSolve">KSPSolve</A>() or
<A HREF="../KSP/KSPSetOperators.html#KSPSetOperators">KSPSetOperators</A>()
<P>

<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../KSP/KSPComputeEigenvalues.html#KSPComputeEigenvalues">KSPComputeEigenvalues</A>(), <A HREF="../KSP/KSPMonitorSingularValue.html#KSPMonitorSingularValue">KSPMonitorSingularValue</A>(), <A HREF="../KSP/KSPComputeExtremeSingularValues.html#KSPComputeExtremeSingularValues">KSPComputeExtremeSingularValues</A>(), <A HREF="../KSP/KSPSetOperators.html#KSPSetOperators">KSPSetOperators</A>(), <A HREF="../KSP/KSPSolve.html#KSPSolve">KSPSolve</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/ksp/ksp/interface/eige.c.html#KSPComputeEigenvaluesExplicitly">src/ksp/ksp/interface/eige.c</A>
<BR><A HREF="./index.html">Index of all KSP 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>
</BODY></HTML>