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
|
<!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/MatDuplicate.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatDuplicate</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/MatDuplicate.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatDuplicate"><H1>MatDuplicate</H1></A>
Duplicates a matrix including the non-zero structure.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscmat.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Mat/MatDuplicate.html#MatDuplicate">MatDuplicate</A>(<A HREF="../Mat/Mat.html#Mat">Mat</A> mat,<A HREF="../Mat/MatDuplicateOption.html#MatDuplicateOption">MatDuplicateOption</A> op,<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>op </B></TD><TD>- One of <A HREF="../Mat/MatDuplicateOption.html#MatDuplicateOption">MAT_DO_NOT_COPY_VALUES</A>, <A HREF="../Mat/MatDuplicateOption.html#MatDuplicateOption">MAT_COPY_VALUES</A>, or <A HREF="../Mat/MatDuplicateOption.html#MatDuplicateOption">MAT_SHARE_NONZERO_PATTERN</A>.
See the manual page for <A HREF="../Mat/MatDuplicateOption.html#MatDuplicateOption">MatDuplicateOption</A> for an explanation of these options.
</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>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
You cannot change the nonzero pattern for the parent or child matrix if you use <A HREF="../Mat/MatDuplicateOption.html#MatDuplicateOption">MAT_SHARE_NONZERO_PATTERN</A>.
When original mat is a product of matrix operation, e.g., an output of <A HREF="../Mat/MatMatMult.html#MatMatMult">MatMatMult</A>() or <A HREF="../Mat/MatCreateSubMatrix.html#MatCreateSubMatrix">MatCreateSubMatrix</A>(), only the simple matrix data structure of mat is duplicated and the internal data structures created for the reuse of previous matrix operations are not duplicated. User should not use <A HREF="../Mat/MatDuplicate.html#MatDuplicate">MatDuplicate</A>() to create new matrix M if M is intended to be reused as the product of matrix operation.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Mat/MatCopy.html#MatCopy">MatCopy</A>(), <A HREF="../Mat/MatConvert.html#MatConvert">MatConvert</A>(), <A HREF="../Mat/MatDuplicateOption.html#MatDuplicateOption">MatDuplicateOption</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#MatDuplicate">src/mat/interface/matrix.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/ksp/ksp/tutorials/ex5.c.html">src/ksp/ksp/tutorials/ex5.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex42.c.html">src/ksp/ksp/tutorials/ex42.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/ex5f.F90.html">src/ksp/ksp/tutorials/ex5f.F90.html</A><BR>
<A HREF="../../../src/ts/tutorials/ex3.c.html">src/ts/tutorials/ex3.c.html</A><BR>
<A HREF="../../../src/ts/tutorials/ex50.c.html">src/ts/tutorials/ex50.c.html</A><BR>
<A HREF="../../../src/tao/unconstrained/tutorials/spectraladjointassimilation.c.html">src/tao/unconstrained/tutorials/spectraladjointassimilation.c.html</A><BR>
<A HREF="../../../src/tao/pde_constrained/tutorials/elliptic.c.html">src/tao/pde_constrained/tutorials/elliptic.c.html</A><BR>
<A HREF="../../../src/tao/pde_constrained/tutorials/parabolic.c.html">src/tao/pde_constrained/tutorials/parabolic.c.html</A><BR>
<A HREF="../../../src/tao/pde_constrained/tutorials/hyperbolic.c.html">src/tao/pde_constrained/tutorials/hyperbolic.c.html</A><BR>
<A HREF="../../../src/tao/tutorials/ex4.c.html">src/tao/tutorials/ex4.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/mat/impls/aij/mpi/mpiaij.c.html#MatDuplicate_MPIAIJ">MatDuplicate_MPIAIJ in src/mat/impls/aij/mpi/mpiaij.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aij.c.html#MatDuplicate_SeqAIJ">MatDuplicate_SeqAIJ in src/mat/impls/aij/seq/aij.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aijmkl/aijmkl.c.html#MatDuplicate_SeqAIJMKL">MatDuplicate_SeqAIJMKL in src/mat/impls/aij/seq/aijmkl/aijmkl.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aijperm/aijperm.c.html#MatDuplicate_SeqAIJPERM">MatDuplicate_SeqAIJPERM in src/mat/impls/aij/seq/aijperm/aijperm.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/aijsell/aijsell.c.html#MatDuplicate_SeqAIJSELL">MatDuplicate_SeqAIJSELL in src/mat/impls/aij/seq/aijsell/aijsell.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/crl/crl.c.html#MatDuplicate_AIJCRL">MatDuplicate_AIJCRL in src/mat/impls/aij/seq/crl/crl.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/inode.c.html#MatDuplicate_SeqAIJ_Inode">MatDuplicate_SeqAIJ_Inode in src/mat/impls/aij/seq/inode.c</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/kokkos/aijkok.kokkos.cxx.html#MatDuplicate_SeqAIJKokkos">MatDuplicate_SeqAIJKokkos in src/mat/impls/aij/seq/kokkos/aijkok.kokkos.cxx</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/seqcusparse/aijcusparse.cu.html#MatDuplicate_SeqAIJCUSPARSE">MatDuplicate_SeqAIJCUSPARSE in src/mat/impls/aij/seq/seqcusparse/aijcusparse.cu</A><BR>
<A HREF="../../../src/mat/impls/aij/seq/seqviennacl/aijviennacl.cxx.html#MatDuplicate_SeqAIJViennaCL">MatDuplicate_SeqAIJViennaCL in src/mat/impls/aij/seq/seqviennacl/aijviennacl.cxx</A><BR>
<A HREF="../../../src/mat/impls/baij/mpi/mpibaij.c.html#MatDuplicate_MPIBAIJ">MatDuplicate_MPIBAIJ in src/mat/impls/baij/mpi/mpibaij.c</A><BR>
<A HREF="../../../src/mat/impls/baij/seq/baij.c.html#MatDuplicate_SeqBAIJ">MatDuplicate_SeqBAIJ in src/mat/impls/baij/seq/baij.c</A><BR>
<A HREF="../../../src/mat/impls/baij/seq/baijmkl/baijmkl.c.html#MatDuplicate_SeqBAIJMKL">MatDuplicate_SeqBAIJMKL in src/mat/impls/baij/seq/baijmkl/baijmkl.c</A><BR>
<A HREF="../../../src/mat/impls/cdiagonal/cdiagonal.c.html#MatDuplicate_ConstantDiagonal">MatDuplicate_ConstantDiagonal in src/mat/impls/cdiagonal/cdiagonal.c</A><BR>
<A HREF="../../../src/mat/impls/dense/mpi/mpidense.c.html#MatDuplicate_MPIDense">MatDuplicate_MPIDense in src/mat/impls/dense/mpi/mpidense.c</A><BR>
<A HREF="../../../src/mat/impls/dense/seq/cuda/densecuda.cu.html#MatDuplicate_SeqDenseCUDA">MatDuplicate_SeqDenseCUDA in src/mat/impls/dense/seq/cuda/densecuda.cu</A><BR>
<A HREF="../../../src/mat/impls/dense/seq/dense.c.html#MatDuplicate_SeqDense">MatDuplicate_SeqDense in src/mat/impls/dense/seq/dense.c</A><BR>
<A HREF="../../../src/mat/impls/elemental/matelem.cxx.html#MatDuplicate_Elemental">MatDuplicate_Elemental in src/mat/impls/elemental/matelem.cxx</A><BR>
<A HREF="../../../src/mat/impls/hara/mathara.cu.html#MatDuplicate_HARA">MatDuplicate_HARA in src/mat/impls/hara/mathara.cu</A><BR>
<A HREF="../../../src/mat/impls/hypre/mhypre.c.html#MatDuplicate_HYPRE">MatDuplicate_HYPRE in src/mat/impls/hypre/mhypre.c</A><BR>
<A HREF="../../../src/mat/impls/is/matis.c.html#MatDuplicate_IS">MatDuplicate_IS in src/mat/impls/is/matis.c</A><BR>
<A HREF="../../../src/mat/impls/nest/matnest.c.html#MatDuplicate_Nest">MatDuplicate_Nest in src/mat/impls/nest/matnest.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/mpi/mpisbaij.c.html#MatDuplicate_MPISBAIJ">MatDuplicate_MPISBAIJ in src/mat/impls/sbaij/mpi/mpisbaij.c</A><BR>
<A HREF="../../../src/mat/impls/sbaij/seq/sbaij.c.html#MatDuplicate_SeqSBAIJ">MatDuplicate_SeqSBAIJ in src/mat/impls/sbaij/seq/sbaij.c</A><BR>
<A HREF="../../../src/mat/impls/scalapack/matscalapack.c.html#MatDuplicate_ScaLAPACK">MatDuplicate_ScaLAPACK in src/mat/impls/scalapack/matscalapack.c</A><BR>
<A HREF="../../../src/mat/impls/sell/mpi/mpisell.c.html#MatDuplicate_MPISELL">MatDuplicate_MPISELL in src/mat/impls/sell/mpi/mpisell.c</A><BR>
<A HREF="../../../src/mat/impls/sell/seq/sell.c.html#MatDuplicate_SeqSELL">MatDuplicate_SeqSELL in src/mat/impls/sell/seq/sell.c</A><BR>
<A HREF="../../../src/mat/impls/shell/shell.c.html#MatDuplicate_Shell">MatDuplicate_Shell in src/mat/impls/shell/shell.c</A><BR>
<A HREF="../../../src/mat/impls/transpose/htransm.c.html#MatDuplicate_HT">MatDuplicate_HT in src/mat/impls/transpose/htransm.c</A><BR>
<A HREF="../../../src/mat/impls/transpose/transm.c.html#MatDuplicate_Transpose">MatDuplicate_Transpose in src/mat/impls/transpose/transm.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>
|