File: KSPPIPEGCRSetModifyPC.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 (45 lines) | stat: -rw-r--r-- 2,578 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
<!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/KSPPIPEGCRSetModifyPC.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>KSPPIPEGCRSetModifyPC</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/KSPPIPEGCRSetModifyPC.html "><small>Report Typos and Errors</small></a></div>
<A NAME="KSPPIPEGCRSetModifyPC"><H1>KSPPIPEGCRSetModifyPC</H1></A>
Sets the routine used by PIPEGCR to modify the preconditioner. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscksp.h"  
PetscErrorCode  KSPPIPEGCRSetModifyPC(KSP ksp,PetscErrorCode (*function)(KSP,PetscInt,PetscReal,void*),void *data,PetscErrorCode (*destroy)(void*))
</PRE>
Logically Collective on <A HREF="../KSP/KSP.html#KSP">KSP</A>
<P>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
+  ksp      - iterative context obtained from <A HREF="../KSP/KSPCreate.html#KSPCreate">KSPCreate</A>()
.  function - user defined function to modify the preconditioner
.  ctx      - user provided contex for the modify preconditioner function
-  destroy  - the function to use to destroy the user provided application context.
<P>
<H3><FONT COLOR="#CC3333">Calling Sequence of function</FONT></H3>
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> function (<A HREF="../KSP/KSP.html#KSP">KSP</A> ksp, <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> n, <A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> rnorm, void *ctx)
<P>
ksp   - iterative context
n     - the total number of PIPEGCR iterations that have occurred
rnorm - 2-norm residual value
ctx   - the user provided application context
<P>

<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
The default modifypc routine is KSPPIPEGCRModifyPCNoChange()
<P>
.seealso: KSPPIPEGCRModifyPCNoChange()
<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/gcr/pipegcr/pipegcr.c.html#KSPPIPEGCRSetModifyPC">src/ksp/ksp/impls/gcr/pipegcr/pipegcr.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>