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