petsc-3.14.6 2021-03-30

MatNullSpaceCreate

Creates a data structure used to project vectors out of null spaces.

Synopsis

#include "petscmat.h" 
PetscErrorCode  MatNullSpaceCreate(MPI_Comm comm,PetscBool has_cnst,PetscInt n,const Vec vecs[],MatNullSpace *SP)

Collective

Input Parameters

	comm	- the MPI communicator associated with the object
	has_cnst	- PETSC_TRUE if the null space contains the constant vector; otherwise PETSC_FALSE
	n	- number of vectors (excluding constant vector) in null space
	vecs	- the vectors that span the null space (excluding the constant vector); these vectors must be orthonormal. These vectors are NOT copied, so do not change them after this call. You should free the array that you pass in and destroy the vectors (this will reduce the reference count for them by one).

Output Parameter

- the null space context

Notes

See MatNullSpaceSetFunction() as an alternative way of providing the null space information instead of setting vecs.

If has_cnst is PETSC_TRUE you do not need to pass a constant vector in as a fourth argument to this routine, nor do you need to pass in a function that eliminates the constant function into MatNullSpaceSetFunction().

Users manual sections

sec_singular

Level

advanced

Location

src/mat/interface/matnull.c

Examples

src/dm/impls/stag/tutorials/ex2.c.html
src/dm/impls/stag/tutorials/ex3.c.html
src/ksp/ksp/tutorials/ex29.c.html
src/ksp/ksp/tutorials/ex32.c.html
src/ksp/ksp/tutorials/ex34.c.html
src/ksp/ksp/tutorials/ex49.c.html
src/ksp/ksp/tutorials/ex50.c.html
src/ksp/ksp/tutorials/ex59.c.html
src/ksp/ksp/tutorials/ex66.c.html
src/ksp/ksp/tutorials/ex67.c.html
src/ksp/ksp/tutorials/ex71.c.html

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