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