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