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