Actual source code: petscmat.h

petsc-dev 2014-04-15
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 MATSOLVERPASTIX       "pastix"
110: #define MATSOLVERMATLAB       "matlab"
111: #define MATSOLVERPETSC        "petsc"
112: #define MATSOLVERBAS          "bas"
113: #define MATSOLVERCUSPARSE     "cusparse"
114: #define MATSOLVERBSTRM        "bstrm"
115: #define MATSOLVERSBSTRM       "sbstrm"
116: #define MATSOLVERELEMENTAL    "elemental"
117: #define MATSOLVERCLIQUE       "clique"
118: #define MATSOLVERKLU          "klu"

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

123:     Level: beginner

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

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

132: PETSC_EXTERN PetscErrorCode MatGetFactor(Mat,const MatSolverPackage,MatFactorType,Mat*);
133: PETSC_EXTERN PetscErrorCode MatGetFactorAvailable(Mat,const MatSolverPackage,MatFactorType,PetscBool *);
134: PETSC_EXTERN PetscErrorCode MatFactorGetSolverPackage(Mat,const MatSolverPackage*);
135: PETSC_EXTERN PetscErrorCode MatGetFactorType(Mat,MatFactorType*);

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

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

153:     Level: beginner

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

157: .seealso: MatGetSubMatrices(), MatGetSubMatrix(), MatDestroyMatrices(), MatConvert()
158: E*/
159: typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX} MatReuse;

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

165:     Level: beginner

167: .seealso: MatGetSeqNonzerostructure()
168: E*/
169: typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatGetSubMatrixOption;

171: PETSC_EXTERN PetscErrorCode MatInitializePackage(void);

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

185: PETSC_EXTERN PetscBool         MatRegisterAllCalled;
186: PETSC_EXTERN PetscFunctionList MatList;
187: PETSC_EXTERN PetscFunctionList MatColoringList;
188: PETSC_EXTERN PetscFunctionList MatPartitioningList;
189: PETSC_EXTERN PetscFunctionList MatCoarsenList;

191: /*E
192:     MatStructure - Indicates if two matrices have the same nonzero structure

194:     Level: beginner

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

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

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

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

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

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

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

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

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

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

247: PETSC_EXTERN PetscErrorCode MatCreateTranspose(Mat,Mat*);
248: PETSC_EXTERN PetscErrorCode MatCreateSubMatrix(Mat,IS,IS,Mat*);
249: PETSC_EXTERN PetscErrorCode MatSubMatrixUpdate(Mat,Mat,IS,IS);
250: PETSC_EXTERN PetscErrorCode MatCreateLocalRef(Mat,IS,IS,Mat*);

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

254: PETSC_EXTERN PetscErrorCode MatSetUp(Mat);
255: PETSC_EXTERN PetscErrorCode MatDestroy(Mat*);
256: PETSC_EXTERN PetscErrorCode MatGetNonzeroState(Mat,PetscObjectState*);

258: PETSC_EXTERN PetscErrorCode MatConjugate(Mat);
259: PETSC_EXTERN PetscErrorCode MatRealPart(Mat);
260: PETSC_EXTERN PetscErrorCode MatImaginaryPart(Mat);
261: PETSC_EXTERN PetscErrorCode MatGetDiagonalBlock(Mat,Mat*);
262: PETSC_EXTERN PetscErrorCode MatGetTrace(Mat,PetscScalar*);
263: PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonal(Mat,const PetscScalar **);

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

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

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

279:    Level: beginner

281:   Concepts: matrix; linear operator

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

289: PETSC_EXTERN PetscErrorCode MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
290: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
291: PETSC_EXTERN PetscErrorCode MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);

293: PETSC_EXTERN PetscErrorCode MatSetColoring(Mat,ISColoring);
294: PETSC_EXTERN PetscErrorCode MatSetValuesAdifor(Mat,PetscInt,void*);

296: /*E
297:     MatAssemblyType - Indicates if the matrix is now to be used, or if you plan
298:      to continue to add values to it

300:     Level: beginner

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



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

314:     Level: beginner

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

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

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

347: PETSC_EXTERN const char *MatOptions[];
348: PETSC_EXTERN PetscErrorCode MatSetOption(Mat,MatOption,PetscBool );
349: PETSC_EXTERN PetscErrorCode MatGetType(Mat,MatType*);

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

372: PETSC_EXTERN PetscErrorCode MatMult(Mat,Vec,Vec);
373: PETSC_EXTERN PetscErrorCode MatMultDiagonalBlock(Mat,Vec,Vec);
374: PETSC_EXTERN PetscErrorCode MatMultAdd(Mat,Vec,Vec,Vec);
375: PETSC_EXTERN PetscErrorCode MatMultTranspose(Mat,Vec,Vec);
376: PETSC_EXTERN PetscErrorCode MatMultHermitianTranspose(Mat,Vec,Vec);
377: PETSC_EXTERN PetscErrorCode MatIsTranspose(Mat,Mat,PetscReal,PetscBool *);
378: PETSC_EXTERN PetscErrorCode MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscBool *);
379: PETSC_EXTERN PetscErrorCode MatMultTransposeAdd(Mat,Vec,Vec,Vec);
380: PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec);
381: PETSC_EXTERN PetscErrorCode MatMultConstrained(Mat,Vec,Vec);
382: PETSC_EXTERN PetscErrorCode MatMultTransposeConstrained(Mat,Vec,Vec);
383: PETSC_EXTERN PetscErrorCode MatMatSolve(Mat,Mat,Mat);
384: PETSC_EXTERN PetscErrorCode MatResidual(Mat,Vec,Vec,Vec);

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

390:     Level: beginner

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

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

398: .seealso: MatDuplicate()
399: E*/
400: typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption;

402: PETSC_EXTERN PetscErrorCode MatConvert(Mat,MatType,MatReuse,Mat*);
403: PETSC_EXTERN PetscErrorCode MatDuplicate(Mat,MatDuplicateOption,Mat*);


406: PETSC_EXTERN PetscErrorCode MatCopy(Mat,Mat,MatStructure);
407: PETSC_EXTERN PetscErrorCode MatView(Mat,PetscViewer);
408: PETSC_EXTERN PetscErrorCode MatIsSymmetric(Mat,PetscReal,PetscBool *);
409: PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat,PetscBool *);
410: PETSC_EXTERN PetscErrorCode MatIsHermitian(Mat,PetscReal,PetscBool *);
411: PETSC_EXTERN PetscErrorCode MatIsSymmetricKnown(Mat,PetscBool *,PetscBool *);
412: PETSC_EXTERN PetscErrorCode MatIsHermitianKnown(Mat,PetscBool *,PetscBool *);
413: PETSC_EXTERN PetscErrorCode MatMissingDiagonal(Mat,PetscBool  *,PetscInt *);
414: PETSC_EXTERN PetscErrorCode MatLoad(Mat, PetscViewer);

416: PETSC_EXTERN PetscErrorCode MatGetRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool  *);
417: PETSC_EXTERN PetscErrorCode MatRestoreRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool  *);
418: PETSC_EXTERN PetscErrorCode MatGetColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool  *);
419: PETSC_EXTERN PetscErrorCode MatRestoreColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool  *);

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

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

426:    Level: intermediate

428:   Concepts: matrix^nonzero information

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

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

446:     Level: beginner

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

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

471: PETSC_EXTERN PetscErrorCode MatNorm(Mat,NormType,PetscReal *);
472: PETSC_EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal *);
473: PETSC_EXTERN PetscErrorCode MatZeroEntries(Mat);
474: PETSC_EXTERN PetscErrorCode MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
475: PETSC_EXTERN PetscErrorCode MatZeroRowsIS(Mat,IS,PetscScalar,Vec,Vec);
476: PETSC_EXTERN PetscErrorCode MatZeroRowsStencil(Mat,PetscInt,const MatStencil [],PetscScalar,Vec,Vec);
477: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsStencil(Mat,PetscInt,const MatStencil[],PetscScalar,Vec,Vec);
478: PETSC_EXTERN PetscErrorCode MatZeroRowsColumns(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
479: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsIS(Mat,IS,PetscScalar,Vec,Vec);

481: PETSC_EXTERN PetscErrorCode MatGetSize(Mat,PetscInt*,PetscInt*);
482: PETSC_EXTERN PetscErrorCode MatGetLocalSize(Mat,PetscInt*,PetscInt*);
483: PETSC_EXTERN PetscErrorCode MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
484: PETSC_EXTERN PetscErrorCode MatGetOwnershipRanges(Mat,const PetscInt**);
485: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*);
486: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat,const PetscInt**);
487: PETSC_EXTERN PetscErrorCode MatGetOwnershipIS(Mat,IS*,IS*);

489: PETSC_EXTERN PetscErrorCode MatGetSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
490: PETSC_EXTERN PetscErrorCode MatGetSubMatricesParallel(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
491: PETSC_EXTERN PetscErrorCode MatDestroyMatrices(PetscInt,Mat *[]);
492: PETSC_EXTERN PetscErrorCode MatGetSubMatrix(Mat,IS,IS,MatReuse,Mat *);
493: PETSC_EXTERN PetscErrorCode MatGetLocalSubMatrix(Mat,IS,IS,Mat*);
494: PETSC_EXTERN PetscErrorCode MatRestoreLocalSubMatrix(Mat,IS,IS,Mat*);
495: PETSC_EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat,Mat*);
496: PETSC_EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat*);

498: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJConcatenateSeqAIJ(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);
499: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJConcatenateSeqAIJSymbolic(MPI_Comm,Mat,PetscInt,Mat*);
500: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJConcatenateSeqAIJNumeric(MPI_Comm,Mat,PetscInt,Mat);
501: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJ(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
502: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJSymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
503: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJNumeric(Mat,Mat);
504: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMat(Mat,MatReuse,Mat*);
505: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
506: PETSC_EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,Mat*);
507: PETSC_EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *,const PetscInt *[]);

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

511: PETSC_EXTERN PetscErrorCode MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
512: PETSC_EXTERN PetscErrorCode MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
513: PETSC_EXTERN PetscErrorCode MatMatMultNumeric(Mat,Mat,Mat);

515: PETSC_EXTERN PetscErrorCode MatMatMatMult(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);
516: PETSC_EXTERN PetscErrorCode MatMatMatMultSymbolic(Mat,Mat,Mat,PetscReal,Mat*);
517: PETSC_EXTERN PetscErrorCode MatMatMatMultNumeric(Mat,Mat,Mat,Mat);

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

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

533: PETSC_EXTERN PetscErrorCode MatAXPY(Mat,PetscScalar,Mat,MatStructure);
534: PETSC_EXTERN PetscErrorCode MatAYPX(Mat,PetscScalar,Mat,MatStructure);

536: PETSC_EXTERN PetscErrorCode MatScale(Mat,PetscScalar);
537: PETSC_EXTERN PetscErrorCode MatShift(Mat,PetscScalar);

539: PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping);
540: PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMappingBlock(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping);
541: PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*);
542: PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMappingBlock(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 MatGetVecs(Mat,Vec*,Vec*);
558: PETSC_EXTERN PetscErrorCode MatGetRedundantMatrix(Mat,PetscInt,MPI_Comm,MatReuse,Mat*);
559: PETSC_EXTERN PetscErrorCode MatGetMultiProcBlock(Mat,MPI_Comm,MatReuse,Mat*);
560: PETSC_EXTERN PetscErrorCode MatFindZeroDiagonals(Mat,IS*);
561: PETSC_EXTERN PetscErrorCode MatFindOffBlockDiagonalEntries(Mat,IS*);

563: /*MC
564:    MatSetValue - Set a single entry into a matrix.

566:    Not collective

568:    Input Parameters:
569: +  m - the matrix
570: .  row - the row location of the entry
571: .  col - the column location of the entry
572: .  value - the value to insert
573: -  mode - either INSERT_VALUES or ADD_VALUES

575:    Notes:
576:    For efficiency one should use MatSetValues() and set several or many
577:    values simultaneously if possible.

579:    Level: beginner

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

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

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

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

593:    Synopsis:
594:    #include <petscmat.h>
595:    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)

597:    Collective on MPI_Comm

599:    Input Parameters:
600: +  comm - the communicator that will share the eventually allocated matrix
601: .  nrows - the number of LOCAL rows in the matrix
602: -  ncols - the number of LOCAL columns in the matrix

604:    Output Parameters:
605: +  dnz - the array that will be passed to the matrix preallocation routines
606: -  ozn - the other array passed to the matrix preallocation routines

608:    Level: intermediate

610:    Notes:
611:     See the <A href="../../docs/manual.pdf#nameddest=Chapter 11 Hints for Performance Tuning">Hints for Performance Improvment</A> chapter in the users manual for more details.

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

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

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

619:   Concepts: preallocation^Matrix

621: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
622:           MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocal()
623: M*/
624: #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
625: { \
626:   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ctmp = (ncols),__rstart,__start,__end; \
627:   _4_PetscCalloc2(__nrows,&dnz,__nrows,&onz);CHKERRQ(_4_ierr); \
628:   __start = 0; __end = __start;                                         \
629:   _4_MPI_Scan(&__ctmp,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ctmp;\
630:   _4_MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows;

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

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

640:    Not Collective

642:    Input Parameters:
643: +  map - the row mapping from local numbering to global numbering
644: .  nrows - the number of rows indicated
645: .  rows - the indices of the rows
646: .  cmap - the column mapping from local to global numbering
647: .  ncols - the number of columns in the matrix
648: .  cols - the columns indicated
649: .  dnz - the array that will be passed to the matrix preallocation routines
650: -  ozn - the other array passed to the matrix preallocation routines

652:    Level: intermediate

654:    Notes:
655:     See the <A href="../../docs/manual.pdf#nameddest=Chapter 11 Hints for Performance Tuning">Hints for Performance Improvment</A> chapter in the users manual for more details.

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

659:   Concepts: preallocation^Matrix

661: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
662:           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal()
663: M*/
664: #define MatPreallocateSetLocal(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
665: {\
666:   PetscInt __l;\
667:   _4_ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
668:   _4_ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
669:   for (__l=0;__l<nrows;__l++) {\
670:     _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
671:   }\
672: }

674: /*MC
675:    MatPreallocateSymmetricSetLocal - Indicates the locations (rows and columns) in the matrix where nonzeros will be
676:        inserted using a local number of the rows and columns

678:    Synopsis:
679:    #include <petscmat.h>
680:    PetscErrorCode MatPreallocateSymmetricSetLocal(ISLocalToGlobalMappping map,PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

682:    Not Collective

684:    Input Parameters:
685: +  map - the mapping between local numbering and global numbering
686: .  nrows - the number of rows indicated
687: .  rows - the indices of the rows
688: .  ncols - the number of columns in the matrix
689: .  cols - the columns indicated
690: .  dnz - the array that will be passed to the matrix preallocation routines
691: -  ozn - the other array passed to the matrix preallocation routines

693:    Level: intermediate

695:    Notes:
696:     See the <A href="../../docs/manual.pdf#nameddest=Chapter 11 Hints for Performance Tuning">Hints for Performance Improvment</A> chapter in the users manual for more details.

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

700:   Concepts: preallocation^Matrix

702: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
703:           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
704: M*/
705: #define MatPreallocateSymmetricSetLocal(map,nrows,rows,ncols,cols,dnz,onz) 0;\
706: {\
707:   PetscInt __l;\
708:   _4_ISLocalToGlobalMappingApply(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
709:   _4_ISLocalToGlobalMappingApply(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
710:   for (__l=0;__l<nrows;__l++) {\
711:     _4_MatPreallocateSymmetricSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
712:   }\
713: }

715: /*MC
716:    MatPreallocateSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
717:        inserted using a local number of the rows and columns

719:    Synopsis:
720:    #include <petscmat.h>
721:    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

723:    Not Collective

725:    Input Parameters:
726: +  row - the row
727: .  ncols - the number of columns in the matrix
728: -  cols - the columns indicated

730:    Output Parameters:
731: +  dnz - the array that will be passed to the matrix preallocation routines
732: -  ozn - the other array passed to the matrix preallocation routines

734:    Level: intermediate

736:    Notes:
737:     See the <A href="../../docs/manual.pdf#nameddest=Chapter 11 Hints for Performance Tuning">Hints for Performance Improvment</A> chapter in the users manual for more details.

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

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

743:   Concepts: preallocation^Matrix

745: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
746:           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
747: M*/
748: #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
749: { PetscInt __i; \
750:   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);\
751:   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);\
752:   for (__i=0; __i<nc; __i++) {\
753:     if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
754:     else dnz[row - __rstart]++;\
755:   }\
756: }

758: /*MC
759:    MatPreallocateSymmetricSet - Indicates the locations (rows and columns) in the matrix where nonzeros will be
760:        inserted using a local number of the rows and columns

762:    Synopsis:
763:    #include <petscmat.h>
764:    PetscErrorCode MatPreallocateSymmetricSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

766:    Not Collective

768:    Input Parameters:
769: +  nrows - the number of rows indicated
770: .  rows - the indices of the rows
771: .  ncols - the number of columns in the matrix
772: .  cols - the columns indicated
773: .  dnz - the array that will be passed to the matrix preallocation routines
774: -  ozn - the other array passed to the matrix preallocation routines

776:    Level: intermediate

778:    Notes:
779:     See the <A href="../../docs/manual.pdf#nameddest=Chapter 11 Hints for Performance Tuning">Hints for Performance Improvment</A> chapter in the users manual for more details.

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

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

785:   Concepts: preallocation^Matrix

787: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateInitialize(),
788:           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocal(), MatPreallocateSetLocal()
789: M*/
790: #define MatPreallocateSymmetricSet(row,nc,cols,dnz,onz) 0;\
791: { PetscInt __i; \
792:   for (__i=0; __i<nc; __i++) {\
793:     if (cols[__i] >= __end) onz[row - __rstart]++; \
794:     else if (cols[__i] >= row) dnz[row - __rstart]++;\
795:   }\
796: }

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

801:    Synopsis:
802:    #include <petscmat.h>
803:    PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)

805:    Not Collective

807:    Input Parameters:
808: .  A - matrix
809: .  row - row where values exist (must be local to this process)
810: .  ncols - number of columns
811: .  cols - columns with nonzeros
812: .  dnz - the array that will be passed to the matrix preallocation routines
813: -  ozn - the other array passed to the matrix preallocation routines

815:    Level: intermediate

817:    Notes:
818:     See the <A href="../../docs/manual.pdf#nameddest=Chapter 11 Hints for Performance Tuning">Hints for Performance Improvment</A> chapter in the users manual for more details.

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

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

824:   Concepts: preallocation^Matrix

826: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
827:           MatPreallocateSymmetricSetLocal()
828: M*/
829: #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);}


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

836:    Synopsis:
837:    #include <petscmat.h>
838:    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)

840:    Collective on MPI_Comm

842:    Input Parameters:
843: +  dnz - the array that was be passed to the matrix preallocation routines
844: -  ozn - the other array passed to the matrix preallocation routines

846:    Level: intermediate

848:    Notes:
849:     See the <A href="../../docs/manual.pdf#nameddest=Chapter 11 Hints for Performance Tuning">Hints for Performance Improvment</A> chapter in the users manual for more details.

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

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

855:   Concepts: preallocation^Matrix

857: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSet(), MatPreallocateSetLocal(),
858:           MatPreallocateSymmetricSetLocal()
859: M*/
860: #define MatPreallocateFinalize(dnz,onz) 0;_4_PetscFree2(dnz,onz);CHKERRQ(_4_ierr);}

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

865: PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*);
866: PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);

868: PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
869: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
870: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
871: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
872: PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
873: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*,PetscInt,PetscBool);

875: #define MAT_SKIP_ALLOCATION -4

877: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
878: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
879: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);

881: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
882: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
883: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
884: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
885: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
886: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
887: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
888: PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
889: PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
890: PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
891: PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
892: PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
893: PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat,Mat*);

895: PETSC_EXTERN PetscErrorCode MatSeqDenseSetLDA(Mat,PetscInt);
896: PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*);

898: PETSC_EXTERN PetscErrorCode MatStoreValues(Mat);
899: PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat);

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

903: PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat,IS*);
904: /*
905:   These routines are not usually accessed directly, rather solving is
906:   done through the KSP and PC interfaces.
907: */

909: /*J
910:     MatOrderingType - String with the name of a PETSc matrix ordering

912:    Level: beginner

914: .seealso: MatGetOrdering()
915: J*/
916: typedef const char* MatOrderingType;
917: #define MATORDERINGNATURAL     "natural"
918: #define MATORDERINGND          "nd"
919: #define MATORDERING1WD         "1wd"
920: #define MATORDERINGRCM         "rcm"
921: #define MATORDERINGQMD         "qmd"
922: #define MATORDERINGROWLENGTH   "rowlength"
923: #define MATORDERINGWBM         "wbm"
924: #define MATORDERINGSPECTRAL    "spectral"
925: #define MATORDERINGAMD         "amd"            /* only works if UMFPACK is installed with PETSc */

927: PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat,MatOrderingType,IS*,IS*);
928: PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFunctionList*);
929: PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[],PetscErrorCode(*)(Mat,MatOrderingType,IS*,IS*));
930: PETSC_EXTERN PetscErrorCode MatOrderingRegisterAll(void);
931: PETSC_EXTERN PetscBool         MatOrderingRegisterAllCalled;
932: PETSC_EXTERN PetscFunctionList MatOrderingList;

934: PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
935: PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat,PetscReal,PetscBool,Mat*);

937: /*S
938:     MatFactorShiftType - Numeric Shift.

940:    Level: beginner

942: S*/
943: typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType;
944: PETSC_EXTERN const char *const MatFactorShiftTypes[];
945: PETSC_EXTERN const char *const MatFactorShiftTypesDetail[];

947: /*S
948:    MatFactorInfo - Data passed into the matrix factorization routines

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

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

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

957:    Level: developer

959: .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
960:           MatFactorInfoInitialize()

962: S*/
963: typedef struct {
964:   PetscReal     diagonal_fill;  /* force diagonal to fill in if initially not filled */
965:   PetscReal     usedt;
966:   PetscReal     dt;             /* drop tolerance */
967:   PetscReal     dtcol;          /* tolerance for pivoting */
968:   PetscReal     dtcount;        /* maximum nonzeros to be allowed per row */
969:   PetscReal     fill;           /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
970:   PetscReal     levels;         /* ICC/ILU(levels) */
971:   PetscReal     pivotinblocks;  /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
972:                                    factorization may be faster if do not pivot */
973:   PetscReal     zeropivot;      /* pivot is called zero if less than this */
974:   PetscReal     shifttype;      /* type of shift added to matrix factor to prevent zero pivots */
975:   PetscReal     shiftamount;     /* how large the shift is */
976: } MatFactorInfo;

978: PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*);
979: PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*);
980: PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
981: PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*);
982: PETSC_EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*);
983: PETSC_EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*);
984: PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
985: PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
986: PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
987: PETSC_EXTERN PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*);
988: PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*);
989: PETSC_EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
990: PETSC_EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec);
991: PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec);
992: PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec);
993: PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec);
994: PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec);
995: PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
996: PETSC_EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs);

998: PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat);

1000: /*E
1001:     MatSORType - What type of (S)SOR to perform

1003:     Level: beginner

1005:    May be bitwise ORd together

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

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

1011: .seealso: MatSOR()
1012: E*/
1013: typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1014:               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1015:               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
1016:               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1017: PETSC_EXTERN PetscErrorCode MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);

1019: /*
1020:     These routines are for efficiently computing Jacobians via finite differences.
1021: */

1023: /*S
1024:      MatColoring - Object for managing the coloring of matrices.

1026:    Level: beginner

1028:   Concepts: matrix, coloring

1030: .seealso:  MatFDColoringCreate() ISColoring MatFDColoring
1031: S*/
1032: typedef struct _p_MatColoring* MatColoring;
1033: /*J
1034:     MatColoringType - String with the name of a PETSc matrix coloring

1036:    Level: beginner

1038: .seealso: MatColoringSetType(), MatColoring
1039: J*/

1041: typedef const  char*           MatColoringType;
1042: #define MATCOLORINGJP      "jp"
1043: #define MATCOLORINGNATURAL "natural"
1044: #define MATCOLORINGSL      "sl"
1045: #define MATCOLORINGLF      "lf"
1046: #define MATCOLORINGID      "id"
1047: #define MATCOLORINGGREEDY  "greedy"

1049: /*E
1050:    MatColoringWeightType - Type of weight scheme

1052:     Not Collective

1054: +   MAT_COLORING_RANDOM  - Random weights
1055: .   MAT_COLORING_LEXICAL - Lexical weighting based upon global numbering.
1056: -   MAT_COLORING_LF      - Last-first weighting.

1058:     Level: intermediate

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

1062: .seealso: MatCUSPSetFormat(), MatCUSPFormatOperation
1063: E*/
1064: typedef enum {MAT_COLORING_WEIGHT_RANDOM,MAT_COLORING_WEIGHT_LEXICAL,MAT_COLORING_WEIGHT_LF,MAT_COLORING_WEIGHT_SL} MatColoringWeightType;

1066: PETSC_EXTERN PetscErrorCode MatColoringCreate(Mat,MatColoring*);
1067: PETSC_EXTERN PetscErrorCode MatColoringGetDegrees(Mat,PetscInt,PetscInt*);
1068: PETSC_EXTERN PetscErrorCode MatColoringDestroy(MatColoring*);
1069: PETSC_EXTERN PetscErrorCode MatColoringView(MatColoring,PetscViewer);
1070: PETSC_EXTERN PetscErrorCode MatColoringSetType(MatColoring,MatColoringType);
1071: PETSC_EXTERN PetscErrorCode MatColoringSetFromOptions(MatColoring);
1072: PETSC_EXTERN PetscErrorCode MatColoringSetDistance(MatColoring,PetscInt);
1073: PETSC_EXTERN PetscErrorCode MatColoringGetDistance(MatColoring,PetscInt*);
1074: PETSC_EXTERN PetscErrorCode MatColoringSetMaxColors(MatColoring,PetscInt);
1075: PETSC_EXTERN PetscErrorCode MatColoringGetMaxColors(MatColoring,PetscInt*);
1076: PETSC_EXTERN PetscErrorCode MatColoringApply(MatColoring,ISColoring*);
1077: PETSC_EXTERN PetscErrorCode MatColoringRegisterAll(void);
1078: PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[],PetscErrorCode(*)(MatColoring));
1079: PETSC_EXTERN PetscBool MatColoringRegisterAllCalled;
1080: PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1081: PETSC_EXTERN PetscErrorCode MatColoringSetWeightType(MatColoring,MatColoringWeightType);
1082: PETSC_EXTERN PetscErrorCode MatColoringSetWeights(MatColoring,PetscReal*,PetscInt*);
1083: PETSC_EXTERN PetscErrorCode MatColoringCreateWeights(MatColoring,PetscReal **,PetscInt **lperm);

1085: /*S
1086:      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1087:         and coloring

1089:    Level: beginner

1091:   Concepts: coloring, sparse Jacobian, finite differences

1093: .seealso:  MatFDColoringCreate()
1094: S*/
1095: typedef struct _p_MatFDColoring* MatFDColoring;

1097: PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1098: PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring*);
1099: PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer);
1100: PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
1101: PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1102: PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1103: PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring);
1104: PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,void *);
1105: PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec);
1106: PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,PetscInt*[]);
1107: PETSC_EXTERN PetscErrorCode MatFDColoringSetUp(Mat,ISColoring,MatFDColoring);
1108: PETSC_EXTERN PetscErrorCode MatFDColoringSetBlockSize(MatFDColoring,PetscInt,PetscInt);


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

1114:    Level: beginner

1116:   Concepts: coloring, sparse matrix product

1118: .seealso:  MatTransposeColoringCreate()
1119: S*/
1120: typedef struct _p_MatTransposeColoring* MatTransposeColoring;

1122: PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat,ISColoring,MatTransposeColoring *);
1123: PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring,Mat,Mat);
1124: PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring,Mat,Mat);
1125: PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring*);

1127: /*
1128:     These routines are for partitioning matrices: currently used only
1129:   for adjacency matrix, MatCreateMPIAdj().
1130: */

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

1135:    Level: beginner

1137:   Concepts: partitioning

1139: .seealso:  MatPartitioningCreate(), MatPartitioningType
1140: S*/
1141: typedef struct _p_MatPartitioning* MatPartitioning;

1143: /*J
1144:     MatPartitioningType - String with the name of a PETSc matrix partitioning

1146:    Level: beginner
1147: dm
1148: .seealso: MatPartitioningCreate(), MatPartitioning
1149: J*/
1150: typedef const char* MatPartitioningType;
1151: #define MATPARTITIONINGCURRENT  "current"
1152: #define MATPARTITIONINGSQUARE   "square"
1153: #define MATPARTITIONINGPARMETIS "parmetis"
1154: #define MATPARTITIONINGCHACO    "chaco"
1155: #define MATPARTITIONINGPARTY    "party"
1156: #define MATPARTITIONINGPTSCOTCH "ptscotch"


1159: PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1160: PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,MatPartitioningType);
1161: PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt);
1162: PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat);
1163: PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1164: PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1165: PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*);
1166: PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning*);

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

1170: PETSC_EXTERN PetscBool MatPartitioningRegisterAllCalled;

1172: PETSC_EXTERN PetscErrorCode MatPartitioningRegisterAll(void);

1174: PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer);
1175: PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning);
1176: PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,MatPartitioningType*);

1178: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
1179: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);

1181: typedef enum { MP_CHACO_MULTILEVEL=1,MP_CHACO_SPECTRAL=2,MP_CHACO_LINEAR=4,MP_CHACO_RANDOM=5,MP_CHACO_SCATTERED=6 } MPChacoGlobalType;
1182: PETSC_EXTERN const char *const MPChacoGlobalTypes[];
1183: typedef enum { MP_CHACO_KERNIGHAN=1,MP_CHACO_NONE=2 } MPChacoLocalType;
1184: PETSC_EXTERN const char *const MPChacoLocalTypes[];
1185: typedef enum { MP_CHACO_LANCZOS=0,MP_CHACO_RQI=1 } MPChacoEigenType;
1186: PETSC_EXTERN const char *const MPChacoEigenTypes[];

1188: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning,MPChacoGlobalType);
1189: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning,MPChacoGlobalType*);
1190: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning,MPChacoLocalType);
1191: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning,MPChacoLocalType*);
1192: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
1193: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1194: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning,MPChacoEigenType*);
1195: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning,PetscReal);
1196: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning,PetscReal*);
1197: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning,PetscInt);
1198: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning,PetscInt*);

1200: #define MP_PARTY_OPT "opt"
1201: #define MP_PARTY_LIN "lin"
1202: #define MP_PARTY_SCA "sca"
1203: #define MP_PARTY_RAN "ran"
1204: #define MP_PARTY_GBF "gbf"
1205: #define MP_PARTY_GCF "gcf"
1206: #define MP_PARTY_BUB "bub"
1207: #define MP_PARTY_DEF "def"
1208: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning,const char*);
1209: #define MP_PARTY_HELPFUL_SETS "hs"
1210: #define MP_PARTY_KERNIGHAN_LIN "kl"
1211: #define MP_PARTY_NONE "no"
1212: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning,const char*);
1213: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1214: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscBool);
1215: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool);

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

1220: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal);
1221: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*);
1222: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType);
1223: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*);

1225: /*
1226:     These routines are for coarsening matrices:
1227: */

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

1232:    Level: beginner

1234:   Concepts: coarsen

1236: .seealso:  MatCoarsenCreate), MatCoarsenType
1237: S*/
1238: typedef struct _p_MatCoarsen* MatCoarsen;

1240: /*J
1241:     MatCoarsenType - String with the name of a PETSc matrix coarsen

1243:    Level: beginner

1245: .seealso: MatCoarsenCreate(), MatCoarsen
1246: J*/
1247: typedef const char* MatCoarsenType;
1248: #define MATCOARSENMIS  "mis"
1249: #define MATCOARSENHEM  "hem"

1251: /* linked list for aggregates */
1252: typedef struct _PetscCDIntNd{
1253:   struct _PetscCDIntNd *next;
1254:   PetscInt             gid;
1255: }PetscCDIntNd;

1257: /* only used by node pool */
1258: typedef struct _PetscCDArrNd{
1259:   struct _PetscCDArrNd *next;
1260:   struct _PetscCDIntNd *array;
1261: }PetscCDArrNd;

1263: typedef struct _PetscCoarsenData{
1264:   PetscCDArrNd pool_list;  /* node pool */
1265:   PetscCDIntNd *new_node;
1266:   PetscInt     new_left;
1267:   PetscInt     chk_sz;
1268:   PetscCDIntNd *extra_nodes;
1269:   PetscCDIntNd **array;  /* Array of lists */
1270:   PetscInt     size;
1271:   Mat          mat;  /* cache a Mat for communication data */
1272: }PetscCoarsenData;

1274: PETSC_EXTERN PetscErrorCode MatCoarsenCreate(MPI_Comm,MatCoarsen*);
1275: PETSC_EXTERN PetscErrorCode MatCoarsenSetType(MatCoarsen,MatCoarsenType);
1276: PETSC_EXTERN PetscErrorCode MatCoarsenSetAdjacency(MatCoarsen,Mat);
1277: PETSC_EXTERN PetscErrorCode MatCoarsenSetGreedyOrdering(MatCoarsen,const IS);
1278: PETSC_EXTERN PetscErrorCode MatCoarsenSetStrictAggs(MatCoarsen,PetscBool);
1279: PETSC_EXTERN PetscErrorCode MatCoarsenSetVerbose(MatCoarsen,PetscInt);
1280: PETSC_EXTERN PetscErrorCode MatCoarsenGetData( MatCoarsen, PetscCoarsenData ** );
1281: PETSC_EXTERN PetscErrorCode MatCoarsenApply(MatCoarsen);
1282: PETSC_EXTERN PetscErrorCode MatCoarsenDestroy(MatCoarsen*);

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

1286: PETSC_EXTERN PetscBool MatCoarsenRegisterAllCalled;

1288: PETSC_EXTERN PetscErrorCode MatCoarsenRegisterAll(void);

1290: PETSC_EXTERN PetscErrorCode MatCoarsenView(MatCoarsen,PetscViewer);
1291: PETSC_EXTERN PetscErrorCode MatCoarsenSetFromOptions(MatCoarsen);
1292: PETSC_EXTERN PetscErrorCode MatCoarsenGetType(MatCoarsen,MatCoarsenType*);
1293: PETSC_STATIC_INLINE PetscErrorCode MatCoarsenViewFromOptions(MatCoarsen A,const char prefix[],const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,prefix,name);}

1295: PETSC_EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*);
1296: PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*);

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

1450: /*
1451:    Codes for matrices stored on disk. By default they are
1452:    stored in a universal format. By changing the format with
1453:    PetscViewerSetFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
1454:    be stored in a way natural for the matrix, for example dense matrices
1455:    would be stored as dense. Matrices stored this way may only be
1456:    read into matrices of the same type.
1457: */
1458: #define MATRIX_BINARY_FORMAT_DENSE -1

1460: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal);
1461: PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*);
1462: PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat,Mat);

1464: /*S
1465:      MatNullSpace - Object that removes a null space from a vector, i.e.
1466:          orthogonalizes the vector to a subsapce

1468:    Level: advanced

1470:   Concepts: matrix; linear operator, null space

1472:   Users manual sections:
1473: .   Section 4.17 Solving Singular Systems

1475: .seealso:  MatNullSpaceCreate()
1476: S*/
1477: typedef struct _p_MatNullSpace* MatNullSpace;

1479: PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*);
1480: PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*);
1481: PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace*);
1482: PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec);
1483: PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *);
1484: PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat,MatNullSpace);
1485: PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat,MatNullSpace);
1486: PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat,MatNullSpace*);
1487: PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscBool  *);
1488: PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace,PetscViewer);
1489: PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace,PetscBool*,PetscInt*,const Vec**);
1490: PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec,MatNullSpace*);

1492: PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS);
1493: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1494: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
1495: PETSC_EXTERN PetscErrorCode MatSeqBAIJInvertBlockDiagonal(Mat);

1497: PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*);
1498: PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*);
1499: PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*);

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

1503: PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec);

1505: PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
1506: PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec);
1507: PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
1508: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
1509: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
1510: PETSC_EXTERN PetscErrorCode MatMFFDAddNullSpace(Mat,MatNullSpace);
1511: PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
1512: PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat);
1513: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal);
1514: PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt);
1515: PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat,PetscScalar *);
1516: PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat,const char[]);
1517: PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
1518: PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);

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

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

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

1528:     Level: developer

1530: .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister()
1531: S*/
1532: typedef struct _p_MatMFFD* MatMFFD;

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

1537:    Level: beginner

1539: .seealso: MatMFFDSetType(), MatMFFDRegister()
1540: J*/
1541: typedef const char* MatMFFDType;
1542: #define MATMFFD_DS  "ds"
1543: #define MATMFFD_WP  "wp"

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

1548: PETSC_EXTERN PetscErrorCode MatMFFDRegisterAll(void);
1549: PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal);
1550: PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscBool );

1552: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1553: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);

1555: /*
1556:    PETSc interface to MUMPS
1557: */
1558: #ifdef PETSC_HAVE_MUMPS
1559: PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt);
1560: PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat,PetscInt,PetscReal);
1561: #endif

1563: /*
1564:    PETSc interface to SUPERLU
1565: */
1566: #ifdef PETSC_HAVE_SUPERLU
1567: PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal);
1568: #endif

1570: #ifdef PETSC_HAVE_CUDA
1571: /*E
1572:     MatCUSPARSEStorageFormat - indicates the storage format for CUSPARSE (GPU)
1573:     matrices. 

1575:     Not Collective

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

1581:     Level: intermediate

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

1585: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEFormatOperation
1586: E*/

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

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

1593: /*E
1594:     MatCUSPARSEFormatOperation - indicates the operation of CUSPARSE (GPU)
1595:     matrices whose operation should use a particular storage format. 

1597:     Not Collective

1599: +   MAT_CUSPARSE_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult
1600: .   MAT_CUSPARSE_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult
1601: .   MAT_CUSPARSE_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult
1602: -   MAT_CUSPARSE_ALL - sets the storage format for all CUSPARSE (GPU) matrices

1604:     Level: intermediate

1606: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEStorageFormat
1607: E*/
1608: typedef enum {MAT_CUSPARSE_MULT_DIAG, MAT_CUSPARSE_MULT_OFFDIAG, MAT_CUSPARSE_MULT, MAT_CUSPARSE_ALL} MatCUSPARSEFormatOperation;

1610: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1611: PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1612: PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat,MatCUSPARSEFormatOperation,MatCUSPARSEStorageFormat);
1613: #endif

1615: #if defined(PETSC_HAVE_CUSP)
1616: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSP(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1617: PETSC_EXTERN PetscErrorCode MatCreateAIJCUSP(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);

1619: /*E
1620:     MatCUSPStorageFormat - indicates the storage format for CUSP (GPU)
1621:     matrices. 

1623:     Not Collective

1625: +   MAT_CUSP_CSR - Compressed Sparse Row
1626: .   MAT_CUSP_DIA - Diagonal
1627: -   MAT_CUSP_ELL - Ellpack

1629:     Level: intermediate

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

1633: .seealso: MatCUSPSetFormat(), MatCUSPFormatOperation
1634: E*/
1635: typedef enum {MAT_CUSP_CSR, MAT_CUSP_DIA, MAT_CUSP_ELL} MatCUSPStorageFormat;

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

1640: /*E
1641:     MatCUSPFormatOperation - indicates the operation of CUSP (GPU)
1642:     matrices whose operation should use a particular storage format. 

1644:     Not Collective

1646: +   MAT_CUSP_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult
1647: .   MAT_CUSP_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult
1648: .   MAT_CUSP_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult
1649: -   MAT_CUSP_ALL - sets the storage format for all CUSP (GPU) matrices

1651:     Level: intermediate

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

1655: .seealso: MatCUSPSetFormat(), MatCUSPStorageFormat
1656: E*/
1657: typedef enum {MAT_CUSP_MULT_DIAG, MAT_CUSP_MULT_OFFDIAG, MAT_CUSP_MULT, MAT_CUSP_ALL} MatCUSPFormatOperation;

1659: PETSC_EXTERN PetscErrorCode MatCUSPSetFormat(Mat,MatCUSPFormatOperation,MatCUSPStorageFormat);
1660: #endif

1662: #if defined(PETSC_HAVE_VIENNACL)
1663: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1664: PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1665: #endif

1667: /*
1668:    PETSc interface to FFTW
1669: */
1670: #if defined(PETSC_HAVE_FFTW)
1671: PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec);
1672: PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec);
1673: PETSC_EXTERN PetscErrorCode MatGetVecsFFTW(Mat,Vec*,Vec*,Vec*);
1674: #endif

1676: #if defined(PETSC_HAVE_ELEMENTAL)
1677: PETSC_EXTERN PetscErrorCode PetscElementalInitializePackage(void);
1678: PETSC_EXTERN PetscErrorCode PetscElementalFinalizePackage(void);
1679: #endif

1681: PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*);
1682: PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*);
1683: PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat,IS[],IS[]);
1684: PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat,IS[],IS[]);
1685: PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***);
1686: PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*);
1687: PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat,VecType);
1688: PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]);
1689: PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat);

1691: PETSC_EXTERN PetscErrorCode MatChop(Mat,PetscReal);
1692: PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat,PetscReal,PetscInt*);

1694: #endif