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