petsc/include/petscmat.h

2eac72dbSBarry Smith/*
2eac72dbSBarry Smith     Include file for the matrix component of PETSc
2eac72dbSBarry Smith*/
1eb62cbbSBarry Smith#ifndef __MAT_PACKAGE
1eb62cbbSBarry Smith#define __MAT_PACKAGE
8ed539a5SBarry Smith#include "vec.h"
2eac72dbSBarry Smith
9cd28387SBarry Smith#define MAT_COOKIE PETSC_COOKIE+5
f0479e8cSBarry Smith
2eac72dbSBarry Smithtypedef struct _Mat*           Mat;
2eac72dbSBarry Smithtypedef struct _MatScatterCtx* MatScatterCtx;
2eac72dbSBarry Smith
*1fb19edaSLois Curfman McInnestypedef enum { MATDENSE, MATAIJ, MATMPIAIJ, MATSHELL, MATROW,
*1fb19edaSLois Curfman McInnes               MATMPIROW } MATTYPE;
28988994SBarry Smith
8ed539a5SBarry Smithextern int MatCreateSequentialDense(int,int,Mat*);
aabeff55SBarry Smithextern int MatCreateSequentialAIJ(int,int,int,int *,Mat*);
9717bf64SBarry Smithextern int MatCreateMPIAIJ(MPI_Comm,int,int,int,int,int,int*,int,int*,Mat*);
d7692543SLois Curfman McInnesextern int MatCreateSequentialRow(int,int,int,int *,Mat*);
d7692543SLois Curfman McInnesextern int MatCreateMPIRow(MPI_Comm,int,int,int,int,int,int*,int,int*,Mat*);
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));
f0479e8cSBarry Smithextern int MatShellSetMultTransAdd(Mat,int (*)(void*,Vec,Vec,Vec));
2eac72dbSBarry Smith
8ed539a5SBarry Smith/* ------------------------------------------------------------*/
8ed539a5SBarry Smithextern int  MatValidMatrix(Mat);
2eac72dbSBarry Smith
20563c6bSBarry Smithextern int MatSetValues(Mat,int,int*,int,int*,Scalar*,InsertMode);
8ed539a5SBarry Smithextern int MatBeginAssembly(Mat);
8ed539a5SBarry Smithextern int MatEndAssembly(Mat);
20563c6bSBarry Smithextern int MatSetOption(Mat,int);
8ed539a5SBarry Smith#define ROW_ORIENTED              1
8ed539a5SBarry Smith#define COLUMN_ORIENTED           2
20563c6bSBarry Smith#define ROWS_SORTED               4
20563c6bSBarry Smith#define COLUMNS_SORTED            8
20563c6bSBarry Smith#define NO_NEW_NONZERO_LOCATIONS  16
20563c6bSBarry Smith#define YES_NEW_NONZERO_LOCATIONS 32
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**);
64e87e97SBarry Smithextern int MatGetArray(Mat,Scalar **);
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*);
da3a660dSBarry Smithextern int MatILUFactorSymbolic(Mat,IS,IS,int,Mat*);
8ed539a5SBarry Smithextern int MatCholeskyFactorSymbolic(Mat,IS,Mat*);
da3a660dSBarry Smithextern int MatIncompleteCholeskyFactorSymbolic(Mat,IS,int,Mat*);
20563c6bSBarry Smithextern int MatLUFactorNumeric(Mat,Mat*);
20563c6bSBarry Smithextern int MatCholeskyFactorNumeric(Mat,Mat*);
8ed539a5SBarry Smith
8ed539a5SBarry Smithextern int MatSolve(Mat,Vec,Vec);
8ed539a5SBarry Smithextern int MatSolveAdd(Mat,Vec,Vec,Vec);
28988994SBarry Smithextern int MatSolveTrans(Mat,Vec,Vec);
28988994SBarry Smithextern int MatSolveTransAdd(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
d6dfbf8fSBarry Smith#define SOR_LOCAL_FORWARD_SWEEP      4
d6dfbf8fSBarry Smith#define SOR_LOCAL_BACKWARD_SWEEP     8
d6dfbf8fSBarry Smith#define SOR_LOCAL_SYMMETRIC_SWEEP    12
d6dfbf8fSBarry Smith#define SOR_ZERO_INITIAL_GUESS       16
da3a660dSBarry Smith#define SOR_EISENSTAT                32
9cd28387SBarry Smith#define SOR_APPLY_UPPER              64
9cd28387SBarry Smith#define SOR_APPLY_LOWER              128
d6dfbf8fSBarry Smithextern int MatRelax(Mat,Vec,double,int,double,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);
20563c6bSBarry Smithextern int MatScatterBegin(Mat,IS,IS,Mat,IS,IS,InsertMode,MatScatterCtx*);
20563c6bSBarry Smithextern int MatScatterEnd(Mat,IS,IS,Mat,IS,IS,InsertMode,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);
20563c6bSBarry Smithextern int MatZeroRows(Mat,IS,Scalar*);
20563c6bSBarry Smithextern int MatZeroColumns(Mat,IS,Scalar*);
8ed539a5SBarry Smith
8ed539a5SBarry Smithextern int MatCompress(Mat);
8ed539a5SBarry Smithextern int MatDestroy(Mat);
8ed539a5SBarry Smith
1eb62cbbSBarry Smithextern int MatGetSize(Mat,int*,int*);
1eb62cbbSBarry Smithextern int MatGetLocalSize(Mat,int*,int*);
d6dfbf8fSBarry Smithextern int MatGetOwnershipRange(Mat,int*,int*);
1eb62cbbSBarry Smith
8ed539a5SBarry Smithextern int MatCreateInitialMatrix(int,int,Mat*);
8ed539a5SBarry Smith
8ed539a5SBarry Smith
8ed539a5SBarry Smith
1eb62cbbSBarry Smith
2eac72dbSBarry Smith#endif
2eac72dbSBarry Smith
2eac72dbSBarry Smith