File: MatSetValuesLocal.html

package info (click to toggle)
petsc 3.10.3%2Bdfsg1-5
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 209,064 kB
  • sloc: ansic: 587,333; python: 29,696; makefile: 12,445; fortran: 11,626; f90: 9,677; cpp: 8,768; sh: 1,027; xml: 621; objc: 445; csh: 194; java: 13
file content (80 lines) | stat: -rw-r--r-- 6,917 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
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
<!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/MatSetValuesLocal.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatSetValuesLocal</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/Mat/MatSetValuesLocal.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatSetValuesLocal"><H1>MatSetValuesLocal</H1></A>
Inserts or adds values into certain locations of a matrix, using a local ordering of the nodes. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h" 
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Mat/MatSetValuesLocal.html#MatSetValuesLocal">MatSetValuesLocal</A>(<A HREF="../Mat/Mat.html#Mat">Mat</A> mat,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> nrow,const <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> irow[],<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> ncol,const <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> icol[],const <A HREF="../Sys/PetscScalar.html#PetscScalar">PetscScalar</A> y[],<A HREF="../Sys/InsertMode.html#InsertMode">InsertMode</A> addv)
</PRE>
Not Collective
<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
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>nrow, irow </B></TD><TD>- number of rows and their local indices
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ncol, icol </B></TD><TD>- number of columns and their local indices
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>y </B></TD><TD>- a logically two-dimensional array of values
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>addv </B></TD><TD>- either <A HREF="../Sys/INSERT_VALUES.html#INSERT_VALUES">INSERT_VALUES</A> or <A HREF="../Sys/ADD_VALUES.html#ADD_VALUES">ADD_VALUES</A>, where
<A HREF="../Sys/ADD_VALUES.html#ADD_VALUES">ADD_VALUES</A> adds values to any existing entries, and
<A HREF="../Sys/INSERT_VALUES.html#INSERT_VALUES">INSERT_VALUES</A> replaces existing entries with new values
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
If you create the matrix yourself (that is not with a call to <A HREF="../DM/DMCreateMatrix.html#DMCreateMatrix">DMCreateMatrix</A>()) then you MUST call MatXXXXSetPreallocation() or
<A HREF="../Mat/MatSetUp.html#MatSetUp">MatSetUp</A>() before using this routine
<P>
If you create the matrix yourself (that is not with a call to <A HREF="../DM/DMCreateMatrix.html#DMCreateMatrix">DMCreateMatrix</A>()) then you MUST call <A HREF="../Mat/MatSetLocalToGlobalMapping.html#MatSetLocalToGlobalMapping">MatSetLocalToGlobalMapping</A>() before using this routine
<P>
Calls to <A HREF="../Mat/MatSetValuesLocal.html#MatSetValuesLocal">MatSetValuesLocal</A>() with the <A HREF="../Sys/INSERT_VALUES.html#INSERT_VALUES">INSERT_VALUES</A> and <A HREF="../Sys/ADD_VALUES.html#ADD_VALUES">ADD_VALUES</A>
options cannot be mixed without intervening calls to the assembly
routines.
<P>
These values may be cached, so <A HREF="../Mat/MatAssemblyBegin.html#MatAssemblyBegin">MatAssemblyBegin</A>() and <A HREF="../Mat/MatAssemblyEnd.html#MatAssemblyEnd">MatAssemblyEnd</A>()
MUST be called after all calls to <A HREF="../Mat/MatSetValuesLocal.html#MatSetValuesLocal">MatSetValuesLocal</A>() have been completed.
<P>

<P>
<P>
<H3><FONT COLOR="#CC3333">Developer Notes</FONT></H3>
This is labeled with C so does not automatically generate Fortran stubs and interfaces
because it requires multiple Fortran interfaces depending on which arguments are scalar or arrays.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
  <A HREF="../Mat/MatAssemblyBegin.html#MatAssemblyBegin">MatAssemblyBegin</A>(), <A HREF="../Mat/MatAssemblyEnd.html#MatAssemblyEnd">MatAssemblyEnd</A>(), <A HREF="../Mat/MatSetValues.html#MatSetValues">MatSetValues</A>(), <A HREF="../Mat/MatSetLocalToGlobalMapping.html#MatSetLocalToGlobalMapping">MatSetLocalToGlobalMapping</A>(),
<BR>MatSetValueLocal()
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/mat/interface/matrix.c.html#MatSetValuesLocal">src/mat/interface/matrix.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex70.c.html">src/ksp/ksp/examples/tutorials/ex70.c.html</A><BR>
<A HREF="../../../src/snes/examples/tutorials/ex5.c.html">src/snes/examples/tutorials/ex5.c.html</A><BR>
<A HREF="../../../src/snes/examples/tutorials/ex14.c.html">src/snes/examples/tutorials/ex14.c.html</A><BR>
<A HREF="../../../src/snes/examples/tutorials/ex28.c.html">src/snes/examples/tutorials/ex28.c.html</A><BR>
<A HREF="../../../src/snes/examples/tutorials/ex35.c.html">src/snes/examples/tutorials/ex35.c.html</A><BR>
<A HREF="../../../src/snes/examples/tutorials/ex46.c.html">src/snes/examples/tutorials/ex46.c.html</A><BR>
<A HREF="../../../src/snes/examples/tutorials/ex5f.F90.html">src/snes/examples/tutorials/ex5f.F90.html</A><BR>
<A HREF="../../../src/snes/examples/tutorials/ex5f90.F90.html">src/snes/examples/tutorials/ex5f90.F90.html</A><BR>
<A HREF="../../../src/snes/examples/tutorials/ex5f90t.F90.html">src/snes/examples/tutorials/ex5f90t.F90.html</A><BR>
<A HREF="../../../src/snes/examples/tutorials/ex40f90.F90.html">src/snes/examples/tutorials/ex40f90.F90.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex2.c.html">src/ts/examples/tutorials/ex2.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/dm/impls/da/hypre/mhyp.c.html#MatSetValuesLocal_HYPREStruct_3d">MatSetValuesLocal_HYPREStruct_3d in src/dm/impls/da/hypre/mhyp.c</A><BR>
<A HREF="../../../src/dm/impls/da/hypre/mhyp.c.html#MatSetValuesLocal_HYPRESStruct_3d">MatSetValuesLocal_HYPRESStruct_3d in src/dm/impls/da/hypre/mhyp.c</A><BR>
<A HREF="../../../src/mat/impls/is/matis.c.html#MatSetValuesLocal_SubMat_IS">MatSetValuesLocal_SubMat_IS in src/mat/impls/is/matis.c</A><BR>
<A HREF="../../../src/mat/impls/is/matis.c.html#MatSetValuesLocal_IS">MatSetValuesLocal_IS in src/mat/impls/is/matis.c</A><BR>
<A HREF="../../../src/mat/impls/localref/mlocalref.c.html#MatSetValuesLocal_LocalRef_Scalar">MatSetValuesLocal_LocalRef_Scalar in src/mat/impls/localref/mlocalref.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>