File: MatMPIBAIJSetPreallocationCSR.html

package info (click to toggle)
petsc 3.14.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 266,472 kB
  • sloc: ansic: 680,898; python: 33,303; cpp: 16,324; makefile: 14,022; f90: 13,731; javascript: 10,713; fortran: 9,581; sh: 1,373; xml: 619; objc: 445; csh: 192; pascal: 148; java: 13
file content (52 lines) | stat: -rw-r--r-- 4,450 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
<!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/MatMPIBAIJSetPreallocationCSR.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatMPIBAIJSetPreallocationCSR</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/MatMPIBAIJSetPreallocationCSR.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatMPIBAIJSetPreallocationCSR"><H1>MatMPIBAIJSetPreallocationCSR</H1></A>
Creates a sparse parallel matrix in BAIJ format using the given nonzero structure and (optional) numerical values 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h"  
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A>  <A HREF="../Mat/MatMPIBAIJSetPreallocationCSR.html#MatMPIBAIJSetPreallocationCSR">MatMPIBAIJSetPreallocationCSR</A>(<A HREF="../Mat/Mat.html#Mat">Mat</A> B,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> bs,const <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> i[],const <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> j[], const <A HREF="../Sys/PetscScalar.html#PetscScalar">PetscScalar</A> v[])
</PRE>
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>B </B></TD><TD>- the matrix
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>bs </B></TD><TD>- the block size
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>i </B></TD><TD>- the indices into j for the start of each local row (starts with zero)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>j </B></TD><TD>- the column indices for each local row (starts with zero) these must be sorted for each row
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>v </B></TD><TD>- optional values in the matrix
</TD></TR></TABLE>
<P>

<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
The order of the entries in values is specified by the <A HREF="../Mat/MatOption.html#MatOption">MatOption</A> <A HREF="../Mat/MatOption.html#MatOption">MAT_ROW_ORIENTED</A>.  For example, C programs
may want to use the default <A HREF="../Mat/MatOption.html#MatOption">MAT_ROW_ORIENTED</A>=<A HREF="../Sys/PETSC_TRUE.html#PETSC_TRUE">PETSC_TRUE</A> and use an array v[nnz][bs][bs] where the second index is
over rows within a block and the last index is over columns within a block row.  Fortran programs will likely set
<A HREF="../Mat/MatOption.html#MatOption">MAT_ROW_ORIENTED</A>=<A HREF="../Sys/PETSC_FALSE.html#PETSC_FALSE">PETSC_FALSE</A> and use a Fortran array v(bs,bs,nnz) in which the first index is over rows within a
block column and the second index is over columns within a block.
<P>
Though this routine has Preallocation() in the name it also sets the exact nonzero locations of the matrix entries and usually the numerical values as well
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../Mat/MatCreate.html#MatCreate">MatCreate</A>(), <A HREF="../Mat/MatCreateSeqAIJ.html#MatCreateSeqAIJ">MatCreateSeqAIJ</A>(), <A HREF="../Mat/MatSetValues.html#MatSetValues">MatSetValues</A>(), <A HREF="../Mat/MatMPIBAIJSetPreallocation.html#MatMPIBAIJSetPreallocation">MatMPIBAIJSetPreallocation</A>(), <A HREF="../Mat/MatCreateAIJ.html#MatCreateAIJ">MatCreateAIJ</A>(), MPIAIJ, <A HREF="../Mat/MatCreateMPIBAIJWithArrays.html#MatCreateMPIBAIJWithArrays">MatCreateMPIBAIJWithArrays</A>(), MPIBAIJ
<BR><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/baij/mpi/mpibaij.c.html#MatMPIBAIJSetPreallocationCSR">src/mat/impls/baij/mpi/mpibaij.c</A>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/mat/impls/baij/mpi/mpibaij.c.html#MatMPIBAIJSetPreallocationCSR_MPIBAIJ">MatMPIBAIJSetPreallocationCSR_MPIBAIJ in src/mat/impls/baij/mpi/mpibaij.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>