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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="https://slepc.upv.es/documentation/current/docs/manualpages/MFN/MFNConvergedReasonView.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>MFNConvergedReasonView</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/MFN/MFNConvergedReasonView.html "><small>Report Typos and Errors</small></a></div>
<H1>MFNConvergedReasonView</H1>
Displays the reason an <A HREF="../MFN/MFN.html#MFN">MFN</A> solve converged or diverged.
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcmfn.h"
<A HREF="https://petsc.org/release/manualpages/Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../MFN/MFNConvergedReasonView.html#MFNConvergedReasonView">MFNConvergedReasonView</A>(<A HREF="../MFN/MFN.html#MFN">MFN</A> mfn,<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>mfn </B></TD><TD> - the matrix function 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>-mfn_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
-mfn_converged_reason ::failed
<P>
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
<A HREF="../MFN/MFNSetTolerances.html#MFNSetTolerances">MFNSetTolerances</A>(), <A HREF="../MFN/MFNGetIterationNumber.html#MFNGetIterationNumber">MFNGetIterationNumber</A>(), <A HREF="../MFN/MFNConvergedReasonViewFromOptions.html#MFNConvergedReasonViewFromOptions">MFNConvergedReasonViewFromOptions</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/mfn/interface/mfnbasic.c.html#MFNConvergedReasonView">src/mfn/interface/mfnbasic.c</A>
<BR><BR><A HREF="./index.html">Index of all MFN 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>
|
