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 49 50 51 52 53 54 55 56 57
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/TS/SNESTSFormFunction.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESTSFormFunction</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/TS/SNESTSFormFunction.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESTSFormFunction"><H1>SNESTSFormFunction</H1></A>
Function to evaluate nonlinear residual
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscts.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../TS/SNESTSFormFunction.html#SNESTSFormFunction">SNESTSFormFunction</A>(<A HREF="../SNES/SNES.html#SNES">SNES</A> snes,<A HREF="../Vec/Vec.html#Vec">Vec</A> U,<A HREF="../Vec/Vec.html#Vec">Vec</A> F,void *ctx)
</PRE>
Logically Collective on <A HREF="../SNES/SNES.html#SNES">SNES</A>
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>snes </B></TD><TD>- nonlinear solver
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>U </B></TD><TD>- the current state at which to evaluate the residual
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx </B></TD><TD>- user context, must be a <A HREF="../TS/TS.html#TS">TS</A>
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<DT><B>F </B> -the nonlinear residual
<br>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
This function is not normally called by users and is automatically registered with the <A HREF="../SNES/SNES.html#SNES">SNES</A> used by <A HREF="../TS/TS.html#TS">TS</A>.
It is most frequently passed to <A HREF="../MatFD/MatFDColoringSetFunction.html#MatFDColoringSetFunction">MatFDColoringSetFunction</A>().
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../SNES/SNESSetFunction.html#SNESSetFunction">SNESSetFunction</A>(), <A HREF="../MatFD/MatFDColoringSetFunction.html#MatFDColoringSetFunction">MatFDColoringSetFunction</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/ts/interface/ts.c.html#SNESTSFormFunction">src/ts/interface/ts.c</A>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/ts/impls/arkimex/arkimex.c.html#SNESTSFormFunction_ARKIMEX">SNESTSFormFunction_ARKIMEX in src/ts/impls/arkimex/arkimex.c</A><BR>
<A HREF="../../../src/ts/impls/bdf/bdf.c.html#SNESTSFormFunction_BDF">SNESTSFormFunction_BDF in src/ts/impls/bdf/bdf.c</A><BR>
<A HREF="../../../src/ts/impls/eimex/eimex.c.html#SNESTSFormFunction_EIMEX">SNESTSFormFunction_EIMEX in src/ts/impls/eimex/eimex.c</A><BR>
<A HREF="../../../src/ts/impls/glee/glee.c.html#SNESTSFormFunction_GLEE">SNESTSFormFunction_GLEE in src/ts/impls/glee/glee.c</A><BR>
<A HREF="../../../src/ts/impls/implicit/alpha/alpha1.c.html#SNESTSFormFunction_Alpha">SNESTSFormFunction_Alpha in src/ts/impls/implicit/alpha/alpha1.c</A><BR>
<A HREF="../../../src/ts/impls/implicit/alpha/alpha2.c.html#SNESTSFormFunction_Alpha">SNESTSFormFunction_Alpha in src/ts/impls/implicit/alpha/alpha2.c</A><BR>
<A HREF="../../../src/ts/impls/implicit/glle/glle.c.html#SNESTSFormFunction_GLLE">SNESTSFormFunction_GLLE in src/ts/impls/implicit/glle/glle.c</A><BR>
<A HREF="../../../src/ts/impls/implicit/theta/theta.c.html#SNESTSFormFunction_Theta">SNESTSFormFunction_Theta in src/ts/impls/implicit/theta/theta.c</A><BR>
<A HREF="../../../src/ts/impls/mimex/mimex.c.html#SNESTSFormFunction_Mimex">SNESTSFormFunction_Mimex in src/ts/impls/mimex/mimex.c</A><BR>
<A HREF="../../../src/ts/impls/pseudo/posindep.c.html#SNESTSFormFunction_Pseudo">SNESTSFormFunction_Pseudo in src/ts/impls/pseudo/posindep.c</A><BR>
<A HREF="../../../src/ts/impls/rosw/rosw.c.html#SNESTSFormFunction_RosW">SNESTSFormFunction_RosW in src/ts/impls/rosw/rosw.c</A><BR>
<BR><A HREF="./index.html">Index of all TS 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>
|