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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/MatFD/MatFDColoringApply.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatFDColoringApply</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.14.5 2021-03-03</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.14.5 v3.14.5 docs/manualpages/MatFD/MatFDColoringApply.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatFDColoringApply"><H1>MatFDColoringApply</H1></A>
Given a matrix for which a <A HREF="../Mat/MatFDColoring.html#MatFDColoring">MatFDColoring</A> context has been created, computes the Jacobian for a function via finite differences.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../MatFD/MatFDColoringApply.html#MatFDColoringApply">MatFDColoringApply</A>(<A HREF="../Mat/Mat.html#Mat">Mat</A> J,<A HREF="../Mat/MatFDColoring.html#MatFDColoring">MatFDColoring</A> coloring,<A HREF="../Vec/Vec.html#Vec">Vec</A> x1,void *sctx)
</PRE>
Collective on <A HREF="../Mat/MatFDColoring.html#MatFDColoring">MatFDColoring</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>mat </B></TD><TD>- location to store Jacobian
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>coloring </B></TD><TD>- coloring context created with <A HREF="../MatFD/MatFDColoringCreate.html#MatFDColoringCreate">MatFDColoringCreate</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>x1 </B></TD><TD>- location at which Jacobian is to be computed
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>sctx </B></TD><TD>- context required by function, if this is being used with the <A HREF="../SNES/SNES.html#SNES">SNES</A> solver then it is <A HREF="../SNES/SNES.html#SNES">SNES</A> object, otherwise it is null
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Options Database Keys</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_fd_type </B></TD><TD>- "wp" or "ds" (see <A HREF="../Mat/MATMFFD_WP.html#MATMFFD_WP">MATMFFD_WP</A> or <A HREF="../Mat/MATMFFD_DS.html#MATMFFD_DS">MATMFFD_DS</A>)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_fd_coloring_view </B></TD><TD>- Activates basic viewing or coloring
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_fd_coloring_view draw </B></TD><TD>- Activates drawing of coloring
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_fd_coloring_view ::ascii_info </B></TD><TD>- Activates viewing of coloring info
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../MatFD/MatFDColoringCreate.html#MatFDColoringCreate">MatFDColoringCreate</A>(), <A HREF="../MatFD/MatFDColoringDestroy.html#MatFDColoringDestroy">MatFDColoringDestroy</A>(), <A HREF="../MatFD/MatFDColoringView.html#MatFDColoringView">MatFDColoringView</A>(), <A HREF="../MatFD/MatFDColoringSetFunction.html#MatFDColoringSetFunction">MatFDColoringSetFunction</A>(), <A HREF="../Mat/MatFDColoringSetValues.html#MatFDColoringSetValues">MatFDColoringSetValues</A>()
<BR>
<P>
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/mat/matfd/fdmatrix.c.html#MatFDColoringApply">src/mat/matfd/fdmatrix.c</A>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/mat/impls/aij/mpi/fdmpiaij.c.html#MatFDColoringApply_BAIJ">MatFDColoringApply_BAIJ in src/mat/impls/aij/mpi/fdmpiaij.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/fdmpiaij.c.html#MatFDColoringApply_AIJ">MatFDColoringApply_AIJ in src/mat/impls/aij/mpi/fdmpiaij.c</A><BR>
<BR><A HREF="./index.html">Index of all MatFD 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>
|
