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