petsc/include/petscmat.h

*052efed2SBarry Smith/* $Id: mat.h,v 1.86 1996/01/02 18:41:38 bsmith Exp bsmith $ */
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 Smith
4ac9ca07SLois Curfman McInnestypedef enum { MATSAME=-1, MATSEQDENSE, MATSEQAIJ, MATMPIAIJ, MATSHELL,
4ac9ca07SLois Curfman McInnes               MATSEQROW, MATMPIROW, MATMPIROWBS, MATSEQBDIAG, MATMPIBDIAG,
4ac9ca07SLois Curfman McInnes               MATMPIDENSE } MatType;
28988994SBarry Smith
0e998a85SBarry Smithextern int MatCreate(MPI_Comm,int,int,Mat*);
df6e0191SLois Curfman McInnesextern int MatCreateSeqDense(MPI_Comm,int,int,Scalar*,Mat*);
d5bc1036SLois Curfman McInnesextern int MatCreateMPIDense(MPI_Comm,int,int,int,int,Scalar*,Mat*);
de7da479SBarry Smithextern int MatCreateSeqAIJ(MPI_Comm,int,int,int,int*,Mat*);
9717bf64SBarry Smithextern int MatCreateMPIAIJ(MPI_Comm,int,int,int,int,int,int*,int,int*,Mat*);
de7da479SBarry Smithextern int MatCreateSeqRow(MPI_Comm,int,int,int,int*,Mat*);
d7692543SLois Curfman McInnesextern int MatCreateMPIRow(MPI_Comm,int,int,int,int,int,int*,int,int*,Mat*);
cfe223acSLois Curfman McInnesextern int MatCreateMPIRowbs(MPI_Comm,int,int,int,int*,void*,Mat*);
f26ada1bSBarry Smithextern int MatCreateSeqBDiag(MPI_Comm,int,int,int,int,int*,Scalar**,Mat*);
f26ada1bSBarry Smithextern int MatCreateMPIBDiag(MPI_Comm,int,int,int,int,int,int*,Scalar**,Mat*);
9717bf64SBarry Smith
7b80b807SBarry Smithextern int MatDestroy(Mat);
7b80b807SBarry Smith
*052efed2SBarry Smithextern int MatCreateShell(MPI_Comm,int,int,void *,Mat*);
17116c71SBarry Smithextern int MatShellGetContext(Mat,void **);
aabeff55SBarry Smithextern int MatShellSetMult(Mat,int (*)(void*,Vec,Vec));
b9fa9cd0SBarry Smithextern int MatShellSetDestroy(Mat,int (*)(void*));
aabeff55SBarry Smithextern int MatShellSetMultTrans(Mat,int (*)(void*,Vec,Vec));
f0479e8cSBarry Smithextern int MatShellSetMultTransAdd(Mat,int (*)(void*,Vec,Vec,Vec));
2eac72dbSBarry Smith
ec0117caSBarry Smithextern int MatPrintHelp(Mat);
ec0117caSBarry Smith
8ed539a5SBarry Smith/* ------------------------------------------------------------*/
ee50ffe9SBarry Smithextern int MatSetValues(Mat,int,int*,int,int*,Scalar*,InsertMode);
7b80b807SBarry Smithtypedef enum {FLUSH_ASSEMBLY=1,FINAL_ASSEMBLY=0} MatAssemblyType;
ee50ffe9SBarry Smithextern int MatAssemblyBegin(Mat,MatAssemblyType);
ee50ffe9SBarry Smithextern int MatAssemblyEnd(Mat,MatAssemblyType);
ee50ffe9SBarry Smith
ee50ffe9SBarry Smithtypedef enum {ROW_ORIENTED=1,COLUMN_ORIENTED=2,ROWS_SORTED=4,
ee50ffe9SBarry Smith              COLUMNS_SORTED=8,NO_NEW_NONZERO_LOCATIONS=16,
02834360SBarry Smith              YES_NEW_NONZERO_LOCATIONS=32,SYMMETRIC_MATRIX=64,
c0bbcb79SLois Curfman McInnes              STRUCTURALLY_SYMMETRIC_MATRIX,NO_NEW_DIAGONALS,
429c0c78SLois Curfman McInnes              YES_NEW_DIAGONALS,INODE_LIMIT_1,INODE_LIMIT_2,
429c0c78SLois Curfman McInnes              INODE_LIMIT_3,INODE_LIMIT_4,INODE_LIMIT_5} MatOption;
ee50ffe9SBarry Smithextern int MatSetOption(Mat,MatOption);
4b0e389bSBarry Smithextern int MatGetType(Mat,MatType*,char**);
e3726954SLois Curfman McInnesextern int MatGetFormatFromOptions(MPI_Comm,char*,MatType*,int*);
ee50ffe9SBarry Smithextern int MatGetValues(Mat,int,int*,int,int*,Scalar*);
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 **);
7b80b807SBarry 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
7b80b807SBarry Smithextern int MatConvert(Mat,MatType,Mat*);
7b80b807SBarry Smithextern int MatCopy(Mat,Mat);
7b80b807SBarry Smithextern int MatView(Mat,Viewer);
7b80b807SBarry Smithextern int MatLoad(Viewer,MatType,Mat*);
7b80b807SBarry Smith
7b80b807SBarry Smithtypedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
7b80b807SBarry Smithextern int MatGetInfo(Mat,MatInfoType,int*,int*,int*);
7b80b807SBarry Smithextern int MatValidMatrix(Mat);
7b80b807SBarry Smithextern int MatGetDiagonal(Mat,Vec);
7b80b807SBarry Smithextern int MatTranspose(Mat,Mat*);
*052efed2SBarry Smithextern int MatDiagonalScale(Mat,Vec,Vec);
7b80b807SBarry Smithextern int MatEqual(Mat,Mat);
7b80b807SBarry Smith
7b80b807SBarry Smithextern int MatNorm(Mat,NormType,double *);
7b80b807SBarry Smithextern int MatZeroEntries(Mat);
7b80b807SBarry Smithextern int MatZeroRows(Mat,IS,Scalar*);
7b80b807SBarry Smithextern int MatZeroColumns(Mat,IS,Scalar*);
7b80b807SBarry Smith
7b80b807SBarry Smithextern int MatGetSize(Mat,int*,int*);
7b80b807SBarry Smithextern int MatGetLocalSize(Mat,int*,int*);
7b80b807SBarry Smithextern int MatGetOwnershipRange(Mat,int*,int*);
7b80b807SBarry Smith
7b80b807SBarry Smithtypedef enum {MAT_INITIAL_MATRIX, MAT_REUSE_MATRIX} MatGetSubMatrixCall;
7b80b807SBarry Smithextern int MatGetSubMatrix(Mat,IS,IS,MatGetSubMatrixCall,Mat*);
7b80b807SBarry Smithextern int MatGetSubMatrixInPlace(Mat,IS,IS);
7b80b807SBarry Smithextern int MatGetSubMatrices(Mat,int,IS *,IS *,MatGetSubMatrixCall,Mat **);
7b80b807SBarry Smithextern int MatIncreaseOverlap(Mat,int,IS *,int);
7b80b807SBarry Smith
7b80b807SBarry Smithextern int MatAXPY(Scalar *,Mat,Mat);
7b80b807SBarry Smithextern int MatCompress(Mat);
7b80b807SBarry Smith
*052efed2SBarry Smithextern int MatScale(Scalar *,Mat);
*052efed2SBarry Smithextern int MatShift(Scalar *,Mat);
*052efed2SBarry Smith
7b80b807SBarry Smith/* Routines unique to particular data structures */
7b80b807SBarry Smithextern int MatBDiagGetData(Mat,int*,int*,int**,int**,Scalar***);
7b80b807SBarry Smith
7b80b807SBarry Smith/*
7b80b807SBarry Smith  These routines are not usually accessed directly, rather solving is
7b80b807SBarry Smith  done through the SLES, KSP and PC interfaces.
7b80b807SBarry Smith*/
7b80b807SBarry Smith
83f0b094SBarry Smithtypedef enum {ORDER_NATURAL=0,ORDER_ND=1,ORDER_1WD=2,
464493b3SBarry Smith              ORDER_RCM=3,ORDER_QMD=4,ORDER_APPLICATION_1,
464493b3SBarry Smith              ORDER_APPLICATION_2} MatOrdering;
ee50ffe9SBarry Smithextern int MatGetReordering(Mat,MatOrdering,IS*,IS*);
d7b056bfSBarry Smithextern int MatGetReorderingTypeFromOptions(char *,MatOrdering*);
832a8ecbSBarry Smithextern int MatReorderForNonzeroDiagonal(Mat,double,IS,IS);
f26ada1bSBarry Smithextern int MatReorderingRegister(MatOrdering,char*,int (*)(int*,int*,int*,int*,int*));
464493b3SBarry Smithextern int MatReorderingRegisterAll();
464493b3SBarry Smithextern int MatReorderingRegisterDestroy();
2eac72dbSBarry Smith
49d8b64dSBarry Smithextern int MatLUFactor(Mat,IS,IS,double);
d7b056bfSBarry Smithextern int MatILUFactor(Mat,IS,IS,double,int);
49d8b64dSBarry Smithextern int MatCholeskyFactor(Mat,IS,double);
64051cb3SBarry Smithextern int MatLUFactorSymbolic(Mat,IS,IS,double,Mat*);
64051cb3SBarry Smithextern int MatILUFactorSymbolic(Mat,IS,IS,double,int,Mat*);
64051cb3SBarry Smithextern int MatCholeskyFactorSymbolic(Mat,IS,double,Mat*);
64051cb3SBarry Smithextern int MatIncompleteCholeskyFactorSymbolic(Mat,IS,double,int,Mat*);
20563c6bSBarry Smithextern int MatLUFactorNumeric(Mat,Mat*);
20563c6bSBarry Smithextern int MatCholeskyFactorNumeric(Mat,Mat*);
8ed539a5SBarry Smith
8ed539a5SBarry Smithextern int MatSolve(Mat,Vec,Vec);
22169318SLois Curfman McInnesextern int MatForwardSolve(Mat,Vec,Vec);
22169318SLois Curfman McInnesextern int MatBackwardSolve(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
ee50ffe9SBarry Smithtypedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
ee50ffe9SBarry Smith              SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
ee50ffe9SBarry Smith              SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
ca9b4cbeSLois Curfman McInnes              SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128
ca9b4cbeSLois Curfman McInnes              } MatSORType;
ca9b4cbeSLois Curfman McInnesextern int MatRelax(Mat,Vec,double,MatSORType,double,int,Vec);
8ed539a5SBarry Smith
037ecd73SBarry Smith/*  Not currently supported!
037ecd73SBarry Smith#define MAT_SCATTER_COOKIE PETSC_COOKIE+15
037ecd73SBarry Smithtypedef struct _MatScatter* MatScatter;
037ecd73SBarry Smith
037ecd73SBarry Smithextern int MatScatterBegin(Mat,Mat,InsertMode,MatScatter);
037ecd73SBarry Smithextern int MatScatterEnd(Mat,Mat,InsertMode,MatScatter);
037ecd73SBarry Smithextern int MatScatterCreate(Mat,IS,IS,Mat,IS,IS,MatScatter*);
037ecd73SBarry Smithextern int MatScatterDestroy(MatScatter);
037ecd73SBarry Smith*/
2eac72dbSBarry Smith
2eac72dbSBarry Smith#endif
2eac72dbSBarry Smith
2eac72dbSBarry Smith
9d00d63dSBarry Smith