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*/ 29273d9f13SBarry Smith #define MATSAME "same" 30273d9f13SBarry Smith #define MATSEQMAIJ "seqmaij" 31273d9f13SBarry Smith #define MATMPIMAIJ "mpimaij" 32209238afSKris Buschelman #define MATMAIJ "maij" 33273d9f13SBarry Smith #define MATIS "is" 34273d9f13SBarry Smith #define MATMPIROWBS "mpirowbs" 35273d9f13SBarry Smith #define MATSEQAIJ "seqaij" 36273d9f13SBarry Smith #define MATMPIAIJ "mpiaij" 37209238afSKris Buschelman #define MATAIJ "aij" 38273d9f13SBarry Smith #define MATSHELL "shell" 39273d9f13SBarry Smith #define MATSEQBDIAG "seqbdiag" 40273d9f13SBarry Smith #define MATMPIBDIAG "mpibdiag" 41209238afSKris Buschelman #define MATBDIAG "bdiag" 42209238afSKris Buschelman #define MATSEQDENSE "seqdense" 43273d9f13SBarry Smith #define MATMPIDENSE "mpidense" 44209238afSKris Buschelman #define MATDENSE "dense" 45273d9f13SBarry Smith #define MATSEQBAIJ "seqbaij" 46273d9f13SBarry Smith #define MATMPIBAIJ "mpibaij" 47209238afSKris Buschelman #define MATBAIJ "baij" 48273d9f13SBarry Smith #define MATMPIADJ "mpiadj" 49273d9f13SBarry Smith #define MATSEQSBAIJ "seqsbaij" 50273d9f13SBarry Smith #define MATMPISBAIJ "mpisbaij" 51209238afSKris Buschelman #define MATSBAIJ "sbaij" 52cebc7f6cSBarry Smith #define MATDAAD "daad" 53cebc7f6cSBarry Smith #define MATMFFD "mffd" 54c8a8475eSBarry Smith #define MATNORMAL "normal" 55ab92ecdeSBarry Smith #define MATLRC "lrc" 56b3a1e11cSKris Buschelman #define MATSEQAIJSPOOLES "seqaijspooles" 57d10c748bSKris Buschelman #define MATMPIAIJSPOOLES "mpiaijspooles" 589abb65ffSKris Buschelman #define MATSEQSBAIJSPOOLES "seqsbaijspooles" 5922191285SKris Buschelman #define MATMPISBAIJSPOOLES "mpisbaijspooles" 60bb4d4166SHong Zhang #define MATAIJSPOOLES "aijspooles" 61bb4d4166SHong Zhang #define MATSBAIJSPOOLES "sbaijspooles" 6214b396bbSKris Buschelman #define MATSUPERLU "superlu" 631d96aa28SKris Buschelman #define MATSUPERLU_DIST "superlu_dist" 641677d0b8SKris Buschelman #define MATUMFPACK "umfpack" 65e8aa55a4SKris Buschelman #define MATESSL "essl" 664eb8e494SKris Buschelman #define MATLUSOL "lusol" 67397b6df1SKris Buschelman #define MATAIJMUMPS "aijmumps" 68397b6df1SKris Buschelman #define MATSBAIJMUMPS "sbaijmumps" 698da957c5SKris Buschelman #define MATDSCPACK "dscpack" 707065e2aaSKris Buschelman #define MATMATLAB "matlab" 714b8d99adSRichard Tran Mills #define MATSEQCSRPERM "seqcsrperm" 7218def556SRichard Tran Mills #define MATMPICSRPERM "mpicsrperm" 73814655b8SBarry Smith #define MATCSRPERM "csrperm" 7481824310SBarry Smith #define MATSEQCRL "seqcrl" 75c02b24c5SBarry Smith #define MATMPICRL "mpicrl" 76c02b24c5SBarry Smith #define MATCRL "crl" 77c0aa2d19SHong Zhang #define MATPLAPACK "plapack" 78f69a0ea3SMatthew Knepley #define MatType const char* 79d91e6319SBarry Smith 80c06d978dSMatthew Knepley /* Logging support */ 81552e946dSBarry Smith #define MAT_FILE_COOKIE 1211216 /* used to indicate matrices in binary files */ 82be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_COOKIE; 83be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_FDCOLORING_COOKIE; 84be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_PARTITIONING_COOKIE; 85be1d678aSKris Buschelman extern PetscCookie PETSCMAT_DLLEXPORT MAT_NULLSPACE_COOKIE; 86c06d978dSMatthew Knepley 87ceb03754SKris Buschelman /*E 88ceb03754SKris Buschelman MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices() 89ceb03754SKris Buschelman or MatGetSubMatrix() are to be reused to store the new matrix values. 90ceb03754SKris Buschelman 91ceb03754SKris Buschelman Level: beginner 92ceb03754SKris Buschelman 93ceb03754SKris Buschelman Any additions/changes here MUST also be made in include/finclude/petscmat.h 94ceb03754SKris Buschelman 950c451bc4SBarry Smith .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert() 96ceb03754SKris Buschelman E*/ 97ceb03754SKris Buschelman typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX} MatReuse; 98ceb03754SKris Buschelman 99be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInitializePackage(char *); 100c06d978dSMatthew Knepley 101f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreate(MPI_Comm,Mat*); 102a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(MPI_Comm comm),(comm,&A),Mat,A) 103a69a960dSMatthew Knepley PetscPolymorphicFunction(MatCreate,(),(PETSC_COMM_WORLD,&A),Mat,A) 104f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt); 105f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetType(Mat,MatType); 106be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetFromOptions(Mat); 107be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUpPreallocation(Mat); 108be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegisterAll(const char[]); 109be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat)); 11030de9b25SBarry Smith 111f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOptionsPrefix(Mat,const char[]); 112f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAppendOptionsPrefix(Mat,const char[]); 113f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOptionsPrefix(Mat,const char*[]); 114f69a0ea3SMatthew Knepley 11530de9b25SBarry Smith /*MC 11630de9b25SBarry Smith MatRegisterDynamic - Adds a new matrix type 11730de9b25SBarry Smith 11830de9b25SBarry Smith Synopsis: 119c1ac3661SBarry Smith PetscErrorCode MatRegisterDynamic(char *name,char *path,char *name_create,PetscErrorCode (*routine_create)(Mat)) 12030de9b25SBarry Smith 12130de9b25SBarry Smith Not Collective 12230de9b25SBarry Smith 12330de9b25SBarry Smith Input Parameters: 12430de9b25SBarry Smith + name - name of a new user-defined matrix type 12530de9b25SBarry Smith . path - path (either absolute or relative) the library containing this solver 12630de9b25SBarry Smith . name_create - name of routine to create method context 12730de9b25SBarry Smith - routine_create - routine to create method context 12830de9b25SBarry Smith 12930de9b25SBarry Smith Notes: 13030de9b25SBarry Smith MatRegisterDynamic() may be called multiple times to add several user-defined solvers. 13130de9b25SBarry Smith 13230de9b25SBarry Smith If dynamic libraries are used, then the fourth input argument (routine_create) 13330de9b25SBarry Smith is ignored. 13430de9b25SBarry Smith 13530de9b25SBarry Smith Sample usage: 13630de9b25SBarry Smith .vb 13730de9b25SBarry Smith MatRegisterDynamic("my_mat",/home/username/my_lib/lib/libO/solaris/mylib.a, 13830de9b25SBarry Smith "MyMatCreate",MyMatCreate); 13930de9b25SBarry Smith .ve 14030de9b25SBarry Smith 14130de9b25SBarry Smith Then, your solver can be chosen with the procedural interface via 14230de9b25SBarry Smith $ MatSetType(Mat,"my_mat") 14330de9b25SBarry Smith or at runtime via the option 14430de9b25SBarry Smith $ -mat_type my_mat 14530de9b25SBarry Smith 14630de9b25SBarry Smith Level: advanced 14730de9b25SBarry Smith 148ab901514SBarry Smith Notes: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values. 14930de9b25SBarry Smith If your function is not being put into a shared library then use VecRegister() instead 15030de9b25SBarry Smith 15130de9b25SBarry Smith .keywords: Mat, register 15230de9b25SBarry Smith 15330de9b25SBarry Smith .seealso: MatRegisterAll(), MatRegisterDestroy() 15430de9b25SBarry Smith 15530de9b25SBarry Smith M*/ 156273d9f13SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 157273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,0) 158273d9f13SBarry Smith #else 159273d9f13SBarry Smith #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,d) 16030de9b25SBarry Smith #endif 16130de9b25SBarry Smith 162273d9f13SBarry Smith extern PetscTruth MatRegisterAllCalled; 163b0a32e0cSBarry Smith extern PetscFList MatList; 16428988994SBarry Smith 165be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*); 166be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*); 167be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 168ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,nz,nnz,&A),Mat,A) 169ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,&A),Mat,A) 170ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,0,nnz,&A),Mat,A) 171ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,&A),Mat,A) 172ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,A)) 173ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,m,n,0,nnz,A)) 174ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,A)) 175be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 176ba966639SSatish 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) 177ba966639SSatish 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) 178ba966639SSatish 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) 179ba966639SSatish 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) 180ba966639SSatish 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)) 181ba966639SSatish 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)) 182ba966639SSatish 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)) 183ba966639SSatish 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) 184ba966639SSatish 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) 185ba966639SSatish 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) 186ba966639SSatish 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) 187ba966639SSatish 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)) 188ba966639SSatish 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)) 189ba966639SSatish 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)) 190be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIRowbs(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 191be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBDiag(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscScalar*[],Mat*); 192be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBDiag(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscScalar*[],Mat*); 193be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 194ba966639SSatish 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) 195ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A) 196ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A) 197ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A) 198ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A)) 199ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A)) 200ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A)) 201be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 202ba966639SSatish 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) 203ba966639SSatish 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) 204ba966639SSatish 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) 205ba966639SSatish 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) 206ba966639SSatish 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)) 207ba966639SSatish 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)) 208ba966639SSatish 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)) 209ba966639SSatish 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) 210ba966639SSatish 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) 211ba966639SSatish 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) 212ba966639SSatish 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) 213ba966639SSatish 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)) 214ba966639SSatish 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)) 215ba966639SSatish 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)) 216be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*); 217be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 218ba966639SSatish 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) 219ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A) 220ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A) 221ba966639SSatish Balay PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A) 222ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A)) 223ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A)) 224ba966639SSatish Balay PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A)) 225be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPISBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 226ba966639SSatish 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) 227ba966639SSatish 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) 228ba966639SSatish 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) 229ba966639SSatish 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) 230ba966639SSatish 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)) 231ba966639SSatish 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)) 232ba966639SSatish 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)) 233ba966639SSatish 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) 234ba966639SSatish 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) 235ba966639SSatish 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) 236ba966639SSatish 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) 237ba966639SSatish 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)) 238ba966639SSatish 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)) 239ba966639SSatish 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)) 240be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*); 241ba966639SSatish 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) 242ba966639SSatish Balay PetscPolymorphicFunction(MatCreateShell,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(PETSC_COMM_WORLD,m,n,M,N,ctx,&A),Mat,A) 243be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateAdic(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,void (*)(void),Mat*); 244be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateNormal(Mat,Mat*); 245ba966639SSatish Balay PetscPolymorphicFunction(MatCreateNormal,(Mat mat),(mat,&A),Mat,A) 246ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateLRC(Mat,Mat,Mat,Mat*); 247284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,Mat*); 2481472f72bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 2491472f72bSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPICRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 2501472f72bSBarry Smith 251f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUp(Mat); 252be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy(Mat); 25321c89e3eSBarry Smith 254be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPrintHelp(Mat); 255ec0117caSBarry Smith 2560c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConjugate(Mat); 25799cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRealPart(Mat); 25899cafbc1SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatImaginaryPart(Mat); 25999cafbc1SBarry Smith 2608ed539a5SBarry Smith /* ------------------------------------------------------------*/ 261be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 262be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 26387d4246cSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRow(Mat,PetscInt,const PetscScalar[]); 264f259bd47SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]); 26584cb2905SBarry Smith 2662ef4de8bSBarry Smith /*S 2672ef4de8bSBarry Smith MatStencil - Data structure (C struct) for storing information about a single row or 2682ef4de8bSBarry Smith column of a matrix as index on an associated grid. 2692ef4de8bSBarry Smith 2702ef4de8bSBarry Smith Level: beginner 2712ef4de8bSBarry Smith 2722ef4de8bSBarry Smith Concepts: matrix; linear operator 2732ef4de8bSBarry Smith 274d7bd93baSBarry Smith .seealso: MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockStencil() 2752ef4de8bSBarry Smith S*/ 276435da068SBarry Smith typedef struct { 277c1ac3661SBarry Smith PetscInt k,j,i,c; 278435da068SBarry Smith } MatStencil; 2792ef4de8bSBarry Smith 280be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode); 281be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode); 282be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt); 283435da068SBarry Smith 284be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetColoring(Mat,ISColoring); 285be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdic(Mat,void*); 286be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdifor(Mat,PetscInt,void*); 2873a7fca6bSBarry Smith 288d91e6319SBarry Smith /*E 289d91e6319SBarry Smith MatAssemblyType - Indicates if the matrix is now to be used, or if you plan 290d91e6319SBarry Smith to continue to add values to it 291d91e6319SBarry Smith 292d91e6319SBarry Smith Level: beginner 293d91e6319SBarry Smith 294d91e6319SBarry Smith .seealso: MatAssemblyBegin(), MatAssemblyEnd() 295d91e6319SBarry Smith E*/ 2966d4a8577SBarry Smith typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType; 297be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyBegin(Mat,MatAssemblyType); 298be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyEnd(Mat,MatAssemblyType); 299be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssembled(Mat,PetscTruth*); 3004f9c727eSBarry Smith 301be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscInt MatSetValue_Row; 302be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscInt MatSetValue_Column; 303be1d678aSKris Buschelman extern PETSCMAT_DLLEXPORT PetscScalar MatSetValue_Value; 3041d73ed98SBarry Smith 30530de9b25SBarry Smith /*MC 30630de9b25SBarry Smith MatSetValue - Set a single entry into a matrix. 30730de9b25SBarry Smith 30830de9b25SBarry Smith Synopsis: 309c1ac3661SBarry Smith PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode); 31030de9b25SBarry Smith 31130de9b25SBarry Smith Not collective 31230de9b25SBarry Smith 31330de9b25SBarry Smith Input Parameters: 31430de9b25SBarry Smith + m - the matrix 31530de9b25SBarry Smith . row - the row location of the entry 31630de9b25SBarry Smith . col - the column location of the entry 31730de9b25SBarry Smith . value - the value to insert 31830de9b25SBarry Smith - mode - either INSERT_VALUES or ADD_VALUES 31930de9b25SBarry Smith 32030de9b25SBarry Smith Notes: 32130de9b25SBarry Smith For efficiency one should use MatSetValues() and set several or many 32230de9b25SBarry Smith values simultaneously if possible. 32330de9b25SBarry Smith 32430de9b25SBarry Smith Level: beginner 32530de9b25SBarry Smith 32630de9b25SBarry Smith .seealso: MatSetValues(), MatSetValueLocal() 32730de9b25SBarry Smith M*/ 328b951964fSBarry Smith #define MatSetValue(v,i,j,va,mode) \ 329f1144a30SSatish Balay ((MatSetValue_Row = i,MatSetValue_Column = j,MatSetValue_Value = va,0) || \ 3301d73ed98SBarry Smith MatSetValues(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&MatSetValue_Value,mode)) 33130de9b25SBarry Smith 332ea06a074SBarry Smith #define MatGetValue(v,i,j,va) \ 333f1144a30SSatish Balay ((MatSetValue_Row = i,MatSetValue_Column = j,0) || \ 3341d73ed98SBarry Smith MatGetValues(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&va)) 33530de9b25SBarry Smith 336d91e6319SBarry Smith #define MatSetValueLocal(v,i,j,va,mode) \ 337f1144a30SSatish Balay ((MatSetValue_Row = i,MatSetValue_Column = j,MatSetValue_Value = va,0) || \ 3381d73ed98SBarry Smith MatSetValuesLocal(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&MatSetValue_Value,mode)) 33930de9b25SBarry Smith 340d91e6319SBarry Smith /*E 341d91e6319SBarry Smith MatOption - Options that may be set for a matrix and its behavior or storage 342d91e6319SBarry Smith 343d91e6319SBarry Smith Level: beginner 344d91e6319SBarry Smith 3450a835dfdSSatish Balay Any additions/changes here MUST also be made in include/finclude/petscmat.h 346d91e6319SBarry Smith 347d91e6319SBarry Smith .seealso: MatSetOption() 348d91e6319SBarry Smith E*/ 3496d4a8577SBarry Smith typedef enum {MAT_ROW_ORIENTED=1,MAT_COLUMN_ORIENTED=2,MAT_ROWS_SORTED=4, 3506d4a8577SBarry Smith MAT_COLUMNS_SORTED=8,MAT_NO_NEW_NONZERO_LOCATIONS=16, 3516d4a8577SBarry Smith MAT_YES_NEW_NONZERO_LOCATIONS=32,MAT_SYMMETRIC=64, 3526ca9ecd3SBarry Smith MAT_STRUCTURALLY_SYMMETRIC=65,MAT_NO_NEW_DIAGONALS=66, 3536ca9ecd3SBarry Smith MAT_YES_NEW_DIAGONALS=67,MAT_INODE_LIMIT_1=68,MAT_INODE_LIMIT_2=69, 3546ca9ecd3SBarry Smith MAT_INODE_LIMIT_3=70,MAT_INODE_LIMIT_4=71,MAT_INODE_LIMIT_5=72, 3556ca9ecd3SBarry Smith MAT_IGNORE_OFF_PROC_ENTRIES=73,MAT_ROWS_UNSORTED=74, 3564787f768SSatish Balay MAT_COLUMNS_UNSORTED=75,MAT_NEW_NONZERO_LOCATION_ERR=76, 3577c922b88SBarry Smith MAT_NEW_NONZERO_ALLOCATION_ERR=77,MAT_USE_HASH_TABLE=78, 3582bad1931SBarry Smith MAT_KEEP_ZEROED_ROWS=79,MAT_IGNORE_ZERO_ENTRIES=80,MAT_USE_INODES=81, 359efcf0fc3SBarry Smith MAT_DO_NOT_USE_INODES=82,MAT_NOT_SYMMETRIC=83,MAT_HERMITIAN=84, 3609a4540c5SBarry Smith MAT_NOT_STRUCTURALLY_SYMMETRIC=85,MAT_NOT_HERMITIAN=86, 361d487561eSHong Zhang MAT_SYMMETRY_ETERNAL=87,MAT_NOT_SYMMETRY_ETERNAL=88, 362941593c8SHong Zhang MAT_USE_COMPRESSEDROW=89,MAT_DO_NOT_USE_COMPRESSEDROW=90, 363f5edf698SHong Zhang MAT_IGNORE_LOWER_TRIANGULAR=91,MAT_ERROR_LOWER_TRIANGULAR=92,MAT_GETROW_UPPERTRIANGULAR=93} MatOption; 364be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOption(Mat,MatOption); 365be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetType(Mat,MatType*); 366ba966639SSatish Balay PetscPolymorphicFunction(MatGetType,(Mat mat),(mat,&t),MatType,t) 36784cb2905SBarry Smith 368be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]); 369be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 370be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 371f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowUpperTriangular(Mat); 372f5edf698SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowUpperTriangular(Mat); 373be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 374be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 375be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnVector(Mat,Vec,PetscInt); 376be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetArray(Mat,PetscScalar *[]); 377ba966639SSatish Balay PetscPolymorphicFunction(MatGetArray,(Mat mat),(mat,&a),PetscScalar*,a) 378be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreArray(Mat,PetscScalar *[]); 379be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBlockSize(Mat,PetscInt *); 380ba966639SSatish Balay PetscPolymorphicFunction(MatGetBlockSize,(Mat mat),(mat,&a),PetscInt,a) 381be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetBlockSize(Mat,PetscInt); 3827b80b807SBarry Smith 383be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMult(Mat,Vec,Vec); 384be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAdd(Mat,Vec,Vec,Vec); 385ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultAdd,(Mat A,Vec x,Vec y),(A,x,y,y)) 386be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTranspose(Mat,Vec,Vec); 387be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsTranspose(Mat,Mat,PetscReal,PetscTruth*); 388ba966639SSatish Balay PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B,PetscReal tol),(A,B,tol,&t),PetscTruth,t) 389e37f64cdSBarry Smith PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B),(A,B,0,&t),PetscTruth,t) 390be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAdd(Mat,Vec,Vec,Vec); 391ba966639SSatish Balay PetscPolymorphicSubroutine(MatMultTransposeAdd,(Mat A,Vec x,Vec y),(A,x,y,y)) 392be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultConstrained(Mat,Vec,Vec); 393be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeConstrained(Mat,Vec,Vec); 3942bebee5dSHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatSolve(Mat,Mat,Mat); 395f5edf698SHong Zhang 396d91e6319SBarry Smith /*E 397d91e6319SBarry Smith MatDuplicateOption - Indicates if a duplicated sparse matrix should have 398d91e6319SBarry Smith its numerical values copied over or just its nonzero structure. 399d91e6319SBarry Smith 400d91e6319SBarry Smith Level: beginner 401d91e6319SBarry Smith 402d91e6319SBarry Smith Any additions/changes here MUST also be made in include/finclude/petscmat.h 403d91e6319SBarry Smith 404d91e6319SBarry Smith .seealso: MatDuplicate() 405d91e6319SBarry Smith E*/ 4062e8a6d31SBarry Smith typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES} MatDuplicateOption; 4072e8a6d31SBarry Smith 408be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvertRegister(const char[],const char[],const char[],PetscErrorCode (*)(Mat,MatType,MatReuse,Mat*)); 409273d9f13SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 410273d9f13SBarry Smith #define MatConvertRegisterDynamic(a,b,c,d) MatConvertRegister(a,b,c,0) 411273d9f13SBarry Smith #else 412273d9f13SBarry Smith #define MatConvertRegisterDynamic(a,b,c,d) MatConvertRegister(a,b,c,d) 413273d9f13SBarry Smith #endif 414be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvertRegisterAll(const char[]); 415be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvertRegisterDestroy(void); 416273d9f13SBarry Smith extern PetscTruth MatConvertRegisterAllCalled; 417b0a32e0cSBarry Smith extern PetscFList MatConvertList; 418f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvert(Mat,MatType,MatReuse,Mat*); 419ba966639SSatish Balay PetscPolymorphicFunction(MatConvert,(Mat A,MatType t),(A,t,MAT_INITIAL_MATRIX,&a),Mat,a) 420be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDuplicate(Mat,MatDuplicateOption,Mat*); 421ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A,MatDuplicateOption o),(A,o,&a),Mat,a) 422ba966639SSatish Balay PetscPolymorphicFunction(MatDuplicate,(Mat A),(A,MAT_COPY_VALUES,&a),Mat,a) 42394a9d846SBarry Smith 424d91e6319SBarry Smith /*E 425d91e6319SBarry Smith MatStructure - Indicates if the matrix has the same nonzero structure 426d91e6319SBarry Smith 427d91e6319SBarry Smith Level: beginner 428d91e6319SBarry Smith 429d91e6319SBarry Smith Any additions/changes here MUST also be made in include/finclude/petscmat.h 430d91e6319SBarry Smith 43194b7f48cSBarry Smith .seealso: MatCopy(), KSPSetOperators(), PCSetOperators() 432d91e6319SBarry Smith E*/ 433c537a176SHong Zhang typedef enum {SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER,SUBSET_NONZERO_PATTERN} MatStructure; 434cb5b572fSBarry Smith 435be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCopy(Mat,Mat,MatStructure); 436be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatView(Mat,PetscViewer); 437be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetric(Mat,PetscReal,PetscTruth*); 438ba966639SSatish Balay PetscPolymorphicFunction(MatIsSymmetric,(Mat A,PetscReal tol),(A,tol,&t),PetscTruth,t) 439e37f64cdSBarry Smith PetscPolymorphicFunction(MatIsSymmetric,(Mat A),(A,0,&t),PetscTruth,t) 440be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsStructurallySymmetric(Mat,PetscTruth*); 441ba966639SSatish Balay PetscPolymorphicFunction(MatIsStructurallySymmetric,(Mat A),(A,&t),PetscTruth,t) 442be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitian(Mat,PetscTruth*); 443ba966639SSatish Balay PetscPolymorphicFunction(MatIsHermitian,(Mat A),(A,&t),PetscTruth,t) 444be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetricKnown(Mat,PetscTruth*,PetscTruth*); 445be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianKnown(Mat,PetscTruth*,PetscTruth*); 446f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLoad(PetscViewer,MatType,Mat*); 447ba966639SSatish Balay PetscPolymorphicFunction(MatLoad,(PetscViewer v,MatType t),(v,t,&a),Mat,a) 4487b80b807SBarry Smith 449be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowIJ(Mat,PetscInt,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *); 450be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowIJ(Mat,PetscInt,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *); 451be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnIJ(Mat,PetscInt,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *); 452be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumnIJ(Mat,PetscInt,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *); 453d4fbbf0eSBarry Smith 454d91e6319SBarry Smith /*S 455d91e6319SBarry Smith MatInfo - Context of matrix information, used with MatGetInfo() 456d91e6319SBarry Smith 457d91e6319SBarry Smith In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE 458d91e6319SBarry Smith 459d91e6319SBarry Smith Level: intermediate 460d91e6319SBarry Smith 461d91e6319SBarry Smith Concepts: matrix^nonzero information 462d91e6319SBarry Smith 463d9274352SBarry Smith .seealso: MatGetInfo(), MatInfoType 464d91e6319SBarry Smith S*/ 4654e220ebcSLois Curfman McInnes typedef struct { 466b0a32e0cSBarry Smith PetscLogDouble rows_global,columns_global; /* number of global rows and columns */ 467b0a32e0cSBarry Smith PetscLogDouble rows_local,columns_local; /* number of local rows and columns */ 468b0a32e0cSBarry Smith PetscLogDouble block_size; /* block size */ 469b0a32e0cSBarry Smith PetscLogDouble nz_allocated,nz_used,nz_unneeded; /* number of nonzeros */ 470b0a32e0cSBarry Smith PetscLogDouble memory; /* memory allocated */ 471b0a32e0cSBarry Smith PetscLogDouble assemblies; /* number of matrix assemblies called */ 472b0a32e0cSBarry Smith PetscLogDouble mallocs; /* number of mallocs during MatSetValues() */ 473b0a32e0cSBarry Smith PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */ 474b0a32e0cSBarry Smith PetscLogDouble factor_mallocs; /* number of mallocs during factorization */ 4754e220ebcSLois Curfman McInnes } MatInfo; 4764e220ebcSLois Curfman McInnes 477d9274352SBarry Smith /*E 478d9274352SBarry Smith MatInfoType - Indicates if you want information about the local part of the matrix, 479d9274352SBarry Smith the entire parallel matrix or the maximum over all the local parts. 480d9274352SBarry Smith 481d9274352SBarry Smith Level: beginner 482d9274352SBarry Smith 483d9274352SBarry Smith Any additions/changes here MUST also be made in include/finclude/petscmat.h 484d9274352SBarry Smith 485d9274352SBarry Smith .seealso: MatGetInfo(), MatInfo 486d9274352SBarry Smith E*/ 4877b80b807SBarry Smith typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType; 488be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInfo(Mat,MatInfoType,MatInfo*); 489be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatValid(Mat,PetscTruth*); 490be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonal(Mat,Vec); 491be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMax(Mat,Vec); 492be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatTranspose(Mat,Mat*); 493ba966639SSatish Balay PetscPolymorphicFunction(MatTranspose,(Mat A),(A,&t),Mat,t) 494be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermute(Mat,IS,IS,Mat *); 495ba966639SSatish Balay PetscPolymorphicFunction(MatPermute,(Mat A,IS is1,IS is2),(A,is1,is2,&t),Mat,t) 496be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermuteSparsify(Mat,PetscInt,PetscReal,PetscReal,IS,IS,Mat *); 497be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScale(Mat,Vec,Vec); 498be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalSet(Mat,Vec,InsertMode); 499be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatEqual(Mat,Mat,PetscTruth*); 500ba966639SSatish Balay PetscPolymorphicFunction(MatEqual,(Mat A,Mat B),(A,B,&t),PetscTruth,t) 501be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultEqual(Mat,Mat,PetscInt,PetscTruth*); 502be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAddEqual(Mat,Mat,PetscInt,PetscTruth*); 503be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeEqual(Mat,Mat,PetscInt,PetscTruth*); 504be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscTruth*); 5057b80b807SBarry Smith 506be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNorm(Mat,NormType,PetscReal *); 507ba966639SSatish Balay PetscPolymorphicFunction(MatNorm,(Mat A,NormType t),(A,t,&n),PetscReal,n) 508be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroEntries(Mat); 509f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar); 510f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsIS(Mat,IS,PetscScalar); 511f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumns(Mat,PetscInt,const PetscInt [],const PetscScalar*); 512f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumnsIS(Mat,IS,const PetscScalar*); 5137b80b807SBarry Smith 514be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUseScaledForm(Mat,PetscTruth); 515be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScaleSystem(Mat,Vec,Vec); 516be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUnScaleSystem(Mat,Vec,Vec); 5175ef9f2a5SBarry Smith 518be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSize(Mat,PetscInt*,PetscInt*); 519be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalSize(Mat,PetscInt*,PetscInt*); 520be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRange(Mat,PetscInt*,PetscInt*); 5217b80b807SBarry Smith 522be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]); 523be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroyMatrices(PetscInt,Mat *[]); 524be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrix(Mat,IS,IS,PetscInt,MatReuse,Mat *); 525abf0e977SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrixRaw(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscInt,MatReuse,Mat *); 526be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*); 527be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*); 528be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*); 529be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPINumeric(Mat,Mat); 530be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy_MPIAIJ_SeqsToMPI(Mat); 531be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMat(Mat,MatReuse,Mat*); 532be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*); 533be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*); 534be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,PetscScalar**,Mat*); 53543eb5e2fSMatthew Knepley #if defined (PETSC_USE_CTABLE) 536cd116e26SSatish Balay #include "petscctable.h" 53743eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscTable *, VecScatter *); 53843eb5e2fSMatthew Knepley #else 53943eb5e2fSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscInt *[], VecScatter *); 54043eb5e2fSMatthew Knepley #endif 5418efafbd8SBarry Smith 542be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt); 5437b80b807SBarry Smith 544be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*); 545be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*); 546be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultNumeric(Mat,Mat,Mat); 54722440eb1SKris Buschelman 548be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*); 549be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*); 550be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPNumeric(Mat,Mat,Mat); 55122440eb1SKris Buschelman 552be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*); 553be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*); 554be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeNumeric(Mat,Mat,Mat); 555bc011b1eSHong Zhang 556f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAXPY(Mat,PetscScalar,Mat,MatStructure); 557f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAYPX(Mat,PetscScalar,Mat); 558be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompress(Mat); 5591c741599SHong Zhang 560f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScale(Mat,PetscScalar); 561f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShift(Mat,PetscScalar); 5627b80b807SBarry Smith 563be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping); 564be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping); 565f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar); 566f4df32b1SMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocalIS(Mat,IS,PetscScalar); 567be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 568be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 569052efed2SBarry Smith 570be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashSetInitialSize(Mat,PetscInt,PetscInt); 571be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 57290f02eecSBarry Smith 573be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolate(Mat,Vec,Vec); 5740c451bc4SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolateAdd(Mat,Vec,Vec,Vec); 575ba966639SSatish Balay PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y)) 576be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestrict(Mat,Vec,Vec); 577be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetVecs(Mat,Vec*,Vec*); 578bd481603SBarry Smith 579bd481603SBarry Smith /*MC 5800d2a7ff2SSatish Balay MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per 581bd481603SBarry Smith row in a matrix providing the data that one can use to correctly preallocate the matrix. 582bd481603SBarry Smith 583bd481603SBarry Smith Synopsis: 584c1ac3661SBarry Smith PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz) 585bd481603SBarry Smith 586bd481603SBarry Smith Collective on MPI_Comm 587bd481603SBarry Smith 588bd481603SBarry Smith Input Parameters: 589bd481603SBarry Smith + comm - the communicator that will share the eventually allocated matrix 590859fcb39SBarry Smith . nrows - the number of LOCAL rows in the matrix 591859fcb39SBarry Smith - ncols - the number of LOCAL columns in the matrix 592bd481603SBarry Smith 593bd481603SBarry Smith Output Parameters: 594bd481603SBarry Smith + dnz - the array that will be passed to the matrix preallocation routines 595bd481603SBarry Smith - ozn - the other array passed to the matrix preallocation routines 596bd481603SBarry Smith 597bd481603SBarry Smith 598bd481603SBarry Smith Level: intermediate 599bd481603SBarry Smith 600bd481603SBarry Smith Notes: 601bd481603SBarry Smith See the chapter in the users manual on performance for more details 602bd481603SBarry Smith 6031d73ed98SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 604bd481603SBarry Smith 605bd481603SBarry Smith Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices) 606bd481603SBarry Smith 607bd481603SBarry Smith Concepts: preallocation^Matrix 608bd481603SBarry Smith 609bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 610bd481603SBarry Smith MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal() 611bd481603SBarry Smith M*/ 612c4f061fbSSatish Balay #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \ 6137c922b88SBarry Smith { \ 614c1ac3661SBarry Smith PetscErrorCode _4_ierr; PetscInt __tmp = (nrows),__ctmp = (ncols),__rstart,__start,__end; \ 615c1ac3661SBarry Smith _4_ierr = PetscMalloc(2*__tmp*sizeof(PetscInt),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\ 616c1ac3661SBarry Smith _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(PetscInt));CHKERRQ(_4_ierr);\ 617c1ac3661SBarry Smith _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\ 618c1ac3661SBarry Smith _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp; 6197c922b88SBarry Smith 620bd481603SBarry Smith /*MC 6210d2a7ff2SSatish Balay MatPreallocateSymmetricInitialize - Begins the block of code that will count the number of nonzeros per 622bd481603SBarry Smith row in a matrix providing the data that one can use to correctly preallocate the matrix. 623bd481603SBarry Smith 624bd481603SBarry Smith Synopsis: 625c1ac3661SBarry Smith PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz) 626bd481603SBarry Smith 627bd481603SBarry Smith Collective on MPI_Comm 628bd481603SBarry Smith 629bd481603SBarry Smith Input Parameters: 630bd481603SBarry Smith + comm - the communicator that will share the eventually allocated matrix 631859fcb39SBarry Smith . nrows - the number of LOCAL rows in the matrix 632859fcb39SBarry Smith - ncols - the number of LOCAL columns in the matrix 633bd481603SBarry Smith 634bd481603SBarry Smith Output Parameters: 635bd481603SBarry Smith + dnz - the array that will be passed to the matrix preallocation routines 636bd481603SBarry Smith - ozn - the other array passed to the matrix preallocation routines 637bd481603SBarry Smith 638bd481603SBarry Smith 639bd481603SBarry Smith Level: intermediate 640bd481603SBarry Smith 641bd481603SBarry Smith Notes: 642bd481603SBarry Smith See the chapter in the users manual on performance for more details 643bd481603SBarry Smith 6441d73ed98SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 645bd481603SBarry Smith 646bd481603SBarry Smith Concepts: preallocation^Matrix 647bd481603SBarry Smith 648bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 649bd481603SBarry Smith MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal() 650bd481603SBarry Smith M*/ 651222b16d4SBarry Smith #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \ 652222b16d4SBarry Smith { \ 653c1ac3661SBarry Smith PetscErrorCode _4_ierr; PetscInt __tmp = (nrows),__ctmp = (ncols),__rstart,__end; \ 654c1ac3661SBarry Smith _4_ierr = PetscMalloc(2*__tmp*sizeof(PetscInt),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\ 655c1ac3661SBarry Smith _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(PetscInt));CHKERRQ(_4_ierr);\ 656c1ac3661SBarry Smith _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\ 657c1ac3661SBarry Smith _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp; 658222b16d4SBarry Smith 659bd481603SBarry Smith /*MC 660bd481603SBarry Smith MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 661bd481603SBarry Smith inserted using a local number of the rows and columns 662bd481603SBarry Smith 663bd481603SBarry Smith Synopsis: 664c1ac3661SBarry Smith PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 665bd481603SBarry Smith 666bd481603SBarry Smith Not Collective 667bd481603SBarry Smith 668bd481603SBarry Smith Input Parameters: 669bd481603SBarry Smith + map - the mapping between local numbering and global numbering 670bd481603SBarry Smith . nrows - the number of rows indicated 6711d73ed98SBarry Smith . rows - the indices of the rows 672bd481603SBarry Smith . ncols - the number of columns in the matrix 673bd481603SBarry Smith . cols - the columns indicated 674bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 675bd481603SBarry Smith - ozn - the other array passed to the matrix preallocation routines 676bd481603SBarry Smith 677bd481603SBarry Smith 678bd481603SBarry Smith Level: intermediate 679bd481603SBarry Smith 680bd481603SBarry Smith Notes: 681bd481603SBarry Smith See the chapter in the users manual on performance for more details 682bd481603SBarry Smith 6831d73ed98SBarry Smith Do not malloc or free dnz and onz, that is handled internally by these routines 684bd481603SBarry Smith 685bd481603SBarry Smith Concepts: preallocation^Matrix 686bd481603SBarry Smith 687bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 688bd481603SBarry Smith MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal() 689bd481603SBarry Smith M*/ 690c4f061fbSSatish Balay #define MatPreallocateSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\ 691c4f061fbSSatish Balay {\ 692c1ac3661SBarry Smith PetscInt __l;\ 693ef66eb69SBarry Smith _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\ 694ef66eb69SBarry Smith _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\ 695c4f061fbSSatish Balay for (__l=0;__l<nrows;__l++) {\ 696ef66eb69SBarry Smith _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 697c4f061fbSSatish Balay }\ 698c4f061fbSSatish Balay } 699c4f061fbSSatish Balay 700bd481603SBarry Smith /*MC 701bd481603SBarry Smith MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 702bd481603SBarry Smith inserted using a local number of the rows and columns 703bd481603SBarry Smith 704bd481603SBarry Smith Synopsis: 705c1ac3661SBarry Smith PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 706bd481603SBarry Smith 707bd481603SBarry Smith Not Collective 708bd481603SBarry Smith 709bd481603SBarry Smith Input Parameters: 710bd481603SBarry Smith + map - the mapping between local numbering and global numbering 711bd481603SBarry Smith . nrows - the number of rows indicated 7121d73ed98SBarry Smith . rows - the indices of the rows 713bd481603SBarry Smith . ncols - the number of columns in the matrix 714bd481603SBarry Smith . cols - the columns indicated 715bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 716bd481603SBarry Smith - ozn - the other array passed to the matrix preallocation routines 717bd481603SBarry Smith 718bd481603SBarry Smith 719bd481603SBarry Smith Level: intermediate 720bd481603SBarry Smith 721bd481603SBarry Smith Notes: 722bd481603SBarry Smith See the chapter in the users manual on performance for more details 723bd481603SBarry Smith 724bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 725bd481603SBarry Smith 726bd481603SBarry Smith Concepts: preallocation^Matrix 727bd481603SBarry Smith 728bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 729bd481603SBarry Smith MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 730bd481603SBarry Smith M*/ 731d3d32019SBarry Smith #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\ 732d3d32019SBarry Smith {\ 733c1ac3661SBarry Smith PetscInt __l;\ 734d3d32019SBarry Smith _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\ 735d3d32019SBarry Smith _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\ 736d3d32019SBarry Smith for (__l=0;__l<nrows;__l++) {\ 737d3d32019SBarry Smith _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 738d3d32019SBarry Smith }\ 739d3d32019SBarry Smith } 740d3d32019SBarry Smith 741bd481603SBarry Smith /*MC 742bd481603SBarry Smith MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 743bd481603SBarry Smith inserted using a local number of the rows and columns 744bd481603SBarry Smith 745bd481603SBarry Smith Synopsis: 746c1ac3661SBarry Smith PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 747bd481603SBarry Smith 748bd481603SBarry Smith Not Collective 749bd481603SBarry Smith 750bd481603SBarry Smith Input Parameters: 751bd481603SBarry Smith + nrows - the number of rows indicated 7521d73ed98SBarry Smith . rows - the indices of the rows 753bd481603SBarry Smith . ncols - the number of columns in the matrix 754a50f8bf6SHong Zhang - cols - the columns indicated 755a50f8bf6SHong Zhang 756a50f8bf6SHong Zhang Output Parameters: 757a50f8bf6SHong Zhang + dnz - the array that will be passed to the matrix preallocation routines 758bd481603SBarry Smith - ozn - the other array passed to the matrix preallocation routines 759bd481603SBarry Smith 760bd481603SBarry Smith 761bd481603SBarry Smith Level: intermediate 762bd481603SBarry Smith 763bd481603SBarry Smith Notes: 764bd481603SBarry Smith See the chapter in the users manual on performance for more details 765bd481603SBarry Smith 766bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 767bd481603SBarry Smith 768bd481603SBarry Smith Concepts: preallocation^Matrix 769bd481603SBarry Smith 770bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 771bd481603SBarry Smith MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 772bd481603SBarry Smith M*/ 773c4f061fbSSatish Balay #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\ 774c1ac3661SBarry Smith { PetscInt __i; \ 7757c922b88SBarry Smith for (__i=0; __i<nc; __i++) {\ 7767c922b88SBarry Smith if (cols[__i] < __start || cols[__i] >= __end) onz[row - __rstart]++; \ 7777c922b88SBarry Smith }\ 7787c922b88SBarry Smith dnz[row - __rstart] = nc - onz[row - __rstart];\ 7797c922b88SBarry Smith } 7807c922b88SBarry Smith 781bd481603SBarry Smith /*MC 782bd481603SBarry Smith MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 783bd481603SBarry Smith inserted using a local number of the rows and columns 784bd481603SBarry Smith 785bd481603SBarry Smith Synopsis: 786c1ac3661SBarry Smith PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 787bd481603SBarry Smith 788bd481603SBarry Smith Not Collective 789bd481603SBarry Smith 790bd481603SBarry Smith Input Parameters: 791bd481603SBarry Smith + nrows - the number of rows indicated 7921d73ed98SBarry Smith . rows - the indices of the rows 793bd481603SBarry Smith . ncols - the number of columns in the matrix 794bd481603SBarry Smith . cols - the columns indicated 795bd481603SBarry Smith . dnz - the array that will be passed to the matrix preallocation routines 796bd481603SBarry Smith - ozn - the other array passed to the matrix preallocation routines 797bd481603SBarry Smith 798bd481603SBarry Smith 799bd481603SBarry Smith Level: intermediate 800bd481603SBarry Smith 801bd481603SBarry Smith Notes: 802bd481603SBarry Smith See the chapter in the users manual on performance for more details 803bd481603SBarry Smith 804bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 805bd481603SBarry Smith 806bd481603SBarry Smith Concepts: preallocation^Matrix 807bd481603SBarry Smith 808bd481603SBarry Smith .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 809bd481603SBarry Smith MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 810bd481603SBarry Smith M*/ 811d3d32019SBarry Smith #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\ 812c1ac3661SBarry Smith { PetscInt __i; \ 813d3d32019SBarry Smith for (__i=0; __i<nc; __i++) {\ 814d3d32019SBarry Smith if (cols[__i] >= __end) onz[row - __rstart]++; \ 815d3d32019SBarry Smith else if (cols[__i] >= row) dnz[row - __rstart]++;\ 816d3d32019SBarry Smith }\ 817d3d32019SBarry Smith } 818d3d32019SBarry Smith 819bd481603SBarry Smith /*MC 8200d2a7ff2SSatish Balay MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per 821bd481603SBarry Smith row in a matrix providing the data that one can use to correctly preallocate the matrix. 822bd481603SBarry Smith 823bd481603SBarry Smith Synopsis: 824c1ac3661SBarry Smith PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz) 825bd481603SBarry Smith 826bd481603SBarry Smith Collective on MPI_Comm 827bd481603SBarry Smith 828bd481603SBarry Smith Input Parameters: 829bd481603SBarry Smith + dnz - the array that will be passed to the matrix preallocation routines 830bd481603SBarry Smith - ozn - the other array passed to the matrix preallocation routines 831bd481603SBarry Smith 832bd481603SBarry Smith 833bd481603SBarry Smith Level: intermediate 834bd481603SBarry Smith 835bd481603SBarry Smith Notes: 836bd481603SBarry Smith See the chapter in the users manual on performance for more details 837bd481603SBarry Smith 838bd481603SBarry Smith Do not malloc or free dnz and onz that is handled internally by these routines 839bd481603SBarry Smith 840bd481603SBarry Smith Concepts: preallocation^Matrix 841bd481603SBarry Smith 842bd481603SBarry Smith .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 843bd481603SBarry Smith MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal() 844bd481603SBarry Smith M*/ 845ef66eb69SBarry Smith #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree(dnz);CHKERRQ(_4_ierr);} 8467c922b88SBarry Smith 847bd481603SBarry Smith 848bd481603SBarry Smith 8497b80b807SBarry Smith /* Routines unique to particular data structures */ 850be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetContext(Mat,void **); 851ba966639SSatish Balay PetscPolymorphicFunction(MatShellGetContext,(Mat A),(A,&t),void*,t) 852be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBDiagGetData(Mat,PetscInt*,PetscInt*,PetscInt*[],PetscInt*[],PetscScalar***); 853698d4c6aSKris Buschelman 854be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeAdjustForInodes(Mat,IS*,IS*); 855be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *); 856698d4c6aSKris Buschelman 857be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetColumnIndices(Mat,PetscInt[]); 858be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetColumnIndices(Mat,PetscInt[]); 859be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 860*c75a6043SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 861*c75a6043SHong Zhang EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 8627b80b807SBarry Smith 863a96a251dSBarry Smith #define MAT_SKIP_ALLOCATION -4 864a96a251dSBarry Smith 865be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 866ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz)) 867be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 868ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqSBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz)) 869be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]); 870ba966639SSatish Balay PetscPolymorphicSubroutine(MatSeqAIJSetPreallocation,(Mat A,const PetscInt nnz[]),(A,0,nnz)) 871be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDensePreallocation(Mat,PetscScalar[]); 872be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBDiagSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscScalar*[]); 873273d9f13SBarry Smith 874be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 875ba966639SSatish Balay PetscPolymorphicSubroutine(MatMPIBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[],const PetscInt onz[]),(A,bs,0,nnz,0,onz)) 876be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 877be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 87853803f26SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []); 879be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]); 880be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 881be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDensePreallocation(Mat,PetscScalar[]); 882be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBDiagSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscScalar*[]); 883be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]); 884be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDenseSetPreallocation(Mat,PetscScalar[]); 885284134d9SBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetPreallocation(Mat,PetscScalar[]); 886be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIRowbsSetPreallocation(Mat,PetscInt,const PetscInt[]); 887be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]); 888be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]); 889be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAdicSetLocalFunction(Mat,void (*)(void)); 890273d9f13SBarry Smith 891be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetLDA(Mat,PetscInt); 892ab92ecdeSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDenseGetLocalMatrix(Mat,Mat*); 8931b807ce4Svictorle 894be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStoreValues(Mat); 895be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRetrieveValues(Mat); 8962e8a6d31SBarry Smith 897be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDAADSetCtx(Mat,void*); 8983a7fca6bSBarry Smith 8997b80b807SBarry Smith /* 9007b80b807SBarry Smith These routines are not usually accessed directly, rather solving is 90194b7f48cSBarry Smith done through the KSP and PC interfaces. 9027b80b807SBarry Smith */ 9037b80b807SBarry Smith 904d9274352SBarry Smith /*E 905d9274352SBarry Smith MatOrderingType - String with the name of a PETSc matrix ordering or the creation function 906d9274352SBarry Smith with an optional dynamic library name, for example 907d9274352SBarry Smith http://www.mcs.anl.gov/petsc/lib.a:orderingcreate() 908d9274352SBarry Smith 909d9274352SBarry Smith Level: beginner 910d9274352SBarry Smith 911d9274352SBarry Smith .seealso: MatGetOrdering() 912d9274352SBarry Smith E*/ 91349773a63SBarry Smith #define MatOrderingType char* 914b12f92e5SBarry Smith #define MATORDERING_NATURAL "natural" 915b12f92e5SBarry Smith #define MATORDERING_ND "nd" 916b12f92e5SBarry Smith #define MATORDERING_1WD "1wd" 917b12f92e5SBarry Smith #define MATORDERING_RCM "rcm" 918b12f92e5SBarry Smith #define MATORDERING_QMD "qmd" 919b12f92e5SBarry Smith #define MATORDERING_ROWLENGTH "rowlength" 92062152c8bSBarry Smith #define MATORDERING_DSC_ND "dsc_nd" 92162152c8bSBarry Smith #define MATORDERING_DSC_MMD "dsc_mmd" 92262152c8bSBarry Smith #define MATORDERING_DSC_MDF "dsc_mdf" 923c06d978dSMatthew Knepley #define MATORDERING_CONSTRAINED "constrained" 924c06d978dSMatthew Knepley #define MATORDERING_IDENTITY "identity" 925c06d978dSMatthew Knepley #define MATORDERING_REVERSE "reverse" 926b12f92e5SBarry Smith 927be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrdering(Mat,const MatOrderingType,IS*,IS*); 928be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrderingList(PetscFList *list); 929be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*)); 93030de9b25SBarry Smith 93130de9b25SBarry Smith /*MC 93230de9b25SBarry Smith MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the 93330de9b25SBarry Smith matrix package. 93430de9b25SBarry Smith 93530de9b25SBarry Smith Synopsis: 936c1ac3661SBarry Smith PetscErrorCode MatOrderingRegisterDynamic(char *name_ordering,char *path,char *name_create,PetscErrorCode (*routine_create)(MatOrdering)) 93730de9b25SBarry Smith 93830de9b25SBarry Smith Not Collective 93930de9b25SBarry Smith 94030de9b25SBarry Smith Input Parameters: 94130de9b25SBarry Smith + sname - name of ordering (for example MATORDERING_ND) 94230de9b25SBarry Smith . path - location of library where creation routine is 94330de9b25SBarry Smith . name - name of function that creates the ordering type,a string 94430de9b25SBarry Smith - function - function pointer that creates the ordering 94530de9b25SBarry Smith 94630de9b25SBarry Smith Level: developer 94730de9b25SBarry Smith 94830de9b25SBarry Smith If dynamic libraries are used, then the fourth input argument (function) 94930de9b25SBarry Smith is ignored. 95030de9b25SBarry Smith 95130de9b25SBarry Smith Sample usage: 95230de9b25SBarry Smith .vb 95330de9b25SBarry Smith MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a, 95430de9b25SBarry Smith "MyOrder",MyOrder); 95530de9b25SBarry Smith .ve 95630de9b25SBarry Smith 95730de9b25SBarry Smith Then, your partitioner can be chosen with the procedural interface via 95830de9b25SBarry Smith $ MatOrderingSetType(part,"my_order) 95930de9b25SBarry Smith or at runtime via the option 9602401956bSBarry Smith $ -pc_factor_mat_ordering_type my_order 96130de9b25SBarry Smith 962ab901514SBarry Smith ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values. 96330de9b25SBarry Smith 96430de9b25SBarry Smith .keywords: matrix, ordering, register 96530de9b25SBarry Smith 96630de9b25SBarry Smith .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll() 96730de9b25SBarry Smith M*/ 968aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 969f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0) 970b12f92e5SBarry Smith #else 971f1af5d2fSBarry Smith #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d) 972b12f92e5SBarry Smith #endif 97330de9b25SBarry Smith 974be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterDestroy(void); 975be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterAll(const char[]); 9762bad1931SBarry Smith extern PetscTruth MatOrderingRegisterAllCalled; 977b0a32e0cSBarry Smith extern PetscFList MatOrderingList; 978d4fbbf0eSBarry Smith 979be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS); 980a2ce50c7SBarry Smith 981d91e6319SBarry Smith /*S 9822401956bSBarry Smith MatFactorInfo - Data passed into the matrix factorization routines 983b00f7748SHong Zhang 98415e8a5b3SHong Zhang In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE 985b00f7748SHong Zhang 98615e8a5b3SHong Zhang Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC. 987b00f7748SHong Zhang 988b00f7748SHong Zhang Level: developer 989b00f7748SHong Zhang 990d7d82daaSBarry Smith .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(), 991d7d82daaSBarry Smith MatFactorInfoInitialize() 992b00f7748SHong Zhang 993b00f7748SHong Zhang S*/ 994b00f7748SHong Zhang typedef struct { 9950a29876aSHong Zhang PetscReal shiftnz; /* scaling of identity added to matrix to prevent zero pivots */ 996fbf22428SSatish Balay PetscReal shiftpd; /* if true, shift until positive pivots */ 9972cea7109SBarry Smith PetscReal shift_fraction; /* record shift fraction taken */ 99815e8a5b3SHong Zhang PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */ 99915e8a5b3SHong Zhang PetscReal dt; /* drop tolerance */ 1000b00f7748SHong Zhang PetscReal dtcol; /* tolerance for pivoting */ 100115e8a5b3SHong Zhang PetscReal dtcount; /* maximum nonzeros to be allowed per row */ 1002f6275e2eSBarry Smith PetscReal fill; /* expected fill; nonzeros in factored matrix/nonzeros in original matrix*/ 1003348344bbSBarry Smith PetscReal levels; /* ICC/ILU(levels) */ 1004bcd9e38bSBarry Smith PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0 1005bcd9e38bSBarry Smith factorization may be faster if do not pivot */ 100615e8a5b3SHong Zhang PetscReal zeropivot; /* pivot is called zero if less than this */ 100715e8a5b3SHong Zhang } MatFactorInfo; 1008ffa6d0a5SLois Curfman McInnes 1009be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorInfoInitialize(MatFactorInfo*); 1010be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactor(Mat,IS,MatFactorInfo*); 1011be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*); 1012be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorNumeric(Mat,MatFactorInfo*,Mat*); 1013be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactor(Mat,IS,IS,MatFactorInfo*); 1014be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactor(Mat,IS,IS,MatFactorInfo*); 1015be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*); 1016be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*); 1017be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*); 1018be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactor(Mat,IS,MatFactorInfo*); 1019be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorNumeric(Mat,MatFactorInfo*,Mat*); 1020be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUDTFactor(Mat,IS,IS,MatFactorInfo*,Mat *); 1021be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*); 1022be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolve(Mat,Vec,Vec); 1023be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatForwardSolve(Mat,Vec,Vec); 1024be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBackwardSolve(Mat,Vec,Vec); 1025be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveAdd(Mat,Vec,Vec,Vec); 1026be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTranspose(Mat,Vec,Vec); 1027be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTransposeAdd(Mat,Vec,Vec,Vec); 1028be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolves(Mat,Vecs,Vecs); 10298ed539a5SBarry Smith 1030be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUnfactored(Mat); 1031bb5a7306SBarry Smith 1032d91e6319SBarry Smith /*E 1033d91e6319SBarry Smith MatSORType - What type of (S)SOR to perform 1034bb1eb677SSatish Balay 1035d91e6319SBarry Smith Level: beginner 1036d91e6319SBarry Smith 1037d9274352SBarry Smith May be bitwise ORd together 1038d9274352SBarry Smith 1039d91e6319SBarry Smith Any additions/changes here MUST also be made in include/finclude/petscmat.h 1040d91e6319SBarry Smith 10414e7234bfSBarry Smith MatSORType may be bitwise ORd together, so do not change the numbers 10424e7234bfSBarry Smith 1043a1d92eedSBarry Smith .seealso: MatRelax(), MatPBRelax() 1044d91e6319SBarry Smith E*/ 1045ee50ffe9SBarry Smith typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3, 1046ee50ffe9SBarry Smith SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8, 1047ee50ffe9SBarry Smith SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16, 104884cb2905SBarry Smith SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType; 1049be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec); 1050be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPBRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec); 10518ed539a5SBarry Smith 1052d4fbbf0eSBarry Smith /* 1053639f9d9dSBarry Smith These routines are for efficiently computing Jacobians via finite differences. 1054639f9d9dSBarry Smith */ 1055b12f92e5SBarry Smith 1056d9274352SBarry Smith /*E 1057d9274352SBarry Smith MatColoringType - String with the name of a PETSc matrix coloring or the creation function 1058d9274352SBarry Smith with an optional dynamic library name, for example 1059d9274352SBarry Smith http://www.mcs.anl.gov/petsc/lib.a:coloringcreate() 1060d9274352SBarry Smith 1061d9274352SBarry Smith Level: beginner 1062d9274352SBarry Smith 1063d9274352SBarry Smith .seealso: MatGetColoring() 1064d9274352SBarry Smith E*/ 106549773a63SBarry Smith #define MatColoringType char* 1066b12f92e5SBarry Smith #define MATCOLORING_NATURAL "natural" 1067b12f92e5SBarry Smith #define MATCOLORING_SL "sl" 1068b12f92e5SBarry Smith #define MATCOLORING_LF "lf" 1069b12f92e5SBarry Smith #define MATCOLORING_ID "id" 1070b12f92e5SBarry Smith 1071be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColoring(Mat,const MatColoringType,ISColoring*); 1072be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatColoringType,ISColoring *)); 107330de9b25SBarry Smith 107430de9b25SBarry Smith /*MC 107530de9b25SBarry Smith MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the 107630de9b25SBarry Smith matrix package. 107730de9b25SBarry Smith 107830de9b25SBarry Smith Synopsis: 1079c1ac3661SBarry Smith PetscErrorCode MatColoringRegisterDynamic(char *name_coloring,char *path,char *name_create,PetscErrorCode (*routine_create)(MatColoring)) 108030de9b25SBarry Smith 108130de9b25SBarry Smith Not Collective 108230de9b25SBarry Smith 108330de9b25SBarry Smith Input Parameters: 108430de9b25SBarry Smith + sname - name of Coloring (for example MATCOLORING_SL) 108530de9b25SBarry Smith . path - location of library where creation routine is 108630de9b25SBarry Smith . name - name of function that creates the Coloring type, a string 108730de9b25SBarry Smith - function - function pointer that creates the coloring 108830de9b25SBarry Smith 108930de9b25SBarry Smith Level: developer 109030de9b25SBarry Smith 109130de9b25SBarry Smith If dynamic libraries are used, then the fourth input argument (function) 109230de9b25SBarry Smith is ignored. 109330de9b25SBarry Smith 109430de9b25SBarry Smith Sample usage: 109530de9b25SBarry Smith .vb 109630de9b25SBarry Smith MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a, 109730de9b25SBarry Smith "MyColor",MyColor); 109830de9b25SBarry Smith .ve 109930de9b25SBarry Smith 110030de9b25SBarry Smith Then, your partitioner can be chosen with the procedural interface via 110130de9b25SBarry Smith $ MatColoringSetType(part,"my_color") 110230de9b25SBarry Smith or at runtime via the option 110330de9b25SBarry Smith $ -mat_coloring_type my_color 110430de9b25SBarry Smith 1105ab901514SBarry Smith $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 110630de9b25SBarry Smith 110730de9b25SBarry Smith .keywords: matrix, Coloring, register 110830de9b25SBarry Smith 110930de9b25SBarry Smith .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll() 111030de9b25SBarry Smith M*/ 1111aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1112f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0) 1113b12f92e5SBarry Smith #else 1114f1af5d2fSBarry Smith #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d) 1115b12f92e5SBarry Smith #endif 111630de9b25SBarry Smith 11172bad1931SBarry Smith extern PetscTruth MatColoringRegisterAllCalled; 1118f1144a30SSatish Balay 1119be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterAll(const char[]); 1120be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterDestroy(void); 1121be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*); 1122639f9d9dSBarry Smith 1123d9274352SBarry Smith /*S 1124d9274352SBarry Smith MatFDColoring - Object for computing a sparse Jacobian via finite differences 1125d9274352SBarry Smith and coloring 1126639f9d9dSBarry Smith 1127d9274352SBarry Smith Level: beginner 1128d9274352SBarry Smith 1129d9274352SBarry Smith Concepts: coloring, sparse Jacobian, finite differences 1130d9274352SBarry Smith 1131d9274352SBarry Smith .seealso: MatFDColoringCreate() 1132d9274352SBarry Smith S*/ 1133e2a1c21fSSatish Balay typedef struct _p_MatFDColoring* MatFDColoring; 1134639f9d9dSBarry Smith 1135be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringCreate(Mat,ISColoring,MatFDColoring *); 1136be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringDestroy(MatFDColoring); 1137be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringView(MatFDColoring,PetscViewer); 1138be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*); 11394a9d489dSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**); 1140be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal); 1141be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFrequency(MatFDColoring,PetscInt); 1142be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFrequency(MatFDColoring,PetscInt*); 1143be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFromOptions(MatFDColoring); 1144be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *); 1145be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *); 1146be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetRecompute(MatFDColoring); 1147be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetF(MatFDColoring,Vec); 1148be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]); 1149639f9d9dSBarry Smith /* 11500752156aSBarry Smith These routines are for partitioning matrices: currently used only 11513eda8832SBarry Smith for adjacency matrix, MatCreateMPIAdj(). 11520752156aSBarry Smith */ 1153ca161407SBarry Smith 1154d9274352SBarry Smith /*S 1155d9274352SBarry Smith MatPartitioning - Object for managing the partitioning of a matrix or graph 1156d9274352SBarry Smith 1157d9274352SBarry Smith Level: beginner 1158d9274352SBarry Smith 1159d9274352SBarry Smith Concepts: partitioning 1160d9274352SBarry Smith 1161743a1026Svictorle .seealso: MatPartitioningCreate(), MatPartitioningType 1162d9274352SBarry Smith S*/ 116391e9ee9fSBarry Smith typedef struct _p_MatPartitioning* MatPartitioning; 1164d9274352SBarry Smith 1165d9274352SBarry Smith /*E 11665bc6e7ccSvictorle MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function 1167d9274352SBarry Smith with an optional dynamic library name, for example 1168d9274352SBarry Smith http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate() 1169d9274352SBarry Smith 1170d9274352SBarry Smith Level: beginner 1171d9274352SBarry Smith 1172b547a13bSvictorle .seealso: MatPartitioningCreate(), MatPartitioning 1173d9274352SBarry Smith E*/ 117449773a63SBarry Smith #define MatPartitioningType char* 11758ba1e511SMatthew Knepley #define MAT_PARTITIONING_CURRENT "current" 1176c2ec2a73SHong Zhang #define MAT_PARTITIONING_SQUARE "square" 11778ba1e511SMatthew Knepley #define MAT_PARTITIONING_PARMETIS "parmetis" 117871306c60Sjroman #define MAT_PARTITIONING_CHACO "chaco" 117971306c60Sjroman #define MAT_PARTITIONING_JOSTLE "jostle" 118071306c60Sjroman #define MAT_PARTITIONING_PARTY "party" 118171306c60Sjroman #define MAT_PARTITIONING_SCOTCH "scotch" 118271306c60Sjroman 1183ca161407SBarry Smith 1184be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningCreate(MPI_Comm,MatPartitioning*); 1185be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetType(MatPartitioning,const MatPartitioningType); 1186be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetNParts(MatPartitioning,PetscInt); 1187be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetAdjacency(MatPartitioning,Mat); 1188be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]); 1189be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []); 1190be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningApply(MatPartitioning,IS*); 1191be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningDestroy(MatPartitioning); 11922aabb6bbSBarry Smith 1193be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning)); 119430de9b25SBarry Smith 119530de9b25SBarry Smith /*MC 119630de9b25SBarry Smith MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the 119730de9b25SBarry Smith matrix package. 119830de9b25SBarry Smith 119930de9b25SBarry Smith Synopsis: 1200c1ac3661SBarry Smith PetscErrorCode MatPartitioningRegisterDynamic(char *name_partitioning,char *path,char *name_create,PetscErrorCode (*routine_create)(MatPartitioning)) 120130de9b25SBarry Smith 120230de9b25SBarry Smith Not Collective 120330de9b25SBarry Smith 120430de9b25SBarry Smith Input Parameters: 120530de9b25SBarry Smith + sname - name of partitioning (for example MAT_PARTITIONING_CURRENT) or parmetis 120630de9b25SBarry Smith . path - location of library where creation routine is 120730de9b25SBarry Smith . name - name of function that creates the partitioning type, a string 120830de9b25SBarry Smith - function - function pointer that creates the partitioning type 120930de9b25SBarry Smith 121030de9b25SBarry Smith Level: developer 121130de9b25SBarry Smith 121230de9b25SBarry Smith If dynamic libraries are used, then the fourth input argument (function) 121330de9b25SBarry Smith is ignored. 121430de9b25SBarry Smith 121530de9b25SBarry Smith Sample usage: 121630de9b25SBarry Smith .vb 121730de9b25SBarry Smith MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a, 121830de9b25SBarry Smith "MyPartCreate",MyPartCreate); 121930de9b25SBarry Smith .ve 122030de9b25SBarry Smith 122130de9b25SBarry Smith Then, your partitioner can be chosen with the procedural interface via 122230de9b25SBarry Smith $ MatPartitioningSetType(part,"my_part") 122330de9b25SBarry Smith or at runtime via the option 122430de9b25SBarry Smith $ -mat_partitioning_type my_part 122530de9b25SBarry Smith 1226ab901514SBarry Smith $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 122730de9b25SBarry Smith 122830de9b25SBarry Smith .keywords: matrix, partitioning, register 122930de9b25SBarry Smith 123030de9b25SBarry Smith .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll() 123130de9b25SBarry Smith M*/ 1232aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1233f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0) 12342aabb6bbSBarry Smith #else 1235f1af5d2fSBarry Smith #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d) 12362aabb6bbSBarry Smith #endif 12372aabb6bbSBarry Smith 12382bad1931SBarry Smith extern PetscTruth MatPartitioningRegisterAllCalled; 1239f1144a30SSatish Balay 1240be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterAll(const char[]); 1241be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterDestroy(void); 12422bad1931SBarry Smith 1243be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningView(MatPartitioning,PetscViewer); 1244be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetFromOptions(MatPartitioning); 1245be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningGetType(MatPartitioning,MatPartitioningType*); 1246ca161407SBarry Smith 1247be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisSetCoarseSequential(MatPartitioning); 12480752156aSBarry Smith 1249be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal); 1250be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseSequential(MatPartitioning); 125171306c60Sjroman 1252954b3ec6SBarry Smith typedef enum {MP_CHACO_MULTILEVEL_KL,MP_CHACO_SPECTRAL,MP_CHACO_LINEAR,MP_CHACO_RANDOM, MP_CHACO_SCATTERED} MPChacoGlobalType; 1253be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType); 125471306c60Sjroman typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType; 1255be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType); 1256be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal); 125771306c60Sjroman typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType; 1258be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType); 1259be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal); 1260be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt); 126171306c60Sjroman 126271306c60Sjroman #define MP_PARTY_OPT "opt" 126371306c60Sjroman #define MP_PARTY_LIN "lin" 126471306c60Sjroman #define MP_PARTY_SCA "sca" 126571306c60Sjroman #define MP_PARTY_RAN "ran" 126671306c60Sjroman #define MP_PARTY_GBF "gbf" 126771306c60Sjroman #define MP_PARTY_GCF "gcf" 126871306c60Sjroman #define MP_PARTY_BUB "bub" 126971306c60Sjroman #define MP_PARTY_DEF "def" 1270be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetGlobal(MatPartitioning, const char*); 127171306c60Sjroman #define MP_PARTY_HELPFUL_SETS "hs" 127271306c60Sjroman #define MP_PARTY_KERNIGHAN_LIN "kl" 127371306c60Sjroman #define MP_PARTY_NONE "no" 1274be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetLocal(MatPartitioning, const char*); 1275be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal); 1276be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetBipart(MatPartitioning,PetscTruth); 1277be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscTruth); 127871306c60Sjroman 127971306c60Sjroman typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType; 1280be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetArch(MatPartitioning,const char*); 1281be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMultilevel(MatPartitioning); 1282be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType); 1283be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal); 1284be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetHostList(MatPartitioning,const char*); 128571306c60Sjroman typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType; 1286be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType); 1287be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMapping(MatPartitioning); 1288be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetStrategy(MatPartitioning,char*); 128971306c60Sjroman 12900752156aSBarry Smith /* 12910a835dfdSSatish Balay If you add entries here you must also add them to finclude/petscmat.h 1292d4fbbf0eSBarry Smith */ 12931c1c02c0SLois Curfman McInnes typedef enum { MATOP_SET_VALUES=0, 12941c1c02c0SLois Curfman McInnes MATOP_GET_ROW=1, 12951c1c02c0SLois Curfman McInnes MATOP_RESTORE_ROW=2, 12961c1c02c0SLois Curfman McInnes MATOP_MULT=3, 12971c1c02c0SLois Curfman McInnes MATOP_MULT_ADD=4, 12987c922b88SBarry Smith MATOP_MULT_TRANSPOSE=5, 12997c922b88SBarry Smith MATOP_MULT_TRANSPOSE_ADD=6, 13001c1c02c0SLois Curfman McInnes MATOP_SOLVE=7, 13011c1c02c0SLois Curfman McInnes MATOP_SOLVE_ADD=8, 13027c922b88SBarry Smith MATOP_SOLVE_TRANSPOSE=9, 13037c922b88SBarry Smith MATOP_SOLVE_TRANSPOSE_ADD=10, 13041c1c02c0SLois Curfman McInnes MATOP_LUFACTOR=11, 13051c1c02c0SLois Curfman McInnes MATOP_CHOLESKYFACTOR=12, 13061c1c02c0SLois Curfman McInnes MATOP_RELAX=13, 13071c1c02c0SLois Curfman McInnes MATOP_TRANSPOSE=14, 13081c1c02c0SLois Curfman McInnes MATOP_GETINFO=15, 13091c1c02c0SLois Curfman McInnes MATOP_EQUAL=16, 13101c1c02c0SLois Curfman McInnes MATOP_GET_DIAGONAL=17, 13111c1c02c0SLois Curfman McInnes MATOP_DIAGONAL_SCALE=18, 13121c1c02c0SLois Curfman McInnes MATOP_NORM=19, 13131c1c02c0SLois Curfman McInnes MATOP_ASSEMBLY_BEGIN=20, 13141c1c02c0SLois Curfman McInnes MATOP_ASSEMBLY_END=21, 13151c1c02c0SLois Curfman McInnes MATOP_COMPRESS=22, 13161c1c02c0SLois Curfman McInnes MATOP_SET_OPTION=23, 13171c1c02c0SLois Curfman McInnes MATOP_ZERO_ENTRIES=24, 13181c1c02c0SLois Curfman McInnes MATOP_ZERO_ROWS=25, 13191c1c02c0SLois Curfman McInnes MATOP_LUFACTOR_SYMBOLIC=26, 13201c1c02c0SLois Curfman McInnes MATOP_LUFACTOR_NUMERIC=27, 13211c1c02c0SLois Curfman McInnes MATOP_CHOLESKY_FACTOR_SYMBOLIC=28, 13221c1c02c0SLois Curfman McInnes MATOP_CHOLESKY_FACTOR_NUMERIC=29, 1323d643ce63SMatthew Knepley MATOP_SETUP_PREALLOCATION=30, 1324d643ce63SMatthew Knepley MATOP_ILUFACTOR_SYMBOLIC=31, 1325d643ce63SMatthew Knepley MATOP_ICCFACTOR_SYMBOLIC=32, 1326d643ce63SMatthew Knepley MATOP_GET_ARRAY=33, 1327d643ce63SMatthew Knepley MATOP_RESTORE_ARRAY=34, 1328e26f1c3cSBarry Smith MATOP_DUPLICATE=35, 1329d643ce63SMatthew Knepley MATOP_FORWARD_SOLVE=36, 1330d643ce63SMatthew Knepley MATOP_BACKWARD_SOLVE=37, 1331d643ce63SMatthew Knepley MATOP_ILUFACTOR=38, 1332d643ce63SMatthew Knepley MATOP_ICCFACTOR=39, 1333d643ce63SMatthew Knepley MATOP_AXPY=40, 1334d643ce63SMatthew Knepley MATOP_GET_SUBMATRICES=41, 1335d643ce63SMatthew Knepley MATOP_INCREASE_OVERLAP=42, 1336d643ce63SMatthew Knepley MATOP_GET_VALUES=43, 1337d643ce63SMatthew Knepley MATOP_COPY=44, 1338d643ce63SMatthew Knepley MATOP_PRINT_HELP=45, 1339d643ce63SMatthew Knepley MATOP_SCALE=46, 1340d643ce63SMatthew Knepley MATOP_SHIFT=47, 1341d643ce63SMatthew Knepley MATOP_DIAGONAL_SHIFT=48, 1342d643ce63SMatthew Knepley MATOP_ILUDT_FACTOR=49, 1343d643ce63SMatthew Knepley MATOP_GET_BLOCK_SIZE=50, 1344d643ce63SMatthew Knepley MATOP_GET_ROW_IJ=51, 1345d643ce63SMatthew Knepley MATOP_RESTORE_ROW_IJ=52, 1346d643ce63SMatthew Knepley MATOP_GET_COLUMN_IJ=53, 1347d643ce63SMatthew Knepley MATOP_RESTORE_COLUMN_IJ=54, 1348d643ce63SMatthew Knepley MATOP_FDCOLORING_CREATE=55, 1349d643ce63SMatthew Knepley MATOP_COLORING_PATCH=56, 1350d643ce63SMatthew Knepley MATOP_SET_UNFACTORED=57, 1351d643ce63SMatthew Knepley MATOP_PERMUTE=58, 1352d643ce63SMatthew Knepley MATOP_SET_VALUES_BLOCKED=59, 1353d643ce63SMatthew Knepley MATOP_GET_SUBMATRIX=60, 1354d643ce63SMatthew Knepley MATOP_DESTROY=61, 1355d643ce63SMatthew Knepley MATOP_VIEW=62, 1356d643ce63SMatthew Knepley MATOP_GET_MAPS=63, 1357d643ce63SMatthew Knepley MATOP_USE_SCALED_FORM=64, 1358d643ce63SMatthew Knepley MATOP_SCALE_SYSTEM=65, 1359d643ce63SMatthew Knepley MATOP_UNSCALE_SYSTEM=66, 1360ba16a8cbSKris Buschelman MATOP_SET_LOCAL_TO_GLOBAL_MAP=67, 1361d643ce63SMatthew Knepley MATOP_SET_VALUES_LOCAL=68, 1362d643ce63SMatthew Knepley MATOP_ZERO_ROWS_LOCAL=69, 1363d643ce63SMatthew Knepley MATOP_GET_ROW_MAX=70, 1364d643ce63SMatthew Knepley MATOP_CONVERT=71, 1365d643ce63SMatthew Knepley MATOP_SET_COLORING=72, 1366d643ce63SMatthew Knepley MATOP_SET_VALUES_ADIC=73, 1367d643ce63SMatthew Knepley MATOP_SET_VALUES_ADIFOR=74, 1368d643ce63SMatthew Knepley MATOP_FD_COLORING_APPLY=75, 1369d643ce63SMatthew Knepley MATOP_SET_FROM_OPTIONS=76, 1370ba16a8cbSKris Buschelman MATOP_MULT_CON=77, 1371ba16a8cbSKris Buschelman MATOP_MULT_TRANSPOSE_CON=78, 1372ba16a8cbSKris Buschelman MATOP_ILU_FACTOR_SYMBOLIC_CON=79, 1373d643ce63SMatthew Knepley MATOP_PERMUTE_SPARSIFY=80, 1374d643ce63SMatthew Knepley MATOP_MULT_MULTIPLE=81, 137541acf15aSKris Buschelman MATOP_SOLVE_MULTIPLE=82, 137641acf15aSKris Buschelman MATOP_GET_INERTIA=83, 137741acf15aSKris Buschelman MATOP_LOAD=84, 137841acf15aSKris Buschelman MATOP_IS_SYMMETRIC=85, 137941acf15aSKris Buschelman MATOP_IS_HERMITIAN=86, 138041acf15aSKris Buschelman MATOP_IS_STRUCTURALLY_SYMMETRIC=87, 138141acf15aSKris Buschelman MATOP_PB_RELAX=88, 138241acf15aSKris Buschelman MATOP_GET_VECS=89, 138341acf15aSKris Buschelman MATOP_MAT_MULT=90, 138441acf15aSKris Buschelman MATOP_MAT_MULT_SYMBOLIC=91, 138541acf15aSKris Buschelman MATOP_MAT_MULT_NUMERIC=92, 138641acf15aSKris Buschelman MATOP_PTAP=93, 138741acf15aSKris Buschelman MATOP_PTAP_SYMBOLIC=94, 1388bc011b1eSHong Zhang MATOP_PTAP_NUMERIC=95, 1389bc011b1eSHong Zhang MATOP_MAT_MULTTRANSPOSE=96, 1390bc011b1eSHong Zhang MATOP_MAT_MULTTRANSPOSE_SYMBOLIC=97, 13917ba1a0bfSKris Buschelman MATOP_MAT_MULTTRANSPOSE_NUMERIC=98, 13927ba1a0bfSKris Buschelman MATOP_PTAP_SYMBOLIC_SEQAIJ=99, 13937ba1a0bfSKris Buschelman MATOP_PTAP_NUMERIC_SEQAIJ=100, 13947ba1a0bfSKris Buschelman MATOP_PTAP_SYMBOLIC_MPIAIJ=101, 139587d4246cSBarry Smith MATOP_PTAP_NUMERIC_MPIAIJ=102, 1396f5edf698SHong Zhang MATOP_SET_VALUES_ROW = 105, 1397d5c63f83SSatish Balay MATOP_GET_ROW_UTRIANGULAR=108, 13982bebee5dSHong Zhang MATOP_RESTORE_ROW_UTRIANGULAR=109, 13992bebee5dSHong Zhang MATOP_MATSOLVE=110 1400fae171e0SBarry Smith } MatOperation; 1401be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHasOperation(Mat,MatOperation,PetscTruth*); 1402be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetOperation(Mat,MatOperation,void(*)(void)); 1403be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetOperation(Mat,MatOperation,void(**)(void)); 1404be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetContext(Mat,void*); 1405112a2221SBarry Smith 140690ace30eSBarry Smith /* 140790ace30eSBarry Smith Codes for matrices stored on disk. By default they are 140890ace30eSBarry Smith stored in a universal format. By changing the format with 1409fb9695e5SSatish Balay PetscViewerSetFormat(viewer,PETSC_VIEWER_BINARY_NATIVE); the matrices will 141090ace30eSBarry Smith be stored in a way natural for the matrix, for example dense matrices 141190ace30eSBarry Smith would be stored as dense. Matrices stored this way may only be 141290ace30eSBarry Smith read into matrices of the same time. 141390ace30eSBarry Smith */ 141490ace30eSBarry Smith #define MATRIX_BINARY_FORMAT_DENSE -1 141590ace30eSBarry Smith 1416be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetHashTableFactor(Mat,PetscReal); 1417be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatISGetLocalMat(Mat,Mat*); 14181f4e1ec7SBarry Smith 1419d9274352SBarry Smith /*S 1420d9274352SBarry Smith MatNullSpace - Object that removes a null space from a vector, i.e. 1421d9274352SBarry Smith orthogonalizes the vector to a subsapce 1422d9274352SBarry Smith 1423f7a9e4ceSBarry Smith Level: advanced 1424d9274352SBarry Smith 1425d9274352SBarry Smith Concepts: matrix; linear operator, null space 1426d9274352SBarry Smith 14276e1639daSBarry Smith Users manual sections: 14286e1639daSBarry Smith . sec_singular 14296e1639daSBarry Smith 1430d9274352SBarry Smith .seealso: MatNullSpaceCreate() 1431d9274352SBarry Smith S*/ 143274637425SBarry Smith typedef struct _p_MatNullSpace* MatNullSpace; 1433d9274352SBarry Smith 1434be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceCreate(MPI_Comm,PetscTruth,PetscInt,const Vec[],MatNullSpace*); 1435281d1b2eSBarry Smith EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(Vec,void*),void*); 1436be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceDestroy(MatNullSpace); 1437be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceRemove(MatNullSpace,Vec,Vec*); 1438be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceAttach(Mat,MatNullSpace); 1439be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceTest(MatNullSpace,Mat); 144074637425SBarry Smith 1441be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderingSeqSBAIJ(Mat,IS); 1442be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetHashTableFactor(Mat,PetscReal); 1443be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetColumnIndices(Mat,PetscInt *); 144446129b97SKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJInvertBlockDiagonal(Mat); 14453f1d51d7SBarry Smith 1446be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMAIJ(Mat,PetscInt,Mat*); 1447be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJRedimension(Mat,PetscInt,Mat*); 1448be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJGetAIJ(Mat,Mat*); 1449c4f061fbSSatish Balay 1450be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatComputeExplicitOperator(Mat,Mat*); 1451b0a32e0cSBarry Smith 1452be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScaleLocal(Mat,Vec); 145304f1ad80SBarry Smith 1454be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *); 1455be1d678aSKris Buschelman EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *); 14567dbadf16SMatthew Knepley 1457e9fa29b7SSatish Balay PETSC_EXTERN_CXX_END 14582eac72dbSBarry Smith #endif 1459