File: MFNSolve.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 (68 lines) | stat: -rw-r--r-- 4,570 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
64
65
66
67
68
<!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/MFN/MFNSolve.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>MFNSolve</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/MFN/MFNSolve.html "><small>Report Typos and Errors</small></a></div>
<H1>MFNSolve</H1>
Solves the matrix function problem. Given a vector b, the vector x = f(A)*b is returned. 
<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/MFNSolve.html#MFNSolve">MFNSolve</A>(<A HREF="../MFN/MFN.html#MFN">MFN</A> mfn,<A HREF="https://petsc.org/release/manualpages/Vec/Vec.html#Vec">Vec</A> b,<A HREF="https://petsc.org/release/manualpages/Vec/Vec.html#Vec">Vec</A> x)
</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>&nbsp;- matrix function context obtained from <A HREF="../MFN/MFNCreate.html#MFNCreate">MFNCreate</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>b   </B></TD><TD>&nbsp;- the right hand side vector
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Output Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>x   </B></TD><TD>&nbsp;- the solution (this may be the same vector as b, then b will be
overwritten with the answer)
</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_view </B></TD><TD>&nbsp;- print information about the solver used
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mfn_view_mat binary </B></TD><TD>&nbsp;- save the matrix to the default binary viewer
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mfn_view_rhs binary </B></TD><TD>&nbsp;- save right hand side vector to the default binary viewer
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mfn_view_solution binary </B></TD><TD>&nbsp;- save computed solution vector to the default binary viewer
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mfn_converged_reason </B></TD><TD>&nbsp;- print reason for convergence, and number of iterations
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
The matrix A is specified with <A HREF="../MFN/MFNSetOperator.html#MFNSetOperator">MFNSetOperator</A>().
The function f is specified with <A HREF="../MFN/MFNSetFN.html#MFNSetFN">MFNSetFN</A>().
<P>

<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
 <A HREF="../MFN/MFNCreate.html#MFNCreate">MFNCreate</A>(), <A HREF="../MFN/MFNSetUp.html#MFNSetUp">MFNSetUp</A>(), <A HREF="../MFN/MFNDestroy.html#MFNDestroy">MFNDestroy</A>(), <A HREF="../MFN/MFNSetTolerances.html#MFNSetTolerances">MFNSetTolerances</A>(),
<BR><A HREF="../MFN/MFNSetOperator.html#MFNSetOperator">MFNSetOperator</A>(), <A HREF="../MFN/MFNSetFN.html#MFNSetFN">MFNSetFN</A>()
<P><B></B><H3><FONT COLOR="#883300">Level</FONT></H3>beginner<BR>
<H3><FONT COLOR="#883300">Location</FONT></H3>
</B><A HREF="../../../src/mfn/interface/mfnsolve.c.html#MFNSolve">src/mfn/interface/mfnsolve.c</A>
<P><H3><FONT COLOR="#883300">Examples</FONT></H3>
<A HREF="../../../src/eps/tutorials/ex36.c.html">src/eps/tutorials/ex36.c</A><BR>
<A HREF="../../../src/mfn/tutorials/ex23.c.html">src/mfn/tutorials/ex23.c</A><BR>
<A HREF="../../../src/mfn/tutorials/ex23f.F90.html">src/mfn/tutorials/ex23f.F90</A><BR>
<A HREF="../../../src/mfn/tutorials/ex26.c.html">src/mfn/tutorials/ex26.c</A><BR>
<A HREF="../../../src/mfn/tutorials/ex37.c.html">src/mfn/tutorials/ex37.c</A><BR>
<A HREF="../../../src/mfn/tutorials/ex39.c.html">src/mfn/tutorials/ex39.c</A><BR>
<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>