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