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