Actual source code: petscmat.h

petsc-master 2018-04-24
Report Typos and Errors
  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 used to manage all linear operators in PETSc, even those without
 10:            an explicit sparse representation (such as matrix-free operators)

 12:    Level: beginner

 14:   Concepts: matrix; linear operator

 16: .seealso:  MatCreate(), MatType, MatSetType(), MatDestroy()
 17: S*/
 18: typedef struct _p_Mat*           Mat;

 20: /*J
 21:     MatType - String with the name of a PETSc matrix type

 23:    Level: beginner

 25: .seealso: MatSetType(), Mat, MatSolverType, MatRegister()
 26: J*/
 27: typedef const char* MatType;
 28: #define MATSAME            "same"
 29: #define MATMAIJ            "maij"
 30: #define MATSEQMAIJ         "seqmaij"
 31: #define MATMPIMAIJ         "mpimaij"
 32: #define MATIS              "is"
 33: #define MATAIJ             "aij"
 34: #define MATSEQAIJ          "seqaij"
 35: #define MATMPIAIJ          "mpiaij"
 36: #define MATAIJCRL          "aijcrl"
 37: #define MATSEQAIJCRL       "seqaijcrl"
 38: #define MATMPIAIJCRL       "mpiaijcrl"
 39: #define MATAIJCUSPARSE     "aijcusparse"
 40: #define MATSEQAIJCUSPARSE  "seqaijcusparse"
 41: #define MATMPIAIJCUSPARSE  "mpiaijcusparse"
 42: #define MATAIJVIENNACL     "aijviennacl"
 43: #define MATSEQAIJVIENNACL  "seqaijviennacl"
 44: #define MATMPIAIJVIENNACL  "mpiaijviennacl"
 45: #define MATAIJPERM         "aijperm"
 46: #define MATSEQAIJPERM      "seqaijperm"
 47: #define MATMPIAIJPERM      "mpiaijperm"
 48: #define MATAIJMKL          "aijmkl"
 49: #define MATSEQAIJMKL       "seqaijmkl"
 50: #define MATMPIAIJMKL       "mpiaijmkl"
 51: #define MATBAIJMKL         "baijmkl"
 52: #define MATSEQBAIJMKL      "seqbaijmkl"
 53: #define MATMPIBAIJMKL      "mpibaijmkl"
 54: #define MATSHELL           "shell"
 55: #define MATDENSE           "dense"
 56: #define MATSEQDENSE        "seqdense"
 57: #define MATMPIDENSE        "mpidense"
 58: #define MATELEMENTAL       "elemental"
 59: #define MATBAIJ            "baij"
 60: #define MATSEQBAIJ         "seqbaij"
 61: #define MATMPIBAIJ         "mpibaij"
 62: #define MATMPIADJ          "mpiadj"
 63: #define MATSBAIJ           "sbaij"
 64: #define MATSEQSBAIJ        "seqsbaij"
 65: #define MATMPISBAIJ        "mpisbaij"
 66: #define MATDAAD            "daad"
 67: #define MATMFFD            "mffd"
 68: #define MATNORMAL          "normal"
 69: #define MATNORMALHERMITIAN "normalh"
 70: #define MATLRC             "lrc"
 71: #define MATSCATTER         "scatter"
 72: #define MATBLOCKMAT        "blockmat"
 73: #define MATCOMPOSITE       "composite"
 74: #define MATFFT             "fft"
 75: #define MATFFTW            "fftw"
 76: #define MATSEQCUFFT        "seqcufft"
 77: #define MATTRANSPOSEMAT    "transpose"
 78: #define MATSCHURCOMPLEMENT "schurcomplement"
 79: #define MATPYTHON          "python"
 80: #define MATHYPRE           "hypre"
 81: #define MATHYPRESTRUCT     "hyprestruct"
 82: #define MATHYPRESSTRUCT    "hypresstruct"
 83: #define MATSUBMATRIX       "submatrix"
 84: #define MATLOCALREF        "localref"
 85: #define MATNEST            "nest"
 86: #define MATPREALLOCATOR    "preallocator"
 87: #define MATSELL            "sell"
 88: #define MATSEQSELL         "seqsell"
 89: #define MATMPISELL         "mpisell"
 90: #define MATDUMMY           "dummy"

 92: /*J
 93:     MatSolverType - String with the name of a PETSc matrix solver type.

 95:     For example: "petsc" indicates what PETSc provides, "superlu_dist" the parallel SuperLU_DIST package etc

 97:    Level: beginner

 99: .seealso: MatGetFactor(), Mat, MatSetType(), MatType
100: J*/
101: typedef const char* MatSolverType;
102: #define MATSOLVERSUPERLU          "superlu"
103: #define MATSOLVERSUPERLU_DIST     "superlu_dist"
104: #define MATSOLVERSTRUMPACK        "strumpack"
105: #define MATSOLVERUMFPACK          "umfpack"
106: #define MATSOLVERCHOLMOD          "cholmod"
107: #define MATSOLVERKLU              "klu"
108: #define MATSOLVERSPARSEELEMENTAL  "sparseelemental"
109: #define MATSOLVERELEMENTAL        "elemental"
110: #define MATSOLVERESSL             "essl"
111: #define MATSOLVERLUSOL            "lusol"
112: #define MATSOLVERMUMPS            "mumps"
113: #define MATSOLVERMKL_PARDISO      "mkl_pardiso"
114: #define MATSOLVERMKL_CPARDISO     "mkl_cpardiso"
115: #define MATSOLVERPASTIX           "pastix"
116: #define MATSOLVERMATLAB           "matlab"
117: #define MATSOLVERPETSC            "petsc"
118: #define MATSOLVERBAS              "bas"
119: #define MATSOLVERCUSPARSE         "cusparse"

121: /*E
122:     MatFactorType - indicates what type of factorization is requested

124:     Level: beginner

126:    Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h

128: .seealso: MatSolverType, MatGetFactor()
129: E*/
130: typedef enum {MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC,MAT_FACTOR_ILUDT} MatFactorType;
131: PETSC_EXTERN const char *const MatFactorTypes[];

133: PETSC_EXTERN PetscErrorCode MatGetFactor(Mat,MatSolverType,MatFactorType,Mat*);
134: PETSC_EXTERN PetscErrorCode MatGetFactorAvailable(Mat,MatSolverType,MatFactorType,PetscBool *);
135: PETSC_EXTERN PetscErrorCode MatFactorGetSolverType(Mat,MatSolverType*);
136: PETSC_EXTERN PetscErrorCode MatGetFactorType(Mat,MatFactorType*);
137: PETSC_EXTERN PetscErrorCode MatSolverTypeRegister(MatSolverType,const MatType,MatFactorType,PetscErrorCode(*)(Mat,MatFactorType,Mat*));
138: PETSC_EXTERN PetscErrorCode MatSolverTypeGet(MatSolverType,const MatType,MatFactorType,PetscBool*,PetscBool*,PetscErrorCode (**)(Mat,MatFactorType,Mat*));

140: /* Logging support */
141: #define    MAT_FILE_CLASSID 1211216    /* used to indicate matrices in binary files */
142: PETSC_EXTERN PetscClassId MAT_CLASSID;
143: PETSC_EXTERN PetscClassId MAT_COLORING_CLASSID;
144: PETSC_EXTERN PetscClassId MAT_FDCOLORING_CLASSID;
145: PETSC_EXTERN PetscClassId MAT_TRANSPOSECOLORING_CLASSID;
146: PETSC_EXTERN PetscClassId MAT_PARTITIONING_CLASSID;
147: PETSC_EXTERN PetscClassId MAT_COARSEN_CLASSID;
148: PETSC_EXTERN PetscClassId MAT_NULLSPACE_CLASSID;
149: PETSC_EXTERN PetscClassId MATMFFD_CLASSID;

151: /*E
152:     MatReuse - Indicates if matrices obtained from a previous call to MatCreateSubMatrices(), MatCreateSubMatrix(), MatConvert() or several other functions
153:      are to be reused to store the new matrix values.

155: $  MAT_INITIAL_MATRIX - create a new matrix
156: $  MAT_REUSE_MATRIX - reuse the matrix created with a previous call that used MAT_INITIAL_MATRIX
157: $  MAT_INPLACE_MATRIX - replace the first input matrix with the new matrix (not applicable to all functions)
158: $  MAT_IGNORE_MATRIX - do not create a new matrix or reuse a give matrix, just ignore that matrix argument (not applicable to all functions)

160:     Level: beginner

162:    Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h

164: .seealso: MatCreateSubMatrices(), MatCreateSubMatrix(), MatDestroyMatrices(), MatConvert()
165: E*/
166: typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX,MAT_INPLACE_MATRIX} MatReuse;

168: /*E
169:     MatCreateSubMatrixOption - Indicates if matrices obtained from a call to MatCreateSubMatrices()
170:      include the matrix values. Currently it is only used by MatGetSeqNonzerostructure().

172:     Level: beginner

174: .seealso: MatGetSeqNonzerostructure()
175: E*/
176: typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatCreateSubMatrixOption;

178: PETSC_EXTERN PetscErrorCode MatInitializePackage(void);

180: PETSC_EXTERN PetscErrorCode MatCreate(MPI_Comm,Mat*);
181: PETSC_EXTERN PetscErrorCode MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
182: PETSC_EXTERN PetscErrorCode MatSetType(Mat,MatType);
183: PETSC_EXTERN PetscErrorCode MatSetFromOptions(Mat);
184: PETSC_STATIC_INLINE PetscErrorCode MatViewFromOptions(Mat A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
185: PETSC_EXTERN PetscErrorCode MatRegister(const char[],PetscErrorCode(*)(Mat));
186: PETSC_EXTERN PetscErrorCode MatRegisterBaseName(const char[],const char[],const char[]);
187: PETSC_EXTERN PetscErrorCode MatSetOptionsPrefix(Mat,const char[]);
188: PETSC_EXTERN PetscErrorCode MatAppendOptionsPrefix(Mat,const char[]);
189: PETSC_EXTERN PetscErrorCode MatGetOptionsPrefix(Mat,const char*[]);
190: PETSC_EXTERN PetscErrorCode MatSetErrorIfFailure(Mat,PetscBool);

192: PETSC_EXTERN PetscFunctionList MatList;
193: PETSC_EXTERN PetscFunctionList MatColoringList;
194: PETSC_EXTERN PetscFunctionList MatPartitioningList;

196: /*E
197:     MatStructure - Indicates if two matrices have the same nonzero structure

199:     Level: beginner

201:    Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h

203: .seealso: MatCopy(), MatAXPY()
204: E*/
205: typedef enum {DIFFERENT_NONZERO_PATTERN,SUBSET_NONZERO_PATTERN,SAME_NONZERO_PATTERN} MatStructure;

207: #if defined PETSC_HAVE_MKL_SPARSE
208: PETSC_EXTERN PetscErrorCode MatCreateBAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
209: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJMKL(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[],Mat *A);
210: #endif
211: PETSC_EXTERN PetscErrorCode MatCreateSeqSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
212: PETSC_EXTERN PetscErrorCode MatCreateSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
213: PETSC_EXTERN PetscErrorCode MatSeqSELLSetPreallocation(Mat,PetscInt,const PetscInt[]);
214: PETSC_EXTERN PetscErrorCode MatMPISELLSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);

216: PETSC_EXTERN PetscErrorCode MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
217: PETSC_EXTERN PetscErrorCode MatCreateDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
218: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
219: PETSC_EXTERN PetscErrorCode MatCreateAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
220: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
221: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*);
222: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSeqAIJ(MPI_Comm,Mat,Mat,const PetscInt[],Mat*);

224: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
225: PETSC_EXTERN PetscErrorCode MatCreateBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
226: PETSC_EXTERN PetscErrorCode MatCreateMPIBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat*);

228: PETSC_EXTERN PetscErrorCode MatCreateMPIAdj(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscInt[],Mat*);
229: PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);

231: PETSC_EXTERN PetscErrorCode MatCreateSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
232: PETSC_EXTERN PetscErrorCode MatCreateMPISBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
233: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
234: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
235: PETSC_EXTERN PetscErrorCode MatXAIJSetPreallocation(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],const PetscInt[]);

237: PETSC_EXTERN PetscErrorCode MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
238: PETSC_EXTERN PetscErrorCode MatCreateNormal(Mat,Mat*);
239: PETSC_EXTERN PetscErrorCode MatCreateNormalHermitian(Mat,Mat*);
240: PETSC_EXTERN PetscErrorCode MatCreateLRC(Mat,Mat,Vec,Mat,Mat*);
241: PETSC_EXTERN PetscErrorCode MatLRCGetMats(Mat,Mat*,Mat*,Vec*,Mat*);
242: PETSC_EXTERN PetscErrorCode MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,ISLocalToGlobalMapping,Mat*);
243: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
244: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);

246: PETSC_EXTERN PetscErrorCode MatCreateScatter(MPI_Comm,VecScatter,Mat*);
247: PETSC_EXTERN PetscErrorCode MatScatterSetVecScatter(Mat,VecScatter);
248: PETSC_EXTERN PetscErrorCode MatScatterGetVecScatter(Mat,VecScatter*);
249: PETSC_EXTERN PetscErrorCode MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*);
250: PETSC_EXTERN PetscErrorCode MatCompositeAddMat(Mat,Mat);
251: PETSC_EXTERN PetscErrorCode MatCompositeMerge(Mat);
252: PETSC_EXTERN PetscErrorCode MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*);
253: typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType;
254: PETSC_EXTERN PetscErrorCode MatCompositeSetType(Mat,MatCompositeType);

256: PETSC_EXTERN PetscErrorCode MatCreateFFT(MPI_Comm,PetscInt,const PetscInt[],MatType,Mat*);
257: PETSC_EXTERN PetscErrorCode MatCreateSeqCUFFT(MPI_Comm,PetscInt,const PetscInt[],Mat*);

259: PETSC_EXTERN PetscErrorCode MatCreateTranspose(Mat,Mat*);
260: PETSC_EXTERN PetscErrorCode MatTransposeGetMat(Mat,Mat*);
261: PETSC_EXTERN PetscErrorCode MatCreateHermitianTranspose(Mat,Mat*);
262: PETSC_EXTERN PetscErrorCode MatCreateSubMatrixVirtual(Mat,IS,IS,Mat*);
263: PETSC_EXTERN PetscErrorCode MatSubMatrixVirtualUpdate(Mat,Mat,IS,IS);
264: PETSC_EXTERN PetscErrorCode MatCreateLocalRef(Mat,IS,IS,Mat*);

266: #if defined(PETSC_HAVE_HYPRE)
267: PETSC_EXTERN PetscErrorCode MatHYPRESetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
268: #endif

270: PETSC_EXTERN PetscErrorCode MatPythonSetType(Mat,const char[]);

272: PETSC_EXTERN PetscErrorCode MatResetPreallocation(Mat);
273: PETSC_EXTERN PetscErrorCode MatSetUp(Mat);
274: PETSC_EXTERN PetscErrorCode MatDestroy(Mat*);
275: PETSC_EXTERN PetscErrorCode MatGetNonzeroState(Mat,PetscObjectState*);

277: PETSC_EXTERN PetscErrorCode MatConjugate(Mat);
278: PETSC_EXTERN PetscErrorCode MatRealPart(Mat);
279: PETSC_EXTERN PetscErrorCode MatImaginaryPart(Mat);
280: PETSC_EXTERN PetscErrorCode MatGetDiagonalBlock(Mat,Mat*);
281: PETSC_EXTERN PetscErrorCode MatGetTrace(Mat,PetscScalar*);
282: PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonal(Mat,const PetscScalar **);
283: PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonalMat(Mat,Mat);

285: /* ------------------------------------------------------------*/
286: PETSC_EXTERN PetscErrorCode MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
287: PETSC_EXTERN PetscErrorCode MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
288: PETSC_EXTERN PetscErrorCode MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
289: PETSC_EXTERN PetscErrorCode MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);
290: PETSC_EXTERN PetscErrorCode MatSetValuesBatch(Mat,PetscInt,PetscInt,PetscInt[],const PetscScalar[]);
291: PETSC_EXTERN PetscErrorCode MatSetRandom(Mat,PetscRandom);

293: /*S
294:      MatStencil - Data structure (C struct) for storing information about a single row or
295:         column of a matrix as indexed on an associated grid. These are arguments to MatSetStencil() and MatSetBlockStencil()

297:    The i,j, and k represent the logical coordinates over the entire grid (for 2 and 1 dimensional problems the k and j entries are ignored).
298:    The c represents the the degrees of freedom at each grid point (the dof argument to DMDASetDOF()). If dof is 1 then this entry is ignored.

300:    For stencil access to vectors see DMDAVecGetArray(), DMDAVecGetArrayF90().

302:    Fortran usage is different, see MatSetValuesStencil() for details.

304:    Level: beginner

306:   Concepts: matrix; linear operator

308: .seealso:  MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockedStencil(), DMDAVecGetArray(), DMDAVecGetArrayF90()
309: S*/
310: typedef struct {
311:   PetscInt k,j,i,c;
312: } MatStencil;

314: PETSC_EXTERN PetscErrorCode MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
315: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
316: PETSC_EXTERN PetscErrorCode MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);

318: /*E
319:     MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
320:      to continue to add or insert values to it

322:     Level: beginner

324: .seealso: MatAssemblyBegin(), MatAssemblyEnd()
325: E*/
326: typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
327: PETSC_EXTERN PetscErrorCode MatAssemblyBegin(Mat,MatAssemblyType);
328: PETSC_EXTERN PetscErrorCode MatAssemblyEnd(Mat,MatAssemblyType);
329: PETSC_EXTERN PetscErrorCode MatAssembled(Mat,PetscBool *);



333: /*E
334:     MatOption - Options that may be set for a matrix and its behavior or storage

336:     Level: beginner

338:    Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
339:    Any additions/changes here must also be made in src/mat/interface/dlregismat.c in MatOptions[]

341:    Developer Notes:
342:     Entries that are negative need not be called collectively by all processes.

344: .seealso: MatSetOption()
345: E*/
346: typedef enum {MAT_OPTION_MIN = -3,
347:               MAT_UNUSED_NONZERO_LOCATION_ERR = -2,
348:               MAT_ROW_ORIENTED = -1,
349:               MAT_SYMMETRIC = 1,
350:               MAT_STRUCTURALLY_SYMMETRIC = 2,
351:               MAT_NEW_DIAGONALS = 3,
352:               MAT_IGNORE_OFF_PROC_ENTRIES = 4,
353:               MAT_USE_HASH_TABLE = 5,
354:               MAT_KEEP_NONZERO_PATTERN = 6,
355:               MAT_IGNORE_ZERO_ENTRIES = 7,
356:               MAT_USE_INODES = 8,
357:               MAT_HERMITIAN = 9,
358:               MAT_SYMMETRY_ETERNAL = 10,
359:               MAT_NEW_NONZERO_LOCATION_ERR = 11,
360:               MAT_IGNORE_LOWER_TRIANGULAR = 12,
361:               MAT_ERROR_LOWER_TRIANGULAR = 13,
362:               MAT_GETROW_UPPERTRIANGULAR = 14,
363:               MAT_SPD = 15,
364:               MAT_NO_OFF_PROC_ZERO_ROWS = 16,
365:               MAT_NO_OFF_PROC_ENTRIES = 17,
366:               MAT_NEW_NONZERO_LOCATIONS = 18,
367:               MAT_NEW_NONZERO_ALLOCATION_ERR = 19,
368:               MAT_SUBSET_OFF_PROC_ENTRIES = 20,
369:               MAT_SUBMAT_SINGLEIS = 21,
370:               MAT_STRUCTURE_ONLY = 22,
371:               MAT_OPTION_MAX = 23} MatOption;

373: PETSC_EXTERN const char *const *MatOptions;
374: PETSC_EXTERN PetscErrorCode MatSetOption(Mat,MatOption,PetscBool);
375: PETSC_EXTERN PetscErrorCode MatGetOption(Mat,MatOption,PetscBool*);
376: PETSC_EXTERN PetscErrorCode MatGetType(Mat,MatType*);

378: PETSC_EXTERN PetscErrorCode MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
379: PETSC_EXTERN PetscErrorCode MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
380: PETSC_EXTERN PetscErrorCode MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
381: PETSC_EXTERN PetscErrorCode MatGetRowUpperTriangular(Mat);
382: PETSC_EXTERN PetscErrorCode MatRestoreRowUpperTriangular(Mat);
383: PETSC_EXTERN PetscErrorCode MatGetColumnVector(Mat,Vec,PetscInt);
384: PETSC_EXTERN PetscErrorCode MatSeqAIJGetArray(Mat,PetscScalar *[]);
385: PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArray(Mat,PetscScalar *[]);
386: PETSC_EXTERN PetscErrorCode MatSeqAIJGetMaxRowNonzeros(Mat,PetscInt*);
387: PETSC_EXTERN PetscErrorCode MatSeqAIJSetValuesLocalFast(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
388: PETSC_EXTERN PetscErrorCode MatSeqAIJSetType(Mat,MatType);
389: PETSC_EXTERN PetscErrorCode MatSeqAIJRegister(const char[],PetscErrorCode (*)(Mat,MatType,MatReuse,Mat *));
390: PETSC_EXTERN PetscFunctionList MatSeqAIJList;
391: PETSC_EXTERN PetscErrorCode MatSeqSBAIJGetArray(Mat,PetscScalar *[]);
392: PETSC_EXTERN PetscErrorCode MatSeqSBAIJRestoreArray(Mat,PetscScalar *[]);
393: PETSC_EXTERN PetscErrorCode MatDenseGetArray(Mat,PetscScalar *[]);
394: PETSC_EXTERN PetscErrorCode MatDenseRestoreArray(Mat,PetscScalar *[]);
395: PETSC_EXTERN PetscErrorCode MatDensePlaceArray(Mat,const PetscScalar[]);
396: PETSC_EXTERN PetscErrorCode MatDenseResetArray(Mat);
397: PETSC_EXTERN PetscErrorCode MatDenseGetArrayRead(Mat,const PetscScalar *[]);
398: PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayRead(Mat,const PetscScalar *[]);
399: PETSC_EXTERN PetscErrorCode MatGetBlockSize(Mat,PetscInt *);
400: PETSC_EXTERN PetscErrorCode MatSetBlockSize(Mat,PetscInt);
401: PETSC_EXTERN PetscErrorCode MatGetBlockSizes(Mat,PetscInt *,PetscInt *);
402: PETSC_EXTERN PetscErrorCode MatSetBlockSizes(Mat,PetscInt,PetscInt);
403: PETSC_EXTERN PetscErrorCode MatSetBlockSizesFromMats(Mat,Mat,Mat);
404: PETSC_EXTERN PetscErrorCode MatDenseGetColumn(Mat,PetscInt,PetscScalar *[]);
405: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumn(Mat,PetscScalar *[]);

407: PETSC_EXTERN PetscErrorCode MatMult(Mat,Vec,Vec);
408: PETSC_EXTERN PetscErrorCode MatMultDiagonalBlock(Mat,Vec,Vec);
409: PETSC_EXTERN PetscErrorCode MatMultAdd(Mat,Vec,Vec,Vec);
410: PETSC_EXTERN PetscErrorCode MatMultTranspose(Mat,Vec,Vec);
411: PETSC_EXTERN PetscErrorCode MatMultHermitianTranspose(Mat,Vec,Vec);
412: PETSC_EXTERN PetscErrorCode MatIsTranspose(Mat,Mat,PetscReal,PetscBool *);
413: PETSC_EXTERN PetscErrorCode MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscBool *);
414: PETSC_EXTERN PetscErrorCode MatMultTransposeAdd(Mat,Vec,Vec,Vec);
415: PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec);
416: PETSC_EXTERN PetscErrorCode MatMultConstrained(Mat,Vec,Vec);
417: PETSC_EXTERN PetscErrorCode MatMultTransposeConstrained(Mat,Vec,Vec);
418: PETSC_EXTERN PetscErrorCode MatMatSolve(Mat,Mat,Mat);
419: PETSC_EXTERN PetscErrorCode MatMatSolveTranspose(Mat,Mat,Mat);
420: PETSC_EXTERN PetscErrorCode MatResidual(Mat,Vec,Vec,Vec);

422: /*E
423:     MatDuplicateOption - Indicates if a duplicated sparse matrix should have
424:   its numerical values copied over or just its nonzero structure.

426:     Level: beginner

428:    Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h

430: $   MAT_DO_NOT_COPY_VALUES    - Create a matrix using the same nonzero pattern as the original matrix,
431: $                               with zeros for the numerical values.
432: $   MAT_COPY_VALUES           - Create a matrix with the same nonzero pattern as the original matrix
433: $                               and with the same numerical values.
434: $   MAT_SHARE_NONZERO_PATTERN - Create a matrix that shares the nonzero structure with the previous matrix
435: $                               and does not copy it, using zeros for the numerical values. The parent and
436: $                               child matrices will share their index (i and j) arrays, and you cannot
437: $                               insert new nonzero entries into either matrix.

439: Notes:
440:     Many matrix types (including SeqAIJ) do not support the MAT_SHARE_NONZERO_PATTERN optimization; in
441: this case the behavior is as if MAT_DO_NOT_COPY_VALUES has been specified.

443: .seealso: MatDuplicate()
444: E*/
445: typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption;

447: PETSC_EXTERN PetscErrorCode MatConvert(Mat,MatType,MatReuse,Mat*);
448: PETSC_EXTERN PetscErrorCode MatDuplicate(Mat,MatDuplicateOption,Mat*);


451: PETSC_EXTERN PetscErrorCode MatCopy(Mat,Mat,MatStructure);
452: PETSC_EXTERN PetscErrorCode MatView(Mat,PetscViewer);
453: PETSC_EXTERN PetscErrorCode MatIsSymmetric(Mat,PetscReal,PetscBool *);
454: PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat,PetscBool *);
455: PETSC_EXTERN PetscErrorCode MatIsHermitian(Mat,PetscReal,PetscBool *);
456: PETSC_EXTERN PetscErrorCode MatIsSymmetricKnown(Mat,PetscBool *,PetscBool *);
457: PETSC_EXTERN PetscErrorCode MatIsHermitianKnown(Mat,PetscBool *,PetscBool *);
458: PETSC_EXTERN PetscErrorCode MatMissingDiagonal(Mat,PetscBool  *,PetscInt *);
459: PETSC_EXTERN PetscErrorCode MatLoad(Mat, PetscViewer);

461: PETSC_EXTERN PetscErrorCode MatGetRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool  *);
462: PETSC_EXTERN PetscErrorCode MatRestoreRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool  *);
463: PETSC_EXTERN PetscErrorCode MatGetColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool  *);
464: PETSC_EXTERN PetscErrorCode MatRestoreColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool  *);

466: /*S
467:      MatInfo - Context of matrix information, used with MatGetInfo()

469:    In Fortran this is simply a double precision array of dimension MAT_INFO_SIZE

471:    Level: intermediate

473:   Concepts: matrix^nonzero information

475: .seealso:  MatGetInfo(), MatInfoType
476: S*/
477: typedef struct {
478:   PetscLogDouble block_size;                         /* block size */
479:   PetscLogDouble nz_allocated,nz_used,nz_unneeded;   /* number of nonzeros */
480:   PetscLogDouble memory;                             /* memory allocated */
481:   PetscLogDouble assemblies;                         /* number of matrix assemblies called */
482:   PetscLogDouble mallocs;                            /* number of mallocs during MatSetValues() */
483:   PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
484:   PetscLogDouble factor_mallocs;                     /* number of mallocs during factorization */
485: } MatInfo;

487: /*E
488:     MatInfoType - Indicates if you want information about the local part of the matrix,
489:      the entire parallel matrix or the maximum over all the local parts.

491:     Level: beginner

493:    Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h

495: .seealso: MatGetInfo(), MatInfo
496: E*/
497: typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
498: PETSC_EXTERN PetscErrorCode MatGetInfo(Mat,MatInfoType,MatInfo*);
499: PETSC_EXTERN PetscErrorCode MatGetDiagonal(Mat,Vec);
500: PETSC_EXTERN PetscErrorCode MatGetRowMax(Mat,Vec,PetscInt[]);
501: PETSC_EXTERN PetscErrorCode MatGetRowMin(Mat,Vec,PetscInt[]);
502: PETSC_EXTERN PetscErrorCode MatGetRowMaxAbs(Mat,Vec,PetscInt[]);
503: PETSC_EXTERN PetscErrorCode MatGetRowMinAbs(Mat,Vec,PetscInt[]);
504: PETSC_EXTERN PetscErrorCode MatGetRowSum(Mat,Vec);
505: PETSC_EXTERN PetscErrorCode MatTranspose(Mat,MatReuse,Mat*);
506: PETSC_EXTERN PetscErrorCode MatHermitianTranspose(Mat,MatReuse,Mat*);
507: PETSC_EXTERN PetscErrorCode MatPermute(Mat,IS,IS,Mat*);
508: PETSC_EXTERN PetscErrorCode MatDiagonalScale(Mat,Vec,Vec);
509: PETSC_EXTERN PetscErrorCode MatDiagonalSet(Mat,Vec,InsertMode);

511: PETSC_EXTERN PetscErrorCode MatEqual(Mat,Mat,PetscBool*);
512: PETSC_EXTERN PetscErrorCode MatMultEqual(Mat,Mat,PetscInt,PetscBool*);
513: PETSC_EXTERN PetscErrorCode MatMultAddEqual(Mat,Mat,PetscInt,PetscBool*);
514: PETSC_EXTERN PetscErrorCode MatMultTransposeEqual(Mat,Mat,PetscInt,PetscBool*);
515: PETSC_EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscBool*);
516: PETSC_EXTERN PetscErrorCode MatMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
517: PETSC_EXTERN PetscErrorCode MatTransposeMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);

519: PETSC_EXTERN PetscErrorCode MatNorm(Mat,NormType,PetscReal*);
520: PETSC_EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal*);
521: PETSC_EXTERN PetscErrorCode MatZeroEntries(Mat);
522: PETSC_EXTERN PetscErrorCode MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
523: PETSC_EXTERN PetscErrorCode MatZeroRowsIS(Mat,IS,PetscScalar,Vec,Vec);
524: PETSC_EXTERN PetscErrorCode MatZeroRowsStencil(Mat,PetscInt,const MatStencil [],PetscScalar,Vec,Vec);
525: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsStencil(Mat,PetscInt,const MatStencil[],PetscScalar,Vec,Vec);
526: PETSC_EXTERN PetscErrorCode MatZeroRowsColumns(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
527: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsIS(Mat,IS,PetscScalar,Vec,Vec);

529: PETSC_EXTERN PetscErrorCode MatGetSize(Mat,PetscInt*,PetscInt*);
530: PETSC_EXTERN PetscErrorCode MatGetLocalSize(Mat,PetscInt*,PetscInt*);
531: PETSC_EXTERN PetscErrorCode MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
532: PETSC_EXTERN PetscErrorCode MatGetOwnershipRanges(Mat,const PetscInt**);
533: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*);
534: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat,const PetscInt**);
535: PETSC_EXTERN PetscErrorCode MatGetOwnershipIS(Mat,IS*,IS*);

537: PETSC_EXTERN PetscErrorCode MatCreateSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
538: PETSC_DEPRECATED("Use MatCreateSubMatrices()") PETSC_STATIC_INLINE PetscErrorCode MatGetSubMatrices(Mat mat,PetscInt n,const IS irow[],const IS icol[],MatReuse scall,Mat *submat[]) {return MatCreateSubMatrices(mat,n,irow,icol,scall,submat);}
539: PETSC_EXTERN PetscErrorCode MatCreateSubMatricesMPI(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
540: PETSC_DEPRECATED("Use MatCreateSubMatricesMPI()") PETSC_STATIC_INLINE PetscErrorCode MatGetSubMatricesMPI(Mat mat,PetscInt n,const IS irow[],const IS icol[],MatReuse scall,Mat *submat[]) {return MatCreateSubMatricesMPI(mat,n,irow,icol,scall,submat);}
541: PETSC_EXTERN PetscErrorCode MatDestroyMatrices(PetscInt,Mat *[]);
542: PETSC_EXTERN PetscErrorCode MatDestroySubMatrices(PetscInt,Mat *[]);
543: PETSC_EXTERN PetscErrorCode MatCreateSubMatrix(Mat,IS,IS,MatReuse,Mat *);
544: PETSC_DEPRECATED("Use MatCreateSubMatrix()") PETSC_STATIC_INLINE PetscErrorCode MatGetSubMatrix(Mat mat,IS isrow,IS iscol,MatReuse cll,Mat *newmat) {return MatCreateSubMatrix(mat,isrow,iscol,cll,newmat);}
545: PETSC_EXTERN PetscErrorCode MatGetLocalSubMatrix(Mat,IS,IS,Mat*);
546: PETSC_EXTERN PetscErrorCode MatRestoreLocalSubMatrix(Mat,IS,IS,Mat*);
547: PETSC_EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat,Mat*);
548: PETSC_EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat*);

550: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJ(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
551: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJSymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
552: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJNumeric(Mat,Mat);
553: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMat(Mat,MatReuse,Mat*);
554: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
555: PETSC_EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,Mat*);
556: PETSC_EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *,const PetscInt *[]);

558: PETSC_EXTERN PetscErrorCode MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
559: PETSC_EXTERN PetscErrorCode MatIncreaseOverlapSplit(Mat mat,PetscInt n,IS is[],PetscInt ov);
560: PETSC_EXTERN PetscErrorCode MatMPIAIJSetUseScalableIncreaseOverlap(Mat,PetscBool);

562: PETSC_EXTERN PetscErrorCode MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
563: PETSC_EXTERN PetscErrorCode MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
564: PETSC_EXTERN PetscErrorCode MatMatMultNumeric(Mat,Mat,Mat);

566: PETSC_EXTERN PetscErrorCode MatMatMatMult(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);
567: PETSC_EXTERN PetscErrorCode MatGalerkin(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);

569: PETSC_EXTERN PetscErrorCode MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
570: PETSC_EXTERN PetscErrorCode MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
571: PETSC_EXTERN PetscErrorCode MatPtAPNumeric(Mat,Mat,Mat);
572: PETSC_EXTERN PetscErrorCode MatRARt(Mat,Mat,MatReuse,PetscReal,Mat*);
573: PETSC_EXTERN PetscErrorCode MatRARtSymbolic(Mat,Mat,PetscReal,Mat*);
574: PETSC_EXTERN PetscErrorCode MatRARtNumeric(Mat,Mat,Mat);

576: PETSC_EXTERN PetscErrorCode MatTransposeMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
577: PETSC_EXTERN PetscErrorCode MatTransposetMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
578: PETSC_EXTERN PetscErrorCode MatTransposetMatMultNumeric(Mat,Mat,Mat);
579: PETSC_EXTERN PetscErrorCode MatMatTransposeMult(Mat,Mat,MatReuse,PetscReal,Mat*);
580: PETSC_EXTERN PetscErrorCode MatMatTransposeMultSymbolic(Mat,Mat,PetscReal,Mat*);
581: PETSC_EXTERN PetscErrorCode MatMatTransposeMultNumeric(Mat,Mat,Mat);

583: PETSC_EXTERN PetscErrorCode MatAXPY(Mat,PetscScalar,Mat,MatStructure);
584: PETSC_EXTERN PetscErrorCode MatAYPX(Mat,PetscScalar,Mat,MatStructure);

586: PETSC_EXTERN PetscErrorCode MatScale(Mat,PetscScalar);
587: PETSC_EXTERN PetscErrorCode MatShift(Mat,PetscScalar);

589: PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping);
590: PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*);
591: PETSC_EXTERN PetscErrorCode MatGetLayouts(Mat,PetscLayout*,PetscLayout*);
592: PETSC_EXTERN PetscErrorCode MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
593: PETSC_EXTERN PetscErrorCode MatZeroRowsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
594: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
595: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
596: PETSC_EXTERN PetscErrorCode MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
597: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);

599: PETSC_EXTERN PetscErrorCode MatStashSetInitialSize(Mat,PetscInt,PetscInt);
600: PETSC_EXTERN PetscErrorCode MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);

602: PETSC_EXTERN PetscErrorCode MatInterpolate(Mat,Vec,Vec);
603: PETSC_EXTERN PetscErrorCode MatInterpolateAdd(Mat,Vec,Vec,Vec);
604: PETSC_EXTERN PetscErrorCode MatRestrict(Mat,Vec,Vec);
605: PETSC_EXTERN PetscErrorCode MatCreateVecs(Mat,Vec*,Vec*);
606: PETSC_DEPRECATED("Use MatCreateVecs()") PETSC_STATIC_INLINE PetscErrorCode MatGetVecs(Mat mat,Vec *x,Vec *y) {return MatCreateVecs(mat,x,y);}
607: PETSC_EXTERN PetscErrorCode MatCreateRedundantMatrix(Mat,PetscInt,MPI_Comm,MatReuse,Mat*);
608: PETSC_EXTERN PetscErrorCode MatGetMultiProcBlock(Mat,MPI_Comm,MatReuse,Mat*);
609: PETSC_EXTERN PetscErrorCode MatFindZeroDiagonals(Mat,IS*);
610: PETSC_EXTERN PetscErrorCode MatFindOffBlockDiagonalEntries(Mat,IS*);
611: PETSC_EXTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);

613: /*MC
614:    MatSetValue - Set a single entry into a matrix.

616:    Not collective

618:    Synopsis:
619:      #include <petscmat.h>
620:      PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode)

622:    Input Parameters:
623: +  m - the matrix
624: .  row - the row location of the entry
625: .  col - the column location of the entry
626: .  value - the value to insert
627: -  mode - either INSERT_VALUES or ADD_VALUES

629:    Notes:
630:    For efficiency one should use MatSetValues() and set several or many
631:    values simultaneously if possible.

633:    Level: beginner

635: .seealso: MatSetValues(), MatSetValueLocal()
636: M*/
637: PETSC_STATIC_INLINE PetscErrorCode MatSetValue(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValues(v,1,&i,1,&j,&va,mode);}

639: PETSC_STATIC_INLINE PetscErrorCode MatGetValue(Mat v,PetscInt i,PetscInt j,PetscScalar *va) {return MatGetValues(v,1,&i,1,&j,va);}

641: PETSC_STATIC_INLINE PetscErrorCode MatSetValueLocal(Mat v,PetscInt i,PetscInt j,PetscScalar va,InsertMode mode) {return MatSetValuesLocal(v,1,&i,1,&j,&va,mode);}

643: /*MC
644:    MatPreallocateInitialize - Begins the block of code that will count the number of nonzeros per
645:        row in a matrix providing the data that one can use to correctly preallocate the matrix.

647:    Synopsis:
648:    #include <petscmat.h>
649:    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)

651:    Collective on MPI_Comm

653:    Input Parameters:
654: +  comm - the communicator that will share the eventually allocated matrix
655: .  nrows - the number of LOCAL rows in the matrix
656: -  ncols - the number of LOCAL columns in the matrix

658:    Output Parameters:
659: +  dnz - the array that will be passed to the matrix preallocation routines
660: -  ozn - the other array passed to the matrix preallocation routines

662:    Level: intermediate

664:    Notes:
665:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

667:    Do not malloc or free dnz and onz, that is handled internally by these routines

669:    Use MatPreallocateInitializeSymmetric() for symmetric matrices (MPISBAIJ matrices)

671:    This is a MACRO not a function because it has a leading { that is closed by PetscPreallocateFinalize().

673:   Concepts: preallocation^Matrix

675: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
676:           MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocalBlock()
677: M*/
678: #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
679: { \
680:   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__start,__end; \
681:   _4_PetscCalloc2((size_t)__nrows,&dnz,(size_t)__nrows,&onz);CHKERRQ(_4_ierr); \
682:   __start = 0; __end = __start;                                         \
683:   _4_MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\
684:   _4_MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;

686: /*MC
687:    MatPreallocateSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
688:        inserted using a local number of the rows and columns

690:    Synopsis:
691:    #include <petscmat.h>
692:    PetscErrorCode MatPreallocateSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

694:    Not Collective

696:    Input Parameters:
697: +  map - the row mapping from local numbering to global numbering
698: .  nrows - the number of rows indicated
699: .  rows - the indices of the rows
700: .  cmap - the column mapping from local to global numbering
701: .  ncols - the number of columns in the matrix
702: .  cols - the columns indicated
703: .  dnz - the array that will be passed to the matrix preallocation routines
704: -  ozn - the other array passed to the matrix preallocation routines

706:    Level: intermediate

708:    Notes:
709:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

711:    Do not malloc or free dnz and onz, that is handled internally by these routines

713:   Concepts: preallocation^Matrix

715: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateInitialize(),
716:           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocalRemoveDups()
717: M*/
718: #define MatPreallocateSetLocal(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
719: {\
720:   PetscInt __l;\
721:   _4_ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
722:   _4_ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
723:   for (__l=0;__l<nrows;__l++) {\
724:     _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
725:   }\
726: }

728: /*MC
729:    MatPreallocateSetLocalRemoveDups - Indicates the locations (rows and columns) in the matrix where nonzeros will be
730:        inserted using a local number of the rows and columns. This version removes any duplicate columns in cols

732:    Synopsis:
733:    #include <petscmat.h>
734:    PetscErrorCode MatPreallocateSetLocalRemoveDups(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

736:    Not Collective

738:    Input Parameters:
739: +  map - the row mapping from local numbering to global numbering
740: .  nrows - the number of rows indicated
741: .  rows - the indices of the rows (these values are mapped to the global values)
742: .  cmap - the column mapping from local to global numbering
743: .  ncols - the number of columns in the matrix   (this value will be changed if duplicate columns are found)
744: .  cols - the columns indicated (these values are mapped to the global values, they are then sorted and duplicates removed)
745: .  dnz - the array that will be passed to the matrix preallocation routines
746: -  ozn - the other array passed to the matrix preallocation routines

748:    Level: intermediate

750:    Notes:
751:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

753:    Do not malloc or free dnz and onz, that is handled internally by these routines

755:   Concepts: preallocation^Matrix

757: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateInitialize(),
758:           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal()
759: M*/
760: #define MatPreallocateSetLocalRemoveDups(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
761: {\
762:   PetscInt __l;\
763:   _4_ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
764:   _4_ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
765:   _4_PetscSortRemoveDupsInt(&ncols,cols);CHKERRQ(_4_ierr);\
766:   for (__l=0;__l<nrows;__l++) {\
767:     _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
768:   }\
769: }

771: /*MC
772:    MatPreallocateSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
773:        inserted using a local number of the rows and columns

775:    Synopsis:
776:    #include <petscmat.h>
777:    PetscErrorCode MatPreallocateSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

779:    Not Collective

781:    Input Parameters:
782: +  map - the row mapping from local numbering to global numbering
783: .  nrows - the number of rows indicated
784: .  rows - the indices of the rows
785: .  cmap - the column mapping from local to global numbering
786: .  ncols - the number of columns in the matrix
787: .  cols - the columns indicated
788: .  dnz - the array that will be passed to the matrix preallocation routines
789: -  ozn - the other array passed to the matrix preallocation routines

791:    Level: intermediate

793:    Notes:
794:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

796:    Do not malloc or free dnz and onz, that is handled internally by these routines

798:   Concepts: preallocation^Matrix

800: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateInitialize(),
801:           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock()
802: M*/
803: #define MatPreallocateSetLocalBlock(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
804: {\
805:   PetscInt __l;\
806:   _4_ISLocalToGlobalMappingApplyBlock(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
807:   _4_ISLocalToGlobalMappingApplyBlock(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
808:   for (__l=0;__l<nrows;__l++) {\
809:     _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
810:   }\
811: }

813: /*MC
814:    MatPreallocateSymmetricSetLocalBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
815:        inserted using a local number of the rows and columns

817:    Synopsis:
818:    #include <petscmat.h>
819:    PetscErrorCode MatPreallocateSymmetricSetLocalBlock(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

821:    Not Collective

823:    Input Parameters:
824: +  map - the mapping between local numbering and global numbering
825: .  nrows - the number of rows indicated
826: .  rows - the indices of the rows
827: .  ncols - the number of columns in the matrix
828: .  cols - the columns indicated
829: .  dnz - the array that will be passed to the matrix preallocation routines
830: -  ozn - the other array passed to the matrix preallocation routines

832:    Level: intermediate

834:    Notes:
835:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

837:    Do not malloc or free dnz and onz that is handled internally by these routines

839:   Concepts: preallocation^Matrix

841: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateInitialize(),
842:           MatPreallocateInitialize(),  MatPreallocateSetLocal()
843: M*/
844: #define MatPreallocateSymmetricSetLocalBlock(map,nrows,rows,ncols,cols,dnz,onz) 0;\
845: {\
846:   PetscInt __l;\
847:   _4_ISLocalToGlobalMappingApplyBlock(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
848:   _4_ISLocalToGlobalMappingApplyBlock(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
849:   for (__l=0;__l<nrows;__l++) {\
850:     _4_MatPreallocateSymmetricSetBlock((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
851:   }\
852: }
853: /*MC
854:    MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
855:        inserted using a local number of the rows and columns

857:    Synopsis:
858:    #include <petscmat.h>
859:    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

861:    Not Collective

863:    Input Parameters:
864: +  row - the row
865: .  ncols - the number of columns in the matrix
866: -  cols - the columns indicated

868:    Output Parameters:
869: +  dnz - the array that will be passed to the matrix preallocation routines
870: -  ozn - the other array passed to the matrix preallocation routines

872:    Level: intermediate

874:    Notes:
875:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

877:    Do not malloc or free dnz and onz that is handled internally by these routines

879:    This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().

881:   Concepts: preallocation^Matrix

883: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateInitialize(),
884:           MatPreallocateInitialize(), MatPreallocateSetLocal()
885: M*/
886: #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
887: { PetscInt __i; \
888:   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);\
889:   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);\
890:   for (__i=0; __i<nc; __i++) {\
891:     if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
892:     else dnz[row - __rstart]++;\
893:   }\
894: }

896: /*MC
897:    MatPreallocateSymmetricSetBlock - Indicates the locations (rows and columns) in the matrix where nonzeros will be
898:        inserted using a local number of the rows and columns

900:    Synopsis:
901:    #include <petscmat.h>
902:    PetscErrorCode MatPreallocateSymmetricSetBlock(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

904:    Not Collective

906:    Input Parameters:
907: +  nrows - the number of rows indicated
908: .  rows - the indices of the rows
909: .  ncols - the number of columns in the matrix
910: .  cols - the columns indicated
911: .  dnz - the array that will be passed to the matrix preallocation routines
912: -  ozn - the other array passed to the matrix preallocation routines

914:    Level: intermediate

916:    Notes:
917:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

919:    Do not malloc or free dnz and onz that is handled internally by these routines

921:    This is a MACRO not a function because it uses variables declared in MatPreallocateInitialize().

923:   Concepts: preallocation^Matrix

925: .seealso: MatPreallocateFinalize(), MatPreallocateSet(),  MatPreallocateInitialize(),
926:           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal()
927: M*/
928: #define MatPreallocateSymmetricSetBlock(row,nc,cols,dnz,onz) 0;\
929: { PetscInt __i; \
930:   for (__i=0; __i<nc; __i++) {\
931:     if (cols[__i] >= __end) onz[row - __rstart]++; \
932:     else if (cols[__i] >= row) dnz[row - __rstart]++;\
933:   }\
934: }

936: /*MC
937:    MatPreallocateLocation -  An alternative to MatPreallocationSet() that puts the nonzero locations into the matrix if it exists

939:    Synopsis:
940:    #include <petscmat.h>
941:    PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)

943:    Not Collective

945:    Input Parameters:
946: .  A - matrix
947: .  row - row where values exist (must be local to this process)
948: .  ncols - number of columns
949: .  cols - columns with nonzeros
950: .  dnz - the array that will be passed to the matrix preallocation routines
951: -  ozn - the other array passed to the matrix preallocation routines

953:    Level: intermediate

955:    Notes:
956:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

958:    Do not malloc or free dnz and onz that is handled internally by these routines

960:    This is a MACRO not a function because it uses a bunch of variables private to the MatPreallocation.... routines.

962:   Concepts: preallocation^Matrix

964: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
965:           MatPreallocateSymmetricSetLocalBlock()
966: M*/
967: #define MatPreallocateLocation(A,row,ncols,cols,dnz,onz) 0;if (A) {MatSetValues(A,1,&row,ncols,cols,NULL,INSERT_VALUES);} else { MatPreallocateSet(row,ncols,cols,dnz,onz);}


970: /*MC
971:    MatPreallocateFinalize - Ends the block of code that will count the number of nonzeros per
972:        row in a matrix providing the data that one can use to correctly preallocate the matrix.

974:    Synopsis:
975:    #include <petscmat.h>
976:    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)

978:    Collective on MPI_Comm

980:    Input Parameters:
981: +  dnz - the array that was be passed to the matrix preallocation routines
982: -  ozn - the other array passed to the matrix preallocation routines

984:    Level: intermediate

986:    Notes:
987:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

989:    Do not malloc or free dnz and onz that is handled internally by these routines

991:    This is a MACRO not a function because it closes the { started in MatPreallocateInitialize().

993:   Concepts: preallocation^Matrix

995: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
996:           MatPreallocateSymmetricSetLocalBlock()
997: M*/
998: #define MatPreallocateFinalize(dnz,onz) 0;_4_PetscFree2(dnz,onz);CHKERRQ(_4_ierr);}

1000: /* Routines unique to particular data structures */
1001: PETSC_EXTERN PetscErrorCode MatShellGetContext(Mat,void *);

1003: PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*);
1004: PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);

1006: PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
1007: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
1008: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1009: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1010: PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1011: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*,PetscInt,PetscBool);

1013: #define MAT_SKIP_ALLOCATION -4

1015: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1016: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1017: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);

1019: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1020: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1021: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1022: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
1023: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1024: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
1025: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1026: PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
1027: PETSC_EXTERN PetscErrorCode MatMPIAdjToSeq(Mat,Mat*);
1028: PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
1029: PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
1030: PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
1031: PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
1032: PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat,Mat*);

1034: PETSC_EXTERN PetscErrorCode MatISSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1035: PETSC_EXTERN PetscErrorCode MatISSetUpSF(Mat);
1036: PETSC_EXTERN PetscErrorCode MatSeqDenseSetLDA(Mat,PetscInt);
1037: PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*);

1039: PETSC_EXTERN PetscErrorCode MatStoreValues(Mat);
1040: PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat);

1042: PETSC_EXTERN PetscErrorCode MatDAADSetCtx(Mat,void*);

1044: PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat,IS*);
1045: PETSC_EXTERN PetscErrorCode MatFindZeroRows(Mat,IS*);
1046: /*
1047:   These routines are not usually accessed directly, rather solving is
1048:   done through the KSP and PC interfaces.
1049: */

1051: /*J
1052:     MatOrderingType - String with the name of a PETSc matrix ordering

1054:    Level: beginner

1056: .seealso: MatGetOrdering()
1057: J*/
1058: typedef const char* MatOrderingType;
1059: #define MATORDERINGNATURAL     "natural"
1060: #define MATORDERINGND          "nd"
1061: #define MATORDERING1WD         "1wd"
1062: #define MATORDERINGRCM         "rcm"
1063: #define MATORDERINGQMD         "qmd"
1064: #define MATORDERINGROWLENGTH   "rowlength"
1065: #define MATORDERINGWBM         "wbm"
1066: #define MATORDERINGSPECTRAL    "spectral"
1067: #define MATORDERINGAMD         "amd"            /* only works if UMFPACK is installed with PETSc */

1069: PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat,MatOrderingType,IS*,IS*);
1070: PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFunctionList*);
1071: PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[],PetscErrorCode(*)(Mat,MatOrderingType,IS*,IS*));
1072: PETSC_EXTERN PetscFunctionList MatOrderingList;

1074: PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
1075: PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat,PetscReal,PetscBool,Mat*);

1077: /*S
1078:     MatFactorShiftType - Numeric Shift.

1080:    Level: beginner

1082: S*/
1083: typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType;
1084: PETSC_EXTERN const char *const MatFactorShiftTypes[];
1085: PETSC_EXTERN const char *const MatFactorShiftTypesDetail[];

1087: /*S
1088:     MatFactorError - indicates what type of error in matrix factor

1090:     Level: beginner

1092:     Developer Notes:
1093:     Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h

1095: .seealso: MatGetFactor()
1096: S*/
1097: typedef enum {MAT_FACTOR_NOERROR,MAT_FACTOR_STRUCT_ZEROPIVOT,MAT_FACTOR_NUMERIC_ZEROPIVOT,MAT_FACTOR_OUTMEMORY,MAT_FACTOR_OTHER} MatFactorError;

1099: PETSC_EXTERN PetscErrorCode MatFactorGetError(Mat,MatFactorError*);
1100: PETSC_EXTERN PetscErrorCode MatFactorClearError(Mat);
1101: PETSC_EXTERN PetscErrorCode MatFactorGetErrorZeroPivot(Mat,PetscReal*,PetscInt*);

1103: /*S
1104:    MatFactorInfo - Data passed into the matrix factorization routines, and information about the resulting factorization

1106:    In Fortran these are simply double precision arrays of size MAT_FACTORINFO_SIZE, that is use
1107: $     MatFactorInfo  info(MAT_FACTORINFO_SIZE)

1109:    Notes:
1110:     These are not usually directly used by users, instead use PC type of LU, ILU, CHOLESKY or ICC.

1112:       You can use MatFactorInfoInitialize() to set default values.

1114:    Level: developer

1116: .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
1117:           MatFactorInfoInitialize()

1119: S*/
1120: typedef struct {
1121:   PetscReal     diagonal_fill;  /* force diagonal to fill in if initially not filled */
1122:   PetscReal     usedt;
1123:   PetscReal     dt;             /* drop tolerance */
1124:   PetscReal     dtcol;          /* tolerance for pivoting */
1125:   PetscReal     dtcount;        /* maximum nonzeros to be allowed per row */
1126:   PetscReal     fill;           /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1127:   PetscReal     levels;         /* ICC/ILU(levels) */
1128:   PetscReal     pivotinblocks;  /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1129:                                    factorization may be faster if do not pivot */
1130:   PetscReal     zeropivot;      /* pivot is called zero if less than this */
1131:   PetscReal     shifttype;      /* type of shift added to matrix factor to prevent zero pivots */
1132:   PetscReal     shiftamount;     /* how large the shift is */
1133: } MatFactorInfo;

1135: PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*);
1136: PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*);
1137: PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1138: PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*);
1139: PETSC_EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*);
1140: PETSC_EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*);
1141: PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1142: PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1143: PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1144: PETSC_EXTERN PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*);
1145: PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*);
1146: PETSC_EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1147: PETSC_EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec);
1148: PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec);
1149: PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec);
1150: PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec);
1151: PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec);
1152: PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1153: PETSC_EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs);
1154: PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat);

1156: typedef enum {MAT_FACTOR_SCHUR_UNFACTORED, MAT_FACTOR_SCHUR_FACTORED, MAT_FACTOR_SCHUR_INVERTED} MatFactorSchurStatus;
1157: PETSC_EXTERN PetscErrorCode MatFactorSetSchurIS(Mat,IS);
1158: PETSC_EXTERN PetscErrorCode MatFactorGetSchurComplement(Mat,Mat*,MatFactorSchurStatus*);
1159: PETSC_EXTERN PetscErrorCode MatFactorRestoreSchurComplement(Mat,Mat*,MatFactorSchurStatus);
1160: PETSC_EXTERN PetscErrorCode MatFactorInvertSchurComplement(Mat);
1161: PETSC_EXTERN PetscErrorCode MatFactorCreateSchurComplement(Mat,Mat*,MatFactorSchurStatus*);
1162: PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplement(Mat,Vec,Vec);
1163: PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplementTranspose(Mat,Vec,Vec);
1164: PETSC_EXTERN PetscErrorCode MatFactorFactorizeSchurComplement(Mat);

1166: /*E
1167:     MatSORType - What type of (S)SOR to perform

1169:     Level: beginner

1171:    May be bitwise ORd together

1173:    Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h

1175:    MatSORType may be bitwise ORd together, so do not change the numbers

1177: .seealso: MatSOR()
1178: E*/
1179: typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1180:               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1181:               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
1182:               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1183: PETSC_EXTERN PetscErrorCode MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);

1185: /*
1186:     These routines are for efficiently computing Jacobians via finite differences.
1187: */

1189: /*S
1190:      MatColoring - Object for managing the coloring of matrices.

1192:    Level: beginner

1194:   Concepts: matrix, coloring

1196: .seealso:  MatFDColoringCreate() ISColoring MatFDColoring
1197: S*/
1198: typedef struct _p_MatColoring* MatColoring;
1199: /*J
1200:     MatColoringType - String with the name of a PETSc matrix coloring

1202:    Level: beginner

1204: .seealso: MatColoringSetType(), MatColoring
1205: J*/

1207: typedef const  char*           MatColoringType;
1208: #define MATCOLORINGJP      "jp"
1209: #define MATCOLORINGPOWER   "power"
1210: #define MATCOLORINGNATURAL "natural"
1211: #define MATCOLORINGSL      "sl"
1212: #define MATCOLORINGLF      "lf"
1213: #define MATCOLORINGID      "id"
1214: #define MATCOLORINGGREEDY  "greedy"

1216: /*E
1217:    MatColoringWeightType - Type of weight scheme

1219:     Not Collective

1221: +   MAT_COLORING_RANDOM  - Random weights
1222: .   MAT_COLORING_LEXICAL - Lexical weighting based upon global numbering.
1223: -   MAT_COLORING_LF      - Last-first weighting.

1225:     Level: intermediate

1227:    Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h
1228: E*/
1229: typedef enum {MAT_COLORING_WEIGHT_RANDOM,MAT_COLORING_WEIGHT_LEXICAL,MAT_COLORING_WEIGHT_LF,MAT_COLORING_WEIGHT_SL} MatColoringWeightType;

1231: PETSC_EXTERN PetscErrorCode MatColoringCreate(Mat,MatColoring*);
1232: PETSC_EXTERN PetscErrorCode MatColoringGetDegrees(Mat,PetscInt,PetscInt*);
1233: PETSC_EXTERN PetscErrorCode MatColoringDestroy(MatColoring*);
1234: PETSC_EXTERN PetscErrorCode MatColoringView(MatColoring,PetscViewer);
1235: PETSC_EXTERN PetscErrorCode MatColoringSetType(MatColoring,MatColoringType);
1236: PETSC_EXTERN PetscErrorCode MatColoringSetFromOptions(MatColoring);
1237: PETSC_EXTERN PetscErrorCode MatColoringSetDistance(MatColoring,PetscInt);
1238: PETSC_EXTERN PetscErrorCode MatColoringGetDistance(MatColoring,PetscInt*);
1239: PETSC_EXTERN PetscErrorCode MatColoringSetMaxColors(MatColoring,PetscInt);
1240: PETSC_EXTERN PetscErrorCode MatColoringGetMaxColors(MatColoring,PetscInt*);
1241: PETSC_EXTERN PetscErrorCode MatColoringApply(MatColoring,ISColoring*);
1242: PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[],PetscErrorCode(*)(MatColoring));
1243: PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1244: PETSC_EXTERN PetscErrorCode MatColoringSetWeightType(MatColoring,MatColoringWeightType);
1245: PETSC_EXTERN PetscErrorCode MatColoringSetWeights(MatColoring,PetscReal*,PetscInt*);
1246: PETSC_EXTERN PetscErrorCode MatColoringCreateWeights(MatColoring,PetscReal **,PetscInt **lperm);
1247: PETSC_EXTERN PetscErrorCode MatColoringTest(MatColoring,ISColoring);
1248: PETSC_EXTERN PetscErrorCode MatISColoringTest(Mat,ISColoring);

1250: /*S
1251:      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1252:         and coloring

1254:    Level: beginner

1256:   Concepts: coloring, sparse Jacobian, finite differences

1258: .seealso:  MatFDColoringCreate()
1259: S*/
1260: typedef struct _p_MatFDColoring* MatFDColoring;

1262: PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1263: PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring*);
1264: PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer);
1265: PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
1266: PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1267: PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1268: PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring);
1269: PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,void *);
1270: PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec);
1271: PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,const PetscInt*[]);
1272: PETSC_EXTERN PetscErrorCode MatFDColoringSetUp(Mat,ISColoring,MatFDColoring);
1273: PETSC_EXTERN PetscErrorCode MatFDColoringSetBlockSize(MatFDColoring,PetscInt,PetscInt);


1276: /*S
1277:      MatTransposeColoring - Object for computing a sparse matrix product C=A*B^T via coloring

1279:    Level: beginner

1281:   Concepts: coloring, sparse matrix product

1283: .seealso:  MatTransposeColoringCreate()
1284: S*/
1285: typedef struct _p_MatTransposeColoring* MatTransposeColoring;

1287: PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat,ISColoring,MatTransposeColoring *);
1288: PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring,Mat,Mat);
1289: PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring,Mat,Mat);
1290: PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring*);

1292: /*
1293:     These routines are for partitioning matrices: currently used only
1294:   for adjacency matrix, MatCreateMPIAdj().
1295: */

1297: /*S
1298:      MatPartitioning - Object for managing the partitioning of a matrix or graph

1300:    Level: beginner

1302:   Concepts: partitioning

1304: .seealso:  MatPartitioningCreate(), MatPartitioningType
1305: S*/
1306: typedef struct _p_MatPartitioning* MatPartitioning;

1308: /*J
1309:     MatPartitioningType - String with the name of a PETSc matrix partitioning

1311:    Level: beginner
1312: dm
1313: .seealso: MatPartitioningCreate(), MatPartitioning
1314: J*/
1315: typedef const char* MatPartitioningType;
1316: #define MATPARTITIONINGCURRENT  "current"
1317: #define MATPARTITIONINGAVERAGE   "average"
1318: #define MATPARTITIONINGSQUARE   "square"
1319: #define MATPARTITIONINGPARMETIS "parmetis"
1320: #define MATPARTITIONINGCHACO    "chaco"
1321: #define MATPARTITIONINGPARTY    "party"
1322: #define MATPARTITIONINGPTSCOTCH "ptscotch"
1323: #define MATPARTITIONINGHIERARCH  "hierarch"


1326: PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1327: PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,MatPartitioningType);
1328: PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt);
1329: PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat);
1330: PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1331: PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1332: PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*);
1333: PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning*);

1335: PETSC_EXTERN PetscErrorCode MatPartitioningRegister(const char[],PetscErrorCode (*)(MatPartitioning));



1339: PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer);
1340: PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning);
1341: PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,MatPartitioningType*);

1343: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetRepartition(MatPartitioning part);
1344: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
1345: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);

1347: typedef enum { MP_CHACO_MULTILEVEL=1,MP_CHACO_SPECTRAL=2,MP_CHACO_LINEAR=4,MP_CHACO_RANDOM=5,MP_CHACO_SCATTERED=6 } MPChacoGlobalType;
1348: PETSC_EXTERN const char *const MPChacoGlobalTypes[];
1349: typedef enum { MP_CHACO_KERNIGHAN=1,MP_CHACO_NONE=2 } MPChacoLocalType;
1350: PETSC_EXTERN const char *const MPChacoLocalTypes[];
1351: typedef enum { MP_CHACO_LANCZOS=0,MP_CHACO_RQI=1 } MPChacoEigenType;
1352: PETSC_EXTERN const char *const MPChacoEigenTypes[];

1354: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning,MPChacoGlobalType);
1355: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning,MPChacoGlobalType*);
1356: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning,MPChacoLocalType);
1357: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning,MPChacoLocalType*);
1358: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
1359: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1360: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning,MPChacoEigenType*);
1361: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning,PetscReal);
1362: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning,PetscReal*);
1363: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning,PetscInt);
1364: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning,PetscInt*);

1366: #define MP_PARTY_OPT "opt"
1367: #define MP_PARTY_LIN "lin"
1368: #define MP_PARTY_SCA "sca"
1369: #define MP_PARTY_RAN "ran"
1370: #define MP_PARTY_GBF "gbf"
1371: #define MP_PARTY_GCF "gcf"
1372: #define MP_PARTY_BUB "bub"
1373: #define MP_PARTY_DEF "def"
1374: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning,const char*);
1375: #define MP_PARTY_HELPFUL_SETS "hs"
1376: #define MP_PARTY_KERNIGHAN_LIN "kl"
1377: #define MP_PARTY_NONE "no"
1378: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning,const char*);
1379: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1380: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscBool);
1381: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool);

1383: typedef enum { MP_PTSCOTCH_DEFAULT,MP_PTSCOTCH_QUALITY,MP_PTSCOTCH_SPEED,MP_PTSCOTCH_BALANCE,MP_PTSCOTCH_SAFETY,MP_PTSCOTCH_SCALABILITY } MPPTScotchStrategyType;
1384: PETSC_EXTERN const char *const MPPTScotchStrategyTypes[];

1386: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal);
1387: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*);
1388: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType);
1389: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*);

1391: /*
1392:  * hierarchical partitioning
1393:  */
1394: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetFineparts(MatPartitioning,IS*);
1395: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetCoarseparts(MatPartitioning,IS*);
1396: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNcoarseparts(MatPartitioning,PetscInt);
1397: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNfineparts(MatPartitioning, PetscInt);

1399: PETSC_EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*);
1400: PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*);

1402: /*
1403:     If you add entries here you must also add them to petsc/finclude/petscmat.h
1404: */
1405: typedef enum { MATOP_SET_VALUES=0,
1406:                MATOP_GET_ROW=1,
1407:                MATOP_RESTORE_ROW=2,
1408:                MATOP_MULT=3,
1409:                MATOP_MULT_ADD=4,
1410:                MATOP_MULT_TRANSPOSE=5,
1411:                MATOP_MULT_TRANSPOSE_ADD=6,
1412:                MATOP_SOLVE=7,
1413:                MATOP_SOLVE_ADD=8,
1414:                MATOP_SOLVE_TRANSPOSE=9,
1415:                MATOP_SOLVE_TRANSPOSE_ADD=10,
1416:                MATOP_LUFACTOR=11,
1417:                MATOP_CHOLESKYFACTOR=12,
1418:                MATOP_SOR=13,
1419:                MATOP_TRANSPOSE=14,
1420:                MATOP_GETINFO=15,
1421:                MATOP_EQUAL=16,
1422:                MATOP_GET_DIAGONAL=17,
1423:                MATOP_DIAGONAL_SCALE=18,
1424:                MATOP_NORM=19,
1425:                MATOP_ASSEMBLY_BEGIN=20,
1426:                MATOP_ASSEMBLY_END=21,
1427:                MATOP_SET_OPTION=22,
1428:                MATOP_ZERO_ENTRIES=23,
1429:                MATOP_ZERO_ROWS=24,
1430:                MATOP_LUFACTOR_SYMBOLIC=25,
1431:                MATOP_LUFACTOR_NUMERIC=26,
1432:                MATOP_CHOLESKY_FACTOR_SYMBOLIC=27,
1433:                MATOP_CHOLESKY_FACTOR_NUMERIC=28,
1434:                MATOP_SETUP_PREALLOCATION=29,
1435:                MATOP_ILUFACTOR_SYMBOLIC=30,
1436:                MATOP_ICCFACTOR_SYMBOLIC=31,
1437:                MATOP_GET_DIAGONAL_BLOCK=32,
1438:                /* MATOP_PLACEHOLDER_33=33, */
1439:                MATOP_DUPLICATE=34,
1440:                MATOP_FORWARD_SOLVE=35,
1441:                MATOP_BACKWARD_SOLVE=36,
1442:                MATOP_ILUFACTOR=37,
1443:                MATOP_ICCFACTOR=38,
1444:                MATOP_AXPY=39,
1445:                MATOP_CREATE_SUBMATRICES=40,
1446:                MATOP_INCREASE_OVERLAP=41,
1447:                MATOP_GET_VALUES=42,
1448:                MATOP_COPY=43,
1449:                MATOP_GET_ROW_MAX=44,
1450:                MATOP_SCALE=45,
1451:                MATOP_SHIFT=46,
1452:                MATOP_DIAGONAL_SET=47,
1453:                MATOP_ZERO_ROWS_COLUMNS=48,
1454:                MATOP_SET_RANDOM=49,
1455:                MATOP_GET_ROW_IJ=50,
1456:                MATOP_RESTORE_ROW_IJ=51,
1457:                MATOP_GET_COLUMN_IJ=52,
1458:                MATOP_RESTORE_COLUMN_IJ=53,
1459:                MATOP_FDCOLORING_CREATE=54,
1460:                MATOP_COLORING_PATCH=55,
1461:                MATOP_SET_UNFACTORED=56,
1462:                MATOP_PERMUTE=57,
1463:                MATOP_SET_VALUES_BLOCKED=58,
1464:                MATOP_CREATE_SUBMATRIX=59,
1465:                MATOP_DESTROY=60,
1466:                MATOP_VIEW=61,
1467:                MATOP_CONVERT_FROM=62,
1468:                MATOP_MATMAT_MULT=63,
1469:                MATOP_MATMAT_MULT_SYMBOLIC=64,
1470:                MATOP_MATMAT_MULT_NUMERIC=65,
1471:                MATOP_SET_LOCAL_TO_GLOBAL_MAP=66,
1472:                MATOP_SET_VALUES_LOCAL=67,
1473:                MATOP_ZERO_ROWS_LOCAL=68,
1474:                MATOP_GET_ROW_MAX_ABS=69,
1475:                MATOP_GET_ROW_MIN_ABS=70,
1476:                MATOP_CONVERT=71,
1477:                MATOP_SET_COLORING=72,
1478:                /* MATOP_PLACEHOLDER_73=73, */
1479:                MATOP_SET_VALUES_ADIFOR=74,
1480:                MATOP_FD_COLORING_APPLY=75,
1481:                MATOP_SET_FROM_OPTIONS=76,
1482:                MATOP_MULT_CONSTRAINED=77,
1483:                MATOP_MULT_TRANSPOSE_CONSTRAIN=78,
1484:                MATOP_FIND_ZERO_DIAGONALS=79,
1485:                MATOP_MULT_MULTIPLE=80,
1486:                MATOP_SOLVE_MULTIPLE=81,
1487:                MATOP_GET_INERTIA=82,
1488:                MATOP_LOAD=83,
1489:                MATOP_IS_SYMMETRIC=84,
1490:                MATOP_IS_HERMITIAN=85,
1491:                MATOP_IS_STRUCTURALLY_SYMMETRIC=86,
1492:                MATOP_SET_VALUES_BLOCKEDLOCAL=87,
1493:                MATOP_CREATE_VECS=88,
1494:                MATOP_MAT_MULT=89,
1495:                MATOP_MAT_MULT_SYMBOLIC=90,
1496:                MATOP_MAT_MULT_NUMERIC=91,
1497:                MATOP_PTAP=92,
1498:                MATOP_PTAP_SYMBOLIC=93,
1499:                MATOP_PTAP_NUMERIC=94,
1500:                MATOP_MAT_TRANSPOSE_MULT=95,
1501:                MATOP_MAT_TRANSPOSE_MULT_SYMBO=96,
1502:                MATOP_MAT_TRANSPOSE_MULT_NUMER=97,
1503:                /* MATOP_PLACEHOLDER_98=98, */
1504:                /* MATOP_PLACEHOLDER_99=99, */
1505:                /* MATOP_PLACEHOLDER_100=100, */
1506:                /* MATOP_PLACEHOLDER_101=101, */
1507:                MATOP_CONJUGATE=102,
1508:                /* MATOP_PLACEHOLDER_103=103, */
1509:                MATOP_SET_VALUES_ROW=104,
1510:                MATOP_REAL_PART=105,
1511:                MATOP_IMAGINARY_PART=106,
1512:                MATOP_GET_ROW_UPPER_TRIANGULAR=107,
1513:                MATOP_RESTORE_ROW_UPPER_TRIANG=108,
1514:                MATOP_MAT_SOLVE=109,
1515:                MATOP_MAT_SOLVE_TRANSPOSE=110,
1516:                MATOP_GET_ROW_MIN=111,
1517:                MATOP_GET_COLUMN_VECTOR=112,
1518:                MATOP_MISSING_DIAGONAL=113,
1519:                MATOP_GET_SEQ_NONZERO_STRUCTUR=114,
1520:                MATOP_CREATE=115,
1521:                MATOP_GET_GHOSTS=116,
1522:                MATOP_GET_LOCAL_SUB_MATRIX=117,
1523:                MATOP_RESTORE_LOCALSUB_MATRIX=118,
1524:                MATOP_MULT_DIAGONAL_BLOCK=119,
1525:                MATOP_HERMITIAN_TRANSPOSE=120,
1526:                MATOP_MULT_HERMITIAN_TRANSPOSE=121,
1527:                MATOP_MULT_HERMITIAN_TRANS_ADD=122,
1528:                MATOP_GET_MULTI_PROC_BLOCK=123,
1529:                MATOP_FIND_NONZERO_ROWS=124,
1530:                MATOP_GET_COLUMN_NORMS=125,
1531:                MATOP_INVERT_BLOCK_DIAGONAL=126,
1532:                /* MATOP_PLACEHOLDER_127=127, */
1533:                MATOP_CREATE_SUB_MATRICES_MPI=128,
1534:                MATOP_SET_VALUES_BATCH=129,
1535:                MATOP_TRANSPOSE_MAT_MULT=130,
1536:                MATOP_TRANSPOSE_MAT_MULT_SYMBO=131,
1537:                MATOP_TRANSPOSE_MAT_MULT_NUMER=132,
1538:                MATOP_TRANSPOSE_COLORING_CREAT=133,
1539:                MATOP_TRANS_COLORING_APPLY_SPT=134,
1540:                MATOP_TRANS_COLORING_APPLY_DEN=135,
1541:                MATOP_RART=136,
1542:                MATOP_RART_SYMBOLIC=137,
1543:                MATOP_RART_NUMERIC=138,
1544:                MATOP_SET_BLOCK_SIZES=139,
1545:                MATOP_AYPX=140,
1546:                MATOP_RESIDUAL=141,
1547:                MATOP_FDCOLORING_SETUP=142,
1548:                MATOP_MPICONCATENATESEQ=144,
1549:                MATOP_DESTROYSUBMATRICES=145
1550:              } MatOperation;
1551: PETSC_EXTERN PetscErrorCode MatSetOperation(Mat,MatOperation,void(*)(void));
1552: PETSC_EXTERN PetscErrorCode MatGetOperation(Mat,MatOperation,void(**)(void));
1553: PETSC_EXTERN PetscErrorCode MatHasOperation(Mat,MatOperation,PetscBool *);

1555: PETSC_EXTERN PetscErrorCode MatShellSetOperation(Mat,MatOperation,void(*)(void));
1556: PETSC_EXTERN PetscErrorCode MatShellGetOperation(Mat,MatOperation,void(**)(void));
1557: PETSC_EXTERN PetscErrorCode MatShellSetContext(Mat,void*);
1558: PETSC_EXTERN PetscErrorCode MatShellTestMult(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*);
1559: PETSC_EXTERN PetscErrorCode MatShellTestMultTranspose(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*);
1560: PETSC_EXTERN PetscErrorCode MatShellSetManageScalingShifts(Mat);

1562: /*
1563:    Codes for matrices stored on disk. By default they are
1564:    stored in a universal format. By changing the format with
1565:    PetscViewerPushFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
1566:    be stored in a way natural for the matrix, for example dense matrices
1567:    would be stored as dense. Matrices stored this way may only be
1568:    read into matrices of the same type.
1569: */
1570: #define MATRIX_BINARY_FORMAT_DENSE -1

1572: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1573: PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*);
1574: PETSC_EXTERN PetscErrorCode MatISRestoreLocalMat(Mat,Mat*);
1575: PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat,Mat);
1576: PETSC_EXTERN PetscErrorCode MatISGetMPIXAIJ(Mat,MatReuse,Mat*);

1578: /*S
1579:      MatNullSpace - Object that removes a null space from a vector, i.e.
1580:          orthogonalizes the vector to a subsapce

1582:    Level: advanced

1584:   Concepts: matrix; linear operator, null space

1586:   Users manual sections:
1587: .   Section 4.19 Solving Singular Systems

1589: .seealso:  MatNullSpaceCreate()
1590: S*/
1591: typedef struct _p_MatNullSpace* MatNullSpace;

1593: PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*);
1594: PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*);
1595: PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace*);
1596: PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec);
1597: PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *);
1598: PETSC_EXTERN PetscErrorCode MatGetTransposeNullSpace(Mat, MatNullSpace *);
1599: PETSC_EXTERN PetscErrorCode MatSetTransposeNullSpace(Mat,MatNullSpace);
1600: PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat,MatNullSpace);
1601: PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat,MatNullSpace);
1602: PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat,MatNullSpace*);
1603: PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscBool  *);
1604: PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace,PetscViewer);
1605: PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace,PetscBool*,PetscInt*,const Vec**);
1606: PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec,MatNullSpace*);

1608: PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS);
1609: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1610: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
1611: PETSC_EXTERN PetscErrorCode MatSeqBAIJInvertBlockDiagonal(Mat);

1613: PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*);
1614: PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*);
1615: PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*);

1617: PETSC_EXTERN PetscErrorCode MatComputeExplicitOperator(Mat,Mat*);
1618: PETSC_EXTERN PetscErrorCode MatComputeExplicitOperatorTranspose(Mat,Mat*);

1620: PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec);

1622: PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
1623: PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec);
1624: PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
1625: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
1626: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
1627: PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
1628: PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat);
1629: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal);
1630: PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt);
1631: PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat,PetscScalar *);
1632: PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat,const char[]);
1633: PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
1634: PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);

1636: /*S
1637:     MatMFFD - A data structured used to manage the computation of the h differencing parameter for matrix-free
1638:               Jacobian vector products

1640:     Notes:
1641:     MATMFFD is a specific MatType which uses the MatMFFD data structure

1643:            MatMFFD*() methods actually take the Mat as their first argument. Not a MatMFFD data structure

1645:     Level: developer

1647: .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister()
1648: S*/
1649: typedef struct _p_MatMFFD* MatMFFD;

1651: /*J
1652:     MatMFFDType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function

1654:    Level: beginner

1656: .seealso: MatMFFDSetType(), MatMFFDRegister()
1657: J*/
1658: typedef const char* MatMFFDType;
1659: #define MATMFFD_DS  "ds"
1660: #define MATMFFD_WP  "wp"

1662: PETSC_EXTERN PetscErrorCode MatMFFDSetType(Mat,MatMFFDType);
1663: PETSC_EXTERN PetscErrorCode MatMFFDRegister(const char[],PetscErrorCode (*)(MatMFFD));

1665: PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal);
1666: PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscBool );

1668: PETSC_EXTERN PetscErrorCode MatFDColoringSetType(MatFDColoring,MatMFFDType);

1670: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1671: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);

1673: /*
1674:    PETSc interface to MUMPS
1675: */
1676: #ifdef PETSC_HAVE_MUMPS
1677: PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt);
1678: PETSC_EXTERN PetscErrorCode MatMumpsGetIcntl(Mat,PetscInt,PetscInt*);
1679: PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat,PetscInt,PetscReal);
1680: PETSC_EXTERN PetscErrorCode MatMumpsGetCntl(Mat,PetscInt,PetscReal*);

1682: PETSC_EXTERN PetscErrorCode MatMumpsGetInfo(Mat,PetscInt,PetscInt*);
1683: PETSC_EXTERN PetscErrorCode MatMumpsGetInfog(Mat,PetscInt,PetscInt*);
1684: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfo(Mat,PetscInt,PetscReal*);
1685: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfog(Mat,PetscInt,PetscReal*);
1686: PETSC_EXTERN PetscErrorCode MatMumpsGetInverse(Mat,Mat);
1687: #endif

1689: /*
1690:    PETSc interface to Mkl_Pardiso
1691: */
1692: #ifdef PETSC_HAVE_MKL_PARDISO
1693: PETSC_EXTERN PetscErrorCode MatMkl_PardisoSetCntl(Mat,PetscInt,PetscInt);
1694: #endif

1696: /*
1697:    PETSc interface to Mkl_CPardiso
1698: */
1699: #ifdef PETSC_HAVE_MKL_CPARDISO
1700: PETSC_EXTERN PetscErrorCode MatMkl_CPardisoSetCntl(Mat,PetscInt,PetscInt);
1701: #endif

1703: /*
1704:    PETSc interface to SUPERLU
1705: */
1706: #ifdef PETSC_HAVE_SUPERLU
1707: PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal);
1708: #endif

1710: /*
1711:    PETSc interface to SUPERLU_DIST
1712: */
1713: #ifdef PETSC_HAVE_SUPERLU_DIST
1714: PETSC_EXTERN PetscErrorCode MatSuperluDistGetDiagU(Mat,PetscScalar*);
1715: #endif

1717: /*
1718:    PETSc interface to STRUMPACK
1719: */
1720: #ifdef PETSC_HAVE_STRUMPACK
1721: /*E
1722:     MatSTRUMPACKReordering - sparsity reducing ordering to be used in STRUMPACK

1724:     Level: intermediate
1725: E*/
1726: typedef enum {MAT_STRUMPACK_NATURAL=0,
1727:               MAT_STRUMPACK_METIS=1,
1728:               MAT_STRUMPACK_PARMETIS=2,
1729:               MAT_STRUMPACK_SCOTCH=3,
1730:               MAT_STRUMPACK_PTSCOTCH=4,
1731:               MAT_STRUMPACK_RCM=5} MatSTRUMPACKReordering;
1732: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetReordering(Mat,MatSTRUMPACKReordering);
1733: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetColPerm(Mat,PetscBool);
1734: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSRelTol(Mat,PetscReal);
1735: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSAbsTol(Mat,PetscReal);
1736: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMinSepSize(Mat,PetscInt);
1737: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMaxRank(Mat,PetscInt);
1738: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSLeafSize(Mat,PetscInt);
1739: #endif


1742: #ifdef PETSC_HAVE_CUDA
1743: /*E
1744:     MatCUSPARSEStorageFormat - indicates the storage format for CUSPARSE (GPU)
1745:     matrices.

1747:     Not Collective

1749: +   MAT_CUSPARSE_CSR - Compressed Sparse Row
1750: .   MAT_CUSPARSE_ELL - Ellpack (requires CUDA 4.2 or later).
1751: -   MAT_CUSPARSE_HYB - Hybrid, a combination of Ellpack and Coordinate format (requires CUDA 4.2 or later).

1753:     Level: intermediate

1755:    Any additions/changes here MUST also be made in include/petsc/finclude/petscmat.h

1757: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEFormatOperation
1758: E*/

1760: typedef enum {MAT_CUSPARSE_CSR, MAT_CUSPARSE_ELL, MAT_CUSPARSE_HYB} MatCUSPARSEStorageFormat;

1762: /* these will be strings associated with enumerated type defined above */
1763: PETSC_EXTERN const char *const MatCUSPARSEStorageFormats[];

1765: /*E
1766:     MatCUSPARSEFormatOperation - indicates the operation of CUSPARSE (GPU)
1767:     matrices whose operation should use a particular storage format.

1769:     Not Collective

1771: +   MAT_CUSPARSE_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult
1772: .   MAT_CUSPARSE_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult
1773: .   MAT_CUSPARSE_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult
1774: -   MAT_CUSPARSE_ALL - sets the storage format for all CUSPARSE (GPU) matrices

1776:     Level: intermediate

1778: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEStorageFormat
1779: E*/
1780: typedef enum {MAT_CUSPARSE_MULT_DIAG, MAT_CUSPARSE_MULT_OFFDIAG, MAT_CUSPARSE_MULT, MAT_CUSPARSE_ALL} MatCUSPARSEFormatOperation;

1782: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1783: PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1784: PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat,MatCUSPARSEFormatOperation,MatCUSPARSEStorageFormat);
1785: #endif

1787: #if defined(PETSC_HAVE_VIENNACL)
1788: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1789: PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1790: #endif

1792: /*
1793:    PETSc interface to FFTW
1794: */
1795: #if defined(PETSC_HAVE_FFTW)
1796: PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec);
1797: PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec);
1798: PETSC_EXTERN PetscErrorCode MatCreateVecsFFTW(Mat,Vec*,Vec*,Vec*);
1799: #endif

1801: PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*);
1802: PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*);
1803: PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat,IS[],IS[]);
1804: PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat,IS[],IS[]);
1805: PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***);
1806: PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*);
1807: PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat,VecType);
1808: PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]);
1809: PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat);

1811: PETSC_EXTERN PetscErrorCode MatChop(Mat,PetscReal);
1812: PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat,PetscReal,PetscInt*);

1814: PETSC_EXTERN PetscErrorCode MatSubdomainsCreateCoalesce(Mat,PetscInt,PetscInt*,IS**);

1816: PETSC_EXTERN PetscErrorCode MatPreallocatorPreallocate(Mat,PetscBool,Mat);

1818: PETSC_INTERN PetscErrorCode MatHeaderMerge(Mat,Mat*);
1819: PETSC_EXTERN PetscErrorCode MatHeaderReplace(Mat,Mat*);

1821: #endif