MatDuplicateOption — PETSc 3.21.4 documentation

Skip to main content
`Ctrl`+`K`

# MatDuplicateOption

Indicates if a duplicated sparse matrix should have its numerical values copied over or just its nonzero structure.

## Synopsis

    typedef enum {
      MAT_DO_NOT_COPY_VALUES,
      MAT_COPY_VALUES,
      MAT_SHARE_NONZERO_PATTERN
    } MatDuplicateOption;

## Values

- `MAT_DO_NOT_COPY_VALUES` - Create a matrix using the same nonzero pattern as the original matrix, with zeros for the numerical values

- `MAT_COPY_VALUES` - Create a matrix with the same nonzero pattern as the original matrix and with the same numerical values.

- `MAT_SHARE_NONZERO_PATTERN` - Create a matrix that shares the nonzero structure with the previous matrix and does not copy it, using zeros for the numerical values. The parent and child matrices will share their index (i and j) arrays, and you cannot insert new nonzero entries into either matrix

## Note

Many matrix types (including `MATSEQAIJ`) do not support the `MAT_SHARE_NONZERO_PATTERN` optimization; in this case the behavior is as if `MAT_DO_NOT_COPY_VALUES` has been specified.

## See Also

Matrices, `Mat`, `MatDuplicate()`

## Level

beginner

## Location

include/petscmat.h

## Examples

src/tao/pde_constrained/tutorials/parabolic.c
src/tao/tutorials/ex4.c
src/tao/pde_constrained/tutorials/hyperbolic.c
src/tao/pde_constrained/tutorials/elliptic.c

## Examples

src/mat/tutorials/ex18.c
src/ksp/ksp/tutorials/ex76.c
src/ts/tutorials/ex20adj.c
src/tao/tutorials/ex4.c
src/ts/tutorials/ex3.c

## Examples

src/tao/pde_constrained/tutorials/parabolic.c
src/mat/tutorials/ex20f.F90
src/tao/pde_constrained/tutorials/hyperbolic.c

## Examples

src/ksp/ksp/tutorials/ex81.c
src/tao/pde_constrained/tutorials/hyperbolic.c
src/ts/tutorials/ex50.c
src/ksp/ksp/tutorials/ex5.c
src/tao/unconstrained/tutorials/spectraladjointassimilation.c
src/tao/unconstrained/tutorials/burgers_spectral.c
src/ksp/ksp/tutorials/ex42.c

Index of all Mat routines
Table of Contents for all manual pages
Index of all manual pages