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