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