petsc-3.14.6 2021-03-30

MatSetValues

Inserts or adds a block of values into a matrix. These values may be cached, so MatAssemblyBegin() and MatAssemblyEnd() MUST be called after all calls to MatSetValues() have been completed.

Synopsis

#include "petscmat.h" 
PetscErrorCode MatSetValues(Mat mat,PetscInt m,const PetscInt idxm[],PetscInt n,const PetscInt idxn[],const PetscScalar v[],InsertMode addv)

Not Collective

Input Parameters

	mat	- the matrix
	v	- a logically two-dimensional array of values
	m, idxm	- the number of rows and their global indices
	n, idxn	- the number of columns and their global indices
	addv	- either ADD_VALUES or INSERT_VALUES, where ADD_VALUES adds values to any existing entries, and INSERT_VALUES replaces existing entries with new values

Notes

If you create the matrix yourself (that is not with a call to DMCreateMatrix()) then you MUST call MatXXXXSetPreallocation() or MatSetUp() before using this routine

By default the values, v, are row-oriented. See MatSetOption() for other options.

Calls to MatSetValues() with the INSERT_VALUES and ADD_VALUES options cannot be mixed without intervening calls to the assembly routines.

MatSetValues() uses 0-based row and column numbers in Fortran as well as in C.

Negative indices may be passed in idxm and idxn, these rows and columns are simply ignored. This allows easily inserting element stiffness matrices with homogeneous Dirchlet boundary conditions that you don't want represented in the matrix.

Efficiency Alert

The routine MatSetValuesBlocked() may offer much better efficiency for users of block sparse formats (MATSEQBAIJ and MATMPIBAIJ).

Developer Notes

This is labeled with C so does not automatically generate Fortran stubs and interfaces because it requires multiple Fortran interfaces depending on which arguments are scalar or arrays.

Level

beginner

MatSetValues

Synopsis

Input Parameters

Notes

Efficiency Alert

Developer Notes

See Also

Level

Location

Examples

Implementations