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