petsc/include/petscmat.h

2eac72dbSBarry Smith/*
2eac72dbSBarry Smith     Include file for the matrix component of PETSc
2eac72dbSBarry Smith*/
8ed539a5SBarry Smith#ifndef __MAT
8ed539a5SBarry Smith#define __MAT
8ed539a5SBarry Smith#include "vec.h"
2eac72dbSBarry Smith
2eac72dbSBarry Smithtypedef struct _Mat*           Mat;
2eac72dbSBarry Smithtypedef struct _MatScatterCtx* MatScatterCtx;
2eac72dbSBarry Smith
2eac72dbSBarry Smith
8ed539a5SBarry Smithextern int MatCreateSequentialDense(int,int,Mat*);
aabeff55SBarry Smithextern int MatCreateSequentialAIJ(int,int,int,int *,Mat*);
aabeff55SBarry Smith
*9717bf64SBarry Smith#if defined(USING_MPI)
*9717bf64SBarry Smithextern int MatCreateMPIAIJ(MPI_Comm,int,int,int,int,int,int*,int,int*,Mat*);
*9717bf64SBarry Smith#endif
*9717bf64SBarry Smith
aabeff55SBarry Smithextern int MatShellCreate(int,int,void *,Mat*);
aabeff55SBarry Smithextern int MatShellSetMult(Mat,int (*)(void*,Vec,Vec));
aabeff55SBarry Smithextern int MatShellSetMultTrans(Mat,int (*)(void*,Vec,Vec));
aabeff55SBarry Smith
2eac72dbSBarry Smith
8ed539a5SBarry Smith/* ------------------------------------------------------------*/
8ed539a5SBarry Smithextern int  MatValidMatrix(Mat);
2eac72dbSBarry Smith
8ed539a5SBarry Smithextern int MatInsertValues(Mat,Scalar*,int,int*,int,int*);
8ed539a5SBarry Smithextern int MatAddValues(Mat,Scalar*,int,int*,int,int*);
8ed539a5SBarry Smithextern int MatBeginAssembly(Mat);
8ed539a5SBarry Smithextern int MatEndAssembly(Mat);
8ed539a5SBarry Smithextern int MatSetInsertOption(Mat,int);
8ed539a5SBarry Smith#define ROW_ORIENTED              1
8ed539a5SBarry Smith#define COLUMN_ORIENTED           2
8ed539a5SBarry Smith#define ROWS_SORTED               3
8ed539a5SBarry Smith#define COLUMNS_SORTED            4
8ed539a5SBarry Smith#define NO_NEW_NONZERO_LOCATIONS  5
8ed539a5SBarry Smith#define YES_NEW_NONZERO_LOCATIONS 6
2eac72dbSBarry Smith
8ed539a5SBarry Smithextern int MatGetValues(Mat,Scalar*,int,int*,int,int*);
8ed539a5SBarry Smithextern int MatGetRow(Mat,int,int *,int **,Scalar**);
8ed539a5SBarry Smithextern int MatRestoreRow(Mat,int,int *,int **,Scalar**);
8ed539a5SBarry Smithextern int MatGetCol(Mat,int,int *,int **,Scalar**);
8ed539a5SBarry Smithextern int MatRestoreCol(Mat,int,int *,int **,Scalar**);
2eac72dbSBarry Smith
8ed539a5SBarry Smithextern int MatMult(Mat,Vec,Vec);
8ed539a5SBarry Smithextern int MatMultAdd(Mat,Vec,Vec,Vec);
8ed539a5SBarry Smithextern int MatMultTrans(Mat,Vec,Vec);
8ed539a5SBarry Smithextern int MatMultTransAdd(Mat,Vec,Vec,Vec);
2eac72dbSBarry Smith
8ed539a5SBarry Smith#define ORDER_NATURAL 0
8ed539a5SBarry Smith#define ORDER_ND      1
8ed539a5SBarry Smith#define ORDER_1WD     2
8ed539a5SBarry Smith#define ORDER_RCM     3
8ed539a5SBarry Smith#define ORDER_QMD     4
8ed539a5SBarry Smithextern int MatGetReordering(Mat,int,IS*,IS*);
2eac72dbSBarry Smith
8ed539a5SBarry Smithextern int MatLUFactor(Mat,IS,IS);
8ed539a5SBarry Smithextern int MatCholeskyFactor(Mat,IS);
8ed539a5SBarry Smithextern int MatLUFactorSymbolic(Mat,IS,IS,Mat*);
8ed539a5SBarry Smithextern int MatCholeskyFactorSymbolic(Mat,IS,Mat*);
8ed539a5SBarry Smithextern int MatLUFactorNumeric(Mat,Mat);
8ed539a5SBarry Smithextern int MatCholeskyFactorNumeric(Mat,Mat);
8ed539a5SBarry Smith
8ed539a5SBarry Smithextern int MatSolve(Mat,Vec,Vec);
8ed539a5SBarry Smithextern int MatSolveAdd(Mat,Vec,Vec,Vec);
8ed539a5SBarry Smithextern int MatSolveTran(Mat,Vec,Vec);
8ed539a5SBarry Smithextern int MatSolveTranAdd(Mat,Vec,Vec,Vec);
8ed539a5SBarry Smith
8ed539a5SBarry Smith#define SOR_FORWARD_SWEEP      1
8ed539a5SBarry Smith#define SOR_BACKWARD_SWEEP     2
8ed539a5SBarry Smith#define SOR_SYMMETRIC_SWEEP    3
8ed539a5SBarry Smith#define SOR_ZERO_INITIAL_GUESS 4
8ed539a5SBarry Smithextern int MatRelax(Mat,Vec,double,int,IS,int,Vec);
8ed539a5SBarry Smith
8ed539a5SBarry Smithextern int MatCopy(Mat,Mat*);
8ed539a5SBarry Smithextern int MatView(Mat,Viewer);
8ed539a5SBarry Smith#include <stdio.h>
8ed539a5SBarry Smithextern int MatPrintMatlab(Mat,FILE*,char *);
8ed539a5SBarry Smithextern int  MatNonZeros(Mat,int*);
8ed539a5SBarry Smithextern int  MatMemoryUsed(Mat,int*);
8ed539a5SBarry Smithextern int MatGetDiagonal(Mat,Vec);
8ed539a5SBarry Smithextern int MatTranspose(Mat);
8ed539a5SBarry Smithextern int MatScale(Mat,Vec,Vec);
8ed539a5SBarry Smithextern int MatShrink(Mat,int,int*,int,int*);
8ed539a5SBarry Smithextern int  MatEqual(Mat,Mat);
aabeff55SBarry Smithextern int  MatScatterBegin(Mat,IS,IS,Mat,IS,IS,MatScatterCtx*);
aabeff55SBarry Smithextern int  MatScatterEnd(Mat,IS,IS,Mat,IS,IS,MatScatterCtx*);
aabeff55SBarry Smithextern int  MatScatterAddBegin(Mat,IS,IS,Mat,IS,IS,MatScatterCtx*);
aabeff55SBarry Smithextern int  MatScatterAddEnd(Mat,IS,IS,Mat,IS,IS,MatScatterCtx*);
8ed539a5SBarry Smithextern int MatReOrder(Mat,IS,IS);
2eac72dbSBarry Smith
2eac72dbSBarry Smith#define NORM_1         1
2eac72dbSBarry Smith#define NORM_2         2
2eac72dbSBarry Smith#define NORM_FROBENIUS 3
2eac72dbSBarry Smith#define NORM_INFINITY  4
8ed539a5SBarry Smithextern int MatNorm(Mat,int,double *);
2eac72dbSBarry Smith
8ed539a5SBarry Smithextern int MatZeroEntries(Mat);
8ed539a5SBarry Smithextern int MatZeroRows(Mat);
8ed539a5SBarry Smith
8ed539a5SBarry Smithextern int MatCompress(Mat);
8ed539a5SBarry Smithextern int MatDestroy(Mat);
8ed539a5SBarry Smith
8ed539a5SBarry Smithextern int MatCreateInitialMatrix(int,int,Mat*);
8ed539a5SBarry Smith
8ed539a5SBarry Smith
8ed539a5SBarry Smith
2eac72dbSBarry Smith#endif
2eac72dbSBarry Smith
2eac72dbSBarry Smith