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