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