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 PETSCMAT_DLLEXPORT MatZeroEntries(Mat); 528 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar); 529 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsIS(Mat,IS,PetscScalar); 530 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumns(Mat,PetscInt,const PetscInt [],const PetscScalar*); 531 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroColumnsIS(Mat,IS,const PetscScalar*); 532 533 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUseScaledForm(Mat,PetscTruth); 534 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScaleSystem(Mat,Vec,Vec); 535 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatUnScaleSystem(Mat,Vec,Vec); 536 537 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSize(Mat,PetscInt*,PetscInt*); 538 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalSize(Mat,PetscInt*,PetscInt*); 539 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRange(Mat,PetscInt*,PetscInt*); 540 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRanges(Mat,const PetscInt**); 541 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*); 542 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOwnershipRangesColumn(Mat,const PetscInt**); 543 544 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]); 545 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroyMatrices(PetscInt,Mat *[]); 546 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSubMatrix(Mat,IS,IS,MatReuse,Mat *); 547 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetSeqNonzeroStructure(Mat,Mat *[]); 548 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroySeqNonzeroStructure(Mat *[]); 549 550 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge(MPI_Comm,Mat,PetscInt,MatReuse,Mat*); 551 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPI(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*); 552 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPISymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*); 553 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMerge_SeqsToMPINumeric(Mat,Mat); 554 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDestroy_MPIAIJ_SeqsToMPI(Mat); 555 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMat(Mat,MatReuse,Mat*); 556 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*); 557 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,PetscInt*,Mat*); 558 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetBrowsOfAoCols(Mat,Mat,MatReuse,PetscInt**,MatScalar**,Mat*); 559 #if defined (PETSC_USE_CTABLE) 560 #include "petscctable.h" 561 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscTable *, VecScatter *); 562 #else 563 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetCommunicationStructs(Mat, Vec *, PetscInt *[], VecScatter *); 564 #endif 565 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetGhosts(Mat, PetscInt *,const PetscInt *[]); 566 567 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt); 568 569 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*); 570 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*); 571 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultNumeric(Mat,Mat,Mat); 572 573 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*); 574 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*); 575 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPtAPNumeric(Mat,Mat,Mat); 576 577 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTranspose(Mat,Mat,MatReuse,PetscReal,Mat*); 578 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeSymbolic(Mat,Mat,PetscReal,Mat*); 579 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMatMultTransposeNumeric(Mat,Mat,Mat); 580 581 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAXPY(Mat,PetscScalar,Mat,MatStructure); 582 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAYPX(Mat,PetscScalar,Mat,MatStructure); 583 584 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatScale(Mat,PetscScalar); 585 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShift(Mat,PetscScalar); 586 587 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping); 588 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping); 589 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar); 590 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatZeroRowsLocalIS(Mat,IS,PetscScalar); 591 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 592 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode); 593 594 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashSetInitialSize(Mat,PetscInt,PetscInt); 595 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 596 597 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolate(Mat,Vec,Vec); 598 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInterpolateAdd(Mat,Vec,Vec,Vec); 599 PetscPolymorphicSubroutine(MatInterpolateAdd,(Mat A,Vec x,Vec y),(A,x,y,y)) 600 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRestrict(Mat,Vec,Vec); 601 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetVecs(Mat,Vec*,Vec*); 602 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetRedundantMatrix(Mat,PetscInt,MPI_Comm,PetscInt,MatReuse,Mat*); 603 604 /*MC 605 MatSetValue - Set a single entry into a matrix. 606 607 Not collective 608 609 Input Parameters: 610 + m - the matrix 611 . row - the row location of the entry 612 . col - the column location of the entry 613 . value - the value to insert 614 - mode - either INSERT_VALUES or ADD_VALUES 615 616 Notes: 617 For efficiency one should use MatSetValues() and set several or many 618 values simultaneously if possible. 619 620 Level: beginner 621 622 .seealso: MatSetValues(), MatSetValueLocal() 623 M*/ 624 PETSC_STATIC_INLINE PetscErrorCode MatSetValue(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValues(v,1,&i,1,&j,&va,mode);} 625 626 PETSC_STATIC_INLINE PetscErrorCode MatGetValue(Mat v,PetscInt i,PetscInt j,PetscScalar *va) {return MatGetValues(v,1,&i,1,&j,va);} 627 628 PETSC_STATIC_INLINE PetscErrorCode MatSetValueLocal(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValuesLocal(v,1,&i,1,&j,&va,mode);} 629 630 /*MC 631 MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per 632 row in a matrix providing the data that one can use to correctly preallocate the matrix. 633 634 Synopsis: 635 PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz) 636 637 Collective on MPI_Comm 638 639 Input Parameters: 640 + comm - the communicator that will share the eventually allocated matrix 641 . nrows - the number of LOCAL rows in the matrix 642 - ncols - the number of LOCAL columns in the matrix 643 644 Output Parameters: 645 + dnz - the array that will be passed to the matrix preallocation routines 646 - ozn - the other array passed to the matrix preallocation routines 647 648 649 Level: intermediate 650 651 Notes: 652 See the chapter in the users manual on performance for more details 653 654 Do not malloc or free dnz and onz, that is handled internally by these routines 655 656 Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices) 657 658 This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize(). 659 660 Concepts: preallocation^Matrix 661 662 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 663 MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal() 664 M*/ 665 #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \ 666 { \ 667 PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__start,__end; \ 668 _4_ierr = PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \ 669 _4_ierr = PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\ 670 _4_ierr = PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\ 671 _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\ 672 _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows; 673 674 /*MC 675 MatPreallocateSymmetricInitialize - Begins the block of code that will count the number of nonzeros per 676 row in a matrix providing the data that one can use to correctly preallocate the matrix. 677 678 Synopsis: 679 PetscErrorCode MatPreallocateSymmetricInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz) 680 681 Collective on MPI_Comm 682 683 Input Parameters: 684 + comm - the communicator that will share the eventually allocated matrix 685 . nrows - the number of LOCAL rows in the matrix 686 - ncols - the number of LOCAL columns in the matrix 687 688 Output Parameters: 689 + dnz - the array that will be passed to the matrix preallocation routines 690 - ozn - the other array passed to the matrix preallocation routines 691 692 693 Level: intermediate 694 695 Notes: 696 See the chapter in the users manual on performance for more details 697 698 Do not malloc or free dnz and onz, that is handled internally by these routines 699 700 This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize(). 701 702 Concepts: preallocation^Matrix 703 704 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 705 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal() 706 M*/ 707 #define MatPreallocateSymmetricInitialize(comm,nrows,ncols,dnz,onz) 0; \ 708 { \ 709 PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__end; \ 710 _4_ierr = PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \ 711 _4_ierr = PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\ 712 _4_ierr = PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\ 713 _4_ierr = MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr);\ 714 _4_ierr = MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows; 715 716 /*MC 717 MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 718 inserted using a local number of the rows and columns 719 720 Synopsis: 721 PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 722 723 Not Collective 724 725 Input Parameters: 726 + map - the mapping between local numbering and global numbering 727 . nrows - the number of rows indicated 728 . rows - the indices of the rows 729 . ncols - the number of columns in the matrix 730 . cols - the columns indicated 731 . dnz - the array that will be passed to the matrix preallocation routines 732 - ozn - the other array passed to the matrix preallocation routines 733 734 735 Level: intermediate 736 737 Notes: 738 See the chapter in the users manual on performance for more details 739 740 Do not malloc or free dnz and onz, that is handled internally by these routines 741 742 Concepts: preallocation^Matrix 743 744 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 745 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal() 746 M*/ 747 #define MatPreallocateSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\ 748 {\ 749 PetscInt __l;\ 750 _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\ 751 _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\ 752 for (__l=0;__l<nrows;__l++) {\ 753 _4_ierr = MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 754 }\ 755 } 756 757 /*MC 758 MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be 759 inserted using a local number of the rows and columns 760 761 Synopsis: 762 PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 763 764 Not Collective 765 766 Input Parameters: 767 + map - the mapping between local numbering and global numbering 768 . nrows - the number of rows indicated 769 . rows - the indices of the rows 770 . ncols - the number of columns in the matrix 771 . cols - the columns indicated 772 . dnz - the array that will be passed to the matrix preallocation routines 773 - ozn - the other array passed to the matrix preallocation routines 774 775 776 Level: intermediate 777 778 Notes: 779 See the chapter in the users manual on performance for more details 780 781 Do not malloc or free dnz and onz that is handled internally by these routines 782 783 Concepts: preallocation^Matrix 784 785 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 786 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 787 M*/ 788 #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\ 789 {\ 790 PetscInt __l;\ 791 _4_ierr = ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\ 792 _4_ierr = ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\ 793 for (__l=0;__l<nrows;__l++) {\ 794 _4_ierr = MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\ 795 }\ 796 } 797 798 /*MC 799 MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 800 inserted using a local number of the rows and columns 801 802 Synopsis: 803 PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 804 805 Not Collective 806 807 Input Parameters: 808 + row - the row 809 . ncols - the number of columns in the matrix 810 - cols - the columns indicated 811 812 Output Parameters: 813 + dnz - the array that will be passed to the matrix preallocation routines 814 - ozn - the other array passed to the matrix preallocation routines 815 816 817 Level: intermediate 818 819 Notes: 820 See the chapter in the users manual on performance for more details 821 822 Do not malloc or free dnz and onz that is handled internally by these routines 823 824 This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize(). 825 826 Concepts: preallocation^Matrix 827 828 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 829 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 830 M*/ 831 #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\ 832 { PetscInt __i; \ 833 if (row < __rstart) SETERRQ2(PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D less than first local row %D",row,__rstart);\ 834 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);\ 835 for (__i=0; __i<nc; __i++) {\ 836 if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \ 837 else dnz[row - __rstart]++;\ 838 }\ 839 } 840 841 /*MC 842 MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be 843 inserted using a local number of the rows and columns 844 845 Synopsis: 846 PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz) 847 848 Not Collective 849 850 Input Parameters: 851 + nrows - the number of rows indicated 852 . rows - the indices of the rows 853 . ncols - the number of columns in the matrix 854 . cols - the columns indicated 855 . dnz - the array that will be passed to the matrix preallocation routines 856 - ozn - the other array passed to the matrix preallocation routines 857 858 859 Level: intermediate 860 861 Notes: 862 See the chapter in the users manual on performance for more details 863 864 Do not malloc or free dnz and onz that is handled internally by these routines 865 866 This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize(). 867 868 Concepts: preallocation^Matrix 869 870 .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(), 871 MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal() 872 M*/ 873 #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\ 874 { PetscInt __i; \ 875 for (__i=0; __i<nc; __i++) {\ 876 if (cols[__i] >= __end) onz[row - __rstart]++; \ 877 else if (cols[__i] >= row) dnz[row - __rstart]++;\ 878 }\ 879 } 880 881 /*MC 882 MatPreallocateLocation - An alternative to MatPreallocationSet() that puts the nonzero locations into the matrix if it exists 883 884 Synopsis: 885 PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz) 886 887 Not Collective 888 889 Input Parameters: 890 . A - matrix 891 . row - row where values exist (must be local to this process) 892 . ncols - number of columns 893 . cols - columns with nonzeros 894 . dnz - the array that will be passed to the matrix preallocation routines 895 - ozn - the other array passed to the matrix preallocation routines 896 897 898 Level: intermediate 899 900 Notes: 901 See the chapter in the users manual on performance for more details 902 903 Do not malloc or free dnz and onz that is handled internally by these routines 904 905 This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines. 906 907 Concepts: preallocation^Matrix 908 909 .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 910 MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal() 911 M*/ 912 #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);} 913 914 915 /*MC 916 MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per 917 row in a matrix providing the data that one can use to correctly preallocate the matrix. 918 919 Synopsis: 920 PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz) 921 922 Collective on MPI_Comm 923 924 Input Parameters: 925 + dnz - the array that was 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 closes the { started in MatPreallocateInitialize(). 937 938 Concepts: preallocation^Matrix 939 940 .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(), 941 MatPreallocateSymmetricInitialize(), MatPreallocateSymmetricSetLocal() 942 M*/ 943 #define MatPreallocateFinalize(dnz,onz) 0;_4_ierr = PetscFree2(dnz,onz);CHKERRQ(_4_ierr);} 944 945 946 947 /* Routines unique to particular data structures */ 948 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetContext(Mat,void **); 949 PetscPolymorphicFunction(MatShellGetContext,(Mat A),(A,&t),void*,t) 950 951 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeAdjustForInodes(Mat,IS*,IS*); 952 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *); 953 954 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetColumnIndices(Mat,PetscInt[]); 955 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetColumnIndices(Mat,PetscInt[]); 956 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 957 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 958 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*); 959 960 #define MAT_SKIP_ALLOCATION -4 961 962 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 963 PetscPolymorphicSubroutine(MatSeqBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz)) 964 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]); 965 PetscPolymorphicSubroutine(MatSeqSBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[]),(A,bs,0,nnz)) 966 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]); 967 PetscPolymorphicSubroutine(MatSeqAIJSetPreallocation,(Mat A,const PetscInt nnz[]),(A,0,nnz)) 968 969 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 970 PetscPolymorphicSubroutine(MatMPIBAIJSetPreallocation,(Mat A,PetscInt bs,const PetscInt nnz[],const PetscInt onz[]),(A,bs,0,nnz,0,onz)) 971 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 972 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]); 973 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []); 974 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 975 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]); 976 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]); 977 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]); 978 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIDenseSetPreallocation(Mat,PetscScalar[]); 979 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetPreallocation(Mat,PetscScalar[]); 980 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIRowbsSetPreallocation(Mat,PetscInt,const PetscInt[]); 981 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]); 982 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]); 983 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatAdicSetLocalFunction(Mat,void (*)(void)); 984 985 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqDenseSetLDA(Mat,PetscInt); 986 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDenseGetLocalMatrix(Mat,Mat*); 987 988 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatStoreValues(Mat); 989 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRetrieveValues(Mat); 990 991 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDAADSetCtx(Mat,void*); 992 993 /* 994 These routines are not usually accessed directly, rather solving is 995 done through the KSP and PC interfaces. 996 */ 997 998 /*E 999 MatOrderingType - String with the name of a PETSc matrix ordering or the creation function 1000 with an optional dynamic library name, for example 1001 http://www.mcs.anl.gov/petsc/lib.a:orderingcreate() 1002 1003 Level: beginner 1004 1005 Cannot use const because the PC objects manipulate the string 1006 1007 .seealso: MatGetOrdering() 1008 E*/ 1009 #define MatOrderingType char* 1010 #define MATORDERING_NATURAL "natural" 1011 #define MATORDERING_ND "nd" 1012 #define MATORDERING_1WD "1wd" 1013 #define MATORDERING_RCM "rcm" 1014 #define MATORDERING_QMD "qmd" 1015 #define MATORDERING_ROWLENGTH "rowlength" 1016 #define MATORDERING_DSC_ND "dsc_nd" /* these three are only for DSCPACK, see its documentation for details */ 1017 #define MATORDERING_DSC_MMD "dsc_mmd" 1018 #define MATORDERING_DSC_MDF "dsc_mdf" 1019 #define MATORDERING_CONSTRAINED "constrained" 1020 #define MATORDERING_IDENTITY "identity" 1021 #define MATORDERING_REVERSE "reverse" 1022 #define MATORDERING_FLOW "flow" 1023 1024 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrdering(Mat,const MatOrderingType,IS*,IS*); 1025 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetOrderingList(PetscFList *list); 1026 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*)); 1027 1028 /*MC 1029 MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the 1030 matrix package. 1031 1032 Synopsis: 1033 PetscErrorCode MatOrderingRegisterDynamic(char *name_ordering,char *path,char *name_create,PetscErrorCode (*routine_create)(MatOrdering)) 1034 1035 Not Collective 1036 1037 Input Parameters: 1038 + sname - name of ordering (for example MATORDERING_ND) 1039 . path - location of library where creation routine is 1040 . name - name of function that creates the ordering type,a string 1041 - function - function pointer that creates the ordering 1042 1043 Level: developer 1044 1045 If dynamic libraries are used, then the fourth input argument (function) 1046 is ignored. 1047 1048 Sample usage: 1049 .vb 1050 MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a, 1051 "MyOrder",MyOrder); 1052 .ve 1053 1054 Then, your partitioner can be chosen with the procedural interface via 1055 $ MatOrderingSetType(part,"my_order) 1056 or at runtime via the option 1057 $ -pc_factor_mat_ordering_type my_order 1058 1059 ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values. 1060 1061 .keywords: matrix, ordering, register 1062 1063 .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll() 1064 M*/ 1065 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1066 #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0) 1067 #else 1068 #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d) 1069 #endif 1070 1071 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterDestroy(void); 1072 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatOrderingRegisterAll(const char[]); 1073 extern PetscTruth MatOrderingRegisterAllCalled; 1074 extern PetscFList MatOrderingList; 1075 1076 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS); 1077 1078 /*S 1079 MatFactorInfo - Data passed into the matrix factorization routines 1080 1081 In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use 1082 $ MatFactorInfo info(MAT_FACTORINFO_SIZE) 1083 1084 Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC. 1085 1086 You can use MatFactorInfoInitialize() to set default values. 1087 1088 Level: developer 1089 1090 .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(), 1091 MatFactorInfoInitialize() 1092 1093 S*/ 1094 typedef struct { 1095 PetscReal shiftnz; /* scaling of identity added to matrix to prevent zero pivots */ 1096 PetscReal shiftpd; /* if true, shift until positive pivots */ 1097 PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */ 1098 PetscReal usedt; 1099 PetscReal dt; /* drop tolerance */ 1100 PetscReal dtcol; /* tolerance for pivoting */ 1101 PetscReal dtcount; /* maximum nonzeros to be allowed per row */ 1102 PetscReal fill; /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */ 1103 PetscReal levels; /* ICC/ILU(levels) */ 1104 PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0 1105 factorization may be faster if do not pivot */ 1106 PetscReal shiftinblocks; /* if block in block factorization has zero pivot then shift diagonal until non-singular */ 1107 PetscReal zeropivot; /* pivot is called zero if less than this */ 1108 } MatFactorInfo; 1109 1110 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFactorInfoInitialize(MatFactorInfo*); 1111 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactor(Mat,IS,const MatFactorInfo*); 1112 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 1113 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*); 1114 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactor(Mat,IS,IS,const MatFactorInfo*); 1115 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactor(Mat,IS,IS,const MatFactorInfo*); 1116 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 1117 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 1118 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*); 1119 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatICCFactor(Mat,IS,const MatFactorInfo*); 1120 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*); 1121 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUDTFactor(Mat,IS,IS,const MatFactorInfo*,Mat *); 1122 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUDTFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*); 1123 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatILUDTFactorNumeric(Mat,Mat,const MatFactorInfo*); 1124 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*); 1125 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolve(Mat,Vec,Vec); 1126 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatForwardSolve(Mat,Vec,Vec); 1127 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatBackwardSolve(Mat,Vec,Vec); 1128 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveAdd(Mat,Vec,Vec,Vec); 1129 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTranspose(Mat,Vec,Vec); 1130 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolveTransposeAdd(Mat,Vec,Vec,Vec); 1131 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSolves(Mat,Vecs,Vecs); 1132 1133 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSetUnfactored(Mat); 1134 1135 /*E 1136 MatSORType - What type of (S)SOR to perform 1137 1138 Level: beginner 1139 1140 May be bitwise ORd together 1141 1142 Any additions/changes here MUST also be made in include/finclude/petscmat.h 1143 1144 MatSORType may be bitwise ORd together, so do not change the numbers 1145 1146 .seealso: MatRelax(), MatPBRelax() 1147 E*/ 1148 typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3, 1149 SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8, 1150 SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16, 1151 SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType; 1152 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec); 1153 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPBRelax(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec); 1154 1155 /* 1156 These routines are for efficiently computing Jacobians via finite differences. 1157 */ 1158 1159 /*E 1160 MatColoringType - String with the name of a PETSc matrix coloring or the creation function 1161 with an optional dynamic library name, for example 1162 http://www.mcs.anl.gov/petsc/lib.a:coloringcreate() 1163 1164 Level: beginner 1165 1166 .seealso: MatGetColoring() 1167 E*/ 1168 #define MatColoringType char* 1169 #define MATCOLORING_NATURAL "natural" 1170 #define MATCOLORING_SL "sl" 1171 #define MATCOLORING_LF "lf" 1172 #define MATCOLORING_ID "id" 1173 1174 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatGetColoring(Mat,const MatColoringType,ISColoring*); 1175 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,MatColoringType,ISColoring *)); 1176 1177 /*MC 1178 MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the 1179 matrix package. 1180 1181 Synopsis: 1182 PetscErrorCode MatColoringRegisterDynamic(char *name_coloring,char *path,char *name_create,PetscErrorCode (*routine_create)(MatColoring)) 1183 1184 Not Collective 1185 1186 Input Parameters: 1187 + sname - name of Coloring (for example MATCOLORING_SL) 1188 . path - location of library where creation routine is 1189 . name - name of function that creates the Coloring type, a string 1190 - function - function pointer that creates the coloring 1191 1192 Level: developer 1193 1194 If dynamic libraries are used, then the fourth input argument (function) 1195 is ignored. 1196 1197 Sample usage: 1198 .vb 1199 MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a, 1200 "MyColor",MyColor); 1201 .ve 1202 1203 Then, your partitioner can be chosen with the procedural interface via 1204 $ MatColoringSetType(part,"my_color") 1205 or at runtime via the option 1206 $ -mat_coloring_type my_color 1207 1208 $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 1209 1210 .keywords: matrix, Coloring, register 1211 1212 .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll() 1213 M*/ 1214 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1215 #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0) 1216 #else 1217 #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d) 1218 #endif 1219 1220 extern PetscTruth MatColoringRegisterAllCalled; 1221 1222 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterAll(const char[]); 1223 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringRegisterDestroy(void); 1224 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*); 1225 1226 /*S 1227 MatFDColoring - Object for computing a sparse Jacobian via finite differences 1228 and coloring 1229 1230 Level: beginner 1231 1232 Concepts: coloring, sparse Jacobian, finite differences 1233 1234 .seealso: MatFDColoringCreate() 1235 S*/ 1236 typedef struct _p_MatFDColoring* MatFDColoring; 1237 1238 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringCreate(Mat,ISColoring,MatFDColoring *); 1239 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringDestroy(MatFDColoring); 1240 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringView(MatFDColoring,PetscViewer); 1241 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*); 1242 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**); 1243 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal); 1244 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetFromOptions(MatFDColoring); 1245 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *); 1246 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringApplyTS(Mat,MatFDColoring,PetscReal,Vec,MatStructure*,void *); 1247 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringSetF(MatFDColoring,Vec); 1248 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]); 1249 /* 1250 These routines are for partitioning matrices: currently used only 1251 for adjacency matrix, MatCreateMPIAdj(). 1252 */ 1253 1254 /*S 1255 MatPartitioning - Object for managing the partitioning of a matrix or graph 1256 1257 Level: beginner 1258 1259 Concepts: partitioning 1260 1261 .seealso: MatPartitioningCreate(), MatPartitioningType 1262 S*/ 1263 typedef struct _p_MatPartitioning* MatPartitioning; 1264 1265 /*E 1266 MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function 1267 with an optional dynamic library name, for example 1268 http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate() 1269 1270 Level: beginner 1271 1272 .seealso: MatPartitioningCreate(), MatPartitioning 1273 E*/ 1274 #define MatPartitioningType char* 1275 #define MAT_PARTITIONING_CURRENT "current" 1276 #define MAT_PARTITIONING_SQUARE "square" 1277 #define MAT_PARTITIONING_PARMETIS "parmetis" 1278 #define MAT_PARTITIONING_CHACO "chaco" 1279 #define MAT_PARTITIONING_JOSTLE "jostle" 1280 #define MAT_PARTITIONING_PARTY "party" 1281 #define MAT_PARTITIONING_SCOTCH "scotch" 1282 1283 1284 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningCreate(MPI_Comm,MatPartitioning*); 1285 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetType(MatPartitioning,const MatPartitioningType); 1286 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetNParts(MatPartitioning,PetscInt); 1287 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetAdjacency(MatPartitioning,Mat); 1288 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]); 1289 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []); 1290 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningApply(MatPartitioning,IS*); 1291 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningDestroy(MatPartitioning); 1292 1293 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning)); 1294 1295 /*MC 1296 MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the 1297 matrix package. 1298 1299 Synopsis: 1300 PetscErrorCode MatPartitioningRegisterDynamic(char *name_partitioning,char *path,char *name_create,PetscErrorCode (*routine_create)(MatPartitioning)) 1301 1302 Not Collective 1303 1304 Input Parameters: 1305 + sname - name of partitioning (for example MAT_PARTITIONING_CURRENT) or parmetis 1306 . path - location of library where creation routine is 1307 . name - name of function that creates the partitioning type, a string 1308 - function - function pointer that creates the partitioning type 1309 1310 Level: developer 1311 1312 If dynamic libraries are used, then the fourth input argument (function) 1313 is ignored. 1314 1315 Sample usage: 1316 .vb 1317 MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a, 1318 "MyPartCreate",MyPartCreate); 1319 .ve 1320 1321 Then, your partitioner can be chosen with the procedural interface via 1322 $ MatPartitioningSetType(part,"my_part") 1323 or at runtime via the option 1324 $ -mat_partitioning_type my_part 1325 1326 $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 1327 1328 .keywords: matrix, partitioning, register 1329 1330 .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll() 1331 M*/ 1332 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1333 #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0) 1334 #else 1335 #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d) 1336 #endif 1337 1338 extern PetscTruth MatPartitioningRegisterAllCalled; 1339 1340 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterAll(const char[]); 1341 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningRegisterDestroy(void); 1342 1343 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningView(MatPartitioning,PetscViewer); 1344 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningSetFromOptions(MatPartitioning); 1345 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningGetType(MatPartitioning,const MatPartitioningType*); 1346 1347 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisSetCoarseSequential(MatPartitioning); 1348 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *); 1349 1350 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseLevel(MatPartitioning,PetscReal); 1351 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningJostleSetCoarseSequential(MatPartitioning); 1352 1353 typedef enum {MP_CHACO_MULTILEVEL_KL,MP_CHACO_SPECTRAL,MP_CHACO_LINEAR,MP_CHACO_RANDOM, MP_CHACO_SCATTERED} MPChacoGlobalType; 1354 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetGlobal(MatPartitioning, MPChacoGlobalType); 1355 typedef enum { MP_CHACO_KERNIGHAN_LIN, MP_CHACO_NONE } MPChacoLocalType; 1356 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetLocal(MatPartitioning, MPChacoLocalType); 1357 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal); 1358 typedef enum { MP_CHACO_LANCZOS, MP_CHACO_RQI_SYMMLQ } MPChacoEigenType; 1359 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType); 1360 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenTol(MatPartitioning, PetscReal); 1361 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningChacoSetEigenNumber(MatPartitioning, PetscInt); 1362 1363 #define MP_PARTY_OPT "opt" 1364 #define MP_PARTY_LIN "lin" 1365 #define MP_PARTY_SCA "sca" 1366 #define MP_PARTY_RAN "ran" 1367 #define MP_PARTY_GBF "gbf" 1368 #define MP_PARTY_GCF "gcf" 1369 #define MP_PARTY_BUB "bub" 1370 #define MP_PARTY_DEF "def" 1371 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetGlobal(MatPartitioning, const char*); 1372 #define MP_PARTY_HELPFUL_SETS "hs" 1373 #define MP_PARTY_KERNIGHAN_LIN "kl" 1374 #define MP_PARTY_NONE "no" 1375 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetLocal(MatPartitioning, const char*); 1376 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal); 1377 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetBipart(MatPartitioning,PetscTruth); 1378 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscTruth); 1379 1380 typedef enum { MP_SCOTCH_GREEDY, MP_SCOTCH_GPS, MP_SCOTCH_GR_GPS } MPScotchGlobalType; 1381 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetArch(MatPartitioning,const char*); 1382 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMultilevel(MatPartitioning); 1383 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetGlobal(MatPartitioning,MPScotchGlobalType); 1384 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetCoarseLevel(MatPartitioning,PetscReal); 1385 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetHostList(MatPartitioning,const char*); 1386 typedef enum { MP_SCOTCH_KERNIGHAN_LIN, MP_SCOTCH_NONE } MPScotchLocalType; 1387 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetLocal(MatPartitioning,MPScotchLocalType); 1388 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetMapping(MatPartitioning); 1389 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatPartitioningScotchSetStrategy(MatPartitioning,char*); 1390 1391 /* 1392 If you add entries here you must also add them to finclude/petscmat.h 1393 */ 1394 typedef enum { MATOP_SET_VALUES=0, 1395 MATOP_GET_ROW=1, 1396 MATOP_RESTORE_ROW=2, 1397 MATOP_MULT=3, 1398 MATOP_MULT_ADD=4, 1399 MATOP_MULT_TRANSPOSE=5, 1400 MATOP_MULT_TRANSPOSE_ADD=6, 1401 MATOP_SOLVE=7, 1402 MATOP_SOLVE_ADD=8, 1403 MATOP_SOLVE_TRANSPOSE=9, 1404 MATOP_SOLVE_TRANSPOSE_ADD=10, 1405 MATOP_LUFACTOR=11, 1406 MATOP_CHOLESKYFACTOR=12, 1407 MATOP_RELAX=13, 1408 MATOP_TRANSPOSE=14, 1409 MATOP_GETINFO=15, 1410 MATOP_EQUAL=16, 1411 MATOP_GET_DIAGONAL=17, 1412 MATOP_DIAGONAL_SCALE=18, 1413 MATOP_NORM=19, 1414 MATOP_ASSEMBLY_BEGIN=20, 1415 MATOP_ASSEMBLY_END=21, 1416 MATOP_SET_OPTION=22, 1417 MATOP_ZERO_ENTRIES=23, 1418 MATOP_ZERO_ROWS=24, 1419 MATOP_LUFACTOR_SYMBOLIC=25, 1420 MATOP_LUFACTOR_NUMERIC=26, 1421 MATOP_CHOLESKY_FACTOR_SYMBOLIC=27, 1422 MATOP_CHOLESKY_FACTOR_NUMERIC=28, 1423 MATOP_SETUP_PREALLOCATION=29, 1424 MATOP_ILUFACTOR_SYMBOLIC=30, 1425 MATOP_ICCFACTOR_SYMBOLIC=31, 1426 MATOP_GET_ARRAY=32, 1427 MATOP_RESTORE_ARRAY=33, 1428 MATOP_DUPLICATE=34, 1429 MATOP_FORWARD_SOLVE=35, 1430 MATOP_BACKWARD_SOLVE=36, 1431 MATOP_ILUFACTOR=37, 1432 MATOP_ICCFACTOR=38, 1433 MATOP_AXPY=39, 1434 MATOP_GET_SUBMATRICES=40, 1435 MATOP_INCREASE_OVERLAP=41, 1436 MATOP_GET_VALUES=42, 1437 MATOP_COPY=43, 1438 MATOP_GET_ROW_MAX=44, 1439 MATOP_SCALE=45, 1440 MATOP_SHIFT=46, 1441 MATOP_DIAGONAL_SHIFT=47, 1442 MATOP_ILUDT_FACTOR=48, 1443 MATOP_SET_BLOCK_SIZE=49, 1444 MATOP_GET_ROW_IJ=50, 1445 MATOP_RESTORE_ROW_IJ=51, 1446 MATOP_GET_COLUMN_IJ=52, 1447 MATOP_RESTORE_COLUMN_IJ=53, 1448 MATOP_FDCOLORING_CREATE=54, 1449 MATOP_COLORING_PATCH=55, 1450 MATOP_SET_UNFACTORED=56, 1451 MATOP_PERMUTE=57, 1452 MATOP_SET_VALUES_BLOCKED=58, 1453 MATOP_GET_SUBMATRIX=59, 1454 MATOP_DESTROY=60, 1455 MATOP_VIEW=61, 1456 MATOP_CONVERT_FROM=62, 1457 MATOP_USE_SCALED_FORM=63, 1458 MATOP_SCALE_SYSTEM=64, 1459 MATOP_UNSCALE_SYSTEM=65, 1460 MATOP_SET_LOCAL_TO_GLOBAL_MAP=66, 1461 MATOP_SET_VALUES_LOCAL=67, 1462 MATOP_ZERO_ROWS_LOCAL=68, 1463 MATOP_GET_ROW_MAX_ABS=69, 1464 MATOP_GET_ROW_MIN_ABS=70, 1465 MATOP_CONVERT=71, 1466 MATOP_SET_COLORING=72, 1467 MATOP_SET_VALUES_ADIC=73, 1468 MATOP_SET_VALUES_ADIFOR=74, 1469 MATOP_FD_COLORING_APPLY=75, 1470 MATOP_SET_FROM_OPTIONS=76, 1471 MATOP_MULT_CON=77, 1472 MATOP_MULT_TRANSPOSE_CON=78, 1473 MATOP_PERMUTE_SPARSIFY=79, 1474 MATOP_MULT_MULTIPLE=80, 1475 MATOP_SOLVE_MULTIPLE=81, 1476 MATOP_GET_INERTIA=82, 1477 MATOP_LOAD=83, 1478 MATOP_IS_SYMMETRIC=84, 1479 MATOP_IS_HERMITIAN=85, 1480 MATOP_IS_STRUCTURALLY_SYMMETRIC=86, 1481 MATOP_PB_RELAX=87, 1482 MATOP_GET_VECS=88, 1483 MATOP_MAT_MULT=89, 1484 MATOP_MAT_MULT_SYMBOLIC=90, 1485 MATOP_MAT_MULT_NUMERIC=91, 1486 MATOP_PTAP=92, 1487 MATOP_PTAP_SYMBOLIC=93, 1488 MATOP_PTAP_NUMERIC=94, 1489 MATOP_MAT_MULTTRANSPOSE=95, 1490 MATOP_MAT_MULTTRANSPOSE_SYMBOLIC=96, 1491 MATOP_MAT_MULTTRANSPOSE_NUMERIC=97, 1492 MATOP_PTAP_SYMBOLIC_SEQAIJ=98, 1493 MATOP_PTAP_NUMERIC_SEQAIJ=99, 1494 MATOP_PTAP_SYMBOLIC_MPIAIJ=100, 1495 MATOP_PTAP_NUMERIC_MPIAIJ=101, 1496 MATOP_CONJUGATE=102, 1497 MATOP_SET_SIZES=103, 1498 MATOP_SET_VALUES_ROW = 104, 1499 MATOP_REAL_PART=105, 1500 MATOP_IMAG_PART=106, 1501 MATOP_GET_ROW_UTRIANGULAR=107, 1502 MATOP_RESTORE_ROW_UTRIANGULAR=108, 1503 MATOP_MATSOLVE=109, 1504 MATOP_GET_REDUNDANTMATRIX=110, 1505 MATOP_GET_ROW_MIN=111, 1506 MATOP_GET_COLUMN_VEC=112, 1507 MATOP_MISSING_DIAGONAL=113, 1508 MATOP_MATGETSEQNONZEROSTRUCTURE=114, 1509 MATOP_CREATE=115, 1510 MATOP_GET_GHOSTS=116, 1511 MATOP_ILUDTFACTORSYMBOLIC=117, 1512 MATOP_ILUDTFACTORNUMERIC=118, 1513 MATOP_MULT_DIAGONAL_BLOCK=119 1514 } MatOperation; 1515 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatHasOperation(Mat,MatOperation,PetscTruth*); 1516 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetOperation(Mat,MatOperation,void(*)(void)); 1517 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellGetOperation(Mat,MatOperation,void(**)(void)); 1518 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatShellSetContext(Mat,void*); 1519 1520 /* 1521 Codes for matrices stored on disk. By default they are 1522 stored in a universal format. By changing the format with 1523 PetscViewerSetFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will 1524 be stored in a way natural for the matrix, for example dense matrices 1525 would be stored as dense. Matrices stored this way may only be 1526 read into matrices of the same time. 1527 */ 1528 #define MATRIX_BINARY_FORMAT_DENSE -1 1529 1530 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPIBAIJSetHashTableFactor(Mat,PetscReal); 1531 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatISGetLocalMat(Mat,Mat*); 1532 1533 /*S 1534 MatNullSpace - Object that removes a null space from a vector, i.e. 1535 orthogonalizes the vector to a subsapce 1536 1537 Level: advanced 1538 1539 Concepts: matrix; linear operator, null space 1540 1541 Users manual sections: 1542 . sec_singular 1543 1544 .seealso: MatNullSpaceCreate() 1545 S*/ 1546 typedef struct _p_MatNullSpace* MatNullSpace; 1547 1548 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceCreate(MPI_Comm,PetscTruth,PetscInt,const Vec[],MatNullSpace*); 1549 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(Vec,void*),void*); 1550 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceDestroy(MatNullSpace); 1551 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceRemove(MatNullSpace,Vec,Vec*); 1552 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceAttach(Mat,MatNullSpace); 1553 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatNullSpaceTest(MatNullSpace,Mat,PetscTruth *); 1554 1555 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatReorderingSeqSBAIJ(Mat,IS); 1556 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMPISBAIJSetHashTableFactor(Mat,PetscReal); 1557 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqSBAIJSetColumnIndices(Mat,PetscInt *); 1558 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatSeqBAIJInvertBlockDiagonal(Mat); 1559 1560 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMAIJ(Mat,PetscInt,Mat*); 1561 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJRedimension(Mat,PetscInt,Mat*); 1562 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMAIJGetAIJ(Mat,Mat*); 1563 1564 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatComputeExplicitOperator(Mat,Mat*); 1565 1566 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatDiagonalScaleLocal(Mat,Vec); 1567 1568 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*); 1569 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetBase(Mat,Vec,Vec); 1570 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*); 1571 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*)); 1572 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec)); 1573 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDAddNullSpace(Mat,MatNullSpace); 1574 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt); 1575 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDResetHHistory(Mat); 1576 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFunctionError(Mat,PetscReal); 1577 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetPeriod(Mat,PetscInt); 1578 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDGetH(Mat,PetscScalar *); 1579 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetFromOptions(Mat); 1580 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*); 1581 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*); 1582 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDDSSetUmin(Mat,PetscReal); 1583 1584 1585 typedef struct _p_MatMFFD* MatMFFD; 1586 1587 /*E 1588 MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function 1589 1590 Level: beginner 1591 1592 .seealso: MatMFFDSetType(), MatMFFDRegister() 1593 E*/ 1594 #define MatMFFDType char* 1595 #define MATMFFD_DS "ds" 1596 #define MATMFFD_WP "wp" 1597 1598 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDSetType(Mat,const MatMFFDType); 1599 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatMFFD)); 1600 1601 /*MC 1602 MatMFFDRegisterDynamic - Adds a method to the MatMFFD registry. 1603 1604 Synopsis: 1605 PetscErrorCode MatMFFDRegisterDynamic(char *name_solver,char *path,char *name_create,PetscErrorCode (*routine_create)(MatMFFD)) 1606 1607 Not Collective 1608 1609 Input Parameters: 1610 + name_solver - name of a new user-defined compute-h module 1611 . path - path (either absolute or relative) the library containing this solver 1612 . name_create - name of routine to create method context 1613 - routine_create - routine to create method context 1614 1615 Level: developer 1616 1617 Notes: 1618 MatMFFDRegisterDynamic() may be called multiple times to add several user-defined solvers. 1619 1620 If dynamic libraries are used, then the fourth input argument (routine_create) 1621 is ignored. 1622 1623 Sample usage: 1624 .vb 1625 MatMFFDRegisterDynamic("my_h",/home/username/my_lib/lib/libO/solaris/mylib.a, 1626 "MyHCreate",MyHCreate); 1627 .ve 1628 1629 Then, your solver can be chosen with the procedural interface via 1630 $ MatMFFDSetType(mfctx,"my_h") 1631 or at runtime via the option 1632 $ -snes_mf_type my_h 1633 1634 .keywords: MatMFFD, register 1635 1636 .seealso: MatMFFDRegisterAll(), MatMFFDRegisterDestroy() 1637 M*/ 1638 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 1639 #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,0) 1640 #else 1641 #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,d) 1642 #endif 1643 1644 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegisterAll(const char[]); 1645 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDRegisterDestroy(void); 1646 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDDefaultSetUmin(Mat,PetscReal); 1647 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDWPSetComputeNormU(Mat,PetscTruth); 1648 1649 1650 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *); 1651 EXTERN PetscErrorCode PETSCMAT_DLLEXPORT PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *); 1652 1653 PETSC_EXTERN_CXX_END 1654 #endif 1655