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