1 /* 2 Include file for the matrix component of PETSc 3 */ 4 #ifndef __PETSCMAT_H 5 #define __PETSCMAT_H 6 #include "petscvec.h" 7 PETSC_EXTERN_CXX_BEGIN 8 9 /*S 10 Mat - Abstract PETSc matrix object 11 12 Level: beginner 13 14 Concepts: matrix; linear operator 15 16 .seealso: MatCreate(), MatType, MatSetType() 17 S*/ 18 typedef struct _p_Mat* Mat; 19 20 /*E 21 MatType - String with the name of a PETSc matrix or the creation function 22 with an optional dynamic library name, for example 23 http://www.mcs.anl.gov/petsc/lib.a:mymatcreate() 24 25 Level: beginner 26 27 .seealso: MatSetType(), Mat 28 E*/ 29 #define MATSAME "same" 30 #define MATSEQMAIJ "seqmaij" 31 #define MATMPIMAIJ "mpimaij" 32 #define MATMAIJ "maij" 33 #define MATIS "is" 34 #define MATMPIROWBS "mpirowbs" 35 #define MATSEQAIJ "seqaij" 36 #define MATMPIAIJ "mpiaij" 37 #define MATAIJ "aij" 38 #define MATSHELL "shell" 39 #define MATSEQBDIAG "seqbdiag" 40 #define MATMPIBDIAG "mpibdiag" 41 #define MATBDIAG "bdiag" 42 #define MATSEQDENSE "seqdense" 43 #define MATMPIDENSE "mpidense" 44 #define MATDENSE "dense" 45 #define MATSEQBAIJ "seqbaij" 46 #define MATMPIBAIJ "mpibaij" 47 #define MATBAIJ "baij" 48 #define MATMPIADJ "mpiadj" 49 #define MATSEQSBAIJ "seqsbaij" 50 #define MATMPISBAIJ "mpisbaij" 51 #define MATSBAIJ "sbaij" 52 #define MATDAAD "daad" 53 #define MATMFFD "mffd" 54 #define MATNORMAL "normal" 55 #define MATLRC "lrc" 56 #define MATSEQAIJSPOOLES "seqaijspooles" 57 #define MATMPIAIJSPOOLES "mpiaijspooles" 58 #define MATSEQSBAIJSPOOLES "seqsbaijspooles" 59 #define MATMPISBAIJSPOOLES "mpisbaijspooles" 60 #define MATAIJSPOOLES "aijspooles" 61 #define MATSBAIJSPOOLES "sbaijspooles" 62 #define MATSUPERLU "superlu" 63 #define MATSUPERLU_DIST "superlu_dist" 64 #define MATUMFPACK "umfpack" 65 #define MATESSL "essl" 66 #define MATLUSOL "lusol" 67 #define MATAIJMUMPS "aijmumps" 68 #define MATSBAIJMUMPS "sbaijmumps" 69 #define MATDSCPACK "dscpack" 70 #define MATMATLAB "matlab" 71 #define MATSEQCSRPERM "seqcsrperm" 72 #define MATMPICSRPERM "mpicsrperm" 73 #define MATCSRPERM "csrperm" 74 #define MATSEQCRL "seqcrl" 75 #define MATMPICRL "mpicrl" 76 #define MATCRL "crl" 77 #define MATPLAPACK "plapack" 78 #define MATSCATTER "scatter" 79 #define MATBLOCKMAT "blockmat" 80 #define MatType const char* 81 82 /* Logging support */ 83 #define MAT_FILE_COOKIE 1211216 /* used to indicate matrices in binary files */ 84 extern PetscCookie PETSCMAT_DLLEXPORT MAT_COOKIE; 85 extern PetscCookie PETSCMAT_DLLEXPORT MAT_FDCOLORING_COOKIE; 86 extern PetscCookie PETSCMAT_DLLEXPORT MAT_PARTITIONING_COOKIE; 87 extern PetscCookie PETSCMAT_DLLEXPORT MAT_NULLSPACE_COOKIE; 88 89 /*E 90 MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices() 91 or MatGetSubMatrix() are to be reused to store the new matrix values. 92 93 Level: beginner 94 95 Any additions/changes here MUST also be made in include/finclude/petscmat.h 96 97 .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert() 98 E*/ 99 typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX} MatReuse; 100 101 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInitializePackage(char *); 102 103 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreate(MPI_Comm,Mat*); 104 PetscPolymorphicFunction(MatCreate,(MPI_Comm comm),(comm,&A),Mat,A) 105 PetscPolymorphicFunction(MatCreate,(),(PETSC_COMM_WORLD,&A),Mat,A) 106 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt); 107 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetType(Mat,MatType); 108 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetFromOptions(Mat); 109 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUpPreallocation(Mat); 110 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegisterAll(const char[]); 111 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat)); 112 113 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOptionsPrefix(Mat,const char[]); 114 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAppendOptionsPrefix(Mat,const char[]); 115 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOptionsPrefix(Mat,const char*[]); 116 117 /*MC 118 MatRegisterDynamic - Adds a new matrix type 119 120 Synopsis: 121 PetscErrorCode MatRegisterDynamic(char *name,char *path,char *name_create,PetscErrorCode (*routine_create)(Mat)) 122 123 Not Collective 124 125 Input Parameters: 126 + name - name of a new user-defined matrix type 127 . path - path (either absolute or relative) the library containing this solver 128 . name_create - name of routine to create method context 129 - routine_create - routine to create method context 130 131 Notes: 132 MatRegisterDynamic() may be called multiple times to add several user-defined solvers. 133 134 If dynamic libraries are used, then the fourth input argument (routine_create) 135 is ignored. 136 137 Sample usage: 138 .vb 139 MatRegisterDynamic("my_mat",/home/username/my_lib/lib/libO/solaris/mylib.a, 140 "MyMatCreate",MyMatCreate); 141 .ve 142 143 Then, your solver can be chosen with the procedural interface via 144 $ MatSetType(Mat,"my_mat") 145 or at runtime via the option 146 $ -mat_type my_mat 147 148 Level: advanced 149 150 Notes: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values. 151 If your function is not being put into a shared library then use VecRegister() instead 152 153 .keywords: Mat, register 154 155 .seealso: MatRegisterAll(), MatRegisterDestroy() 156 157 M*/ 158 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 159 #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,0) 160 #else 161 #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,d) 162 #endif 163 164 extern PetscTruth MatRegisterAllCalled; 165 extern PetscFList MatList; 166 167 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*); 168 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*); 169 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 170 PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,nz,nnz,&A),Mat,A) 171 PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,&A),Mat,A) 172 PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,0,nnz,&A),Mat,A) 173 PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,&A),Mat,A) 174 PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,A)) 175 PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,m,n,0,nnz,A)) 176 PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,A)) 177 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 178 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) 179 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) 180 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) 181 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) 182 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)) 183 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)) 184 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)) 185 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) 186 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) 187 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) 188 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) 189 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)) 190 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)) 191 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)) 192 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *); 193 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIRowbs(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 194 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBDiag(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscScalar*[],Mat*); 195 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBDiag(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscScalar*[],Mat*); 196 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 197 PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A) 198 PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A) 199 PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A) 200 PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A) 201 PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A)) 202 PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A)) 203 PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A)) 204 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 205 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) 206 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) 207 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) 208 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) 209 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)) 210 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)) 211 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)) 212 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) 213 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) 214 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) 215 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) 216 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)) 217 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)) 218 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)) 219 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*); 220 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 221 PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A) 222 PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A) 223 PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A) 224 PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A) 225 PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A)) 226 PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A)) 227 PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A)) 228 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPISBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 229 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) 230 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) 231 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) 232 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) 233 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)) 234 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)) 235 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)) 236 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) 237 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) 238 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) 239 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) 240 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)) 241 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)) 242 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)) 243 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*); 244 PetscPolymorphicFunction(MatCreateShell,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(comm,m,n,M,N,ctx,&A),Mat,A) 245 PetscPolymorphicFunction(MatCreateShell,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(PETSC_COMM_WORLD,m,n,M,N,ctx,&A),Mat,A) 246 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateAdic(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,void (*)(void),Mat*); 247 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateNormal(Mat,Mat*); 248 PetscPolymorphicFunction(MatCreateNormal,(Mat mat),(mat,&A),Mat,A) 249 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateLRC(Mat,Mat,Mat,Mat*); 250 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,Mat*); 251 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 252 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMPICRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 253 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateScatter(MPI_Comm,VecScatter,Mat*); 254 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScatterSetVecScatter(Mat,VecScatter); 255 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScatterGetVecScatter(Mat,VecScatter*); 256 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,Mat*); 257 258 259 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUp(Mat); 260 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy(Mat); 261 262 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConjugate(Mat); 263 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRealPart(Mat); 264 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatImaginaryPart(Mat); 265 266 /* ------------------------------------------------------------*/ 267 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 268 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 269 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRow(Mat,PetscInt,const PetscScalar[]); 270 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]); 271 272 /*S 273 MatStencil - Data structure (C struct) for storing information about a single row or 274 column of a matrix as index on an associated grid. 275 276 Level: beginner 277 278 Concepts: matrix; linear operator 279 280 .seealso: MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockStencil() 281 S*/ 282 typedef struct { 283 PetscInt k,j,i,c; 284 } MatStencil; 285 286 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode); 287 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode); 288 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt); 289 290 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetColoring(Mat,ISColoring); 291 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdic(Mat,void*); 292 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesAdifor(Mat,PetscInt,void*); 293 294 /*E 295 MatAssemblyType - Indicates if the matrix is now to be used, or if you plan 296 to continue to add values to it 297 298 Level: beginner 299 300 .seealso: MatAssemblyBegin(), MatAssemblyEnd() 301 E*/ 302 typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType; 303 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyBegin(Mat,MatAssemblyType); 304 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssemblyEnd(Mat,MatAssemblyType); 305 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAssembled(Mat,PetscTruth*); 306 307 extern PETSCMAT_DLLEXPORT PetscInt MatSetValue_Row; 308 extern PETSCMAT_DLLEXPORT PetscInt MatSetValue_Column; 309 extern PETSCMAT_DLLEXPORT PetscScalar MatSetValue_Value; 310 311 /*MC 312 MatSetValue - Set a single entry into a matrix. 313 314 Synopsis: 315 PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode); 316 317 Not collective 318 319 Input Parameters: 320 + m - the matrix 321 . row - the row location of the entry 322 . col - the column location of the entry 323 . value - the value to insert 324 - mode - either INSERT_VALUES or ADD_VALUES 325 326 Notes: 327 For efficiency one should use MatSetValues() and set several or many 328 values simultaneously if possible. 329 330 Level: beginner 331 332 .seealso: MatSetValues(), MatSetValueLocal() 333 M*/ 334 #define MatSetValue(v,i,j,va,mode) \ 335 ((MatSetValue_Row = i,MatSetValue_Column = j,MatSetValue_Value = va,0) || \ 336 MatSetValues(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&MatSetValue_Value,mode)) 337 338 #define MatGetValue(v,i,j,va) \ 339 ((MatSetValue_Row = i,MatSetValue_Column = j,0) || \ 340 MatGetValues(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&va)) 341 342 #define MatSetValueLocal(v,i,j,va,mode) \ 343 ((MatSetValue_Row = i,MatSetValue_Column = j,MatSetValue_Value = va,0) || \ 344 MatSetValuesLocal(v,1,&MatSetValue_Row,1,&MatSetValue_Column,&MatSetValue_Value,mode)) 345 346 /*E 347 MatOption - Options that may be set for a matrix and its behavior or storage 348 349 Level: beginner 350 351 Any additions/changes here MUST also be made in include/finclude/petscmat.h 352 353 .seealso: MatSetOption() 354 E*/ 355 typedef enum {MAT_ROW_ORIENTED,MAT_COLUMN_ORIENTED,MAT_ROWS_SORTED, 356 MAT_COLUMNS_SORTED,MAT_NO_NEW_NONZERO_LOCATIONS, 357 MAT_YES_NEW_NONZERO_LOCATIONS,MAT_SYMMETRIC, 358 MAT_STRUCTURALLY_SYMMETRIC,MAT_NO_NEW_DIAGONALS, 359 MAT_YES_NEW_DIAGONALS,MAT_INODE_LIMIT_1,MAT_INODE_LIMIT_2, 360 MAT_INODE_LIMIT_3,MAT_INODE_LIMIT_4,MAT_INODE_LIMIT_5, 361 MAT_IGNORE_OFF_PROC_ENTRIES,MAT_ROWS_UNSORTED, 362 MAT_COLUMNS_UNSORTED,MAT_NEW_NONZERO_LOCATION_ERR, 363 MAT_NEW_NONZERO_ALLOCATION_ERR,MAT_USE_HASH_TABLE, 364 MAT_KEEP_ZEROED_ROWS,MAT_IGNORE_ZERO_ENTRIES,MAT_USE_INODES, 365 MAT_DO_NOT_USE_INODES,MAT_NOT_SYMMETRIC,MAT_HERMITIAN, 366 MAT_NOT_STRUCTURALLY_SYMMETRIC,MAT_NOT_HERMITIAN, 367 MAT_SYMMETRY_ETERNAL,MAT_NOT_SYMMETRY_ETERNAL, 368 MAT_USE_COMPRESSEDROW,MAT_DO_NOT_USE_COMPRESSEDROW, 369 MAT_IGNORE_LOWER_TRIANGULAR,MAT_ERROR_LOWER_TRIANGULAR,MAT_GETROW_UPPERTRIANGULAR} MatOption; 370 extern const char *MatOptions[]; 371 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetOption(Mat,MatOption); 372 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetType(Mat,MatType*); 373 PetscPolymorphicFunction(MatGetType,(Mat mat),(mat,&t),MatType,t) 374 375 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]); 376 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 377 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 378 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowUpperTriangular(Mat); 379 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowUpperTriangular(Mat); 380 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 381 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 382 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnVector(Mat,Vec,PetscInt); 383 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetArray(Mat,PetscScalar *[]); 384 PetscPolymorphicFunction(MatGetArray,(Mat mat),(mat,&a),PetscScalar*,a) 385 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreArray(Mat,PetscScalar *[]); 386 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBlockSize(Mat,PetscInt *); 387 PetscPolymorphicFunction(MatGetBlockSize,(Mat mat),(mat,&a),PetscInt,a) 388 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetBlockSize(Mat,PetscInt); 389 390 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMult(Mat,Vec,Vec); 391 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAdd(Mat,Vec,Vec,Vec); 392 PetscPolymorphicSubroutine(MatMultAdd,(Mat A,Vec x,Vec y),(A,x,y,y)) 393 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTranspose(Mat,Vec,Vec); 394 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsTranspose(Mat,Mat,PetscReal,PetscTruth*); 395 PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B,PetscReal tol),(A,B,tol,&t),PetscTruth,t) 396 PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B),(A,B,0,&t),PetscTruth,t) 397 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAdd(Mat,Vec,Vec,Vec); 398 PetscPolymorphicSubroutine(MatMultTransposeAdd,(Mat A,Vec x,Vec y),(A,x,y,y)) 399 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultConstrained(Mat,Vec,Vec); 400 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeConstrained(Mat,Vec,Vec); 401 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatSolve(Mat,Mat,Mat); 402 403 /*E 404 MatDuplicateOption - Indicates if a duplicated sparse matrix should have 405 its numerical values copied over or just its nonzero structure. 406 407 Level: beginner 408 409 Any additions/changes here MUST also be made in include/finclude/petscmat.h 410 411 .seealso: MatDuplicate() 412 E*/ 413 typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES} MatDuplicateOption; 414 415 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatConvert(Mat,MatType,MatReuse,Mat*); 416 PetscPolymorphicFunction(MatConvert,(Mat A,MatType t),(A,t,MAT_INITIAL_MATRIX,&a),Mat,a) 417 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDuplicate(Mat,MatDuplicateOption,Mat*); 418 PetscPolymorphicFunction(MatDuplicate,(Mat A,MatDuplicateOption o),(A,o,&a),Mat,a) 419 PetscPolymorphicFunction(MatDuplicate,(Mat A),(A,MAT_COPY_VALUES,&a),Mat,a) 420 421 /*E 422 MatStructure - Indicates if the matrix has the same nonzero structure 423 424 Level: beginner 425 426 Any additions/changes here MUST also be made in include/finclude/petscmat.h 427 428 .seealso: MatCopy(), KSPSetOperators(), PCSetOperators() 429 E*/ 430 typedef enum {SAME_NONZERO_PATTERN,DIFFERENT_NONZERO_PATTERN,SAME_PRECONDITIONER,SUBSET_NONZERO_PATTERN} MatStructure; 431 432 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCopy(Mat,Mat,MatStructure); 433 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatView(Mat,PetscViewer); 434 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetric(Mat,PetscReal,PetscTruth*); 435 PetscPolymorphicFunction(MatIsSymmetric,(Mat A,PetscReal tol),(A,tol,&t),PetscTruth,t) 436 PetscPolymorphicFunction(MatIsSymmetric,(Mat A),(A,0,&t),PetscTruth,t) 437 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsStructurallySymmetric(Mat,PetscTruth*); 438 PetscPolymorphicFunction(MatIsStructurallySymmetric,(Mat A),(A,&t),PetscTruth,t) 439 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitian(Mat,PetscTruth*); 440 PetscPolymorphicFunction(MatIsHermitian,(Mat A),(A,&t),PetscTruth,t) 441 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsSymmetricKnown(Mat,PetscTruth*,PetscTruth*); 442 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIsHermitianKnown(Mat,PetscTruth*,PetscTruth*); 443 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLoad(PetscViewer,MatType,Mat*); 444 PetscPolymorphicFunction(MatLoad,(PetscViewer v,MatType t),(v,t,&a),Mat,a) 445 446 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowIJ(Mat,PetscInt,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *); 447 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreRowIJ(Mat,PetscInt,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *); 448 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColumnIJ(Mat,PetscInt,PetscTruth,PetscInt*,PetscInt *[],PetscInt *[],PetscTruth *); 449 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestoreColumnIJ(Mat,PetscInt,PetscTruth,PetscInt *,PetscInt *[],PetscInt *[],PetscTruth *); 450 451 /*S 452 MatInfo - Context of matrix information, used with MatGetInfo() 453 454 In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE 455 456 Level: intermediate 457 458 Concepts: matrix^nonzero information 459 460 .seealso: MatGetInfo(), MatInfoType 461 S*/ 462 typedef struct { 463 PetscLogDouble rows_global,columns_global; /* number of global rows and columns */ 464 PetscLogDouble rows_local,columns_local; /* number of local rows and columns */ 465 PetscLogDouble block_size; /* block size */ 466 PetscLogDouble nz_allocated,nz_used,nz_unneeded; /* number of nonzeros */ 467 PetscLogDouble memory; /* memory allocated */ 468 PetscLogDouble assemblies; /* number of matrix assemblies called */ 469 PetscLogDouble mallocs; /* number of mallocs during MatSetValues() */ 470 PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */ 471 PetscLogDouble factor_mallocs; /* number of mallocs during factorization */ 472 } MatInfo; 473 474 /*E 475 MatInfoType - Indicates if you want information about the local part of the matrix, 476 the entire parallel matrix or the maximum over all the local parts. 477 478 Level: beginner 479 480 Any additions/changes here MUST also be made in include/finclude/petscmat.h 481 482 .seealso: MatGetInfo(), MatInfo 483 E*/ 484 typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType; 485 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInfo(Mat,MatInfoType,MatInfo*); 486 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatValid(Mat,PetscTruth*); 487 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetDiagonal(Mat,Vec); 488 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRowMax(Mat,Vec); 489 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatTranspose(Mat,Mat*); 490 PetscPolymorphicFunction(MatTranspose,(Mat A),(A,&t),Mat,t) 491 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermute(Mat,IS,IS,Mat *); 492 PetscPolymorphicFunction(MatPermute,(Mat A,IS is1,IS is2),(A,is1,is2,&t),Mat,t) 493 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPermuteSparsify(Mat,PetscInt,PetscReal,PetscReal,IS,IS,Mat *); 494 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScale(Mat,Vec,Vec); 495 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalSet(Mat,Vec,InsertMode); 496 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatEqual(Mat,Mat,PetscTruth*); 497 PetscPolymorphicFunction(MatEqual,(Mat A,Mat B),(A,B,&t),PetscTruth,t) 498 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultEqual(Mat,Mat,PetscInt,PetscTruth*); 499 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultAddEqual(Mat,Mat,PetscInt,PetscTruth*); 500 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeEqual(Mat,Mat,PetscInt,PetscTruth*); 501 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscTruth*); 502 503 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNorm(Mat,NormType,PetscReal *); 504 PetscPolymorphicFunction(MatNorm,(Mat A,NormType t),(A,t,&n),PetscReal,n) 505 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroEntries(Mat); 506 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar); 507 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsIS(Mat,IS,PetscScalar); 508 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumns(Mat,PetscInt,const PetscInt [],const PetscScalar*); 509 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumnsIS(Mat,IS,const PetscScalar*); 510 511 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUseScaledForm(Mat,PetscTruth); 512 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScaleSystem(Mat,Vec,Vec); 513 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUnScaleSystem(Mat,Vec,Vec); 514 515 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSize(Mat,PetscInt*,PetscInt*); 516 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalSize(Mat,PetscInt*,PetscInt*); 517 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRange(Mat,PetscInt*,PetscInt*); 518 519 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]); 520 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroyMatrices(PetscInt,Mat *[]); 521 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrix(Mat,IS,IS,PetscInt,MatReuse,Mat *); 522 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrixRaw(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscInt,MatReuse,Mat *); 523 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*); 524 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*); 525 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*); 526 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPINumeric(Mat,Mat); 527 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy_MPIAIJ_SeqsToMPI(Mat); 528 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMat(Mat,MatReuse,Mat*); 529 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*); 530 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*); 531 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,PetscScalar**,Mat*); 532 #if defined (PETSC_USE_CTABLE) 533 #include "petscctable.h" 534 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscTable *, VecScatter *); 535 #else 536 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscInt *[], VecScatter *); 537 #endif 538 539 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt); 540 541 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*); 542 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*); 543 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultNumeric(Mat,Mat,Mat); 544 545 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*); 546 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*); 547 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPNumeric(Mat,Mat,Mat); 548 549 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*); 550 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*); 551 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeNumeric(Mat,Mat,Mat); 552 553 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAXPY(Mat,PetscScalar,Mat,MatStructure); 554 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAYPX(Mat,PetscScalar,Mat,MatStructure); 555 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCompress(Mat); 556 557 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScale(Mat,PetscScalar); 558 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShift(Mat,PetscScalar); 559 560 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping); 561 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping); 562 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar); 563 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocalIS(Mat,IS,PetscScalar); 564 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 565 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 566 567 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashSetInitialSize(Mat,PetscInt,PetscInt); 568 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 569 570 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolate(Mat,Vec,Vec); 571 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolateAdd(Mat,Vec,Vec,Vec); 572 PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y)) 573 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestrict(Mat,Vec,Vec); 574 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetVecs(Mat,Vec*,Vec*); 575 576 /*MC 577 MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per 578 row in a matrix providing the data that one can use to correctly preallocate the matrix. 579 580 Synopsis: 581 PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz) 582 583 Collective on MPI_Comm 584 585 Input Parameters: 586 + comm - the communicator that will share the eventually allocated matrix 587 . nrows - the number of LOCAL rows in the matrix 588 - ncols - the number of LOCAL columns in the matrix 589 590 Output Parameters: 591 + dnz - the array that will be passed to the matrix preallocation routines 592 - ozn - the other array passed to the matrix preallocation routines 593 594 595 Level: intermediate 596 597 Notes: 598 See the chapter in the users manual on performance for more details 599 600 Do not malloc or free dnz and onz, that is handled internally by these routines 601 602 Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices) 603 604 Concepts: preallocation^Matrix 605 606 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 607 MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal() 608 M*/ 609 #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \ 610 { \ 611 PetscErrorCode _4_ierr; PetscInt __tmp = (nrows),__ctmp = (ncols),__rstart,__start,__end; \ 612 _4_ierr = PetscMalloc(2*__tmp*sizeof(PetscInt),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\ 613 _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(PetscInt));CHKERRQ(_4_ierr);\ 614 _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\ 615 _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp; 616 617 /*MC 618 MatPreallocateSymmetricInitialize - Begins the block of code that will count the number of nonzeros per 619 row in a matrix providing the data that one can use to correctly preallocate the matrix. 620 621 Synopsis: 622 PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz) 623 624 Collective on MPI_Comm 625 626 Input Parameters: 627 + comm - the communicator that will share the eventually allocated matrix 628 . nrows - the number of LOCAL rows in the matrix 629 - ncols - the number of LOCAL columns in the matrix 630 631 Output Parameters: 632 + dnz - the array that will be passed to the matrix preallocation routines 633 - ozn - the other array passed to the matrix preallocation routines 634 635 636 Level: intermediate 637 638 Notes: 639 See the chapter in the users manual on performance for more details 640 641 Do not malloc or free dnz and onz, that is handled internally by these routines 642 643 Concepts: preallocation^Matrix 644 645 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 646 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal() 647 M*/ 648 #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \ 649 { \ 650 PetscErrorCode _4_ierr; PetscInt __tmp = (nrows),__ctmp = (ncols),__rstart,__end; \ 651 _4_ierr = PetscMalloc(2*__tmp*sizeof(PetscInt),&dnz);CHKERRQ(_4_ierr);onz = dnz + __tmp;\ 652 _4_ierr = PetscMemzero(dnz,2*__tmp*sizeof(PetscInt));CHKERRQ(_4_ierr);\ 653 _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\ 654 _4_ierr = MPI_Scan(&__tmp,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __tmp; 655 656 /*MC 657 MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 658 inserted using a local number of the rows and columns 659 660 Synopsis: 661 PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 662 663 Not Collective 664 665 Input Parameters: 666 + map - the mapping between local numbering and global numbering 667 . nrows - the number of rows indicated 668 . rows - the indices of the rows 669 . ncols - the number of columns in the matrix 670 . cols - the columns indicated 671 . dnz - the array that will be passed to the matrix preallocation routines 672 - ozn - the other array passed to the matrix preallocation routines 673 674 675 Level: intermediate 676 677 Notes: 678 See the chapter in the users manual on performance for more details 679 680 Do not malloc or free dnz and onz, that is handled internally by these routines 681 682 Concepts: preallocation^Matrix 683 684 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 685 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal() 686 M*/ 687 #define MatPreallocateSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\ 688 {\ 689 PetscInt __l;\ 690 _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\ 691 _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\ 692 for (__l=0;__l<nrows;__l++) {\ 693 _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 694 }\ 695 } 696 697 /*MC 698 MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 699 inserted using a local number of the rows and columns 700 701 Synopsis: 702 PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 703 704 Not Collective 705 706 Input Parameters: 707 + map - the mapping between local numbering and global numbering 708 . nrows - the number of rows indicated 709 . rows - the indices of the rows 710 . ncols - the number of columns in the matrix 711 . cols - the columns indicated 712 . dnz - the array that will be passed to the matrix preallocation routines 713 - ozn - the other array passed to the matrix preallocation routines 714 715 716 Level: intermediate 717 718 Notes: 719 See the chapter in the users manual on performance for more details 720 721 Do not malloc or free dnz and onz that is handled internally by these routines 722 723 Concepts: preallocation^Matrix 724 725 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 726 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 727 M*/ 728 #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\ 729 {\ 730 PetscInt __l;\ 731 _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\ 732 _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\ 733 for (__l=0;__l<nrows;__l++) {\ 734 _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 735 }\ 736 } 737 738 /*MC 739 MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 740 inserted using a local number of the rows and columns 741 742 Synopsis: 743 PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 744 745 Not Collective 746 747 Input Parameters: 748 + nrows - the number of rows indicated 749 . rows - the indices of the rows 750 . ncols - the number of columns in the matrix 751 - cols - the columns indicated 752 753 Output Parameters: 754 + dnz - the array that will be passed to the matrix preallocation routines 755 - ozn - the other array passed to the matrix preallocation routines 756 757 758 Level: intermediate 759 760 Notes: 761 See the chapter in the users manual on performance for more details 762 763 Do not malloc or free dnz and onz that is handled internally by these routines 764 765 Concepts: preallocation^Matrix 766 767 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 768 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 769 M*/ 770 #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\ 771 { PetscInt __i; \ 772 for (__i=0; __i<nc; __i++) {\ 773 if (cols[__i] < __start || cols[__i] >= __end) onz[row - __rstart]++; \ 774 }\ 775 dnz[row - __rstart] = nc - onz[row - __rstart];\ 776 } 777 778 /*MC 779 MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 780 inserted using a local number of the rows and columns 781 782 Synopsis: 783 PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 784 785 Not Collective 786 787 Input Parameters: 788 + nrows - the number of rows indicated 789 . rows - the indices of the rows 790 . ncols - the number of columns in the matrix 791 . cols - the columns indicated 792 . dnz - the array that will be passed to the matrix preallocation routines 793 - ozn - the other array passed to the matrix preallocation routines 794 795 796 Level: intermediate 797 798 Notes: 799 See the chapter in the users manual on performance for more details 800 801 Do not malloc or free dnz and onz that is handled internally by these routines 802 803 Concepts: preallocation^Matrix 804 805 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 806 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 807 M*/ 808 #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\ 809 { PetscInt __i; \ 810 for (__i=0; __i<nc; __i++) {\ 811 if (cols[__i] >= __end) onz[row - __rstart]++; \ 812 else if (cols[__i] >= row) dnz[row - __rstart]++;\ 813 }\ 814 } 815 816 /*MC 817 MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per 818 row in a matrix providing the data that one can use to correctly preallocate the matrix. 819 820 Synopsis: 821 PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz) 822 823 Collective on MPI_Comm 824 825 Input Parameters: 826 + dnz - the array that will be passed to the matrix preallocation routines 827 - ozn - the other array passed to the matrix preallocation routines 828 829 830 Level: intermediate 831 832 Notes: 833 See the chapter in the users manual on performance for more details 834 835 Do not malloc or free dnz and onz that is handled internally by these routines 836 837 Concepts: preallocation^Matrix 838 839 .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 840 MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal() 841 M*/ 842 #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree(dnz);CHKERRQ(_4_ierr);} 843 844 845 846 /* Routines unique to particular data structures */ 847 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetContext(Mat,void **); 848 PetscPolymorphicFunction(MatShellGetContext,(Mat A),(A,&t),void*,t) 849 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBDiagGetData(Mat,PetscInt*,PetscInt*,PetscInt*[],PetscInt*[],PetscScalar***); 850 851 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeAdjustForInodes(Mat,IS*,IS*); 852 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *); 853 854 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetColumnIndices(Mat,PetscInt[]); 855 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetColumnIndices(Mat,PetscInt[]); 856 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 857 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 858 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 859 860 #define MAT_SKIP_ALLOCATION -4 861 862 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 863 PetscPolymorphicSubroutine(MatSeqBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz)) 864 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 865 PetscPolymorphicSubroutine(MatSeqSBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz)) 866 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]); 867 PetscPolymorphicSubroutine(MatSeqAIJSetPreallocation,(Mat A,const PetscInt nnz[]),(A,0,nnz)) 868 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDensePreallocation(Mat,PetscScalar[]); 869 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBDiagSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscScalar*[]); 870 871 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 872 PetscPolymorphicSubroutine(MatMPIBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[],const PetscInt onz[]),(A,bs,0,nnz,0,onz)) 873 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 874 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 875 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []); 876 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]); 877 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 878 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDensePreallocation(Mat,PetscScalar[]); 879 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBDiagSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscScalar*[]); 880 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]); 881 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDenseSetPreallocation(Mat,PetscScalar[]); 882 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetPreallocation(Mat,PetscScalar[]); 883 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIRowbsSetPreallocation(Mat,PetscInt,const PetscInt[]); 884 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]); 885 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]); 886 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAdicSetLocalFunction(Mat,void (*)(void)); 887 888 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetLDA(Mat,PetscInt); 889 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDenseGetLocalMatrix(Mat,Mat*); 890 891 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStoreValues(Mat); 892 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRetrieveValues(Mat); 893 894 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDAADSetCtx(Mat,void*); 895 896 /* 897 These routines are not usually accessed directly, rather solving is 898 done through the KSP and PC interfaces. 899 */ 900 901 /*E 902 MatOrderingType - String with the name of a PETSc matrix ordering or the creation function 903 with an optional dynamic library name, for example 904 http://www.mcs.anl.gov/petsc/lib.a:orderingcreate() 905 906 Level: beginner 907 908 .seealso: MatGetOrdering() 909 E*/ 910 #define MatOrderingType char* 911 #define MATORDERING_NATURAL "natural" 912 #define MATORDERING_ND "nd" 913 #define MATORDERING_1WD "1wd" 914 #define MATORDERING_RCM "rcm" 915 #define MATORDERING_QMD "qmd" 916 #define MATORDERING_ROWLENGTH "rowlength" 917 #define MATORDERING_DSC_ND "dsc_nd" 918 #define MATORDERING_DSC_MMD "dsc_mmd" 919 #define MATORDERING_DSC_MDF "dsc_mdf" 920 #define MATORDERING_CONSTRAINED "constrained" 921 #define MATORDERING_IDENTITY "identity" 922 #define MATORDERING_REVERSE "reverse" 923 924 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrdering(Mat,const MatOrderingType,IS*,IS*); 925 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrderingList(PetscFList *list); 926 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*)); 927 928 /*MC 929 MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the 930 matrix package. 931 932 Synopsis: 933 PetscErrorCode MatOrderingRegisterDynamic(char *name_ordering,char *path,char *name_create,PetscErrorCode (*routine_create)(MatOrdering)) 934 935 Not Collective 936 937 Input Parameters: 938 + sname - name of ordering (for example MATORDERING_ND) 939 . path - location of library where creation routine is 940 . name - name of function that creates the ordering type,a string 941 - function - function pointer that creates the ordering 942 943 Level: developer 944 945 If dynamic libraries are used, then the fourth input argument (function) 946 is ignored. 947 948 Sample usage: 949 .vb 950 MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a, 951 "MyOrder",MyOrder); 952 .ve 953 954 Then, your partitioner can be chosen with the procedural interface via 955 $ MatOrderingSetType(part,"my_order) 956 or at runtime via the option 957 $ -pc_factor_mat_ordering_type my_order 958 959 ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values. 960 961 .keywords: matrix, ordering, register 962 963 .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll() 964 M*/ 965 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 966 #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0) 967 #else 968 #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d) 969 #endif 970 971 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterDestroy(void); 972 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterAll(const char[]); 973 extern PetscTruth MatOrderingRegisterAllCalled; 974 extern PetscFList MatOrderingList; 975 976 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS); 977 978 /*S 979 MatFactorInfo - Data passed into the matrix factorization routines 980 981 In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE 982 983 Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC. 984 985 Level: developer 986 987 .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(), 988 MatFactorInfoInitialize() 989 990 S*/ 991 typedef struct { 992 PetscReal shiftnz; /* scaling of identity added to matrix to prevent zero pivots */ 993 PetscReal shiftpd; /* if true, shift until positive pivots */ 994 PetscReal shift_fraction; /* record shift fraction taken */ 995 PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */ 996 PetscReal dt; /* drop tolerance */ 997 PetscReal dtcol; /* tolerance for pivoting */ 998 PetscReal dtcount; /* maximum nonzeros to be allowed per row */ 999 PetscReal fill; /* expected fill; nonzeros in factored matrix/nonzeros in original matrix*/ 1000 PetscReal levels; /* ICC/ILU(levels) */ 1001 PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0 1002 factorization may be faster if do not pivot */ 1003 PetscReal zeropivot; /* pivot is called zero if less than this */ 1004 } MatFactorInfo; 1005 1006 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorInfoInitialize(MatFactorInfo*); 1007 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactor(Mat,IS,MatFactorInfo*); 1008 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*); 1009 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorNumeric(Mat,MatFactorInfo*,Mat*); 1010 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactor(Mat,IS,IS,MatFactorInfo*); 1011 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactor(Mat,IS,IS,MatFactorInfo*); 1012 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*); 1013 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactorSymbolic(Mat,IS,IS,MatFactorInfo*,Mat*); 1014 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactorSymbolic(Mat,IS,MatFactorInfo*,Mat*); 1015 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactor(Mat,IS,MatFactorInfo*); 1016 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorNumeric(Mat,MatFactorInfo*,Mat*); 1017 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUDTFactor(Mat,IS,IS,MatFactorInfo*,Mat *); 1018 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*); 1019 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolve(Mat,Vec,Vec); 1020 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatForwardSolve(Mat,Vec,Vec); 1021 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBackwardSolve(Mat,Vec,Vec); 1022 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveAdd(Mat,Vec,Vec,Vec); 1023 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTranspose(Mat,Vec,Vec); 1024 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTransposeAdd(Mat,Vec,Vec,Vec); 1025 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolves(Mat,Vecs,Vecs); 1026 1027 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUnfactored(Mat); 1028 1029 /*E 1030 MatSORType - What type of (S)SOR to perform 1031 1032 Level: beginner 1033 1034 May be bitwise ORd together 1035 1036 Any additions/changes here MUST also be made in include/finclude/petscmat.h 1037 1038 MatSORType may be bitwise ORd together, so do not change the numbers 1039 1040 .seealso: MatRelax(), MatPBRelax() 1041 E*/ 1042 typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3, 1043 SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8, 1044 SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16, 1045 SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType; 1046 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec); 1047 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPBRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec); 1048 1049 /* 1050 These routines are for efficiently computing Jacobians via finite differences. 1051 */ 1052 1053 /*E 1054 MatColoringType - String with the name of a PETSc matrix coloring or the creation function 1055 with an optional dynamic library name, for example 1056 http://www.mcs.anl.gov/petsc/lib.a:coloringcreate() 1057 1058 Level: beginner 1059 1060 .seealso: MatGetColoring() 1061 E*/ 1062 #define MatColoringType char* 1063 #define MATCOLORING_NATURAL "natural" 1064 #define MATCOLORING_SL "sl" 1065 #define MATCOLORING_LF "lf" 1066 #define MATCOLORING_ID "id" 1067 1068 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColoring(Mat,const MatColoringType,ISColoring*); 1069 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatColoringType,ISColoring *)); 1070 1071 /*MC 1072 MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the 1073 matrix package. 1074 1075 Synopsis: 1076 PetscErrorCode MatColoringRegisterDynamic(char *name_coloring,char *path,char *name_create,PetscErrorCode (*routine_create)(MatColoring)) 1077 1078 Not Collective 1079 1080 Input Parameters: 1081 + sname - name of Coloring (for example MATCOLORING_SL) 1082 . path - location of library where creation routine is 1083 . name - name of function that creates the Coloring type, a string 1084 - function - function pointer that creates the coloring 1085 1086 Level: developer 1087 1088 If dynamic libraries are used, then the fourth input argument (function) 1089 is ignored. 1090 1091 Sample usage: 1092 .vb 1093 MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a, 1094 "MyColor",MyColor); 1095 .ve 1096 1097 Then, your partitioner can be chosen with the procedural interface via 1098 $ MatColoringSetType(part,"my_color") 1099 or at runtime via the option 1100 $ -mat_coloring_type my_color 1101 1102 $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 1103 1104 .keywords: matrix, Coloring, register 1105 1106 .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll() 1107 M*/ 1108 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1109 #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0) 1110 #else 1111 #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d) 1112 #endif 1113 1114 extern PetscTruth MatColoringRegisterAllCalled; 1115 1116 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterAll(const char[]); 1117 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterDestroy(void); 1118 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*); 1119 1120 /*S 1121 MatFDColoring - Object for computing a sparse Jacobian via finite differences 1122 and coloring 1123 1124 Level: beginner 1125 1126 Concepts: coloring, sparse Jacobian, finite differences 1127 1128 .seealso: MatFDColoringCreate() 1129 S*/ 1130 typedef struct _p_MatFDColoring* MatFDColoring; 1131 1132 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringCreate(Mat,ISColoring,MatFDColoring *); 1133 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringDestroy(MatFDColoring); 1134 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringView(MatFDColoring,PetscViewer); 1135 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*); 1136 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**); 1137 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal); 1138 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFrequency(MatFDColoring,PetscInt); 1139 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFrequency(MatFDColoring,PetscInt*); 1140 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFromOptions(MatFDColoring); 1141 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *); 1142 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *); 1143 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetRecompute(MatFDColoring); 1144 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetF(MatFDColoring,Vec); 1145 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]); 1146 /* 1147 These routines are for partitioning matrices: currently used only 1148 for adjacency matrix, MatCreateMPIAdj(). 1149 */ 1150 1151 /*S 1152 MatPartitioning - Object for managing the partitioning of a matrix or graph 1153 1154 Level: beginner 1155 1156 Concepts: partitioning 1157 1158 .seealso: MatPartitioningCreate(), MatPartitioningType 1159 S*/ 1160 typedef struct _p_MatPartitioning* MatPartitioning; 1161 1162 /*E 1163 MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function 1164 with an optional dynamic library name, for example 1165 http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate() 1166 1167 Level: beginner 1168 1169 .seealso: MatPartitioningCreate(), MatPartitioning 1170 E*/ 1171 #define MatPartitioningType char* 1172 #define MAT_PARTITIONING_CURRENT "current" 1173 #define MAT_PARTITIONING_SQUARE "square" 1174 #define MAT_PARTITIONING_PARMETIS "parmetis" 1175 #define MAT_PARTITIONING_CHACO "chaco" 1176 #define MAT_PARTITIONING_JOSTLE "jostle" 1177 #define MAT_PARTITIONING_PARTY "party" 1178 #define MAT_PARTITIONING_SCOTCH "scotch" 1179 1180 1181 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningCreate(MPI_Comm,MatPartitioning*); 1182 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetType(MatPartitioning,const MatPartitioningType); 1183 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetNParts(MatPartitioning,PetscInt); 1184 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetAdjacency(MatPartitioning,Mat); 1185 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]); 1186 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []); 1187 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningApply(MatPartitioning,IS*); 1188 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningDestroy(MatPartitioning); 1189 1190 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning)); 1191 1192 /*MC 1193 MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the 1194 matrix package. 1195 1196 Synopsis: 1197 PetscErrorCode MatPartitioningRegisterDynamic(char *name_partitioning,char *path,char *name_create,PetscErrorCode (*routine_create)(MatPartitioning)) 1198 1199 Not Collective 1200 1201 Input Parameters: 1202 + sname - name of partitioning (for example MAT_PARTITIONING_CURRENT) or parmetis 1203 . path - location of library where creation routine is 1204 . name - name of function that creates the partitioning type, a string 1205 - function - function pointer that creates the partitioning type 1206 1207 Level: developer 1208 1209 If dynamic libraries are used, then the fourth input argument (function) 1210 is ignored. 1211 1212 Sample usage: 1213 .vb 1214 MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a, 1215 "MyPartCreate",MyPartCreate); 1216 .ve 1217 1218 Then, your partitioner can be chosen with the procedural interface via 1219 $ MatPartitioningSetType(part,"my_part") 1220 or at runtime via the option 1221 $ -mat_partitioning_type my_part 1222 1223 $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 1224 1225 .keywords: matrix, partitioning, register 1226 1227 .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll() 1228 M*/ 1229 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1230 #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0) 1231 #else 1232 #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d) 1233 #endif 1234 1235 extern PetscTruth MatPartitioningRegisterAllCalled; 1236 1237 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterAll(const char[]); 1238 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterDestroy(void); 1239 1240 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningView(MatPartitioning,PetscViewer); 1241 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetFromOptions(MatPartitioning); 1242 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningGetType(MatPartitioning,MatPartitioningType*); 1243 1244 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisSetCoarseSequential(MatPartitioning); 1245 1246 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal); 1247 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseSequential(MatPartitioning); 1248 1249 typedef enum {MP_CHACO_MULTILEVEL_KL,MP_CHACO_SPECTRAL,MP_CHACO_LINEAR,MP_CHACO_RANDOM, MP_CHACO_SCATTERED} MPChacoGlobalType; 1250 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType); 1251 typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType; 1252 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType); 1253 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal); 1254 typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType; 1255 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType); 1256 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal); 1257 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt); 1258 1259 #define MP_PARTY_OPT "opt" 1260 #define MP_PARTY_LIN "lin" 1261 #define MP_PARTY_SCA "sca" 1262 #define MP_PARTY_RAN "ran" 1263 #define MP_PARTY_GBF "gbf" 1264 #define MP_PARTY_GCF "gcf" 1265 #define MP_PARTY_BUB "bub" 1266 #define MP_PARTY_DEF "def" 1267 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetGlobal(MatPartitioning, const char*); 1268 #define MP_PARTY_HELPFUL_SETS "hs" 1269 #define MP_PARTY_KERNIGHAN_LIN "kl" 1270 #define MP_PARTY_NONE "no" 1271 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetLocal(MatPartitioning, const char*); 1272 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal); 1273 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetBipart(MatPartitioning,PetscTruth); 1274 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscTruth); 1275 1276 typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType; 1277 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetArch(MatPartitioning,const char*); 1278 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMultilevel(MatPartitioning); 1279 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType); 1280 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal); 1281 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetHostList(MatPartitioning,const char*); 1282 typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType; 1283 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType); 1284 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMapping(MatPartitioning); 1285 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetStrategy(MatPartitioning,char*); 1286 1287 /* 1288 If you add entries here you must also add them to finclude/petscmat.h 1289 */ 1290 typedef enum { MATOP_SET_VALUES=0, 1291 MATOP_GET_ROW=1, 1292 MATOP_RESTORE_ROW=2, 1293 MATOP_MULT=3, 1294 MATOP_MULT_ADD=4, 1295 MATOP_MULT_TRANSPOSE=5, 1296 MATOP_MULT_TRANSPOSE_ADD=6, 1297 MATOP_SOLVE=7, 1298 MATOP_SOLVE_ADD=8, 1299 MATOP_SOLVE_TRANSPOSE=9, 1300 MATOP_SOLVE_TRANSPOSE_ADD=10, 1301 MATOP_LUFACTOR=11, 1302 MATOP_CHOLESKYFACTOR=12, 1303 MATOP_RELAX=13, 1304 MATOP_TRANSPOSE=14, 1305 MATOP_GETINFO=15, 1306 MATOP_EQUAL=16, 1307 MATOP_GET_DIAGONAL=17, 1308 MATOP_DIAGONAL_SCALE=18, 1309 MATOP_NORM=19, 1310 MATOP_ASSEMBLY_BEGIN=20, 1311 MATOP_ASSEMBLY_END=21, 1312 MATOP_COMPRESS=22, 1313 MATOP_SET_OPTION=23, 1314 MATOP_ZERO_ENTRIES=24, 1315 MATOP_ZERO_ROWS=25, 1316 MATOP_LUFACTOR_SYMBOLIC=26, 1317 MATOP_LUFACTOR_NUMERIC=27, 1318 MATOP_CHOLESKY_FACTOR_SYMBOLIC=28, 1319 MATOP_CHOLESKY_FACTOR_NUMERIC=29, 1320 MATOP_SETUP_PREALLOCATION=30, 1321 MATOP_ILUFACTOR_SYMBOLIC=31, 1322 MATOP_ICCFACTOR_SYMBOLIC=32, 1323 MATOP_GET_ARRAY=33, 1324 MATOP_RESTORE_ARRAY=34, 1325 MATOP_DUPLICATE=35, 1326 MATOP_FORWARD_SOLVE=36, 1327 MATOP_BACKWARD_SOLVE=37, 1328 MATOP_ILUFACTOR=38, 1329 MATOP_ICCFACTOR=39, 1330 MATOP_AXPY=40, 1331 MATOP_GET_SUBMATRICES=41, 1332 MATOP_INCREASE_OVERLAP=42, 1333 MATOP_GET_VALUES=43, 1334 MATOP_COPY=44, 1335 MATOP_PRINT_HELP=45, 1336 MATOP_SCALE=46, 1337 MATOP_SHIFT=47, 1338 MATOP_DIAGONAL_SHIFT=48, 1339 MATOP_ILUDT_FACTOR=49, 1340 MATOP_GET_BLOCK_SIZE=50, 1341 MATOP_GET_ROW_IJ=51, 1342 MATOP_RESTORE_ROW_IJ=52, 1343 MATOP_GET_COLUMN_IJ=53, 1344 MATOP_RESTORE_COLUMN_IJ=54, 1345 MATOP_FDCOLORING_CREATE=55, 1346 MATOP_COLORING_PATCH=56, 1347 MATOP_SET_UNFACTORED=57, 1348 MATOP_PERMUTE=58, 1349 MATOP_SET_VALUES_BLOCKED=59, 1350 MATOP_GET_SUBMATRIX=60, 1351 MATOP_DESTROY=61, 1352 MATOP_VIEW=62, 1353 MATOP_GET_MAPS=63, 1354 MATOP_USE_SCALED_FORM=64, 1355 MATOP_SCALE_SYSTEM=65, 1356 MATOP_UNSCALE_SYSTEM=66, 1357 MATOP_SET_LOCAL_TO_GLOBAL_MAP=67, 1358 MATOP_SET_VALUES_LOCAL=68, 1359 MATOP_ZERO_ROWS_LOCAL=69, 1360 MATOP_GET_ROW_MAX=70, 1361 MATOP_CONVERT=71, 1362 MATOP_SET_COLORING=72, 1363 MATOP_SET_VALUES_ADIC=73, 1364 MATOP_SET_VALUES_ADIFOR=74, 1365 MATOP_FD_COLORING_APPLY=75, 1366 MATOP_SET_FROM_OPTIONS=76, 1367 MATOP_MULT_CON=77, 1368 MATOP_MULT_TRANSPOSE_CON=78, 1369 MATOP_ILU_FACTOR_SYMBOLIC_CON=79, 1370 MATOP_PERMUTE_SPARSIFY=80, 1371 MATOP_MULT_MULTIPLE=81, 1372 MATOP_SOLVE_MULTIPLE=82, 1373 MATOP_GET_INERTIA=83, 1374 MATOP_LOAD=84, 1375 MATOP_IS_SYMMETRIC=85, 1376 MATOP_IS_HERMITIAN=86, 1377 MATOP_IS_STRUCTURALLY_SYMMETRIC=87, 1378 MATOP_PB_RELAX=88, 1379 MATOP_GET_VECS=89, 1380 MATOP_MAT_MULT=90, 1381 MATOP_MAT_MULT_SYMBOLIC=91, 1382 MATOP_MAT_MULT_NUMERIC=92, 1383 MATOP_PTAP=93, 1384 MATOP_PTAP_SYMBOLIC=94, 1385 MATOP_PTAP_NUMERIC=95, 1386 MATOP_MAT_MULTTRANSPOSE=96, 1387 MATOP_MAT_MULTTRANSPOSE_SYMBOLIC=97, 1388 MATOP_MAT_MULTTRANSPOSE_NUMERIC=98, 1389 MATOP_PTAP_SYMBOLIC_SEQAIJ=99, 1390 MATOP_PTAP_NUMERIC_SEQAIJ=100, 1391 MATOP_PTAP_SYMBOLIC_MPIAIJ=101, 1392 MATOP_PTAP_NUMERIC_MPIAIJ=102, 1393 MATOP_SET_VALUES_ROW = 105, 1394 MATOP_GET_ROW_UTRIANGULAR=108, 1395 MATOP_RESTORE_ROW_UTRIANGULAR=109, 1396 MATOP_MATSOLVE=110 1397 } MatOperation; 1398 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHasOperation(Mat,MatOperation,PetscTruth*); 1399 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetOperation(Mat,MatOperation,void(*)(void)); 1400 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetOperation(Mat,MatOperation,void(**)(void)); 1401 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetContext(Mat,void*); 1402 1403 /* 1404 Codes for matrices stored on disk. By default they are 1405 stored in a universal format. By changing the format with 1406 PetscViewerSetFormat(viewer,PETSC_VIEWER_BINARY_NATIVE); the matrices will 1407 be stored in a way natural for the matrix, for example dense matrices 1408 would be stored as dense. Matrices stored this way may only be 1409 read into matrices of the same time. 1410 */ 1411 #define MATRIX_BINARY_FORMAT_DENSE -1 1412 1413 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetHashTableFactor(Mat,PetscReal); 1414 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatISGetLocalMat(Mat,Mat*); 1415 1416 /*S 1417 MatNullSpace - Object that removes a null space from a vector, i.e. 1418 orthogonalizes the vector to a subsapce 1419 1420 Level: advanced 1421 1422 Concepts: matrix; linear operator, null space 1423 1424 Users manual sections: 1425 . sec_singular 1426 1427 .seealso: MatNullSpaceCreate() 1428 S*/ 1429 typedef struct _p_MatNullSpace* MatNullSpace; 1430 1431 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceCreate(MPI_Comm,PetscTruth,PetscInt,const Vec[],MatNullSpace*); 1432 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(Vec,void*),void*); 1433 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceDestroy(MatNullSpace); 1434 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceRemove(MatNullSpace,Vec,Vec*); 1435 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceAttach(Mat,MatNullSpace); 1436 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceTest(MatNullSpace,Mat); 1437 1438 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderingSeqSBAIJ(Mat,IS); 1439 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetHashTableFactor(Mat,PetscReal); 1440 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetColumnIndices(Mat,PetscInt *); 1441 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJInvertBlockDiagonal(Mat); 1442 1443 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMAIJ(Mat,PetscInt,Mat*); 1444 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJRedimension(Mat,PetscInt,Mat*); 1445 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJGetAIJ(Mat,Mat*); 1446 1447 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatComputeExplicitOperator(Mat,Mat*); 1448 1449 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScaleLocal(Mat,Vec); 1450 1451 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *); 1452 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *); 1453 1454 PETSC_EXTERN_CXX_END 1455 #endif 1456