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