12eac72dbSBarry Smith /* 22eac72dbSBarry Smith Include file for the matrix component of PETSc 32eac72dbSBarry Smith */ 40a835dfdSSatish Balay #ifndef __PETSCMAT_H 50a835dfdSSatish Balay #define __PETSCMAT_H 60a835dfdSSatish Balay #include "petscvec.h" 7e9fa29b7SSatish Balay PETSC_EXTERN_CXX_BEGIN 82eac72dbSBarry Smith 9d9274352SBarry Smith /*S 10d9274352SBarry Smith Mat - Abstract PETSc matrix object 112eac72dbSBarry Smith 12d91e6319SBarry Smith Level: beginner 13d91e6319SBarry Smith 14d9274352SBarry Smith Concepts: matrix; linear operator 15d9274352SBarry Smith 16d9274352SBarry Smith .seealso: MatCreate(), MatType, MatSetType() 17d9274352SBarry Smith S*/ 18d9274352SBarry Smith typedef struct _p_Mat* Mat; 19d9274352SBarry Smith 20d9274352SBarry Smith /*E 21d9274352SBarry Smith MatType - String with the name of a PETSc matrix or the creation function 22d9274352SBarry Smith with an optional dynamic library name, for example 23d9274352SBarry Smith http://www.mcs.anl.gov/petsc/lib.a:mymatcreate() 24d9274352SBarry Smith 25d9274352SBarry Smith Level: beginner 26d9274352SBarry Smith 27d9274352SBarry Smith .seealso: MatSetType(), Mat 28d91e6319SBarry Smith E*/ 29e5a9bf91SBarry Smith #define MatType const char* 30273d9f13SBarry Smith #define MATSAME "same" 31273d9f13SBarry Smith #define MATSEQMAIJ "seqmaij" 32273d9f13SBarry Smith #define MATMPIMAIJ "mpimaij" 33209238afSKris Buschelman #define MATMAIJ "maij" 34273d9f13SBarry Smith #define MATIS "is" 35273d9f13SBarry Smith #define MATMPIROWBS "mpirowbs" 36273d9f13SBarry Smith #define MATSEQAIJ "seqaij" 37273d9f13SBarry Smith #define MATMPIAIJ "mpiaij" 38209238afSKris Buschelman #define MATAIJ "aij" 39273d9f13SBarry Smith #define MATSHELL "shell" 40273d9f13SBarry Smith #define MATSEQBDIAG "seqbdiag" 41273d9f13SBarry Smith #define MATMPIBDIAG "mpibdiag" 42209238afSKris Buschelman #define MATBDIAG "bdiag" 43209238afSKris Buschelman #define MATSEQDENSE "seqdense" 44273d9f13SBarry Smith #define MATMPIDENSE "mpidense" 45209238afSKris Buschelman #define MATDENSE "dense" 46273d9f13SBarry Smith #define MATSEQBAIJ "seqbaij" 47273d9f13SBarry Smith #define MATMPIBAIJ "mpibaij" 48209238afSKris Buschelman #define MATBAIJ "baij" 49273d9f13SBarry Smith #define MATMPIADJ "mpiadj" 50273d9f13SBarry Smith #define MATSEQSBAIJ "seqsbaij" 51273d9f13SBarry Smith #define MATMPISBAIJ "mpisbaij" 52209238afSKris Buschelman #define MATSBAIJ "sbaij" 53cebc7f6cSBarry Smith #define MATDAAD "daad" 54cebc7f6cSBarry Smith #define MATMFFD "mffd" 55c8a8475eSBarry Smith #define MATNORMAL "normal" 56ab92ecdeSBarry Smith #define MATLRC "lrc" 57b3a1e11cSKris Buschelman #define MATSEQAIJSPOOLES "seqaijspooles" 58d10c748bSKris Buschelman #define MATMPIAIJSPOOLES "mpiaijspooles" 599abb65ffSKris Buschelman #define MATSEQSBAIJSPOOLES "seqsbaijspooles" 6022191285SKris Buschelman #define MATMPISBAIJSPOOLES "mpisbaijspooles" 61bb4d4166SHong Zhang #define MATAIJSPOOLES "aijspooles" 62bb4d4166SHong Zhang #define MATSBAIJSPOOLES "sbaijspooles" 6314b396bbSKris Buschelman #define MATSUPERLU "superlu" 641d96aa28SKris Buschelman #define MATSUPERLU_DIST "superlu_dist" 651677d0b8SKris Buschelman #define MATUMFPACK "umfpack" 66e8aa55a4SKris Buschelman #define MATESSL "essl" 674eb8e494SKris Buschelman #define MATLUSOL "lusol" 68397b6df1SKris Buschelman #define MATAIJMUMPS "aijmumps" 69397b6df1SKris Buschelman #define MATSBAIJMUMPS "sbaijmumps" 708da957c5SKris Buschelman #define MATDSCPACK "dscpack" 717065e2aaSKris Buschelman #define MATMATLAB "matlab" 724b8d99adSRichard Tran Mills #define MATSEQCSRPERM "seqcsrperm" 7318def556SRichard Tran Mills #define MATMPICSRPERM "mpicsrperm" 74814655b8SBarry Smith #define MATCSRPERM "csrperm" 7581824310SBarry Smith #define MATSEQCRL "seqcrl" 76c02b24c5SBarry Smith #define MATMPICRL "mpicrl" 77c02b24c5SBarry Smith #define MATCRL "crl" 78c0aa2d19SHong Zhang #define MATPLAPACK "plapack" 792a6744ebSBarry Smith #define MATSCATTER "scatter" 80421e10b8SBarry Smith #define MATBLOCKMAT "blockmat" 81793850ffSBarry Smith #define MATCOMPOSITE "composite" 825a7f1df3SHong Zhang #define MATSEQFFTW "seqfftw" 83d91e6319SBarry Smith 84c06d978dSMatthew Knepley /* Logging support */ 85552e946dSBarry Smith #define MAT_FILE_COOKIE 1211216 /* used to indicate matrices in binary files */ 86be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_COOKIE; 87be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_FDCOLORING_COOKIE; 88be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_PARTITIONING_COOKIE; 89be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_NULLSPACE_COOKIE; 90c06d978dSMatthew Knepley 91ceb03754SKris Buschelman /*E 92ceb03754SKris Buschelman MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices() 93ceb03754SKris Buschelman or MatGetSubMatrix() are to be reused to store the new matrix values. 94ceb03754SKris Buschelman 95ceb03754SKris Buschelman Level: beginner 96ceb03754SKris Buschelman 97ceb03754SKris Buschelman Any additions/changes here MUST also be made in include/finclude/petscmat.h 98ceb03754SKris Buschelman 990c451bc4SBarry Smith .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert() 100ceb03754SKris Buschelman E*/ 101ceb03754SKris Buschelman typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX} MatReuse; 102ceb03754SKris Buschelman 103e5bd5246SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInitializePackage(const char[]); 104c06d978dSMatthew Knepley 105f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreate(MPI_Comm,Mat*); 106a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(MPI_Comm comm),(comm,&A),Mat,A) 107a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(),(PETSC_COMM_WORLD,&A),Mat,A) 108f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt); 109f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetType(Mat,MatType); 110be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetFromOptions(Mat); 111be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUpPreallocation(Mat); 112be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegisterAll(const char[]); 113be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat)); 11430de9b25SBarry Smith 115f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOptionsPrefix(Mat,const char[]); 116f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAppendOptionsPrefix(Mat,const char[]); 117f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOptionsPrefix(Mat,const char*[]); 118f69a0ea3SMatthew Knepley 11930de9b25SBarry Smith /*MC 12030de9b25SBarry Smith MatRegisterDynamic - Adds a new matrix type 12130de9b25SBarry Smith 12230de9b25SBarry Smith Synopsis: 123c1ac3661SBarry Smith PetscErrorCode MatRegisterDynamic(char *name,char *path,char *name_create,PetscErrorCode (*routine_create)(Mat)) 12430de9b25SBarry Smith 12530de9b25SBarry Smith Not Collective 12630de9b25SBarry Smith 12730de9b25SBarry Smith Input Parameters: 12830de9b25SBarry Smith + name - name of a new user-defined matrix type 12930de9b25SBarry Smith . path - path (either absolute or relative) the library containing this solver 13030de9b25SBarry Smith . name_create - name of routine to create method context 13130de9b25SBarry Smith - routine_create - routine to create method context 13230de9b25SBarry Smith 13330de9b25SBarry Smith Notes: 13430de9b25SBarry Smith MatRegisterDynamic() may be called multiple times to add several user-defined solvers. 13530de9b25SBarry Smith 13630de9b25SBarry Smith If dynamic libraries are used, then the fourth input argument (routine_create) 13730de9b25SBarry Smith is ignored. 13830de9b25SBarry Smith 13930de9b25SBarry Smith Sample usage: 14030de9b25SBarry Smith .vb 14130de9b25SBarry Smith MatRegisterDynamic("my_mat",/home/username/my_lib/lib/libO/solaris/mylib.a, 14230de9b25SBarry Smith "MyMatCreate",MyMatCreate); 14330de9b25SBarry Smith .ve 14430de9b25SBarry Smith 14530de9b25SBarry Smith Then, your solver can be chosen with the procedural interface via 14630de9b25SBarry Smith $ MatSetType(Mat,"my_mat") 14730de9b25SBarry Smith or at runtime via the option 14830de9b25SBarry Smith $ -mat_type my_mat 14930de9b25SBarry Smith 15030de9b25SBarry Smith Level: advanced 15130de9b25SBarry Smith 152ab901514SBarry Smith Notes: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values. 15330de9b25SBarry Smith If your function is not being put into a shared library then use VecRegister() instead 15430de9b25SBarry Smith 15530de9b25SBarry Smith .keywords: Mat, register 15630de9b25SBarry Smith 15730de9b25SBarry Smith .seealso: MatRegisterAll(), MatRegisterDestroy() 15830de9b25SBarry Smith 15930de9b25SBarry Smith M*/ 160273d9f13SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 161273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,0) 162273d9f13SBarry Smith #else 163273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,d) 16430de9b25SBarry Smith #endif 16530de9b25SBarry Smith 166*9c666560SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegisterAll(const char[]); 167273d9f13SBarry Smith extern PetscTruth MatRegisterAllCalled; 168b0a32e0cSBarry Smith extern PetscFList MatList; 16928988994SBarry Smith 170be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*); 171be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*); 172be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 173ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,nz,nnz,&A),Mat,A) 174ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,&A),Mat,A) 175ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,0,nnz,&A),Mat,A) 176ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,&A),Mat,A) 177ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,A)) 178ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,m,n,0,nnz,A)) 179ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,A)) 180be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 181ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(comm,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A) 182ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(comm,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A) 183ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(comm,m,n,M,N,0,nnz,0,onz,&A),Mat,A) 184ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(comm,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A) 185ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(comm,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A)) 186ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(comm,m,n,M,N,0,nnz,0,onz,A)) 187ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(comm,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A)) 188ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(PETSC_COMM_WORLD,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A) 189ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(PETSC_COMM_WORLD,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A) 190ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(PETSC_COMM_WORLD,m,n,M,N,0,nnz,0,onz,&A),Mat,A) 191ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N),(PETSC_COMM_WORLD,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A) 192ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(PETSC_COMM_WORLD,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A)) 193ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(PETSC_COMM_WORLD,m,n,M,N,0,nnz,0,onz,A)) 194ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIAIJ,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(PETSC_COMM_WORLD,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A)) 19563ab93bfSSatish Balay EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *); 1968d7a6e47SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*); 1978d7a6e47SBarry Smith 198be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIRowbs(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 199be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBDiag(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscScalar*[],Mat*); 200be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBDiag(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscScalar*[],Mat*); 201be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 202ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A) 203ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A) 204ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A) 205ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A) 206ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A)) 207ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A)) 208ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A)) 209be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 210ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(comm,bs,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A) 211ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(comm,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A) 212ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(comm,bs,m,n,M,N,0,nnz,0,onz,&A),Mat,A) 213ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(comm,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A) 214ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(comm,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A)) 215ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(comm,bs,m,n,M,N,0,nnz,0,onz,A)) 216ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(comm,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A)) 217ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A) 218ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A) 219ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(PETSC_COMM_WORLD,bs,m,n,M,N,0,nnz,0,onz,&A),Mat,A) 220ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(PETSC_COMM_WORLD,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A) 221ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A)) 222ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,0,nnz,0,onz,A)) 223ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPIBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A)) 224be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*); 225be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 226ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A) 227ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A) 228ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A) 229ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A) 230ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A)) 231ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A)) 232ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A)) 233be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPISBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 234ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(comm,bs,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A) 235ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(comm,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A) 236ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(comm,bs,m,n,M,N,0,nnz,0,onz,&A),Mat,A) 237ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(comm,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A) 238ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(comm,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A)) 239ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(comm,bs,m,n,M,N,0,nnz,0,onz,A)) 240ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(comm,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A)) 241ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,const PetscInt nnz[],PetscInt onz,const PetscInt onnz[]),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,nnz,onz,onnz,&A),Mat,A) 242ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,&A),Mat,A) 243ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[]),(PETSC_COMM_WORLD,bs,m,n,M,N,0,nnz,0,onz,&A),Mat,A) 244ba966639SSatish Balay PetscPolymorphicFunction(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N),(PETSC_COMM_WORLD,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,&A),Mat,A) 245ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,PetscInt nz,PetscInt nnz,Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,nz,PETSC_NULL,nnz,PETSC_NULL,A)) 246ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,const PetscInt nnz[],const PetscInt onz[],Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,0,nnz,0,onz,A)) 247ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateMPISBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt M,PetscInt N,Mat *A),(PETSC_COMM_WORLD,bs,m,n,M,N,0,PETSC_NULL,0,PETSC_NULL,A)) 248be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*); 249ba966639SSatish Balay PetscPolymorphicFunction(MatCreateShell,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(comm,m,n,M,N,ctx,&A),Mat,A) 250ba966639SSatish Balay PetscPolymorphicFunction(MatCreateShell,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(PETSC_COMM_WORLD,m,n,M,N,ctx,&A),Mat,A) 251be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateAdic(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,void (*)(void),Mat*); 252be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateNormal(Mat,Mat*); 253ba966639SSatish Balay PetscPolymorphicFunction(MatCreateNormal,(Mat mat),(mat,&A),Mat,A) 254ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateLRC(Mat,Mat,Mat,Mat*); 255284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,Mat*); 2561472f72bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 2571472f72bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPICRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 2582a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateScatter(MPI_Comm,VecScatter,Mat*); 2592a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScatterSetVecScatter(Mat,VecScatter); 2602a6744ebSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScatterGetVecScatter(Mat,VecScatter*); 2618cdf2d9bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*); 262793850ffSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeAddMat(Mat,Mat); 263b52f573bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompositeMerge(Mat); 264793850ffSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*); 2655a7f1df3SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqFFTW(MPI_Comm,PetscInt,const PetscInt[],Mat*); 2661472f72bSBarry Smith 267f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUp(Mat); 268be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy(Mat); 26921c89e3eSBarry Smith 2700c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConjugate(Mat); 27199cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRealPart(Mat); 27299cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatImaginaryPart(Mat); 27399cafbc1SBarry Smith 2748ed539a5SBarry Smith /* ------------------------------------------------------------*/ 275be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 276be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 27787d4246cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRow(Mat,PetscInt,const PetscScalar[]); 278f259bd47SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]); 27984cb2905SBarry Smith 2802ef4de8bSBarry Smith /*S 2812ef4de8bSBarry Smith MatStencil - Data structure (C struct) for storing information about a single row or 2822ef4de8bSBarry Smith column of a matrix as index on an associated grid. 2832ef4de8bSBarry Smith 2842ef4de8bSBarry Smith Level: beginner 2852ef4de8bSBarry Smith 2862ef4de8bSBarry Smith Concepts: matrix; linear operator 2872ef4de8bSBarry Smith 288d7bd93baSBarry Smith .seealso: MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockStencil() 2892ef4de8bSBarry Smith S*/ 290435da068SBarry Smith typedef struct { 291c1ac3661SBarry Smith PetscInt k,j,i,c; 292435da068SBarry Smith } MatStencil; 2932ef4de8bSBarry Smith 294be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode); 295be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode); 296be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt); 297435da068SBarry Smith 298be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetColoring(Mat,ISColoring); 299be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdic(Mat,void*); 300be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdifor(Mat,PetscInt,void*); 3013a7fca6bSBarry Smith 302d91e6319SBarry Smith /*E 303d91e6319SBarry Smith MatAssemblyType - Indicates if the matrix is now to be used, or if you plan 304d91e6319SBarry Smith to continue to add values to it 305d91e6319SBarry Smith 306d91e6319SBarry Smith Level: beginner 307d91e6319SBarry Smith 308d91e6319SBarry Smith .seealso: MatAssemblyBegin(), MatAssemblyEnd() 309d91e6319SBarry Smith E*/ 3106d4a8577SBarry Smith typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType; 311be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyBegin(Mat,MatAssemblyType); 312be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyEnd(Mat,MatAssemblyType); 313be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssembled(Mat,PetscTruth*); 3144f9c727eSBarry Smith 315be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscInt MatSetValue_Row; 316be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscInt MatSetValue_Column; 317be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscScalar MatSetValue_Value; 3181d73ed98SBarry Smith 31930de9b25SBarry Smith /*MC 32030de9b25SBarry Smith MatSetValue - Set a single entry into a matrix. 32130de9b25SBarry Smith 32230de9b25SBarry Smith Synopsis: 323c1ac3661SBarry Smith PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode); 32430de9b25SBarry Smith 32530de9b25SBarry Smith Not collective 32630de9b25SBarry Smith 32730de9b25SBarry Smith Input Parameters: 32830de9b25SBarry Smith + m - the matrix 32930de9b25SBarry Smith . row - the row location of the entry 33030de9b25SBarry Smith . col - the column location of the entry 33130de9b25SBarry Smith . value - the value to insert 33230de9b25SBarry Smith - mode - either INSERT_VALUES or ADD_VALUES 33330de9b25SBarry Smith 33430de9b25SBarry Smith Notes: 33530de9b25SBarry Smith For efficiency one should use MatSetValues() and set several or many 33630de9b25SBarry Smith values simultaneously if possible. 33730de9b25SBarry Smith 33830de9b25SBarry Smith Level: beginner 33930de9b25SBarry Smith 34030de9b25SBarry Smith .seealso: MatSetValues(), MatSetValueLocal() 34130de9b25SBarry Smith M*/ 342b951964fSBarry Smith #define MatSetValue(v,i,j,va,mode) \ 343f1144a30SSatish Balay ((MatSetValue_Row = i,MatSetValue_Column = j,MatSetValue_Value = va,0) || \ 3441d73ed98SBarry Smith MatSetValues(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&MatSetValue_Value,mode)) 34530de9b25SBarry Smith 346ea06a074SBarry Smith #define MatGetValue(v,i,j,va) \ 347f1144a30SSatish Balay ((MatSetValue_Row = i,MatSetValue_Column = j,0) || \ 3481d73ed98SBarry Smith MatGetValues(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&va)) 34930de9b25SBarry Smith 350d91e6319SBarry Smith #define MatSetValueLocal(v,i,j,va,mode) \ 351f1144a30SSatish Balay ((MatSetValue_Row = i,MatSetValue_Column = j,MatSetValue_Value = va,0) || \ 3521d73ed98SBarry Smith MatSetValuesLocal(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&MatSetValue_Value,mode)) 35330de9b25SBarry Smith 354d91e6319SBarry Smith /*E 355d91e6319SBarry Smith MatOption - Options that may be set for a matrix and its behavior or storage 356d91e6319SBarry Smith 357d91e6319SBarry Smith Level: beginner 358d91e6319SBarry Smith 3590a835dfdSSatish Balay Any additions/changes here MUST also be made in include/finclude/petscmat.h 360d91e6319SBarry Smith 361d91e6319SBarry Smith .seealso: MatSetOption() 362d91e6319SBarry Smith E*/ 363290bbb0aSBarry Smith typedef enum {MAT_ROW_ORIENTED,MAT_COLUMN_ORIENTED,MAT_ROWS_SORTED, 364290bbb0aSBarry Smith MAT_COLUMNS_SORTED,MAT_NO_NEW_NONZERO_LOCATIONS, 365290bbb0aSBarry Smith MAT_YES_NEW_NONZERO_LOCATIONS,MAT_SYMMETRIC, 366290bbb0aSBarry Smith MAT_STRUCTURALLY_SYMMETRIC,MAT_NO_NEW_DIAGONALS, 367290bbb0aSBarry Smith MAT_YES_NEW_DIAGONALS,MAT_INODE_LIMIT_1,MAT_INODE_LIMIT_2, 368290bbb0aSBarry Smith MAT_INODE_LIMIT_3,MAT_INODE_LIMIT_4,MAT_INODE_LIMIT_5, 369290bbb0aSBarry Smith MAT_IGNORE_OFF_PROC_ENTRIES,MAT_ROWS_UNSORTED, 370290bbb0aSBarry Smith MAT_COLUMNS_UNSORTED,MAT_NEW_NONZERO_LOCATION_ERR, 371290bbb0aSBarry Smith MAT_NEW_NONZERO_ALLOCATION_ERR,MAT_USE_HASH_TABLE, 372290bbb0aSBarry Smith MAT_KEEP_ZEROED_ROWS,MAT_IGNORE_ZERO_ENTRIES,MAT_USE_INODES, 373290bbb0aSBarry Smith MAT_DO_NOT_USE_INODES,MAT_NOT_SYMMETRIC,MAT_HERMITIAN, 374290bbb0aSBarry Smith MAT_NOT_STRUCTURALLY_SYMMETRIC,MAT_NOT_HERMITIAN, 375290bbb0aSBarry Smith MAT_SYMMETRY_ETERNAL,MAT_NOT_SYMMETRY_ETERNAL, 376290bbb0aSBarry Smith MAT_USE_COMPRESSEDROW,MAT_DO_NOT_USE_COMPRESSEDROW, 377290bbb0aSBarry Smith MAT_IGNORE_LOWER_TRIANGULAR,MAT_ERROR_LOWER_TRIANGULAR,MAT_GETROW_UPPERTRIANGULAR} MatOption; 378290bbb0aSBarry Smith extern const char *MatOptions[]; 379be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOption(Mat,MatOption); 380be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetType(Mat,MatType*); 381ba966639SSatish Balay PetscPolymorphicFunction(MatGetType,(Mat mat),(mat,&t),MatType,t) 38284cb2905SBarry Smith 383be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]); 384be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 385be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 386f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowUpperTriangular(Mat); 387f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowUpperTriangular(Mat); 388be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 389be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 390be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnVector(Mat,Vec,PetscInt); 391be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetArray(Mat,PetscScalar *[]); 392ba966639SSatish Balay PetscPolymorphicFunction(MatGetArray,(Mat mat),(mat,&a),PetscScalar*,a) 393be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreArray(Mat,PetscScalar *[]); 394be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBlockSize(Mat,PetscInt *); 395ba966639SSatish Balay PetscPolymorphicFunction(MatGetBlockSize,(Mat mat),(mat,&a),PetscInt,a) 396be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetBlockSize(Mat,PetscInt); 3977b80b807SBarry Smith 398be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMult(Mat,Vec,Vec); 399be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAdd(Mat,Vec,Vec,Vec); 400ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultAdd,(Mat A,Vec x,Vec y),(A,x,y,y)) 401be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTranspose(Mat,Vec,Vec); 402be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsTranspose(Mat,Mat,PetscReal,PetscTruth*); 403ba966639SSatish Balay PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B,PetscReal tol),(A,B,tol,&t),PetscTruth,t) 404e37f64cdSBarry Smith PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B),(A,B,0,&t),PetscTruth,t) 405be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAdd(Mat,Vec,Vec,Vec); 406ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultTransposeAdd,(Mat A,Vec x,Vec y),(A,x,y,y)) 407be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultConstrained(Mat,Vec,Vec); 408be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeConstrained(Mat,Vec,Vec); 4092bebee5dSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatSolve(Mat,Mat,Mat); 410f5edf698SHong Zhang 411d91e6319SBarry Smith /*E 412d91e6319SBarry Smith MatDuplicateOption - Indicates if a duplicated sparse matrix should have 413d91e6319SBarry Smith its numerical values copied over or just its nonzero structure. 414d91e6319SBarry Smith 415d91e6319SBarry Smith Level: beginner 416d91e6319SBarry Smith 417d91e6319SBarry Smith Any additions/changes here MUST also be made in include/finclude/petscmat.h 418d91e6319SBarry Smith 419d91e6319SBarry Smith .seealso: MatDuplicate() 420d91e6319SBarry Smith E*/ 4212e8a6d31SBarry Smith typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES} MatDuplicateOption; 4222e8a6d31SBarry Smith 423f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvert(Mat,MatType,MatReuse,Mat*); 424ba966639SSatish Balay PetscPolymorphicFunction(MatConvert,(Mat A,MatType t),(A,t,MAT_INITIAL_MATRIX,&a),Mat,a) 425be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDuplicate(Mat,MatDuplicateOption,Mat*); 426ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A,MatDuplicateOption o),(A,o,&a),Mat,a) 427ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A),(A,MAT_COPY_VALUES,&a),Mat,a) 42894a9d846SBarry Smith 429d91e6319SBarry Smith /*E 430d91e6319SBarry Smith MatStructure - Indicates if the matrix has the same nonzero structure 431d91e6319SBarry Smith 432d91e6319SBarry Smith Level: beginner 433d91e6319SBarry Smith 434d91e6319SBarry Smith Any additions/changes here MUST also be made in include/finclude/petscmat.h 435d91e6319SBarry Smith 43694b7f48cSBarry Smith .seealso: MatCopy(), KSPSetOperators(), PCSetOperators() 437d91e6319SBarry Smith E*/ 438c537a176SHong Zhang typedef enum {SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER,SUBSET_NONZERO_PATTERN} MatStructure; 439cb5b572fSBarry Smith 440be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCopy(Mat,Mat,MatStructure); 441be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatView(Mat,PetscViewer); 442be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetric(Mat,PetscReal,PetscTruth*); 443ba966639SSatish Balay PetscPolymorphicFunction(MatIsSymmetric,(Mat A,PetscReal tol),(A,tol,&t),PetscTruth,t) 444e37f64cdSBarry Smith PetscPolymorphicFunction(MatIsSymmetric,(Mat A),(A,0,&t),PetscTruth,t) 445be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsStructurallySymmetric(Mat,PetscTruth*); 446ba966639SSatish Balay PetscPolymorphicFunction(MatIsStructurallySymmetric,(Mat A),(A,&t),PetscTruth,t) 447be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitian(Mat,PetscTruth*); 448ba966639SSatish Balay PetscPolymorphicFunction(MatIsHermitian,(Mat A),(A,&t),PetscTruth,t) 449be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetricKnown(Mat,PetscTruth*,PetscTruth*); 450be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianKnown(Mat,PetscTruth*,PetscTruth*); 451f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLoad(PetscViewer,MatType,Mat*); 452ba966639SSatish Balay PetscPolymorphicFunction(MatLoad,(PetscViewer v,MatType t),(v,t,&a),Mat,a) 4537b80b807SBarry Smith 454be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowIJ(Mat,PetscInt,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *); 455be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowIJ(Mat,PetscInt,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *); 456be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnIJ(Mat,PetscInt,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *); 457be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumnIJ(Mat,PetscInt,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *); 458d4fbbf0eSBarry Smith 459d91e6319SBarry Smith /*S 460d91e6319SBarry Smith MatInfo - Context of matrix information, used with MatGetInfo() 461d91e6319SBarry Smith 462d91e6319SBarry Smith In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE 463d91e6319SBarry Smith 464d91e6319SBarry Smith Level: intermediate 465d91e6319SBarry Smith 466d91e6319SBarry Smith Concepts: matrix^nonzero information 467d91e6319SBarry Smith 468d9274352SBarry Smith .seealso: MatGetInfo(), MatInfoType 469d91e6319SBarry Smith S*/ 4704e220ebcSLois Curfman McInnes typedef struct { 471b0a32e0cSBarry Smith PetscLogDouble rows_global,columns_global; /* number of global rows and columns */ 472b0a32e0cSBarry Smith PetscLogDouble rows_local,columns_local; /* number of local rows and columns */ 473b0a32e0cSBarry Smith PetscLogDouble block_size; /* block size */ 474b0a32e0cSBarry Smith PetscLogDouble nz_allocated,nz_used,nz_unneeded; /* number of nonzeros */ 475b0a32e0cSBarry Smith PetscLogDouble memory; /* memory allocated */ 476b0a32e0cSBarry Smith PetscLogDouble assemblies; /* number of matrix assemblies called */ 477b0a32e0cSBarry Smith PetscLogDouble mallocs; /* number of mallocs during MatSetValues() */ 478b0a32e0cSBarry Smith PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */ 479b0a32e0cSBarry Smith PetscLogDouble factor_mallocs; /* number of mallocs during factorization */ 4804e220ebcSLois Curfman McInnes } MatInfo; 4814e220ebcSLois Curfman McInnes 482d9274352SBarry Smith /*E 483d9274352SBarry Smith MatInfoType - Indicates if you want information about the local part of the matrix, 484d9274352SBarry Smith the entire parallel matrix or the maximum over all the local parts. 485d9274352SBarry Smith 486d9274352SBarry Smith Level: beginner 487d9274352SBarry Smith 488d9274352SBarry Smith Any additions/changes here MUST also be made in include/finclude/petscmat.h 489d9274352SBarry Smith 490d9274352SBarry Smith .seealso: MatGetInfo(), MatInfo 491d9274352SBarry Smith E*/ 4927b80b807SBarry Smith typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType; 493be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInfo(Mat,MatInfoType,MatInfo*); 494be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatValid(Mat,PetscTruth*); 495be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonal(Mat,Vec); 496985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMax(Mat,Vec,PetscInt[]); 497985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMin(Mat,Vec,PetscInt[]); 498985db425SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMaxAbs(Mat,Vec,PetscInt[]); 49986697f06SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowSum(Mat,Vec); 500be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatTranspose(Mat,Mat*); 501ba966639SSatish Balay PetscPolymorphicFunction(MatTranspose,(Mat A),(A,&t),Mat,t) 502be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermute(Mat,IS,IS,Mat *); 503ba966639SSatish Balay PetscPolymorphicFunction(MatPermute,(Mat A,IS is1,IS is2),(A,is1,is2,&t),Mat,t) 504be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermuteSparsify(Mat,PetscInt,PetscReal,PetscReal,IS,IS,Mat *); 505be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScale(Mat,Vec,Vec); 506be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalSet(Mat,Vec,InsertMode); 507be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatEqual(Mat,Mat,PetscTruth*); 508ba966639SSatish Balay PetscPolymorphicFunction(MatEqual,(Mat A,Mat B),(A,B,&t),PetscTruth,t) 509be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultEqual(Mat,Mat,PetscInt,PetscTruth*); 510be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAddEqual(Mat,Mat,PetscInt,PetscTruth*); 511be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeEqual(Mat,Mat,PetscInt,PetscTruth*); 512be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscTruth*); 5137b80b807SBarry Smith 514be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNorm(Mat,NormType,PetscReal *); 515ba966639SSatish Balay PetscPolymorphicFunction(MatNorm,(Mat A,NormType t),(A,t,&n),PetscReal,n) 516be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroEntries(Mat); 517f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar); 518f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsIS(Mat,IS,PetscScalar); 519f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumns(Mat,PetscInt,const PetscInt [],const PetscScalar*); 520f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumnsIS(Mat,IS,const PetscScalar*); 5217b80b807SBarry Smith 522be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUseScaledForm(Mat,PetscTruth); 523be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScaleSystem(Mat,Vec,Vec); 524be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUnScaleSystem(Mat,Vec,Vec); 5255ef9f2a5SBarry Smith 526be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSize(Mat,PetscInt*,PetscInt*); 527be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalSize(Mat,PetscInt*,PetscInt*); 528be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRange(Mat,PetscInt*,PetscInt*); 5298ee2e534SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRanges(Mat,const PetscInt**); 5307b80b807SBarry Smith 531be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]); 532be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroyMatrices(PetscInt,Mat *[]); 533be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrix(Mat,IS,IS,PetscInt,MatReuse,Mat *); 534abf0e977SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrixRaw(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscInt,MatReuse,Mat *); 535be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*); 536be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*); 537be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*); 538be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPINumeric(Mat,Mat); 539be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy_MPIAIJ_SeqsToMPI(Mat); 540be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMat(Mat,MatReuse,Mat*); 541be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*); 542be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*); 543be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,PetscScalar**,Mat*); 54443eb5e2fSMatthew Knepley #if defined (PETSC_USE_CTABLE) 545cd116e26SSatish Balay #include "petscctable.h" 54643eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscTable *, VecScatter *); 54743eb5e2fSMatthew Knepley #else 54843eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscInt *[], VecScatter *); 54943eb5e2fSMatthew Knepley #endif 5508efafbd8SBarry Smith 551be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt); 5527b80b807SBarry Smith 553be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*); 554be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*); 555be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultNumeric(Mat,Mat,Mat); 55622440eb1SKris Buschelman 557be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*); 558be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*); 559be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPNumeric(Mat,Mat,Mat); 56022440eb1SKris Buschelman 561be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*); 562be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*); 563be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeNumeric(Mat,Mat,Mat); 564bc011b1eSHong Zhang 565f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAXPY(Mat,PetscScalar,Mat,MatStructure); 56604aac2b0SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAYPX(Mat,PetscScalar,Mat,MatStructure); 567be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompress(Mat); 5681c741599SHong Zhang 569f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScale(Mat,PetscScalar); 570f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShift(Mat,PetscScalar); 5717b80b807SBarry Smith 572be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping); 573be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping); 574f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar); 575f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocalIS(Mat,IS,PetscScalar); 576be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 577be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 578052efed2SBarry Smith 579be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashSetInitialSize(Mat,PetscInt,PetscInt); 580be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 58190f02eecSBarry Smith 582be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolate(Mat,Vec,Vec); 5830c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolateAdd(Mat,Vec,Vec,Vec); 584ba966639SSatish Balay PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y)) 585be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestrict(Mat,Vec,Vec); 586be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetVecs(Mat,Vec*,Vec*); 58769db28dcSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRedundantMatrix(Mat,PetscInt,MPI_Comm,PetscInt,MatReuse,Mat*); 588bd481603SBarry Smith 589bd481603SBarry Smith /*MC 5900d2a7ff2SSatish Balay MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per 591bd481603SBarry Smith row in a matrix providing the data that one can use to correctly preallocate the matrix. 592bd481603SBarry Smith 593bd481603SBarry Smith Synopsis: 594c1ac3661SBarry Smith PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz) 595bd481603SBarry Smith 596bd481603SBarry Smith Collective on MPI_Comm 597bd481603SBarry Smith 598bd481603SBarry Smith Input Parameters: 599bd481603SBarry Smith + comm - the communicator that will share the eventually allocated matrix 600859fcb39SBarry Smith . nrows - the number of LOCAL rows in the matrix 601859fcb39SBarry Smith - ncols - the number of LOCAL columns in the matrix 602bd481603SBarry Smith 603bd481603SBarry Smith Output Parameters: 604bd481603SBarry Smith + dnz - the array that will be passed to the matrix preallocation routines 605bd481603SBarry Smith - ozn - the other array passed to the matrix preallocation routines 606bd481603SBarry Smith 607bd481603SBarry Smith 608bd481603SBarry Smith Level: intermediate 609bd481603SBarry Smith 610bd481603SBarry Smith Notes: 611bd481603SBarry Smith See the chapter in the users manual on performance for more details 612bd481603SBarry Smith 6131d73ed98SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 614bd481603SBarry Smith 615bd481603SBarry Smith Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices) 616bd481603SBarry Smith 617bd481603SBarry Smith Concepts: preallocation^Matrix 618bd481603SBarry Smith 619bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 620bd481603SBarry Smith MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal() 621bd481603SBarry Smith M*/ 622c4f061fbSSatish Balay #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \ 6237c922b88SBarry Smith { \ 624c1ac3661SBarry Smith PetscErrorCode _4_ierr; PetscInt __tmp = (nrows),__ctmp = (ncols),__rstart,__start,__end; \ 625c1ac3661SBarry Smith _4_ierr = PetscMalloc(2*__tmp*sizeof(PetscInt),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\ 626c1ac3661SBarry Smith _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(PetscInt));CHKERRQ(_4_ierr);\ 627c1ac3661SBarry Smith _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\ 628c1ac3661SBarry Smith _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp; 6297c922b88SBarry Smith 630bd481603SBarry Smith /*MC 6310d2a7ff2SSatish Balay MatPreallocateSymmetricInitialize - Begins the block of code that will count the number of nonzeros per 632bd481603SBarry Smith row in a matrix providing the data that one can use to correctly preallocate the matrix. 633bd481603SBarry Smith 634bd481603SBarry Smith Synopsis: 635c1ac3661SBarry Smith PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz) 636bd481603SBarry Smith 637bd481603SBarry Smith Collective on MPI_Comm 638bd481603SBarry Smith 639bd481603SBarry Smith Input Parameters: 640bd481603SBarry Smith + comm - the communicator that will share the eventually allocated matrix 641859fcb39SBarry Smith . nrows - the number of LOCAL rows in the matrix 642859fcb39SBarry Smith - ncols - the number of LOCAL columns in the matrix 643bd481603SBarry Smith 644bd481603SBarry Smith Output Parameters: 645bd481603SBarry Smith + dnz - the array that will be passed to the matrix preallocation routines 646bd481603SBarry Smith - ozn - the other array passed to the matrix preallocation routines 647bd481603SBarry Smith 648bd481603SBarry Smith 649bd481603SBarry Smith Level: intermediate 650bd481603SBarry Smith 651bd481603SBarry Smith Notes: 652bd481603SBarry Smith See the chapter in the users manual on performance for more details 653bd481603SBarry Smith 6541d73ed98SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 655bd481603SBarry Smith 656bd481603SBarry Smith Concepts: preallocation^Matrix 657bd481603SBarry Smith 658bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 659bd481603SBarry Smith MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal() 660bd481603SBarry Smith M*/ 661222b16d4SBarry Smith #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \ 662222b16d4SBarry Smith { \ 663c1ac3661SBarry Smith PetscErrorCode _4_ierr; PetscInt __tmp = (nrows),__ctmp = (ncols),__rstart,__end; \ 664c1ac3661SBarry Smith _4_ierr = PetscMalloc(2*__tmp*sizeof(PetscInt),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\ 665c1ac3661SBarry Smith _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(PetscInt));CHKERRQ(_4_ierr);\ 666c1ac3661SBarry Smith _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\ 667c1ac3661SBarry Smith _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp; 668222b16d4SBarry Smith 669bd481603SBarry Smith /*MC 670bd481603SBarry Smith MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 671bd481603SBarry Smith inserted using a local number of the rows and columns 672bd481603SBarry Smith 673bd481603SBarry Smith Synopsis: 674c1ac3661SBarry Smith PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 675bd481603SBarry Smith 676bd481603SBarry Smith Not Collective 677bd481603SBarry Smith 678bd481603SBarry Smith Input Parameters: 679bd481603SBarry Smith + map - the mapping between local numbering and global numbering 680bd481603SBarry Smith . nrows - the number of rows indicated 6811d73ed98SBarry Smith . rows - the indices of the rows 682bd481603SBarry Smith . ncols - the number of columns in the matrix 683bd481603SBarry Smith . cols - the columns indicated 684bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 685bd481603SBarry Smith - ozn - the other array passed to the matrix preallocation routines 686bd481603SBarry Smith 687bd481603SBarry Smith 688bd481603SBarry Smith Level: intermediate 689bd481603SBarry Smith 690bd481603SBarry Smith Notes: 691bd481603SBarry Smith See the chapter in the users manual on performance for more details 692bd481603SBarry Smith 6931d73ed98SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 694bd481603SBarry Smith 695bd481603SBarry Smith Concepts: preallocation^Matrix 696bd481603SBarry Smith 697bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 698bd481603SBarry Smith MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal() 699bd481603SBarry Smith M*/ 700c4f061fbSSatish Balay #define MatPreallocateSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\ 701c4f061fbSSatish Balay {\ 702c1ac3661SBarry Smith PetscInt __l;\ 703ef66eb69SBarry Smith _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\ 704ef66eb69SBarry Smith _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\ 705c4f061fbSSatish Balay for (__l=0;__l<nrows;__l++) {\ 706ef66eb69SBarry Smith _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 707c4f061fbSSatish Balay }\ 708c4f061fbSSatish Balay } 709c4f061fbSSatish Balay 710bd481603SBarry Smith /*MC 711bd481603SBarry Smith MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 712bd481603SBarry Smith inserted using a local number of the rows and columns 713bd481603SBarry Smith 714bd481603SBarry Smith Synopsis: 715c1ac3661SBarry Smith PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 716bd481603SBarry Smith 717bd481603SBarry Smith Not Collective 718bd481603SBarry Smith 719bd481603SBarry Smith Input Parameters: 720bd481603SBarry Smith + map - the mapping between local numbering and global numbering 721bd481603SBarry Smith . nrows - the number of rows indicated 7221d73ed98SBarry Smith . rows - the indices of the rows 723bd481603SBarry Smith . ncols - the number of columns in the matrix 724bd481603SBarry Smith . cols - the columns indicated 725bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 726bd481603SBarry Smith - ozn - the other array passed to the matrix preallocation routines 727bd481603SBarry Smith 728bd481603SBarry Smith 729bd481603SBarry Smith Level: intermediate 730bd481603SBarry Smith 731bd481603SBarry Smith Notes: 732bd481603SBarry Smith See the chapter in the users manual on performance for more details 733bd481603SBarry Smith 734bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 735bd481603SBarry Smith 736bd481603SBarry Smith Concepts: preallocation^Matrix 737bd481603SBarry Smith 738bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 739bd481603SBarry Smith MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 740bd481603SBarry Smith M*/ 741d3d32019SBarry Smith #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\ 742d3d32019SBarry Smith {\ 743c1ac3661SBarry Smith PetscInt __l;\ 744d3d32019SBarry Smith _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\ 745d3d32019SBarry Smith _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\ 746d3d32019SBarry Smith for (__l=0;__l<nrows;__l++) {\ 747d3d32019SBarry Smith _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 748d3d32019SBarry Smith }\ 749d3d32019SBarry Smith } 750d3d32019SBarry Smith 751bd481603SBarry Smith /*MC 752bd481603SBarry Smith MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 753bd481603SBarry Smith inserted using a local number of the rows and columns 754bd481603SBarry Smith 755bd481603SBarry Smith Synopsis: 756c1ac3661SBarry Smith PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 757bd481603SBarry Smith 758bd481603SBarry Smith Not Collective 759bd481603SBarry Smith 760bd481603SBarry Smith Input Parameters: 76164075487SBarry Smith + row - the row 762bd481603SBarry Smith . ncols - the number of columns in the matrix 763a50f8bf6SHong Zhang - cols - the columns indicated 764a50f8bf6SHong Zhang 765a50f8bf6SHong Zhang Output Parameters: 766a50f8bf6SHong Zhang + dnz - the array that will be passed to the matrix preallocation routines 767bd481603SBarry Smith - ozn - the other array passed to the matrix preallocation routines 768bd481603SBarry Smith 769bd481603SBarry Smith 770bd481603SBarry Smith Level: intermediate 771bd481603SBarry Smith 772bd481603SBarry Smith Notes: 773bd481603SBarry Smith See the chapter in the users manual on performance for more details 774bd481603SBarry Smith 775bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 776bd481603SBarry Smith 777bd481603SBarry Smith Concepts: preallocation^Matrix 778bd481603SBarry Smith 779bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 780bd481603SBarry Smith MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 781bd481603SBarry Smith M*/ 782c4f061fbSSatish Balay #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\ 783c1ac3661SBarry Smith { PetscInt __i; \ 7848ee2e534SBarry Smith if (row < __rstart) SETERRQ2(PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D less than first local row %D",row,__rstart);\ 7858ee2e534SBarry Smith if (row >= __rstart+__tmp) SETERRQ2(PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D greater than last local row %D",row,__rstart+__tmp-1);\ 7867c922b88SBarry Smith for (__i=0; __i<nc; __i++) {\ 78764075487SBarry Smith if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \ 7887cc688d7SBarry Smith else dnz[row - __rstart]++;\ 7897c922b88SBarry Smith }\ 7907c922b88SBarry Smith } 7917c922b88SBarry Smith 792bd481603SBarry Smith /*MC 793bd481603SBarry Smith MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 794bd481603SBarry Smith inserted using a local number of the rows and columns 795bd481603SBarry Smith 796bd481603SBarry Smith Synopsis: 797c1ac3661SBarry Smith PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 798bd481603SBarry Smith 799bd481603SBarry Smith Not Collective 800bd481603SBarry Smith 801bd481603SBarry Smith Input Parameters: 802bd481603SBarry Smith + nrows - the number of rows indicated 8031d73ed98SBarry Smith . rows - the indices of the rows 804bd481603SBarry Smith . ncols - the number of columns in the matrix 805bd481603SBarry Smith . cols - the columns indicated 806bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 807bd481603SBarry Smith - ozn - the other array passed to the matrix preallocation routines 808bd481603SBarry Smith 809bd481603SBarry Smith 810bd481603SBarry Smith Level: intermediate 811bd481603SBarry Smith 812bd481603SBarry Smith Notes: 813bd481603SBarry Smith See the chapter in the users manual on performance for more details 814bd481603SBarry Smith 815bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 816bd481603SBarry Smith 817bd481603SBarry Smith Concepts: preallocation^Matrix 818bd481603SBarry Smith 819bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 820bd481603SBarry Smith MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 821bd481603SBarry Smith M*/ 822d3d32019SBarry Smith #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\ 823c1ac3661SBarry Smith { PetscInt __i; \ 824d3d32019SBarry Smith for (__i=0; __i<nc; __i++) {\ 825d3d32019SBarry Smith if (cols[__i] >= __end) onz[row - __rstart]++; \ 826d3d32019SBarry Smith else if (cols[__i] >= row) dnz[row - __rstart]++;\ 827d3d32019SBarry Smith }\ 828d3d32019SBarry Smith } 829d3d32019SBarry Smith 830bd481603SBarry Smith /*MC 8310d2a7ff2SSatish Balay MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per 832bd481603SBarry Smith row in a matrix providing the data that one can use to correctly preallocate the matrix. 833bd481603SBarry Smith 834bd481603SBarry Smith Synopsis: 835c1ac3661SBarry Smith PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz) 836bd481603SBarry Smith 837bd481603SBarry Smith Collective on MPI_Comm 838bd481603SBarry Smith 839bd481603SBarry Smith Input Parameters: 840bd481603SBarry Smith + dnz - the array that will be passed to the matrix preallocation routines 841bd481603SBarry Smith - ozn - the other array passed to the matrix preallocation routines 842bd481603SBarry Smith 843bd481603SBarry Smith 844bd481603SBarry Smith Level: intermediate 845bd481603SBarry Smith 846bd481603SBarry Smith Notes: 847bd481603SBarry Smith See the chapter in the users manual on performance for more details 848bd481603SBarry Smith 849bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 850bd481603SBarry Smith 851bd481603SBarry Smith Concepts: preallocation^Matrix 852bd481603SBarry Smith 853bd481603SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 854bd481603SBarry Smith MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal() 855bd481603SBarry Smith M*/ 856ef66eb69SBarry Smith #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree(dnz);CHKERRQ(_4_ierr);} 8577c922b88SBarry Smith 858bd481603SBarry Smith 859bd481603SBarry Smith 8607b80b807SBarry Smith /* Routines unique to particular data structures */ 861be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetContext(Mat,void **); 862ba966639SSatish Balay PetscPolymorphicFunction(MatShellGetContext,(Mat A),(A,&t),void*,t) 863be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBDiagGetData(Mat,PetscInt*,PetscInt*,PetscInt*[],PetscInt*[],PetscScalar***); 864698d4c6aSKris Buschelman 865be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeAdjustForInodes(Mat,IS*,IS*); 866be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *); 867698d4c6aSKris Buschelman 868be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetColumnIndices(Mat,PetscInt[]); 869be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetColumnIndices(Mat,PetscInt[]); 870be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 871c75a6043SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 872c75a6043SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 8737b80b807SBarry Smith 874a96a251dSBarry Smith #define MAT_SKIP_ALLOCATION -4 875a96a251dSBarry Smith 876be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 877ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz)) 878be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 879ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqSBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz)) 880be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]); 881ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqAIJSetPreallocation,(Mat A,const PetscInt nnz[]),(A,0,nnz)) 882be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDensePreallocation(Mat,PetscScalar[]); 883be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBDiagSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscScalar*[]); 884273d9f13SBarry Smith 885be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 886ba966639SSatish Balay PetscPolymorphicSubroutine(MatMPIBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[],const PetscInt onz[]),(A,bs,0,nnz,0,onz)) 887be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 888be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 88953803f26SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []); 890be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]); 891be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 892be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBDiagSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscScalar*[]); 893be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]); 894be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDenseSetPreallocation(Mat,PetscScalar[]); 895284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetPreallocation(Mat,PetscScalar[]); 896be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIRowbsSetPreallocation(Mat,PetscInt,const PetscInt[]); 897be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]); 898be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]); 899be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAdicSetLocalFunction(Mat,void (*)(void)); 900273d9f13SBarry Smith 901be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetLDA(Mat,PetscInt); 902ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDenseGetLocalMatrix(Mat,Mat*); 9031b807ce4Svictorle 904be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStoreValues(Mat); 905be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRetrieveValues(Mat); 9062e8a6d31SBarry Smith 907be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDAADSetCtx(Mat,void*); 9083a7fca6bSBarry Smith 9097b80b807SBarry Smith /* 9107b80b807SBarry Smith These routines are not usually accessed directly, rather solving is 91194b7f48cSBarry Smith done through the KSP and PC interfaces. 9127b80b807SBarry Smith */ 9137b80b807SBarry Smith 914d9274352SBarry Smith /*E 915d9274352SBarry Smith MatOrderingType - String with the name of a PETSc matrix ordering or the creation function 916d9274352SBarry Smith with an optional dynamic library name, for example 917d9274352SBarry Smith http://www.mcs.anl.gov/petsc/lib.a:orderingcreate() 918d9274352SBarry Smith 919d9274352SBarry Smith Level: beginner 920d9274352SBarry Smith 921e5a9bf91SBarry Smith Cannot use const because the PC objects manipulate the string 922e5a9bf91SBarry Smith 923d9274352SBarry Smith .seealso: MatGetOrdering() 924d9274352SBarry Smith E*/ 92549773a63SBarry Smith #define MatOrderingType char* 926b12f92e5SBarry Smith #define MATORDERING_NATURAL "natural" 927b12f92e5SBarry Smith #define MATORDERING_ND "nd" 928b12f92e5SBarry Smith #define MATORDERING_1WD "1wd" 929b12f92e5SBarry Smith #define MATORDERING_RCM "rcm" 930b12f92e5SBarry Smith #define MATORDERING_QMD "qmd" 931b12f92e5SBarry Smith #define MATORDERING_ROWLENGTH "rowlength" 93262152c8bSBarry Smith #define MATORDERING_DSC_ND "dsc_nd" 93362152c8bSBarry Smith #define MATORDERING_DSC_MMD "dsc_mmd" 93462152c8bSBarry Smith #define MATORDERING_DSC_MDF "dsc_mdf" 935c06d978dSMatthew Knepley #define MATORDERING_CONSTRAINED "constrained" 936c06d978dSMatthew Knepley #define MATORDERING_IDENTITY "identity" 937c06d978dSMatthew Knepley #define MATORDERING_REVERSE "reverse" 938b12f92e5SBarry Smith 939be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrdering(Mat,const MatOrderingType,IS*,IS*); 940be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrderingList(PetscFList *list); 941be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*)); 94230de9b25SBarry Smith 94330de9b25SBarry Smith /*MC 94430de9b25SBarry Smith MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the 94530de9b25SBarry Smith matrix package. 94630de9b25SBarry Smith 94730de9b25SBarry Smith Synopsis: 948c1ac3661SBarry Smith PetscErrorCode MatOrderingRegisterDynamic(char *name_ordering,char *path,char *name_create,PetscErrorCode (*routine_create)(MatOrdering)) 94930de9b25SBarry Smith 95030de9b25SBarry Smith Not Collective 95130de9b25SBarry Smith 95230de9b25SBarry Smith Input Parameters: 95330de9b25SBarry Smith + sname - name of ordering (for example MATORDERING_ND) 95430de9b25SBarry Smith . path - location of library where creation routine is 95530de9b25SBarry Smith . name - name of function that creates the ordering type,a string 95630de9b25SBarry Smith - function - function pointer that creates the ordering 95730de9b25SBarry Smith 95830de9b25SBarry Smith Level: developer 95930de9b25SBarry Smith 96030de9b25SBarry Smith If dynamic libraries are used, then the fourth input argument (function) 96130de9b25SBarry Smith is ignored. 96230de9b25SBarry Smith 96330de9b25SBarry Smith Sample usage: 96430de9b25SBarry Smith .vb 96530de9b25SBarry Smith MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a, 96630de9b25SBarry Smith "MyOrder",MyOrder); 96730de9b25SBarry Smith .ve 96830de9b25SBarry Smith 96930de9b25SBarry Smith Then, your partitioner can be chosen with the procedural interface via 97030de9b25SBarry Smith $ MatOrderingSetType(part,"my_order) 97130de9b25SBarry Smith or at runtime via the option 9722401956bSBarry Smith $ -pc_factor_mat_ordering_type my_order 97330de9b25SBarry Smith 974ab901514SBarry Smith ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values. 97530de9b25SBarry Smith 97630de9b25SBarry Smith .keywords: matrix, ordering, register 97730de9b25SBarry Smith 97830de9b25SBarry Smith .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll() 97930de9b25SBarry Smith M*/ 980aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 981f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0) 982b12f92e5SBarry Smith #else 983f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d) 984b12f92e5SBarry Smith #endif 98530de9b25SBarry Smith 986be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterDestroy(void); 987be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterAll(const char[]); 9882bad1931SBarry Smith extern PetscTruth MatOrderingRegisterAllCalled; 989b0a32e0cSBarry Smith extern PetscFList MatOrderingList; 990d4fbbf0eSBarry Smith 991be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS); 992a2ce50c7SBarry Smith 993d91e6319SBarry Smith /*S 9942401956bSBarry Smith MatFactorInfo - Data passed into the matrix factorization routines 995b00f7748SHong Zhang 99615e8a5b3SHong Zhang In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE 997b00f7748SHong Zhang 99815e8a5b3SHong Zhang Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC. 999b00f7748SHong Zhang 1000b00f7748SHong Zhang Level: developer 1001b00f7748SHong Zhang 1002d7d82daaSBarry Smith .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(), 1003d7d82daaSBarry Smith MatFactorInfoInitialize() 1004b00f7748SHong Zhang 1005b00f7748SHong Zhang S*/ 1006b00f7748SHong Zhang typedef struct { 10070a29876aSHong Zhang PetscReal shiftnz; /* scaling of identity added to matrix to prevent zero pivots */ 1008fbf22428SSatish Balay PetscReal shiftpd; /* if true, shift until positive pivots */ 10092cea7109SBarry Smith PetscReal shift_fraction; /* record shift fraction taken */ 101015e8a5b3SHong Zhang PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */ 101115e8a5b3SHong Zhang PetscReal dt; /* drop tolerance */ 1012b00f7748SHong Zhang PetscReal dtcol; /* tolerance for pivoting */ 101315e8a5b3SHong Zhang PetscReal dtcount; /* maximum nonzeros to be allowed per row */ 101467e28bfeSBarry Smith PetscReal fill; /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */ 1015348344bbSBarry Smith PetscReal levels; /* ICC/ILU(levels) */ 1016bcd9e38bSBarry Smith PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0 1017bcd9e38bSBarry Smith factorization may be faster if do not pivot */ 101815e8a5b3SHong Zhang PetscReal zeropivot; /* pivot is called zero if less than this */ 101915e8a5b3SHong Zhang } MatFactorInfo; 1020ffa6d0a5SLois Curfman McInnes 1021be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorInfoInitialize(MatFactorInfo*); 1022be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactor(Mat,IS,MatFactorInfo*); 1023be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*); 1024be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorNumeric(Mat,MatFactorInfo*,Mat*); 1025be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactor(Mat,IS,IS,MatFactorInfo*); 1026be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactor(Mat,IS,IS,MatFactorInfo*); 1027be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*); 1028be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*); 1029be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*); 1030be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactor(Mat,IS,MatFactorInfo*); 1031be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorNumeric(Mat,MatFactorInfo*,Mat*); 1032be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUDTFactor(Mat,IS,IS,MatFactorInfo*,Mat *); 1033be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*); 1034be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolve(Mat,Vec,Vec); 1035be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatForwardSolve(Mat,Vec,Vec); 1036be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBackwardSolve(Mat,Vec,Vec); 1037be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveAdd(Mat,Vec,Vec,Vec); 1038be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTranspose(Mat,Vec,Vec); 1039be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTransposeAdd(Mat,Vec,Vec,Vec); 1040be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolves(Mat,Vecs,Vecs); 10418ed539a5SBarry Smith 1042be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUnfactored(Mat); 1043bb5a7306SBarry Smith 1044d91e6319SBarry Smith /*E 1045d91e6319SBarry Smith MatSORType - What type of (S)SOR to perform 1046bb1eb677SSatish Balay 1047d91e6319SBarry Smith Level: beginner 1048d91e6319SBarry Smith 1049d9274352SBarry Smith May be bitwise ORd together 1050d9274352SBarry Smith 1051d91e6319SBarry Smith Any additions/changes here MUST also be made in include/finclude/petscmat.h 1052d91e6319SBarry Smith 10534e7234bfSBarry Smith MatSORType may be bitwise ORd together, so do not change the numbers 10544e7234bfSBarry Smith 1055a1d92eedSBarry Smith .seealso: MatRelax(), MatPBRelax() 1056d91e6319SBarry Smith E*/ 1057ee50ffe9SBarry Smith typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3, 1058ee50ffe9SBarry Smith SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8, 1059ee50ffe9SBarry Smith SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16, 106084cb2905SBarry Smith SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType; 1061be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec); 1062be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPBRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec); 10638ed539a5SBarry Smith 1064d4fbbf0eSBarry Smith /* 1065639f9d9dSBarry Smith These routines are for efficiently computing Jacobians via finite differences. 1066639f9d9dSBarry Smith */ 1067b12f92e5SBarry Smith 1068d9274352SBarry Smith /*E 1069d9274352SBarry Smith MatColoringType - String with the name of a PETSc matrix coloring or the creation function 1070d9274352SBarry Smith with an optional dynamic library name, for example 1071d9274352SBarry Smith http://www.mcs.anl.gov/petsc/lib.a:coloringcreate() 1072d9274352SBarry Smith 1073d9274352SBarry Smith Level: beginner 1074d9274352SBarry Smith 1075d9274352SBarry Smith .seealso: MatGetColoring() 1076d9274352SBarry Smith E*/ 1077e5a9bf91SBarry Smith #define MatColoringType const char* 1078b12f92e5SBarry Smith #define MATCOLORING_NATURAL "natural" 1079b12f92e5SBarry Smith #define MATCOLORING_SL "sl" 1080b12f92e5SBarry Smith #define MATCOLORING_LF "lf" 1081b12f92e5SBarry Smith #define MATCOLORING_ID "id" 1082b12f92e5SBarry Smith 10832e90c967SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColoring(Mat,MatColoringType,ISColoring*); 10842e90c967SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,MatColoringType,ISColoring *)); 108530de9b25SBarry Smith 108630de9b25SBarry Smith /*MC 108730de9b25SBarry Smith MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the 108830de9b25SBarry Smith matrix package. 108930de9b25SBarry Smith 109030de9b25SBarry Smith Synopsis: 1091c1ac3661SBarry Smith PetscErrorCode MatColoringRegisterDynamic(char *name_coloring,char *path,char *name_create,PetscErrorCode (*routine_create)(MatColoring)) 109230de9b25SBarry Smith 109330de9b25SBarry Smith Not Collective 109430de9b25SBarry Smith 109530de9b25SBarry Smith Input Parameters: 109630de9b25SBarry Smith + sname - name of Coloring (for example MATCOLORING_SL) 109730de9b25SBarry Smith . path - location of library where creation routine is 109830de9b25SBarry Smith . name - name of function that creates the Coloring type, a string 109930de9b25SBarry Smith - function - function pointer that creates the coloring 110030de9b25SBarry Smith 110130de9b25SBarry Smith Level: developer 110230de9b25SBarry Smith 110330de9b25SBarry Smith If dynamic libraries are used, then the fourth input argument (function) 110430de9b25SBarry Smith is ignored. 110530de9b25SBarry Smith 110630de9b25SBarry Smith Sample usage: 110730de9b25SBarry Smith .vb 110830de9b25SBarry Smith MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a, 110930de9b25SBarry Smith "MyColor",MyColor); 111030de9b25SBarry Smith .ve 111130de9b25SBarry Smith 111230de9b25SBarry Smith Then, your partitioner can be chosen with the procedural interface via 111330de9b25SBarry Smith $ MatColoringSetType(part,"my_color") 111430de9b25SBarry Smith or at runtime via the option 111530de9b25SBarry Smith $ -mat_coloring_type my_color 111630de9b25SBarry Smith 1117ab901514SBarry Smith $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 111830de9b25SBarry Smith 111930de9b25SBarry Smith .keywords: matrix, Coloring, register 112030de9b25SBarry Smith 112130de9b25SBarry Smith .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll() 112230de9b25SBarry Smith M*/ 1123aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1124f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0) 1125b12f92e5SBarry Smith #else 1126f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d) 1127b12f92e5SBarry Smith #endif 112830de9b25SBarry Smith 11292bad1931SBarry Smith extern PetscTruth MatColoringRegisterAllCalled; 1130f1144a30SSatish Balay 1131be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterAll(const char[]); 1132be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterDestroy(void); 1133be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*); 1134639f9d9dSBarry Smith 1135d9274352SBarry Smith /*S 1136d9274352SBarry Smith MatFDColoring - Object for computing a sparse Jacobian via finite differences 1137d9274352SBarry Smith and coloring 1138639f9d9dSBarry Smith 1139d9274352SBarry Smith Level: beginner 1140d9274352SBarry Smith 1141d9274352SBarry Smith Concepts: coloring, sparse Jacobian, finite differences 1142d9274352SBarry Smith 1143d9274352SBarry Smith .seealso: MatFDColoringCreate() 1144d9274352SBarry Smith S*/ 1145e2a1c21fSSatish Balay typedef struct _p_MatFDColoring* MatFDColoring; 1146639f9d9dSBarry Smith 1147be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringCreate(Mat,ISColoring,MatFDColoring *); 1148be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringDestroy(MatFDColoring); 1149be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringView(MatFDColoring,PetscViewer); 1150be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*); 11514a9d489dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**); 1152be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal); 1153be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFrequency(MatFDColoring,PetscInt); 1154be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFrequency(MatFDColoring,PetscInt*); 1155be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFromOptions(MatFDColoring); 1156be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *); 1157be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *); 1158be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetRecompute(MatFDColoring); 1159be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetF(MatFDColoring,Vec); 1160be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]); 1161639f9d9dSBarry Smith /* 11620752156aSBarry Smith These routines are for partitioning matrices: currently used only 11633eda8832SBarry Smith for adjacency matrix, MatCreateMPIAdj(). 11640752156aSBarry Smith */ 1165ca161407SBarry Smith 1166d9274352SBarry Smith /*S 1167d9274352SBarry Smith MatPartitioning - Object for managing the partitioning of a matrix or graph 1168d9274352SBarry Smith 1169d9274352SBarry Smith Level: beginner 1170d9274352SBarry Smith 1171d9274352SBarry Smith Concepts: partitioning 1172d9274352SBarry Smith 1173743a1026Svictorle .seealso: MatPartitioningCreate(), MatPartitioningType 1174d9274352SBarry Smith S*/ 117591e9ee9fSBarry Smith typedef struct _p_MatPartitioning* MatPartitioning; 1176d9274352SBarry Smith 1177d9274352SBarry Smith /*E 11785bc6e7ccSvictorle MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function 1179d9274352SBarry Smith with an optional dynamic library name, for example 1180d9274352SBarry Smith http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate() 1181d9274352SBarry Smith 1182d9274352SBarry Smith Level: beginner 1183d9274352SBarry Smith 1184b547a13bSvictorle .seealso: MatPartitioningCreate(), MatPartitioning 1185d9274352SBarry Smith E*/ 1186e5a9bf91SBarry Smith #define MatPartitioningType const char* 11878ba1e511SMatthew Knepley #define MAT_PARTITIONING_CURRENT "current" 1188c2ec2a73SHong Zhang #define MAT_PARTITIONING_SQUARE "square" 11898ba1e511SMatthew Knepley #define MAT_PARTITIONING_PARMETIS "parmetis" 119071306c60Sjroman #define MAT_PARTITIONING_CHACO "chaco" 119171306c60Sjroman #define MAT_PARTITIONING_JOSTLE "jostle" 119271306c60Sjroman #define MAT_PARTITIONING_PARTY "party" 119371306c60Sjroman #define MAT_PARTITIONING_SCOTCH "scotch" 119471306c60Sjroman 1195ca161407SBarry Smith 1196be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningCreate(MPI_Comm,MatPartitioning*); 11972e90c967SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetType(MatPartitioning,MatPartitioningType); 1198be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetNParts(MatPartitioning,PetscInt); 1199be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetAdjacency(MatPartitioning,Mat); 1200be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]); 1201be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []); 1202be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningApply(MatPartitioning,IS*); 1203be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningDestroy(MatPartitioning); 12042aabb6bbSBarry Smith 1205be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning)); 120630de9b25SBarry Smith 120730de9b25SBarry Smith /*MC 120830de9b25SBarry Smith MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the 120930de9b25SBarry Smith matrix package. 121030de9b25SBarry Smith 121130de9b25SBarry Smith Synopsis: 1212c1ac3661SBarry Smith PetscErrorCode MatPartitioningRegisterDynamic(char *name_partitioning,char *path,char *name_create,PetscErrorCode (*routine_create)(MatPartitioning)) 121330de9b25SBarry Smith 121430de9b25SBarry Smith Not Collective 121530de9b25SBarry Smith 121630de9b25SBarry Smith Input Parameters: 121730de9b25SBarry Smith + sname - name of partitioning (for example MAT_PARTITIONING_CURRENT) or parmetis 121830de9b25SBarry Smith . path - location of library where creation routine is 121930de9b25SBarry Smith . name - name of function that creates the partitioning type, a string 122030de9b25SBarry Smith - function - function pointer that creates the partitioning type 122130de9b25SBarry Smith 122230de9b25SBarry Smith Level: developer 122330de9b25SBarry Smith 122430de9b25SBarry Smith If dynamic libraries are used, then the fourth input argument (function) 122530de9b25SBarry Smith is ignored. 122630de9b25SBarry Smith 122730de9b25SBarry Smith Sample usage: 122830de9b25SBarry Smith .vb 122930de9b25SBarry Smith MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a, 123030de9b25SBarry Smith "MyPartCreate",MyPartCreate); 123130de9b25SBarry Smith .ve 123230de9b25SBarry Smith 123330de9b25SBarry Smith Then, your partitioner can be chosen with the procedural interface via 123430de9b25SBarry Smith $ MatPartitioningSetType(part,"my_part") 123530de9b25SBarry Smith or at runtime via the option 123630de9b25SBarry Smith $ -mat_partitioning_type my_part 123730de9b25SBarry Smith 1238ab901514SBarry Smith $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 123930de9b25SBarry Smith 124030de9b25SBarry Smith .keywords: matrix, partitioning, register 124130de9b25SBarry Smith 124230de9b25SBarry Smith .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll() 124330de9b25SBarry Smith M*/ 1244aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1245f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0) 12462aabb6bbSBarry Smith #else 1247f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d) 12482aabb6bbSBarry Smith #endif 12492aabb6bbSBarry Smith 12502bad1931SBarry Smith extern PetscTruth MatPartitioningRegisterAllCalled; 1251f1144a30SSatish Balay 1252be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterAll(const char[]); 1253be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterDestroy(void); 12542bad1931SBarry Smith 1255be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningView(MatPartitioning,PetscViewer); 1256be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetFromOptions(MatPartitioning); 1257be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningGetType(MatPartitioning,MatPartitioningType*); 1258ca161407SBarry Smith 1259be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisSetCoarseSequential(MatPartitioning); 12600752156aSBarry Smith 1261be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal); 1262be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseSequential(MatPartitioning); 126371306c60Sjroman 1264954b3ec6SBarry Smith typedef enum {MP_CHACO_MULTILEVEL_KL,MP_CHACO_SPECTRAL,MP_CHACO_LINEAR,MP_CHACO_RANDOM, MP_CHACO_SCATTERED} MPChacoGlobalType; 1265be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType); 126671306c60Sjroman typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType; 1267be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType); 1268be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal); 126971306c60Sjroman typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType; 1270be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType); 1271be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal); 1272be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt); 127371306c60Sjroman 127471306c60Sjroman #define MP_PARTY_OPT "opt" 127571306c60Sjroman #define MP_PARTY_LIN "lin" 127671306c60Sjroman #define MP_PARTY_SCA "sca" 127771306c60Sjroman #define MP_PARTY_RAN "ran" 127871306c60Sjroman #define MP_PARTY_GBF "gbf" 127971306c60Sjroman #define MP_PARTY_GCF "gcf" 128071306c60Sjroman #define MP_PARTY_BUB "bub" 128171306c60Sjroman #define MP_PARTY_DEF "def" 1282be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetGlobal(MatPartitioning, const char*); 128371306c60Sjroman #define MP_PARTY_HELPFUL_SETS "hs" 128471306c60Sjroman #define MP_PARTY_KERNIGHAN_LIN "kl" 128571306c60Sjroman #define MP_PARTY_NONE "no" 1286be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetLocal(MatPartitioning, const char*); 1287be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal); 1288be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetBipart(MatPartitioning,PetscTruth); 1289be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscTruth); 129071306c60Sjroman 129171306c60Sjroman typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType; 1292be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetArch(MatPartitioning,const char*); 1293be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMultilevel(MatPartitioning); 1294be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType); 1295be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal); 1296be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetHostList(MatPartitioning,const char*); 129771306c60Sjroman typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType; 1298be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType); 1299be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMapping(MatPartitioning); 1300be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetStrategy(MatPartitioning,char*); 130171306c60Sjroman 13020752156aSBarry Smith /* 13030a835dfdSSatish Balay If you add entries here you must also add them to finclude/petscmat.h 1304d4fbbf0eSBarry Smith */ 13051c1c02c0SLois Curfman McInnes typedef enum { MATOP_SET_VALUES=0, 13061c1c02c0SLois Curfman McInnes MATOP_GET_ROW=1, 13071c1c02c0SLois Curfman McInnes MATOP_RESTORE_ROW=2, 13081c1c02c0SLois Curfman McInnes MATOP_MULT=3, 13091c1c02c0SLois Curfman McInnes MATOP_MULT_ADD=4, 13107c922b88SBarry Smith MATOP_MULT_TRANSPOSE=5, 13117c922b88SBarry Smith MATOP_MULT_TRANSPOSE_ADD=6, 13121c1c02c0SLois Curfman McInnes MATOP_SOLVE=7, 13131c1c02c0SLois Curfman McInnes MATOP_SOLVE_ADD=8, 13147c922b88SBarry Smith MATOP_SOLVE_TRANSPOSE=9, 13157c922b88SBarry Smith MATOP_SOLVE_TRANSPOSE_ADD=10, 13161c1c02c0SLois Curfman McInnes MATOP_LUFACTOR=11, 13171c1c02c0SLois Curfman McInnes MATOP_CHOLESKYFACTOR=12, 13181c1c02c0SLois Curfman McInnes MATOP_RELAX=13, 13191c1c02c0SLois Curfman McInnes MATOP_TRANSPOSE=14, 13201c1c02c0SLois Curfman McInnes MATOP_GETINFO=15, 13211c1c02c0SLois Curfman McInnes MATOP_EQUAL=16, 13221c1c02c0SLois Curfman McInnes MATOP_GET_DIAGONAL=17, 13231c1c02c0SLois Curfman McInnes MATOP_DIAGONAL_SCALE=18, 13241c1c02c0SLois Curfman McInnes MATOP_NORM=19, 13251c1c02c0SLois Curfman McInnes MATOP_ASSEMBLY_BEGIN=20, 13261c1c02c0SLois Curfman McInnes MATOP_ASSEMBLY_END=21, 13271c1c02c0SLois Curfman McInnes MATOP_COMPRESS=22, 13281c1c02c0SLois Curfman McInnes MATOP_SET_OPTION=23, 13291c1c02c0SLois Curfman McInnes MATOP_ZERO_ENTRIES=24, 13301c1c02c0SLois Curfman McInnes MATOP_ZERO_ROWS=25, 13311c1c02c0SLois Curfman McInnes MATOP_LUFACTOR_SYMBOLIC=26, 13321c1c02c0SLois Curfman McInnes MATOP_LUFACTOR_NUMERIC=27, 13331c1c02c0SLois Curfman McInnes MATOP_CHOLESKY_FACTOR_SYMBOLIC=28, 13341c1c02c0SLois Curfman McInnes MATOP_CHOLESKY_FACTOR_NUMERIC=29, 1335d643ce63SMatthew Knepley MATOP_SETUP_PREALLOCATION=30, 1336d643ce63SMatthew Knepley MATOP_ILUFACTOR_SYMBOLIC=31, 1337d643ce63SMatthew Knepley MATOP_ICCFACTOR_SYMBOLIC=32, 1338d643ce63SMatthew Knepley MATOP_GET_ARRAY=33, 1339d643ce63SMatthew Knepley MATOP_RESTORE_ARRAY=34, 1340e26f1c3cSBarry Smith MATOP_DUPLICATE=35, 1341d643ce63SMatthew Knepley MATOP_FORWARD_SOLVE=36, 1342d643ce63SMatthew Knepley MATOP_BACKWARD_SOLVE=37, 1343d643ce63SMatthew Knepley MATOP_ILUFACTOR=38, 1344d643ce63SMatthew Knepley MATOP_ICCFACTOR=39, 1345d643ce63SMatthew Knepley MATOP_AXPY=40, 1346d643ce63SMatthew Knepley MATOP_GET_SUBMATRICES=41, 1347d643ce63SMatthew Knepley MATOP_INCREASE_OVERLAP=42, 1348d643ce63SMatthew Knepley MATOP_GET_VALUES=43, 1349d643ce63SMatthew Knepley MATOP_COPY=44, 1350d643ce63SMatthew Knepley MATOP_PRINT_HELP=45, 1351d643ce63SMatthew Knepley MATOP_SCALE=46, 1352d643ce63SMatthew Knepley MATOP_SHIFT=47, 1353d643ce63SMatthew Knepley MATOP_DIAGONAL_SHIFT=48, 1354d643ce63SMatthew Knepley MATOP_ILUDT_FACTOR=49, 1355d643ce63SMatthew Knepley MATOP_GET_BLOCK_SIZE=50, 1356d643ce63SMatthew Knepley MATOP_GET_ROW_IJ=51, 1357d643ce63SMatthew Knepley MATOP_RESTORE_ROW_IJ=52, 1358d643ce63SMatthew Knepley MATOP_GET_COLUMN_IJ=53, 1359d643ce63SMatthew Knepley MATOP_RESTORE_COLUMN_IJ=54, 1360d643ce63SMatthew Knepley MATOP_FDCOLORING_CREATE=55, 1361d643ce63SMatthew Knepley MATOP_COLORING_PATCH=56, 1362d643ce63SMatthew Knepley MATOP_SET_UNFACTORED=57, 1363d643ce63SMatthew Knepley MATOP_PERMUTE=58, 1364d643ce63SMatthew Knepley MATOP_SET_VALUES_BLOCKED=59, 1365d643ce63SMatthew Knepley MATOP_GET_SUBMATRIX=60, 1366d643ce63SMatthew Knepley MATOP_DESTROY=61, 1367d643ce63SMatthew Knepley MATOP_VIEW=62, 1368d643ce63SMatthew Knepley MATOP_GET_MAPS=63, 1369d643ce63SMatthew Knepley MATOP_USE_SCALED_FORM=64, 1370d643ce63SMatthew Knepley MATOP_SCALE_SYSTEM=65, 1371d643ce63SMatthew Knepley MATOP_UNSCALE_SYSTEM=66, 1372ba16a8cbSKris Buschelman MATOP_SET_LOCAL_TO_GLOBAL_MAP=67, 1373d643ce63SMatthew Knepley MATOP_SET_VALUES_LOCAL=68, 1374d643ce63SMatthew Knepley MATOP_ZERO_ROWS_LOCAL=69, 1375d643ce63SMatthew Knepley MATOP_GET_ROW_MAX=70, 1376d643ce63SMatthew Knepley MATOP_CONVERT=71, 1377d643ce63SMatthew Knepley MATOP_SET_COLORING=72, 1378d643ce63SMatthew Knepley MATOP_SET_VALUES_ADIC=73, 1379d643ce63SMatthew Knepley MATOP_SET_VALUES_ADIFOR=74, 1380d643ce63SMatthew Knepley MATOP_FD_COLORING_APPLY=75, 1381d643ce63SMatthew Knepley MATOP_SET_FROM_OPTIONS=76, 1382ba16a8cbSKris Buschelman MATOP_MULT_CON=77, 1383ba16a8cbSKris Buschelman MATOP_MULT_TRANSPOSE_CON=78, 1384ba16a8cbSKris Buschelman MATOP_ILU_FACTOR_SYMBOLIC_CON=79, 1385d643ce63SMatthew Knepley MATOP_PERMUTE_SPARSIFY=80, 1386d643ce63SMatthew Knepley MATOP_MULT_MULTIPLE=81, 138741acf15aSKris Buschelman MATOP_SOLVE_MULTIPLE=82, 138841acf15aSKris Buschelman MATOP_GET_INERTIA=83, 138941acf15aSKris Buschelman MATOP_LOAD=84, 139041acf15aSKris Buschelman MATOP_IS_SYMMETRIC=85, 139141acf15aSKris Buschelman MATOP_IS_HERMITIAN=86, 139241acf15aSKris Buschelman MATOP_IS_STRUCTURALLY_SYMMETRIC=87, 139341acf15aSKris Buschelman MATOP_PB_RELAX=88, 139441acf15aSKris Buschelman MATOP_GET_VECS=89, 139541acf15aSKris Buschelman MATOP_MAT_MULT=90, 139641acf15aSKris Buschelman MATOP_MAT_MULT_SYMBOLIC=91, 139741acf15aSKris Buschelman MATOP_MAT_MULT_NUMERIC=92, 139841acf15aSKris Buschelman MATOP_PTAP=93, 139941acf15aSKris Buschelman MATOP_PTAP_SYMBOLIC=94, 1400bc011b1eSHong Zhang MATOP_PTAP_NUMERIC=95, 1401bc011b1eSHong Zhang MATOP_MAT_MULTTRANSPOSE=96, 1402bc011b1eSHong Zhang MATOP_MAT_MULTTRANSPOSE_SYMBOLIC=97, 14037ba1a0bfSKris Buschelman MATOP_MAT_MULTTRANSPOSE_NUMERIC=98, 14047ba1a0bfSKris Buschelman MATOP_PTAP_SYMBOLIC_SEQAIJ=99, 14057ba1a0bfSKris Buschelman MATOP_PTAP_NUMERIC_SEQAIJ=100, 14067ba1a0bfSKris Buschelman MATOP_PTAP_SYMBOLIC_MPIAIJ=101, 140787d4246cSBarry Smith MATOP_PTAP_NUMERIC_MPIAIJ=102, 1408f5edf698SHong Zhang MATOP_SET_VALUES_ROW = 105, 1409d5c63f83SSatish Balay MATOP_GET_ROW_UTRIANGULAR=108, 14102bebee5dSHong Zhang MATOP_RESTORE_ROW_UTRIANGULAR=109, 141169db28dcSHong Zhang MATOP_MATSOLVE=110, 141269db28dcSHong Zhang MATOP_GET_REDUNDANTMATRIX=111 1413fae171e0SBarry Smith } MatOperation; 1414be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHasOperation(Mat,MatOperation,PetscTruth*); 1415be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetOperation(Mat,MatOperation,void(*)(void)); 1416be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetOperation(Mat,MatOperation,void(**)(void)); 1417be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetContext(Mat,void*); 1418112a2221SBarry Smith 141990ace30eSBarry Smith /* 142090ace30eSBarry Smith Codes for matrices stored on disk. By default they are 142190ace30eSBarry Smith stored in a universal format. By changing the format with 1422fb9695e5SSatish Balay PetscViewerSetFormat(viewer,PETSC_VIEWER_BINARY_NATIVE); the matrices will 142390ace30eSBarry Smith be stored in a way natural for the matrix, for example dense matrices 142490ace30eSBarry Smith would be stored as dense. Matrices stored this way may only be 142590ace30eSBarry Smith read into matrices of the same time. 142690ace30eSBarry Smith */ 142790ace30eSBarry Smith #define MATRIX_BINARY_FORMAT_DENSE -1 142890ace30eSBarry Smith 1429be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetHashTableFactor(Mat,PetscReal); 1430be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatISGetLocalMat(Mat,Mat*); 14311f4e1ec7SBarry Smith 1432d9274352SBarry Smith /*S 1433d9274352SBarry Smith MatNullSpace - Object that removes a null space from a vector, i.e. 1434d9274352SBarry Smith orthogonalizes the vector to a subsapce 1435d9274352SBarry Smith 1436f7a9e4ceSBarry Smith Level: advanced 1437d9274352SBarry Smith 1438d9274352SBarry Smith Concepts: matrix; linear operator, null space 1439d9274352SBarry Smith 14406e1639daSBarry Smith Users manual sections: 14416e1639daSBarry Smith . sec_singular 14426e1639daSBarry Smith 1443d9274352SBarry Smith .seealso: MatNullSpaceCreate() 1444d9274352SBarry Smith S*/ 144574637425SBarry Smith typedef struct _p_MatNullSpace* MatNullSpace; 1446d9274352SBarry Smith 1447be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceCreate(MPI_Comm,PetscTruth,PetscInt,const Vec[],MatNullSpace*); 1448281d1b2eSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(Vec,void*),void*); 1449be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceDestroy(MatNullSpace); 1450be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceRemove(MatNullSpace,Vec,Vec*); 1451be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceAttach(Mat,MatNullSpace); 1452be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceTest(MatNullSpace,Mat); 145374637425SBarry Smith 1454be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderingSeqSBAIJ(Mat,IS); 1455be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetHashTableFactor(Mat,PetscReal); 1456be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetColumnIndices(Mat,PetscInt *); 145746129b97SKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJInvertBlockDiagonal(Mat); 14583f1d51d7SBarry Smith 1459be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMAIJ(Mat,PetscInt,Mat*); 1460be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJRedimension(Mat,PetscInt,Mat*); 1461be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJGetAIJ(Mat,Mat*); 1462c4f061fbSSatish Balay 1463be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatComputeExplicitOperator(Mat,Mat*); 1464b0a32e0cSBarry Smith 1465be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScaleLocal(Mat,Vec); 146604f1ad80SBarry Smith 1467be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *); 1468be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *); 14697dbadf16SMatthew Knepley 1470e9fa29b7SSatish Balay PETSC_EXTERN_CXX_END 14712eac72dbSBarry Smith #endif 1472