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