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/KSPSetSupportedNorm.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>KSPSetSupportedNorm</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/KSPSetSupportedNorm.html "><small>Report Typos and Errors</small></a></div>
<A NAME="KSPSetSupportedNorm"><H1>KSPSetSupportedNorm</H1></A>
Sets a norm and preconditioner side supported by a <A HREF="../KSP/KSP.html#KSP">KSP</A>
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscksp.h"
PetscErrorCode KSPSetSupportedNorm(KSP ksp,KSPNormType normtype,PCSide pcside,PetscInt priority)
</PRE>
Logically Collective
<P>
<H3><FONT COLOR="#CC3333">Input Arguments</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ksp </B></TD><TD>- Krylov method
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>normtype </B></TD><TD>- supported norm type
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>pcside </B></TD><TD>- preconditioner side that can be used with this norm
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>preference </B></TD><TD>- integer preference for this combination, larger values have higher priority
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
This function should be called from the implementation files KSPCreate_XXX() to declare
which norms and preconditioner sides are supported. Users should not need to call this
function.
<P>
<A HREF="../KSP/KSP_NORM_NONE.html#KSP_NORM_NONE">KSP_NORM_NONE</A> is supported by default with all <A HREF="../KSP/KSP.html#KSP">KSP</A> methods and any <A HREF="../PC/PC.html#PC">PC</A> side at priority 1. If a <A HREF="../KSP/KSP.html#KSP">KSP</A> explicitly does
not support <A HREF="../KSP/KSP_NORM_NONE.html#KSP_NORM_NONE">KSP_NORM_NONE</A>, it should set this by setting priority=0. Since defaulting to <A HREF="../KSP/KSP_NORM_NONE.html#KSP_NORM_NONE">KSP_NORM_NONE</A> is usually
undesirable, more desirable norms should usually have priority 2 or higher.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../KSP/KSPSetNormType.html#KSPSetNormType">KSPSetNormType</A>(), <A HREF="../KSP/KSPSetPCSide.html#KSPSetPCSide">KSPSetPCSide</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>developer
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/ksp/ksp/interface/itcreate.c.html#KSPSetSupportedNorm">src/ksp/ksp/interface/itcreate.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>
|
