petsc-3.5.4 2015-05-23
Report Typos and Errors


Loads a matrix that has been stored in binary format with MatView(). The matrix format is determined from the options database. Generates a parallel MPI matrix if the communicator has more than one processor. The default matrix type is AIJ.


#include "petscmat.h" 
PetscErrorCode  MatLoad(Mat newmat,PetscViewer viewer)
Collective on PetscViewer

Input Parameters

newmat - the newly loaded matrix, this needs to have been created with MatCreate() or some related function before a call to MatLoad()
viewer - binary file viewer, created with PetscViewerBinaryOpen()

Options Database Keys

Used with block matrix formats (MATSEQBAIJ, ...) to specify block size
-matload_block_size <bs> -


If the Mat type has not yet been given then MATAIJ is used, call MatSetFromOptions() on the Mat before calling this routine if you wish to set it from the options database.

MatLoad() automatically loads into the options database any options given in the file where filename is the name of the file that was passed to the PetscViewerBinaryOpen(). The options in the info file will be ignored if you use the -viewer_binary_skip_info option.

If the type or size of newmat is not set before a call to MatLoad, PETSc sets the default matrix type AIJ and sets the local and global sizes. If type and/or size is already set, then the same are used.

In parallel, each processor can load a subset of rows (or the entire matrix). This routine is especially useful when a large matrix is stored on disk and only part of it is desired on each processor. For example, a parallel solver may access only some of the rows from each processor. The algorithm used here reads relatively small blocks of data rather than reading the entire matrix and then subsetting it.

Notes for advanced users

Most users should not need to know the details of the binary storage format, since MatLoad() and MatView() completely hide these details. But for anyone who's interested, the standard binary matrix storage format is

   int    number of rows
   int    number of columns
   int    total number of nonzeros
   int    *number nonzeros in each row
   int    *column indices of all nonzeros (starting index is zero)
   PetscScalar *values of all nonzeros

PETSc automatically does the byte swapping for machines that store the bytes reversed, e.g. DEC alpha, freebsd, linux, Windows and the paragon; thus if you write your own binary read/write routines you have to swap the bytes; see PetscBinaryRead() and PetscBinaryWrite() to see how this may be done.


matrix, load, binary, input

See Also

PetscViewerBinaryOpen(), MatView(), VecLoad()

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