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
|
<!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/MatStencil.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatStencil</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/MatStencil.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatStencil"><H1>MatStencil</H1></A>
Data structure (C struct) for storing information about a single row or column of a matrix as indexed on an associated grid. These are arguments to <A HREF="../Mat/MatSetStencil.html#MatSetStencil">MatSetStencil</A>() and MatSetBlockStencil()
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
typedef struct {
<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> k,j,i,c;
} <A HREF="../Mat/MatStencil.html#MatStencil">MatStencil</A>;
</PRE>
The i,j, and k represent the logical coordinates over the entire grid (for 2 and 1 dimensional problems the k and j entries are ignored).
The c represents the the degrees of freedom at each grid point (the dof argument to DMDASetDOF()). If dof is 1 then this entry is ignored.
<P>
For stencil access to vectors see <A HREF="../DMDA/DMDAVecGetArray.html#DMDAVecGetArray">DMDAVecGetArray</A>(), DMDAVecGetArrayF90().
<P>
Fortran usage is different, see <A HREF="../Mat/MatSetValuesStencil.html#MatSetValuesStencil">MatSetValuesStencil</A>() for details.
<P>
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Mat/MatSetValuesStencil.html#MatSetValuesStencil">MatSetValuesStencil</A>(), <A HREF="../Mat/MatSetStencil.html#MatSetStencil">MatSetStencil</A>(), <A HREF="../Mat/MatSetValuesBlockedStencil.html#MatSetValuesBlockedStencil">MatSetValuesBlockedStencil</A>(), <A HREF="../DMDA/DMDAVecGetArray.html#DMDAVecGetArray">DMDAVecGetArray</A>(), DMDAVecGetArrayF90()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>beginner<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/mat/../../include/petscmat.h.html#MatStencil">src/mat/../../include/petscmat.h</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/ksp/ksp/examples/tutorials/ex28.c.html">src/ksp/ksp/examples/tutorials/ex28.c.html</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>
|
