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