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