Actual source code: petscmat.h

petsc-master 2017-11-20
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, MatSolverPackage, 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 MATAIJCUSP         "aijcusp"
 40: #define MATSEQAIJCUSP      "seqaijcusp"
 41: #define MATMPIAIJCUSP      "mpiaijcusp"
 42: #define MATAIJCUSPARSE     "aijcusparse"
 43: #define MATSEQAIJCUSPARSE  "seqaijcusparse"
 44: #define MATMPIAIJCUSPARSE  "mpiaijcusparse"
 45: #define MATAIJVIENNACL     "aijviennacl"
 46: #define MATSEQAIJVIENNACL  "seqaijviennacl"
 47: #define MATMPIAIJVIENNACL  "mpiaijviennacl"
 48: #define MATAIJPERM         "aijperm"
 49: #define MATSEQAIJPERM      "seqaijperm"
 50: #define MATMPIAIJPERM      "mpiaijperm"
 51: #define MATAIJMKL          "aijmkl"
 52: #define MATSEQAIJMKL       "seqaijmkl"
 53: #define MATMPIAIJMKL       "mpiaijmkl"
 54: #define MATBAIJMKL         "baijmkl"
 55: #define MATSEQBAIJMKL      "seqbaijmkl"
 56: #define MATMPIBAIJMKL      "mpibaijmkl"
 57: #define MATSHELL           "shell"
 58: #define MATDENSE           "dense"
 59: #define MATSEQDENSE        "seqdense"
 60: #define MATMPIDENSE        "mpidense"
 61: #define MATELEMENTAL       "elemental"
 62: #define MATBAIJ            "baij"
 63: #define MATSEQBAIJ         "seqbaij"
 64: #define MATMPIBAIJ         "mpibaij"
 65: #define MATMPIADJ          "mpiadj"
 66: #define MATSBAIJ           "sbaij"
 67: #define MATSEQSBAIJ        "seqsbaij"
 68: #define MATMPISBAIJ        "mpisbaij"
 69: #define MATDAAD            "daad"
 70: #define MATMFFD            "mffd"
 71: #define MATNORMAL          "normal"
 72: #define MATNORMALHERMITIAN "normalh"
 73: #define MATLRC             "lrc"
 74: #define MATSCATTER         "scatter"
 75: #define MATBLOCKMAT        "blockmat"
 76: #define MATCOMPOSITE       "composite"
 77: #define MATFFT             "fft"
 78: #define MATFFTW            "fftw"
 79: #define MATSEQCUFFT        "seqcufft"
 80: #define MATTRANSPOSEMAT    "transpose"
 81: #define MATSCHURCOMPLEMENT "schurcomplement"
 82: #define MATPYTHON          "python"
 83: #define MATHYPRE           "hypre"
 84: #define MATHYPRESTRUCT     "hyprestruct"
 85: #define MATHYPRESSTRUCT    "hypresstruct"
 86: #define MATSUBMATRIX       "submatrix"
 87: #define MATLOCALREF        "localref"
 88: #define MATNEST            "nest"
 89: #define MATPREALLOCATOR    "preallocator"
 90: #define MATELL             "ell"
 91: #define MATSEQELL          "seqell"
 92: #define MATMPIELL          "mpiell"
 93: #define MATDUMMY           "dummy"

 95: /*J
 96:     MatSolverPackage - String with the name of a PETSc matrix solver type.

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

100:    Level: beginner

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

124: /*E
125:     MatFactorType - indicates what type of factorization is requested

127:     Level: beginner

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

131: .seealso: MatSolverPackage, MatGetFactor()
132: E*/
133: typedef enum {MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC,MAT_FACTOR_ILUDT} MatFactorType;
134: PETSC_EXTERN const char *const MatFactorTypes[];

136: PETSC_EXTERN PetscErrorCode MatGetFactor(Mat,const MatSolverPackage,MatFactorType,Mat*);
137: PETSC_EXTERN PetscErrorCode MatGetFactorAvailable(Mat,const MatSolverPackage,MatFactorType,PetscBool *);
138: PETSC_EXTERN PetscErrorCode MatFactorGetSolverPackage(Mat,const MatSolverPackage*);
139: PETSC_EXTERN PetscErrorCode MatGetFactorType(Mat,MatFactorType*);
140: PETSC_EXTERN PetscErrorCode MatSolverPackageRegister(const MatSolverPackage,const MatType,MatFactorType,PetscErrorCode(*)(Mat,MatFactorType,Mat*));
141: PETSC_EXTERN PetscErrorCode MatSolverPackageGet(const MatSolverPackage,const MatType,MatFactorType,PetscBool*,PetscBool*,PetscErrorCode (**)(Mat,MatFactorType,Mat*));

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

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

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

163:     Level: beginner

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

167: .seealso: MatCreateSubMatrices(), MatCreateSubMatrix(), MatDestroyMatrices(), MatConvert()
168: E*/
169: typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX,MAT_INPLACE_MATRIX} MatReuse;

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

175:     Level: beginner

177: .seealso: MatGetSeqNonzerostructure()
178: E*/
179: typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatCreateSubMatrixOption;

181: PETSC_EXTERN PetscErrorCode MatInitializePackage(void);

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

195: PETSC_EXTERN PetscFunctionList MatList;
196: PETSC_EXTERN PetscFunctionList MatColoringList;
197: PETSC_EXTERN PetscFunctionList MatPartitioningList;

199: /*E
200:     MatStructure - Indicates if two matrices have the same nonzero structure

202:     Level: beginner

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

206: .seealso: MatCopy(), MatAXPY()
207: E*/
208: typedef enum {DIFFERENT_NONZERO_PATTERN,SUBSET_NONZERO_PATTERN,SAME_NONZERO_PATTERN} MatStructure;

210: #if defined PETSC_HAVE_MKL_SPARSE
211: PETSC_EXTERN PetscErrorCode MatCreateBAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
212: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJMKL(MPI_Comm comm,PetscInt bs,PetscInt m,PetscInt n,PetscInt nz,const PetscInt nnz[],Mat *A);
213: #endif
214: PETSC_EXTERN PetscErrorCode MatCreateSeqELL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
215: PETSC_EXTERN PetscErrorCode MatCreateELL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
216: PETSC_EXTERN PetscErrorCode MatSeqELLSetPreallocation(Mat,PetscInt,const PetscInt[]);
217: PETSC_EXTERN PetscErrorCode MatMPIELLSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);

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

227: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
228: PETSC_EXTERN PetscErrorCode MatCreateBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
229: PETSC_EXTERN PetscErrorCode MatCreateMPIBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat*);

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

234: PETSC_EXTERN PetscErrorCode MatCreateSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
235: PETSC_EXTERN PetscErrorCode MatCreateMPISBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
236: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
237: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
238: PETSC_EXTERN PetscErrorCode MatXAIJSetPreallocation(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],const PetscInt[]);

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

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

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

262: PETSC_EXTERN PetscErrorCode MatCreateTranspose(Mat,Mat*);
263: PETSC_EXTERN PetscErrorCode MatTransposeGetMat(Mat,Mat*);
264: PETSC_EXTERN PetscErrorCode MatCreateHermitianTranspose(Mat,Mat*);
265: PETSC_EXTERN PetscErrorCode MatCreateSubMatrixVirtual(Mat,IS,IS,Mat*);
266: PETSC_EXTERN PetscErrorCode MatSubMatrixVirtualUpdate(Mat,Mat,IS,IS);
267: PETSC_EXTERN PetscErrorCode MatCreateLocalRef(Mat,IS,IS,Mat*);

269: #if defined(PETSC_HAVE_HYPRE)
270: PETSC_EXTERN PetscErrorCode MatHYPRESetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
271: #endif

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

275: PETSC_EXTERN PetscErrorCode MatSetUp(Mat);
276: PETSC_EXTERN PetscErrorCode MatDestroy(Mat*);
277: PETSC_EXTERN PetscErrorCode MatGetNonzeroState(Mat,PetscObjectState*);

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

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

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

299:    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).
300:    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.

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

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

306:    Level: beginner

308:   Concepts: matrix; linear operator

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

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

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

324:     Level: beginner

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



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

338:     Level: beginner

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

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

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

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

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

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

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

423:     Level: beginner

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

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

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

439: .seealso: MatDuplicate()
440: E*/
441: typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption;

443: PETSC_EXTERN PetscErrorCode MatConvert(Mat,MatType,MatReuse,Mat*);
444: PETSC_EXTERN PetscErrorCode MatDuplicate(Mat,MatDuplicateOption,Mat*);


447: PETSC_EXTERN PetscErrorCode MatCopy(Mat,Mat,MatStructure);
448: PETSC_EXTERN PetscErrorCode MatView(Mat,PetscViewer);
449: PETSC_EXTERN PetscErrorCode MatIsSymmetric(Mat,PetscReal,PetscBool *);
450: PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat,PetscBool *);
451: PETSC_EXTERN PetscErrorCode MatIsHermitian(Mat,PetscReal,PetscBool *);
452: PETSC_EXTERN PetscErrorCode MatIsSymmetricKnown(Mat,PetscBool *,PetscBool *);
453: PETSC_EXTERN PetscErrorCode MatIsHermitianKnown(Mat,PetscBool *,PetscBool *);
454: PETSC_EXTERN PetscErrorCode MatMissingDiagonal(Mat,PetscBool  *,PetscInt *);
455: PETSC_EXTERN PetscErrorCode MatLoad(Mat, PetscViewer);

457: PETSC_EXTERN PetscErrorCode MatGetRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool  *);
458: PETSC_EXTERN PetscErrorCode MatRestoreRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool  *);
459: PETSC_EXTERN PetscErrorCode MatGetColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool  *);
460: PETSC_EXTERN PetscErrorCode MatRestoreColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool  *);

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

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

467:    Level: intermediate

469:   Concepts: matrix^nonzero information

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

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

487:     Level: beginner

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

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

507: PETSC_EXTERN PetscErrorCode MatEqual(Mat,Mat,PetscBool*);
508: PETSC_EXTERN PetscErrorCode MatMultEqual(Mat,Mat,PetscInt,PetscBool*);
509: PETSC_EXTERN PetscErrorCode MatMultAddEqual(Mat,Mat,PetscInt,PetscBool*);
510: PETSC_EXTERN PetscErrorCode MatMultTransposeEqual(Mat,Mat,PetscInt,PetscBool*);
511: PETSC_EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscBool*);
512: PETSC_EXTERN PetscErrorCode MatMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
513: PETSC_EXTERN PetscErrorCode MatTransposeMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);

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

525: PETSC_EXTERN PetscErrorCode MatGetSize(Mat,PetscInt*,PetscInt*);
526: PETSC_EXTERN PetscErrorCode MatGetLocalSize(Mat,PetscInt*,PetscInt*);
527: PETSC_EXTERN PetscErrorCode MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
528: PETSC_EXTERN PetscErrorCode MatGetOwnershipRanges(Mat,const PetscInt**);
529: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*);
530: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat,const PetscInt**);
531: PETSC_EXTERN PetscErrorCode MatGetOwnershipIS(Mat,IS*,IS*);

533: PETSC_EXTERN PetscErrorCode MatCreateSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
534: 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);}
535: PETSC_EXTERN PetscErrorCode MatCreateSubMatricesMPI(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
536: 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);}
537: PETSC_EXTERN PetscErrorCode MatDestroyMatrices(PetscInt,Mat *[]);
538: PETSC_EXTERN PetscErrorCode MatDestroySubMatrices(PetscInt,Mat *[]);
539: PETSC_EXTERN PetscErrorCode MatCreateSubMatrix(Mat,IS,IS,MatReuse,Mat *);
540: 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);}
541: PETSC_EXTERN PetscErrorCode MatGetLocalSubMatrix(Mat,IS,IS,Mat*);
542: PETSC_EXTERN PetscErrorCode MatRestoreLocalSubMatrix(Mat,IS,IS,Mat*);
543: PETSC_EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat,Mat*);
544: PETSC_EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat*);

546: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJ(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
547: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJSymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
548: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJNumeric(Mat,Mat);
549: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMat(Mat,MatReuse,Mat*);
550: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
551: PETSC_EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,Mat*);
552: PETSC_EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *,const PetscInt *[]);

554: PETSC_EXTERN PetscErrorCode MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
555: PETSC_EXTERN PetscErrorCode MatIncreaseOverlapSplit(Mat mat,PetscInt n,IS is[],PetscInt ov);
556: PETSC_EXTERN PetscErrorCode MatMPIAIJSetUseScalableIncreaseOverlap(Mat,PetscBool);

558: PETSC_EXTERN PetscErrorCode MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
559: PETSC_EXTERN PetscErrorCode MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
560: PETSC_EXTERN PetscErrorCode MatMatMultNumeric(Mat,Mat,Mat);

562: PETSC_EXTERN PetscErrorCode MatMatMatMult(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);
563: PETSC_EXTERN PetscErrorCode MatGalerkin(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);

565: PETSC_EXTERN PetscErrorCode MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
566: PETSC_EXTERN PetscErrorCode MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
567: PETSC_EXTERN PetscErrorCode MatPtAPNumeric(Mat,Mat,Mat);
568: PETSC_EXTERN PetscErrorCode MatRARt(Mat,Mat,MatReuse,PetscReal,Mat*);
569: PETSC_EXTERN PetscErrorCode MatRARtSymbolic(Mat,Mat,PetscReal,Mat*);
570: PETSC_EXTERN PetscErrorCode MatRARtNumeric(Mat,Mat,Mat);

572: PETSC_EXTERN PetscErrorCode MatTransposeMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
573: PETSC_EXTERN PetscErrorCode MatTransposetMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
574: PETSC_EXTERN PetscErrorCode MatTransposetMatMultNumeric(Mat,Mat,Mat);
575: PETSC_EXTERN PetscErrorCode MatMatTransposeMult(Mat,Mat,MatReuse,PetscReal,Mat*);
576: PETSC_EXTERN PetscErrorCode MatMatTransposeMultSymbolic(Mat,Mat,PetscReal,Mat*);
577: PETSC_EXTERN PetscErrorCode MatMatTransposeMultNumeric(Mat,Mat,Mat);

579: PETSC_EXTERN PetscErrorCode MatAXPY(Mat,PetscScalar,Mat,MatStructure);
580: PETSC_EXTERN PetscErrorCode MatAYPX(Mat,PetscScalar,Mat,MatStructure);

582: PETSC_EXTERN PetscErrorCode MatScale(Mat,PetscScalar);
583: PETSC_EXTERN PetscErrorCode MatShift(Mat,PetscScalar);

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

595: PETSC_EXTERN PetscErrorCode MatStashSetInitialSize(Mat,PetscInt,PetscInt);
596: PETSC_EXTERN PetscErrorCode MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);

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

609: /*MC
610:    MatSetValue - Set a single entry into a matrix.

612:    Not collective

614:    Synopsis:
615:      #include <petscmat.h>
616:      PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode)

618:    Input Parameters:
619: +  m - the matrix
620: .  row - the row location of the entry
621: .  col - the column location of the entry
622: .  value - the value to insert
623: -  mode - either INSERT_VALUES or ADD_VALUES

625:    Notes:
626:    For efficiency one should use MatSetValues() and set several or many
627:    values simultaneously if possible.

629:    Level: beginner

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

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

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

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

643:    Synopsis:
644:    #include <petscmat.h>
645:    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)

647:    Collective on MPI_Comm

649:    Input Parameters:
650: +  comm - the communicator that will share the eventually allocated matrix
651: .  nrows - the number of LOCAL rows in the matrix
652: -  ncols - the number of LOCAL columns in the matrix

654:    Output Parameters:
655: +  dnz - the array that will be passed to the matrix preallocation routines
656: -  ozn - the other array passed to the matrix preallocation routines

658:    Level: intermediate

660:    Notes:
661:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

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

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

669:   Concepts: preallocation^Matrix

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

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

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

690:    Not Collective

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

702:    Level: intermediate

704:    Notes:
705:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

709:   Concepts: preallocation^Matrix

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

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

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

732:    Not Collective

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

744:    Level: intermediate

746:    Notes:
747:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

751:   Concepts: preallocation^Matrix

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

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

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

775:    Not Collective

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

787:    Level: intermediate

789:    Notes:
790:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

794:   Concepts: preallocation^Matrix

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

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

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

817:    Not Collective

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

828:    Level: intermediate

830:    Notes:
831:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

835:   Concepts: preallocation^Matrix

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

853:    Synopsis:
854:    #include <petscmat.h>
855:    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

857:    Not Collective

859:    Input Parameters:
860: +  row - the row
861: .  ncols - the number of columns in the matrix
862: -  cols - the columns indicated

864:    Output Parameters:
865: +  dnz - the array that will be passed to the matrix preallocation routines
866: -  ozn - the other array passed to the matrix preallocation routines

868:    Level: intermediate

870:    Notes:
871:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

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

877:   Concepts: preallocation^Matrix

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

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

896:    Synopsis:
897:    #include <petscmat.h>
898:    PetscErrorCode MatPreallocateSymmetricSetBlock(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

900:    Not Collective

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

910:    Level: intermediate

912:    Notes:
913:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

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

919:   Concepts: preallocation^Matrix

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

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

935:    Synopsis:
936:    #include <petscmat.h>
937:    PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)

939:    Not Collective

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

949:    Level: intermediate

951:    Notes:
952:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

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

958:   Concepts: preallocation^Matrix

960: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
961:           MatPreallocateSymmetricSetLocalBlock()
962: M*/
963: #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);}


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

970:    Synopsis:
971:    #include <petscmat.h>
972:    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)

974:    Collective on MPI_Comm

976:    Input Parameters:
977: +  dnz - the array that was be passed to the matrix preallocation routines
978: -  ozn - the other array passed to the matrix preallocation routines

980:    Level: intermediate

982:    Notes:
983:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

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

989:   Concepts: preallocation^Matrix

991: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
992:           MatPreallocateSymmetricSetLocalBlock()
993: M*/
994: #define MatPreallocateFinalize(dnz,onz) 0;_4_PetscFree2(dnz,onz);CHKERRQ(_4_ierr);}

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

999: PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*);
1000: PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);

1002: PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
1003: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
1004: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1005: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1006: PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1007: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*,PetscInt,PetscBool);

1009: #define MAT_SKIP_ALLOCATION -4

1011: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1012: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1013: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);

1015: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1016: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1017: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1018: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
1019: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1020: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
1021: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1022: PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
1023: PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
1024: PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
1025: PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
1026: PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
1027: PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat,Mat*);

1029: PETSC_EXTERN PetscErrorCode MatISSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1030: PETSC_EXTERN PetscErrorCode MatISSetUpSF(Mat);
1031: PETSC_EXTERN PetscErrorCode MatSeqDenseSetLDA(Mat,PetscInt);
1032: PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*);

1034: PETSC_EXTERN PetscErrorCode MatStoreValues(Mat);
1035: PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat);

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

1039: PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat,IS*);
1040: PETSC_EXTERN PetscErrorCode MatFindZeroRows(Mat,IS*);
1041: /*
1042:   These routines are not usually accessed directly, rather solving is
1043:   done through the KSP and PC interfaces.
1044: */

1046: /*J
1047:     MatOrderingType - String with the name of a PETSc matrix ordering

1049:    Level: beginner

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

1064: PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat,MatOrderingType,IS*,IS*);
1065: PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFunctionList*);
1066: PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[],PetscErrorCode(*)(Mat,MatOrderingType,IS*,IS*));
1067: PETSC_EXTERN PetscFunctionList MatOrderingList;

1069: PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
1070: PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat,PetscReal,PetscBool,Mat*);

1072: /*S
1073:     MatFactorShiftType - Numeric Shift.

1075:    Level: beginner

1077: S*/
1078: typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType;
1079: PETSC_EXTERN const char *const MatFactorShiftTypes[];
1080: PETSC_EXTERN const char *const MatFactorShiftTypesDetail[];

1082: /*S
1083:     MatFactorError - indicates what type of error in matrix factor

1085:     Level: beginner

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

1089: .seealso: MatGetFactor()
1090: S*/
1091: typedef enum {MAT_FACTOR_NOERROR,MAT_FACTOR_STRUCT_ZEROPIVOT,MAT_FACTOR_NUMERIC_ZEROPIVOT,MAT_FACTOR_OUTMEMORY,MAT_FACTOR_OTHER} MatFactorError;

1093: PETSC_EXTERN PetscErrorCode MatFactorGetError(Mat,MatFactorError*);
1094: PETSC_EXTERN PetscErrorCode MatFactorClearError(Mat);
1095: PETSC_EXTERN PetscErrorCode MatFactorGetErrorZeroPivot(Mat,PetscReal*,PetscInt*);

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

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

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

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

1107:    Level: developer

1109: .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
1110:           MatFactorInfoInitialize()

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

1128: PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*);
1129: PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*);
1130: PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1131: PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*);
1132: PETSC_EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*);
1133: PETSC_EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*);
1134: PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1135: PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1136: PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1137: PETSC_EXTERN PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*);
1138: PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*);
1139: PETSC_EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1140: PETSC_EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec);
1141: PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec);
1142: PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec);
1143: PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec);
1144: PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec);
1145: PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1146: PETSC_EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs);
1147: PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat);

1149: typedef enum {MAT_FACTOR_SCHUR_UNFACTORED, MAT_FACTOR_SCHUR_FACTORED, MAT_FACTOR_SCHUR_INVERTED} MatFactorSchurStatus;
1150: PETSC_EXTERN PetscErrorCode MatFactorSetSchurIS(Mat,IS);
1151: PETSC_EXTERN PetscErrorCode MatFactorGetSchurComplement(Mat,Mat*,MatFactorSchurStatus*);
1152: PETSC_EXTERN PetscErrorCode MatFactorRestoreSchurComplement(Mat,Mat*,MatFactorSchurStatus);
1153: PETSC_EXTERN PetscErrorCode MatFactorInvertSchurComplement(Mat);
1154: PETSC_EXTERN PetscErrorCode MatFactorCreateSchurComplement(Mat,Mat*,MatFactorSchurStatus*);
1155: PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplement(Mat,Vec,Vec);
1156: PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplementTranspose(Mat,Vec,Vec);
1157: PETSC_EXTERN PetscErrorCode MatFactorFactorizeSchurComplement(Mat);

1159: /*E
1160:     MatSORType - What type of (S)SOR to perform

1162:     Level: beginner

1164:    May be bitwise ORd together

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

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

1170: .seealso: MatSOR()
1171: E*/
1172: typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1173:               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1174:               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
1175:               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1176: PETSC_EXTERN PetscErrorCode MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);

1178: /*
1179:     These routines are for efficiently computing Jacobians via finite differences.
1180: */

1182: /*S
1183:      MatColoring - Object for managing the coloring of matrices.

1185:    Level: beginner

1187:   Concepts: matrix, coloring

1189: .seealso:  MatFDColoringCreate() ISColoring MatFDColoring
1190: S*/
1191: typedef struct _p_MatColoring* MatColoring;
1192: /*J
1193:     MatColoringType - String with the name of a PETSc matrix coloring

1195:    Level: beginner

1197: .seealso: MatColoringSetType(), MatColoring
1198: J*/

1200: typedef const  char*           MatColoringType;
1201: #define MATCOLORINGJP      "jp"
1202: #define MATCOLORINGPOWER   "power"
1203: #define MATCOLORINGNATURAL "natural"
1204: #define MATCOLORINGSL      "sl"
1205: #define MATCOLORINGLF      "lf"
1206: #define MATCOLORINGID      "id"
1207: #define MATCOLORINGGREEDY  "greedy"

1209: /*E
1210:    MatColoringWeightType - Type of weight scheme

1212:     Not Collective

1214: +   MAT_COLORING_RANDOM  - Random weights
1215: .   MAT_COLORING_LEXICAL - Lexical weighting based upon global numbering.
1216: -   MAT_COLORING_LF      - Last-first weighting.

1218:     Level: intermediate

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

1222: .seealso: MatCUSPSetFormat(), MatCUSPFormatOperation
1223: E*/
1224: typedef enum {MAT_COLORING_WEIGHT_RANDOM,MAT_COLORING_WEIGHT_LEXICAL,MAT_COLORING_WEIGHT_LF,MAT_COLORING_WEIGHT_SL} MatColoringWeightType;

1226: PETSC_EXTERN PetscErrorCode MatColoringCreate(Mat,MatColoring*);
1227: PETSC_EXTERN PetscErrorCode MatColoringGetDegrees(Mat,PetscInt,PetscInt*);
1228: PETSC_EXTERN PetscErrorCode MatColoringDestroy(MatColoring*);
1229: PETSC_EXTERN PetscErrorCode MatColoringView(MatColoring,PetscViewer);
1230: PETSC_EXTERN PetscErrorCode MatColoringSetType(MatColoring,MatColoringType);
1231: PETSC_EXTERN PetscErrorCode MatColoringSetFromOptions(MatColoring);
1232: PETSC_EXTERN PetscErrorCode MatColoringSetDistance(MatColoring,PetscInt);
1233: PETSC_EXTERN PetscErrorCode MatColoringGetDistance(MatColoring,PetscInt*);
1234: PETSC_EXTERN PetscErrorCode MatColoringSetMaxColors(MatColoring,PetscInt);
1235: PETSC_EXTERN PetscErrorCode MatColoringGetMaxColors(MatColoring,PetscInt*);
1236: PETSC_EXTERN PetscErrorCode MatColoringApply(MatColoring,ISColoring*);
1237: PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[],PetscErrorCode(*)(MatColoring));
1238: PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1239: PETSC_EXTERN PetscErrorCode MatColoringSetWeightType(MatColoring,MatColoringWeightType);
1240: PETSC_EXTERN PetscErrorCode MatColoringSetWeights(MatColoring,PetscReal*,PetscInt*);
1241: PETSC_EXTERN PetscErrorCode MatColoringCreateWeights(MatColoring,PetscReal **,PetscInt **lperm);
1242: PETSC_EXTERN PetscErrorCode MatColoringTestValid(MatColoring,ISColoring);

1244: /*S
1245:      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1246:         and coloring

1248:    Level: beginner

1250:   Concepts: coloring, sparse Jacobian, finite differences

1252: .seealso:  MatFDColoringCreate()
1253: S*/
1254: typedef struct _p_MatFDColoring* MatFDColoring;

1256: PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1257: PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring*);
1258: PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer);
1259: PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
1260: PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1261: PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1262: PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring);
1263: PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,void *);
1264: PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec);
1265: PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,const PetscInt*[]);
1266: PETSC_EXTERN PetscErrorCode MatFDColoringSetUp(Mat,ISColoring,MatFDColoring);
1267: PETSC_EXTERN PetscErrorCode MatFDColoringSetBlockSize(MatFDColoring,PetscInt,PetscInt);


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

1273:    Level: beginner

1275:   Concepts: coloring, sparse matrix product

1277: .seealso:  MatTransposeColoringCreate()
1278: S*/
1279: typedef struct _p_MatTransposeColoring* MatTransposeColoring;

1281: PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat,ISColoring,MatTransposeColoring *);
1282: PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring,Mat,Mat);
1283: PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring,Mat,Mat);
1284: PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring*);

1286: /*
1287:     These routines are for partitioning matrices: currently used only
1288:   for adjacency matrix, MatCreateMPIAdj().
1289: */

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

1294:    Level: beginner

1296:   Concepts: partitioning

1298: .seealso:  MatPartitioningCreate(), MatPartitioningType
1299: S*/
1300: typedef struct _p_MatPartitioning* MatPartitioning;

1302: /*J
1303:     MatPartitioningType - String with the name of a PETSc matrix partitioning

1305:    Level: beginner
1306: dm
1307: .seealso: MatPartitioningCreate(), MatPartitioning
1308: J*/
1309: typedef const char* MatPartitioningType;
1310: #define MATPARTITIONINGCURRENT  "current"
1311: #define MATPARTITIONINGAVERAGE   "average"
1312: #define MATPARTITIONINGSQUARE   "square"
1313: #define MATPARTITIONINGPARMETIS "parmetis"
1314: #define MATPARTITIONINGCHACO    "chaco"
1315: #define MATPARTITIONINGPARTY    "party"
1316: #define MATPARTITIONINGPTSCOTCH "ptscotch"
1317: #define MATPARTITIONINGHIERARCH  "hierarch"


1320: PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1321: PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,MatPartitioningType);
1322: PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt);
1323: PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat);
1324: PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1325: PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1326: PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*);
1327: PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning*);

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



1333: PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer);
1334: PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning);
1335: PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,MatPartitioningType*);

1337: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetRepartition(MatPartitioning part);
1338: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
1339: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);

1341: typedef enum { MP_CHACO_MULTILEVEL=1,MP_CHACO_SPECTRAL=2,MP_CHACO_LINEAR=4,MP_CHACO_RANDOM=5,MP_CHACO_SCATTERED=6 } MPChacoGlobalType;
1342: PETSC_EXTERN const char *const MPChacoGlobalTypes[];
1343: typedef enum { MP_CHACO_KERNIGHAN=1,MP_CHACO_NONE=2 } MPChacoLocalType;
1344: PETSC_EXTERN const char *const MPChacoLocalTypes[];
1345: typedef enum { MP_CHACO_LANCZOS=0,MP_CHACO_RQI=1 } MPChacoEigenType;
1346: PETSC_EXTERN const char *const MPChacoEigenTypes[];

1348: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning,MPChacoGlobalType);
1349: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning,MPChacoGlobalType*);
1350: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning,MPChacoLocalType);
1351: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning,MPChacoLocalType*);
1352: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
1353: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1354: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning,MPChacoEigenType*);
1355: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning,PetscReal);
1356: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning,PetscReal*);
1357: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning,PetscInt);
1358: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning,PetscInt*);

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

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

1380: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal);
1381: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*);
1382: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType);
1383: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*);

1385: /*
1386:  * hierarchical partitioning
1387:  */
1388: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetFineparts(MatPartitioning,IS*);
1389: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetCoarseparts(MatPartitioning,IS*);
1390: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNcoarseparts(MatPartitioning,PetscInt);
1391: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNfineparts(MatPartitioning, PetscInt);

1393: PETSC_EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*);
1394: PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*);

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

1550: /*
1551:    Codes for matrices stored on disk. By default they are
1552:    stored in a universal format. By changing the format with
1553:    PetscViewerPushFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
1554:    be stored in a way natural for the matrix, for example dense matrices
1555:    would be stored as dense. Matrices stored this way may only be
1556:    read into matrices of the same type.
1557: */
1558: #define MATRIX_BINARY_FORMAT_DENSE -1

1560: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1561: PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*);
1562: PETSC_EXTERN PetscErrorCode MatISRestoreLocalMat(Mat,Mat*);
1563: PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat,Mat);
1564: PETSC_EXTERN PetscErrorCode MatISGetMPIXAIJ(Mat,MatReuse,Mat*);

1566: /*S
1567:      MatNullSpace - Object that removes a null space from a vector, i.e.
1568:          orthogonalizes the vector to a subsapce

1570:    Level: advanced

1572:   Concepts: matrix; linear operator, null space

1574:   Users manual sections:
1575: .   Section 4.19 Solving Singular Systems

1577: .seealso:  MatNullSpaceCreate()
1578: S*/
1579: typedef struct _p_MatNullSpace* MatNullSpace;

1581: PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*);
1582: PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*);
1583: PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace*);
1584: PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec);
1585: PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *);
1586: PETSC_EXTERN PetscErrorCode MatGetTransposeNullSpace(Mat, MatNullSpace *);
1587: PETSC_EXTERN PetscErrorCode MatSetTransposeNullSpace(Mat,MatNullSpace);
1588: PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat,MatNullSpace);
1589: PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat,MatNullSpace);
1590: PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat,MatNullSpace*);
1591: PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscBool  *);
1592: PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace,PetscViewer);
1593: PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace,PetscBool*,PetscInt*,const Vec**);
1594: PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec,MatNullSpace*);

1596: PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS);
1597: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1598: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
1599: PETSC_EXTERN PetscErrorCode MatSeqBAIJInvertBlockDiagonal(Mat);

1601: PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*);
1602: PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*);
1603: PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*);

1605: PETSC_EXTERN PetscErrorCode MatComputeExplicitOperator(Mat,Mat*);

1607: PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec);

1609: PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
1610: PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec);
1611: PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
1612: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
1613: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
1614: PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
1615: PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat);
1616: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal);
1617: PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt);
1618: PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat,PetscScalar *);
1619: PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat,const char[]);
1620: PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
1621: PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);

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

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

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

1631:     Level: developer

1633: .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister()
1634: S*/
1635: typedef struct _p_MatMFFD* MatMFFD;

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

1640:    Level: beginner

1642: .seealso: MatMFFDSetType(), MatMFFDRegister()
1643: J*/
1644: typedef const char* MatMFFDType;
1645: #define MATMFFD_DS  "ds"
1646: #define MATMFFD_WP  "wp"

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

1651: PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal);
1652: PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscBool );

1654: PETSC_EXTERN PetscErrorCode MatFDColoringSetType(MatFDColoring,MatMFFDType);

1656: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1657: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);

1659: /*
1660:    PETSc interface to MUMPS
1661: */
1662: #ifdef PETSC_HAVE_MUMPS
1663: PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt);
1664: PETSC_EXTERN PetscErrorCode MatMumpsGetIcntl(Mat,PetscInt,PetscInt*);
1665: PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat,PetscInt,PetscReal);
1666: PETSC_EXTERN PetscErrorCode MatMumpsGetCntl(Mat,PetscInt,PetscReal*);

1668: PETSC_EXTERN PetscErrorCode MatMumpsGetInfo(Mat,PetscInt,PetscInt*);
1669: PETSC_EXTERN PetscErrorCode MatMumpsGetInfog(Mat,PetscInt,PetscInt*);
1670: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfo(Mat,PetscInt,PetscReal*);
1671: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfog(Mat,PetscInt,PetscReal*);
1672: #endif

1674: /*
1675:    PETSc interface to Mkl_Pardiso
1676: */
1677: #ifdef PETSC_HAVE_MKL_PARDISO
1678: PETSC_EXTERN PetscErrorCode MatMkl_PardisoSetCntl(Mat,PetscInt,PetscInt);
1679: #endif

1681: /*
1682:    PETSc interface to Mkl_CPardiso
1683: */
1684: #ifdef PETSC_HAVE_MKL_CPARDISO
1685: PETSC_EXTERN PetscErrorCode MatMkl_CPardisoSetCntl(Mat,PetscInt,PetscInt);
1686: #endif

1688: /*
1689:    PETSc interface to SUPERLU
1690: */
1691: #ifdef PETSC_HAVE_SUPERLU
1692: PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal);
1693: #endif

1695: /*
1696:    PETSc interface to SUPERLU_DIST
1697: */
1698: #ifdef PETSC_HAVE_SUPERLU_DIST
1699: PETSC_EXTERN PetscErrorCode MatSuperluDistGetDiagU(Mat,PetscScalar*);
1700: #endif

1702: /*
1703:    PETSc interface to STRUMPACK
1704: */
1705: #ifdef PETSC_HAVE_STRUMPACK
1706: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSRelCompTol(Mat,PetscReal);
1707: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMinSize(Mat,PetscInt);
1708: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetColPerm(Mat,PetscBool);
1709: #endif


1712: #ifdef PETSC_HAVE_CUDA
1713: /*E
1714:     MatCUSPARSEStorageFormat - indicates the storage format for CUSPARSE (GPU)
1715:     matrices.

1717:     Not Collective

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

1723:     Level: intermediate

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

1727: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEFormatOperation
1728: E*/

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

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

1735: /*E
1736:     MatCUSPARSEFormatOperation - indicates the operation of CUSPARSE (GPU)
1737:     matrices whose operation should use a particular storage format.

1739:     Not Collective

1741: +   MAT_CUSPARSE_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult
1742: .   MAT_CUSPARSE_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult
1743: .   MAT_CUSPARSE_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult
1744: -   MAT_CUSPARSE_ALL - sets the storage format for all CUSPARSE (GPU) matrices

1746:     Level: intermediate

1748: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEStorageFormat
1749: E*/
1750: typedef enum {MAT_CUSPARSE_MULT_DIAG, MAT_CUSPARSE_MULT_OFFDIAG, MAT_CUSPARSE_MULT, MAT_CUSPARSE_ALL} MatCUSPARSEFormatOperation;

1752: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1753: PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1754: PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat,MatCUSPARSEFormatOperation,MatCUSPARSEStorageFormat);
1755: #endif

1757: #if defined(PETSC_HAVE_CUSP)
1758: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSP(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1759: PETSC_EXTERN PetscErrorCode MatCreateAIJCUSP(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);

1761: /*E
1762:     MatCUSPStorageFormat - indicates the storage format for CUSP (GPU)
1763:     matrices.

1765:     Not Collective

1767: +   MAT_CUSP_CSR - Compressed Sparse Row
1768: .   MAT_CUSP_DIA - Diagonal
1769: -   MAT_CUSP_ELL - Ellpack

1771:     Level: intermediate

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

1775: .seealso: MatCUSPSetFormat(), MatCUSPFormatOperation
1776: E*/
1777: typedef enum {MAT_CUSP_CSR, MAT_CUSP_DIA, MAT_CUSP_ELL} MatCUSPStorageFormat;

1779: /* these will be strings associated with enumerated type defined above */
1780: PETSC_EXTERN const char *const MatCUSPStorageFormats[];

1782: /*E
1783:     MatCUSPFormatOperation - indicates the operation of CUSP (GPU)
1784:     matrices whose operation should use a particular storage format.

1786:     Not Collective

1788: +   MAT_CUSP_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult
1789: .   MAT_CUSP_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult
1790: .   MAT_CUSP_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult
1791: -   MAT_CUSP_ALL - sets the storage format for all CUSP (GPU) matrices

1793:     Level: intermediate

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

1797: .seealso: MatCUSPSetFormat(), MatCUSPStorageFormat
1798: E*/
1799: typedef enum {MAT_CUSP_MULT_DIAG, MAT_CUSP_MULT_OFFDIAG, MAT_CUSP_MULT, MAT_CUSP_ALL} MatCUSPFormatOperation;

1801: PETSC_EXTERN PetscErrorCode MatCUSPSetFormat(Mat,MatCUSPFormatOperation,MatCUSPStorageFormat);
1802: #endif

1804: #if defined(PETSC_HAVE_VIENNACL)
1805: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1806: PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1807: #endif

1809: /*
1810:    PETSc interface to FFTW
1811: */
1812: #if defined(PETSC_HAVE_FFTW)
1813: PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec);
1814: PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec);
1815: PETSC_EXTERN PetscErrorCode MatCreateVecsFFTW(Mat,Vec*,Vec*,Vec*);
1816: #endif

1818: PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*);
1819: PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*);
1820: PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat,IS[],IS[]);
1821: PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat,IS[],IS[]);
1822: PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***);
1823: PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*);
1824: PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat,VecType);
1825: PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]);
1826: PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat);

1828: PETSC_EXTERN PetscErrorCode MatChop(Mat,PetscReal);
1829: PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat,PetscReal,PetscInt*);

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

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

1835: PETSC_INTERN PetscErrorCode MatHeaderMerge(Mat,Mat*);
1836: PETSC_EXTERN PetscErrorCode MatHeaderReplace(Mat,Mat*);

1838: #endif