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="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/KSP/KSPRichardsonSetSelfScale.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>KSPRichardsonSetSelfScale</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.10.3 2018-12-18</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.10.3 v3.10.3 docs/manualpages/KSP/KSPRichardsonSetSelfScale.html "><small>Report Typos and Errors</small></a></div>
<A NAME="KSPRichardsonSetSelfScale"><H1>KSPRichardsonSetSelfScale</H1></A>
Sets Richardson to automatically determine optimal scaling at each iteration to minimize the 2-norm of the preconditioned residual
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscksp.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../KSP/KSPRichardsonSetSelfScale.html#KSPRichardsonSetSelfScale">KSPRichardsonSetSelfScale</A>(<A HREF="../KSP/KSP.html#KSP">KSP</A> ksp,<A HREF="../Sys/PetscBool.html#PetscBool">PetscBool</A> scale)
</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>- the iterative context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>scale </B></TD><TD>- <A HREF="../Sys/PETSC_TRUE.html#PETSC_TRUE">PETSC_TRUE</A> or the default of <A HREF="../Sys/PETSC_FALSE.html#PETSC_FALSE">PETSC_FALSE</A>
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Options Database Keys</FONT></H3>
<DT><B>-ksp_richardson_self_scale </B> -Use self-scaling
<br>
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Requires two extra work vectors. Uses an extra <A HREF="../Vec/VecAXPY.html#VecAXPY">VecAXPY</A>() and <A HREF="../Vec/VecDotNorm2.html#VecDotNorm2">VecDotNorm2</A>() per iteration.
<P>
<H3><FONT COLOR="#CC3333">Developer Notes</FONT></H3>
Could also minimize the 2-norm of the true residual with one less work vector
<P>
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
<A HREF="../KSP/KSP.html#KSP">KSP</A>, Richardson, set, scale
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/ksp/ksp/impls/rich/richscale.c.html#KSPRichardsonSetSelfScale">src/ksp/ksp/impls/rich/richscale.c</A>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/ksp/ksp/impls/rich/rich.c.html#KSPRichardsonSetSelfScale_Richardson">KSPRichardsonSetSelfScale_Richardson in src/ksp/ksp/impls/rich/rich.c</A><BR>
<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>
|
