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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Mat/MatStoreValues.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatStoreValues</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/Mat/MatStoreValues.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatStoreValues"><H1>MatStoreValues</H1></A>
Stashes a copy of the matrix values; this allows, for example, reuse of the linear part of a Jacobian, while recomputing the nonlinear portion.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Mat/MatStoreValues.html#MatStoreValues">MatStoreValues</A>(<A HREF="../Mat/Mat.html#Mat">Mat</A> mat)
</PRE>
Collect on <A HREF="../Mat/Mat.html#Mat">Mat</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>- the matrix (currently only AIJ matrices support this option)
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Common Usage, with SNESSolve()</FONT></H3>
<pre>
Create Jacobian matrix
</pre>
<pre>
Set linear terms into matrix
</pre>
<pre>
Apply boundary conditions to matrix, at this time matrix must have
</pre>
<pre>
final nonzero structure (i.e. setting the nonlinear terms and applying
</pre>
<pre>
boundary conditions again will not change the nonzero structure
</pre>
<pre>
ierr = <A HREF="../Mat/MatSetOption.html#MatSetOption">MatSetOption</A>(mat,<A HREF="../Mat/MatOption.html#MatOption">MAT_NEW_NONZERO_LOCATIONS</A>,<A HREF="../Sys/PETSC_FALSE.html#PETSC_FALSE">PETSC_FALSE</A>);
</pre>
<pre>
ierr = <A HREF="../Mat/MatStoreValues.html#MatStoreValues">MatStoreValues</A>(mat);
</pre>
<pre>
Call <A HREF="../SNES/SNESSetJacobian.html#SNESSetJacobian">SNESSetJacobian</A>() with matrix
</pre>
<pre>
In your Jacobian routine
</pre>
<pre>
ierr = <A HREF="../Mat/MatRetrieveValues.html#MatRetrieveValues">MatRetrieveValues</A>(mat);
</pre>
<pre>
Set nonlinear terms in matrix
</pre>
<P>
<H3><FONT COLOR="#CC3333">Common Usage without SNESSolve(), i.e. when you handle nonlinear solve yourself</FONT></H3>
<pre>
// build linear portion of Jacobian
</pre>
<pre>
ierr = <A HREF="../Mat/MatSetOption.html#MatSetOption">MatSetOption</A>(mat,<A HREF="../Mat/MatOption.html#MatOption">MAT_NEW_NONZERO_LOCATIONS</A>,<A HREF="../Sys/PETSC_FALSE.html#PETSC_FALSE">PETSC_FALSE</A>);
</pre>
<pre>
ierr = <A HREF="../Mat/MatStoreValues.html#MatStoreValues">MatStoreValues</A>(mat);
</pre>
<pre>
loop over nonlinear iterations
</pre>
<pre>
ierr = <A HREF="../Mat/MatRetrieveValues.html#MatRetrieveValues">MatRetrieveValues</A>(mat);
</pre>
<pre>
// call <A HREF="../Mat/MatSetValues.html#MatSetValues">MatSetValues</A>(mat,...) to set nonliner portion of Jacobian
</pre>
<pre>
// call <A HREF="../Mat/MatAssemblyBegin.html#MatAssemblyBegin">MatAssemblyBegin</A>/End() on matrix
</pre>
<pre>
Solve linear system with Jacobian
</pre>
<pre>
endloop
</pre>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Matrix must already be assemblied before calling this routine
Must set the matrix option <A HREF="../Mat/MatSetOption.html#MatSetOption">MatSetOption</A>(mat,<A HREF="../Mat/MatOption.html#MatOption">MAT_NEW_NONZERO_LOCATIONS</A>,<A HREF="../Sys/PETSC_FALSE.html#PETSC_FALSE">PETSC_FALSE</A>); before
calling this routine.
<P>
When this is called multiple times it overwrites the previous set of stored values
and does not allocated additional space.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Mat/MatRetrieveValues.html#MatRetrieveValues">MatRetrieveValues</A>()
<BR>
<P>
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/mat/impls/aij/seq/aij.c.html#MatStoreValues">src/mat/impls/aij/seq/aij.c</A>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/mat/impls/aij/mpi/mpiaij.c.html#MatStoreValues_MPIAIJ">MatStoreValues_MPIAIJ in src/mat/impls/aij/mpi/mpiaij.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aij.c.html#MatStoreValues_SeqAIJ">MatStoreValues_SeqAIJ in src/mat/impls/aij/seq/aij.c</A><BR>
<A HREF="../../../src/mat/impls/baij/mpi/mpibaij.c.html#MatStoreValues_MPIBAIJ">MatStoreValues_MPIBAIJ in src/mat/impls/baij/mpi/mpibaij.c</A><BR>
<A HREF="../../../src/mat/impls/baij/seq/baij.c.html#MatStoreValues_SeqBAIJ">MatStoreValues_SeqBAIJ in src/mat/impls/baij/seq/baij.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/mpi/mpisbaij.c.html#MatStoreValues_MPISBAIJ">MatStoreValues_MPISBAIJ in src/mat/impls/sbaij/mpi/mpisbaij.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/seq/sbaij.c.html#MatStoreValues_SeqSBAIJ">MatStoreValues_SeqSBAIJ in src/mat/impls/sbaij/seq/sbaij.c</A><BR>
<A HREF="../../../src/mat/impls/sell/mpi/mpisell.c.html#MatStoreValues_MPISELL">MatStoreValues_MPISELL in src/mat/impls/sell/mpi/mpisell.c</A><BR>
<A HREF="../../../src/mat/impls/sell/seq/sell.c.html#MatStoreValues_SeqSELL">MatStoreValues_SeqSELL in src/mat/impls/sell/seq/sell.c</A><BR>
<BR><A HREF="./index.html">Index of all Mat 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>
|
