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/DMSTAG/DMStagVecSetValuesStencil.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMStagVecSetValuesStencil</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/DMSTAG/DMStagVecSetValuesStencil.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMStagVecSetValuesStencil"><H1>DMStagVecSetValuesStencil</H1></A>
Set <A HREF="../Vec/Vec.html#Vec">Vec</A> values using global grid indexing
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../DMSTAG/DMStagVecSetValuesStencil.html#DMStagVecSetValuesStencil">DMStagVecSetValuesStencil</A>(<A HREF="../DM/DM.html#DM">DM</A> dm,<A HREF="../Vec/Vec.html#Vec">Vec</A> vec,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> n,const <A HREF="../DMSTAG/DMStagStencil.html#DMStagStencil">DMStagStencil</A> *pos,const <A HREF="../Sys/PetscScalar.html#PetscScalar">PetscScalar</A> *val,<A HREF="../Sys/InsertMode.html#InsertMode">InsertMode</A> insertMode)
</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>dm </B></TD><TD>- the DMStag object
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>vec </B></TD><TD>- the <A HREF="../Vec/Vec.html#Vec">Vec</A>
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>n </B></TD><TD>- the number of values to set
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>pos </B></TD><TD>- the locations to set values, as an array of <A HREF="../DMSTAG/DMStagStencil.html#DMStagStencil">DMStagStencil</A> structs
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>val </B></TD><TD>- the values to set
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>insertMode </B></TD><TD>- <A HREF="../Sys/INSERT_VALUES.html#INSERT_VALUES">INSERT_VALUES</A> or <A HREF="../Sys/ADD_VALUES.html#ADD_VALUES">ADD_VALUES</A>
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
The vector is expected to be a global vector compatible with the <A HREF="../DM/DM.html#DM">DM</A> (usually obtained by <A HREF="../DM/DMGetGlobalVector.html#DMGetGlobalVector">DMGetGlobalVector</A>() or <A HREF="../DM/DMCreateGlobalVector.html#DMCreateGlobalVector">DMCreateGlobalVector</A>()).
<P>
This approach is not as efficient as setting values directly with <A HREF="../DMSTAG/DMStagVecGetArray.html#DMStagVecGetArray">DMStagVecGetArray</A>(), which is recommended for matrix-free operators.
For assembling systems, where overhead may be less important than convenience, this routine could be helpful in assembling a righthand side and a matrix (using <A HREF="../DMSTAG/DMStagMatSetValuesStencil.html#DMStagMatSetValuesStencil">DMStagMatSetValuesStencil</A>()).
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../DMSTAG/DMSTAG.html#DMSTAG">DMSTAG</A>, <A HREF="../DMSTAG/DMStagStencil.html#DMStagStencil">DMStagStencil</A>, <A HREF="../DMSTAG/DMStagStencilLocation.html#DMStagStencilLocation">DMStagStencilLocation</A>, <A HREF="../DMSTAG/DMStagVecGetValuesStencil.html#DMStagVecGetValuesStencil">DMStagVecGetValuesStencil</A>(), <A HREF="../DMSTAG/DMStagMatSetValuesStencil.html#DMStagMatSetValuesStencil">DMStagMatSetValuesStencil</A>(), <A HREF="../DM/DMCreateGlobalVector.html#DMCreateGlobalVector">DMCreateGlobalVector</A>(), <A HREF="../DM/DMGetLocalVector.html#DMGetLocalVector">DMGetLocalVector</A>(), <A HREF="../DMSTAG/DMStagVecGetArray.html#DMStagVecGetArray">DMStagVecGetArray</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/dm/impls/stag/stagstencil.c.html#DMStagVecSetValuesStencil">src/dm/impls/stag/stagstencil.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/dm/impls/stag/tutorials/ex1.c.html">src/dm/impls/stag/tutorials/ex1.c.html</A><BR>
<A HREF="../../../src/dm/impls/stag/tutorials/ex2.c.html">src/dm/impls/stag/tutorials/ex2.c.html</A><BR>
<A HREF="../../../src/dm/impls/stag/tutorials/ex3.c.html">src/dm/impls/stag/tutorials/ex3.c.html</A><BR>
<A HREF="../../../src/dm/impls/stag/tutorials/ex4.c.html">src/dm/impls/stag/tutorials/ex4.c.html</A><BR>
<A HREF="../../../src/dm/impls/stag/tutorials/ex6.c.html">src/dm/impls/stag/tutorials/ex6.c.html</A><BR>
<BR><A HREF="./index.html">Index of all DMSTAG 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>
|
