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