File: MatConvert.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 (129 lines) | stat: -rw-r--r-- 14,960 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
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
124
125
126
127
128
129
<!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/MatConvert.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatConvert</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/MatConvert.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatConvert"><H1>MatConvert</H1></A>
<A HREF="../Sys/Converts.html#Converts">Converts</A> a matrix to another matrix, either of the same or different type. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h" 
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Mat/MatConvert.html#MatConvert">MatConvert</A>(<A HREF="../Mat/Mat.html#Mat">Mat</A> mat, <A HREF="../Mat/MatType.html#MatType">MatType</A> newtype,<A HREF="../Mat/MatReuse.html#MatReuse">MatReuse</A> reuse,<A HREF="../Mat/Mat.html#Mat">Mat</A> *M)
</PRE>
Collective on <A HREF="../Mat/Mat.html#Mat">Mat</A>
<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>mat </B></TD><TD>- the matrix
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>newtype </B></TD><TD>- new matrix type.  Use MATSAME to create a new matrix of the
same type as the original matrix.
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>reuse </B></TD><TD>- denotes if the destination matrix is to be created or reused.
Use <A HREF="../Mat/MatReuse.html#MatReuse">MAT_INPLACE_MATRIX</A> for inplace conversion (that is when you want the input mat to be changed to contain the matrix in the new format), otherwise use
<A HREF="../Mat/MatReuse.html#MatReuse">MAT_INITIAL_MATRIX</A> or <A HREF="../Mat/MatReuse.html#MatReuse">MAT_REUSE_MATRIX</A> (can only be used after the first call was made with <A HREF="../Mat/MatReuse.html#MatReuse">MAT_INITIAL_MATRIX</A>, causes the matrix space in M to be reused).
</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>M </B></TD><TD>- pointer to place new matrix
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
<A HREF="../Mat/MatConvert.html#MatConvert">MatConvert</A>() first creates a new matrix and then copies the data from
the first matrix.  A related routine is <A HREF="../Mat/MatCopy.html#MatCopy">MatCopy</A>(), which copies the matrix
entries of one matrix to another already existing matrix context.
<P>
Cannot be used to convert a sequential matrix to parallel or parallel to sequential,
the MPI communicator of the generated matrix is always the same as the communicator
of the input matrix.
<P>

<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../Mat/MatCopy.html#MatCopy">MatCopy</A>(), <A HREF="../Mat/MatDuplicate.html#MatDuplicate">MatDuplicate</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/mat/interface/matrix.c.html#MatConvert">src/mat/interface/matrix.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/ksp/ksp/tutorials/ex29.c.html">src/ksp/ksp/tutorials/ex29.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex34.c.html">src/ksp/ksp/tutorials/ex34.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex71.c.html">src/ksp/ksp/tutorials/ex71.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex72.c.html">src/ksp/ksp/tutorials/ex72.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex76.c.html">src/ksp/ksp/tutorials/ex76.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex77.c.html">src/ksp/ksp/tutorials/ex77.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex6f.F90.html">src/ksp/ksp/tutorials/ex6f.F90.html</A><BR>
<A HREF="../../../src/snes/tutorials/ex28.c.html">src/snes/tutorials/ex28.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/ksp/pc/impls/ml/ml.c.html#MatConvert_MPIAIJ_ML">MatConvert_MPIAIJ_ML in src/ksp/pc/impls/ml/ml.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/aijmkl/mpiaijmkl.c.html#MatConvert_MPIAIJ_MPIAIJMKL">MatConvert_MPIAIJ_MPIAIJMKL in src/mat/impls/aij/mpi/aijmkl/mpiaijmkl.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/aijperm/mpiaijperm.c.html#MatConvert_MPIAIJ_MPIAIJPERM">MatConvert_MPIAIJ_MPIAIJPERM in src/mat/impls/aij/mpi/aijperm/mpiaijperm.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/aijsell/mpiaijsell.c.html#MatConvert_MPIAIJ_MPIAIJSELL">MatConvert_MPIAIJ_MPIAIJSELL in src/mat/impls/aij/mpi/aijsell/mpiaijsell.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/crl/mcrl.c.html#MatConvert_MPIAIJ_MPIAIJCRL">MatConvert_MPIAIJ_MPIAIJCRL in src/mat/impls/aij/mpi/crl/mcrl.c</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/kokkos/mpiaijkok.kokkos.cxx.html#MatConvert_MPIAIJ_MPIAIJKokkos">MatConvert_MPIAIJ_MPIAIJKokkos in src/mat/impls/aij/mpi/kokkos/mpiaijkok.kokkos.cxx</A><BR>
<A HREF="../../../src/mat/impls/aij/mpi/mpicusparse/mpiaijcusparse.cu.html#MatConvert_MPIAIJ_MPIAIJCUSPARSE">MatConvert_MPIAIJ_MPIAIJCUSPARSE in src/mat/impls/aij/mpi/mpicusparse/mpiaijcusparse.cu</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aijmkl/aijmkl.c.html#MatConvert_SeqAIJMKL_SeqAIJ">MatConvert_SeqAIJMKL_SeqAIJ in src/mat/impls/aij/seq/aijmkl/aijmkl.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aijmkl/aijmkl.c.html#MatConvert_SeqAIJ_SeqAIJMKL">MatConvert_SeqAIJ_SeqAIJMKL in src/mat/impls/aij/seq/aijmkl/aijmkl.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aijperm/aijperm.c.html#MatConvert_SeqAIJPERM_SeqAIJ">MatConvert_SeqAIJPERM_SeqAIJ in src/mat/impls/aij/seq/aijperm/aijperm.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aijperm/aijperm.c.html#MatConvert_SeqAIJ_SeqAIJPERM">MatConvert_SeqAIJ_SeqAIJPERM in src/mat/impls/aij/seq/aijperm/aijperm.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aijsell/aijsell.c.html#MatConvert_SeqAIJSELL_SeqAIJ">MatConvert_SeqAIJSELL_SeqAIJ in src/mat/impls/aij/seq/aijsell/aijsell.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aijsell/aijsell.c.html#MatConvert_SeqAIJ_SeqAIJSELL">MatConvert_SeqAIJ_SeqAIJSELL in src/mat/impls/aij/seq/aijsell/aijsell.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/crl/crl.c.html#MatConvert_SeqAIJ_SeqAIJCRL">MatConvert_SeqAIJ_SeqAIJCRL in src/mat/impls/aij/seq/crl/crl.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/kokkos/aijkok.kokkos.cxx.html#MatConvert_SeqAIJ_SeqAIJKokkos">MatConvert_SeqAIJ_SeqAIJKokkos in src/mat/impls/aij/seq/kokkos/aijkok.kokkos.cxx</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/seqcusparse/aijcusparse.cu.html#MatConvert_SeqAIJ_SeqAIJCUSPARSE">MatConvert_SeqAIJ_SeqAIJCUSPARSE in src/mat/impls/aij/seq/seqcusparse/aijcusparse.cu</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/seqviennacl/aijviennacl.cxx.html#MatConvert_SeqAIJ_SeqAIJViennaCL">MatConvert_SeqAIJ_SeqAIJViennaCL in src/mat/impls/aij/seq/seqviennacl/aijviennacl.cxx</A><BR>
<A HREF="../../../src/mat/impls/baij/mpi/baijmkl/mpibaijmkl.c.html#MatConvert_MPIBAIJ_MPIBAIJMKL">MatConvert_MPIBAIJ_MPIBAIJMKL in src/mat/impls/baij/mpi/baijmkl/mpibaijmkl.c</A><BR>
<A HREF="../../../src/mat/impls/baij/mpi/mpiaijbaij.c.html#MatConvert_MPIAIJ_MPIBAIJ">MatConvert_MPIAIJ_MPIBAIJ in src/mat/impls/baij/mpi/mpiaijbaij.c</A><BR>
<A HREF="../../../src/mat/impls/baij/mpi/mpibaij.c.html#MatConvert_MPIBAIJ_MPIAdj">MatConvert_MPIBAIJ_MPIAdj in src/mat/impls/baij/mpi/mpibaij.c</A><BR>
<A HREF="../../../src/mat/impls/baij/mpi/mpibaij.c.html#MatConvert_MPIBAIJ_MPIAIJ">MatConvert_MPIBAIJ_MPIAIJ in src/mat/impls/baij/mpi/mpibaij.c</A><BR>
<A HREF="../../../src/mat/impls/baij/seq/aijbaij.c.html#MatConvert_SeqBAIJ_SeqAIJ">MatConvert_SeqBAIJ_SeqAIJ in src/mat/impls/baij/seq/aijbaij.c</A><BR>
<A HREF="../../../src/mat/impls/baij/seq/aijbaij.c.html#MatConvert_SeqAIJ_SeqBAIJ">MatConvert_SeqAIJ_SeqBAIJ in src/mat/impls/baij/seq/aijbaij.c</A><BR>
<A HREF="../../../src/mat/impls/baij/seq/baijmkl/baijmkl.c.html#MatConvert_SeqBAIJMKL_SeqBAIJ">MatConvert_SeqBAIJMKL_SeqBAIJ in src/mat/impls/baij/seq/baijmkl/baijmkl.c</A><BR>
<A HREF="../../../src/mat/impls/baij/seq/baijmkl/baijmkl.c.html#MatConvert_SeqBAIJ_SeqBAIJMKL">MatConvert_SeqBAIJ_SeqBAIJMKL in src/mat/impls/baij/seq/baijmkl/baijmkl.c</A><BR>
<A HREF="../../../src/mat/impls/dense/mpi/mpidense.c.html#MatConvert_MPIDense_Elemental">MatConvert_MPIDense_Elemental in src/mat/impls/dense/mpi/mpidense.c</A><BR>
<A HREF="../../../src/mat/impls/dense/mpi/mpidense.c.html#MatConvert_MPIDenseCUDA_MPIDense">MatConvert_MPIDenseCUDA_MPIDense in src/mat/impls/dense/mpi/mpidense.c</A><BR>
<A HREF="../../../src/mat/impls/dense/mpi/mpidense.c.html#MatConvert_MPIDense_MPIDenseCUDA">MatConvert_MPIDense_MPIDenseCUDA in src/mat/impls/dense/mpi/mpidense.c</A><BR>
<A HREF="../../../src/mat/impls/dense/seq/cuda/densecuda.cu.html#MatConvert_SeqDenseCUDA_SeqDense">MatConvert_SeqDenseCUDA_SeqDense in src/mat/impls/dense/seq/cuda/densecuda.cu</A><BR>
<A HREF="../../../src/mat/impls/dense/seq/cuda/densecuda.cu.html#MatConvert_SeqDense_SeqDenseCUDA">MatConvert_SeqDense_SeqDenseCUDA in src/mat/impls/dense/seq/cuda/densecuda.cu</A><BR>
<A HREF="../../../src/mat/impls/dense/seq/dense.c.html#MatConvert_SeqAIJ_SeqDense">MatConvert_SeqAIJ_SeqDense in src/mat/impls/dense/seq/dense.c</A><BR>
<A HREF="../../../src/mat/impls/dense/seq/dense.c.html#MatConvert_SeqDense_SeqAIJ">MatConvert_SeqDense_SeqAIJ in src/mat/impls/dense/seq/dense.c</A><BR>
<A HREF="../../../src/mat/impls/dense/seq/dense.c.html#MatConvert_SeqDense_Elemental">MatConvert_SeqDense_Elemental in src/mat/impls/dense/seq/dense.c</A><BR>
<A HREF="../../../src/mat/impls/elemental/matelem.cxx.html#MatConvert_Elemental_Dense">MatConvert_Elemental_Dense in src/mat/impls/elemental/matelem.cxx</A><BR>
<A HREF="../../../src/mat/impls/elemental/matelem.cxx.html#MatConvert_SeqAIJ_Elemental">MatConvert_SeqAIJ_Elemental in src/mat/impls/elemental/matelem.cxx</A><BR>
<A HREF="../../../src/mat/impls/elemental/matelem.cxx.html#MatConvert_MPIAIJ_Elemental">MatConvert_MPIAIJ_Elemental in src/mat/impls/elemental/matelem.cxx</A><BR>
<A HREF="../../../src/mat/impls/elemental/matelem.cxx.html#MatConvert_SeqSBAIJ_Elemental">MatConvert_SeqSBAIJ_Elemental in src/mat/impls/elemental/matelem.cxx</A><BR>
<A HREF="../../../src/mat/impls/elemental/matelem.cxx.html#MatConvert_MPISBAIJ_Elemental">MatConvert_MPISBAIJ_Elemental in src/mat/impls/elemental/matelem.cxx</A><BR>
<A HREF="../../../src/mat/impls/hypre/mhypre.c.html#MatConvert_HYPRE_IS">MatConvert_HYPRE_IS in src/mat/impls/hypre/mhypre.c</A><BR>
<A HREF="../../../src/mat/impls/hypre/mhypre.c.html#MatConvert_AIJ_HYPRE">MatConvert_AIJ_HYPRE in src/mat/impls/hypre/mhypre.c</A><BR>
<A HREF="../../../src/mat/impls/hypre/mhypre.c.html#MatConvert_HYPRE_AIJ">MatConvert_HYPRE_AIJ in src/mat/impls/hypre/mhypre.c</A><BR>
<A HREF="../../../src/mat/impls/is/matis.c.html#MatConvert_SeqXAIJ_IS">MatConvert_SeqXAIJ_IS in src/mat/impls/is/matis.c</A><BR>
<A HREF="../../../src/mat/impls/is/matis.c.html#MatConvert_XAIJ_IS">MatConvert_XAIJ_IS in src/mat/impls/is/matis.c</A><BR>
<A HREF="../../../src/mat/impls/is/matis.c.html#MatConvert_Nest_IS">MatConvert_Nest_IS in src/mat/impls/is/matis.c</A><BR>
<A HREF="../../../src/mat/impls/is/matis.c.html#MatConvert_IS_XAIJ">MatConvert_IS_XAIJ in src/mat/impls/is/matis.c</A><BR>
<A HREF="../../../src/mat/impls/maij/maij.c.html#MatConvert_SeqMAIJ_SeqAIJ">MatConvert_SeqMAIJ_SeqAIJ in src/mat/impls/maij/maij.c</A><BR>
<A HREF="../../../src/mat/impls/maij/maij.c.html#MatConvert_MPIMAIJ_MPIAIJ">MatConvert_MPIMAIJ_MPIAIJ in src/mat/impls/maij/maij.c</A><BR>
<A HREF="../../../src/mat/impls/nest/matnest.c.html#MatConvert_Nest_SeqAIJ_fast">MatConvert_Nest_SeqAIJ_fast in src/mat/impls/nest/matnest.c</A><BR>
<A HREF="../../../src/mat/impls/nest/matnest.c.html#MatConvert_Nest_AIJ">MatConvert_Nest_AIJ in src/mat/impls/nest/matnest.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/mpi/mpiaijsbaij.c.html#MatConvert_MPIAIJ_MPISBAIJ">MatConvert_MPIAIJ_MPISBAIJ in src/mat/impls/sbaij/mpi/mpiaijsbaij.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/mpi/mpiaijsbaij.c.html#MatConvert_MPIBAIJ_MPISBAIJ">MatConvert_MPIBAIJ_MPISBAIJ in src/mat/impls/sbaij/mpi/mpiaijsbaij.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/mpi/mpisbaij.c.html#MatConvert_MPISBAIJ_Basic">MatConvert_MPISBAIJ_Basic in src/mat/impls/sbaij/mpi/mpisbaij.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/seq/aijsbaij.c.html#MatConvert_SeqSBAIJ_SeqAIJ">MatConvert_SeqSBAIJ_SeqAIJ in src/mat/impls/sbaij/seq/aijsbaij.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/seq/aijsbaij.c.html#MatConvert_SeqAIJ_SeqSBAIJ">MatConvert_SeqAIJ_SeqSBAIJ in src/mat/impls/sbaij/seq/aijsbaij.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/seq/aijsbaij.c.html#MatConvert_SeqSBAIJ_SeqBAIJ">MatConvert_SeqSBAIJ_SeqBAIJ in src/mat/impls/sbaij/seq/aijsbaij.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/seq/aijsbaij.c.html#MatConvert_SeqBAIJ_SeqSBAIJ">MatConvert_SeqBAIJ_SeqSBAIJ in src/mat/impls/sbaij/seq/aijsbaij.c</A><BR>
<A HREF="../../../src/mat/impls/scalapack/matscalapack.c.html#MatConvert_ScaLAPACK_Dense">MatConvert_ScaLAPACK_Dense in src/mat/impls/scalapack/matscalapack.c</A><BR>
<A HREF="../../../src/mat/impls/scalapack/matscalapack.c.html#MatConvert_Dense_ScaLAPACK">MatConvert_Dense_ScaLAPACK in src/mat/impls/scalapack/matscalapack.c</A><BR>
<A HREF="../../../src/mat/impls/scalapack/matscalapack.c.html#MatConvert_AIJ_ScaLAPACK">MatConvert_AIJ_ScaLAPACK in src/mat/impls/scalapack/matscalapack.c</A><BR>
<A HREF="../../../src/mat/impls/scalapack/matscalapack.c.html#MatConvert_SBAIJ_ScaLAPACK">MatConvert_SBAIJ_ScaLAPACK in src/mat/impls/scalapack/matscalapack.c</A><BR>
<A HREF="../../../src/mat/impls/sell/mpi/mpisell.c.html#MatConvert_MPISELL_MPIAIJ">MatConvert_MPISELL_MPIAIJ in src/mat/impls/sell/mpi/mpisell.c</A><BR>
<A HREF="../../../src/mat/impls/sell/mpi/mpisell.c.html#MatConvert_MPIAIJ_MPISELL">MatConvert_MPIAIJ_MPISELL in src/mat/impls/sell/mpi/mpisell.c</A><BR>
<A HREF="../../../src/mat/impls/sell/seq/sell.c.html#MatConvert_SeqSELL_SeqAIJ">MatConvert_SeqSELL_SeqAIJ in src/mat/impls/sell/seq/sell.c</A><BR>
<A HREF="../../../src/mat/impls/sell/seq/sell.c.html#MatConvert_SeqAIJ_SeqSELL">MatConvert_SeqAIJ_SeqSELL in src/mat/impls/sell/seq/sell.c</A><BR>
<A HREF="../../../src/mat/impls/shell/shellcnv.c.html#MatConvert_Shell">MatConvert_Shell in src/mat/impls/shell/shellcnv.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>