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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
<!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/MatCreate.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatCreate</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/MatCreate.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatCreate"><H1>MatCreate</H1></A>
Creates a matrix where the type is determined from either a call to <A HREF="../Mat/MatSetType.html#MatSetType">MatSetType</A>() or from the options database with a call to <A HREF="../Mat/MatSetFromOptions.html#MatSetFromOptions">MatSetFromOptions</A>(). The default matrix type is AIJ, using the routines <A HREF="../Mat/MatCreateSeqAIJ.html#MatCreateSeqAIJ">MatCreateSeqAIJ</A>() or <A HREF="../Mat/MatCreateAIJ.html#MatCreateAIJ">MatCreateAIJ</A>() if you do not set a type in the options database. If you never call <A HREF="../Mat/MatSetType.html#MatSetType">MatSetType</A>() or <A HREF="../Mat/MatSetFromOptions.html#MatSetFromOptions">MatSetFromOptions</A>() it will generate an error when you try to use the matrix.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Mat/MatCreate.html#MatCreate">MatCreate</A>(<A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A> comm,<A HREF="../Mat/Mat.html#Mat">Mat</A> *A)
</PRE>
Collective
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>comm </B></TD><TD>- MPI communicator
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>A </B></TD><TD>- the matrix
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Options Database Keys</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_type seqaij </B></TD><TD>- AIJ type, uses <A HREF="../Mat/MatCreateSeqAIJ.html#MatCreateSeqAIJ">MatCreateSeqAIJ</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_type mpiaij </B></TD><TD>- AIJ type, uses <A HREF="../Mat/MatCreateAIJ.html#MatCreateAIJ">MatCreateAIJ</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_type seqdense </B></TD><TD>- dense type, uses <A HREF="../Mat/MatCreateSeqDense.html#MatCreateSeqDense">MatCreateSeqDense</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_type mpidense </B></TD><TD>- dense type, uses <A HREF="../Mat/MatCreateDense.html#MatCreateDense">MatCreateDense</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_type seqbaij </B></TD><TD>- block AIJ type, uses <A HREF="../Mat/MatCreateSeqBAIJ.html#MatCreateSeqBAIJ">MatCreateSeqBAIJ</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mat_type mpibaij </B></TD><TD>- block AIJ type, uses <A HREF="../Mat/MatCreateBAIJ.html#MatCreateBAIJ">MatCreateBAIJ</A>()
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Even More Options Database Keys</FONT></H3>
See the manpages for particular formats (e.g., <A HREF="../Mat/MatCreateSeqAIJ.html#MatCreateSeqAIJ">MatCreateSeqAIJ</A>())
for additional format-specific options.
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Mat/MatCreateSeqAIJ.html#MatCreateSeqAIJ">MatCreateSeqAIJ</A>(), <A HREF="../Mat/MatCreateAIJ.html#MatCreateAIJ">MatCreateAIJ</A>(),
<BR><A HREF="../Mat/MatCreateSeqDense.html#MatCreateSeqDense">MatCreateSeqDense</A>(), <A HREF="../Mat/MatCreateDense.html#MatCreateDense">MatCreateDense</A>(),
<A HREF="../Mat/MatCreateSeqBAIJ.html#MatCreateSeqBAIJ">MatCreateSeqBAIJ</A>(), <A HREF="../Mat/MatCreateBAIJ.html#MatCreateBAIJ">MatCreateBAIJ</A>(),
<A HREF="../Mat/MatCreateSeqSBAIJ.html#MatCreateSeqSBAIJ">MatCreateSeqSBAIJ</A>(), <A HREF="../Mat/MatCreateSBAIJ.html#MatCreateSBAIJ">MatCreateSBAIJ</A>(),
<A HREF="../Mat/MatConvert.html#MatConvert">MatConvert</A>()
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>beginner<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/mat/utils/gcreate.c.html#MatCreate">src/mat/utils/gcreate.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/mat/tutorials/ex1.c.html">src/mat/tutorials/ex1.c.html</A><BR>
<A HREF="../../../src/mat/tutorials/ex2.c.html">src/mat/tutorials/ex2.c.html</A><BR>
<A HREF="../../../src/mat/tutorials/ex8.c.html">src/mat/tutorials/ex8.c.html</A><BR>
<A HREF="../../../src/mat/tutorials/ex10.c.html">src/mat/tutorials/ex10.c.html</A><BR>
<A HREF="../../../src/mat/tutorials/ex12.c.html">src/mat/tutorials/ex12.c.html</A><BR>
<A HREF="../../../src/mat/tutorials/ex15.c.html">src/mat/tutorials/ex15.c.html</A><BR>
<A HREF="../../../src/mat/tutorials/ex16.c.html">src/mat/tutorials/ex16.c.html</A><BR>
<A HREF="../../../src/mat/tutorials/ex17.c.html">src/mat/tutorials/ex17.c.html</A><BR>
<A HREF="../../../src/mat/tutorials/ex15f.F90.html">src/mat/tutorials/ex15f.F90.html</A><BR>
<A HREF="../../../src/mat/tutorials/ex17f.F90.html">src/mat/tutorials/ex17f.F90.html</A><BR>
<A HREF="../../../src/ksp/pc/tutorials/ex3.c.html">src/ksp/pc/tutorials/ex3.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/dm/impls/da/hypre/mhyp.c.html#MatCreate_HYPREStruct">MatCreate_HYPREStruct in src/dm/impls/da/hypre/mhyp.c</A><BR>
<A HREF="../../../src/dm/impls/da/hypre/mhyp.c.html#MatCreate_HYPRESStruct">MatCreate_HYPRESStruct in src/dm/impls/da/hypre/mhyp.c</A><BR>
<A HREF="../../../src/mat/impls/adj/mpi/mpiadj.c.html#MatCreate_MPIAdj">MatCreate_MPIAdj in src/mat/impls/adj/mpi/mpiadj.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/aijmkl/mpiaijmkl.c.html#MatCreate_MPIAIJMKL">MatCreate_MPIAIJMKL in src/mat/impls/aij/mpi/aijmkl/mpiaijmkl.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/aijperm/mpiaijperm.c.html#MatCreate_MPIAIJPERM">MatCreate_MPIAIJPERM in src/mat/impls/aij/mpi/aijperm/mpiaijperm.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/aijsell/mpiaijsell.c.html#MatCreate_MPIAIJSELL">MatCreate_MPIAIJSELL in src/mat/impls/aij/mpi/aijsell/mpiaijsell.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/crl/mcrl.c.html#MatCreate_MPIAIJCRL">MatCreate_MPIAIJCRL in src/mat/impls/aij/mpi/crl/mcrl.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/kokkos/mpiaijkok.kokkos.cxx.html#MatCreate_MPIAIJKokkos">MatCreate_MPIAIJKokkos in src/mat/impls/aij/mpi/kokkos/mpiaijkok.kokkos.cxx</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/mpiaij.c.html#MatCreate_MPIAIJ">MatCreate_MPIAIJ in src/mat/impls/aij/mpi/mpiaij.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/mpicusparse/mpiaijcusparse.cu.html#MatCreate_MPIAIJCUSPARSE">MatCreate_MPIAIJCUSPARSE in src/mat/impls/aij/mpi/mpicusparse/mpiaijcusparse.cu</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/mpiviennacl/mpiaijviennacl.cxx.html#MatCreate_MPIAIJViennaCL">MatCreate_MPIAIJViennaCL in src/mat/impls/aij/mpi/mpiviennacl/mpiaijviennacl.cxx</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aij.c.html#MatCreate_SeqAIJ">MatCreate_SeqAIJ in src/mat/impls/aij/seq/aij.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aijmkl/aijmkl.c.html#MatCreate_SeqAIJMKL">MatCreate_SeqAIJMKL in src/mat/impls/aij/seq/aijmkl/aijmkl.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aijperm/aijperm.c.html#MatCreate_SeqAIJPERM">MatCreate_SeqAIJPERM in src/mat/impls/aij/seq/aijperm/aijperm.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aijsell/aijsell.c.html#MatCreate_SeqAIJSELL">MatCreate_SeqAIJSELL in src/mat/impls/aij/seq/aijsell/aijsell.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/crl/crl.c.html#MatCreate_SeqAIJCRL">MatCreate_SeqAIJCRL in src/mat/impls/aij/seq/crl/crl.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/inode2.c.html#MatCreate_SeqAIJ_Inode">MatCreate_SeqAIJ_Inode in src/mat/impls/aij/seq/inode2.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/kokkos/aijkok.kokkos.cxx.html#MatCreate_SeqAIJKokkos">MatCreate_SeqAIJKokkos in src/mat/impls/aij/seq/kokkos/aijkok.kokkos.cxx</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/seqcusparse/aijcusparse.cu.html#MatCreate_SeqAIJCUSPARSE">MatCreate_SeqAIJCUSPARSE in src/mat/impls/aij/seq/seqcusparse/aijcusparse.cu</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/seqviennacl/aijviennacl.cxx.html#MatCreate_SeqAIJViennaCL">MatCreate_SeqAIJViennaCL in src/mat/impls/aij/seq/seqviennacl/aijviennacl.cxx</A><BR>
<A HREF="../../../src/mat/impls/baij/mpi/baijmkl/mpibaijmkl.c.html#MatCreate_MPIBAIJMKL">MatCreate_MPIBAIJMKL in src/mat/impls/baij/mpi/baijmkl/mpibaijmkl.c</A><BR>
<A HREF="../../../src/mat/impls/baij/mpi/mpibaij.c.html#MatCreate_MPIBAIJ">MatCreate_MPIBAIJ in src/mat/impls/baij/mpi/mpibaij.c</A><BR>
<A HREF="../../../src/mat/impls/baij/seq/baij.c.html#MatCreate_SeqBAIJ">MatCreate_SeqBAIJ in src/mat/impls/baij/seq/baij.c</A><BR>
<A HREF="../../../src/mat/impls/baij/seq/baijmkl/baijmkl.c.html#MatCreate_SeqBAIJMKL">MatCreate_SeqBAIJMKL in src/mat/impls/baij/seq/baijmkl/baijmkl.c</A><BR>
<A HREF="../../../src/mat/impls/blockmat/seq/blockmat.c.html#MatCreate_BlockMat">MatCreate_BlockMat in src/mat/impls/blockmat/seq/blockmat.c</A><BR>
<A HREF="../../../src/mat/impls/cdiagonal/cdiagonal.c.html#MatCreate_ConstantDiagonal">MatCreate_ConstantDiagonal in src/mat/impls/cdiagonal/cdiagonal.c</A><BR>
<A HREF="../../../src/mat/impls/composite/mcomposite.c.html#MatCreate_Composite">MatCreate_Composite in src/mat/impls/composite/mcomposite.c</A><BR>
<A HREF="../../../src/mat/impls/dense/mpi/mpidense.c.html#MatCreate_MPIDense">MatCreate_MPIDense in src/mat/impls/dense/mpi/mpidense.c</A><BR>
<A HREF="../../../src/mat/impls/dense/mpi/mpidense.c.html#MatCreate_MPIDenseCUDA">MatCreate_MPIDenseCUDA in src/mat/impls/dense/mpi/mpidense.c</A><BR>
<A HREF="../../../src/mat/impls/dense/seq/cuda/densecuda.cu.html#MatCreate_SeqDenseCUDA">MatCreate_SeqDenseCUDA in src/mat/impls/dense/seq/cuda/densecuda.cu</A><BR>
<A HREF="../../../src/mat/impls/dense/seq/dense.c.html#MatCreate_SeqDense">MatCreate_SeqDense in src/mat/impls/dense/seq/dense.c</A><BR>
<A HREF="../../../src/mat/impls/dummy/matdummy.c.html#MatCreate_Dummy">MatCreate_Dummy in src/mat/impls/dummy/matdummy.c</A><BR>
<A HREF="../../../src/mat/impls/elemental/matelem.cxx.html#MatCreate_Elemental">MatCreate_Elemental in src/mat/impls/elemental/matelem.cxx</A><BR>
<A HREF="../../../src/mat/impls/fft/fftw/fftw.c.html#MatCreate_FFTW">MatCreate_FFTW in src/mat/impls/fft/fftw/fftw.c</A><BR>
<A HREF="../../../src/mat/impls/hara/mathara.cu.html#MatCreate_HARA">MatCreate_HARA in src/mat/impls/hara/mathara.cu</A><BR>
<A HREF="../../../src/mat/impls/hypre/mhypre.c.html#MatCreate_HYPRE">MatCreate_HYPRE in src/mat/impls/hypre/mhypre.c</A><BR>
<A HREF="../../../src/mat/impls/is/matis.c.html#MatCreate_IS">MatCreate_IS in src/mat/impls/is/matis.c</A><BR>
<A HREF="../../../src/mat/impls/kaij/kaij.c.html#MatCreate_KAIJ">MatCreate_KAIJ in src/mat/impls/kaij/kaij.c</A><BR>
<A HREF="../../../src/mat/impls/maij/maij.c.html#MatCreate_MAIJ">MatCreate_MAIJ in src/mat/impls/maij/maij.c</A><BR>
<A HREF="../../../src/mat/impls/mffd/mffd.c.html#MatCreate_MFFD">MatCreate_MFFD in src/mat/impls/mffd/mffd.c</A><BR>
<A HREF="../../../src/mat/impls/nest/matnest.c.html#MatCreate_Nest">MatCreate_Nest in src/mat/impls/nest/matnest.c</A><BR>
<A HREF="../../../src/mat/impls/preallocator/matpreallocator.c.html#MatCreate_Preallocator">MatCreate_Preallocator in src/mat/impls/preallocator/matpreallocator.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/mpi/mpisbaij.c.html#MatCreate_MPISBAIJ">MatCreate_MPISBAIJ in src/mat/impls/sbaij/mpi/mpisbaij.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/seq/sbaij.c.html#MatCreate_SeqSBAIJ">MatCreate_SeqSBAIJ in src/mat/impls/sbaij/seq/sbaij.c</A><BR>
<A HREF="../../../src/mat/impls/scalapack/matscalapack.c.html#MatCreate_ScaLAPACK">MatCreate_ScaLAPACK in src/mat/impls/scalapack/matscalapack.c</A><BR>
<A HREF="../../../src/mat/impls/scatter/mscatter.c.html#MatCreate_Scatter">MatCreate_Scatter in src/mat/impls/scatter/mscatter.c</A><BR>
<A HREF="../../../src/mat/impls/sell/mpi/mpisell.c.html#MatCreate_MPISELL">MatCreate_MPISELL in src/mat/impls/sell/mpi/mpisell.c</A><BR>
<A HREF="../../../src/mat/impls/sell/seq/sell.c.html#MatCreate_SeqSELL">MatCreate_SeqSELL in src/mat/impls/sell/seq/sell.c</A><BR>
<A HREF="../../../src/mat/impls/shell/shell.c.html#MatCreate_Shell">MatCreate_Shell in src/mat/impls/shell/shell.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>
|
