File: KSPFGMRESSetModifyPC.html

package info (click to toggle)
petsc 3.7.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 163,864 kB
  • ctags: 618,438
  • sloc: ansic: 515,133; python: 29,793; makefile: 20,458; fortran: 18,998; cpp: 6,515; f90: 3,914; sh: 1,012; xml: 621; objc: 445; csh: 240; java: 13
file content (61 lines) | stat: -rw-r--r-- 3,323 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
<!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/KSPFGMRESSetModifyPC.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>KSPFGMRESSetModifyPC</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
   <div id="version" align=right><b>petsc-3.7.5 2017-01-01</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.7.5 v3.7.5 docs/manualpages/KSP/KSPFGMRESSetModifyPC.html "><small>Report Typos and Errors</small></a></div>
<A NAME="KSPFGMRESSetModifyPC"><H1>KSPFGMRESSetModifyPC</H1></A>
Sets the routine used by FGMRES to modify the preconditioner. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscksp.h" 
PetscErrorCode  KSPFGMRESSetModifyPC(KSP ksp,PetscErrorCode (*fcn)(KSP,PetscInt,PetscInt,PetscReal,void*),void *ctx,PetscErrorCode (*d)(void*))
</PRE>
Logically Collective on <A HREF="../KSP/KSP.html#KSP">KSP</A>
<P>
<H3><FONT COLOR="#CC3333">Input Parameters</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>fcn </B></TD><TD>- modifypc function
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx </B></TD><TD>- optional contex
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>d </B></TD><TD>- optional context destroy routine
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Calling Sequence of function</FONT></H3>
ierr = int fcn(<A HREF="../KSP/KSP.html#KSP">KSP</A> ksp,int total_its,int loc_its,<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> res_norm,void*ctx);
<P>
ksp - the ksp context being used.
total_its     - the total number of FGMRES iterations that have occurred.
loc_its       - the number of FGMRES iterations since last restart.
res_norm      - the current residual norm.
ctx           - optional context variable
<P>
<H3><FONT COLOR="#CC3333">Options Database Keys</FONT></H3>
-ksp_fgmres_modifypcnochange
-ksp_fgmres_modifypcksp
<P>

<P>
Contributed by Allison Baker
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Several modifypc routines are predefined, including
<A HREF="../KSP/KSPFGMRESModifyPCNoChange.html#KSPFGMRESModifyPCNoChange">KSPFGMRESModifyPCNoChange</A>()
<A HREF="../KSP/KSPFGMRESModifyPCKSP.html#KSPFGMRESModifyPCKSP">KSPFGMRESModifyPCKSP</A>()
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../KSP/KSPFGMRESModifyPCNoChange.html#KSPFGMRESModifyPCNoChange">KSPFGMRESModifyPCNoChange</A>(), <A HREF="../KSP/KSPFGMRESModifyPCKSP.html#KSPFGMRESModifyPCKSP">KSPFGMRESModifyPCKSP</A>()
<BR>
<P>
<P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>intermediate
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/ksp/ksp/impls/gmres/fgmres/modpcf.c.html#KSPFGMRESSetModifyPC">src/ksp/ksp/impls/gmres/fgmres/modpcf.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>