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