Actual source code: petscmat.h
petsc-3.3-p7 2013-05-11
1: /*
2: Include file for the matrix component of PETSc
3: */
4: #ifndef __PETSCMAT_H
6: #include petscvec.h
8: /*S
9: Mat - Abstract PETSc matrix object
11: Level: beginner
13: Concepts: matrix; linear operator
15: .seealso: MatCreate(), MatType, MatSetType()
16: S*/
17: typedef struct _p_Mat* Mat;
19: /*J
20: MatType - String with the name of a PETSc matrix or the creation function
21: with an optional dynamic library name, for example
22: http://www.mcs.anl.gov/petsc/lib.a:mymatcreate()
24: Level: beginner
26: .seealso: MatSetType(), Mat, MatSolverPackage
27: J*/
28: #define MatType char*
29: #define MATSAME "same"
30: #define MATMAIJ "maij"
31: #define MATSEQMAIJ "seqmaij"
32: #define MATMPIMAIJ "mpimaij"
33: #define MATIS "is"
34: #define MATAIJ "aij"
35: #define MATSEQAIJ "seqaij"
36: #define MATSEQAIJPTHREAD "seqaijpthread"
37: #define MATAIJPTHREAD "aijpthread"
38: #define MATMPIAIJ "mpiaij"
39: #define MATAIJCRL "aijcrl"
40: #define MATSEQAIJCRL "seqaijcrl"
41: #define MATMPIAIJCRL "mpiaijcrl"
42: #define MATAIJCUSP "aijcusp"
43: #define MATSEQAIJCUSP "seqaijcusp"
44: #define MATMPIAIJCUSP "mpiaijcusp"
45: #define MATAIJPERM "aijperm"
46: #define MATSEQAIJPERM "seqaijperm"
47: #define MATMPIAIJPERM "mpiaijperm"
48: #define MATSHELL "shell"
49: #define MATDENSE "dense"
50: #define MATSEQDENSE "seqdense"
51: #define MATMPIDENSE "mpidense"
52: #define MATBAIJ "baij"
53: #define MATSEQBAIJ "seqbaij"
54: #define MATMPIBAIJ "mpibaij"
55: #define MATMPIADJ "mpiadj"
56: #define MATSBAIJ "sbaij"
57: #define MATSEQSBAIJ "seqsbaij"
58: #define MATMPISBAIJ "mpisbaij"
59: #define MATSEQBSTRM "seqbstrm"
60: #define MATMPIBSTRM "mpibstrm"
61: #define MATBSTRM "bstrm"
62: #define MATSEQSBSTRM "seqsbstrm"
63: #define MATMPISBSTRM "mpisbstrm"
64: #define MATSBSTRM "sbstrm"
65: #define MATDAAD "daad"
66: #define MATMFFD "mffd"
67: #define MATNORMAL "normal"
68: #define MATLRC "lrc"
69: #define MATSCATTER "scatter"
70: #define MATBLOCKMAT "blockmat"
71: #define MATCOMPOSITE "composite"
72: #define MATFFT "fft"
73: #define MATFFTW "fftw"
74: #define MATSEQCUFFT "seqcufft"
75: #define MATTRANSPOSEMAT "transpose"
76: #define MATSCHURCOMPLEMENT "schurcomplement"
77: #define MATPYTHON "python"
78: #define MATHYPRESTRUCT "hyprestruct"
79: #define MATHYPRESSTRUCT "hypresstruct"
80: #define MATSUBMATRIX "submatrix"
81: #define MATLOCALREF "localref"
82: #define MATNEST "nest"
83: #define MATIJ "ij"
85: /*J
86: MatSolverPackage - String with the name of a PETSc matrix solver type.
88: For example: "petsc" indicates what PETSc provides, "superlu" indicates either
89: SuperLU or SuperLU_Dist etc.
92: Level: beginner
94: .seealso: MatGetFactor(), Mat, MatSetType(), MatType
95: J*/
96: #define MatSolverPackage char*
97: #define MATSOLVERSPOOLES "spooles"
98: #define MATSOLVERSUPERLU "superlu"
99: #define MATSOLVERSUPERLU_DIST "superlu_dist"
100: #define MATSOLVERUMFPACK "umfpack"
101: #define MATSOLVERCHOLMOD "cholmod"
102: #define MATSOLVERESSL "essl"
103: #define MATSOLVERLUSOL "lusol"
104: #define MATSOLVERMUMPS "mumps"
105: #define MATSOLVERPASTIX "pastix"
106: #define MATSOLVERMATLAB "matlab"
107: #define MATSOLVERPETSC "petsc"
108: #define MATSOLVERPLAPACK "plapack"
109: #define MATSOLVERBAS "bas"
111: #define MATSOLVERBSTRM "bstrm"
112: #define MATSOLVERSBSTRM "sbstrm"
114: /*E
115: MatFactorType - indicates what type of factorization is requested
117: Level: beginner
119: Any additions/changes here MUST also be made in include/finclude/petscmat.h
121: .seealso: MatSolverPackage, MatGetFactor()
122: E*/
123: typedef enum {MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC,MAT_FACTOR_ILUDT} MatFactorType;
124: PETSC_EXTERN const char *const MatFactorTypes[];
126: PETSC_EXTERN PetscErrorCode MatGetFactor(Mat,const MatSolverPackage,MatFactorType,Mat*);
127: PETSC_EXTERN PetscErrorCode MatGetFactorAvailable(Mat,const MatSolverPackage,MatFactorType,PetscBool *);
128: PETSC_EXTERN PetscErrorCode MatFactorGetSolverPackage(Mat,const MatSolverPackage*);
129: PETSC_EXTERN PetscErrorCode MatGetFactorType(Mat,MatFactorType*);
131: /* Logging support */
132: #define MAT_FILE_CLASSID 1211216 /* used to indicate matrices in binary files */
133: PETSC_EXTERN PetscClassId MAT_CLASSID;
134: PETSC_EXTERN PetscClassId MAT_FDCOLORING_CLASSID;
135: PETSC_EXTERN PetscClassId MAT_TRANSPOSECOLORING_CLASSID;
136: PETSC_EXTERN PetscClassId MAT_PARTITIONING_CLASSID;
137: PETSC_EXTERN PetscClassId MAT_COARSEN_CLASSID;
138: PETSC_EXTERN PetscClassId MAT_NULLSPACE_CLASSID;
139: PETSC_EXTERN PetscClassId MATMFFD_CLASSID;
141: /*E
142: MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices()
143: or MatGetSubMatrix() are to be reused to store the new matrix values. For MatConvert() is used to indicate
144: that the input matrix is to be replaced with the converted matrix.
146: Level: beginner
148: Any additions/changes here MUST also be made in include/finclude/petscmat.h
150: .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert()
151: E*/
152: typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX} MatReuse;
154: /*E
155: MatGetSubMatrixOption - Indicates if matrices obtained from a call to MatGetSubMatrices()
156: include the matrix values. Currently it is only used by MatGetSeqNonzerostructure().
158: Level: beginner
160: .seealso: MatGetSeqNonzerostructure()
161: E*/
162: typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatGetSubMatrixOption;
164: PETSC_EXTERN PetscErrorCode MatInitializePackage(const char[]);
166: PETSC_EXTERN PetscErrorCode MatCreate(MPI_Comm,Mat*);
167: PETSC_EXTERN PetscErrorCode MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
168: PETSC_EXTERN PetscErrorCode MatSetType(Mat,const MatType);
169: PETSC_EXTERN PetscErrorCode MatSetFromOptions(Mat);
170: PETSC_EXTERN PetscErrorCode MatRegisterAll(const char[]);
171: PETSC_EXTERN PetscErrorCode MatRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat));
172: PETSC_EXTERN PetscErrorCode MatRegisterBaseName(const char[],const char[],const char[]);
173: PETSC_EXTERN PetscErrorCode MatSetOptionsPrefix(Mat,const char[]);
174: PETSC_EXTERN PetscErrorCode MatAppendOptionsPrefix(Mat,const char[]);
175: PETSC_EXTERN PetscErrorCode MatGetOptionsPrefix(Mat,const char*[]);
177: /*MC
178: MatRegisterDynamic - Adds a new matrix type
180: Synopsis:
181: PetscErrorCode MatRegisterDynamic(const char *name,const char *path,const char *name_create,PetscErrorCode (*routine_create)(Mat))
183: Not Collective
185: Input Parameters:
186: + name - name of a new user-defined matrix type
187: . path - path (either absolute or relative) the library containing this solver
188: . name_create - name of routine to create method context
189: - routine_create - routine to create method context
191: Notes:
192: MatRegisterDynamic() may be called multiple times to add several user-defined solvers.
194: If dynamic libraries are used, then the fourth input argument (routine_create)
195: is ignored.
197: Sample usage:
198: .vb
199: MatRegisterDynamic("my_mat",/home/username/my_lib/lib/libO/solaris/mylib.a,
200: "MyMatCreate",MyMatCreate);
201: .ve
203: Then, your solver can be chosen with the procedural interface via
204: $ MatSetType(Mat,"my_mat")
205: or at runtime via the option
206: $ -mat_type my_mat
208: Level: advanced
210: Notes: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
211: If your function is not being put into a shared library then use VecRegister() instead
213: .keywords: Mat, register
215: .seealso: MatRegisterAll(), MatRegisterDestroy()
217: M*/
218: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
219: #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,0)
220: #else
221: #define MatRegisterDynamic(a,b,c,d) MatRegister(a,b,c,d)
222: #endif
224: PETSC_EXTERN PetscBool MatRegisterAllCalled;
225: PETSC_EXTERN PetscFList MatList;
226: PETSC_EXTERN PetscFList MatColoringList;
227: PETSC_EXTERN PetscFList MatPartitioningList;
228: PETSC_EXTERN PetscFList MatCoarsenList;
230: /*E
231: MatStructure - Indicates if the matrix has the same nonzero structure
233: Level: beginner
235: Any additions/changes here MUST also be made in include/finclude/petscmat.h
237: .seealso: MatCopy(), KSPSetOperators(), PCSetOperators()
238: E*/
239: typedef enum {DIFFERENT_NONZERO_PATTERN,SUBSET_NONZERO_PATTERN,SAME_NONZERO_PATTERN,SAME_PRECONDITIONER} MatStructure;
241: PETSC_EXTERN PetscErrorCode MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
242: PETSC_EXTERN PetscErrorCode MatCreateDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
243: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
244: PETSC_EXTERN PetscErrorCode MatCreateAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
245: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
246: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*);
248: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
249: PETSC_EXTERN PetscErrorCode MatCreateBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
250: PETSC_EXTERN PetscErrorCode MatCreateMPIBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat*);
252: PETSC_EXTERN PetscErrorCode MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*);
253: PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
255: PETSC_EXTERN PetscErrorCode MatCreateSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
256: PETSC_EXTERN PetscErrorCode MatCreateMPISBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
257: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
258: PETSC_EXTERN PetscErrorCode MatXAIJSetPreallocation(Mat,PetscInt,const PetscInt*,const PetscInt*,const PetscInt*,const PetscInt*);
260: PETSC_EXTERN PetscErrorCode MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
261: PETSC_EXTERN PetscErrorCode MatCreateAdic(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,void (*)(void),Mat*);
262: PETSC_EXTERN PetscErrorCode MatCreateNormal(Mat,Mat*);
263: PETSC_EXTERN PetscErrorCode MatCreateLRC(Mat,Mat,Mat,Mat*);
264: PETSC_EXTERN PetscErrorCode MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,Mat*);
265: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
266: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
268: PETSC_EXTERN PetscErrorCode MatCreateSeqBSTRM(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
269: PETSC_EXTERN PetscErrorCode MatCreateMPIBSTRM(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
270: PETSC_EXTERN PetscErrorCode MatCreateSeqSBSTRM(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
271: PETSC_EXTERN PetscErrorCode MatCreateMPISBSTRM(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
273: PETSC_EXTERN PetscErrorCode MatCreateScatter(MPI_Comm,VecScatter,Mat*);
274: PETSC_EXTERN PetscErrorCode MatScatterSetVecScatter(Mat,VecScatter);
275: PETSC_EXTERN PetscErrorCode MatScatterGetVecScatter(Mat,VecScatter*);
276: PETSC_EXTERN PetscErrorCode MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*);
277: PETSC_EXTERN PetscErrorCode MatCompositeAddMat(Mat,Mat);
278: PETSC_EXTERN PetscErrorCode MatCompositeMerge(Mat);
279: PETSC_EXTERN PetscErrorCode MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*);
280: typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType;
281: PETSC_EXTERN PetscErrorCode MatCompositeSetType(Mat,MatCompositeType);
283: PETSC_EXTERN PetscErrorCode MatCreateFFT(MPI_Comm,PetscInt,const PetscInt[],const MatType,Mat*);
284: PETSC_EXTERN PetscErrorCode MatCreateSeqCUFFT(MPI_Comm,PetscInt,const PetscInt[],Mat*);
286: PETSC_EXTERN PetscErrorCode MatCreateTranspose(Mat,Mat*);
287: PETSC_EXTERN PetscErrorCode MatCreateSubMatrix(Mat,IS,IS,Mat*);
288: PETSC_EXTERN PetscErrorCode MatSubMatrixUpdate(Mat,Mat,IS,IS);
289: PETSC_EXTERN PetscErrorCode MatCreateLocalRef(Mat,IS,IS,Mat*);
291: PETSC_EXTERN PetscErrorCode MatPythonSetType(Mat,const char[]);
293: PETSC_EXTERN PetscErrorCode MatSetUp(Mat);
294: PETSC_EXTERN PetscErrorCode MatDestroy(Mat*);
296: PETSC_EXTERN PetscErrorCode MatConjugate(Mat);
297: PETSC_EXTERN PetscErrorCode MatRealPart(Mat);
298: PETSC_EXTERN PetscErrorCode MatImaginaryPart(Mat);
299: PETSC_EXTERN PetscErrorCode MatGetDiagonalBlock(Mat,Mat*);
300: PETSC_EXTERN PetscErrorCode MatGetTrace(Mat,PetscScalar*);
301: PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonal(Mat,const PetscScalar **);
303: /* ------------------------------------------------------------*/
304: PETSC_EXTERN PetscErrorCode MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
305: PETSC_EXTERN PetscErrorCode MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
306: PETSC_EXTERN PetscErrorCode MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
307: PETSC_EXTERN PetscErrorCode MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);
308: PETSC_EXTERN PetscErrorCode MatSetValuesBatch(Mat,PetscInt,PetscInt,PetscInt[],const PetscScalar[]);
310: /*S
311: MatStencil - Data structure (C struct) for storing information about a single row or
312: column of a matrix as indexed on an associated grid.
314: Fortran usage is different, see MatSetValuesStencil() for details.
316: Level: beginner
318: Concepts: matrix; linear operator
320: .seealso: MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockedStencil()
321: S*/
322: typedef struct {
323: PetscInt k,j,i,c;
324: } MatStencil;
326: PETSC_EXTERN PetscErrorCode MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
327: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
328: PETSC_EXTERN PetscErrorCode MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);
330: PETSC_EXTERN PetscErrorCode MatSetColoring(Mat,ISColoring);
331: PETSC_EXTERN PetscErrorCode MatSetValuesAdic(Mat,void*);
332: PETSC_EXTERN PetscErrorCode MatSetValuesAdifor(Mat,PetscInt,void*);
334: /*E
335: MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
336: to continue to add values to it
338: Level: beginner
340: .seealso: MatAssemblyBegin(), MatAssemblyEnd()
341: E*/
342: typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
343: PETSC_EXTERN PetscErrorCode MatAssemblyBegin(Mat,MatAssemblyType);
344: PETSC_EXTERN PetscErrorCode MatAssemblyEnd(Mat,MatAssemblyType);
345: PETSC_EXTERN PetscErrorCode MatAssembled(Mat,PetscBool *);
349: /*E
350: MatOption - Options that may be set for a matrix and its behavior or storage
352: Level: beginner
354: Any additions/changes here MUST also be made in include/finclude/petscmat.h
356: .seealso: MatSetOption()
357: E*/
358: typedef enum {MAT_ROW_ORIENTED,MAT_NEW_NONZERO_LOCATIONS,
359: MAT_SYMMETRIC,
360: MAT_STRUCTURALLY_SYMMETRIC,
361: MAT_NEW_DIAGONALS,MAT_IGNORE_OFF_PROC_ENTRIES,
362: MAT_NEW_NONZERO_LOCATION_ERR,
363: MAT_NEW_NONZERO_ALLOCATION_ERR,MAT_USE_HASH_TABLE,
364: MAT_KEEP_NONZERO_PATTERN,MAT_IGNORE_ZERO_ENTRIES,
365: MAT_USE_INODES,
366: MAT_HERMITIAN,
367: MAT_SYMMETRY_ETERNAL,
368: MAT_CHECK_COMPRESSED_ROW,
369: MAT_IGNORE_LOWER_TRIANGULAR,MAT_ERROR_LOWER_TRIANGULAR,
370: MAT_GETROW_UPPERTRIANGULAR,MAT_UNUSED_NONZERO_LOCATION_ERR,
371: MAT_SPD,MAT_NO_OFF_PROC_ENTRIES,MAT_NO_OFF_PROC_ZERO_ROWS,
372: NUM_MAT_OPTIONS} MatOption;
373: PETSC_EXTERN const char *MatOptions[];
374: PETSC_EXTERN PetscErrorCode MatSetOption(Mat,MatOption,PetscBool );
375: PETSC_EXTERN PetscErrorCode MatGetType(Mat,const MatType*);
377: PETSC_EXTERN PetscErrorCode MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
378: PETSC_EXTERN PetscErrorCode MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
379: PETSC_EXTERN PetscErrorCode MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
380: PETSC_EXTERN PetscErrorCode MatGetRowUpperTriangular(Mat);
381: PETSC_EXTERN PetscErrorCode MatRestoreRowUpperTriangular(Mat);
382: PETSC_EXTERN PetscErrorCode MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
383: PETSC_EXTERN PetscErrorCode MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
384: PETSC_EXTERN PetscErrorCode MatGetColumnVector(Mat,Vec,PetscInt);
385: PETSC_EXTERN PetscErrorCode MatGetArray(Mat,PetscScalar *[]);
386: PETSC_EXTERN PetscErrorCode MatRestoreArray(Mat,PetscScalar *[]);
387: PETSC_EXTERN PetscErrorCode MatGetBlockSize(Mat,PetscInt *);
388: PETSC_EXTERN PetscErrorCode MatSetBlockSize(Mat,PetscInt);
389: PETSC_EXTERN PetscErrorCode MatGetBlockSizes(Mat,PetscInt *,PetscInt *);
390: PETSC_EXTERN PetscErrorCode MatSetBlockSizes(Mat,PetscInt,PetscInt);
391: PETSC_EXTERN PetscErrorCode MatSetNThreads(Mat,PetscInt);
392: PETSC_EXTERN PetscErrorCode MatGetNThreads(Mat,PetscInt*);
394: PETSC_EXTERN PetscErrorCode MatMult(Mat,Vec,Vec);
395: PETSC_EXTERN PetscErrorCode MatMultDiagonalBlock(Mat,Vec,Vec);
396: PETSC_EXTERN PetscErrorCode MatMultAdd(Mat,Vec,Vec,Vec);
397: PETSC_EXTERN PetscErrorCode MatMultTranspose(Mat,Vec,Vec);
398: PETSC_EXTERN PetscErrorCode MatMultHermitianTranspose(Mat,Vec,Vec);
399: PETSC_EXTERN PetscErrorCode MatIsTranspose(Mat,Mat,PetscReal,PetscBool *);
400: PETSC_EXTERN PetscErrorCode MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscBool *);
401: PETSC_EXTERN PetscErrorCode MatMultTransposeAdd(Mat,Vec,Vec,Vec);
402: PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec);
403: PETSC_EXTERN PetscErrorCode MatMultConstrained(Mat,Vec,Vec);
404: PETSC_EXTERN PetscErrorCode MatMultTransposeConstrained(Mat,Vec,Vec);
405: PETSC_EXTERN PetscErrorCode MatMatSolve(Mat,Mat,Mat);
407: /*E
408: MatDuplicateOption - Indicates if a duplicated sparse matrix should have
409: its numerical values copied over or just its nonzero structure.
411: Level: beginner
413: Any additions/changes here MUST also be made in include/finclude/petscmat.h
415: $ MAT_SHARE_NONZERO_PATTERN - the i and j arrays in the new matrix will be shared with the original matrix
416: $ this also triggers the MAT_DO_NOT_COPY_VALUES option. This is used when you
417: $ have several matrices with the same nonzero pattern.
419: .seealso: MatDuplicate()
420: E*/
421: typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption;
423: PETSC_EXTERN PetscErrorCode MatConvert(Mat,const MatType,MatReuse,Mat*);
424: PETSC_EXTERN PetscErrorCode MatDuplicate(Mat,MatDuplicateOption,Mat*);
427: PETSC_EXTERN PetscErrorCode MatCopy(Mat,Mat,MatStructure);
428: PETSC_EXTERN PetscErrorCode MatView(Mat,PetscViewer);
429: PETSC_EXTERN PetscErrorCode MatIsSymmetric(Mat,PetscReal,PetscBool *);
430: PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat,PetscBool *);
431: PETSC_EXTERN PetscErrorCode MatIsHermitian(Mat,PetscReal,PetscBool *);
432: PETSC_EXTERN PetscErrorCode MatIsSymmetricKnown(Mat,PetscBool *,PetscBool *);
433: PETSC_EXTERN PetscErrorCode MatIsHermitianKnown(Mat,PetscBool *,PetscBool *);
434: PETSC_EXTERN PetscErrorCode MatMissingDiagonal(Mat,PetscBool *,PetscInt *);
435: PETSC_EXTERN PetscErrorCode MatLoad(Mat, PetscViewer);
437: PETSC_EXTERN PetscErrorCode MatGetRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,PetscInt *[],PetscInt *[],PetscBool *);
438: PETSC_EXTERN PetscErrorCode MatRestoreRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,PetscInt *[],PetscInt *[],PetscBool *);
439: PETSC_EXTERN PetscErrorCode MatGetColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,PetscInt *[],PetscInt *[],PetscBool *);
440: PETSC_EXTERN PetscErrorCode MatRestoreColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,PetscInt *[],PetscInt *[],PetscBool *);
442: /*S
443: MatInfo - Context of matrix information, used with MatGetInfo()
445: In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE
447: Level: intermediate
449: Concepts: matrix^nonzero information
451: .seealso: MatGetInfo(), MatInfoType
452: S*/
453: typedef struct {
454: PetscLogDouble block_size; /* block size */
455: PetscLogDouble nz_allocated,nz_used,nz_unneeded; /* number of nonzeros */
456: PetscLogDouble memory; /* memory allocated */
457: PetscLogDouble assemblies; /* number of matrix assemblies called */
458: PetscLogDouble mallocs; /* number of mallocs during MatSetValues() */
459: PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
460: PetscLogDouble factor_mallocs; /* number of mallocs during factorization */
461: } MatInfo;
463: /*E
464: MatInfoType - Indicates if you want information about the local part of the matrix,
465: the entire parallel matrix or the maximum over all the local parts.
467: Level: beginner
469: Any additions/changes here MUST also be made in include/finclude/petscmat.h
471: .seealso: MatGetInfo(), MatInfo
472: E*/
473: typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
474: PETSC_EXTERN PetscErrorCode MatGetInfo(Mat,MatInfoType,MatInfo*);
475: PETSC_EXTERN PetscErrorCode MatGetDiagonal(Mat,Vec);
476: PETSC_EXTERN PetscErrorCode MatGetRowMax(Mat,Vec,PetscInt[]);
477: PETSC_EXTERN PetscErrorCode MatGetRowMin(Mat,Vec,PetscInt[]);
478: PETSC_EXTERN PetscErrorCode MatGetRowMaxAbs(Mat,Vec,PetscInt[]);
479: PETSC_EXTERN PetscErrorCode MatGetRowMinAbs(Mat,Vec,PetscInt[]);
480: PETSC_EXTERN PetscErrorCode MatGetRowSum(Mat,Vec);
481: PETSC_EXTERN PetscErrorCode MatTranspose(Mat,MatReuse,Mat*);
482: PETSC_EXTERN PetscErrorCode MatHermitianTranspose(Mat,MatReuse,Mat*);
483: PETSC_EXTERN PetscErrorCode MatPermute(Mat,IS,IS,Mat *);
484: PETSC_EXTERN PetscErrorCode MatDiagonalScale(Mat,Vec,Vec);
485: PETSC_EXTERN PetscErrorCode MatDiagonalSet(Mat,Vec,InsertMode);
486: PETSC_EXTERN PetscErrorCode MatEqual(Mat,Mat,PetscBool *);
487: PETSC_EXTERN PetscErrorCode MatMultEqual(Mat,Mat,PetscInt,PetscBool *);
488: PETSC_EXTERN PetscErrorCode MatMultAddEqual(Mat,Mat,PetscInt,PetscBool *);
489: PETSC_EXTERN PetscErrorCode MatMultTransposeEqual(Mat,Mat,PetscInt,PetscBool *);
490: PETSC_EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscBool *);
492: PETSC_EXTERN PetscErrorCode MatNorm(Mat,NormType,PetscReal *);
493: PETSC_EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal *);
494: PETSC_EXTERN PetscErrorCode MatZeroEntries(Mat);
495: PETSC_EXTERN PetscErrorCode MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
496: PETSC_EXTERN PetscErrorCode MatZeroRowsIS(Mat,IS,PetscScalar,Vec,Vec);
497: PETSC_EXTERN PetscErrorCode MatZeroRowsStencil(Mat,PetscInt,const MatStencil [],PetscScalar,Vec,Vec);
498: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsStencil(Mat,PetscInt,const MatStencil[],PetscScalar,Vec,Vec);
499: PETSC_EXTERN PetscErrorCode MatZeroRowsColumns(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
500: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsIS(Mat,IS,PetscScalar,Vec,Vec);
502: PETSC_EXTERN PetscErrorCode MatGetSize(Mat,PetscInt*,PetscInt*);
503: PETSC_EXTERN PetscErrorCode MatGetLocalSize(Mat,PetscInt*,PetscInt*);
504: PETSC_EXTERN PetscErrorCode MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
505: PETSC_EXTERN PetscErrorCode MatGetOwnershipRanges(Mat,const PetscInt**);
506: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*);
507: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat,const PetscInt**);
509: PETSC_EXTERN PetscErrorCode MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
510: PETSC_EXTERN PetscErrorCode MatGetSubMatricesParallel(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
511: PETSC_EXTERN PetscErrorCode MatDestroyMatrices(PetscInt,Mat *[]);
512: PETSC_EXTERN PetscErrorCode MatGetSubMatrix(Mat,IS,IS,MatReuse,Mat *);
513: PETSC_EXTERN PetscErrorCode MatGetLocalSubMatrix(Mat,IS,IS,Mat*);
514: PETSC_EXTERN PetscErrorCode MatRestoreLocalSubMatrix(Mat,IS,IS,Mat*);
515: PETSC_EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat,Mat*);
516: PETSC_EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat*);
518: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJConcatenateSeqAIJ(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
519: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJConcatenateSeqAIJSymbolic(MPI_Comm,Mat,PetscInt,Mat*);
520: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJConcatenateSeqAIJNumeric(MPI_Comm,Mat,PetscInt,Mat);
521: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJ(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
522: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJSymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
523: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJNumeric(Mat,Mat);
524: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMat(Mat,MatReuse,Mat*);
525: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
526: PETSC_EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,Mat*);
527: #if defined (PETSC_USE_CTABLE)
528: PETSC_EXTERN PetscErrorCode MatGetCommunicationStructs(Mat, Vec *, PetscTable *, VecScatter *);
529: #else
530: PETSC_EXTERN PetscErrorCode MatGetCommunicationStructs(Mat, Vec *, PetscInt *[], VecScatter *);
531: #endif
532: PETSC_EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *,const PetscInt *[]);
534: PETSC_EXTERN PetscErrorCode MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
536: PETSC_EXTERN PetscErrorCode MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
537: PETSC_EXTERN PetscErrorCode MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
538: PETSC_EXTERN PetscErrorCode MatMatMultNumeric(Mat,Mat,Mat);
540: PETSC_EXTERN PetscErrorCode MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
541: PETSC_EXTERN PetscErrorCode MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
542: PETSC_EXTERN PetscErrorCode MatPtAPNumeric(Mat,Mat,Mat);
543: PETSC_EXTERN PetscErrorCode MatRARt(Mat,Mat,MatReuse,PetscReal,Mat*);
544: PETSC_EXTERN PetscErrorCode MatRARtSymbolic(Mat,Mat,PetscReal,Mat*);
545: PETSC_EXTERN PetscErrorCode MatRARtNumeric(Mat,Mat,Mat);
547: PETSC_EXTERN PetscErrorCode MatTransposeMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
548: PETSC_EXTERN PetscErrorCode MatTransposetMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
549: PETSC_EXTERN PetscErrorCode MatTransposetMatMultNumeric(Mat,Mat,Mat);
550: PETSC_EXTERN PetscErrorCode MatMatTransposeMult(Mat,Mat,MatReuse,PetscReal,Mat*);
551: PETSC_EXTERN PetscErrorCode MatMatTransposeMultSymbolic(Mat,Mat,PetscReal,Mat*);
552: PETSC_EXTERN PetscErrorCode MatMatTransposeMultNumeric(Mat,Mat,Mat);
554: PETSC_EXTERN PetscErrorCode MatAXPY(Mat,PetscScalar,Mat,MatStructure);
555: PETSC_EXTERN PetscErrorCode MatAYPX(Mat,PetscScalar,Mat,MatStructure);
557: PETSC_EXTERN PetscErrorCode MatScale(Mat,PetscScalar);
558: PETSC_EXTERN PetscErrorCode MatShift(Mat,PetscScalar);
560: PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping);
561: PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping);
562: PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*);
563: PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*);
564: PETSC_EXTERN PetscErrorCode MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
565: PETSC_EXTERN PetscErrorCode MatZeroRowsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
566: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
567: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
568: PETSC_EXTERN PetscErrorCode MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
569: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
571: PETSC_EXTERN PetscErrorCode MatStashSetInitialSize(Mat,PetscInt,PetscInt);
572: PETSC_EXTERN PetscErrorCode MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);
574: PETSC_EXTERN PetscErrorCode MatInterpolate(Mat,Vec,Vec);
575: PETSC_EXTERN PetscErrorCode MatInterpolateAdd(Mat,Vec,Vec,Vec);
576: PETSC_EXTERN PetscErrorCode MatRestrict(Mat,Vec,Vec);
577: PETSC_EXTERN PetscErrorCode MatGetVecs(Mat,Vec*,Vec*);
578: PETSC_EXTERN PetscErrorCode MatGetRedundantMatrix(Mat,PetscInt,MPI_Comm,PetscInt,MatReuse,Mat*);
579: PETSC_EXTERN PetscErrorCode MatGetMultiProcBlock(Mat,MPI_Comm,MatReuse,Mat*);
580: PETSC_EXTERN PetscErrorCode MatFindZeroDiagonals(Mat,IS*);
582: /*MC
583: MatSetValue - Set a single entry into a matrix.
585: Not collective
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
594: Notes:
595: For efficiency one should use MatSetValues() and set several or many
596: values simultaneously if possible.
598: Level: beginner
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);}
604: PETSC_STATIC_INLINE PetscErrorCode MatGetValue(Mat v,PetscInt i,PetscInt j,PetscScalar *va) {return MatGetValues(v,1,&i,1,&j,va);}
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);}
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.
612: Synopsis:
613: PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)
615: Collective on MPI_Comm
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
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
627: Level: intermediate
629: Notes:
630: See the <A href="../../docs/manual.pdf#nameddest=Chapter 11 Hints for Performance Tuning">Hints for Performance Improvment</A> chapter in the users manual for more details.
632: Do not malloc or free dnz and onz, that is handled internally by these routines
634: Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices)
636: This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().
638: Concepts: preallocation^Matrix
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_PetscMalloc2(__nrows,PetscInt,&dnz,__nrows,PetscInt,&onz);CHKERRQ(_4_ierr); \
647: _4_PetscMemzero(dnz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr);\
648: _4_PetscMemzero(onz,__nrows*sizeof(PetscInt));CHKERRQ(_4_ierr); __start = 0; __end = __start; \
649: _4_MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\
650: _4_MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;
652: /*MC
653: MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
654: inserted using a local number of the rows and columns
656: Synopsis:
657: PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
659: Not Collective
661: Input Parameters:
662: + map - the row mapping from local numbering to global numbering
663: . nrows - the number of rows indicated
664: . rows - the indices of the rows
665: . cmap - the column mapping from local to global numbering
666: . ncols - the number of columns in the matrix
667: . cols - the columns indicated
668: . dnz - the array that will be passed to the matrix preallocation routines
669: - ozn - the other array passed to the matrix preallocation routines
672: Level: intermediate
674: Notes:
675: See the <A href="../../docs/manual.pdf#nameddest=Chapter 11 Hints for Performance Tuning">Hints for Performance Improvment</A> chapter in the users manual for more details.
677: Do not malloc or free dnz and onz, that is handled internally by these routines
679: Concepts: preallocation^Matrix
681: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
682: MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
683: M*/
684: #define MatPreallocateSetLocal(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
685: {\
686: PetscInt __l;\
687: _4_ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
688: _4_ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
689: for (__l=0;__l<nrows;__l++) {\
690: _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
691: }\
692: }
693:
694: /*MC
695: MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
696: inserted using a local number of the rows and columns
698: Synopsis:
699: PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
701: Not Collective
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
713: Level: intermediate
715: Notes:
716: See the <A href="../../docs/manual.pdf#nameddest=Chapter 11 Hints for Performance Tuning">Hints for Performance Improvment</A> chapter in the users manual for more details.
718: Do not malloc or free dnz and onz that is handled internally by these routines
720: Concepts: preallocation^Matrix
722: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
723: MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
724: M*/
725: #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
726: {\
727: PetscInt __l;\
728: _4_ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
729: _4_ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
730: for (__l=0;__l<nrows;__l++) {\
731: _4_MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
732: }\
733: }
735: /*MC
736: MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
737: inserted using a local number of the rows and columns
739: Synopsis:
740: PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
742: Not Collective
744: Input Parameters:
745: + row - the row
746: . ncols - the number of columns in the matrix
747: - cols - the columns indicated
749: Output Parameters:
750: + dnz - the array that will be passed to the matrix preallocation routines
751: - ozn - the other array passed to the matrix preallocation routines
754: Level: intermediate
756: Notes:
757: See the <A href="../../docs/manual.pdf#nameddest=Chapter 11 Hints for Performance Tuning">Hints for Performance Improvment</A> chapter in the users manual for more details.
759: Do not malloc or free dnz and onz that is handled internally by these routines
761: This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
763: Concepts: preallocation^Matrix
765: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
766: MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
767: M*/
768: #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
769: { PetscInt __i; \
770: if (row < __rstart) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D less than first local row %D",row,__rstart);\
771: if (row >= __rstart+__nrows) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to set preallocation for row %D greater than last local row %D",row,__rstart+__nrows-1);\
772: for (__i=0; __i<nc; __i++) {\
773: if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
774: else dnz[row - __rstart]++;\
775: }\
776: }
778: /*MC
779: MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
780: inserted using a local number of the rows and columns
782: Synopsis:
783: PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)
785: Not Collective
787: Input Parameters:
788: + nrows - the number of rows indicated
789: . rows - the indices of the rows
790: . ncols - the number of columns in the matrix
791: . cols - the columns indicated
792: . dnz - the array that will be passed to the matrix preallocation routines
793: - ozn - the other array passed to the matrix preallocation routines
796: Level: intermediate
798: Notes:
799: See the <A href="../../docs/manual.pdf#nameddest=Chapter 11 Hints for Performance Tuning">Hints for Performance Improvment</A> chapter in the users manual for more details.
801: Do not malloc or free dnz and onz that is handled internally by these routines
803: This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().
805: Concepts: preallocation^Matrix
807: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
808: MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
809: M*/
810: #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\
811: { PetscInt __i; \
812: for (__i=0; __i<nc; __i++) {\
813: if (cols[__i] >= __end) onz[row - __rstart]++; \
814: else if (cols[__i] >= row) dnz[row - __rstart]++;\
815: }\
816: }
818: /*MC
819: MatPreallocateLocation - An alternative to MatPreallocationSet() that puts the nonzero locations into the matrix if it exists
821: Synopsis:
822: PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)
824: Not Collective
826: Input Parameters:
827: . A - matrix
828: . row - row where values exist (must be local to this process)
829: . ncols - number of columns
830: . cols - columns with nonzeros
831: . dnz - the array that will be passed to the matrix preallocation routines
832: - ozn - the other array passed to the matrix preallocation routines
835: Level: intermediate
837: Notes:
838: See the <A href="../../docs/manual.pdf#nameddest=Chapter 11 Hints for Performance Tuning">Hints for Performance Improvment</A> chapter in the users manual for more details.
840: Do not malloc or free dnz and onz that is handled internally by these routines
842: This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines.
844: Concepts: preallocation^Matrix
846: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
847: MatPreallocateSymmetricSetLocal()
848: M*/
849: #define MatPreallocateLocation(A,row,ncols,cols,dnz,onz) 0;if (A) {MatSetValues(A,1,&row,ncols,cols,PETSC_NULL,INSERT_VALUES);} else { MatPreallocateSet(row,ncols,cols,dnz,onz);}
852: /*MC
853: MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per
854: row in a matrix providing the data that one can use to correctly preallocate the matrix.
856: Synopsis:
857: PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)
859: Collective on MPI_Comm
861: Input Parameters:
862: + dnz - the array that was be passed to the matrix preallocation routines
863: - ozn - the other array passed to the matrix preallocation routines
866: Level: intermediate
868: Notes:
869: See the <A href="../../docs/manual.pdf#nameddest=Chapter 11 Hints for Performance Tuning">Hints for Performance Improvment</A> chapter in the users manual for more details.
871: Do not malloc or free dnz and onz that is handled internally by these routines
873: This is a MACRO not a function because it closes the { started in MatPreallocateInitialize().
875: Concepts: preallocation^Matrix
877: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
878: MatPreallocateSymmetricSetLocal()
879: M*/
880: #define MatPreallocateFinalize(dnz,onz) 0;_4_PetscFree2(dnz,onz);CHKERRQ(_4_ierr);}
884: /* Routines unique to particular data structures */
885: PETSC_EXTERN PetscErrorCode MatShellGetContext(Mat,void *);
887: PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*);
888: PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);
890: PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
891: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
892: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
893: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
894: PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
895: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*,PetscInt,PetscBool);
897: #define MAT_SKIP_ALLOCATION -4
899: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
900: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
901: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
903: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
904: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
905: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
906: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
907: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
908: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
909: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
910: PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
911: PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
912: PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
913: PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,PetscInt*[]);
914: PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,PetscInt*[]);
915: PETSC_EXTERN PetscErrorCode MatAdicSetLocalFunction(Mat,void (*)(void));
916: PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat,Mat*);
918: PETSC_EXTERN PetscErrorCode MatSeqDenseSetLDA(Mat,PetscInt);
919: PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*);
921: PETSC_EXTERN PetscErrorCode MatStoreValues(Mat);
922: PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat);
924: PETSC_EXTERN PetscErrorCode MatDAADSetCtx(Mat,void*);
926: PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat,IS*);
927: /*
928: These routines are not usually accessed directly, rather solving is
929: done through the KSP and PC interfaces.
930: */
932: /*J
933: MatOrderingType - String with the name of a PETSc matrix ordering or the creation function
934: with an optional dynamic library name, for example
935: http://www.mcs.anl.gov/petsc/lib.a:orderingcreate()
937: Level: beginner
939: Cannot use const because the PC objects manipulate the string
941: .seealso: MatGetOrdering()
942: J*/
943: #define MatOrderingType char*
944: #define MATORDERINGNATURAL "natural"
945: #define MATORDERINGND "nd"
946: #define MATORDERING1WD "1wd"
947: #define MATORDERINGRCM "rcm"
948: #define MATORDERINGQMD "qmd"
949: #define MATORDERINGROWLENGTH "rowlength"
950: #define MATORDERINGAMD "amd" /* only works if UMFPACK is installed with PETSc */
952: PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat,const MatOrderingType,IS*,IS*);
953: PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFList *list);
954: PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,const MatOrderingType,IS*,IS*));
956: /*MC
957: MatOrderingRegisterDynamic - Adds a new sparse matrix ordering to the matrix package.
959: Synopsis:
960: PetscErrorCode MatOrderingRegisterDynamic(const char *name_ordering,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatOrdering))
962: Not Collective
964: Input Parameters:
965: + sname - name of ordering (for example MATORDERINGND)
966: . path - location of library where creation routine is
967: . name - name of function that creates the ordering type,a string
968: - function - function pointer that creates the ordering
970: Level: developer
972: If dynamic libraries are used, then the fourth input argument (function)
973: is ignored.
975: Sample usage:
976: .vb
977: MatOrderingRegisterDynamic("my_order",/home/username/my_lib/lib/libO/solaris/mylib.a,
978: "MyOrder",MyOrder);
979: .ve
981: Then, your partitioner can be chosen with the procedural interface via
982: $ MatOrderingSetType(part,"my_order)
983: or at runtime via the option
984: $ -pc_factor_mat_ordering_type my_order
986: ${PETSC_ARCH} occuring in pathname will be replaced with appropriate values.
988: .keywords: matrix, ordering, register
990: .seealso: MatOrderingRegisterDestroy(), MatOrderingRegisterAll()
991: M*/
992: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
993: #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,0)
994: #else
995: #define MatOrderingRegisterDynamic(a,b,c,d) MatOrderingRegister(a,b,c,d)
996: #endif
998: PETSC_EXTERN PetscErrorCode MatOrderingRegisterDestroy(void);
999: PETSC_EXTERN PetscErrorCode MatOrderingRegisterAll(const char[]);
1000: PETSC_EXTERN PetscBool MatOrderingRegisterAllCalled;
1001: PETSC_EXTERN PetscFList MatOrderingList;
1003: PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
1005: /*S
1006: MatFactorShiftType - Numeric Shift.
1008: Level: beginner
1010: S*/
1011: typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType;
1012: PETSC_EXTERN const char *MatFactorShiftTypes[];
1014: /*S
1015: MatFactorInfo - Data passed into the matrix factorization routines
1017: In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use
1018: $ MatFactorInfo info(MAT_FACTORINFO_SIZE)
1020: Notes: These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC.
1022: You can use MatFactorInfoInitialize() to set default values.
1024: Level: developer
1026: .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
1027: MatFactorInfoInitialize()
1029: S*/
1030: typedef struct {
1031: PetscReal diagonal_fill; /* force diagonal to fill in if initially not filled */
1032: PetscReal usedt;
1033: PetscReal dt; /* drop tolerance */
1034: PetscReal dtcol; /* tolerance for pivoting */
1035: PetscReal dtcount; /* maximum nonzeros to be allowed per row */
1036: PetscReal fill; /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1037: PetscReal levels; /* ICC/ILU(levels) */
1038: PetscReal pivotinblocks; /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1039: factorization may be faster if do not pivot */
1040: PetscReal zeropivot; /* pivot is called zero if less than this */
1041: PetscReal shifttype; /* type of shift added to matrix factor to prevent zero pivots */
1042: PetscReal shiftamount; /* how large the shift is */
1043: } MatFactorInfo;
1045: PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*);
1046: PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*);
1047: PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1048: PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*);
1049: PETSC_EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*);
1050: PETSC_EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*);
1051: PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1052: PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1053: PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1054: PETSC_EXTERN PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*);
1055: PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*);
1056: PETSC_EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1057: PETSC_EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec);
1058: PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec);
1059: PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec);
1060: PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec);
1061: PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec);
1062: PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1063: PETSC_EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs);
1065: PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat);
1067: /*E
1068: MatSORType - What type of (S)SOR to perform
1070: Level: beginner
1072: May be bitwise ORd together
1074: Any additions/changes here MUST also be made in include/finclude/petscmat.h
1076: MatSORType may be bitwise ORd together, so do not change the numbers
1078: .seealso: MatSOR()
1079: E*/
1080: typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1081: SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1082: SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
1083: SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1084: PETSC_EXTERN PetscErrorCode MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);
1086: /*
1087: These routines are for efficiently computing Jacobians via finite differences.
1088: */
1090: /*J
1091: MatColoringType - String with the name of a PETSc matrix coloring or the creation function
1092: with an optional dynamic library name, for example
1093: http://www.mcs.anl.gov/petsc/lib.a:coloringcreate()
1095: Level: beginner
1097: .seealso: MatGetColoring()
1098: J*/
1099: #define MatColoringType char*
1100: #define MATCOLORINGNATURAL "natural"
1101: #define MATCOLORINGSL "sl"
1102: #define MATCOLORINGLF "lf"
1103: #define MATCOLORINGID "id"
1105: PETSC_EXTERN PetscErrorCode MatGetColoring(Mat,const MatColoringType,ISColoring*);
1106: PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[],const char[],const char[],PetscErrorCode(*)(Mat,MatColoringType,ISColoring *));
1108: /*MC
1109: MatColoringRegisterDynamic - Adds a new sparse matrix coloring to the
1110: matrix package.
1112: Synopsis:
1113: PetscErrorCode MatColoringRegisterDynamic(const char *name_coloring,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatColoring))
1115: Not Collective
1117: Input Parameters:
1118: + sname - name of Coloring (for example MATCOLORINGSL)
1119: . path - location of library where creation routine is
1120: . name - name of function that creates the Coloring type, a string
1121: - function - function pointer that creates the coloring
1123: Level: developer
1125: If dynamic libraries are used, then the fourth input argument (function)
1126: is ignored.
1128: Sample usage:
1129: .vb
1130: MatColoringRegisterDynamic("my_color",/home/username/my_lib/lib/libO/solaris/mylib.a,
1131: "MyColor",MyColor);
1132: .ve
1134: Then, your partitioner can be chosen with the procedural interface via
1135: $ MatColoringSetType(part,"my_color")
1136: or at runtime via the option
1137: $ -mat_coloring_type my_color
1139: $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
1141: .keywords: matrix, Coloring, register
1143: .seealso: MatColoringRegisterDestroy(), MatColoringRegisterAll()
1144: M*/
1145: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1146: #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,0)
1147: #else
1148: #define MatColoringRegisterDynamic(a,b,c,d) MatColoringRegister(a,b,c,d)
1149: #endif
1151: PETSC_EXTERN PetscBool MatColoringRegisterAllCalled;
1153: PETSC_EXTERN PetscErrorCode MatColoringRegisterAll(const char[]);
1154: PETSC_EXTERN PetscErrorCode MatColoringRegisterDestroy(void);
1155: PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1157: /*S
1158: MatFDColoring - Object for computing a sparse Jacobian via finite differences
1159: and coloring
1161: Level: beginner
1163: Concepts: coloring, sparse Jacobian, finite differences
1165: .seealso: MatFDColoringCreate()
1166: S*/
1167: typedef struct _p_MatFDColoring* MatFDColoring;
1169: PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1170: PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring*);
1171: PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer);
1172: PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
1173: PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1174: PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1175: PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring);
1176: PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,MatStructure*,void *);
1177: PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec);
1178: PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]);
1180: /*S
1181: MatTransposeColoring - Object for computing a sparse matrix product C=A*B^T via coloring
1183: Level: beginner
1185: Concepts: coloring, sparse matrix product
1187: .seealso: MatTransposeColoringCreate()
1188: S*/
1189: typedef struct _p_MatTransposeColoring* MatTransposeColoring;
1191: PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat,ISColoring,MatTransposeColoring *);
1192: PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring,Mat,Mat);
1193: PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring,Mat,Mat);
1194: PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring*);
1196: /*
1197: These routines are for partitioning matrices: currently used only
1198: for adjacency matrix, MatCreateMPIAdj().
1199: */
1201: /*S
1202: MatPartitioning - Object for managing the partitioning of a matrix or graph
1204: Level: beginner
1206: Concepts: partitioning
1208: .seealso: MatPartitioningCreate(), MatPartitioningType
1209: S*/
1210: typedef struct _p_MatPartitioning* MatPartitioning;
1212: /*J
1213: MatPartitioningType - String with the name of a PETSc matrix partitioning or the creation function
1214: with an optional dynamic library name, for example
1215: http://www.mcs.anl.gov/petsc/lib.a:partitioningcreate()
1217: Level: beginner
1218: dm
1219: .seealso: MatPartitioningCreate(), MatPartitioning
1220: J*/
1221: #define MatPartitioningType char*
1222: #define MATPARTITIONINGCURRENT "current"
1223: #define MATPARTITIONINGSQUARE "square"
1224: #define MATPARTITIONINGPARMETIS "parmetis"
1225: #define MATPARTITIONINGCHACO "chaco"
1226: #define MATPARTITIONINGPARTY "party"
1227: #define MATPARTITIONINGPTSCOTCH "ptscotch"
1230: PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1231: PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,const MatPartitioningType);
1232: PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt);
1233: PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat);
1234: PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1235: PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1236: PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*);
1237: PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning*);
1239: PETSC_EXTERN PetscErrorCode MatPartitioningRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatPartitioning));
1241: /*MC
1242: MatPartitioningRegisterDynamic - Adds a new sparse matrix partitioning to the
1243: matrix package.
1245: Synopsis:
1246: PetscErrorCode MatPartitioningRegisterDynamic(const char *name_partitioning,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatPartitioning))
1248: Not Collective
1250: Input Parameters:
1251: + sname - name of partitioning (for example MATPARTITIONINGCURRENT) or parmetis
1252: . path - location of library where creation routine is
1253: . name - name of function that creates the partitioning type, a string
1254: - function - function pointer that creates the partitioning type
1256: Level: developer
1258: If dynamic libraries are used, then the fourth input argument (function)
1259: is ignored.
1261: Sample usage:
1262: .vb
1263: MatPartitioningRegisterDynamic("my_part",/home/username/my_lib/lib/libO/solaris/mylib.a,
1264: "MyPartCreate",MyPartCreate);
1265: .ve
1267: Then, your partitioner can be chosen with the procedural interface via
1268: $ MatPartitioningSetType(part,"my_part")
1269: or at runtime via the option
1270: $ -mat_partitioning_type my_part
1272: $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
1274: .keywords: matrix, partitioning, register
1276: .seealso: MatPartitioningRegisterDestroy(), MatPartitioningRegisterAll()
1277: M*/
1278: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1279: #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,0)
1280: #else
1281: #define MatPartitioningRegisterDynamic(a,b,c,d) MatPartitioningRegister(a,b,c,d)
1282: #endif
1284: PETSC_EXTERN PetscBool MatPartitioningRegisterAllCalled;
1286: PETSC_EXTERN PetscErrorCode MatPartitioningRegisterAll(const char[]);
1287: PETSC_EXTERN PetscErrorCode MatPartitioningRegisterDestroy(void);
1289: PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer);
1290: PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning);
1291: PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,const MatPartitioningType*);
1293: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
1294: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);
1296: typedef enum { MP_CHACO_MULTILEVEL=1,MP_CHACO_SPECTRAL=2,MP_CHACO_LINEAR=4,MP_CHACO_RANDOM=5,MP_CHACO_SCATTERED=6 } MPChacoGlobalType;
1297: PETSC_EXTERN const char *MPChacoGlobalTypes[];
1298: typedef enum { MP_CHACO_KERNIGHAN=1,MP_CHACO_NONE=2 } MPChacoLocalType;
1299: PETSC_EXTERN const char *MPChacoLocalTypes[];
1300: typedef enum { MP_CHACO_LANCZOS=0,MP_CHACO_RQI=1 } MPChacoEigenType;
1301: PETSC_EXTERN const char *MPChacoEigenTypes[];
1303: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning,MPChacoGlobalType);
1304: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning,MPChacoGlobalType*);
1305: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning,MPChacoLocalType);
1306: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning,MPChacoLocalType*);
1307: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
1308: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1309: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning,MPChacoEigenType*);
1310: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning,PetscReal);
1311: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning,PetscReal*);
1312: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning,PetscInt);
1313: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning,PetscInt*);
1315: #define MP_PARTY_OPT "opt"
1316: #define MP_PARTY_LIN "lin"
1317: #define MP_PARTY_SCA "sca"
1318: #define MP_PARTY_RAN "ran"
1319: #define MP_PARTY_GBF "gbf"
1320: #define MP_PARTY_GCF "gcf"
1321: #define MP_PARTY_BUB "bub"
1322: #define MP_PARTY_DEF "def"
1323: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning,const char*);
1324: #define MP_PARTY_HELPFUL_SETS "hs"
1325: #define MP_PARTY_KERNIGHAN_LIN "kl"
1326: #define MP_PARTY_NONE "no"
1327: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning,const char*);
1328: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1329: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscBool);
1330: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool);
1332: typedef enum { MP_PTSCOTCH_QUALITY,MP_PTSCOTCH_SPEED,MP_PTSCOTCH_BALANCE,MP_PTSCOTCH_SAFETY,MP_PTSCOTCH_SCALABILITY } MPPTScotchStrategyType;
1333: PETSC_EXTERN const char *MPPTScotchStrategyTypes[];
1335: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal);
1336: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*);
1337: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType);
1338: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*);
1340: /*
1341: These routines are for coarsening matrices:
1342: */
1344: /*S
1345: MatCoarsen - Object for managing the coarsening of a graph (symmetric matrix)
1347: Level: beginner
1349: Concepts: coarsen
1351: .seealso: MatCoarsenCreate), MatCoarsenType
1352: S*/
1353: typedef struct _p_MatCoarsen* MatCoarsen;
1355: /*J
1356: MatCoarsenType - String with the name of a PETSc matrix coarsen or the creation function
1357: with an optional dynamic library name, for example
1358: http://www.mcs.anl.gov/petsc/lib.a:coarsencreate()
1360: Level: beginner
1361: dm
1362: .seealso: MatCoarsenCreate(), MatCoarsen
1363: J*/
1364: #define MatCoarsenType char*
1365: #define MATCOARSENMIS "mis"
1366: #define MATCOARSENHEM "hem"
1368: /* linked list for aggregates */
1369: typedef struct _PetscCDIntNd{
1370: struct _PetscCDIntNd *next;
1371: PetscInt gid;
1372: }PetscCDIntNd;
1374: /* only used by node pool */
1375: typedef struct _PetscCDArrNd{
1376: struct _PetscCDArrNd *next;
1377: struct _PetscCDIntNd *array;
1378: }PetscCDArrNd;
1380: typedef struct _PetscCoarsenData{
1381: /* node pool */
1382: PetscCDArrNd pool_list;
1383: PetscCDIntNd *new_node;
1384: PetscInt new_left;
1385: PetscInt chk_sz;
1386: PetscCDIntNd *extra_nodes;
1387: /* Array of lists */
1388: PetscCDIntNd **array;
1389: PetscInt size;
1390: /* cache a Mat for communication data */
1391: Mat mat;
1392: /* cache IS of removed equations */
1393: IS removedIS;
1394: }PetscCoarsenData;
1396: PETSC_EXTERN PetscErrorCode MatCoarsenCreate(MPI_Comm,MatCoarsen*);
1397: PETSC_EXTERN PetscErrorCode MatCoarsenSetType(MatCoarsen,const MatCoarsenType);
1398: PETSC_EXTERN PetscErrorCode MatCoarsenSetAdjacency(MatCoarsen,Mat);
1399: PETSC_EXTERN PetscErrorCode MatCoarsenSetGreedyOrdering(MatCoarsen,const IS);
1400: PETSC_EXTERN PetscErrorCode MatCoarsenSetStrictAggs(MatCoarsen,PetscBool);
1401: PETSC_EXTERN PetscErrorCode MatCoarsenSetVerbose(MatCoarsen,PetscInt);
1402: PETSC_EXTERN PetscErrorCode MatCoarsenGetData( MatCoarsen, PetscCoarsenData ** );
1403: PETSC_EXTERN PetscErrorCode MatCoarsenApply(MatCoarsen);
1404: PETSC_EXTERN PetscErrorCode MatCoarsenDestroy(MatCoarsen*);
1406: PETSC_EXTERN PetscErrorCode MatCoarsenRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatCoarsen));
1408: /*MC
1409: MatCoarsenRegisterDynamic - Adds a new sparse matrix coarsen to the
1410: matrix package.
1412: Synopsis:
1413: PetscErrorCode MatCoarsenRegisterDynamic(const char *name_coarsen,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatCoarsen))
1415: Not Collective
1417: Input Parameters:
1418: + sname - name of coarsen (for example MATCOARSENMIS)
1419: . path - location of library where creation routine is
1420: . name - name of function that creates the coarsen type, a string
1421: - function - function pointer that creates the coarsen type
1423: Level: developer
1425: If dynamic libraries are used, then the fourth input argument (function)
1426: is ignored.
1428: Sample usage:
1429: .vb
1430: MatCoarsenRegisterDynamic("my_agg",/home/username/my_lib/lib/libO/solaris/mylib.a,
1431: "MyAggCreate",MyAggCreate);
1432: .ve
1434: Then, your aggregator can be chosen with the procedural interface via
1435: $ MatCoarsenSetType(agg,"my_agg")
1436: or at runtime via the option
1437: $ -mat_coarsen_type my_agg
1439: $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
1441: .keywords: matrix, coarsen, register
1443: .seealso: MatCoarsenRegisterDestroy(), MatCoarsenRegisterAll()
1444: M*/
1445: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1446: #define MatCoarsenRegisterDynamic(a,b,c,d) MatCoarsenRegister(a,b,c,0)
1447: #else
1448: #define MatCoarsenRegisterDynamic(a,b,c,d) MatCoarsenRegister(a,b,c,d)
1449: #endif
1451: PETSC_EXTERN PetscBool MatCoarsenRegisterAllCalled;
1453: PETSC_EXTERN PetscErrorCode MatCoarsenRegisterAll(const char[]);
1454: PETSC_EXTERN PetscErrorCode MatCoarsenRegisterDestroy(void);
1456: PETSC_EXTERN PetscErrorCode MatCoarsenView(MatCoarsen,PetscViewer);
1457: PETSC_EXTERN PetscErrorCode MatCoarsenSetFromOptions(MatCoarsen);
1458: PETSC_EXTERN PetscErrorCode MatCoarsenGetType(MatCoarsen,const MatCoarsenType*);
1461: PETSC_EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*);
1462: PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*);
1464: /*
1465: If you add entries here you must also add them to finclude/petscmat.h
1466: */
1467: typedef enum { MATOP_SET_VALUES=0,
1468: MATOP_GET_ROW=1,
1469: MATOP_RESTORE_ROW=2,
1470: MATOP_MULT=3,
1471: MATOP_MULT_ADD=4,
1472: MATOP_MULT_TRANSPOSE=5,
1473: MATOP_MULT_TRANSPOSE_ADD=6,
1474: MATOP_SOLVE=7,
1475: MATOP_SOLVE_ADD=8,
1476: MATOP_SOLVE_TRANSPOSE=9,
1477: MATOP_SOLVE_TRANSPOSE_ADD=10,
1478: MATOP_LUFACTOR=11,
1479: MATOP_CHOLESKYFACTOR=12,
1480: MATOP_SOR=13,
1481: MATOP_TRANSPOSE=14,
1482: MATOP_GETINFO=15,
1483: MATOP_EQUAL=16,
1484: MATOP_GET_DIAGONAL=17,
1485: MATOP_DIAGONAL_SCALE=18,
1486: MATOP_NORM=19,
1487: MATOP_ASSEMBLY_BEGIN=20,
1488: MATOP_ASSEMBLY_END=21,
1489: MATOP_SET_OPTION=22,
1490: MATOP_ZERO_ENTRIES=23,
1491: MATOP_ZERO_ROWS=24,
1492: MATOP_LUFACTOR_SYMBOLIC=25,
1493: MATOP_LUFACTOR_NUMERIC=26,
1494: MATOP_CHOLESKY_FACTOR_SYMBOLIC=27,
1495: MATOP_CHOLESKY_FACTOR_NUMERIC=28,
1496: MATOP_SETUP_PREALLOCATION=29,
1497: MATOP_ILUFACTOR_SYMBOLIC=30,
1498: MATOP_ICCFACTOR_SYMBOLIC=31,
1499: MATOP_GET_ARRAY=32,
1500: MATOP_RESTORE_ARRAY=33,
1501: MATOP_DUPLICATE=34,
1502: MATOP_FORWARD_SOLVE=35,
1503: MATOP_BACKWARD_SOLVE=36,
1504: MATOP_ILUFACTOR=37,
1505: MATOP_ICCFACTOR=38,
1506: MATOP_AXPY=39,
1507: MATOP_GET_SUBMATRICES=40,
1508: MATOP_INCREASE_OVERLAP=41,
1509: MATOP_GET_VALUES=42,
1510: MATOP_COPY=43,
1511: MATOP_GET_ROW_MAX=44,
1512: MATOP_SCALE=45,
1513: MATOP_SHIFT=46,
1514: MATOP_DIAGONAL_SET=47,
1515: MATOP_ILUDT_FACTOR=48,
1516: MATOP_SET_BLOCK_SIZE=49,
1517: MATOP_GET_ROW_IJ=50,
1518: MATOP_RESTORE_ROW_IJ=51,
1519: MATOP_GET_COLUMN_IJ=52,
1520: MATOP_RESTORE_COLUMN_IJ=53,
1521: MATOP_FDCOLORING_CREATE=54,
1522: MATOP_COLORING_PATCH=55,
1523: MATOP_SET_UNFACTORED=56,
1524: MATOP_PERMUTE=57,
1525: MATOP_SET_VALUES_BLOCKED=58,
1526: MATOP_GET_SUBMATRIX=59,
1527: MATOP_DESTROY=60,
1528: MATOP_VIEW=61,
1529: MATOP_CONVERT_FROM=62,
1530: MATOP_USE_SCALED_FORM=63,
1531: MATOP_SCALE_SYSTEM=64,
1532: MATOP_UNSCALE_SYSTEM=65,
1533: MATOP_SET_LOCAL_TO_GLOBAL_MAP=66,
1534: MATOP_SET_VALUES_LOCAL=67,
1535: MATOP_ZERO_ROWS_LOCAL=68,
1536: MATOP_GET_ROW_MAX_ABS=69,
1537: MATOP_GET_ROW_MIN_ABS=70,
1538: MATOP_CONVERT=71,
1539: MATOP_SET_COLORING=72,
1540: MATOP_SET_VALUES_ADIC=73,
1541: MATOP_SET_VALUES_ADIFOR=74,
1542: MATOP_FD_COLORING_APPLY=75,
1543: MATOP_SET_FROM_OPTIONS=76,
1544: MATOP_MULT_CON=77,
1545: MATOP_MULT_TRANSPOSE_CON=78,
1546: MATOP_PERMUTE_SPARSIFY=79,
1547: MATOP_MULT_MULTIPLE=80,
1548: MATOP_SOLVE_MULTIPLE=81,
1549: MATOP_GET_INERTIA=82,
1550: MATOP_LOAD=83,
1551: MATOP_IS_SYMMETRIC=84,
1552: MATOP_IS_HERMITIAN=85,
1553: MATOP_IS_STRUCTURALLY_SYMMETRIC=86,
1554: MATOP_DUMMY=87,
1555: MATOP_GET_VECS=88,
1556: MATOP_MAT_MULT=89,
1557: MATOP_MAT_MULT_SYMBOLIC=90,
1558: MATOP_MAT_MULT_NUMERIC=91,
1559: MATOP_PTAP=92,
1560: MATOP_PTAP_SYMBOLIC=93,
1561: MATOP_PTAP_NUMERIC=94,
1562: MATOP_MAT_MULTTRANSPOSE=95,
1563: MATOP_MAT_MULTTRANSPOSE_SYM=96,
1564: MATOP_MAT_MULTTRANSPOSE_NUM=97,
1565: MATOP_PTAP_SYMBOLIC_SEQAIJ=98,
1566: MATOP_PTAP_NUMERIC_SEQAIJ=99,
1567: MATOP_PTAP_SYMBOLIC_MPIAIJ=100,
1568: MATOP_PTAP_NUMERIC_MPIAIJ=101,
1569: MATOP_CONJUGATE=102,
1570: MATOP_SET_SIZES=103,
1571: MATOP_SET_VALUES_ROW=104,
1572: MATOP_REAL_PART=105,
1573: MATOP_IMAG_PART=106,
1574: MATOP_GET_ROW_UTRIANGULAR=107,
1575: MATOP_RESTORE_ROW_UTRIANGULAR=108,
1576: MATOP_MATSOLVE=109,
1577: MATOP_GET_REDUNDANTMATRIX=110,
1578: MATOP_GET_ROW_MIN=111,
1579: MATOP_GET_COLUMN_VEC=112,
1580: MATOP_MISSING_DIAGONAL=113,
1581: MATOP_MATGETSEQNONZEROSTRUCTURE=114,
1582: MATOP_CREATE=115,
1583: MATOP_GET_GHOSTS=116,
1584: MATOP_GET_LOCALSUBMATRIX=117,
1585: MATOP_RESTORE_LOCALSUBMATRIX=118,
1586: MATOP_MULT_DIAGONAL_BLOCK=119,
1587: MATOP_HERMITIANTRANSPOSE=120,
1588: MATOP_MULTHERMITIANTRANSPOSE=121,
1589: MATOP_MULTHERMITIANTRANSPOSEADD=122,
1590: MATOP_GETMULTIPROCBLOCK=123,
1591: MATOP_GETCOLUMNNORMS=125,
1592: MATOP_GET_SUBMATRICES_PARALLEL=128,
1593: MATOP_SET_VALUES_BATCH=129,
1594: MATOP_TRANSPOSEMATMULT=130,
1595: MATOP_TRANSPOSEMATMULT_SYMBOLIC=131,
1596: MATOP_TRANSPOSEMATMULT_NUMERIC=132,
1597: MATOP_TRANSPOSECOLORING_CREATE=133,
1598: MATOP_TRANSCOLORING_APPLY_SPTODEN=134,
1599: MATOP_TRANSCOLORING_APPLY_DENTOSP=135,
1600: MATOP_RARt=136,
1601: MATOP_RARt_SYMBOLIC=137,
1602: MATOP_RARt_NUMERIC=138,
1603: MATOP_SET_BLOCK_SIZES=139
1604: } MatOperation;
1605: PETSC_EXTERN PetscErrorCode MatHasOperation(Mat,MatOperation,PetscBool *);
1606: PETSC_EXTERN PetscErrorCode MatShellSetOperation(Mat,MatOperation,void(*)(void));
1607: PETSC_EXTERN PetscErrorCode MatShellGetOperation(Mat,MatOperation,void(**)(void));
1608: PETSC_EXTERN PetscErrorCode MatShellSetContext(Mat,void*);
1610: /*
1611: Codes for matrices stored on disk. By default they are
1612: stored in a universal format. By changing the format with
1613: PetscViewerSetFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
1614: be stored in a way natural for the matrix, for example dense matrices
1615: would be stored as dense. Matrices stored this way may only be
1616: read into matrices of the same type.
1617: */
1618: #define MATRIX_BINARY_FORMAT_DENSE -1
1620: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1621: PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*);
1622: PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat,Mat);
1624: /*S
1625: MatNullSpace - Object that removes a null space from a vector, i.e.
1626: orthogonalizes the vector to a subsapce
1628: Level: advanced
1630: Concepts: matrix; linear operator, null space
1632: Users manual sections:
1633: . Section 4.16 Solving Singular Systems
1635: .seealso: MatNullSpaceCreate()
1636: S*/
1637: typedef struct _p_MatNullSpace* MatNullSpace;
1639: PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*);
1640: PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*);
1641: PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace*);
1642: PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec,Vec*);
1643: PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *);
1644: PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat,MatNullSpace);
1645: PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat,MatNullSpace);
1646: PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat,MatNullSpace*);
1647: PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscBool *);
1648: PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace,PetscViewer);
1649: PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace,PetscBool*,PetscInt*,const Vec**);
1650: PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec,MatNullSpace*);
1652: PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS);
1653: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1654: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
1655: PETSC_EXTERN PetscErrorCode MatSeqBAIJInvertBlockDiagonal(Mat);
1657: PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*);
1658: PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*);
1659: PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*);
1661: PETSC_EXTERN PetscErrorCode MatComputeExplicitOperator(Mat,Mat*);
1663: PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec);
1665: PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
1666: PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec);
1667: PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
1668: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
1669: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
1670: PETSC_EXTERN PetscErrorCode MatMFFDAddNullSpace(Mat,MatNullSpace);
1671: PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
1672: PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat);
1673: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal);
1674: PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt);
1675: PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat,PetscScalar *);
1676: PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat,const char[]);
1677: PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
1678: PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);
1680: /*S
1681: MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free
1682: Jacobian vector products
1684: Notes: MATMFFD is a specific MatType which uses the MatMFFD data structure
1686: MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure
1688: Level: developer
1690: .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister()
1691: S*/
1692: typedef struct _p_MatMFFD* MatMFFD;
1694: /*J
1695: MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function
1697: Level: beginner
1699: .seealso: MatMFFDSetType(), MatMFFDRegister()
1700: J*/
1701: #define MatMFFDType char*
1702: #define MATMFFD_DS "ds"
1703: #define MATMFFD_WP "wp"
1705: PETSC_EXTERN PetscErrorCode MatMFFDSetType(Mat,const MatMFFDType);
1706: PETSC_EXTERN PetscErrorCode MatMFFDRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatMFFD));
1708: /*MC
1709: MatMFFDRegisterDynamic - Adds a method to the MatMFFD registry.
1711: Synopsis:
1712: PetscErrorCode MatMFFDRegisterDynamic(const char *name_solver,const char *path,const char *name_create,PetscErrorCode (*routine_create)(MatMFFD))
1714: Not Collective
1716: Input Parameters:
1717: + name_solver - name of a new user-defined compute-h module
1718: . path - path (either absolute or relative) the library containing this solver
1719: . name_create - name of routine to create method context
1720: - routine_create - routine to create method context
1722: Level: developer
1724: Notes:
1725: MatMFFDRegisterDynamic() may be called multiple times to add several user-defined solvers.
1727: If dynamic libraries are used, then the fourth input argument (routine_create)
1728: is ignored.
1730: Sample usage:
1731: .vb
1732: MatMFFDRegisterDynamic("my_h",/home/username/my_lib/lib/libO/solaris/mylib.a,
1733: "MyHCreate",MyHCreate);
1734: .ve
1736: Then, your solver can be chosen with the procedural interface via
1737: $ MatMFFDSetType(mfctx,"my_h")
1738: or at runtime via the option
1739: $ -snes_mf_type my_h
1741: .keywords: MatMFFD, register
1743: .seealso: MatMFFDRegisterAll(), MatMFFDRegisterDestroy()
1744: M*/
1745: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
1746: #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,0)
1747: #else
1748: #define MatMFFDRegisterDynamic(a,b,c,d) MatMFFDRegister(a,b,c,d)
1749: #endif
1751: PETSC_EXTERN PetscErrorCode MatMFFDRegisterAll(const char[]);
1752: PETSC_EXTERN PetscErrorCode MatMFFDRegisterDestroy(void);
1753: PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal);
1754: PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscBool );
1757: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1758: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);
1760: /*
1761: PETSc interface to MUMPS
1762: */
1763: #ifdef PETSC_HAVE_MUMPS
1764: PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt);
1765: #endif
1767: /*
1768: PETSc interface to SUPERLU
1769: */
1770: #ifdef PETSC_HAVE_SUPERLU
1771: PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal);
1772: #endif
1774: #if defined(PETSC_HAVE_CUSP)
1775: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSP(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1776: PETSC_EXTERN PetscErrorCode MatCreateAIJCUSP(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1777: #endif
1779: /*
1780: PETSc interface to FFTW
1781: */
1782: #if defined(PETSC_HAVE_FFTW)
1783: PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec);
1784: PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec);
1785: PETSC_EXTERN PetscErrorCode MatGetVecsFFTW(Mat,Vec*,Vec*,Vec*);
1786: #endif
1788: PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*);
1789: PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*);
1790: PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat,IS[],IS[]);
1791: PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat,IS[],IS[]);
1792: PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***);
1793: PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*);
1794: PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat,const VecType);
1795: PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]);
1796: PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat);
1798: /*
1799: MatIJ:
1800: An unweighted directed pseudograph
1801: An interpretation of this matrix as a (pseudo)graph allows us to define additional operations on it:
1802: A MatIJ can act on sparse arrays: arrays of indices, or index arrays of integers, scalars, or integer-scalar pairs
1803: by mapping the indices to the indices connected to them by the (pseudo)graph ed
1804: */
1805: typedef enum {MATIJ_LOCAL, MATIJ_GLOBAL} MatIJIndexType;
1806: PETSC_EXTERN PetscErrorCode MatIJSetMultivalued(Mat, PetscBool);
1807: PETSC_EXTERN PetscErrorCode MatIJGetMultivalued(Mat, PetscBool*);
1808: PETSC_EXTERN PetscErrorCode MatIJSetEdges(Mat, PetscInt, const PetscInt*, const PetscInt*);
1809: PETSC_EXTERN PetscErrorCode MatIJGetEdges(Mat, PetscInt *, PetscInt **, PetscInt **);
1810: PETSC_EXTERN PetscErrorCode MatIJSetEdgesIS(Mat, IS, IS);
1811: PETSC_EXTERN PetscErrorCode MatIJGetEdgesIS(Mat, IS*, IS*);
1812: PETSC_EXTERN PetscErrorCode MatIJGetRowSizes(Mat, MatIJIndexType, PetscInt, const PetscInt *, PetscInt **);
1813: PETSC_EXTERN PetscErrorCode MatIJGetMinRowSize(Mat, PetscInt *);
1814: PETSC_EXTERN PetscErrorCode MatIJGetMaxRowSize(Mat, PetscInt *);
1815: PETSC_EXTERN PetscErrorCode MatIJGetSupport(Mat, PetscInt *, PetscInt **);
1816: PETSC_EXTERN PetscErrorCode MatIJGetSupportIS(Mat, IS *);
1817: PETSC_EXTERN PetscErrorCode MatIJGetImage(Mat, PetscInt*, PetscInt**);
1818: PETSC_EXTERN PetscErrorCode MatIJGetImageIS(Mat, IS *);
1819: PETSC_EXTERN PetscErrorCode MatIJGetSupportSize(Mat, PetscInt *);
1820: PETSC_EXTERN PetscErrorCode MatIJGetImageSize(Mat, PetscInt *);
1822: PETSC_EXTERN PetscErrorCode MatIJBinRenumber(Mat, Mat*);
1824: PETSC_EXTERN PetscErrorCode MatIJMap(Mat, MatIJIndexType, PetscInt,const PetscInt*,const PetscInt*,const PetscScalar*, MatIJIndexType,PetscInt*,PetscInt**,PetscInt**,PetscScalar**,PetscInt**);
1825: PETSC_EXTERN PetscErrorCode MatIJBin(Mat, MatIJIndexType, PetscInt,const PetscInt*,const PetscInt*,const PetscScalar*,PetscInt*,PetscInt**,PetscInt**,PetscScalar**,PetscInt**);
1826: PETSC_EXTERN PetscErrorCode MatIJBinMap(Mat,Mat, MatIJIndexType,PetscInt,const PetscInt*,const PetscInt*,const PetscScalar*,MatIJIndexType,PetscInt*,PetscInt**,PetscInt**,PetscScalar**,PetscInt**);
1828: #endif