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