File: KSPGCRSetModifyPC.html

package info (click to toggle)
petsc 3.1.dfsg-7
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 131,360 kB
  • ctags: 491,710
  • sloc: ansic: 288,064; cpp: 66,909; python: 28,799; fortran: 19,153; makefile: 13,945; sh: 3,502; f90: 1,655; xml: 620; csh: 230; java: 13
file content (42 lines) | stat: -rw-r--r-- 2,018 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>KSPGCRSetModifyPC</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<A NAME="KSPGCRSetModifyPC"><H1>KSPGCRSetModifyPC</H1></A>
Sets the routine used by GCR to modify the preconditioner. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
PetscErrorCode PETSCKSP_DLLEXPORT KSPGCRSetModifyPC(KSP ksp,PetscErrorCode (*function)(KSP,PetscInt,PetscReal,void*),void *data,PetscErrorCode (*destroy)(void*))
</PRE>
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 GCR 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 KSPGCRModifyPCNoChange()
<P>
.seealso: KSPGCRModifyPCNoChange()
<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/gcr.c.html#KSPGCRSetModifyPC">src/ksp/ksp/impls/gcr/gcr.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>