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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="https://slepc.upv.es/documentation/current/docs/manualpages/PEP/PEPConvergedReasonView.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>PEPConvergedReasonView</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>slepc-3.22.2 2024-12-02</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.22.2 v3.22.2 docs/manualpages/PEP/PEPConvergedReasonView.html "><small>Report Typos and Errors</small></a></div>
<H1>PEPConvergedReasonView</H1>
Displays the reason a <A HREF="../PEP/PEP.html#PEP">PEP</A> solve converged or diverged.
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcpep.h"
<A HREF="https://petsc.org/release/manualpages/Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../PEP/PEPConvergedReasonView.html#PEPConvergedReasonView">PEPConvergedReasonView</A>(<A HREF="../PEP/PEP.html#PEP">PEP</A> pep,<A HREF="https://petsc.org/release/manualpages/Viewer/PetscViewer.html#PetscViewer">PetscViewer</A> viewer)
</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>pep </B></TD><TD> - the eigensolver context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>viewer </B></TD><TD> - the viewer to display the reason
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Options Database Keys</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-pep_converged_reason </B></TD><TD> - print reason for convergence, and number of iterations
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Note</FONT></H3>
To change the format of the output call <A HREF="https://petsc.org/release/manualpages/Viewer/PetscViewerPushFormat.html#PetscViewerPushFormat">PetscViewerPushFormat</A>(viewer,format) before
this call. Use <A HREF="https://petsc.org/release/manualpages/Viewer/PetscViewerFormat.html#PetscViewerFormat">PETSC_VIEWER_DEFAULT</A> for the default, use <A HREF="https://petsc.org/release/manualpages/Viewer/PetscViewerFormat.html#PetscViewerFormat">PETSC_VIEWER_FAILED</A> to only
display a reason if it fails. The latter can be set in the command line with
-pep_converged_reason ::failed
<P>
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
<A HREF="../PEP/PEPSetConvergenceTest.html#PEPSetConvergenceTest">PEPSetConvergenceTest</A>(), <A HREF="../PEP/PEPSetTolerances.html#PEPSetTolerances">PEPSetTolerances</A>(), <A HREF="../PEP/PEPGetIterationNumber.html#PEPGetIterationNumber">PEPGetIterationNumber</A>(), <A HREF="../PEP/PEPConvergedReasonViewFromOptions.html#PEPConvergedReasonViewFromOptions">PEPConvergedReasonViewFromOptions</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/pep/interface/pepview.c.html#PEPConvergedReasonView">src/pep/interface/pepview.c</A>
<P><H3><FONT COLOR="#883300">Examples</FONT></H3>
<A HREF="../../../src/pep/tutorials/ex16f.F90.html">src/pep/tutorials/ex16f.F90</A><BR>
<A HREF="../../../src/pep/tutorials/ex17.c.html">src/pep/tutorials/ex17.c</A><BR>
<A HREF="../../../src/pep/tutorials/ex28.c.html">src/pep/tutorials/ex28.c</A><BR>
<A HREF="../../../src/pep/tutorials/ex38.c.html">src/pep/tutorials/ex38.c</A><BR>
<A HREF="../../../src/pep/tutorials/ex40.c.html">src/pep/tutorials/ex40.c</A><BR>
<A HREF="../../../src/pep/tutorials/ex50.c.html">src/pep/tutorials/ex50.c</A><BR>
<A HREF="../../../src/pep/tutorials/nlevp/acoustic_wave_1d.c.html">src/pep/tutorials/nlevp/acoustic_wave_1d.c</A><BR>
<A HREF="../../../src/pep/tutorials/nlevp/acoustic_wave_2d.c.html">src/pep/tutorials/nlevp/acoustic_wave_2d.c</A><BR>
<A HREF="../../../src/pep/tutorials/nlevp/butterfly.c.html">src/pep/tutorials/nlevp/butterfly.c</A><BR>
<A HREF="../../../src/pep/tutorials/nlevp/damped_beam.c.html">src/pep/tutorials/nlevp/damped_beam.c</A><BR>
<A HREF="../../../src/pep/tutorials/nlevp/loaded_string.c.html">src/pep/tutorials/nlevp/loaded_string.c</A><BR>
<BR><BR><A HREF="./index.html">Index of all PEP 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>
|
