File: DMTSGetRHSJacobian.html

package info (click to toggle)
petsc 3.7.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 163,864 kB
  • ctags: 618,438
  • sloc: ansic: 515,133; python: 29,793; makefile: 20,458; fortran: 18,998; cpp: 6,515; f90: 3,914; sh: 1,012; xml: 621; objc: 445; csh: 240; java: 13
file content (44 lines) | stat: -rw-r--r-- 2,552 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
43
44
<!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/DMTSGetRHSJacobian.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMTSGetRHSJacobian</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/TS/DMTSGetRHSJacobian.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMTSGetRHSJacobian"><H1>DMTSGetRHSJacobian</H1></A>
get <A HREF="../TS/TS.html#TS">TS</A> Jacobian evaluation function 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscts.h" 
PetscErrorCode DMTSGetRHSJacobian(DM dm,TSRHSJacobian *func,void **ctx)
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#CC3333">Input Argument</FONT></H3>
<DT><B>dm </B> -<A HREF="../DM/DM.html#DM">DM</A> to be used with <A HREF="../TS/TS.html#TS">TS</A>
<br>
<P>
<H3><FONT COLOR="#CC3333">Output Arguments</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>func </B></TD><TD>- Jacobian evaluation function, see <A HREF="../TS/TSSetRHSJacobian.html#TSSetRHSJacobian">TSSetRHSJacobian</A>() for calling sequence
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx </B></TD><TD>- context for residual evaluation
</TD></TR></TABLE>
<P>

<P>
<H3><FONT COLOR="#CC3333">Note</FONT></H3>
TSGetJacobian() is normally used, but it calls this function internally because the user context is actually
associated with the <A HREF="../DM/DM.html#DM">DM</A>.  This makes the interface consistent regardless of whether the user interacts with a <A HREF="../DM/DM.html#DM">DM</A> or
not. If <A HREF="../DM/DM.html#DM">DM</A> took a more central role at some later date, this could become the primary method of setting the Jacobian.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 DMTSSetContext(), TSSetFunction(), DMTSSetJacobian()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>advanced
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/ts/utils/dmts.c.html#DMTSGetRHSJacobian">src/ts/utils/dmts.c</A>
<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>