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, MatSolverPackage 28 E*/ 29 #define MatType char* 30 #define MATSAME "same" 31 #define MATMAIJ "maij" 32 #define MATSEQMAIJ "seqmaij" 33 #define MATMPIMAIJ "mpimaij" 34 #define MATIS "is" 35 #define MATAIJ "aij" 36 #define MATSEQAIJ "seqaij" 37 #define MATSEQAIJPTHREAD "seqaijpthread" 38 #define MATAIJPTHREAD "aijpthread" 39 #define MATMPIAIJ "mpiaij" 40 #define MATAIJCRL "aijcrl" 41 #define MATSEQAIJCRL "seqaijcrl" 42 #define MATMPIAIJCRL "mpiaijcrl" 43 #define MATAIJCUSP "aijcusp" 44 #define MATSEQAIJCUSP "seqaijcusp" 45 #define MATMPIAIJCUSP "mpiaijcusp" 46 #define MATAIJPERM "aijperm" 47 #define MATSEQAIJPERM "seqaijperm" 48 #define MATMPIAIJPERM "mpiaijperm" 49 #define MATSHELL "shell" 50 #define MATDENSE "dense" 51 #define MATSEQDENSE "seqdense" 52 #define MATMPIDENSE "mpidense" 53 #define MATBAIJ "baij" 54 #define MATSEQBAIJ "seqbaij" 55 #define MATMPIBAIJ "mpibaij" 56 #define MATMPIADJ "mpiadj" 57 #define MATSBAIJ "sbaij" 58 #define MATSEQSBAIJ "seqsbaij" 59 #define MATMPISBAIJ "mpisbaij" 60 61 #define MATSEQBSTRM "seqbstrm" 62 #define MATMPIBSTRM "mpibstrm" 63 #define MATBSTRM "bstrm" 64 #define MATSEQSBSTRM "seqsbstrm" 65 #define MATMPISBSTRM "mpisbstrm" 66 #define MATSBSTRM "sbstrm" 67 68 #define MATDAAD "daad" 69 #define MATMFFD "mffd" 70 #define MATNORMAL "normal" 71 #define MATLRC "lrc" 72 #define MATSCATTER "scatter" 73 #define MATBLOCKMAT "blockmat" 74 #define MATCOMPOSITE "composite" 75 #define MATFFT "fft" 76 #define MATFFTW "fftw" 77 #define MATSEQCUFFT "seqcufft" 78 #define MATTRANSPOSEMAT "transpose" 79 #define MATSCHURCOMPLEMENT "schurcomplement" 80 #define MATPYTHON "python" 81 #define MATHYPRESTRUCT "hyprestruct" 82 #define MATHYPRESSTRUCT "hypresstruct" 83 #define MATSUBMATRIX "submatrix" 84 #define MATLOCALREF "localref" 85 #define MATNEST "nest" 86 87 /*E 88 MatSolverPackage - String with the name of a PETSc matrix solver type. 89 90 For example: "petsc" indicates what PETSc provides, "superlu" indicates either 91 SuperLU or SuperLU_Dist etc. 92 93 94 Level: beginner 95 96 .seealso: MatGetFactor(), Mat, MatSetType(), MatType 97 E*/ 98 #define MatSolverPackage char* 99 #define MATSOLVERSPOOLES "spooles" 100 #define MATSOLVERSUPERLU "superlu" 101 #define MATSOLVERSUPERLU_DIST "superlu_dist" 102 #define MATSOLVERUMFPACK "umfpack" 103 #define MATSOLVERCHOLMOD "cholmod" 104 #define MATSOLVERESSL "essl" 105 #define MATSOLVERLUSOL "lusol" 106 #define MATSOLVERMUMPS "mumps" 107 #define MATSOLVERPASTIX "pastix" 108 #define MATSOLVERDSCPACK "dscpack" 109 #define MATSOLVERMATLAB "matlab" 110 #define MATSOLVERPETSC "petsc" 111 #define MATSOLVERPLAPACK "plapack" 112 #define MATSOLVERBAS "bas" 113 114 #define MATSOLVERBSTRM "bstrm" 115 #define MATSOLVERSBSTRM "sbstrm" 116 117 /*E 118 MatFactorType - indicates what type of factorization is requested 119 120 Level: beginner 121 122 Any additions/changes here MUST also be made in include/finclude/petscmat.h 123 124 .seealso: MatSolverPackage, MatGetFactor() 125 E*/ 126 typedef enum {MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC,MAT_FACTOR_ILUDT} MatFactorType; 127 extern const char *const MatFactorTypes[]; 128 129 extern PetscErrorCode MatGetFactor(Mat,const MatSolverPackage,MatFactorType,Mat*); 130 extern PetscErrorCode MatGetFactorAvailable(Mat,const MatSolverPackage,MatFactorType,PetscBool *); 131 extern PetscErrorCode MatFactorGetSolverPackage(Mat,const MatSolverPackage*); 132 extern PetscErrorCode MatGetFactorType(Mat,MatFactorType*); 133 134 /* Logging support */ 135 #define MAT_FILE_CLASSID 1211216 /* used to indicate matrices in binary files */ 136 extern PetscClassId MAT_CLASSID; 137 extern PetscClassId MAT_FDCOLORING_CLASSID; 138 extern PetscClassId MAT_PARTITIONING_CLASSID; 139 extern PetscClassId MAT_NULLSPACE_CLASSID; 140 extern PetscClassId MATMFFD_CLASSID; 141 142 /*E 143 MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices() 144 or MatGetSubMatrix() are to be reused to store the new matrix values. For MatConvert() is used to indicate 145 that the input matrix is to be replaced with the converted matrix. 146 147 Level: beginner 148 149 Any additions/changes here MUST also be made in include/finclude/petscmat.h 150 151 .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert() 152 E*/ 153 typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX} MatReuse; 154 155 /*E 156 MatGetSubMatrixOption - Indicates if matrices obtained from a call to MatGetSubMatrices() 157 include the matrix values. Currently it is only used by MatGetSeqNonzerostructure(). 158 159 Level: beginner 160 161 .seealso: MatGetSeqNonzerostructure() 162 E*/ 163 typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatGetSubMatrixOption; 164 165 extern PetscErrorCode MatInitializePackage(const char[]); 166 167 extern PetscErrorCode MatCreate(MPI_Comm,Mat*); 168 PetscPolymorphicFunction(MatCreate,(MPI_Comm comm),(comm,&A),Mat,A) 169 PetscPolymorphicFunction(MatCreate,(),(PETSC_COMM_WORLD,&A),Mat,A) 170 extern PetscErrorCode MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt); 171 extern PetscErrorCode MatSetType(Mat,const MatType); 172 extern PetscErrorCode MatSetFromOptions(Mat); 173 extern PetscErrorCode MatSetUpPreallocation(Mat); 174 extern PetscErrorCode MatRegisterAll(const char[]); 175 extern PetscErrorCode MatRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat)); 176 extern PetscErrorCode MatRegisterBaseName(const char[],const char[],const char[]); 177 extern PetscErrorCode MatSetOptionsPrefix(Mat,const char[]); 178 extern PetscErrorCode MatAppendOptionsPrefix(Mat,const char[]); 179 extern PetscErrorCode MatGetOptionsPrefix(Mat,const char*[]); 180 181 /*MC 182 MatRegisterDynamic - Adds a new matrix type 183 184 Synopsis: 185 PetscErrorCode MatRegisterDynamic(const char *name,const char *path,const char *name_create,PetscErrorCode (*routine_create)(Mat)) 186 187 Not Collective 188 189 Input Parameters: 190 + name - name of a new user-defined matrix type 191 . path - path (either absolute or relative) the library containing this solver 192 . name_create - name of routine to create method context 193 - routine_create - routine to create method context 194 195 Notes: 196 MatRegisterDynamic() may be called multiple times to add several user-defined solvers. 197 198 If dynamic libraries are used, then the fourth input argument (routine_create) 199 is ignored. 200 201 Sample usage: 202 .vb 203 MatRegisterDynamic("my_mat",/home/username/my_lib/lib/libO/solaris/mylib.a, 204 "MyMatCreate",MyMatCreate); 205 .ve 206 207 Then, your solver can be chosen with the procedural interface via 208 $ MatSetType(Mat,"my_mat") 209 or at runtime via the option 210 $ -mat_type my_mat 211 212 Level: advanced 213 214 Notes: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values. 215 If your function is not being put into a shared library then use VecRegister() instead 216 217 .keywords: Mat, register 218 219 .seealso: MatRegisterAll(), MatRegisterDestroy() 220 221 M*/ 222 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 223 #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,0) 224 #else 225 #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,d) 226 #endif 227 228 extern PetscBool MatRegisterAllCalled; 229 extern PetscFList MatList; 230 extern PetscFList MatColoringList; 231 extern PetscFList MatPartitioningList; 232 233 /*E 234 MatStructure - Indicates if the matrix has the same nonzero structure 235 236 Level: beginner 237 238 Any additions/changes here MUST also be made in include/finclude/petscmat.h 239 240 .seealso: MatCopy(), KSPSetOperators(), PCSetOperators() 241 E*/ 242 typedef enum {DIFFERENT_NONZERO_PATTERN,SUBSET_NONZERO_PATTERN,SAME_NONZERO_PATTERN,SAME_PRECONDITIONER} MatStructure; 243 244 extern PetscErrorCode MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*); 245 extern PetscErrorCode MatCreateMPIDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*); 246 extern PetscErrorCode MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 247 PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,nz,nnz,&A),Mat,A) 248 PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,&A),Mat,A) 249 PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,m,n,0,nnz,&A),Mat,A) 250 PetscPolymorphicFunction(MatCreateSeqAIJ,(PetscInt m,PetscInt n),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,&A),Mat,A) 251 PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,m,n,nz,PETSC_NULL,A)) 252 PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,m,n,0,nnz,A)) 253 PetscPolymorphicSubroutine(MatCreateSeqAIJ,(PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,m,n,0,PETSC_NULL,A)) 254 extern PetscErrorCode MatCreateMPIAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 255 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) 256 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) 257 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) 258 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) 259 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)) 260 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)) 261 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)) 262 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) 263 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) 264 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) 265 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) 266 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)) 267 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)) 268 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)) 269 extern PetscErrorCode MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *); 270 extern PetscErrorCode MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*); 271 272 extern PetscErrorCode MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 273 PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A) 274 PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A) 275 PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A) 276 PetscPolymorphicFunction(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A) 277 PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A)) 278 PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A)) 279 PetscPolymorphicSubroutine(MatCreateSeqBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A)) 280 extern PetscErrorCode MatCreateMPIBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 281 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) 282 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) 283 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) 284 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) 285 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)) 286 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)) 287 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)) 288 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) 289 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) 290 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) 291 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) 292 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)) 293 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)) 294 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)) 295 extern PetscErrorCode MatCreateMPIBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat*); 296 297 extern PetscErrorCode MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*); 298 extern PetscErrorCode MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 299 PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,nz,nnz,&A),Mat,A) 300 PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,&A),Mat,A) 301 PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[]),(PETSC_COMM_SELF,bs,m,n,0,nnz,&A),Mat,A) 302 PetscPolymorphicFunction(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,&A),Mat,A) 303 PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,Mat *A),(PETSC_COMM_SELF,bs,m,n,nz,PETSC_NULL,A)) 304 PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,const PetscInt nnz[],Mat *A),(PETSC_COMM_SELF,bs,m,n,0,nnz,A)) 305 PetscPolymorphicSubroutine(MatCreateSeqSBAIJ,(PetscInt bs,PetscInt m,PetscInt n,Mat *A),(PETSC_COMM_SELF,bs,m,n,0,PETSC_NULL,A)) 306 307 extern PetscErrorCode MatCreateMPISBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 308 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) 309 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) 310 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) 311 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) 312 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)) 313 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)) 314 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)) 315 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) 316 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) 317 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) 318 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) 319 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)) 320 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)) 321 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)) 322 extern PetscErrorCode MatCreateMPISBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *); 323 extern PetscErrorCode MatMPISBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 324 325 extern PetscErrorCode MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*); 326 PetscPolymorphicFunction(MatCreateShell,(MPI_Comm comm,PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(comm,m,n,M,N,ctx,&A),Mat,A) 327 PetscPolymorphicFunction(MatCreateShell,(PetscInt m,PetscInt n,PetscInt M,PetscInt N,void *ctx),(PETSC_COMM_WORLD,m,n,M,N,ctx,&A),Mat,A) 328 extern PetscErrorCode MatCreateAdic(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,void (*)(void),Mat*); 329 extern PetscErrorCode MatCreateNormal(Mat,Mat*); 330 PetscPolymorphicFunction(MatCreateNormal,(Mat mat),(mat,&A),Mat,A) 331 extern PetscErrorCode MatCreateLRC(Mat,Mat,Mat,Mat*); 332 extern PetscErrorCode MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,Mat*); 333 extern PetscErrorCode MatCreateSeqAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 334 extern PetscErrorCode MatCreateMPIAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 335 336 extern PetscErrorCode MatCreateSeqBSTRM(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 337 extern PetscErrorCode MatCreateMPIBSTRM(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 338 extern PetscErrorCode MatCreateSeqSBSTRM(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 339 extern PetscErrorCode MatCreateMPISBSTRM(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 340 341 extern PetscErrorCode MatCreateScatter(MPI_Comm,VecScatter,Mat*); 342 extern PetscErrorCode MatScatterSetVecScatter(Mat,VecScatter); 343 extern PetscErrorCode MatScatterGetVecScatter(Mat,VecScatter*); 344 extern PetscErrorCode MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*); 345 extern PetscErrorCode MatCompositeAddMat(Mat,Mat); 346 extern PetscErrorCode MatCompositeMerge(Mat); 347 extern PetscErrorCode MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*); 348 typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType; 349 extern PetscErrorCode MatCompositeSetType(Mat,MatCompositeType); 350 351 extern PetscErrorCode MatCreateFFT(MPI_Comm,PetscInt,const PetscInt[],const MatType,Mat*); 352 extern PetscErrorCode MatCreateSeqCUFFT(MPI_Comm,PetscInt,const PetscInt[],Mat*); 353 354 extern PetscErrorCode MatCreateTranspose(Mat,Mat*); 355 extern PetscErrorCode MatCreateSubMatrix(Mat,IS,IS,Mat*); 356 extern PetscErrorCode MatSubMatrixUpdate(Mat,Mat,IS,IS); 357 extern PetscErrorCode MatCreateLocalRef(Mat,IS,IS,Mat*); 358 359 extern PetscErrorCode MatPythonSetType(Mat,const char[]); 360 361 extern PetscErrorCode MatSetUp(Mat); 362 extern PetscErrorCode MatDestroy(Mat*); 363 364 extern PetscErrorCode MatConjugate(Mat); 365 extern PetscErrorCode MatRealPart(Mat); 366 extern PetscErrorCode MatImaginaryPart(Mat); 367 extern PetscErrorCode MatGetDiagonalBlock(Mat,Mat*); 368 extern PetscErrorCode MatGetTrace(Mat,PetscScalar*); 369 extern PetscErrorCode MatInvertBlockDiagonal(Mat,PetscScalar **); 370 371 /* ------------------------------------------------------------*/ 372 extern PetscErrorCode MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 373 extern PetscErrorCode MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 374 extern PetscErrorCode MatSetValuesRow(Mat,PetscInt,const PetscScalar[]); 375 extern PetscErrorCode MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]); 376 extern PetscErrorCode MatSetValuesBatch(Mat,PetscInt,PetscInt,PetscInt[],const PetscScalar[]); 377 378 /*S 379 MatStencil - Data structure (C struct) for storing information about a single row or 380 column of a matrix as index on an associated grid. 381 382 Level: beginner 383 384 Concepts: matrix; linear operator 385 386 .seealso: MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockStencil() 387 S*/ 388 typedef struct { 389 PetscInt k,j,i,c; 390 } MatStencil; 391 392 extern PetscErrorCode MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode); 393 extern PetscErrorCode MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode); 394 extern PetscErrorCode MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt); 395 396 extern PetscErrorCode MatSetColoring(Mat,ISColoring); 397 extern PetscErrorCode MatSetValuesAdic(Mat,void*); 398 extern PetscErrorCode MatSetValuesAdifor(Mat,PetscInt,void*); 399 400 /*E 401 MatAssemblyType - Indicates if the matrix is now to be used, or if you plan 402 to continue to add values to it 403 404 Level: beginner 405 406 .seealso: MatAssemblyBegin(), MatAssemblyEnd() 407 E*/ 408 typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType; 409 extern PetscErrorCode MatAssemblyBegin(Mat,MatAssemblyType); 410 extern PetscErrorCode MatAssemblyEnd(Mat,MatAssemblyType); 411 extern PetscErrorCode MatAssembled(Mat,PetscBool *); 412 413 414 415 /*E 416 MatOption - Options that may be set for a matrix and its behavior or storage 417 418 Level: beginner 419 420 Any additions/changes here MUST also be made in include/finclude/petscmat.h 421 422 .seealso: MatSetOption() 423 E*/ 424 typedef enum {MAT_ROW_ORIENTED,MAT_NEW_NONZERO_LOCATIONS, 425 MAT_SYMMETRIC, 426 MAT_STRUCTURALLY_SYMMETRIC, 427 MAT_NEW_DIAGONALS,MAT_IGNORE_OFF_PROC_ENTRIES, 428 MAT_NEW_NONZERO_LOCATION_ERR, 429 MAT_NEW_NONZERO_ALLOCATION_ERR,MAT_USE_HASH_TABLE, 430 MAT_KEEP_NONZERO_PATTERN,MAT_IGNORE_ZERO_ENTRIES, 431 MAT_USE_INODES, 432 MAT_HERMITIAN, 433 MAT_SYMMETRY_ETERNAL, 434 MAT_CHECK_COMPRESSED_ROW, 435 MAT_IGNORE_LOWER_TRIANGULAR,MAT_ERROR_LOWER_TRIANGULAR, 436 MAT_GETROW_UPPERTRIANGULAR,MAT_UNUSED_NONZERO_LOCATION_ERR, 437 MAT_SPD,MAT_NO_OFF_PROC_ENTRIES,MAT_NO_OFF_PROC_ZERO_ROWS, 438 NUM_MAT_OPTIONS} MatOption; 439 extern const char *MatOptions[]; 440 extern PetscErrorCode MatSetOption(Mat,MatOption,PetscBool ); 441 extern PetscErrorCode MatGetType(Mat,const MatType*); 442 PetscPolymorphicFunction(MatGetType,(Mat mat),(mat,&t),const MatType,t) 443 444 extern PetscErrorCode MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]); 445 extern PetscErrorCode MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 446 extern PetscErrorCode MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 447 extern PetscErrorCode MatGetRowUpperTriangular(Mat); 448 extern PetscErrorCode MatRestoreRowUpperTriangular(Mat); 449 extern PetscErrorCode MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 450 extern PetscErrorCode MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]); 451 extern PetscErrorCode MatGetColumnVector(Mat,Vec,PetscInt); 452 extern PetscErrorCode MatGetArray(Mat,PetscScalar *[]); 453 PetscPolymorphicFunction(MatGetArray,(Mat mat),(mat,&a),PetscScalar*,a) 454 extern PetscErrorCode MatRestoreArray(Mat,PetscScalar *[]); 455 extern PetscErrorCode MatGetBlockSize(Mat,PetscInt *); 456 PetscPolymorphicFunction(MatGetBlockSize,(Mat mat),(mat,&a),PetscInt,a) 457 extern PetscErrorCode MatSetBlockSize(Mat,PetscInt); 458 459 460 extern PetscErrorCode MatMult(Mat,Vec,Vec); 461 extern PetscErrorCode MatMultDiagonalBlock(Mat,Vec,Vec); 462 extern PetscErrorCode MatMultAdd(Mat,Vec,Vec,Vec); 463 PetscPolymorphicSubroutine(MatMultAdd,(Mat A,Vec x,Vec y),(A,x,y,y)) 464 extern PetscErrorCode MatMultTranspose(Mat,Vec,Vec); 465 extern PetscErrorCode MatMultHermitianTranspose(Mat,Vec,Vec); 466 extern PetscErrorCode MatIsTranspose(Mat,Mat,PetscReal,PetscBool *); 467 PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B,PetscReal tol),(A,B,tol,&t),PetscBool ,t) 468 PetscPolymorphicFunction(MatIsTranspose,(Mat A,Mat B),(A,B,0,&t),PetscBool ,t) 469 extern PetscErrorCode MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscBool *); 470 extern PetscErrorCode MatMultTransposeAdd(Mat,Vec,Vec,Vec); 471 extern PetscErrorCode MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec); 472 PetscPolymorphicSubroutine(MatMultTransposeAdd,(Mat A,Vec x,Vec y),(A,x,y,y)) 473 extern PetscErrorCode MatMultConstrained(Mat,Vec,Vec); 474 extern PetscErrorCode MatMultTransposeConstrained(Mat,Vec,Vec); 475 extern PetscErrorCode MatMatSolve(Mat,Mat,Mat); 476 477 /*E 478 MatDuplicateOption - Indicates if a duplicated sparse matrix should have 479 its numerical values copied over or just its nonzero structure. 480 481 Level: beginner 482 483 Any additions/changes here MUST also be made in include/finclude/petscmat.h 484 485 $ MAT_SHARE_NONZERO_PATTERN - the i and j arrays in the new matrix will be shared with the original matrix 486 $ this also triggers the MAT_DO_NOT_COPY_VALUES option. This is used when you 487 $ have several matrices with the same nonzero pattern. 488 489 .seealso: MatDuplicate() 490 E*/ 491 typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption; 492 493 extern PetscErrorCode MatConvert(Mat,const MatType,MatReuse,Mat*); 494 PetscPolymorphicFunction(MatConvert,(Mat A,const MatType t),(A,t,MAT_INITIAL_MATRIX,&a),Mat,a) 495 extern PetscErrorCode MatDuplicate(Mat,MatDuplicateOption,Mat*); 496 PetscPolymorphicFunction(MatDuplicate,(Mat A,MatDuplicateOption o),(A,o,&a),Mat,a) 497 PetscPolymorphicFunction(MatDuplicate,(Mat A),(A,MAT_COPY_VALUES,&a),Mat,a) 498 499 500 extern PetscErrorCode MatCopy(Mat,Mat,MatStructure); 501 extern PetscErrorCode MatView(Mat,PetscViewer); 502 extern PetscErrorCode MatIsSymmetric(Mat,PetscReal,PetscBool *); 503 PetscPolymorphicFunction(MatIsSymmetric,(Mat A,PetscReal tol),(A,tol,&t),PetscBool ,t) 504 PetscPolymorphicFunction(MatIsSymmetric,(Mat A),(A,0,&t),PetscBool ,t) 505 extern PetscErrorCode MatIsStructurallySymmetric(Mat,PetscBool *); 506 PetscPolymorphicFunction(MatIsStructurallySymmetric,(Mat A),(A,&t),PetscBool ,t) 507 extern PetscErrorCode MatIsHermitian(Mat,PetscReal,PetscBool *); 508 PetscPolymorphicFunction(MatIsHermitian,(Mat A),(A,0,&t),PetscBool ,t) 509 extern PetscErrorCode MatIsSymmetricKnown(Mat,PetscBool *,PetscBool *); 510 extern PetscErrorCode MatIsHermitianKnown(Mat,PetscBool *,PetscBool *); 511 extern PetscErrorCode MatMissingDiagonal(Mat,PetscBool *,PetscInt *); 512 extern PetscErrorCode MatLoad(Mat, PetscViewer); 513 514 extern PetscErrorCode MatGetRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,PetscInt *[],PetscInt *[],PetscBool *); 515 extern PetscErrorCode MatRestoreRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,PetscInt *[],PetscInt *[],PetscBool *); 516 extern PetscErrorCode MatGetColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,PetscInt *[],PetscInt *[],PetscBool *); 517 extern PetscErrorCode MatRestoreColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,PetscInt *[],PetscInt *[],PetscBool *); 518 519 /*S 520 MatInfo - Context of matrix information, used with MatGetInfo() 521 522 In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE 523 524 Level: intermediate 525 526 Concepts: matrix^nonzero information 527 528 .seealso: MatGetInfo(), MatInfoType 529 S*/ 530 typedef struct { 531 PetscLogDouble block_size; /* block size */ 532 PetscLogDouble nz_allocated,nz_used,nz_unneeded; /* number of nonzeros */ 533 PetscLogDouble memory; /* memory allocated */ 534 PetscLogDouble assemblies; /* number of matrix assemblies called */ 535 PetscLogDouble mallocs; /* number of mallocs during MatSetValues() */ 536 PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */ 537 PetscLogDouble factor_mallocs; /* number of mallocs during factorization */ 538 } MatInfo; 539 540 /*E 541 MatInfoType - Indicates if you want information about the local part of the matrix, 542 the entire parallel matrix or the maximum over all the local parts. 543 544 Level: beginner 545 546 Any additions/changes here MUST also be made in include/finclude/petscmat.h 547 548 .seealso: MatGetInfo(), MatInfo 549 E*/ 550 typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType; 551 extern PetscErrorCode MatGetInfo(Mat,MatInfoType,MatInfo*); 552 extern PetscErrorCode MatGetDiagonal(Mat,Vec); 553 extern PetscErrorCode MatGetRowMax(Mat,Vec,PetscInt[]); 554 extern PetscErrorCode MatGetRowMin(Mat,Vec,PetscInt[]); 555 extern PetscErrorCode MatGetRowMaxAbs(Mat,Vec,PetscInt[]); 556 extern PetscErrorCode MatGetRowMinAbs(Mat,Vec,PetscInt[]); 557 extern PetscErrorCode MatGetRowSum(Mat,Vec); 558 extern PetscErrorCode MatTranspose(Mat,MatReuse,Mat*); 559 PetscPolymorphicFunction(MatTranspose,(Mat A),(A,MAT_INITIAL_MATRIX,&t),Mat,t) 560 extern PetscErrorCode MatHermitianTranspose(Mat,MatReuse,Mat*); 561 extern PetscErrorCode MatPermute(Mat,IS,IS,Mat *); 562 PetscPolymorphicFunction(MatPermute,(Mat A,IS is1,IS is2),(A,is1,is2,&t),Mat,t) 563 extern PetscErrorCode MatDiagonalScale(Mat,Vec,Vec); 564 extern PetscErrorCode MatDiagonalSet(Mat,Vec,InsertMode); 565 extern PetscErrorCode MatEqual(Mat,Mat,PetscBool *); 566 PetscPolymorphicFunction(MatEqual,(Mat A,Mat B),(A,B,&t),PetscBool ,t) 567 extern PetscErrorCode MatMultEqual(Mat,Mat,PetscInt,PetscBool *); 568 extern PetscErrorCode MatMultAddEqual(Mat,Mat,PetscInt,PetscBool *); 569 extern PetscErrorCode MatMultTransposeEqual(Mat,Mat,PetscInt,PetscBool *); 570 extern PetscErrorCode MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscBool *); 571 572 extern PetscErrorCode MatNorm(Mat,NormType,PetscReal *); 573 PetscPolymorphicFunction(MatNorm,(Mat A,NormType t),(A,t,&n),PetscReal,n) 574 extern PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal *); 575 extern PetscErrorCode MatZeroEntries(Mat); 576 extern PetscErrorCode MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 577 extern PetscErrorCode MatZeroRowsIS(Mat,IS,PetscScalar,Vec,Vec); 578 extern PetscErrorCode MatZeroRowsStencil(Mat,PetscInt,const MatStencil [],PetscScalar,Vec,Vec); 579 extern PetscErrorCode MatZeroRowsColumns(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 580 extern PetscErrorCode MatZeroRowsColumnsIS(Mat,IS,PetscScalar,Vec,Vec); 581 582 extern PetscErrorCode MatUseScaledForm(Mat,PetscBool ); 583 extern PetscErrorCode MatScaleSystem(Mat,Vec,Vec); 584 extern PetscErrorCode MatUnScaleSystem(Mat,Vec,Vec); 585 586 extern PetscErrorCode MatGetSize(Mat,PetscInt*,PetscInt*); 587 extern PetscErrorCode MatGetLocalSize(Mat,PetscInt*,PetscInt*); 588 extern PetscErrorCode MatGetOwnershipRange(Mat,PetscInt*,PetscInt*); 589 extern PetscErrorCode MatGetOwnershipRanges(Mat,const PetscInt**); 590 extern PetscErrorCode MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*); 591 extern PetscErrorCode MatGetOwnershipRangesColumn(Mat,const PetscInt**); 592 593 extern PetscErrorCode MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]); 594 extern PetscErrorCode MatGetSubMatricesParallel(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]); 595 extern PetscErrorCode MatDestroyMatrices(PetscInt,Mat *[]); 596 extern PetscErrorCode MatGetSubMatrix(Mat,IS,IS,MatReuse,Mat *); 597 extern PetscErrorCode MatGetLocalSubMatrix(Mat,IS,IS,Mat*); 598 extern PetscErrorCode MatRestoreLocalSubMatrix(Mat,IS,IS,Mat*); 599 extern PetscErrorCode MatGetSeqNonzeroStructure(Mat,Mat*); 600 extern PetscErrorCode MatDestroySeqNonzeroStructure(Mat*); 601 602 extern PetscErrorCode MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*); 603 extern PetscErrorCode MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*); 604 extern PetscErrorCode MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*); 605 extern PetscErrorCode MatMerge_SeqsToMPINumeric(Mat,Mat); 606 extern PetscErrorCode MatMPIAIJGetLocalMat(Mat,MatReuse,Mat*); 607 extern PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*); 608 extern PetscErrorCode MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*); 609 extern PetscErrorCode MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,PetscInt**,MatScalar**,Mat*); 610 #if defined (PETSC_USE_CTABLE) 611 #include "petscctable.h" 612 extern PetscErrorCode MatGetCommunicationStructs(Mat, Vec *, PetscTable *, VecScatter *); 613 #else 614 extern PetscErrorCode MatGetCommunicationStructs(Mat, Vec *, PetscInt *[], VecScatter *); 615 #endif 616 extern PetscErrorCode MatGetGhosts(Mat, PetscInt *,const PetscInt *[]); 617 618 extern PetscErrorCode MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt); 619 620 extern PetscErrorCode MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*); 621 extern PetscErrorCode MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*); 622 extern PetscErrorCode MatMatMultNumeric(Mat,Mat,Mat); 623 624 extern PetscErrorCode MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*); 625 extern PetscErrorCode MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*); 626 extern PetscErrorCode MatPtAPNumeric(Mat,Mat,Mat); 627 628 extern PetscErrorCode MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*); 629 extern PetscErrorCode MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*); 630 extern PetscErrorCode MatMatMultTransposeNumeric(Mat,Mat,Mat); 631 632 extern PetscErrorCode MatAXPY(Mat,PetscScalar,Mat,MatStructure); 633 extern PetscErrorCode MatAYPX(Mat,PetscScalar,Mat,MatStructure); 634 635 extern PetscErrorCode MatScale(Mat,PetscScalar); 636 extern PetscErrorCode MatShift(Mat,PetscScalar); 637 638 extern PetscErrorCode MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping); 639 extern PetscErrorCode MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping); 640 extern PetscErrorCode MatGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*); 641 extern PetscErrorCode MatGetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*); 642 extern PetscErrorCode MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 643 extern PetscErrorCode MatZeroRowsLocalIS(Mat,IS,PetscScalar,Vec,Vec); 644 extern PetscErrorCode MatZeroRowsColumnsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec); 645 extern PetscErrorCode MatZeroRowsColumnsLocalIS(Mat,IS,PetscScalar,Vec,Vec); 646 extern PetscErrorCode MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 647 extern PetscErrorCode MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 648 649 extern PetscErrorCode MatStashSetInitialSize(Mat,PetscInt,PetscInt); 650 extern PetscErrorCode MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 651 652 extern PetscErrorCode MatInterpolate(Mat,Vec,Vec); 653 extern PetscErrorCode MatInterpolateAdd(Mat,Vec,Vec,Vec); 654 PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y)) 655 extern PetscErrorCode MatRestrict(Mat,Vec,Vec); 656 extern PetscErrorCode MatGetVecs(Mat,Vec*,Vec*); 657 extern PetscErrorCode MatGetRedundantMatrix(Mat,PetscInt,MPI_Comm,PetscInt,MatReuse,Mat*); 658 extern PetscErrorCode MatGetMultiProcBlock(Mat,MPI_Comm,Mat*); 659 extern PetscErrorCode MatFindZeroDiagonals(Mat,IS*); 660 661 /*MC 662 MatSetValue - Set a single entry into a matrix. 663 664 Not collective 665 666 Input Parameters: 667 + m - the matrix 668 . row - the row location of the entry 669 . col - the column location of the entry 670 . value - the value to insert 671 - mode - either INSERT_VALUES or ADD_VALUES 672 673 Notes: 674 For efficiency one should use MatSetValues() and set several or many 675 values simultaneously if possible. 676 677 Level: beginner 678 679 .seealso: MatSetValues(), MatSetValueLocal() 680 M*/ 681 PETSC_STATIC_INLINE PetscErrorCode MatSetValue(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValues(v,1,&i,1,&j,&va,mode);} 682 683 PETSC_STATIC_INLINE PetscErrorCode MatGetValue(Mat v,PetscInt i,PetscInt j,PetscScalar *va) {return MatGetValues(v,1,&i,1,&j,va);} 684 685 PETSC_STATIC_INLINE PetscErrorCode MatSetValueLocal(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValuesLocal(v,1,&i,1,&j,&va,mode);} 686 687 /*MC 688 MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per 689 row in a matrix providing the data that one can use to correctly preallocate the matrix. 690 691 Synopsis: 692 PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz) 693 694 Collective on MPI_Comm 695 696 Input Parameters: 697 + comm - the communicator that will share the eventually allocated matrix 698 . nrows - the number of LOCAL rows in the matrix 699 - ncols - the number of LOCAL columns in the matrix 700 701 Output Parameters: 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 <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details. 710 711 Do not malloc or free dnz and onz, that is handled internally by these routines 712 713 Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices) 714 715 This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize(). 716 717 Concepts: preallocation^Matrix 718 719 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 720 MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal() 721 M*/ 722 #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \ 723 { \ 724 PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__start,__end; \ 725 _4_ierr = PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \ 726 _4_ierr = PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\ 727 _4_ierr = PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\ 728 _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\ 729 _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows; 730 731 /*MC 732 MatPreallocateSymmetricInitialize - Begins the block of code that will count the number of nonzeros per 733 row in a matrix providing the data that one can use to correctly preallocate the matrix. 734 735 Synopsis: 736 PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz) 737 738 Collective on MPI_Comm 739 740 Input Parameters: 741 + comm - the communicator that will share the eventually allocated matrix 742 . nrows - the number of LOCAL rows in the matrix 743 - ncols - the number of LOCAL columns in the matrix 744 745 Output Parameters: 746 + dnz - the array that will be passed to the matrix preallocation routines 747 - ozn - the other array passed to the matrix preallocation routines 748 749 750 Level: intermediate 751 752 Notes: 753 See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details. 754 755 Do not malloc or free dnz and onz, that is handled internally by these routines 756 757 This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize(). 758 759 Concepts: preallocation^Matrix 760 761 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 762 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal() 763 M*/ 764 #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \ 765 { \ 766 PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__end; \ 767 _4_ierr = PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \ 768 _4_ierr = PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\ 769 _4_ierr = PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\ 770 _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\ 771 _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows; 772 773 /*MC 774 MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 775 inserted using a local number of the rows and columns 776 777 Synopsis: 778 PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 779 780 Not Collective 781 782 Input Parameters: 783 + map - the row mapping from local numbering to global numbering 784 . nrows - the number of rows indicated 785 . rows - the indices of the rows 786 . cmap - the column mapping from local to global numbering 787 . ncols - the number of columns in the matrix 788 . cols - the columns indicated 789 . dnz - the array that will be passed to the matrix preallocation routines 790 - ozn - the other array passed to the matrix preallocation routines 791 792 793 Level: intermediate 794 795 Notes: 796 See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details. 797 798 Do not malloc or free dnz and onz, that is handled internally by these routines 799 800 Concepts: preallocation^Matrix 801 802 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 803 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal() 804 M*/ 805 #define MatPreallocateSetLocal(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \ 806 {\ 807 PetscInt __l;\ 808 _4_ierr = ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\ 809 _4_ierr = ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\ 810 for (__l=0;__l<nrows;__l++) {\ 811 _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 812 }\ 813 } 814 815 /*MC 816 MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 817 inserted using a local number of the rows and columns 818 819 Synopsis: 820 PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 821 822 Not Collective 823 824 Input Parameters: 825 + map - the mapping between local numbering and global numbering 826 . nrows - the number of rows indicated 827 . rows - the indices of the rows 828 . ncols - the number of columns in the matrix 829 . cols - the columns indicated 830 . dnz - the array that will be passed to the matrix preallocation routines 831 - ozn - the other array passed to the matrix preallocation routines 832 833 834 Level: intermediate 835 836 Notes: 837 See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details. 838 839 Do not malloc or free dnz and onz that is handled internally by these routines 840 841 Concepts: preallocation^Matrix 842 843 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 844 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 845 M*/ 846 #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\ 847 {\ 848 PetscInt __l;\ 849 _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\ 850 _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\ 851 for (__l=0;__l<nrows;__l++) {\ 852 _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 853 }\ 854 } 855 856 /*MC 857 MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 858 inserted using a local number of the rows and columns 859 860 Synopsis: 861 PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 862 863 Not Collective 864 865 Input Parameters: 866 + row - the row 867 . ncols - the number of columns in the matrix 868 - cols - the columns indicated 869 870 Output Parameters: 871 + dnz - the array that will be passed to the matrix preallocation routines 872 - ozn - the other array passed to the matrix preallocation routines 873 874 875 Level: intermediate 876 877 Notes: 878 See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details. 879 880 Do not malloc or free dnz and onz that is handled internally by these routines 881 882 This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize(). 883 884 Concepts: preallocation^Matrix 885 886 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 887 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 888 M*/ 889 #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\ 890 { PetscInt __i; \ 891 if (row < __rstart) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D less than first local row %D",row,__rstart);\ 892 if (row >= __rstart+__nrows) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D greater than last local row %D",row,__rstart+__nrows-1);\ 893 for (__i=0; __i<nc; __i++) {\ 894 if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \ 895 else dnz[row - __rstart]++;\ 896 }\ 897 } 898 899 /*MC 900 MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 901 inserted using a local number of the rows and columns 902 903 Synopsis: 904 PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 905 906 Not Collective 907 908 Input Parameters: 909 + nrows - the number of rows indicated 910 . rows - the indices of the rows 911 . ncols - the number of columns in the matrix 912 . cols - the columns indicated 913 . dnz - the array that will be passed to the matrix preallocation routines 914 - ozn - the other array passed to the matrix preallocation routines 915 916 917 Level: intermediate 918 919 Notes: 920 See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details. 921 922 Do not malloc or free dnz and onz that is handled internally by these routines 923 924 This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize(). 925 926 Concepts: preallocation^Matrix 927 928 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 929 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 930 M*/ 931 #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\ 932 { PetscInt __i; \ 933 for (__i=0; __i<nc; __i++) {\ 934 if (cols[__i] >= __end) onz[row - __rstart]++; \ 935 else if (cols[__i] >= row) dnz[row - __rstart]++;\ 936 }\ 937 } 938 939 /*MC 940 MatPreallocateLocation - An alternative to MatPreallocationSet() that puts the nonzero locations into the matrix if it exists 941 942 Synopsis: 943 PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz) 944 945 Not Collective 946 947 Input Parameters: 948 . A - matrix 949 . row - row where values exist (must be local to this process) 950 . ncols - number of columns 951 . cols - columns with nonzeros 952 . dnz - the array that will be passed to the matrix preallocation routines 953 - ozn - the other array passed to the matrix preallocation routines 954 955 956 Level: intermediate 957 958 Notes: 959 See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details. 960 961 Do not malloc or free dnz and onz that is handled internally by these routines 962 963 This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines. 964 965 Concepts: preallocation^Matrix 966 967 .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 968 MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal() 969 M*/ 970 #define MatPreallocateLocation(A,row,ncols,cols,dnz,onz) 0;if (A) {ierr = MatSetValues(A,1,&row,ncols,cols,PETSC_NULL,INSERT_VALUES);CHKERRQ(ierr);} else {ierr = MatPreallocateSet(row,ncols,cols,dnz,onz);CHKERRQ(ierr);} 971 972 973 /*MC 974 MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per 975 row in a matrix providing the data that one can use to correctly preallocate the matrix. 976 977 Synopsis: 978 PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz) 979 980 Collective on MPI_Comm 981 982 Input Parameters: 983 + dnz - the array that was be passed to the matrix preallocation routines 984 - ozn - the other array passed to the matrix preallocation routines 985 986 987 Level: intermediate 988 989 Notes: 990 See the <A href="../../docs/manual.pdf#nameddest=ch_performance">Hints for Performance Improvment</A> chapter in the users manual for more details. 991 992 Do not malloc or free dnz and onz that is handled internally by these routines 993 994 This is a MACRO not a function because it closes the { started in MatPreallocateInitialize(). 995 996 Concepts: preallocation^Matrix 997 998 .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 999 MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal() 1000 M*/ 1001 #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree2(dnz,onz);CHKERRQ(_4_ierr);} 1002 1003 1004 1005 /* Routines unique to particular data structures */ 1006 extern PetscErrorCode MatShellGetContext(Mat,void *); 1007 PetscPolymorphicFunction(MatShellGetContext,(Mat A),(A,&t),void*,t) 1008 1009 extern PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*); 1010 extern PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *); 1011 1012 extern PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]); 1013 extern PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]); 1014 extern PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 1015 extern PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 1016 extern PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 1017 1018 #define MAT_SKIP_ALLOCATION -4 1019 1020 extern PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 1021 PetscPolymorphicSubroutine(MatSeqBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz)) 1022 extern PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 1023 PetscPolymorphicSubroutine(MatSeqSBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz)) 1024 extern PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]); 1025 PetscPolymorphicSubroutine(MatSeqAIJSetPreallocation,(Mat A,const PetscInt nnz[]),(A,0,nnz)) 1026 1027 extern PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1028 PetscPolymorphicSubroutine(MatMPIBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[],const PetscInt onz[]),(A,bs,0,nnz,0,onz)) 1029 extern PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1030 extern PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 1031 extern PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []); 1032 extern PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 1033 extern PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]); 1034 extern PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 1035 extern PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]); 1036 extern PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]); 1037 extern PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]); 1038 extern PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]); 1039 extern PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]); 1040 extern PetscErrorCode MatAdicSetLocalFunction(Mat,void (*)(void)); 1041 1042 extern PetscErrorCode MatSeqDenseSetLDA(Mat,PetscInt); 1043 extern PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*); 1044 1045 extern PetscErrorCode MatStoreValues(Mat); 1046 extern PetscErrorCode MatRetrieveValues(Mat); 1047 1048 extern PetscErrorCode MatDAADSetCtx(Mat,void*); 1049 1050 extern PetscErrorCode MatFindNonzeroRows(Mat,IS*); 1051 /* 1052 These routines are not usually accessed directly, rather solving is 1053 done through the KSP and PC interfaces. 1054 */ 1055 1056 /*E 1057 MatOrderingType - String with the name of a PETSc matrix ordering or the creation function 1058 with an optional dynamic library name, for example 1059 http://www.mcs.anl.gov/petsc/lib.a:orderingcreate() 1060 1061 Level: beginner 1062 1063 Cannot use const because the PC objects manipulate the string 1064 1065 .seealso: MatGetOrdering() 1066 E*/ 1067 #define MatOrderingType char* 1068 #define MATORDERINGNATURAL "natural" 1069 #define MATORDERINGND "nd" 1070 #define MATORDERING1WD "1wd" 1071 #define MATORDERINGRCM "rcm" 1072 #define MATORDERINGQMD "qmd" 1073 #define MATORDERINGROWLENGTH "rowlength" 1074 #define MATORDERINGDSC_ND "dsc_nd" /* these three are only for DSCPACK, see its documentation for details */ 1075 #define MATORDERINGDSC_MMD "dsc_mmd" 1076 #define MATORDERINGDSC_MDF "dsc_mdf" 1077 #define MATORDERINGAMD "amd" /* only works if UMFPACK is installed with PETSc */ 1078 1079 extern PetscErrorCode MatGetOrdering(Mat,const MatOrderingType,IS*,IS*); 1080 extern PetscErrorCode MatGetOrderingList(PetscFList *list); 1081 extern PetscErrorCode MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*)); 1082 1083 /*MC 1084 MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the matrix package. 1085 1086 Synopsis: 1087 PetscErrorCode MatOrderingRegisterDynamic(const char *name_ordering,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatOrdering)) 1088 1089 Not Collective 1090 1091 Input Parameters: 1092 + sname - name of ordering (for example MATORDERINGND) 1093 . path - location of library where creation routine is 1094 . name - name of function that creates the ordering type,a string 1095 - function - function pointer that creates the ordering 1096 1097 Level: developer 1098 1099 If dynamic libraries are used, then the fourth input argument (function) 1100 is ignored. 1101 1102 Sample usage: 1103 .vb 1104 MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a, 1105 "MyOrder",MyOrder); 1106 .ve 1107 1108 Then, your partitioner can be chosen with the procedural interface via 1109 $ MatOrderingSetType(part,"my_order) 1110 or at runtime via the option 1111 $ -pc_factor_mat_ordering_type my_order 1112 1113 ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values. 1114 1115 .keywords: matrix, ordering, register 1116 1117 .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll() 1118 M*/ 1119 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1120 #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0) 1121 #else 1122 #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d) 1123 #endif 1124 1125 extern PetscErrorCode MatOrderingRegisterDestroy(void); 1126 extern PetscErrorCode MatOrderingRegisterAll(const char[]); 1127 extern PetscBool MatOrderingRegisterAllCalled; 1128 extern PetscFList MatOrderingList; 1129 1130 extern PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS); 1131 1132 /*S 1133 MatFactorShiftType - Numeric Shift. 1134 1135 Level: beginner 1136 1137 S*/ 1138 typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType; 1139 extern const char *MatFactorShiftTypes[]; 1140 1141 /*S 1142 MatFactorInfo - Data passed into the matrix factorization routines 1143 1144 In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use 1145 $ MatFactorInfo info(MAT_FACTORINFO_SIZE) 1146 1147 Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC. 1148 1149 You can use MatFactorInfoInitialize() to set default values. 1150 1151 Level: developer 1152 1153 .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(), 1154 MatFactorInfoInitialize() 1155 1156 S*/ 1157 typedef struct { 1158 PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */ 1159 PetscReal usedt; 1160 PetscReal dt; /* drop tolerance */ 1161 PetscReal dtcol; /* tolerance for pivoting */ 1162 PetscReal dtcount; /* maximum nonzeros to be allowed per row */ 1163 PetscReal fill; /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */ 1164 PetscReal levels; /* ICC/ILU(levels) */ 1165 PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0 1166 factorization may be faster if do not pivot */ 1167 PetscReal zeropivot; /* pivot is called zero if less than this */ 1168 PetscReal shifttype; /* type of shift added to matrix factor to prevent zero pivots */ 1169 PetscReal shiftamount; /* how large the shift is */ 1170 } MatFactorInfo; 1171 1172 extern PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*); 1173 extern PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*); 1174 extern PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 1175 extern PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*); 1176 extern PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*); 1177 extern PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*); 1178 extern PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 1179 extern PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 1180 extern PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 1181 extern PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*); 1182 extern PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*); 1183 extern PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*); 1184 extern PetscErrorCode MatSolve(Mat,Vec,Vec); 1185 extern PetscErrorCode MatForwardSolve(Mat,Vec,Vec); 1186 extern PetscErrorCode MatBackwardSolve(Mat,Vec,Vec); 1187 extern PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec); 1188 extern PetscErrorCode MatSolveTranspose(Mat,Vec,Vec); 1189 extern PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec); 1190 extern PetscErrorCode MatSolves(Mat,Vecs,Vecs); 1191 1192 extern PetscErrorCode MatSetUnfactored(Mat); 1193 1194 /*E 1195 MatSORType - What type of (S)SOR to perform 1196 1197 Level: beginner 1198 1199 May be bitwise ORd together 1200 1201 Any additions/changes here MUST also be made in include/finclude/petscmat.h 1202 1203 MatSORType may be bitwise ORd together, so do not change the numbers 1204 1205 .seealso: MatSOR() 1206 E*/ 1207 typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3, 1208 SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8, 1209 SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16, 1210 SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType; 1211 extern PetscErrorCode MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec); 1212 1213 /* 1214 These routines are for efficiently computing Jacobians via finite differences. 1215 */ 1216 1217 /*E 1218 MatColoringType - String with the name of a PETSc matrix coloring or the creation function 1219 with an optional dynamic library name, for example 1220 http://www.mcs.anl.gov/petsc/lib.a:coloringcreate() 1221 1222 Level: beginner 1223 1224 .seealso: MatGetColoring() 1225 E*/ 1226 #define MatColoringType char* 1227 #define MATCOLORINGNATURAL "natural" 1228 #define MATCOLORINGSL "sl" 1229 #define MATCOLORINGLF "lf" 1230 #define MATCOLORINGID "id" 1231 1232 extern PetscErrorCode MatGetColoring(Mat,const MatColoringType,ISColoring*); 1233 extern PetscErrorCode MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,MatColoringType,ISColoring *)); 1234 1235 /*MC 1236 MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the 1237 matrix package. 1238 1239 Synopsis: 1240 PetscErrorCode MatColoringRegisterDynamic(const char *name_coloring,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatColoring)) 1241 1242 Not Collective 1243 1244 Input Parameters: 1245 + sname - name of Coloring (for example MATCOLORINGSL) 1246 . path - location of library where creation routine is 1247 . name - name of function that creates the Coloring type, a string 1248 - function - function pointer that creates the coloring 1249 1250 Level: developer 1251 1252 If dynamic libraries are used, then the fourth input argument (function) 1253 is ignored. 1254 1255 Sample usage: 1256 .vb 1257 MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a, 1258 "MyColor",MyColor); 1259 .ve 1260 1261 Then, your partitioner can be chosen with the procedural interface via 1262 $ MatColoringSetType(part,"my_color") 1263 or at runtime via the option 1264 $ -mat_coloring_type my_color 1265 1266 $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 1267 1268 .keywords: matrix, Coloring, register 1269 1270 .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll() 1271 M*/ 1272 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1273 #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0) 1274 #else 1275 #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d) 1276 #endif 1277 1278 extern PetscBool MatColoringRegisterAllCalled; 1279 1280 extern PetscErrorCode MatColoringRegisterAll(const char[]); 1281 extern PetscErrorCode MatColoringRegisterDestroy(void); 1282 extern PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*); 1283 1284 /*S 1285 MatFDColoring - Object for computing a sparse Jacobian via finite differences 1286 and coloring 1287 1288 Level: beginner 1289 1290 Concepts: coloring, sparse Jacobian, finite differences 1291 1292 .seealso: MatFDColoringCreate() 1293 S*/ 1294 typedef struct _p_MatFDColoring* MatFDColoring; 1295 1296 extern PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *); 1297 extern PetscErrorCode MatFDColoringDestroy(MatFDColoring*); 1298 extern PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer); 1299 extern PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*); 1300 extern PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**); 1301 extern PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal); 1302 extern PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring); 1303 extern PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *); 1304 extern PetscErrorCode MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *); 1305 extern PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec); 1306 extern PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]); 1307 /* 1308 These routines are for partitioning matrices: currently used only 1309 for adjacency matrix, MatCreateMPIAdj(). 1310 */ 1311 1312 /*S 1313 MatPartitioning - Object for managing the partitioning of a matrix or graph 1314 1315 Level: beginner 1316 1317 Concepts: partitioning 1318 1319 .seealso: MatPartitioningCreate(), MatPartitioningType 1320 S*/ 1321 typedef struct _p_MatPartitioning* MatPartitioning; 1322 1323 /*E 1324 MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function 1325 with an optional dynamic library name, for example 1326 http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate() 1327 1328 Level: beginner 1329 1330 .seealso: MatPartitioningCreate(), MatPartitioning 1331 E*/ 1332 #define MatPartitioningType char* 1333 #define MATPARTITIONINGCURRENT "current" 1334 #define MATPARTITIONINGSQUARE "square" 1335 #define MATPARTITIONINGPARMETIS "parmetis" 1336 #define MATPARTITIONINGCHACO "chaco" 1337 #define MATPARTITIONINGPARTY "party" 1338 #define MATPARTITIONINGPTSCOTCH "ptscotch" 1339 1340 1341 extern PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*); 1342 extern PetscErrorCode MatPartitioningSetType(MatPartitioning,const MatPartitioningType); 1343 extern PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt); 1344 extern PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat); 1345 extern PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]); 1346 extern PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []); 1347 extern PetscErrorCode MatPartitioningApply(MatPartitioning,IS*); 1348 extern PetscErrorCode MatPartitioningDestroy(MatPartitioning*); 1349 1350 extern PetscErrorCode MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning)); 1351 1352 /*MC 1353 MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the 1354 matrix package. 1355 1356 Synopsis: 1357 PetscErrorCode MatPartitioningRegisterDynamic(const char *name_partitioning,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatPartitioning)) 1358 1359 Not Collective 1360 1361 Input Parameters: 1362 + sname - name of partitioning (for example MATPARTITIONINGCURRENT) or parmetis 1363 . path - location of library where creation routine is 1364 . name - name of function that creates the partitioning type, a string 1365 - function - function pointer that creates the partitioning type 1366 1367 Level: developer 1368 1369 If dynamic libraries are used, then the fourth input argument (function) 1370 is ignored. 1371 1372 Sample usage: 1373 .vb 1374 MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a, 1375 "MyPartCreate",MyPartCreate); 1376 .ve 1377 1378 Then, your partitioner can be chosen with the procedural interface via 1379 $ MatPartitioningSetType(part,"my_part") 1380 or at runtime via the option 1381 $ -mat_partitioning_type my_part 1382 1383 $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 1384 1385 .keywords: matrix, partitioning, register 1386 1387 .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll() 1388 M*/ 1389 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1390 #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0) 1391 #else 1392 #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d) 1393 #endif 1394 1395 extern PetscBool MatPartitioningRegisterAllCalled; 1396 1397 extern PetscErrorCode MatPartitioningRegisterAll(const char[]); 1398 extern PetscErrorCode MatPartitioningRegisterDestroy(void); 1399 1400 extern PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer); 1401 extern PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning); 1402 extern PetscErrorCode MatPartitioningGetType(MatPartitioning,const MatPartitioningType*); 1403 1404 extern PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning); 1405 extern PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *); 1406 1407 typedef enum { MP_CHACO_MULTILEVEL=1,MP_CHACO_SPECTRAL=2,MP_CHACO_LINEAR=4,MP_CHACO_RANDOM=5,MP_CHACO_SCATTERED=6 } MPChacoGlobalType; 1408 extern const char *MPChacoGlobalTypes[]; 1409 typedef enum { MP_CHACO_KERNIGHAN=1,MP_CHACO_NONE=2 } MPChacoLocalType; 1410 extern const char *MPChacoLocalTypes[]; 1411 typedef enum { MP_CHACO_LANCZOS=0,MP_CHACO_RQI=1 } MPChacoEigenType; 1412 extern const char *MPChacoEigenTypes[]; 1413 1414 extern PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning,MPChacoGlobalType); 1415 extern PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning,MPChacoGlobalType*); 1416 extern PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning,MPChacoLocalType); 1417 extern PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning,MPChacoLocalType*); 1418 extern PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal); 1419 extern PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType); 1420 extern PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning,MPChacoEigenType*); 1421 extern PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning,PetscReal); 1422 extern PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning,PetscReal*); 1423 extern PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning,PetscInt); 1424 extern PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning,PetscInt*); 1425 1426 #define MP_PARTY_OPT "opt" 1427 #define MP_PARTY_LIN "lin" 1428 #define MP_PARTY_SCA "sca" 1429 #define MP_PARTY_RAN "ran" 1430 #define MP_PARTY_GBF "gbf" 1431 #define MP_PARTY_GCF "gcf" 1432 #define MP_PARTY_BUB "bub" 1433 #define MP_PARTY_DEF "def" 1434 extern PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning,const char*); 1435 #define MP_PARTY_HELPFUL_SETS "hs" 1436 #define MP_PARTY_KERNIGHAN_LIN "kl" 1437 #define MP_PARTY_NONE "no" 1438 extern PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning,const char*); 1439 extern PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal); 1440 extern PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscBool); 1441 extern PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool); 1442 1443 typedef enum { MP_PTSCOTCH_QUALITY,MP_PTSCOTCH_SPEED,MP_PTSCOTCH_BALANCE,MP_PTSCOTCH_SAFETY,MP_PTSCOTCH_SCALABILITY } MPPTScotchStrategyType; 1444 extern const char *MPPTScotchStrategyTypes[]; 1445 1446 extern PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal); 1447 extern PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*); 1448 extern PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType); 1449 extern PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*); 1450 1451 extern PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*); 1452 extern PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*); 1453 1454 /* 1455 If you add entries here you must also add them to finclude/petscmat.h 1456 */ 1457 typedef enum { MATOP_SET_VALUES=0, 1458 MATOP_GET_ROW=1, 1459 MATOP_RESTORE_ROW=2, 1460 MATOP_MULT=3, 1461 MATOP_MULT_ADD=4, 1462 MATOP_MULT_TRANSPOSE=5, 1463 MATOP_MULT_TRANSPOSE_ADD=6, 1464 MATOP_SOLVE=7, 1465 MATOP_SOLVE_ADD=8, 1466 MATOP_SOLVE_TRANSPOSE=9, 1467 MATOP_SOLVE_TRANSPOSE_ADD=10, 1468 MATOP_LUFACTOR=11, 1469 MATOP_CHOLESKYFACTOR=12, 1470 MATOP_SOR=13, 1471 MATOP_TRANSPOSE=14, 1472 MATOP_GETINFO=15, 1473 MATOP_EQUAL=16, 1474 MATOP_GET_DIAGONAL=17, 1475 MATOP_DIAGONAL_SCALE=18, 1476 MATOP_NORM=19, 1477 MATOP_ASSEMBLY_BEGIN=20, 1478 MATOP_ASSEMBLY_END=21, 1479 MATOP_SET_OPTION=22, 1480 MATOP_ZERO_ENTRIES=23, 1481 MATOP_ZERO_ROWS=24, 1482 MATOP_LUFACTOR_SYMBOLIC=25, 1483 MATOP_LUFACTOR_NUMERIC=26, 1484 MATOP_CHOLESKY_FACTOR_SYMBOLIC=27, 1485 MATOP_CHOLESKY_FACTOR_NUMERIC=28, 1486 MATOP_SETUP_PREALLOCATION=29, 1487 MATOP_ILUFACTOR_SYMBOLIC=30, 1488 MATOP_ICCFACTOR_SYMBOLIC=31, 1489 MATOP_GET_ARRAY=32, 1490 MATOP_RESTORE_ARRAY=33, 1491 MATOP_DUPLICATE=34, 1492 MATOP_FORWARD_SOLVE=35, 1493 MATOP_BACKWARD_SOLVE=36, 1494 MATOP_ILUFACTOR=37, 1495 MATOP_ICCFACTOR=38, 1496 MATOP_AXPY=39, 1497 MATOP_GET_SUBMATRICES=40, 1498 MATOP_INCREASE_OVERLAP=41, 1499 MATOP_GET_VALUES=42, 1500 MATOP_COPY=43, 1501 MATOP_GET_ROW_MAX=44, 1502 MATOP_SCALE=45, 1503 MATOP_SHIFT=46, 1504 MATOP_DIAGONAL_SET=47, 1505 MATOP_ILUDT_FACTOR=48, 1506 MATOP_SET_BLOCK_SIZE=49, 1507 MATOP_GET_ROW_IJ=50, 1508 MATOP_RESTORE_ROW_IJ=51, 1509 MATOP_GET_COLUMN_IJ=52, 1510 MATOP_RESTORE_COLUMN_IJ=53, 1511 MATOP_FDCOLORING_CREATE=54, 1512 MATOP_COLORING_PATCH=55, 1513 MATOP_SET_UNFACTORED=56, 1514 MATOP_PERMUTE=57, 1515 MATOP_SET_VALUES_BLOCKED=58, 1516 MATOP_GET_SUBMATRIX=59, 1517 MATOP_DESTROY=60, 1518 MATOP_VIEW=61, 1519 MATOP_CONVERT_FROM=62, 1520 MATOP_USE_SCALED_FORM=63, 1521 MATOP_SCALE_SYSTEM=64, 1522 MATOP_UNSCALE_SYSTEM=65, 1523 MATOP_SET_LOCAL_TO_GLOBAL_MAP=66, 1524 MATOP_SET_VALUES_LOCAL=67, 1525 MATOP_ZERO_ROWS_LOCAL=68, 1526 MATOP_GET_ROW_MAX_ABS=69, 1527 MATOP_GET_ROW_MIN_ABS=70, 1528 MATOP_CONVERT=71, 1529 MATOP_SET_COLORING=72, 1530 MATOP_SET_VALUES_ADIC=73, 1531 MATOP_SET_VALUES_ADIFOR=74, 1532 MATOP_FD_COLORING_APPLY=75, 1533 MATOP_SET_FROM_OPTIONS=76, 1534 MATOP_MULT_CON=77, 1535 MATOP_MULT_TRANSPOSE_CON=78, 1536 MATOP_PERMUTE_SPARSIFY=79, 1537 MATOP_MULT_MULTIPLE=80, 1538 MATOP_SOLVE_MULTIPLE=81, 1539 MATOP_GET_INERTIA=82, 1540 MATOP_LOAD=83, 1541 MATOP_IS_SYMMETRIC=84, 1542 MATOP_IS_HERMITIAN=85, 1543 MATOP_IS_STRUCTURALLY_SYMMETRIC=86, 1544 MATOP_DUMMY=87, 1545 MATOP_GET_VECS=88, 1546 MATOP_MAT_MULT=89, 1547 MATOP_MAT_MULT_SYMBOLIC=90, 1548 MATOP_MAT_MULT_NUMERIC=91, 1549 MATOP_PTAP=92, 1550 MATOP_PTAP_SYMBOLIC=93, 1551 MATOP_PTAP_NUMERIC=94, 1552 MATOP_MAT_MULTTRANSPOSE=95, 1553 MATOP_MAT_MULTTRANSPOSE_SYM=96, 1554 MATOP_MAT_MULTTRANSPOSE_NUM=97, 1555 MATOP_PTAP_SYMBOLIC_SEQAIJ=98, 1556 MATOP_PTAP_NUMERIC_SEQAIJ=99, 1557 MATOP_PTAP_SYMBOLIC_MPIAIJ=100, 1558 MATOP_PTAP_NUMERIC_MPIAIJ=101, 1559 MATOP_CONJUGATE=102, 1560 MATOP_SET_SIZES=103, 1561 MATOP_SET_VALUES_ROW=104, 1562 MATOP_REAL_PART=105, 1563 MATOP_IMAG_PART=106, 1564 MATOP_GET_ROW_UTRIANGULAR=107, 1565 MATOP_RESTORE_ROW_UTRIANGULAR=108, 1566 MATOP_MATSOLVE=109, 1567 MATOP_GET_REDUNDANTMATRIX=110, 1568 MATOP_GET_ROW_MIN=111, 1569 MATOP_GET_COLUMN_VEC=112, 1570 MATOP_MISSING_DIAGONAL=113, 1571 MATOP_MATGETSEQNONZEROSTRUCTURE=114, 1572 MATOP_CREATE=115, 1573 MATOP_GET_GHOSTS=116, 1574 MATOP_GET_LOCALSUBMATRIX=117, 1575 MATOP_RESTORE_LOCALSUBMATRIX=118, 1576 MATOP_MULT_DIAGONAL_BLOCK=119, 1577 MATOP_HERMITIANTRANSPOSE=120, 1578 MATOP_MULTHERMITIANTRANSPOSE=121, 1579 MATOP_MULTHERMITIANTRANSPOSEADD=122, 1580 MATOP_GETMULTIPROCBLOCK=123, 1581 MATOP_GETCOLUMNNORMS=125, 1582 MATOP_GET_SUBMATRICES_PARALLEL=128, 1583 MATOP_SET_VALUES_BATCH=129 1584 } MatOperation; 1585 extern PetscErrorCode MatHasOperation(Mat,MatOperation,PetscBool *); 1586 extern PetscErrorCode MatShellSetOperation(Mat,MatOperation,void(*)(void)); 1587 extern PetscErrorCode MatShellGetOperation(Mat,MatOperation,void(**)(void)); 1588 extern PetscErrorCode MatShellSetContext(Mat,void*); 1589 1590 /* 1591 Codes for matrices stored on disk. By default they are 1592 stored in a universal format. By changing the format with 1593 PetscViewerSetFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will 1594 be stored in a way natural for the matrix, for example dense matrices 1595 would be stored as dense. Matrices stored this way may only be 1596 read into matrices of the same type. 1597 */ 1598 #define MATRIX_BINARY_FORMAT_DENSE -1 1599 1600 extern PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal); 1601 extern PetscErrorCode MatISGetLocalMat(Mat,Mat*); 1602 1603 /*S 1604 MatNullSpace - Object that removes a null space from a vector, i.e. 1605 orthogonalizes the vector to a subsapce 1606 1607 Level: advanced 1608 1609 Concepts: matrix; linear operator, null space 1610 1611 Users manual sections: 1612 . sec_singular 1613 1614 .seealso: MatNullSpaceCreate() 1615 S*/ 1616 typedef struct _p_MatNullSpace* MatNullSpace; 1617 1618 extern PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*); 1619 extern PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*); 1620 extern PetscErrorCode MatNullSpaceDestroy(MatNullSpace*); 1621 extern PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec,Vec*); 1622 extern PetscErrorCode MatNullSpaceAttach(Mat,MatNullSpace); 1623 extern PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscBool *); 1624 extern PetscErrorCode MatNullSpaceView(MatNullSpace,PetscViewer); 1625 1626 extern PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS); 1627 extern PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal); 1628 extern PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *); 1629 extern PetscErrorCode MatSeqBAIJInvertBlockDiagonal(Mat); 1630 1631 extern PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*); 1632 extern PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*); 1633 extern PetscErrorCode MatMAIJGetAIJ(Mat,Mat*); 1634 1635 extern PetscErrorCode MatComputeExplicitOperator(Mat,Mat*); 1636 1637 extern PetscErrorCode MatDiagonalScaleLocal(Mat,Vec); 1638 1639 extern PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*); 1640 extern PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec); 1641 extern PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*); 1642 extern PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*)); 1643 extern PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec)); 1644 extern PetscErrorCode MatMFFDAddNullSpace(Mat,MatNullSpace); 1645 extern PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt); 1646 extern PetscErrorCode MatMFFDResetHHistory(Mat); 1647 extern PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal); 1648 extern PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt); 1649 extern PetscErrorCode MatMFFDGetH(Mat,PetscScalar *); 1650 extern PetscErrorCode MatMFFDSetOptionsPrefix(Mat,const char[]); 1651 extern PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*); 1652 extern PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*); 1653 1654 /*S 1655 MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free 1656 Jacobian vector products 1657 1658 Notes: MATMFFD is a specific MatType which uses the MatMFFD data structure 1659 1660 MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure 1661 1662 Level: developer 1663 1664 .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister() 1665 S*/ 1666 typedef struct _p_MatMFFD* MatMFFD; 1667 1668 /*E 1669 MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function 1670 1671 Level: beginner 1672 1673 .seealso: MatMFFDSetType(), MatMFFDRegister() 1674 E*/ 1675 #define MatMFFDType char* 1676 #define MATMFFD_DS "ds" 1677 #define MATMFFD_WP "wp" 1678 1679 extern PetscErrorCode MatMFFDSetType(Mat,const MatMFFDType); 1680 extern PetscErrorCode MatMFFDRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatMFFD)); 1681 1682 /*MC 1683 MatMFFDRegisterDynamic - Adds a method to the MatMFFD registry. 1684 1685 Synopsis: 1686 PetscErrorCode MatMFFDRegisterDynamic(const char *name_solver,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatMFFD)) 1687 1688 Not Collective 1689 1690 Input Parameters: 1691 + name_solver - name of a new user-defined compute-h module 1692 . path - path (either absolute or relative) the library containing this solver 1693 . name_create - name of routine to create method context 1694 - routine_create - routine to create method context 1695 1696 Level: developer 1697 1698 Notes: 1699 MatMFFDRegisterDynamic() may be called multiple times to add several user-defined solvers. 1700 1701 If dynamic libraries are used, then the fourth input argument (routine_create) 1702 is ignored. 1703 1704 Sample usage: 1705 .vb 1706 MatMFFDRegisterDynamic("my_h",/home/username/my_lib/lib/libO/solaris/mylib.a, 1707 "MyHCreate",MyHCreate); 1708 .ve 1709 1710 Then, your solver can be chosen with the procedural interface via 1711 $ MatMFFDSetType(mfctx,"my_h") 1712 or at runtime via the option 1713 $ -snes_mf_type my_h 1714 1715 .keywords: MatMFFD, register 1716 1717 .seealso: MatMFFDRegisterAll(), MatMFFDRegisterDestroy() 1718 M*/ 1719 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1720 #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,0) 1721 #else 1722 #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,d) 1723 #endif 1724 1725 extern PetscErrorCode MatMFFDRegisterAll(const char[]); 1726 extern PetscErrorCode MatMFFDRegisterDestroy(void); 1727 extern PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal); 1728 extern PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscBool ); 1729 1730 1731 extern PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *); 1732 extern PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *); 1733 1734 /* 1735 PETSc interface to MUMPS 1736 */ 1737 #ifdef PETSC_HAVE_MUMPS 1738 extern PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt); 1739 #endif 1740 1741 /* 1742 PETSc interface to SUPERLU 1743 */ 1744 #ifdef PETSC_HAVE_SUPERLU 1745 extern PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal); 1746 #endif 1747 1748 #if defined(PETSC_HAVE_CUSP) 1749 extern PetscErrorCode MatCreateSeqAIJCUSP(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*); 1750 extern PetscErrorCode MatCreateMPIAIJCUSP(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*); 1751 #endif 1752 1753 /* 1754 PETSc interface to FFTW 1755 */ 1756 #if defined(PETSC_HAVE_FFTW) 1757 extern PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec); 1758 extern PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec); 1759 extern PetscErrorCode MatGetVecsFFTW(Mat,Vec*,Vec*,Vec*); 1760 #endif 1761 1762 extern PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*); 1763 extern PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*); 1764 extern PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***); 1765 extern PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*); 1766 extern PetscErrorCode MatNestSetVecType(Mat,const VecType); 1767 extern PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]); 1768 extern PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat); 1769 1770 PETSC_EXTERN_CXX_END 1771 #endif 1772