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
|
<!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/MatPreallocateLocation.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatPreallocateLocation</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.7.5 2017-01-01</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.7.5 v3.7.5 docs/manualpages/Mat/MatPreallocateLocation.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatPreallocateLocation"><H1>MatPreallocateLocation</H1></A>
An alternative to MatPreallocationSet() that puts the nonzero locations into the matrix if it exists
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include <petscmat.h>
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> MatPreallocateLocations(<A HREF="../Mat/Mat.html#Mat">Mat</A> A,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> row,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> ncols,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *cols,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *dnz,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *onz)
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<DT><B>A </B> -matrix
<br>
<DT><B>row </B> -row where values exist (must be local to this process)
<br>
<DT><B>ncols </B> -number of columns
<br>
<DT><B>cols </B> -columns with nonzeros
<br>
<DT><B>dnz </B> -the array that will be passed to the matrix preallocation routines
<br>
<DT><B>ozn </B> -the other array passed to the matrix preallocation routines
<br>
</TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
See Users-Manual: <A HREF="../../manual.pdf#chapter.14">Chapter 14 Hints for Performance Tuning</A> for more details.
<P>
Do not malloc or free dnz and onz that is handled internally by these routines
<P>
This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines.
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Mat/MatPreallocateInitialize.html#MatPreallocateInitialize">MatPreallocateInitialize</A>(), <A HREF="../Mat/MatPreallocateSet.html#MatPreallocateSet">MatPreallocateSet</A>(), <A HREF="../Mat/MatPreallocateSymmetricSetBlock.html#MatPreallocateSymmetricSetBlock">MatPreallocateSymmetricSetBlock</A>(), <A HREF="../Mat/MatPreallocateSetLocal.html#MatPreallocateSetLocal">MatPreallocateSetLocal</A>(),
<BR><A HREF="../Mat/MatPreallocateSymmetricSetLocalBlock.html#MatPreallocateSymmetricSetLocalBlock">MatPreallocateSymmetricSetLocalBlock</A>()
<P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>intermediate
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/mat/../../include/petscmat.h.html#MatPreallocateLocation">src/mat/../../include/petscmat.h</A>
<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>
|
