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