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