MatSetFromOptions#

Creates a matrix where the type is determined from the options database.

Synopsis#

#include "petscmat.h"  
PetscErrorCode MatSetFromOptions(Mat B)

Collective

Input Parameter#

B - the matrix

Options Database Keys#

-mat_block_size size - set the block size used to store the matrix; see MatSetBlockSize()
-mat_type type - set the matrix type; see MatType and MatSetType()
-mat_vec_type vtype - set the VecType used by MatCreateVecs(); see MatSetVecType()
-mat_is_symmetric tol - check symmetry during MatAssemblyEnd() with an optional tolerance; see MatIsSymmetric()
-mat_null_space_test (true|false) - test the attached null space during MatAssemblyEnd(); see MatNullSpaceTest()
-mat_error_if_failure (true|false) - generate an error if matrix factorization fails; see MatSetErrorIfFailure()
-mat_spd (true|false) - set the MAT_SPD property with MatSetOption()
-mat_new_nonzero_location_err (true|false) - generate an error if insertion creates a new nonzero location; see MAT_NEW_NONZERO_LOCATION_ERR in MatSetOption()
-mat_new_nonzero_allocation_err (true|false) - generate an error if insertion requires additional nonzero allocation; see MAT_NEW_NONZERO_ALLOCATION_ERR in MatSetOption()
-mat_ignore_zero_entries (true|false) - ignore eligible zero entries during insertion; see MAT_IGNORE_ZERO_ENTRIES in MatSetOption()
-mat_form_explicit_transpose (true|false) - hint to form an explicit transpose for operations such as MatMultTranspose()
-mat_bind_below size - bind the matrix to the CPU if its number of local rows is less than size; see MatBindToCPU()

Notes#

Generates a parallel MPI matrix if the communicator has more than one processor. The default matrix type is MATAIJ, using the routines MatCreateSeqAIJ() and MatCreateAIJ() if you do not select a type in the options database.

See the manpages for particular formats (e.g., MATSEQAIJ) for additional format-specific options.

Level#

beginner

Location#

src/mat/utils/gcreate.c

Examples#

src/mat/tutorials/ex10.c
src/mat/tutorials/ex15.c
src/mat/tutorials/ex15f.F90
src/mat/tutorials/ex16.c
src/mat/tutorials/ex17.c
src/mat/tutorials/ex17f.F90
src/mat/tutorials/ex18.c
src/mat/tutorials/ex19.c
src/mat/tutorials/ex4.c
src/mat/tutorials/ex4f.F90

Implementations#

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