Actual source code: petscmat.h

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

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

 12:    Level: beginner

 14:   Concepts: matrix; linear operator

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

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

 23:    Level: beginner

 25: .seealso: MatSetType(), Mat, MatSolverPackage, MatRegister()
 26: J*/
 27: typedef const char* MatType;
 28: #define MATSAME            "same"
 29: #define MATMAIJ            "maij"
 30: #define MATSEQMAIJ         "seqmaij"
 31: #define MATMPIMAIJ         "mpimaij"
 32: #define MATIS              "is"
 33: #define MATAIJ             "aij"
 34: #define MATSEQAIJ          "seqaij"
 35: #define MATSEQAIJPTHREAD   "seqaijpthread"
 36: #define MATAIJPTHREAD      "aijpthread"
 37: #define MATMPIAIJ          "mpiaij"
 38: #define MATAIJCRL          "aijcrl"
 39: #define MATSEQAIJCRL       "seqaijcrl"
 40: #define MATMPIAIJCRL       "mpiaijcrl"
 41: #define MATAIJCUSP         "aijcusp"
 42: #define MATSEQAIJCUSP      "seqaijcusp"
 43: #define MATMPIAIJCUSP      "mpiaijcusp"
 44: #define MATAIJCUSPARSE     "aijcusparse"
 45: #define MATSEQAIJCUSPARSE  "seqaijcusparse"
 46: #define MATMPIAIJCUSPARSE  "mpiaijcusparse"
 47: #define MATAIJVIENNACL     "aijviennacl"
 48: #define MATSEQAIJVIENNACL  "seqaijviennacl"
 49: #define MATMPIAIJVIENNACL  "mpiaijviennacl"
 50: #define MATAIJPERM         "aijperm"
 51: #define MATSEQAIJPERM      "seqaijperm"
 52: #define MATMPIAIJPERM      "mpiaijperm"
 53: #define MATSHELL           "shell"
 54: #define MATDENSE           "dense"
 55: #define MATSEQDENSE        "seqdense"
 56: #define MATMPIDENSE        "mpidense"
 57: #define MATELEMENTAL       "elemental"
 58: #define MATBAIJ            "baij"
 59: #define MATSEQBAIJ         "seqbaij"
 60: #define MATMPIBAIJ         "mpibaij"
 61: #define MATMPIADJ          "mpiadj"
 62: #define MATSBAIJ           "sbaij"
 63: #define MATSEQSBAIJ        "seqsbaij"
 64: #define MATMPISBAIJ        "mpisbaij"
 65: #define MATSEQBSTRM        "seqbstrm"
 66: #define MATMPIBSTRM        "mpibstrm"
 67: #define MATBSTRM           "bstrm"
 68: #define MATSEQSBSTRM       "seqsbstrm"
 69: #define MATMPISBSTRM       "mpisbstrm"
 70: #define MATSBSTRM          "sbstrm"
 71: #define MATDAAD            "daad"
 72: #define MATMFFD            "mffd"
 73: #define MATNORMAL          "normal"
 74: #define MATLRC             "lrc"
 75: #define MATSCATTER         "scatter"
 76: #define MATBLOCKMAT        "blockmat"
 77: #define MATCOMPOSITE       "composite"
 78: #define MATFFT             "fft"
 79: #define MATFFTW            "fftw"
 80: #define MATSEQCUFFT        "seqcufft"
 81: #define MATTRANSPOSEMAT    "transpose"
 82: #define MATSCHURCOMPLEMENT "schurcomplement"
 83: #define MATPYTHON          "python"
 84: #define MATHYPRESTRUCT     "hyprestruct"
 85: #define MATHYPRESSTRUCT    "hypresstruct"
 86: #define MATSUBMATRIX       "submatrix"
 87: #define MATLOCALREF        "localref"
 88: #define MATNEST            "nest"

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

 93:     For example: "petsc" indicates what PETSc provides, "superlu" indicates either
 94:        SuperLU or SuperLU_Dist etc.


 97:    Level: beginner

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

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

125:     Level: beginner

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

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

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

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

152: /*E
153:     MatReuse - Indicates if matrices obtained from a previous call to MatGetSubMatrices()
154:      or MatGetSubMatrix() are to be reused to store the new matrix values. For MatConvert() is used to indicate
155:      that the input matrix is to be replaced with the converted matrix.

157:     Level: beginner

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

161: .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert()
162: E*/
163: typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX} MatReuse;

165: /*E
166:     MatGetSubMatrixOption - Indicates if matrices obtained from a call to MatGetSubMatrices()
167:      include the matrix values. Currently it is only used by MatGetSeqNonzerostructure().

169:     Level: beginner

171: .seealso: MatGetSeqNonzerostructure()
172: E*/
173: typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatGetSubMatrixOption;

175: PETSC_EXTERN PetscErrorCode MatInitializePackage(void);

177: PETSC_EXTERN PetscErrorCode MatCreate(MPI_Comm,Mat*);
178: PETSC_EXTERN PetscErrorCode MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
179: PETSC_EXTERN PetscErrorCode MatSetType(Mat,MatType);
180: PETSC_EXTERN PetscErrorCode MatSetFromOptions(Mat);
181: PETSC_STATIC_INLINE PetscErrorCode MatViewFromOptions(Mat A,const char prefix[],const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,prefix,name);}
182: PETSC_EXTERN PetscErrorCode MatRegister(const char[],PetscErrorCode(*)(Mat));
183: PETSC_EXTERN PetscErrorCode MatRegisterBaseName(const char[],const char[],const char[]);
184: PETSC_EXTERN PetscErrorCode MatSetOptionsPrefix(Mat,const char[]);
185: PETSC_EXTERN PetscErrorCode MatAppendOptionsPrefix(Mat,const char[]);
186: PETSC_EXTERN PetscErrorCode MatGetOptionsPrefix(Mat,const char*[]);

188: PETSC_EXTERN PetscFunctionList MatList;
189: PETSC_EXTERN PetscFunctionList MatColoringList;
190: PETSC_EXTERN PetscFunctionList MatPartitioningList;
191: PETSC_EXTERN PetscFunctionList MatCoarsenList;

193: /*E
194:     MatStructure - Indicates if two matrices have the same nonzero structure

196:     Level: beginner

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

200: .seealso: MatCopy(), MatAXPY()
201: E*/
202: typedef enum {DIFFERENT_NONZERO_PATTERN,SUBSET_NONZERO_PATTERN,SAME_NONZERO_PATTERN} MatStructure;

204: PETSC_EXTERN PetscErrorCode MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
205: PETSC_EXTERN PetscErrorCode MatCreateDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
206: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
207: PETSC_EXTERN PetscErrorCode MatCreateAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
208: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
209: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*);

211: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
212: PETSC_EXTERN PetscErrorCode MatCreateBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
213: PETSC_EXTERN PetscErrorCode MatCreateMPIBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat*);

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

218: PETSC_EXTERN PetscErrorCode MatCreateSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
219: PETSC_EXTERN PetscErrorCode MatCreateMPISBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
220: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
221: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
222: PETSC_EXTERN PetscErrorCode MatXAIJSetPreallocation(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],const PetscInt[]);

224: PETSC_EXTERN PetscErrorCode MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
225: PETSC_EXTERN PetscErrorCode MatCreateNormal(Mat,Mat*);
226: PETSC_EXTERN PetscErrorCode MatCreateLRC(Mat,Mat,Mat,Mat*);
227: PETSC_EXTERN PetscErrorCode MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,Mat*);
228: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
229: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);

231: PETSC_EXTERN PetscErrorCode MatCreateSeqBSTRM(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
232: PETSC_EXTERN PetscErrorCode MatCreateMPIBSTRM(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
233: PETSC_EXTERN PetscErrorCode MatCreateSeqSBSTRM(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
234: PETSC_EXTERN PetscErrorCode MatCreateMPISBSTRM(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);

236: PETSC_EXTERN PetscErrorCode MatCreateScatter(MPI_Comm,VecScatter,Mat*);
237: PETSC_EXTERN PetscErrorCode MatScatterSetVecScatter(Mat,VecScatter);
238: PETSC_EXTERN PetscErrorCode MatScatterGetVecScatter(Mat,VecScatter*);
239: PETSC_EXTERN PetscErrorCode MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*);
240: PETSC_EXTERN PetscErrorCode MatCompositeAddMat(Mat,Mat);
241: PETSC_EXTERN PetscErrorCode MatCompositeMerge(Mat);
242: PETSC_EXTERN PetscErrorCode MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*);
243: typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType;
244: PETSC_EXTERN PetscErrorCode MatCompositeSetType(Mat,MatCompositeType);

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

249: PETSC_EXTERN PetscErrorCode MatCreateTranspose(Mat,Mat*);
250: PETSC_EXTERN PetscErrorCode MatCreateHermitianTranspose(Mat,Mat*);
251: PETSC_EXTERN PetscErrorCode MatCreateSubMatrix(Mat,IS,IS,Mat*);
252: PETSC_EXTERN PetscErrorCode MatSubMatrixUpdate(Mat,Mat,IS,IS);
253: PETSC_EXTERN PetscErrorCode MatCreateLocalRef(Mat,IS,IS,Mat*);

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

257: PETSC_EXTERN PetscErrorCode MatSetUp(Mat);
258: PETSC_EXTERN PetscErrorCode MatDestroy(Mat*);
259: PETSC_EXTERN PetscErrorCode MatGetNonzeroState(Mat,PetscObjectState*);

261: PETSC_EXTERN PetscErrorCode MatConjugate(Mat);
262: PETSC_EXTERN PetscErrorCode MatRealPart(Mat);
263: PETSC_EXTERN PetscErrorCode MatImaginaryPart(Mat);
264: PETSC_EXTERN PetscErrorCode MatGetDiagonalBlock(Mat,Mat*);
265: PETSC_EXTERN PetscErrorCode MatGetTrace(Mat,PetscScalar*);
266: PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonal(Mat,const PetscScalar **);

268: /* ------------------------------------------------------------*/
269: PETSC_EXTERN PetscErrorCode MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
270: PETSC_EXTERN PetscErrorCode MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
271: PETSC_EXTERN PetscErrorCode MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
272: PETSC_EXTERN PetscErrorCode MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);
273: PETSC_EXTERN PetscErrorCode MatSetValuesBatch(Mat,PetscInt,PetscInt,PetscInt[],const PetscScalar[]);
274: PETSC_EXTERN PetscErrorCode MatSetRandom(Mat,PetscRandom);

276: /*S
277:      MatStencil - Data structure (C struct) for storing information about a single row or
278:         column of a matrix as indexed on an associated grid.

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

282:    Level: beginner

284:   Concepts: matrix; linear operator

286: .seealso:  MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockedStencil()
287: S*/
288: typedef struct {
289:   PetscInt k,j,i,c;
290: } MatStencil;

292: PETSC_EXTERN PetscErrorCode MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
293: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
294: PETSC_EXTERN PetscErrorCode MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);

296: PETSC_EXTERN PetscErrorCode MatSetColoring(Mat,ISColoring);
297: PETSC_EXTERN PetscErrorCode MatSetValuesAdifor(Mat,PetscInt,void*);

299: /*E
300:     MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
301:      to continue to add values to it

303:     Level: beginner

305: .seealso: MatAssemblyBegin(), MatAssemblyEnd()
306: E*/
307: typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
308: PETSC_EXTERN PetscErrorCode MatAssemblyBegin(Mat,MatAssemblyType);
309: PETSC_EXTERN PetscErrorCode MatAssemblyEnd(Mat,MatAssemblyType);
310: PETSC_EXTERN PetscErrorCode MatAssembled(Mat,PetscBool *);



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

317:     Level: beginner

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

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

323: .seealso: MatSetOption()
324: E*/
325: typedef enum {MAT_OPTION_MIN = -5,
326:               MAT_NEW_NONZERO_LOCATION_ERR = -4,
327:               MAT_UNUSED_NONZERO_LOCATION_ERR = -3,
328:               MAT_NEW_NONZERO_ALLOCATION_ERR = -2,
329:               MAT_ROW_ORIENTED = -1,
330:               MAT_SYMMETRIC = 1,
331:               MAT_STRUCTURALLY_SYMMETRIC = 2,
332:               MAT_NEW_DIAGONALS = 3,
333:               MAT_IGNORE_OFF_PROC_ENTRIES = 4,
334:               MAT_USE_HASH_TABLE = 5,
335:               MAT_KEEP_NONZERO_PATTERN = 6,
336:               MAT_IGNORE_ZERO_ENTRIES = 7,
337:               MAT_USE_INODES = 8,
338:               MAT_HERMITIAN = 9,
339:               MAT_SYMMETRY_ETERNAL = 10,
340:               MAT_DUMMY = 11,
341:               MAT_IGNORE_LOWER_TRIANGULAR = 12,
342:               MAT_ERROR_LOWER_TRIANGULAR = 13,
343:               MAT_GETROW_UPPERTRIANGULAR = 14,
344:               MAT_SPD = 15,
345:               MAT_NO_OFF_PROC_ZERO_ROWS = 16,
346:               MAT_NO_OFF_PROC_ENTRIES = 17,
347:               MAT_NEW_NONZERO_LOCATIONS = 18,
348:               MAT_OPTION_MAX = 19} MatOption;

350: PETSC_EXTERN const char *MatOptions[];
351: PETSC_EXTERN PetscErrorCode MatSetOption(Mat,MatOption,PetscBool);
352: PETSC_EXTERN PetscErrorCode MatGetOption(Mat,MatOption,PetscBool*);
353: PETSC_EXTERN PetscErrorCode MatGetType(Mat,MatType*);

355: PETSC_EXTERN PetscErrorCode MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
356: PETSC_EXTERN PetscErrorCode MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
357: PETSC_EXTERN PetscErrorCode MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
358: PETSC_EXTERN PetscErrorCode MatGetRowUpperTriangular(Mat);
359: PETSC_EXTERN PetscErrorCode MatRestoreRowUpperTriangular(Mat);
360: PETSC_EXTERN PetscErrorCode MatGetColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
361: PETSC_EXTERN PetscErrorCode MatRestoreColumn(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
362: PETSC_EXTERN PetscErrorCode MatGetColumnVector(Mat,Vec,PetscInt);
363: PETSC_EXTERN PetscErrorCode MatSeqAIJGetArray(Mat,PetscScalar *[]);
364: PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArray(Mat,PetscScalar *[]);
365: PETSC_EXTERN PetscErrorCode MatSeqAIJGetMaxRowNonzeros(Mat,PetscInt*);
366: PETSC_EXTERN PetscErrorCode MatSeqAIJSetValuesLocalFast(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
367: PETSC_EXTERN PetscErrorCode MatDenseGetArray(Mat,PetscScalar *[]);
368: PETSC_EXTERN PetscErrorCode MatDenseRestoreArray(Mat,PetscScalar *[]);
369: PETSC_EXTERN PetscErrorCode MatGetBlockSize(Mat,PetscInt *);
370: PETSC_EXTERN PetscErrorCode MatSetBlockSize(Mat,PetscInt);
371: PETSC_EXTERN PetscErrorCode MatGetBlockSizes(Mat,PetscInt *,PetscInt *);
372: PETSC_EXTERN PetscErrorCode MatSetBlockSizes(Mat,PetscInt,PetscInt);
373: PETSC_EXTERN PetscErrorCode MatSetBlockSizesFromMats(Mat,Mat,Mat);
374: PETSC_EXTERN PetscErrorCode MatSetNThreads(Mat,PetscInt);
375: PETSC_EXTERN PetscErrorCode MatGetNThreads(Mat,PetscInt*);

377: PETSC_EXTERN PetscErrorCode MatMult(Mat,Vec,Vec);
378: PETSC_EXTERN PetscErrorCode MatMultDiagonalBlock(Mat,Vec,Vec);
379: PETSC_EXTERN PetscErrorCode MatMultAdd(Mat,Vec,Vec,Vec);
380: PETSC_EXTERN PetscErrorCode MatMultTranspose(Mat,Vec,Vec);
381: PETSC_EXTERN PetscErrorCode MatMultHermitianTranspose(Mat,Vec,Vec);
382: PETSC_EXTERN PetscErrorCode MatIsTranspose(Mat,Mat,PetscReal,PetscBool *);
383: PETSC_EXTERN PetscErrorCode MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscBool *);
384: PETSC_EXTERN PetscErrorCode MatMultTransposeAdd(Mat,Vec,Vec,Vec);
385: PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec);
386: PETSC_EXTERN PetscErrorCode MatMultConstrained(Mat,Vec,Vec);
387: PETSC_EXTERN PetscErrorCode MatMultTransposeConstrained(Mat,Vec,Vec);
388: PETSC_EXTERN PetscErrorCode MatMatSolve(Mat,Mat,Mat);
389: PETSC_EXTERN PetscErrorCode MatResidual(Mat,Vec,Vec,Vec);

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

395:     Level: beginner

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

399: $   MAT_SHARE_NONZERO_PATTERN - the i and j arrays in the new matrix will be shared with the original matrix
400: $                               this also triggers the MAT_DO_NOT_COPY_VALUES option. This is used when you
401: $                               have several matrices with the same nonzero pattern.

403: .seealso: MatDuplicate()
404: E*/
405: typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption;

407: PETSC_EXTERN PetscErrorCode MatConvert(Mat,MatType,MatReuse,Mat*);
408: PETSC_EXTERN PetscErrorCode MatDuplicate(Mat,MatDuplicateOption,Mat*);


411: PETSC_EXTERN PetscErrorCode MatCopy(Mat,Mat,MatStructure);
412: PETSC_EXTERN PetscErrorCode MatView(Mat,PetscViewer);
413: PETSC_EXTERN PetscErrorCode MatIsSymmetric(Mat,PetscReal,PetscBool *);
414: PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat,PetscBool *);
415: PETSC_EXTERN PetscErrorCode MatIsHermitian(Mat,PetscReal,PetscBool *);
416: PETSC_EXTERN PetscErrorCode MatIsSymmetricKnown(Mat,PetscBool *,PetscBool *);
417: PETSC_EXTERN PetscErrorCode MatIsHermitianKnown(Mat,PetscBool *,PetscBool *);
418: PETSC_EXTERN PetscErrorCode MatMissingDiagonal(Mat,PetscBool  *,PetscInt *);
419: PETSC_EXTERN PetscErrorCode MatLoad(Mat, PetscViewer);

421: PETSC_EXTERN PetscErrorCode MatGetRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool  *);
422: PETSC_EXTERN PetscErrorCode MatRestoreRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool  *);
423: PETSC_EXTERN PetscErrorCode MatGetColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool  *);
424: PETSC_EXTERN PetscErrorCode MatRestoreColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool  *);

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

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

431:    Level: intermediate

433:   Concepts: matrix^nonzero information

435: .seealso:  MatGetInfo(), MatInfoType
436: S*/
437: typedef struct {
438:   PetscLogDouble block_size;                         /* block size */
439:   PetscLogDouble nz_allocated,nz_used,nz_unneeded;   /* number of nonzeros */
440:   PetscLogDouble memory;                             /* memory allocated */
441:   PetscLogDouble assemblies;                         /* number of matrix assemblies called */
442:   PetscLogDouble mallocs;                            /* number of mallocs during MatSetValues() */
443:   PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
444:   PetscLogDouble factor_mallocs;                     /* number of mallocs during factorization */
445: } MatInfo;

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

451:     Level: beginner

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

455: .seealso: MatGetInfo(), MatInfo
456: E*/
457: typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
458: PETSC_EXTERN PetscErrorCode MatGetInfo(Mat,MatInfoType,MatInfo*);
459: PETSC_EXTERN PetscErrorCode MatGetDiagonal(Mat,Vec);
460: PETSC_EXTERN PetscErrorCode MatGetRowMax(Mat,Vec,PetscInt[]);
461: PETSC_EXTERN PetscErrorCode MatGetRowMin(Mat,Vec,PetscInt[]);
462: PETSC_EXTERN PetscErrorCode MatGetRowMaxAbs(Mat,Vec,PetscInt[]);
463: PETSC_EXTERN PetscErrorCode MatGetRowMinAbs(Mat,Vec,PetscInt[]);
464: PETSC_EXTERN PetscErrorCode MatGetRowSum(Mat,Vec);
465: PETSC_EXTERN PetscErrorCode MatTranspose(Mat,MatReuse,Mat*);
466: PETSC_EXTERN PetscErrorCode MatHermitianTranspose(Mat,MatReuse,Mat*);
467: PETSC_EXTERN PetscErrorCode MatPermute(Mat,IS,IS,Mat *);
468: PETSC_EXTERN PetscErrorCode MatDiagonalScale(Mat,Vec,Vec);
469: PETSC_EXTERN PetscErrorCode MatDiagonalSet(Mat,Vec,InsertMode);
470: PETSC_EXTERN PetscErrorCode MatEqual(Mat,Mat,PetscBool *);
471: PETSC_EXTERN PetscErrorCode MatMultEqual(Mat,Mat,PetscInt,PetscBool *);
472: PETSC_EXTERN PetscErrorCode MatMultAddEqual(Mat,Mat,PetscInt,PetscBool *);
473: PETSC_EXTERN PetscErrorCode MatMultTransposeEqual(Mat,Mat,PetscInt,PetscBool *);
474: PETSC_EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscBool *);

476: PETSC_EXTERN PetscErrorCode MatNorm(Mat,NormType,PetscReal *);
477: PETSC_EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal *);
478: PETSC_EXTERN PetscErrorCode MatZeroEntries(Mat);
479: PETSC_EXTERN PetscErrorCode MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
480: PETSC_EXTERN PetscErrorCode MatZeroRowsIS(Mat,IS,PetscScalar,Vec,Vec);
481: PETSC_EXTERN PetscErrorCode MatZeroRowsStencil(Mat,PetscInt,const MatStencil [],PetscScalar,Vec,Vec);
482: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsStencil(Mat,PetscInt,const MatStencil[],PetscScalar,Vec,Vec);
483: PETSC_EXTERN PetscErrorCode MatZeroRowsColumns(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
484: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsIS(Mat,IS,PetscScalar,Vec,Vec);

486: PETSC_EXTERN PetscErrorCode MatGetSize(Mat,PetscInt*,PetscInt*);
487: PETSC_EXTERN PetscErrorCode MatGetLocalSize(Mat,PetscInt*,PetscInt*);
488: PETSC_EXTERN PetscErrorCode MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
489: PETSC_EXTERN PetscErrorCode MatGetOwnershipRanges(Mat,const PetscInt**);
490: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*);
491: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat,const PetscInt**);
492: PETSC_EXTERN PetscErrorCode MatGetOwnershipIS(Mat,IS*,IS*);

494: PETSC_EXTERN PetscErrorCode MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
495: PETSC_EXTERN PetscErrorCode MatGetSubMatricesParallel(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
496: PETSC_EXTERN PetscErrorCode MatDestroyMatrices(PetscInt,Mat *[]);
497: PETSC_EXTERN PetscErrorCode MatGetSubMatrix(Mat,IS,IS,MatReuse,Mat *);
498: PETSC_EXTERN PetscErrorCode MatGetLocalSubMatrix(Mat,IS,IS,Mat*);
499: PETSC_EXTERN PetscErrorCode MatRestoreLocalSubMatrix(Mat,IS,IS,Mat*);
500: PETSC_EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat,Mat*);
501: PETSC_EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat*);

503: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJ(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
504: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJSymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
505: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJNumeric(Mat,Mat);
506: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMat(Mat,MatReuse,Mat*);
507: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
508: PETSC_EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,Mat*);
509: PETSC_EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *,const PetscInt *[]);

511: PETSC_EXTERN PetscErrorCode MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);

513: PETSC_EXTERN PetscErrorCode MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
514: PETSC_EXTERN PetscErrorCode MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
515: PETSC_EXTERN PetscErrorCode MatMatMultNumeric(Mat,Mat,Mat);

517: PETSC_EXTERN PetscErrorCode MatMatMatMult(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);
518: PETSC_EXTERN PetscErrorCode MatMatMatMultSymbolic(Mat,Mat,Mat,PetscReal,Mat*);
519: PETSC_EXTERN PetscErrorCode MatMatMatMultNumeric(Mat,Mat,Mat,Mat);

521: PETSC_EXTERN PetscErrorCode MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
522: PETSC_EXTERN PetscErrorCode MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
523: PETSC_EXTERN PetscErrorCode MatPtAPNumeric(Mat,Mat,Mat);
524: PETSC_EXTERN PetscErrorCode MatRARt(Mat,Mat,MatReuse,PetscReal,Mat*);
525: PETSC_EXTERN PetscErrorCode MatRARtSymbolic(Mat,Mat,PetscReal,Mat*);
526: PETSC_EXTERN PetscErrorCode MatRARtNumeric(Mat,Mat,Mat);

528: PETSC_EXTERN PetscErrorCode MatTransposeMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
529: PETSC_EXTERN PetscErrorCode MatTransposetMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
530: PETSC_EXTERN PetscErrorCode MatTransposetMatMultNumeric(Mat,Mat,Mat);
531: PETSC_EXTERN PetscErrorCode MatMatTransposeMult(Mat,Mat,MatReuse,PetscReal,Mat*);
532: PETSC_EXTERN PetscErrorCode MatMatTransposeMultSymbolic(Mat,Mat,PetscReal,Mat*);
533: PETSC_EXTERN PetscErrorCode MatMatTransposeMultNumeric(Mat,Mat,Mat);

535: PETSC_EXTERN PetscErrorCode MatAXPY(Mat,PetscScalar,Mat,MatStructure);
536: PETSC_EXTERN PetscErrorCode MatAYPX(Mat,PetscScalar,Mat,MatStructure);

538: PETSC_EXTERN PetscErrorCode MatScale(Mat,PetscScalar);
539: PETSC_EXTERN PetscErrorCode MatShift(Mat,PetscScalar);

541: PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping);
542: PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*);
543: PETSC_EXTERN PetscErrorCode MatGetLayouts(Mat,PetscLayout*,PetscLayout*);
544: PETSC_EXTERN PetscErrorCode MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
545: PETSC_EXTERN PetscErrorCode MatZeroRowsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
546: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
547: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
548: PETSC_EXTERN PetscErrorCode MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
549: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);

551: PETSC_EXTERN PetscErrorCode MatStashSetInitialSize(Mat,PetscInt,PetscInt);
552: PETSC_EXTERN PetscErrorCode MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);

554: PETSC_EXTERN PetscErrorCode MatInterpolate(Mat,Vec,Vec);
555: PETSC_EXTERN PetscErrorCode MatInterpolateAdd(Mat,Vec,Vec,Vec);
556: PETSC_EXTERN PetscErrorCode MatRestrict(Mat,Vec,Vec);
557: PETSC_EXTERN PetscErrorCode MatCreateVecs(Mat,Vec*,Vec*);
558: PETSC_DEPRECATED("Use MatCreateVecs()") PETSC_STATIC_INLINE PetscErrorCode MatGetVecs(Mat mat,Vec *x,Vec *y) {return MatCreateVecs(mat,x,y);}
559: PETSC_EXTERN PetscErrorCode MatCreateRedundantMatrix(Mat,PetscInt,MPI_Comm,MatReuse,Mat*);
560: PETSC_EXTERN PetscErrorCode MatGetMultiProcBlock(Mat,MPI_Comm,MatReuse,Mat*);
561: PETSC_EXTERN PetscErrorCode MatFindZeroDiagonals(Mat,IS*);
562: PETSC_EXTERN PetscErrorCode MatFindOffBlockDiagonalEntries(Mat,IS*);
563: PETSC_EXTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);

565: /*MC
566:    MatSetValue - Set a single entry into a matrix.

568:    Not collective

570:    Synopsis:
571:      #include <petscmat.h>
572:      PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode)

574:    Input Parameters:
575: +  m - the matrix
576: .  row - the row location of the entry
577: .  col - the column location of the entry
578: .  value - the value to insert
579: -  mode - either INSERT_VALUES or ADD_VALUES

581:    Notes:
582:    For efficiency one should use MatSetValues() and set several or many
583:    values simultaneously if possible.

585:    Level: beginner

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

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

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

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

599:    Synopsis:
600:    #include <petscmat.h>
601:    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)

603:    Collective on MPI_Comm

605:    Input Parameters:
606: +  comm - the communicator that will share the eventually allocated matrix
607: .  nrows - the number of LOCAL rows in the matrix
608: -  ncols - the number of LOCAL columns in the matrix

610:    Output Parameters:
611: +  dnz - the array that will be passed to the matrix preallocation routines
612: -  ozn - the other array passed to the matrix preallocation routines

614:    Level: intermediate

616:    Notes:
617:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

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

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

625:   Concepts: preallocation^Matrix

627: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
628:           MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocalBlock()
629: M*/
630: #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
631: { \
632:   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__start,__end; \
633:   _4_PetscCalloc2(__nrows,&dnz,__nrows,&onz);CHKERRQ(_4_ierr); \
634:   __start = 0; __end = __start;                                         \
635:   _4_MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\
636:   _4_MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;

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

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

646:    Not Collective

648:    Input Parameters:
649: +  map - the row mapping from local numbering to global numbering
650: .  nrows - the number of rows indicated
651: .  rows - the indices of the rows
652: .  cmap - the column mapping from local to global numbering
653: .  ncols - the number of columns in the matrix
654: .  cols - the columns indicated
655: .  dnz - the array that will be passed to the matrix preallocation routines
656: -  ozn - the other array passed to the matrix preallocation routines

658:    Level: intermediate

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

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

665:   Concepts: preallocation^Matrix

667: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateInitialize(),
668:           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock()
669: M*/
670: #define MatPreallocateSetLocal(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
671: {\
672:   PetscInt __l;\
673:   _4_ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
674:   _4_ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
675:   for (__l=0;__l<nrows;__l++) {\
676:     _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
677:   }\
678: }

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

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

688:    Not Collective

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

700:    Level: intermediate

702:    Notes:
703:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

707:   Concepts: preallocation^Matrix

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

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

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

730:    Not Collective

732:    Input Parameters:
733: +  map - the mapping between local numbering and global numbering
734: .  nrows - the number of rows indicated
735: .  rows - the indices of the rows
736: .  ncols - the number of columns in the matrix
737: .  cols - the columns indicated
738: .  dnz - the array that will be passed to the matrix preallocation routines
739: -  ozn - the other array passed to the matrix preallocation routines

741:    Level: intermediate

743:    Notes:
744:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

748:   Concepts: preallocation^Matrix

750: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateInitialize(),
751:           MatPreallocateInitialize(),  MatPreallocateSetLocal()
752: M*/
753: #define MatPreallocateSymmetricSetLocalBlock(map,nrows,rows,ncols,cols,dnz,onz) 0;\
754: {\
755:   PetscInt __l;\
756:   _4_ISLocalToGlobalMappingApplyBlock(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
757:   _4_ISLocalToGlobalMappingApplyBlock(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
758:   for (__l=0;__l<nrows;__l++) {\
759:     _4_MatPreallocateSymmetricSetBlock((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
760:   }\
761: }
762: /*MC
763:    MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
764:        inserted using a local number of the rows and columns

766:    Synopsis:
767:    #include <petscmat.h>
768:    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

770:    Not Collective

772:    Input Parameters:
773: +  row - the row
774: .  ncols - the number of columns in the matrix
775: -  cols - the columns indicated

777:    Output Parameters:
778: +  dnz - the array that will be passed to the matrix preallocation routines
779: -  ozn - the other array passed to the matrix preallocation routines

781:    Level: intermediate

783:    Notes:
784:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

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

790:   Concepts: preallocation^Matrix

792: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateInitialize(),
793:           MatPreallocateInitialize(), MatPreallocateSetLocal()
794: M*/
795: #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
796: { PetscInt __i; \
797:   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);\
798:   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);\
799:   for (__i=0; __i<nc; __i++) {\
800:     if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
801:     else dnz[row - __rstart]++;\
802:   }\
803: }

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

809:    Synopsis:
810:    #include <petscmat.h>
811:    PetscErrorCode MatPreallocateSymmetricSetBlock(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

813:    Not Collective

815:    Input Parameters:
816: +  nrows - the number of rows indicated
817: .  rows - the indices of the rows
818: .  ncols - the number of columns in the matrix
819: .  cols - the columns indicated
820: .  dnz - the array that will be passed to the matrix preallocation routines
821: -  ozn - the other array passed to the matrix preallocation routines

823:    Level: intermediate

825:    Notes:
826:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

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

832:   Concepts: preallocation^Matrix

834: .seealso: MatPreallocateFinalize(), MatPreallocateSet(),  MatPreallocateInitialize(),
835:           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal()
836: M*/
837: #define MatPreallocateSymmetricSetBlock(row,nc,cols,dnz,onz) 0;\
838: { PetscInt __i; \
839:   for (__i=0; __i<nc; __i++) {\
840:     if (cols[__i] >= __end) onz[row - __rstart]++; \
841:     else if (cols[__i] >= row) dnz[row - __rstart]++;\
842:   }\
843: }

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

848:    Synopsis:
849:    #include <petscmat.h>
850:    PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)

852:    Not Collective

854:    Input Parameters:
855: .  A - matrix
856: .  row - row where values exist (must be local to this process)
857: .  ncols - number of columns
858: .  cols - columns with nonzeros
859: .  dnz - the array that will be passed to the matrix preallocation routines
860: -  ozn - the other array passed to the matrix preallocation routines

862:    Level: intermediate

864:    Notes:
865:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

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

871:   Concepts: preallocation^Matrix

873: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
874:           MatPreallocateSymmetricSetLocalBlock()
875: M*/
876: #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);}


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

883:    Synopsis:
884:    #include <petscmat.h>
885:    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)

887:    Collective on MPI_Comm

889:    Input Parameters:
890: +  dnz - the array that was be passed to the matrix preallocation routines
891: -  ozn - the other array passed to the matrix preallocation routines

893:    Level: intermediate

895:    Notes:
896:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

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

902:   Concepts: preallocation^Matrix

904: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
905:           MatPreallocateSymmetricSetLocalBlock()
906: M*/
907: #define MatPreallocateFinalize(dnz,onz) 0;_4_PetscFree2(dnz,onz);CHKERRQ(_4_ierr);}

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

912: PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*);
913: PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);

915: PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
916: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
917: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
918: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
919: PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
920: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*,PetscInt,PetscBool);

922: #define MAT_SKIP_ALLOCATION -4

924: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
925: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
926: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);

928: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
929: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
930: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
931: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
932: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
933: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
934: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
935: PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
936: PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
937: PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
938: PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
939: PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
940: PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat,Mat*);

942: PETSC_EXTERN PetscErrorCode MatISSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
943: PETSC_EXTERN PetscErrorCode MatSeqDenseSetLDA(Mat,PetscInt);
944: PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*);

946: PETSC_EXTERN PetscErrorCode MatStoreValues(Mat);
947: PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat);

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

951: PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat,IS*);
952: /*
953:   These routines are not usually accessed directly, rather solving is
954:   done through the KSP and PC interfaces.
955: */

957: /*J
958:     MatOrderingType - String with the name of a PETSc matrix ordering

960:    Level: beginner

962: .seealso: MatGetOrdering()
963: J*/
964: typedef const char* MatOrderingType;
965: #define MATORDERINGNATURAL     "natural"
966: #define MATORDERINGND          "nd"
967: #define MATORDERING1WD         "1wd"
968: #define MATORDERINGRCM         "rcm"
969: #define MATORDERINGQMD         "qmd"
970: #define MATORDERINGROWLENGTH   "rowlength"
971: #define MATORDERINGWBM         "wbm"
972: #define MATORDERINGSPECTRAL    "spectral"
973: #define MATORDERINGAMD         "amd"            /* only works if UMFPACK is installed with PETSc */

975: PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat,MatOrderingType,IS*,IS*);
976: PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFunctionList*);
977: PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[],PetscErrorCode(*)(Mat,MatOrderingType,IS*,IS*));
978: PETSC_EXTERN PetscFunctionList MatOrderingList;

980: PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
981: PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat,PetscReal,PetscBool,Mat*);

983: /*S
984:     MatFactorShiftType - Numeric Shift.

986:    Level: beginner

988: S*/
989: typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType;
990: PETSC_EXTERN const char *const MatFactorShiftTypes[];
991: PETSC_EXTERN const char *const MatFactorShiftTypesDetail[];

993: /*S
994:    MatFactorInfo - Data passed into the matrix factorization routines

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

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

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

1003:    Level: developer

1005: .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
1006:           MatFactorInfoInitialize()

1008: S*/
1009: typedef struct {
1010:   PetscReal     diagonal_fill;  /* force diagonal to fill in if initially not filled */
1011:   PetscReal     usedt;
1012:   PetscReal     dt;             /* drop tolerance */
1013:   PetscReal     dtcol;          /* tolerance for pivoting */
1014:   PetscReal     dtcount;        /* maximum nonzeros to be allowed per row */
1015:   PetscReal     fill;           /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1016:   PetscReal     levels;         /* ICC/ILU(levels) */
1017:   PetscReal     pivotinblocks;  /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1018:                                    factorization may be faster if do not pivot */
1019:   PetscReal     zeropivot;      /* pivot is called zero if less than this */
1020:   PetscReal     shifttype;      /* type of shift added to matrix factor to prevent zero pivots */
1021:   PetscReal     shiftamount;     /* how large the shift is */
1022: } MatFactorInfo;

1024: PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*);
1025: PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*);
1026: PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1027: PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*);
1028: PETSC_EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*);
1029: PETSC_EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*);
1030: PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1031: PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1032: PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1033: PETSC_EXTERN PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*);
1034: PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*);
1035: PETSC_EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1036: PETSC_EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec);
1037: PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec);
1038: PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec);
1039: PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec);
1040: PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec);
1041: PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1042: PETSC_EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs);

1044: PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat);

1046: /*E
1047:     MatSORType - What type of (S)SOR to perform

1049:     Level: beginner

1051:    May be bitwise ORd together

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

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

1057: .seealso: MatSOR()
1058: E*/
1059: typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1060:               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1061:               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
1062:               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1063: PETSC_EXTERN PetscErrorCode MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);

1065: /*
1066:     These routines are for efficiently computing Jacobians via finite differences.
1067: */

1069: /*S
1070:      MatColoring - Object for managing the coloring of matrices.

1072:    Level: beginner

1074:   Concepts: matrix, coloring

1076: .seealso:  MatFDColoringCreate() ISColoring MatFDColoring
1077: S*/
1078: typedef struct _p_MatColoring* MatColoring;
1079: /*J
1080:     MatColoringType - String with the name of a PETSc matrix coloring

1082:    Level: beginner

1084: .seealso: MatColoringSetType(), MatColoring
1085: J*/

1087: typedef const  char*           MatColoringType;
1088: #define MATCOLORINGJP      "jp"
1089: #define MATCOLORINGPOWER   "power"
1090: #define MATCOLORINGNATURAL "natural"
1091: #define MATCOLORINGSL      "sl"
1092: #define MATCOLORINGLF      "lf"
1093: #define MATCOLORINGID      "id"
1094: #define MATCOLORINGGREEDY  "greedy"

1096: /*E
1097:    MatColoringWeightType - Type of weight scheme

1099:     Not Collective

1101: +   MAT_COLORING_RANDOM  - Random weights
1102: .   MAT_COLORING_LEXICAL - Lexical weighting based upon global numbering.
1103: -   MAT_COLORING_LF      - Last-first weighting.

1105:     Level: intermediate

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

1109: .seealso: MatCUSPSetFormat(), MatCUSPFormatOperation
1110: E*/
1111: typedef enum {MAT_COLORING_WEIGHT_RANDOM,MAT_COLORING_WEIGHT_LEXICAL,MAT_COLORING_WEIGHT_LF,MAT_COLORING_WEIGHT_SL} MatColoringWeightType;

1113: PETSC_EXTERN PetscErrorCode MatColoringCreate(Mat,MatColoring*);
1114: PETSC_EXTERN PetscErrorCode MatColoringGetDegrees(Mat,PetscInt,PetscInt*);
1115: PETSC_EXTERN PetscErrorCode MatColoringDestroy(MatColoring*);
1116: PETSC_EXTERN PetscErrorCode MatColoringView(MatColoring,PetscViewer);
1117: PETSC_EXTERN PetscErrorCode MatColoringSetType(MatColoring,MatColoringType);
1118: PETSC_EXTERN PetscErrorCode MatColoringSetFromOptions(MatColoring);
1119: PETSC_EXTERN PetscErrorCode MatColoringSetDistance(MatColoring,PetscInt);
1120: PETSC_EXTERN PetscErrorCode MatColoringGetDistance(MatColoring,PetscInt*);
1121: PETSC_EXTERN PetscErrorCode MatColoringSetMaxColors(MatColoring,PetscInt);
1122: PETSC_EXTERN PetscErrorCode MatColoringGetMaxColors(MatColoring,PetscInt*);
1123: PETSC_EXTERN PetscErrorCode MatColoringApply(MatColoring,ISColoring*);
1124: PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[],PetscErrorCode(*)(MatColoring));
1125: PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1126: PETSC_EXTERN PetscErrorCode MatColoringSetWeightType(MatColoring,MatColoringWeightType);
1127: PETSC_EXTERN PetscErrorCode MatColoringSetWeights(MatColoring,PetscReal*,PetscInt*);
1128: PETSC_EXTERN PetscErrorCode MatColoringCreateWeights(MatColoring,PetscReal **,PetscInt **lperm);

1130: /*S
1131:      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1132:         and coloring

1134:    Level: beginner

1136:   Concepts: coloring, sparse Jacobian, finite differences

1138: .seealso:  MatFDColoringCreate()
1139: S*/
1140: typedef struct _p_MatFDColoring* MatFDColoring;

1142: PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1143: PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring*);
1144: PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer);
1145: PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
1146: PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1147: PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1148: PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring);
1149: PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,void *);
1150: PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec);
1151: PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]);
1152: PETSC_EXTERN PetscErrorCode MatFDColoringSetUp(Mat,ISColoring,MatFDColoring);
1153: PETSC_EXTERN PetscErrorCode MatFDColoringSetBlockSize(MatFDColoring,PetscInt,PetscInt);


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

1159:    Level: beginner

1161:   Concepts: coloring, sparse matrix product

1163: .seealso:  MatTransposeColoringCreate()
1164: S*/
1165: typedef struct _p_MatTransposeColoring* MatTransposeColoring;

1167: PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat,ISColoring,MatTransposeColoring *);
1168: PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring,Mat,Mat);
1169: PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring,Mat,Mat);
1170: PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring*);

1172: /*
1173:     These routines are for partitioning matrices: currently used only
1174:   for adjacency matrix, MatCreateMPIAdj().
1175: */

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

1180:    Level: beginner

1182:   Concepts: partitioning

1184: .seealso:  MatPartitioningCreate(), MatPartitioningType
1185: S*/
1186: typedef struct _p_MatPartitioning* MatPartitioning;

1188: /*J
1189:     MatPartitioningType - String with the name of a PETSc matrix partitioning

1191:    Level: beginner
1192: dm
1193: .seealso: MatPartitioningCreate(), MatPartitioning
1194: J*/
1195: typedef const char* MatPartitioningType;
1196: #define MATPARTITIONINGCURRENT  "current"
1197: #define MATPARTITIONINGSQUARE   "square"
1198: #define MATPARTITIONINGPARMETIS "parmetis"
1199: #define MATPARTITIONINGCHACO    "chaco"
1200: #define MATPARTITIONINGPARTY    "party"
1201: #define MATPARTITIONINGPTSCOTCH "ptscotch"


1204: PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1205: PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,MatPartitioningType);
1206: PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt);
1207: PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat);
1208: PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1209: PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1210: PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*);
1211: PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning*);

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



1217: PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer);
1218: PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning);
1219: PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,MatPartitioningType*);

1221: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
1222: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);

1224: typedef enum { MP_CHACO_MULTILEVEL=1,MP_CHACO_SPECTRAL=2,MP_CHACO_LINEAR=4,MP_CHACO_RANDOM=5,MP_CHACO_SCATTERED=6 } MPChacoGlobalType;
1225: PETSC_EXTERN const char *const MPChacoGlobalTypes[];
1226: typedef enum { MP_CHACO_KERNIGHAN=1,MP_CHACO_NONE=2 } MPChacoLocalType;
1227: PETSC_EXTERN const char *const MPChacoLocalTypes[];
1228: typedef enum { MP_CHACO_LANCZOS=0,MP_CHACO_RQI=1 } MPChacoEigenType;
1229: PETSC_EXTERN const char *const MPChacoEigenTypes[];

1231: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning,MPChacoGlobalType);
1232: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning,MPChacoGlobalType*);
1233: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning,MPChacoLocalType);
1234: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning,MPChacoLocalType*);
1235: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
1236: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1237: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning,MPChacoEigenType*);
1238: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning,PetscReal);
1239: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning,PetscReal*);
1240: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning,PetscInt);
1241: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning,PetscInt*);

1243: #define MP_PARTY_OPT "opt"
1244: #define MP_PARTY_LIN "lin"
1245: #define MP_PARTY_SCA "sca"
1246: #define MP_PARTY_RAN "ran"
1247: #define MP_PARTY_GBF "gbf"
1248: #define MP_PARTY_GCF "gcf"
1249: #define MP_PARTY_BUB "bub"
1250: #define MP_PARTY_DEF "def"
1251: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning,const char*);
1252: #define MP_PARTY_HELPFUL_SETS "hs"
1253: #define MP_PARTY_KERNIGHAN_LIN "kl"
1254: #define MP_PARTY_NONE "no"
1255: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning,const char*);
1256: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1257: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscBool);
1258: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool);

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

1263: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal);
1264: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*);
1265: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType);
1266: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*);

1268: /*
1269:     These routines are for coarsening matrices:
1270: */

1272: /*S
1273:      MatCoarsen - Object for managing the coarsening of a graph (symmetric matrix)

1275:    Level: beginner

1277:   Concepts: coarsen

1279: .seealso:  MatCoarsenCreate), MatCoarsenType
1280: S*/
1281: typedef struct _p_MatCoarsen* MatCoarsen;

1283: /*J
1284:     MatCoarsenType - String with the name of a PETSc matrix coarsen

1286:    Level: beginner

1288: .seealso: MatCoarsenCreate(), MatCoarsen
1289: J*/
1290: typedef const char* MatCoarsenType;
1291: #define MATCOARSENMIS  "mis"
1292: #define MATCOARSENHEM  "hem"

1294: /* linked list for aggregates */
1295: typedef struct _PetscCDIntNd{
1296:   struct _PetscCDIntNd *next;
1297:   PetscInt             gid;
1298: }PetscCDIntNd;

1300: /* only used by node pool */
1301: typedef struct _PetscCDArrNd{
1302:   struct _PetscCDArrNd *next;
1303:   struct _PetscCDIntNd *array;
1304: }PetscCDArrNd;

1306: typedef struct _PetscCoarsenData{
1307:   PetscCDArrNd pool_list;  /* node pool */
1308:   PetscCDIntNd *new_node;
1309:   PetscInt     new_left;
1310:   PetscInt     chk_sz;
1311:   PetscCDIntNd *extra_nodes;
1312:   PetscCDIntNd **array;  /* Array of lists */
1313:   PetscInt     size;
1314:   Mat          mat;  /* cache a Mat for communication data */
1315: }PetscCoarsenData;

1317: PETSC_EXTERN PetscErrorCode MatCoarsenCreate(MPI_Comm,MatCoarsen*);
1318: PETSC_EXTERN PetscErrorCode MatCoarsenSetType(MatCoarsen,MatCoarsenType);
1319: PETSC_EXTERN PetscErrorCode MatCoarsenSetAdjacency(MatCoarsen,Mat);
1320: PETSC_EXTERN PetscErrorCode MatCoarsenSetGreedyOrdering(MatCoarsen,const IS);
1321: PETSC_EXTERN PetscErrorCode MatCoarsenSetStrictAggs(MatCoarsen,PetscBool);
1322: PETSC_EXTERN PetscErrorCode MatCoarsenGetData( MatCoarsen, PetscCoarsenData ** );
1323: PETSC_EXTERN PetscErrorCode MatCoarsenApply(MatCoarsen);
1324: PETSC_EXTERN PetscErrorCode MatCoarsenDestroy(MatCoarsen*);

1326: PETSC_EXTERN PetscErrorCode MatCoarsenRegister(const char[],PetscErrorCode (*)(MatCoarsen));



1330: PETSC_EXTERN PetscErrorCode MatCoarsenView(MatCoarsen,PetscViewer);
1331: PETSC_EXTERN PetscErrorCode MatCoarsenSetFromOptions(MatCoarsen);
1332: PETSC_EXTERN PetscErrorCode MatCoarsenGetType(MatCoarsen,MatCoarsenType*);
1333: PETSC_STATIC_INLINE PetscErrorCode MatCoarsenViewFromOptions(MatCoarsen A,const char prefix[],const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,prefix,name);}

1335: PETSC_EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*);
1336: PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*);

1338: /*
1339:     If you add entries here you must also add them to petsc/finclude/petscmat.h
1340: */
1341: typedef enum { MATOP_SET_VALUES=0,
1342:                MATOP_GET_ROW=1,
1343:                MATOP_RESTORE_ROW=2,
1344:                MATOP_MULT=3,
1345:                MATOP_MULT_ADD=4,
1346:                MATOP_MULT_TRANSPOSE=5,
1347:                MATOP_MULT_TRANSPOSE_ADD=6,
1348:                MATOP_SOLVE=7,
1349:                MATOP_SOLVE_ADD=8,
1350:                MATOP_SOLVE_TRANSPOSE=9,
1351:                MATOP_SOLVE_TRANSPOSE_ADD=10,
1352:                MATOP_LUFACTOR=11,
1353:                MATOP_CHOLESKYFACTOR=12,
1354:                MATOP_SOR=13,
1355:                MATOP_TRANSPOSE=14,
1356:                MATOP_GETINFO=15,
1357:                MATOP_EQUAL=16,
1358:                MATOP_GET_DIAGONAL=17,
1359:                MATOP_DIAGONAL_SCALE=18,
1360:                MATOP_NORM=19,
1361:                MATOP_ASSEMBLY_BEGIN=20,
1362:                MATOP_ASSEMBLY_END=21,
1363:                MATOP_SET_OPTION=22,
1364:                MATOP_ZERO_ENTRIES=23,
1365:                MATOP_ZERO_ROWS=24,
1366:                MATOP_LUFACTOR_SYMBOLIC=25,
1367:                MATOP_LUFACTOR_NUMERIC=26,
1368:                MATOP_CHOLESKY_FACTOR_SYMBOLIC=27,
1369:                MATOP_CHOLESKY_FACTOR_NUMERIC=28,
1370:                MATOP_SETUP_PREALLOCATION=29,
1371:                MATOP_ILUFACTOR_SYMBOLIC=30,
1372:                MATOP_ICCFACTOR_SYMBOLIC=31,
1373:                /* MATOP_PLACEHOLDER_32=32, */
1374:                /* MATOP_PLACEHOLDER_33=33, */
1375:                MATOP_DUPLICATE=34,
1376:                MATOP_FORWARD_SOLVE=35,
1377:                MATOP_BACKWARD_SOLVE=36,
1378:                MATOP_ILUFACTOR=37,
1379:                MATOP_ICCFACTOR=38,
1380:                MATOP_AXPY=39,
1381:                MATOP_GET_SUBMATRICES=40,
1382:                MATOP_INCREASE_OVERLAP=41,
1383:                MATOP_GET_VALUES=42,
1384:                MATOP_COPY=43,
1385:                MATOP_GET_ROW_MAX=44,
1386:                MATOP_SCALE=45,
1387:                MATOP_SHIFT=46,
1388:                MATOP_DIAGONAL_SET=47,
1389:                MATOP_ZERO_ROWS_COLUMNS=48,
1390:                MATOP_SET_RANDOM=49,
1391:                MATOP_GET_ROW_IJ=50,
1392:                MATOP_RESTORE_ROW_IJ=51,
1393:                MATOP_GET_COLUMN_IJ=52,
1394:                MATOP_RESTORE_COLUMN_IJ=53,
1395:                MATOP_FDCOLORING_CREATE=54,
1396:                MATOP_COLORING_PATCH=55,
1397:                MATOP_SET_UNFACTORED=56,
1398:                MATOP_PERMUTE=57,
1399:                MATOP_SET_VALUES_BLOCKED=58,
1400:                MATOP_GET_SUBMATRIX=59,
1401:                MATOP_DESTROY=60,
1402:                MATOP_VIEW=61,
1403:                MATOP_CONVERT_FROM=62,
1404:                MATOP_MATMAT_MULT=63,
1405:                MATOP_MATMAT_MULT_SYMBOLIC=64,
1406:                MATOP_MATMAT_MULT_NUMERIC=65,
1407:                MATOP_SET_LOCAL_TO_GLOBAL_MAP=66,
1408:                MATOP_SET_VALUES_LOCAL=67,
1409:                MATOP_ZERO_ROWS_LOCAL=68,
1410:                MATOP_GET_ROW_MAX_ABS=69,
1411:                MATOP_GET_ROW_MIN_ABS=70,
1412:                MATOP_CONVERT=71,
1413:                MATOP_SET_COLORING=72,
1414:                /* MATOP_PLACEHOLDER_73=73, */
1415:                MATOP_SET_VALUES_ADIFOR=74,
1416:                MATOP_FD_COLORING_APPLY=75,
1417:                MATOP_SET_FROM_OPTIONS=76,
1418:                MATOP_MULT_CONSTRAINED=77,
1419:                MATOP_MULT_TRANSPOSE_CONSTRAIN=78,
1420:                MATOP_FIND_ZERO_DIAGONALS=79,
1421:                MATOP_MULT_MULTIPLE=80,
1422:                MATOP_SOLVE_MULTIPLE=81,
1423:                MATOP_GET_INERTIA=82,
1424:                MATOP_LOAD=83,
1425:                MATOP_IS_SYMMETRIC=84,
1426:                MATOP_IS_HERMITIAN=85,
1427:                MATOP_IS_STRUCTURALLY_SYMMETRIC=86,
1428:                MATOP_SET_VALUES_BLOCKEDLOCAL=87,
1429:                MATOP_GET_VECS=88,
1430:                MATOP_MAT_MULT=89,
1431:                MATOP_MAT_MULT_SYMBOLIC=90,
1432:                MATOP_MAT_MULT_NUMERIC=91,
1433:                MATOP_PTAP=92,
1434:                MATOP_PTAP_SYMBOLIC=93,
1435:                MATOP_PTAP_NUMERIC=94,
1436:                MATOP_MAT_TRANSPOSE_MULT=95,
1437:                MATOP_MAT_TRANSPOSE_MULT_SYMBO=96,
1438:                MATOP_MAT_TRANSPOSE_MULT_NUMER=97,
1439:                /* MATOP_PLACEHOLDER_98=98, */
1440:                /* MATOP_PLACEHOLDER_99=99, */
1441:                /* MATOP_PLACEHOLDER_100=100, */
1442:                /* MATOP_PLACEHOLDER_101=101, */
1443:                MATOP_CONJUGATE=102,
1444:                /* MATOP_PLACEHOLDER_103=103, */
1445:                MATOP_SET_VALUES_ROW=104,
1446:                MATOP_REAL_PART=105,
1447:                MATOP_IMAGINARY_PART=106,
1448:                MATOP_GET_ROW_UPPER_TRIANGULAR=107,
1449:                MATOP_RESTORE_ROW_UPPER_TRIANG=108,
1450:                MATOP_MAT_SOLVE=109,
1451:                MATOP_GET_REDUNDANT_MATRIX=110,
1452:                MATOP_GET_ROW_MIN=111,
1453:                MATOP_GET_COLUMN_VECTOR=112,
1454:                MATOP_MISSING_DIAGONAL=113,
1455:                MATOP_GET_SEQ_NONZERO_STRUCTUR=114,
1456:                MATOP_CREATE=115,
1457:                MATOP_GET_GHOSTS=116,
1458:                MATOP_GET_LOCAL_SUB_MATRIX=117,
1459:                MATOP_RESTORE_LOCALSUB_MATRIX=118,
1460:                MATOP_MULT_DIAGONAL_BLOCK=119,
1461:                MATOP_HERMITIAN_TRANSPOSE=120,
1462:                MATOP_MULT_HERMITIAN_TRANSPOSE=121,
1463:                MATOP_MULT_HERMITIAN_TRANS_ADD=122,
1464:                MATOP_GET_MULTI_PROC_BLOCK=123,
1465:                MATOP_FIND_NONZERO_ROWS=124,
1466:                MATOP_GET_COLUMN_NORMS=125,
1467:                MATOP_INVERT_BLOCK_DIAGONAL=126,
1468:                /* MATOP_PLACEHOLDER_127=127, */
1469:                MATOP_GET_SUB_MATRICES_PARALLE=128,
1470:                MATOP_SET_VALUES_BATCH=129,
1471:                MATOP_TRANSPOSE_MAT_MULT=130,
1472:                MATOP_TRANSPOSE_MAT_MULT_SYMBO=131,
1473:                MATOP_TRANSPOSE_MAT_MULT_NUMER=132,
1474:                MATOP_TRANSPOSE_COLORING_CREAT=133,
1475:                MATOP_TRANS_COLORING_APPLY_SPT=134,
1476:                MATOP_TRANS_COLORING_APPLY_DEN=135,
1477:                MATOP_RART=136,
1478:                MATOP_RART_SYMBOLIC=137,
1479:                MATOP_RART_NUMERIC=138,
1480:                MATOP_SET_BLOCK_SIZES=139,
1481:                MATOP_AYPX=140,
1482:                MATOP_RESIDUAL=141,
1483:                MATOP_FDCOLORING_SETUP=142,
1484:                MATOP_MPICONCATENATESEQ=144
1485:              } MatOperation;
1486: PETSC_EXTERN PetscErrorCode MatHasOperation(Mat,MatOperation,PetscBool *);
1487: PETSC_EXTERN PetscErrorCode MatShellSetOperation(Mat,MatOperation,void(*)(void));
1488: PETSC_EXTERN PetscErrorCode MatShellGetOperation(Mat,MatOperation,void(**)(void));
1489: PETSC_EXTERN PetscErrorCode MatShellSetContext(Mat,void*);

1491: /*
1492:    Codes for matrices stored on disk. By default they are
1493:    stored in a universal format. By changing the format with
1494:    PetscViewerSetFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
1495:    be stored in a way natural for the matrix, for example dense matrices
1496:    would be stored as dense. Matrices stored this way may only be
1497:    read into matrices of the same type.
1498: */
1499: #define MATRIX_BINARY_FORMAT_DENSE -1

1501: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1502: PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*);
1503: PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat,Mat);
1504: PETSC_EXTERN PetscErrorCode MatISGetMPIXAIJ(Mat,MatReuse,Mat*);

1506: /*S
1507:      MatNullSpace - Object that removes a null space from a vector, i.e.
1508:          orthogonalizes the vector to a subsapce

1510:    Level: advanced

1512:   Concepts: matrix; linear operator, null space

1514:   Users manual sections:
1515: .   Section 4.18 Solving Singular Systems

1517: .seealso:  MatNullSpaceCreate()
1518: S*/
1519: typedef struct _p_MatNullSpace* MatNullSpace;

1521: PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*);
1522: PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*);
1523: PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace*);
1524: PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec);
1525: PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *);
1526: PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat,MatNullSpace);
1527: PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat,MatNullSpace);
1528: PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat,MatNullSpace*);
1529: PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscBool  *);
1530: PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace,PetscViewer);
1531: PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace,PetscBool*,PetscInt*,const Vec**);
1532: PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec,MatNullSpace*);

1534: PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS);
1535: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1536: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
1537: PETSC_EXTERN PetscErrorCode MatSeqBAIJInvertBlockDiagonal(Mat);

1539: PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*);
1540: PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*);
1541: PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*);

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

1545: PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec);

1547: PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
1548: PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec);
1549: PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
1550: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
1551: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
1552: PETSC_EXTERN PetscErrorCode MatMFFDAddNullSpace(Mat,MatNullSpace);
1553: PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
1554: PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat);
1555: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal);
1556: PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt);
1557: PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat,PetscScalar *);
1558: PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat,const char[]);
1559: PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
1560: PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);

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

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

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

1570:     Level: developer

1572: .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister()
1573: S*/
1574: typedef struct _p_MatMFFD* MatMFFD;

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

1579:    Level: beginner

1581: .seealso: MatMFFDSetType(), MatMFFDRegister()
1582: J*/
1583: typedef const char* MatMFFDType;
1584: #define MATMFFD_DS  "ds"
1585: #define MATMFFD_WP  "wp"

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

1590: PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal);
1591: PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscBool );

1593: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1594: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);

1596: /*
1597:    PETSc interface to MUMPS
1598: */
1599: #ifdef PETSC_HAVE_MUMPS
1600: PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt);
1601: PETSC_EXTERN PetscErrorCode MatMumpsGetIcntl(Mat,PetscInt,PetscInt*);
1602: PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat,PetscInt,PetscReal);
1603: PETSC_EXTERN PetscErrorCode MatMumpsGetCntl(Mat,PetscInt,PetscReal*);

1605: PETSC_EXTERN PetscErrorCode MatMumpsGetInfo(Mat,PetscInt,PetscInt*);
1606: PETSC_EXTERN PetscErrorCode MatMumpsGetInfog(Mat,PetscInt,PetscInt*);
1607: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfo(Mat,PetscInt,PetscReal*);
1608: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfog(Mat,PetscInt,PetscReal*);
1609: #endif

1611: /*
1612:    PETSc interface to Mkl_Pardiso
1613: */
1614: #ifdef PETSC_HAVE_MKL_PARDISO
1615: PETSC_EXTERN PetscErrorCode MatMkl_PardisoSetCntl(Mat,PetscInt,PetscInt);
1616: #endif

1618: /*
1619:    PETSc interface to Mkl_CPardiso
1620: */
1621: #ifdef PETSC_HAVE_MKL_CPARDISO
1622: PETSC_EXTERN PetscErrorCode MatMkl_CPardisoSetCntl(Mat,PetscInt,PetscInt);
1623: #endif

1625: /*
1626:    PETSc interface to SUPERLU
1627: */
1628: #ifdef PETSC_HAVE_SUPERLU
1629: PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal);
1630: #endif

1632: #ifdef PETSC_HAVE_CUDA
1633: /*E
1634:     MatCUSPARSEStorageFormat - indicates the storage format for CUSPARSE (GPU)
1635:     matrices. 

1637:     Not Collective

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

1643:     Level: intermediate

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

1647: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEFormatOperation
1648: E*/

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

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

1655: /*E
1656:     MatCUSPARSEFormatOperation - indicates the operation of CUSPARSE (GPU)
1657:     matrices whose operation should use a particular storage format. 

1659:     Not Collective

1661: +   MAT_CUSPARSE_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult
1662: .   MAT_CUSPARSE_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult
1663: .   MAT_CUSPARSE_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult
1664: -   MAT_CUSPARSE_ALL - sets the storage format for all CUSPARSE (GPU) matrices

1666:     Level: intermediate

1668: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEStorageFormat
1669: E*/
1670: typedef enum {MAT_CUSPARSE_MULT_DIAG, MAT_CUSPARSE_MULT_OFFDIAG, MAT_CUSPARSE_MULT, MAT_CUSPARSE_ALL} MatCUSPARSEFormatOperation;

1672: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1673: PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1674: PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat,MatCUSPARSEFormatOperation,MatCUSPARSEStorageFormat);
1675: #endif

1677: #if defined(PETSC_HAVE_CUSP)
1678: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSP(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1679: PETSC_EXTERN PetscErrorCode MatCreateAIJCUSP(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);

1681: /*E
1682:     MatCUSPStorageFormat - indicates the storage format for CUSP (GPU)
1683:     matrices. 

1685:     Not Collective

1687: +   MAT_CUSP_CSR - Compressed Sparse Row
1688: .   MAT_CUSP_DIA - Diagonal
1689: -   MAT_CUSP_ELL - Ellpack

1691:     Level: intermediate

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

1695: .seealso: MatCUSPSetFormat(), MatCUSPFormatOperation
1696: E*/
1697: typedef enum {MAT_CUSP_CSR, MAT_CUSP_DIA, MAT_CUSP_ELL} MatCUSPStorageFormat;

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

1702: /*E
1703:     MatCUSPFormatOperation - indicates the operation of CUSP (GPU)
1704:     matrices whose operation should use a particular storage format. 

1706:     Not Collective

1708: +   MAT_CUSP_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult
1709: .   MAT_CUSP_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult
1710: .   MAT_CUSP_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult
1711: -   MAT_CUSP_ALL - sets the storage format for all CUSP (GPU) matrices

1713:     Level: intermediate

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

1717: .seealso: MatCUSPSetFormat(), MatCUSPStorageFormat
1718: E*/
1719: typedef enum {MAT_CUSP_MULT_DIAG, MAT_CUSP_MULT_OFFDIAG, MAT_CUSP_MULT, MAT_CUSP_ALL} MatCUSPFormatOperation;

1721: PETSC_EXTERN PetscErrorCode MatCUSPSetFormat(Mat,MatCUSPFormatOperation,MatCUSPStorageFormat);
1722: #endif

1724: #if defined(PETSC_HAVE_VIENNACL)
1725: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1726: PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1727: #endif

1729: /*
1730:    PETSc interface to FFTW
1731: */
1732: #if defined(PETSC_HAVE_FFTW)
1733: PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec);
1734: PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec);
1735: PETSC_EXTERN PetscErrorCode MatCreateVecsFFTW(Mat,Vec*,Vec*,Vec*);
1736: #endif

1738: /*
1739:    PETSc interface to ELEMENTAL
1740: */
1741: #if defined(PETSC_HAVE_ELEMENTAL)
1742: #if defined(PETSC_USE_COMPLEX)
1743: typedef El::Complex<PetscReal> PetscElemScalar;
1744: #else
1745: typedef PetscScalar PetscElemScalar;
1746: #endif
1747: PETSC_EXTERN PetscErrorCode PetscElementalInitializePackage(void);
1748: PETSC_EXTERN PetscErrorCode PetscElementalFinalizePackage(void);
1749: #endif

1751: PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*);
1752: PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*);
1753: PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat,IS[],IS[]);
1754: PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat,IS[],IS[]);
1755: PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***);
1756: PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*);
1757: PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat,VecType);
1758: PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]);
1759: PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat);

1761: PETSC_EXTERN PetscErrorCode MatChop(Mat,PetscReal);
1762: PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat,PetscReal,PetscInt*);

1764: #endif