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/SNES/SNESSetFunctionType.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESSetFunctionType</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/SNES/SNESSetFunctionType.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESSetFunctionType"><H1>SNESSetFunctionType</H1></A>
Sets the <A HREF="../SNES/SNESNormSchedule.html#SNESNormSchedule">SNESNormSchedule</A> used in covergence and monitoring of the <A HREF="../SNES/SNES.html#SNES">SNES</A> method.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsnes.h"
PetscErrorCode SNESSetFunctionType(SNES snes, SNESFunctionType type)
</PRE>
Logically Collective on <A HREF="../SNES/SNES.html#SNES">SNES</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>snes </B></TD><TD>- the <A HREF="../SNES/SNES.html#SNES">SNES</A> context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>normschedule </B></TD><TD>- the frequency of norm computation
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Only certain <A HREF="../SNES/SNES.html#SNES">SNES</A> methods support certain SNESNormSchedules. Most require evaluation
of the nonlinear function and the taking of its norm at every iteration to
even ensure convergence at all. However, methods such as custom Gauss-Seidel methods
(<A HREF="../SNES/SNESNGS.html#SNESNGS">SNESNGS</A>) and the like do not require the norm of the function to be computed, and therfore
may either be monitored for convergence or not. As these are often used as nonlinear
preconditioners, monitoring the norm of their error is not a useful enterprise within
their solution.
<P>
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
<A HREF="../SNES/SNES.html#SNES">SNES</A>, nonlinear, set, function, norm, type
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../SNES/SNESGetNormSchedule.html#SNESGetNormSchedule">SNESGetNormSchedule</A>(), <A HREF="../SNES/SNESComputeFunction.html#SNESComputeFunction">SNESComputeFunction</A>(), <A HREF="../Vec/VecNorm.html#VecNorm">VecNorm</A>(), <A HREF="../SNES/SNESSetFunction.html#SNESSetFunction">SNESSetFunction</A>(), <A HREF="../SNES/SNESSetInitialFunction.html#SNESSetInitialFunction">SNESSetInitialFunction</A>(), <A HREF="../SNES/SNESNormSchedule.html#SNESNormSchedule">SNESNormSchedule</A>
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>developer
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/snes/interface/snes.c.html#SNESSetFunctionType">src/snes/interface/snes.c</A>
<BR><A HREF="./index.html">Index of all SNES 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>
|
