Actual source code: petscmat.h

petsc-master 2018-02-22
Report Typos and Errors
  1: /*
  2:      Include file for the matrix component of PETSc
  3: */
  4: #ifndef __PETSCMAT_H
  6:  #include <petscvec.h>

  8: /*S
  9:      Mat - Abstract PETSc matrix object used to manage all linear operators in PETSc, even those without
 10:            an explicit sparse representation (such as matrix-free operators)

 12:    Level: beginner

 14:   Concepts: matrix; linear operator

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

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

 23:    Level: beginner

 25: .seealso: MatSetType(), Mat, MatSolverType, MatRegister()
 26: J*/
 27: typedef const char* MatType;
 28: #define MATSAME            "same"
 29: #define MATMAIJ            "maij"
 30: #define MATSEQMAIJ         "seqmaij"
 31: #define MATMPIMAIJ         "mpimaij"
 32: #define MATIS              "is"
 33: #define MATAIJ             "aij"
 34: #define MATSEQAIJ          "seqaij"
 35: #define MATMPIAIJ          "mpiaij"
 36: #define MATAIJCRL          "aijcrl"
 37: #define MATSEQAIJCRL       "seqaijcrl"
 38: #define MATMPIAIJCRL       "mpiaijcrl"
 39: #define 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 MATSELL            "sell"
 91: #define MATSEQSELL         "seqsell"
 92: #define MATMPISELL         "mpisell"
 93: #define MATDUMMY           "dummy"

 95: /*J
 96:     MatSolverType - 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: typedef const char* MatSolverType;
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: MatSolverType, 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,MatSolverType,MatFactorType,Mat*);
137: PETSC_EXTERN PetscErrorCode MatGetFactorAvailable(Mat,MatSolverType,MatFactorType,PetscBool *);
138: PETSC_EXTERN PetscErrorCode MatFactorGetSolverType(Mat,MatSolverType*);
139: PETSC_EXTERN PetscErrorCode MatGetFactorType(Mat,MatFactorType*);
140: PETSC_EXTERN PetscErrorCode MatSolverTypeRegister(MatSolverType,const MatType,MatFactorType,PetscErrorCode(*)(Mat,MatFactorType,Mat*));
141: PETSC_EXTERN PetscErrorCode MatSolverTypeGet(MatSolverType,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 MatCreateSeqSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
215: PETSC_EXTERN PetscErrorCode MatCreateSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
216: PETSC_EXTERN PetscErrorCode MatSeqSELLSetPreallocation(Mat,PetscInt,const PetscInt[]);
217: PETSC_EXTERN PetscErrorCode MatMPISELLSetPreallocation(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 MatResetPreallocation(Mat);
276: PETSC_EXTERN PetscErrorCode MatSetUp(Mat);
277: PETSC_EXTERN PetscErrorCode MatDestroy(Mat*);
278: PETSC_EXTERN PetscErrorCode MatGetNonzeroState(Mat,PetscObjectState*);

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

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

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

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

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

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

307:    Level: beginner

309:   Concepts: matrix; linear operator

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

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

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

325:     Level: beginner

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



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

339:     Level: beginner

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

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

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

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

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

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

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

426:     Level: beginner

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

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

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

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

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


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

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

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

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

470:    Level: intermediate

472:   Concepts: matrix^nonzero information

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

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

490:     Level: beginner

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

615:    Not collective

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

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

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

632:    Level: beginner

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

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

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

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

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

650:    Collective on MPI_Comm

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

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

661:    Level: intermediate

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

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

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

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

672:   Concepts: preallocation^Matrix

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

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

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

693:    Not Collective

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

705:    Level: intermediate

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

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

712:   Concepts: preallocation^Matrix

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

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

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

735:    Not Collective

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

747:    Level: intermediate

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

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

754:   Concepts: preallocation^Matrix

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

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

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

778:    Not Collective

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

790:    Level: intermediate

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

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

797:   Concepts: preallocation^Matrix

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

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

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

820:    Not Collective

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

831:    Level: intermediate

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

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

838:   Concepts: preallocation^Matrix

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

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

860:    Not Collective

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

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

871:    Level: intermediate

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

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

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

880:   Concepts: preallocation^Matrix

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

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

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

903:    Not Collective

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

913:    Level: intermediate

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

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

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

922:   Concepts: preallocation^Matrix

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

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

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

942:    Not Collective

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

952:    Level: intermediate

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

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

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

961:   Concepts: preallocation^Matrix

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


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

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

977:    Collective on MPI_Comm

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

983:    Level: intermediate

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

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

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

992:   Concepts: preallocation^Matrix

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

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

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

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

1012: #define MAT_SKIP_ALLOCATION -4

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

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

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

1037: PETSC_EXTERN PetscErrorCode MatStoreValues(Mat);
1038: PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat);

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

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

1049: /*J
1050:     MatOrderingType - String with the name of a PETSc matrix ordering

1052:    Level: beginner

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

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

1072: PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
1073: PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat,PetscReal,PetscBool,Mat*);

1075: /*S
1076:     MatFactorShiftType - Numeric Shift.

1078:    Level: beginner

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

1085: /*S
1086:     MatFactorError - indicates what type of error in matrix factor

1088:     Level: beginner

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

1092: .seealso: MatGetFactor()
1093: S*/
1094: typedef enum {MAT_FACTOR_NOERROR,MAT_FACTOR_STRUCT_ZEROPIVOT,MAT_FACTOR_NUMERIC_ZEROPIVOT,MAT_FACTOR_OUTMEMORY,MAT_FACTOR_OTHER} MatFactorError;

1096: PETSC_EXTERN PetscErrorCode MatFactorGetError(Mat,MatFactorError*);
1097: PETSC_EXTERN PetscErrorCode MatFactorClearError(Mat);
1098: PETSC_EXTERN PetscErrorCode MatFactorGetErrorZeroPivot(Mat,PetscReal*,PetscInt*);

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

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

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

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

1110:    Level: developer

1112: .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
1113:           MatFactorInfoInitialize()

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

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

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

1162: /*E
1163:     MatSORType - What type of (S)SOR to perform

1165:     Level: beginner

1167:    May be bitwise ORd together

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

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

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

1181: /*
1182:     These routines are for efficiently computing Jacobians via finite differences.
1183: */

1185: /*S
1186:      MatColoring - Object for managing the coloring of matrices.

1188:    Level: beginner

1190:   Concepts: matrix, coloring

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

1198:    Level: beginner

1200: .seealso: MatColoringSetType(), MatColoring
1201: J*/

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

1212: /*E
1213:    MatColoringWeightType - Type of weight scheme

1215:     Not Collective

1217: +   MAT_COLORING_RANDOM  - Random weights
1218: .   MAT_COLORING_LEXICAL - Lexical weighting based upon global numbering.
1219: -   MAT_COLORING_LF      - Last-first weighting.

1221:     Level: intermediate

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

1225: .seealso: MatCUSPSetFormat(), MatCUSPFormatOperation
1226: E*/
1227: typedef enum {MAT_COLORING_WEIGHT_RANDOM,MAT_COLORING_WEIGHT_LEXICAL,MAT_COLORING_WEIGHT_LF,MAT_COLORING_WEIGHT_SL} MatColoringWeightType;

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

1247: /*S
1248:      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1249:         and coloring

1251:    Level: beginner

1253:   Concepts: coloring, sparse Jacobian, finite differences

1255: .seealso:  MatFDColoringCreate()
1256: S*/
1257: typedef struct _p_MatFDColoring* MatFDColoring;

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


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

1276:    Level: beginner

1278:   Concepts: coloring, sparse matrix product

1280: .seealso:  MatTransposeColoringCreate()
1281: S*/
1282: typedef struct _p_MatTransposeColoring* MatTransposeColoring;

1284: PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat,ISColoring,MatTransposeColoring *);
1285: PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring,Mat,Mat);
1286: PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring,Mat,Mat);
1287: PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring*);

1289: /*
1290:     These routines are for partitioning matrices: currently used only
1291:   for adjacency matrix, MatCreateMPIAdj().
1292: */

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

1297:    Level: beginner

1299:   Concepts: partitioning

1301: .seealso:  MatPartitioningCreate(), MatPartitioningType
1302: S*/
1303: typedef struct _p_MatPartitioning* MatPartitioning;

1305: /*J
1306:     MatPartitioningType - String with the name of a PETSc matrix partitioning

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


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

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



1336: PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer);
1337: PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning);
1338: PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,MatPartitioningType*);

1340: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetRepartition(MatPartitioning part);
1341: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
1342: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);

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

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

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

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

1383: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal);
1384: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*);
1385: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType);
1386: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*);

1388: /*
1389:  * hierarchical partitioning
1390:  */
1391: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetFineparts(MatPartitioning,IS*);
1392: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetCoarseparts(MatPartitioning,IS*);
1393: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNcoarseparts(MatPartitioning,PetscInt);
1394: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNfineparts(MatPartitioning, PetscInt);

1396: PETSC_EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*);
1397: PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*);

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

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

1567: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1568: PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*);
1569: PETSC_EXTERN PetscErrorCode MatISRestoreLocalMat(Mat,Mat*);
1570: PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat,Mat);
1571: PETSC_EXTERN PetscErrorCode MatISGetMPIXAIJ(Mat,MatReuse,Mat*);

1573: /*S
1574:      MatNullSpace - Object that removes a null space from a vector, i.e.
1575:          orthogonalizes the vector to a subsapce

1577:    Level: advanced

1579:   Concepts: matrix; linear operator, null space

1581:   Users manual sections:
1582: .   Section 4.19 Solving Singular Systems

1584: .seealso:  MatNullSpaceCreate()
1585: S*/
1586: typedef struct _p_MatNullSpace* MatNullSpace;

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

1603: PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS);
1604: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1605: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
1606: PETSC_EXTERN PetscErrorCode MatSeqBAIJInvertBlockDiagonal(Mat);

1608: PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*);
1609: PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*);
1610: PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*);

1612: PETSC_EXTERN PetscErrorCode MatComputeExplicitOperator(Mat,Mat*);
1613: PETSC_EXTERN PetscErrorCode MatComputeExplicitOperatorTranspose(Mat,Mat*);

1615: PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec);

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

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

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

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

1639:     Level: developer

1641: .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister()
1642: S*/
1643: typedef struct _p_MatMFFD* MatMFFD;

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

1648:    Level: beginner

1650: .seealso: MatMFFDSetType(), MatMFFDRegister()
1651: J*/
1652: typedef const char* MatMFFDType;
1653: #define MATMFFD_DS  "ds"
1654: #define MATMFFD_WP  "wp"

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

1659: PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal);
1660: PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscBool );

1662: PETSC_EXTERN PetscErrorCode MatFDColoringSetType(MatFDColoring,MatMFFDType);

1664: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1665: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);

1667: /*
1668:    PETSc interface to MUMPS
1669: */
1670: #ifdef PETSC_HAVE_MUMPS
1671: PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt);
1672: PETSC_EXTERN PetscErrorCode MatMumpsGetIcntl(Mat,PetscInt,PetscInt*);
1673: PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat,PetscInt,PetscReal);
1674: PETSC_EXTERN PetscErrorCode MatMumpsGetCntl(Mat,PetscInt,PetscReal*);

1676: PETSC_EXTERN PetscErrorCode MatMumpsGetInfo(Mat,PetscInt,PetscInt*);
1677: PETSC_EXTERN PetscErrorCode MatMumpsGetInfog(Mat,PetscInt,PetscInt*);
1678: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfo(Mat,PetscInt,PetscReal*);
1679: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfog(Mat,PetscInt,PetscReal*);
1680: PETSC_EXTERN PetscErrorCode MatMumpsGetInverse(Mat,Mat);
1681: #endif

1683: /*
1684:    PETSc interface to Mkl_Pardiso
1685: */
1686: #ifdef PETSC_HAVE_MKL_PARDISO
1687: PETSC_EXTERN PetscErrorCode MatMkl_PardisoSetCntl(Mat,PetscInt,PetscInt);
1688: #endif

1690: /*
1691:    PETSc interface to Mkl_CPardiso
1692: */
1693: #ifdef PETSC_HAVE_MKL_CPARDISO
1694: PETSC_EXTERN PetscErrorCode MatMkl_CPardisoSetCntl(Mat,PetscInt,PetscInt);
1695: #endif

1697: /*
1698:    PETSc interface to SUPERLU
1699: */
1700: #ifdef PETSC_HAVE_SUPERLU
1701: PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal);
1702: #endif

1704: /*
1705:    PETSc interface to SUPERLU_DIST
1706: */
1707: #ifdef PETSC_HAVE_SUPERLU_DIST
1708: PETSC_EXTERN PetscErrorCode MatSuperluDistGetDiagU(Mat,PetscScalar*);
1709: #endif

1711: /*
1712:    PETSc interface to STRUMPACK
1713: */
1714: #ifdef PETSC_HAVE_STRUMPACK
1715: /*E
1716:     MatSTRUMPACKReordering - sparsity reducing ordering to be used in STRUMPACK

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


1736: #ifdef PETSC_HAVE_CUDA
1737: /*E
1738:     MatCUSPARSEStorageFormat - indicates the storage format for CUSPARSE (GPU)
1739:     matrices.

1741:     Not Collective

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

1747:     Level: intermediate

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

1751: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEFormatOperation
1752: E*/

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

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

1759: /*E
1760:     MatCUSPARSEFormatOperation - indicates the operation of CUSPARSE (GPU)
1761:     matrices whose operation should use a particular storage format.

1763:     Not Collective

1765: +   MAT_CUSPARSE_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult
1766: .   MAT_CUSPARSE_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult
1767: .   MAT_CUSPARSE_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult
1768: -   MAT_CUSPARSE_ALL - sets the storage format for all CUSPARSE (GPU) matrices

1770:     Level: intermediate

1772: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEStorageFormat
1773: E*/
1774: typedef enum {MAT_CUSPARSE_MULT_DIAG, MAT_CUSPARSE_MULT_OFFDIAG, MAT_CUSPARSE_MULT, MAT_CUSPARSE_ALL} MatCUSPARSEFormatOperation;

1776: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1777: PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1778: PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat,MatCUSPARSEFormatOperation,MatCUSPARSEStorageFormat);
1779: #endif

1781: #if defined(PETSC_HAVE_CUSP)
1782: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSP(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1783: PETSC_EXTERN PetscErrorCode MatCreateAIJCUSP(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);

1785: /*E
1786:     MatCUSPStorageFormat - indicates the storage format for CUSP (GPU)
1787:     matrices.

1789:     Not Collective

1791: +   MAT_CUSP_CSR - Compressed Sparse Row
1792: .   MAT_CUSP_DIA - Diagonal
1793: -   MAT_CUSP_ELL - Ellpack

1795:     Level: intermediate

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

1799: .seealso: MatCUSPSetFormat(), MatCUSPFormatOperation
1800: E*/
1801: typedef enum {MAT_CUSP_CSR, MAT_CUSP_DIA, MAT_CUSP_ELL} MatCUSPStorageFormat;

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

1806: /*E
1807:     MatCUSPFormatOperation - indicates the operation of CUSP (GPU)
1808:     matrices whose operation should use a particular storage format.

1810:     Not Collective

1812: +   MAT_CUSP_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult
1813: .   MAT_CUSP_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult
1814: .   MAT_CUSP_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult
1815: -   MAT_CUSP_ALL - sets the storage format for all CUSP (GPU) matrices

1817:     Level: intermediate

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

1821: .seealso: MatCUSPSetFormat(), MatCUSPStorageFormat
1822: E*/
1823: typedef enum {MAT_CUSP_MULT_DIAG, MAT_CUSP_MULT_OFFDIAG, MAT_CUSP_MULT, MAT_CUSP_ALL} MatCUSPFormatOperation;

1825: PETSC_EXTERN PetscErrorCode MatCUSPSetFormat(Mat,MatCUSPFormatOperation,MatCUSPStorageFormat);
1826: #endif

1828: #if defined(PETSC_HAVE_VIENNACL)
1829: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1830: PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1831: #endif

1833: /*
1834:    PETSc interface to FFTW
1835: */
1836: #if defined(PETSC_HAVE_FFTW)
1837: PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec);
1838: PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec);
1839: PETSC_EXTERN PetscErrorCode MatCreateVecsFFTW(Mat,Vec*,Vec*,Vec*);
1840: #endif

1842: PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*);
1843: PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*);
1844: PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat,IS[],IS[]);
1845: PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat,IS[],IS[]);
1846: PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***);
1847: PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*);
1848: PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat,VecType);
1849: PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]);
1850: PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat);

1852: PETSC_EXTERN PetscErrorCode MatChop(Mat,PetscReal);
1853: PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat,PetscReal,PetscInt*);

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

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

1859: PETSC_INTERN PetscErrorCode MatHeaderMerge(Mat,Mat*);
1860: PETSC_EXTERN PetscErrorCode MatHeaderReplace(Mat,Mat*);

1862: #endif