Actual source code: petscmat.h

petsc-master 2019-07-14
Report Typos and Errors
  1: /*
  2:      Include file for the matrix component of PETSc
  3: */
  4: #ifndef PETSCMAT_H
  5: #define 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: .seealso:  MatCreate(), MatType, MatSetType(), MatDestroy()
 15: S*/
 16: typedef struct _p_Mat*           Mat;

 18: /*J
 19:     MatType - String with the name of a PETSc matrix type

 21:    Level: beginner

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

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

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

108:    Level: beginner

110: .seealso: MatGetFactor(), PCFactorSetMatSolverType(), PCFactorGetMatSolverType()
111: J*/
112: typedef const char* MatSolverType;
113: #define MATSOLVERSUPERLU          "superlu"
114: #define MATSOLVERSUPERLU_DIST     "superlu_dist"
115: #define MATSOLVERSTRUMPACK        "strumpack"
116: #define MATSOLVERUMFPACK          "umfpack"
117: #define MATSOLVERCHOLMOD          "cholmod"
118: #define MATSOLVERKLU              "klu"
119: #define MATSOLVERSPARSEELEMENTAL  "sparseelemental"
120: #define MATSOLVERELEMENTAL        "elemental"
121: #define MATSOLVERESSL             "essl"
122: #define MATSOLVERLUSOL            "lusol"
123: #define MATSOLVERMUMPS            "mumps"
124: #define MATSOLVERMKL_PARDISO      "mkl_pardiso"
125: #define MATSOLVERMKL_CPARDISO     "mkl_cpardiso"
126: #define MATSOLVERPASTIX           "pastix"
127: #define MATSOLVERMATLAB           "matlab"
128: #define MATSOLVERPETSC            "petsc"
129: #define MATSOLVERBAS              "bas"
130: #define MATSOLVERCUSPARSE         "cusparse"

132: /*E
133:     MatFactorType - indicates what type of factorization is requested

135:     Level: beginner

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

139: .seealso: MatSolverType, MatGetFactor()
140: E*/
141: typedef enum {MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC,MAT_FACTOR_ILUDT} MatFactorType;
142: PETSC_EXTERN const char *const MatFactorTypes[];

144: PETSC_EXTERN PetscErrorCode MatGetFactor(Mat,MatSolverType,MatFactorType,Mat*);
145: PETSC_EXTERN PetscErrorCode MatGetFactorAvailable(Mat,MatSolverType,MatFactorType,PetscBool *);
146: PETSC_EXTERN PetscErrorCode MatFactorGetSolverType(Mat,MatSolverType*);
147: PETSC_EXTERN PetscErrorCode MatGetFactorType(Mat,MatFactorType*);
148: PETSC_EXTERN PetscErrorCode MatSetFactorType(Mat,MatFactorType);
149: PETSC_EXTERN PetscErrorCode MatSolverTypeRegister(MatSolverType,MatType,MatFactorType,PetscErrorCode(*)(Mat,MatFactorType,Mat*));
150: PETSC_EXTERN PetscErrorCode MatSolverTypeGet(MatSolverType,MatType,MatFactorType,PetscBool*,PetscBool*,PetscErrorCode (**)(Mat,MatFactorType,Mat*));
151: typedef MatSolverType MatSolverPackage PETSC_DEPRECATED_TYPEDEF("Use MatSolverType (since version 3.9)");
152: PETSC_DEPRECATED_FUNCTION("Use MatSolverTypeRegister() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSolverPackageRegister(MatSolverType stype,MatType mtype,MatFactorType ftype,PetscErrorCode(*f)(Mat,MatFactorType,Mat*))
153: { return MatSolverTypeRegister(stype,mtype,ftype,f); }
154: PETSC_DEPRECATED_FUNCTION("Use MatSolverTypeGet() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSolverPackageGet(MatSolverType stype,MatType mtype,MatFactorType ftype,PetscBool *foundmtype,PetscBool *foundstype,PetscErrorCode(**f)(Mat,MatFactorType,Mat*))
155: { return MatSolverTypeGet(stype,mtype,ftype,foundmtype,foundstype,f); }

157: /* Logging support */
158: #define    MAT_FILE_CLASSID 1211216    /* used to indicate matrices in binary files */
159: PETSC_EXTERN PetscClassId MAT_CLASSID;
160: PETSC_EXTERN PetscClassId MAT_COLORING_CLASSID;
161: PETSC_EXTERN PetscClassId MAT_FDCOLORING_CLASSID;
162: PETSC_EXTERN PetscClassId MAT_TRANSPOSECOLORING_CLASSID;
163: PETSC_EXTERN PetscClassId MAT_PARTITIONING_CLASSID;
164: PETSC_EXTERN PetscClassId MAT_COARSEN_CLASSID;
165: PETSC_EXTERN PetscClassId MAT_NULLSPACE_CLASSID;
166: PETSC_EXTERN PetscClassId MATMFFD_CLASSID;

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

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

177:     Level: beginner

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

181: .seealso: MatCreateSubMatrices(), MatCreateSubMatrix(), MatDestroyMatrices(), MatConvert()
182: E*/
183: typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX,MAT_INPLACE_MATRIX} MatReuse;

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

189:     Level: beginner

191: .seealso: MatGetSeqNonzerostructure()
192: E*/
193: typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatCreateSubMatrixOption;

195: PETSC_EXTERN PetscErrorCode MatInitializePackage(void);

197: PETSC_EXTERN PetscErrorCode MatCreate(MPI_Comm,Mat*);
198: PETSC_EXTERN PetscErrorCode MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
199: PETSC_EXTERN PetscErrorCode MatSetType(Mat,MatType);
200: PETSC_EXTERN PetscErrorCode MatSetFromOptions(Mat);
201: PETSC_STATIC_INLINE PetscErrorCode MatViewFromOptions(Mat A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
202: PETSC_EXTERN PetscErrorCode MatRegister(const char[],PetscErrorCode(*)(Mat));
203: PETSC_EXTERN PetscErrorCode MatRegisterRootName(const char[],const char[],const char[]);
204: PETSC_EXTERN PetscErrorCode MatSetOptionsPrefix(Mat,const char[]);
205: PETSC_EXTERN PetscErrorCode MatAppendOptionsPrefix(Mat,const char[]);
206: PETSC_EXTERN PetscErrorCode MatGetOptionsPrefix(Mat,const char*[]);
207: PETSC_EXTERN PetscErrorCode MatSetErrorIfFailure(Mat,PetscBool);

209: PETSC_EXTERN PetscFunctionList MatList;
210: PETSC_EXTERN PetscFunctionList MatColoringList;
211: PETSC_EXTERN PetscFunctionList MatPartitioningList;

213: /*E
214:     MatStructure - Indicates if two matrices have the same nonzero structure

216:     Level: beginner

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

220: .seealso: MatCopy(), MatAXPY()
221: E*/
222: typedef enum {DIFFERENT_NONZERO_PATTERN,SUBSET_NONZERO_PATTERN,SAME_NONZERO_PATTERN} MatStructure;

224: #if defined PETSC_HAVE_MKL_SPARSE
225: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
226: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
227: PETSC_EXTERN PetscErrorCode MatCreateBAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
228: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
229: #endif

231: PETSC_EXTERN PetscErrorCode MatCreateSeqSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
232: PETSC_EXTERN PetscErrorCode MatCreateSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
233: PETSC_EXTERN PetscErrorCode MatSeqSELLSetPreallocation(Mat,PetscInt,const PetscInt[]);
234: PETSC_EXTERN PetscErrorCode MatMPISELLSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);

236: PETSC_EXTERN PetscErrorCode MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
237: PETSC_EXTERN PetscErrorCode MatCreateDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
238: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
239: PETSC_EXTERN PetscErrorCode MatCreateAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
240: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
241: PETSC_EXTERN PetscErrorCode MatUpdateMPIAIJWithArrays(Mat,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
242: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*);
243: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSeqAIJ(MPI_Comm,Mat,Mat,const PetscInt[],Mat*);

245: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
246: PETSC_EXTERN PetscErrorCode MatCreateBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
247: PETSC_EXTERN PetscErrorCode MatCreateMPIBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat*);

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

252: PETSC_EXTERN PetscErrorCode MatCreateSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
253: PETSC_EXTERN PetscErrorCode MatCreateMPISBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
254: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
255: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
256: PETSC_EXTERN PetscErrorCode MatXAIJSetPreallocation(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],const PetscInt[]);

258: PETSC_EXTERN PetscErrorCode MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
259: PETSC_EXTERN PetscErrorCode MatCreateNormal(Mat,Mat*);
260: PETSC_EXTERN PetscErrorCode MatCreateNormalHermitian(Mat,Mat*);
261: PETSC_EXTERN PetscErrorCode MatCreateLRC(Mat,Mat,Vec,Mat,Mat*);
262: PETSC_EXTERN PetscErrorCode MatLRCGetMats(Mat,Mat*,Mat*,Vec*,Mat*);
263: PETSC_EXTERN PetscErrorCode MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,ISLocalToGlobalMapping,Mat*);
264: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
265: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);

267: PETSC_EXTERN PetscErrorCode MatCreateScatter(MPI_Comm,VecScatter,Mat*);
268: PETSC_EXTERN PetscErrorCode MatScatterSetVecScatter(Mat,VecScatter);
269: PETSC_EXTERN PetscErrorCode MatScatterGetVecScatter(Mat,VecScatter*);
270: PETSC_EXTERN PetscErrorCode MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*);
271: PETSC_EXTERN PetscErrorCode MatCompositeAddMat(Mat,Mat);
272: PETSC_EXTERN PetscErrorCode MatCompositeMerge(Mat);
273: typedef enum {MAT_COMPOSITE_MERGE_RIGHT,MAT_COMPOSITE_MERGE_LEFT} MatCompositeMergeType;
274: PETSC_EXTERN PetscErrorCode MatCompositeSetMergeType(Mat,MatCompositeMergeType);
275: PETSC_EXTERN PetscErrorCode MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*);
276: typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType;
277: PETSC_EXTERN PetscErrorCode MatCompositeSetType(Mat,MatCompositeType);
278: PETSC_EXTERN PetscErrorCode MatCompositeGetType(Mat,MatCompositeType*);
279: PETSC_EXTERN PetscErrorCode MatCompositeSetMatStructure(Mat,MatStructure);
280: PETSC_EXTERN PetscErrorCode MatCompositeGetMatStructure(Mat,MatStructure*);
281: PETSC_EXTERN PetscErrorCode MatCompositeGetNumberMat(Mat,PetscInt*);
282: PETSC_EXTERN PetscErrorCode MatCompositeGetMat(Mat,PetscInt,Mat*);

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

287: PETSC_EXTERN PetscErrorCode MatCreateTranspose(Mat,Mat*);
288: PETSC_EXTERN PetscErrorCode MatTransposeGetMat(Mat,Mat*);
289: PETSC_EXTERN PetscErrorCode MatCreateHermitianTranspose(Mat,Mat*);
290: PETSC_EXTERN PetscErrorCode MatHermitianTransposeGetMat(Mat,Mat*);
291: PETSC_EXTERN PetscErrorCode MatCreateSubMatrixVirtual(Mat,IS,IS,Mat*);
292: PETSC_EXTERN PetscErrorCode MatSubMatrixVirtualUpdate(Mat,Mat,IS,IS);
293: PETSC_EXTERN PetscErrorCode MatCreateLocalRef(Mat,IS,IS,Mat*);
294: PETSC_EXTERN PetscErrorCode MatCreateConstantDiagonal(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar,Mat*);

296: #if defined(PETSC_HAVE_HYPRE)
297: PETSC_EXTERN PetscErrorCode MatHYPRESetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
298: #endif

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

302: PETSC_EXTERN PetscErrorCode MatResetPreallocation(Mat);
303: PETSC_EXTERN PetscErrorCode MatSetUp(Mat);
304: PETSC_EXTERN PetscErrorCode MatDestroy(Mat*);
305: PETSC_EXTERN PetscErrorCode MatGetNonzeroState(Mat,PetscObjectState*);

307: PETSC_EXTERN PetscErrorCode MatConjugate(Mat);
308: PETSC_EXTERN PetscErrorCode MatRealPart(Mat);
309: PETSC_EXTERN PetscErrorCode MatImaginaryPart(Mat);
310: PETSC_EXTERN PetscErrorCode MatGetDiagonalBlock(Mat,Mat*);
311: PETSC_EXTERN PetscErrorCode MatGetTrace(Mat,PetscScalar*);
312: PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonal(Mat,const PetscScalar **);
313: PETSC_EXTERN PetscErrorCode MatInvertVariableBlockDiagonal(Mat,PetscInt,const PetscInt*,PetscScalar*);
314: PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonalMat(Mat,Mat);

316: /* ------------------------------------------------------------*/
317: PETSC_EXTERN PetscErrorCode MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
318: PETSC_EXTERN PetscErrorCode MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
319: PETSC_EXTERN PetscErrorCode MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
320: PETSC_EXTERN PetscErrorCode MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);
321: PETSC_EXTERN PetscErrorCode MatSetValuesBatch(Mat,PetscInt,PetscInt,PetscInt[],const PetscScalar[]);
322: PETSC_EXTERN PetscErrorCode MatSetRandom(Mat,PetscRandom);

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

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

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

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

335:    Level: beginner

337: .seealso:  MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockedStencil(), DMDAVecGetArray(), DMDAVecGetArrayF90()
338: S*/
339: typedef struct {
340:   PetscInt k,j,i,c;
341: } MatStencil;

343: PETSC_EXTERN PetscErrorCode MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
344: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
345: PETSC_EXTERN PetscErrorCode MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);

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

351:     Level: beginner

353: .seealso: MatAssemblyBegin(), MatAssemblyEnd()
354: E*/
355: typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
356: PETSC_EXTERN PetscErrorCode MatAssemblyBegin(Mat,MatAssemblyType);
357: PETSC_EXTERN PetscErrorCode MatAssemblyEnd(Mat,MatAssemblyType);
358: PETSC_EXTERN PetscErrorCode MatAssembled(Mat,PetscBool *);



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

365:     Level: beginner

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

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

373: .seealso: MatSetOption()
374: E*/
375: typedef enum {MAT_OPTION_MIN = -3,
376:               MAT_UNUSED_NONZERO_LOCATION_ERR = -2,
377:               MAT_ROW_ORIENTED = -1,
378:               MAT_SYMMETRIC = 1,
379:               MAT_STRUCTURALLY_SYMMETRIC = 2,
380:               MAT_NEW_DIAGONALS = 3,
381:               MAT_IGNORE_OFF_PROC_ENTRIES = 4,
382:               MAT_USE_HASH_TABLE = 5,
383:               MAT_KEEP_NONZERO_PATTERN = 6,
384:               MAT_IGNORE_ZERO_ENTRIES = 7,
385:               MAT_USE_INODES = 8,
386:               MAT_HERMITIAN = 9,
387:               MAT_SYMMETRY_ETERNAL = 10,
388:               MAT_NEW_NONZERO_LOCATION_ERR = 11,
389:               MAT_IGNORE_LOWER_TRIANGULAR = 12,
390:               MAT_ERROR_LOWER_TRIANGULAR = 13,
391:               MAT_GETROW_UPPERTRIANGULAR = 14,
392:               MAT_SPD = 15,
393:               MAT_NO_OFF_PROC_ZERO_ROWS = 16,
394:               MAT_NO_OFF_PROC_ENTRIES = 17,
395:               MAT_NEW_NONZERO_LOCATIONS = 18,
396:               MAT_NEW_NONZERO_ALLOCATION_ERR = 19,
397:               MAT_SUBSET_OFF_PROC_ENTRIES = 20,
398:               MAT_SUBMAT_SINGLEIS = 21,
399:               MAT_STRUCTURE_ONLY = 22,
400:               MAT_SORTED_FULL = 23,
401:               MAT_OPTION_MAX = 24} MatOption;

403: PETSC_EXTERN const char *const *MatOptions;
404: PETSC_EXTERN PetscErrorCode MatSetOption(Mat,MatOption,PetscBool);
405: PETSC_EXTERN PetscErrorCode MatGetOption(Mat,MatOption,PetscBool*);
406: PETSC_EXTERN PetscErrorCode MatGetType(Mat,MatType*);

408: PETSC_EXTERN PetscErrorCode MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
409: PETSC_EXTERN PetscErrorCode MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
410: PETSC_EXTERN PetscErrorCode MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
411: PETSC_EXTERN PetscErrorCode MatGetRowUpperTriangular(Mat);
412: PETSC_EXTERN PetscErrorCode MatRestoreRowUpperTriangular(Mat);
413: PETSC_EXTERN PetscErrorCode MatGetColumnVector(Mat,Vec,PetscInt);
414: PETSC_EXTERN PetscErrorCode MatSeqAIJGetArray(Mat,PetscScalar *[]);
415: PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArray(Mat,PetscScalar *[]);
416: PETSC_EXTERN PetscErrorCode MatSeqAIJGetMaxRowNonzeros(Mat,PetscInt*);
417: PETSC_EXTERN PetscErrorCode MatSeqAIJSetValuesLocalFast(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
418: PETSC_EXTERN PetscErrorCode MatSeqAIJSetType(Mat,MatType);
419: PETSC_EXTERN PetscErrorCode MatSeqAIJRegister(const char[],PetscErrorCode (*)(Mat,MatType,MatReuse,Mat *));
420: PETSC_EXTERN PetscFunctionList MatSeqAIJList;
421: PETSC_EXTERN PetscErrorCode MatSeqSBAIJGetArray(Mat,PetscScalar *[]);
422: PETSC_EXTERN PetscErrorCode MatSeqSBAIJRestoreArray(Mat,PetscScalar *[]);
423: PETSC_EXTERN PetscErrorCode MatDenseGetArray(Mat,PetscScalar *[]);
424: PETSC_EXTERN PetscErrorCode MatDenseRestoreArray(Mat,PetscScalar *[]);
425: PETSC_EXTERN PetscErrorCode MatDensePlaceArray(Mat,const PetscScalar[]);
426: PETSC_EXTERN PetscErrorCode MatDenseResetArray(Mat);
427: PETSC_EXTERN PetscErrorCode MatDenseGetArrayRead(Mat,const PetscScalar *[]);
428: PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayRead(Mat,const PetscScalar *[]);
429: PETSC_EXTERN PetscErrorCode MatGetBlockSize(Mat,PetscInt *);
430: PETSC_EXTERN PetscErrorCode MatSetBlockSize(Mat,PetscInt);
431: PETSC_EXTERN PetscErrorCode MatGetBlockSizes(Mat,PetscInt *,PetscInt *);
432: PETSC_EXTERN PetscErrorCode MatSetBlockSizes(Mat,PetscInt,PetscInt);
433: PETSC_EXTERN PetscErrorCode MatSetBlockSizesFromMats(Mat,Mat,Mat);
434: PETSC_EXTERN PetscErrorCode MatSetVariableBlockSizes(Mat,PetscInt,PetscInt*);
435: PETSC_EXTERN PetscErrorCode MatGetVariableBlockSizes(Mat,PetscInt*,const PetscInt**);

437: PETSC_EXTERN PetscErrorCode MatDenseGetColumn(Mat,PetscInt,PetscScalar *[]);
438: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumn(Mat,PetscScalar *[]);

440: PETSC_EXTERN PetscErrorCode MatMult(Mat,Vec,Vec);
441: PETSC_EXTERN PetscErrorCode MatMultDiagonalBlock(Mat,Vec,Vec);
442: PETSC_EXTERN PetscErrorCode MatMultAdd(Mat,Vec,Vec,Vec);
443: PETSC_EXTERN PetscErrorCode MatMultTranspose(Mat,Vec,Vec);
444: PETSC_EXTERN PetscErrorCode MatMultHermitianTranspose(Mat,Vec,Vec);
445: PETSC_EXTERN PetscErrorCode MatIsTranspose(Mat,Mat,PetscReal,PetscBool *);
446: PETSC_EXTERN PetscErrorCode MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscBool *);
447: PETSC_EXTERN PetscErrorCode MatMultTransposeAdd(Mat,Vec,Vec,Vec);
448: PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec);
449: PETSC_EXTERN PetscErrorCode MatMultConstrained(Mat,Vec,Vec);
450: PETSC_EXTERN PetscErrorCode MatMultTransposeConstrained(Mat,Vec,Vec);
451: PETSC_EXTERN PetscErrorCode MatMatSolve(Mat,Mat,Mat);
452: PETSC_EXTERN PetscErrorCode MatMatSolveTranspose(Mat,Mat,Mat);
453: PETSC_EXTERN PetscErrorCode MatMatTransposeSolve(Mat,Mat,Mat);
454: PETSC_EXTERN PetscErrorCode MatResidual(Mat,Vec,Vec,Vec);

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

460:     Level: beginner

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

464: $   MAT_DO_NOT_COPY_VALUES    - Create a matrix using the same nonzero pattern as the original matrix,
465: $                               with zeros for the numerical values.
466: $   MAT_COPY_VALUES           - Create a matrix with the same nonzero pattern as the original matrix
467: $                               and with the same numerical values.
468: $   MAT_SHARE_NONZERO_PATTERN - Create a matrix that shares the nonzero structure with the previous matrix
469: $                               and does not copy it, using zeros for the numerical values. The parent and
470: $                               child matrices will share their index (i and j) arrays, and you cannot
471: $                               insert new nonzero entries into either matrix.

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

477: .seealso: MatDuplicate()
478: E*/
479: typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption;

481: PETSC_EXTERN PetscErrorCode MatConvert(Mat,MatType,MatReuse,Mat*);
482: PETSC_EXTERN PetscErrorCode MatDuplicate(Mat,MatDuplicateOption,Mat*);


485: PETSC_EXTERN PetscErrorCode MatCopy(Mat,Mat,MatStructure);
486: PETSC_EXTERN PetscErrorCode MatView(Mat,PetscViewer);
487: PETSC_EXTERN PetscErrorCode MatIsSymmetric(Mat,PetscReal,PetscBool *);
488: PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat,PetscBool *);
489: PETSC_EXTERN PetscErrorCode MatIsHermitian(Mat,PetscReal,PetscBool *);
490: PETSC_EXTERN PetscErrorCode MatIsSymmetricKnown(Mat,PetscBool *,PetscBool *);
491: PETSC_EXTERN PetscErrorCode MatIsHermitianKnown(Mat,PetscBool *,PetscBool *);
492: PETSC_EXTERN PetscErrorCode MatMissingDiagonal(Mat,PetscBool  *,PetscInt *);
493: PETSC_EXTERN PetscErrorCode MatLoad(Mat, PetscViewer);

495: PETSC_EXTERN PetscErrorCode MatGetRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool  *);
496: PETSC_EXTERN PetscErrorCode MatRestoreRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool  *);
497: PETSC_EXTERN PetscErrorCode MatGetColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool  *);
498: PETSC_EXTERN PetscErrorCode MatRestoreColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool  *);

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

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

505:    Level: intermediate

507: .seealso:  MatGetInfo(), MatInfoType
508: S*/
509: typedef struct {
510:   PetscLogDouble block_size;                         /* block size */
511:   PetscLogDouble nz_allocated,nz_used,nz_unneeded;   /* number of nonzeros */
512:   PetscLogDouble memory;                             /* memory allocated */
513:   PetscLogDouble assemblies;                         /* number of matrix assemblies called */
514:   PetscLogDouble mallocs;                            /* number of mallocs during MatSetValues() */
515:   PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
516:   PetscLogDouble factor_mallocs;                     /* number of mallocs during factorization */
517: } MatInfo;

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

523:     Level: beginner

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

527: .seealso: MatGetInfo(), MatInfo
528: E*/
529: typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
530: PETSC_EXTERN PetscErrorCode MatGetInfo(Mat,MatInfoType,MatInfo*);
531: PETSC_EXTERN PetscErrorCode MatGetDiagonal(Mat,Vec);
532: PETSC_EXTERN PetscErrorCode MatGetRowMax(Mat,Vec,PetscInt[]);
533: PETSC_EXTERN PetscErrorCode MatGetRowMin(Mat,Vec,PetscInt[]);
534: PETSC_EXTERN PetscErrorCode MatGetRowMaxAbs(Mat,Vec,PetscInt[]);
535: PETSC_EXTERN PetscErrorCode MatGetRowMinAbs(Mat,Vec,PetscInt[]);
536: PETSC_EXTERN PetscErrorCode MatGetRowSum(Mat,Vec);
537: PETSC_EXTERN PetscErrorCode MatTranspose(Mat,MatReuse,Mat*);
538: PETSC_EXTERN PetscErrorCode MatHermitianTranspose(Mat,MatReuse,Mat*);
539: PETSC_EXTERN PetscErrorCode MatPermute(Mat,IS,IS,Mat*);
540: PETSC_EXTERN PetscErrorCode MatDiagonalScale(Mat,Vec,Vec);
541: PETSC_EXTERN PetscErrorCode MatDiagonalSet(Mat,Vec,InsertMode);

543: PETSC_EXTERN PetscErrorCode MatEqual(Mat,Mat,PetscBool*);
544: PETSC_EXTERN PetscErrorCode MatMultEqual(Mat,Mat,PetscInt,PetscBool*);
545: PETSC_EXTERN PetscErrorCode MatMultAddEqual(Mat,Mat,PetscInt,PetscBool*);
546: PETSC_EXTERN PetscErrorCode MatMultTransposeEqual(Mat,Mat,PetscInt,PetscBool*);
547: PETSC_EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscBool*);
548: PETSC_EXTERN PetscErrorCode MatMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
549: PETSC_EXTERN PetscErrorCode MatTransposeMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
550: PETSC_EXTERN PetscErrorCode MatMatTransposeMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
551: PETSC_EXTERN PetscErrorCode MatIsLinear(Mat,PetscInt,PetscBool*);

553: PETSC_EXTERN PetscErrorCode MatNorm(Mat,NormType,PetscReal*);
554: PETSC_EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal*);
555: PETSC_EXTERN PetscErrorCode MatZeroEntries(Mat);
556: PETSC_EXTERN PetscErrorCode MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
557: PETSC_EXTERN PetscErrorCode MatZeroRowsIS(Mat,IS,PetscScalar,Vec,Vec);
558: PETSC_EXTERN PetscErrorCode MatZeroRowsStencil(Mat,PetscInt,const MatStencil [],PetscScalar,Vec,Vec);
559: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsStencil(Mat,PetscInt,const MatStencil[],PetscScalar,Vec,Vec);
560: PETSC_EXTERN PetscErrorCode MatZeroRowsColumns(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
561: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsIS(Mat,IS,PetscScalar,Vec,Vec);

563: PETSC_EXTERN PetscErrorCode MatGetSize(Mat,PetscInt*,PetscInt*);
564: PETSC_EXTERN PetscErrorCode MatGetLocalSize(Mat,PetscInt*,PetscInt*);
565: PETSC_EXTERN PetscErrorCode MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
566: PETSC_EXTERN PetscErrorCode MatGetOwnershipRanges(Mat,const PetscInt**);
567: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*);
568: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat,const PetscInt**);
569: PETSC_EXTERN PetscErrorCode MatGetOwnershipIS(Mat,IS*,IS*);

571: PETSC_EXTERN PetscErrorCode MatCreateSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
572: PETSC_DEPRECATED_FUNCTION("Use MatCreateSubMatrices() (since version 3.8)") PETSC_STATIC_INLINE PetscErrorCode MatGetSubMatrices(Mat mat,PetscInt n,const IS irow[],const IS icol[],MatReuse scall,Mat *submat[]) {return MatCreateSubMatrices(mat,n,irow,icol,scall,submat);}
573: PETSC_EXTERN PetscErrorCode MatCreateSubMatricesMPI(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
574: PETSC_DEPRECATED_FUNCTION("Use MatCreateSubMatricesMPI() (since version 3.8)") PETSC_STATIC_INLINE PetscErrorCode MatGetSubMatricesMPI(Mat mat,PetscInt n,const IS irow[],const IS icol[],MatReuse scall,Mat *submat[]) {return MatCreateSubMatricesMPI(mat,n,irow,icol,scall,submat);}
575: PETSC_EXTERN PetscErrorCode MatDestroyMatrices(PetscInt,Mat *[]);
576: PETSC_EXTERN PetscErrorCode MatDestroySubMatrices(PetscInt,Mat *[]);
577: PETSC_EXTERN PetscErrorCode MatCreateSubMatrix(Mat,IS,IS,MatReuse,Mat *);
578: PETSC_DEPRECATED_FUNCTION("Use MatCreateSubMatrix() (since version 3.8)") PETSC_STATIC_INLINE PetscErrorCode MatGetSubMatrix(Mat mat,IS isrow,IS iscol,MatReuse cll,Mat *newmat) {return MatCreateSubMatrix(mat,isrow,iscol,cll,newmat);}
579: PETSC_EXTERN PetscErrorCode MatGetLocalSubMatrix(Mat,IS,IS,Mat*);
580: PETSC_EXTERN PetscErrorCode MatRestoreLocalSubMatrix(Mat,IS,IS,Mat*);
581: PETSC_EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat,Mat*);
582: PETSC_EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat*);

584: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJ(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
585: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJSymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
586: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJNumeric(Mat,Mat);
587: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMat(Mat,MatReuse,Mat*);
588: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
589: PETSC_EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,Mat*);
590: PETSC_EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *,const PetscInt *[]);

592: PETSC_EXTERN PetscErrorCode MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
593: PETSC_EXTERN PetscErrorCode MatIncreaseOverlapSplit(Mat mat,PetscInt n,IS is[],PetscInt ov);
594: PETSC_EXTERN PetscErrorCode MatMPIAIJSetUseScalableIncreaseOverlap(Mat,PetscBool);

596: PETSC_EXTERN PetscErrorCode MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
597: PETSC_EXTERN PetscErrorCode MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
598: PETSC_EXTERN PetscErrorCode MatMatMultNumeric(Mat,Mat,Mat);

600: PETSC_EXTERN PetscErrorCode MatMatMatMult(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);
601: PETSC_EXTERN PetscErrorCode MatGalerkin(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);

603: PETSC_EXTERN PetscErrorCode MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
604: PETSC_EXTERN PetscErrorCode MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
605: PETSC_EXTERN PetscErrorCode MatPtAPNumeric(Mat,Mat,Mat);
606: PETSC_EXTERN PetscErrorCode MatRARt(Mat,Mat,MatReuse,PetscReal,Mat*);
607: PETSC_EXTERN PetscErrorCode MatRARtSymbolic(Mat,Mat,PetscReal,Mat*);
608: PETSC_EXTERN PetscErrorCode MatRARtNumeric(Mat,Mat,Mat);

610: PETSC_EXTERN PetscErrorCode MatTransposeMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
611: PETSC_EXTERN PetscErrorCode MatTransposetMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
612: PETSC_EXTERN PetscErrorCode MatTransposetMatMultNumeric(Mat,Mat,Mat);
613: PETSC_EXTERN PetscErrorCode MatMatTransposeMult(Mat,Mat,MatReuse,PetscReal,Mat*);
614: PETSC_EXTERN PetscErrorCode MatMatTransposeMultSymbolic(Mat,Mat,PetscReal,Mat*);
615: PETSC_EXTERN PetscErrorCode MatMatTransposeMultNumeric(Mat,Mat,Mat);

617: PETSC_EXTERN PetscErrorCode MatAXPY(Mat,PetscScalar,Mat,MatStructure);
618: PETSC_EXTERN PetscErrorCode MatAYPX(Mat,PetscScalar,Mat,MatStructure);

620: PETSC_EXTERN PetscErrorCode MatScale(Mat,PetscScalar);
621: PETSC_EXTERN PetscErrorCode MatShift(Mat,PetscScalar);

623: PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping);
624: PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*);
625: PETSC_EXTERN PetscErrorCode MatGetLayouts(Mat,PetscLayout*,PetscLayout*);
626: PETSC_EXTERN PetscErrorCode MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
627: PETSC_EXTERN PetscErrorCode MatZeroRowsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
628: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
629: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
630: PETSC_EXTERN PetscErrorCode MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
631: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);

633: PETSC_EXTERN PetscErrorCode MatStashSetInitialSize(Mat,PetscInt,PetscInt);
634: PETSC_EXTERN PetscErrorCode MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);

636: PETSC_EXTERN PetscErrorCode MatInterpolate(Mat,Vec,Vec);
637: PETSC_EXTERN PetscErrorCode MatInterpolateAdd(Mat,Vec,Vec,Vec);
638: PETSC_EXTERN PetscErrorCode MatRestrict(Mat,Vec,Vec);
639: PETSC_EXTERN PetscErrorCode MatCreateVecs(Mat,Vec*,Vec*);
640: PETSC_DEPRECATED_FUNCTION("Use MatCreateVecs() (since version 3.6)") PETSC_STATIC_INLINE PetscErrorCode MatGetVecs(Mat mat,Vec *x,Vec *y) {return MatCreateVecs(mat,x,y);}
641: PETSC_EXTERN PetscErrorCode MatCreateRedundantMatrix(Mat,PetscInt,MPI_Comm,MatReuse,Mat*);
642: PETSC_EXTERN PetscErrorCode MatGetMultiProcBlock(Mat,MPI_Comm,MatReuse,Mat*);
643: PETSC_EXTERN PetscErrorCode MatFindZeroDiagonals(Mat,IS*);
644: PETSC_EXTERN PetscErrorCode MatFindOffBlockDiagonalEntries(Mat,IS*);
645: PETSC_EXTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);

647: /*MC
648:    MatSetValue - Set a single entry into a matrix.

650:    Not collective

652:    Synopsis:
653:      #include <petscmat.h>
654:      PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode)

656:    Input Parameters:
657: +  m - the matrix
658: .  row - the row location of the entry
659: .  col - the column location of the entry
660: .  value - the value to insert
661: -  mode - either INSERT_VALUES or ADD_VALUES

663:    Notes:
664:    For efficiency one should use MatSetValues() and set several or many
665:    values simultaneously if possible.

667:    Level: beginner

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

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

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

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

681:    Synopsis:
682:    #include <petscmat.h>
683:    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)

685:    Collective

687:    Input Parameters:
688: +  comm - the communicator that will share the eventually allocated matrix
689: .  nrows - the number of LOCAL rows in the matrix
690: -  ncols - the number of LOCAL columns in the matrix

692:    Output Parameters:
693: +  dnz - the array that will be passed to the matrix preallocation routines
694: -  onz - the other array passed to the matrix preallocation routines

696:    Level: intermediate

698:    Notes:
699:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

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

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

707: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
708:           MatPreallocateInitializeSymmetric(), MatPreallocateSymmetricSetLocalBlock()
709: M*/
710: #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
711: do { \
712:   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ncols = (ncols),__rstart,__start,__end; \
713:   _4_PetscCalloc2((size_t)__nrows,&dnz,(size_t)__nrows,&onz);CHKERRQ(_4_ierr); \
714:   __start = 0; __end = __start;                                         \
715:   _4_MPI_Scan(&__ncols,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ncols;\
716:   _4_MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows; \
717:   do { } while(0)

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

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

727:    Not Collective

729:    Input Parameters:
730: +  map - the row mapping from local numbering to global numbering
731: .  nrows - the number of rows indicated
732: .  rows - the indices of the rows
733: .  cmap - the column mapping from local to global numbering
734: .  ncols - the number of columns in the matrix
735: .  cols - the columns indicated
736: .  dnz - the array that will be passed to the matrix preallocation routines
737: -  onz - the other array passed to the matrix preallocation routines

739:    Level: intermediate

741:    Notes:
742:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

746: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
747:           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocalRemoveDups()
748: M*/
749: #define MatPreallocateSetLocal(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
750: do {\
751:   PetscInt __l;\
752:   _4_ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
753:   _4_ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
754:   for (__l=0;__l<nrows;__l++) {\
755:     _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
756:   }\
757:  } while (0)

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

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

767:    Not Collective

769:    Input Parameters:
770: +  map - the row mapping from local numbering to global numbering
771: .  nrows - the number of rows indicated
772: .  rows - the indices of the rows (these values are mapped to the global values)
773: .  cmap - the column mapping from local to global numbering
774: .  ncols - the number of columns in the matrix   (this value will be changed if duplicate columns are found)
775: .  cols - the columns indicated (these values are mapped to the global values, they are then sorted and duplicates removed)
776: .  dnz - the array that will be passed to the matrix preallocation routines
777: -  onz - the other array passed to the matrix preallocation routines

779:    Level: intermediate

781:    Notes:
782:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

786: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
787:           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal()
788: M*/
789: #define MatPreallocateSetLocalRemoveDups(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
790: do {\
791:   PetscInt __l;\
792:   _4_ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
793:   _4_ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
794:   _4_PetscSortRemoveDupsInt(&ncols,cols);CHKERRQ(_4_ierr);\
795:   for (__l=0;__l<nrows;__l++) {\
796:     _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
797:   }\
798:  } while (0)

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

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

808:    Not Collective

810:    Input Parameters:
811: +  map - the row mapping from local numbering to global numbering
812: .  nrows - the number of rows indicated
813: .  rows - the indices of the rows
814: .  cmap - the column mapping from local to global numbering
815: .  ncols - the number of columns in the matrix
816: .  cols - the columns indicated
817: .  dnz - the array that will be passed to the matrix preallocation routines
818: -  onz - the other array passed to the matrix preallocation routines

820:    Level: intermediate

822:    Notes:
823:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

827: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
828:           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock()
829: M*/
830: #define MatPreallocateSetLocalBlock(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
831: do {\
832:   PetscInt __l;\
833:   _4_ISLocalToGlobalMappingApplyBlock(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
834:   _4_ISLocalToGlobalMappingApplyBlock(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
835:   for (__l=0;__l<nrows;__l++) {\
836:     _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
837:   }\
838: } while (0)

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

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

848:    Not Collective

850:    Input Parameters:
851: +  map - the mapping between local numbering and global numbering
852: .  nrows - the number of rows indicated
853: .  rows - the indices of the rows
854: .  ncols - the number of columns in the matrix
855: .  cols - the columns indicated
856: .  dnz - the array that will be passed to the matrix preallocation routines
857: -  onz - the other array passed to the matrix preallocation routines

859:    Level: intermediate

861:    Notes:
862:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

866: .seealso: MatPreallocateFinalize(), MatPreallocateSet()
867:           MatPreallocateInitialize(),  MatPreallocateSetLocal()
868: M*/
869: #define MatPreallocateSymmetricSetLocalBlock(map,nrows,rows,ncols,cols,dnz,onz) 0;\
870: do {\
871:   PetscInt __l;\
872:   _4_ISLocalToGlobalMappingApplyBlock(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
873:   _4_ISLocalToGlobalMappingApplyBlock(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
874:   for (__l=0;__l<nrows;__l++) {\
875:     _4_MatPreallocateSymmetricSetBlock((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
876:   }\
877: } while (0)

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

883:    Synopsis:
884:    #include <petscmat.h>
885:    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

887:    Not Collective

889:    Input Parameters:
890: +  row - the row
891: .  ncols - the number of columns in the matrix
892: -  cols - the columns indicated

894:    Output Parameters:
895: +  dnz - the array that will be passed to the matrix preallocation routines
896: -  onz - the other array passed to the matrix preallocation routines

898:    Level: intermediate

900:    Notes:
901:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

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

907: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
908:           MatPreallocateInitialize(), MatPreallocateSetLocal()
909: M*/
910: #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
911: do { PetscInt __i; \
912:   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);\
913:   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);\
914:   for (__i=0; __i<nc; __i++) {\
915:     if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
916:     else if (dnz[row - __rstart] < __ncols) dnz[row - __rstart]++;\
917:   }\
918: } while (0)

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

924:    Synopsis:
925:    #include <petscmat.h>
926:    PetscErrorCode MatPreallocateSymmetricSetBlock(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

928:    Not Collective

930:    Input Parameters:
931: +  nrows - the number of rows indicated
932: .  rows - the indices of the rows
933: .  ncols - the number of columns in the matrix
934: .  cols - the columns indicated
935: .  dnz - the array that will be passed to the matrix preallocation routines
936: -  onz - the other array passed to the matrix preallocation routines

938:    Level: intermediate

940:    Notes:
941:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

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

947: .seealso: MatPreallocateFinalize(), MatPreallocateSet(),  MatPreallocateInitialize(),
948:           MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal()
949: M*/
950: #define MatPreallocateSymmetricSetBlock(row,nc,cols,dnz,onz) 0;\
951: do { PetscInt __i; \
952:   for (__i=0; __i<nc; __i++) {\
953:     if (cols[__i] >= __end) onz[row - __rstart]++; \
954:     else if (cols[__i] >= row && dnz[row - __rstart] < __ncols) dnz[row - __rstart]++;\
955:   }\
956: } while (0)

958: /*MC
959:    MatPreallocateLocation -  An alternative to MatPreallocateSet() that puts the nonzero locations into the matrix if it exists

961:    Synopsis:
962:    #include <petscmat.h>
963:    PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)

965:    Not Collective

967:    Input Parameters:
968: +  A - matrix
969: .  row - row where values exist (must be local to this process)
970: .  ncols - number of columns
971: .  cols - columns with nonzeros
972: .  dnz - the array that will be passed to the matrix preallocation routines
973: -  onz - the other array passed to the matrix preallocation routines

975:    Level: intermediate

977:    Notes:
978:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

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

984: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
985:           MatPreallocateSymmetricSetLocalBlock()
986: M*/
987: #define MatPreallocateLocation(A,row,ncols,cols,dnz,onz) 0; do {if (A) {MatSetValues(A,1,&row,ncols,cols,NULL,INSERT_VALUES);} else { MatPreallocateSet(row,ncols,cols,dnz,onz);}} while(0)


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

994:    Synopsis:
995:    #include <petscmat.h>
996:    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)

998:    Collective

1000:    Input Parameters:
1001: +  dnz - the array that was be passed to the matrix preallocation routines
1002: -  onz - the other array passed to the matrix preallocation routines

1004:    Level: intermediate

1006:    Notes:
1007:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

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

1013: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
1014:           MatPreallocateSymmetricSetLocalBlock()
1015: M*/
1016: #define MatPreallocateFinalize(dnz,onz) 0;_4_PetscFree2(dnz,onz);CHKERRQ(_4_ierr);} while(0)

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

1021: PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*);
1022: PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);

1024: PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
1025: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
1026: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1027: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1028: PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1029: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*,PetscInt,PetscBool);

1031: #define MAT_SKIP_ALLOCATION -4

1033: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1034: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1035: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);

1037: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1038: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1039: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1040: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
1041: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1042: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
1043: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1044: PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
1045: PETSC_EXTERN PetscErrorCode MatMPIAdjToSeq(Mat,Mat*);
1046: PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
1047: PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
1048: PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
1049: PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
1050: PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat,Mat*);

1052: PETSC_EXTERN PetscErrorCode MatSeqDenseSetLDA(Mat,PetscInt);
1053: PETSC_EXTERN PetscErrorCode MatDenseGetLDA(Mat,PetscInt*);
1054: PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*);

1056: PETSC_EXTERN PetscErrorCode MatStoreValues(Mat);
1057: PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat);

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

1061: PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat,IS*);
1062: PETSC_EXTERN PetscErrorCode MatFindZeroRows(Mat,IS*);
1063: /*
1064:   These routines are not usually accessed directly, rather solving is
1065:   done through the KSP and PC interfaces.
1066: */

1068: /*J
1069:     MatOrderingType - String with the name of a PETSc matrix ordering

1071:    Level: beginner

1073: .seealso: MatGetOrdering()
1074: J*/
1075: typedef const char* MatOrderingType;
1076: #define MATORDERINGNATURAL     "natural"
1077: #define MATORDERINGND          "nd"
1078: #define MATORDERING1WD         "1wd"
1079: #define MATORDERINGRCM         "rcm"
1080: #define MATORDERINGQMD         "qmd"
1081: #define MATORDERINGROWLENGTH   "rowlength"
1082: #define MATORDERINGWBM         "wbm"
1083: #define MATORDERINGSPECTRAL    "spectral"
1084: #define MATORDERINGAMD         "amd"            /* only works if UMFPACK is installed with PETSc */

1086: PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat,MatOrderingType,IS*,IS*);
1087: PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFunctionList*);
1088: PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[],PetscErrorCode(*)(Mat,MatOrderingType,IS*,IS*));
1089: PETSC_EXTERN PetscFunctionList MatOrderingList;

1091: PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
1092: PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat,PetscReal,PetscBool,Mat*);

1094: /*S
1095:     MatFactorShiftType - Numeric Shift.

1097:    Level: beginner

1099: S*/
1100: typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType;
1101: PETSC_EXTERN const char *const MatFactorShiftTypes[];
1102: PETSC_EXTERN const char *const MatFactorShiftTypesDetail[];

1104: /*S
1105:     MatFactorError - indicates what type of error in matrix factor

1107:     Level: beginner

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

1112: .seealso: MatGetFactor()
1113: S*/
1114: typedef enum {MAT_FACTOR_NOERROR,MAT_FACTOR_STRUCT_ZEROPIVOT,MAT_FACTOR_NUMERIC_ZEROPIVOT,MAT_FACTOR_OUTMEMORY,MAT_FACTOR_OTHER} MatFactorError;

1116: PETSC_EXTERN PetscErrorCode MatFactorGetError(Mat,MatFactorError*);
1117: PETSC_EXTERN PetscErrorCode MatFactorClearError(Mat);
1118: PETSC_EXTERN PetscErrorCode MatFactorGetErrorZeroPivot(Mat,PetscReal*,PetscInt*);

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

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

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

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

1131:    Level: developer

1133: .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
1134:           MatFactorInfoInitialize()

1136: S*/
1137: typedef struct {
1138:   PetscReal     diagonal_fill;  /* force diagonal to fill in if initially not filled */
1139:   PetscReal     usedt;
1140:   PetscReal     dt;             /* drop tolerance */
1141:   PetscReal     dtcol;          /* tolerance for pivoting */
1142:   PetscReal     dtcount;        /* maximum nonzeros to be allowed per row */
1143:   PetscReal     fill;           /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1144:   PetscReal     levels;         /* ICC/ILU(levels) */
1145:   PetscReal     pivotinblocks;  /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1146:                                    factorization may be faster if do not pivot */
1147:   PetscReal     zeropivot;      /* pivot is called zero if less than this */
1148:   PetscReal     shifttype;      /* type of shift added to matrix factor to prevent zero pivots */
1149:   PetscReal     shiftamount;     /* how large the shift is */
1150: } MatFactorInfo;

1152: PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*);
1153: PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*);
1154: PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1155: PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*);
1156: PETSC_EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*);
1157: PETSC_EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*);
1158: PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1159: PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1160: PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1161: PETSC_EXTERN PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*);
1162: PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*);
1163: PETSC_EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1164: PETSC_EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec);
1165: PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec);
1166: PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec);
1167: PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec);
1168: PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec);
1169: PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1170: PETSC_EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs);
1171: PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat);

1173: typedef enum {MAT_FACTOR_SCHUR_UNFACTORED, MAT_FACTOR_SCHUR_FACTORED, MAT_FACTOR_SCHUR_INVERTED} MatFactorSchurStatus;
1174: PETSC_EXTERN PetscErrorCode MatFactorSetSchurIS(Mat,IS);
1175: PETSC_EXTERN PetscErrorCode MatFactorGetSchurComplement(Mat,Mat*,MatFactorSchurStatus*);
1176: PETSC_EXTERN PetscErrorCode MatFactorRestoreSchurComplement(Mat,Mat*,MatFactorSchurStatus);
1177: PETSC_EXTERN PetscErrorCode MatFactorInvertSchurComplement(Mat);
1178: PETSC_EXTERN PetscErrorCode MatFactorCreateSchurComplement(Mat,Mat*,MatFactorSchurStatus*);
1179: PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplement(Mat,Vec,Vec);
1180: PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplementTranspose(Mat,Vec,Vec);
1181: PETSC_EXTERN PetscErrorCode MatFactorFactorizeSchurComplement(Mat);

1183: /*E
1184:     MatSORType - What type of (S)SOR to perform

1186:     Level: beginner

1188:    May be bitwise ORd together

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

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

1194: .seealso: MatSOR()
1195: E*/
1196: typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1197:               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1198:               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
1199:               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1200: PETSC_EXTERN PetscErrorCode MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);

1202: /*
1203:     These routines are for efficiently computing Jacobians via finite differences.
1204: */

1206: /*S
1207:      MatColoring - Object for managing the coloring of matrices.

1209:    Level: beginner

1211: .seealso:  MatFDColoringCreate() ISColoring MatFDColoring
1212: S*/
1213: typedef struct _p_MatColoring* MatColoring;
1214: /*J
1215:     MatColoringType - String with the name of a PETSc matrix coloring

1217:    Level: beginner

1219: .seealso: MatColoringSetType(), MatColoring
1220: J*/

1222: typedef const  char*           MatColoringType;
1223: #define MATCOLORINGJP      "jp"
1224: #define MATCOLORINGPOWER   "power"
1225: #define MATCOLORINGNATURAL "natural"
1226: #define MATCOLORINGSL      "sl"
1227: #define MATCOLORINGLF      "lf"
1228: #define MATCOLORINGID      "id"
1229: #define MATCOLORINGGREEDY  "greedy"

1231: /*E
1232:    MatColoringWeightType - Type of weight scheme

1234:     Not Collective

1236: +   MAT_COLORING_RANDOM  - Random weights
1237: .   MAT_COLORING_LEXICAL - Lexical weighting based upon global numbering.
1238: -   MAT_COLORING_LF      - Last-first weighting.

1240:     Level: intermediate

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

1246: PETSC_EXTERN PetscErrorCode MatColoringCreate(Mat,MatColoring*);
1247: PETSC_EXTERN PetscErrorCode MatColoringGetDegrees(Mat,PetscInt,PetscInt*);
1248: PETSC_EXTERN PetscErrorCode MatColoringDestroy(MatColoring*);
1249: PETSC_EXTERN PetscErrorCode MatColoringView(MatColoring,PetscViewer);
1250: PETSC_EXTERN PetscErrorCode MatColoringSetType(MatColoring,MatColoringType);
1251: PETSC_EXTERN PetscErrorCode MatColoringSetFromOptions(MatColoring);
1252: PETSC_EXTERN PetscErrorCode MatColoringSetDistance(MatColoring,PetscInt);
1253: PETSC_EXTERN PetscErrorCode MatColoringGetDistance(MatColoring,PetscInt*);
1254: PETSC_EXTERN PetscErrorCode MatColoringSetMaxColors(MatColoring,PetscInt);
1255: PETSC_EXTERN PetscErrorCode MatColoringGetMaxColors(MatColoring,PetscInt*);
1256: PETSC_EXTERN PetscErrorCode MatColoringApply(MatColoring,ISColoring*);
1257: PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[],PetscErrorCode(*)(MatColoring));
1258: PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1259: PETSC_EXTERN PetscErrorCode MatColoringSetWeightType(MatColoring,MatColoringWeightType);
1260: PETSC_EXTERN PetscErrorCode MatColoringSetWeights(MatColoring,PetscReal*,PetscInt*);
1261: PETSC_EXTERN PetscErrorCode MatColoringCreateWeights(MatColoring,PetscReal **,PetscInt **lperm);
1262: PETSC_EXTERN PetscErrorCode MatColoringTest(MatColoring,ISColoring);
1263: PETSC_DEPRECATED_FUNCTION("Use MatColoringTest() (since version 3.10)") PETSC_STATIC_INLINE PetscErrorCode MatColoringTestValid(MatColoring matcoloring,ISColoring iscoloring) {return MatColoringTest(matcoloring,iscoloring);}
1264: PETSC_EXTERN PetscErrorCode MatISColoringTest(Mat,ISColoring);

1266: /*S
1267:      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1268:         and coloring

1270:    Level: beginner

1272: .seealso:  MatFDColoringCreate()
1273: S*/
1274: typedef struct _p_MatFDColoring* MatFDColoring;

1276: PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1277: PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring*);
1278: PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer);
1279: PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
1280: PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1281: PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1282: PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring);
1283: PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,void *);
1284: PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec);
1285: PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,const PetscInt*[]);
1286: PETSC_EXTERN PetscErrorCode MatFDColoringSetUp(Mat,ISColoring,MatFDColoring);
1287: PETSC_EXTERN PetscErrorCode MatFDColoringSetBlockSize(MatFDColoring,PetscInt,PetscInt);


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

1293:    Level: beginner

1295: .seealso:  MatTransposeColoringCreate()
1296: S*/
1297: typedef struct _p_MatTransposeColoring* MatTransposeColoring;

1299: PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat,ISColoring,MatTransposeColoring *);
1300: PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring,Mat,Mat);
1301: PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring,Mat,Mat);
1302: PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring*);

1304: /*
1305:     These routines are for partitioning matrices: currently used only
1306:   for adjacency matrix, MatCreateMPIAdj().
1307: */

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

1312:    Level: beginner

1314: .seealso:  MatPartitioningCreate(), MatPartitioningType
1315: S*/
1316: typedef struct _p_MatPartitioning* MatPartitioning;

1318: /*J
1319:     MatPartitioningType - String with the name of a PETSc matrix partitioning

1321:    Level: beginner
1322: dm
1323: .seealso: MatPartitioningCreate(), MatPartitioning
1324: J*/
1325: typedef const char* MatPartitioningType;
1326: #define MATPARTITIONINGCURRENT  "current"
1327: #define MATPARTITIONINGAVERAGE   "average"
1328: #define MATPARTITIONINGSQUARE   "square"
1329: #define MATPARTITIONINGPARMETIS "parmetis"
1330: #define MATPARTITIONINGCHACO    "chaco"
1331: #define MATPARTITIONINGPARTY    "party"
1332: #define MATPARTITIONINGPTSCOTCH "ptscotch"
1333: #define MATPARTITIONINGHIERARCH  "hierarch"


1336: PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1337: PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,MatPartitioningType);
1338: PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt);
1339: PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat);
1340: PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1341: PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1342: PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*);
1343: PETSC_EXTERN PetscErrorCode MatPartitioningImprove(MatPartitioning,IS*);
1344: PETSC_EXTERN PetscErrorCode MatPartitioningViewImbalance(MatPartitioning,IS);
1345: PETSC_EXTERN PetscErrorCode MatPartitioningApplyND(MatPartitioning,IS*);
1346: PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning*);

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



1352: PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer);
1353: PETSC_STATIC_INLINE PetscErrorCode MatPartitioningViewFromOptions(MatPartitioning A,PetscObject B,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,B,name);}

1355: PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning);
1356: PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,MatPartitioningType*);

1358: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetRepartition(MatPartitioning part);
1359: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
1360: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);

1362: typedef enum { MP_CHACO_MULTILEVEL=1,MP_CHACO_SPECTRAL=2,MP_CHACO_LINEAR=4,MP_CHACO_RANDOM=5,MP_CHACO_SCATTERED=6 } MPChacoGlobalType;
1363: PETSC_EXTERN const char *const MPChacoGlobalTypes[];
1364: typedef enum { MP_CHACO_KERNIGHAN=1,MP_CHACO_NONE=2 } MPChacoLocalType;
1365: PETSC_EXTERN const char *const MPChacoLocalTypes[];
1366: typedef enum { MP_CHACO_LANCZOS=0,MP_CHACO_RQI=1 } MPChacoEigenType;
1367: PETSC_EXTERN const char *const MPChacoEigenTypes[];

1369: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning,MPChacoGlobalType);
1370: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning,MPChacoGlobalType*);
1371: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning,MPChacoLocalType);
1372: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning,MPChacoLocalType*);
1373: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
1374: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1375: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning,MPChacoEigenType*);
1376: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning,PetscReal);
1377: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning,PetscReal*);
1378: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning,PetscInt);
1379: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning,PetscInt*);

1381: #define MP_PARTY_OPT "opt"
1382: #define MP_PARTY_LIN "lin"
1383: #define MP_PARTY_SCA "sca"
1384: #define MP_PARTY_RAN "ran"
1385: #define MP_PARTY_GBF "gbf"
1386: #define MP_PARTY_GCF "gcf"
1387: #define MP_PARTY_BUB "bub"
1388: #define MP_PARTY_DEF "def"
1389: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning,const char*);
1390: #define MP_PARTY_HELPFUL_SETS "hs"
1391: #define MP_PARTY_KERNIGHAN_LIN "kl"
1392: #define MP_PARTY_NONE "no"
1393: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning,const char*);
1394: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1395: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscBool);
1396: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool);

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

1401: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal);
1402: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*);
1403: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType);
1404: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*);

1406: /*
1407:  * hierarchical partitioning
1408:  */
1409: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetFineparts(MatPartitioning,IS*);
1410: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetCoarseparts(MatPartitioning,IS*);
1411: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNcoarseparts(MatPartitioning,PetscInt);
1412: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNfineparts(MatPartitioning, PetscInt);

1414: PETSC_EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*);
1415: PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*);

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

1572: PETSC_EXTERN PetscErrorCode MatShellSetOperation(Mat,MatOperation,void(*)(void));
1573: PETSC_EXTERN PetscErrorCode MatShellGetOperation(Mat,MatOperation,void(**)(void));
1574: PETSC_EXTERN PetscErrorCode MatShellSetContext(Mat,void*);
1575: PETSC_EXTERN PetscErrorCode MatShellTestMult(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*);
1576: PETSC_EXTERN PetscErrorCode MatShellTestMultTranspose(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*);
1577: PETSC_EXTERN PetscErrorCode MatShellSetManageScalingShifts(Mat);

1579: /*
1580:    Codes for matrices stored on disk. By default they are
1581:    stored in a universal format. By changing the format with
1582:    PetscViewerPushFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
1583:    be stored in a way natural for the matrix, for example dense matrices
1584:    would be stored as dense. Matrices stored this way may only be
1585:    read into matrices of the same type.
1586: */
1587: #define MATRIX_BINARY_FORMAT_DENSE -1

1589: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal);

1591: PETSC_EXTERN PetscErrorCode MatISSetLocalMatType(Mat,MatType);
1592: PETSC_EXTERN PetscErrorCode MatISSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1593: PETSC_EXTERN PetscErrorCode MatISStoreL2L(Mat,PetscBool);
1594: PETSC_EXTERN PetscErrorCode MatISFixLocalEmpty(Mat,PetscBool);
1595: PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*);
1596: PETSC_EXTERN PetscErrorCode MatISRestoreLocalMat(Mat,Mat*);
1597: PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat,Mat);
1598: PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use the MatConvert() interface (since version 3.10)") PetscErrorCode MatISGetMPIXAIJ(Mat,MatReuse,Mat*);

1600: /*S
1601:      MatNullSpace - Object that removes a null space from a vector, i.e.
1602:          orthogonalizes the vector to a subsapce

1604:    Level: advanced

1606:   Users manual sections:
1607: .   Section 4.19 Solving Singular Systems

1609: .seealso:  MatNullSpaceCreate()
1610: S*/
1611: typedef struct _p_MatNullSpace* MatNullSpace;

1613: PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*);
1614: PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*);
1615: PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace*);
1616: PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec);
1617: PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *);
1618: PETSC_EXTERN PetscErrorCode MatGetTransposeNullSpace(Mat, MatNullSpace *);
1619: PETSC_EXTERN PetscErrorCode MatSetTransposeNullSpace(Mat,MatNullSpace);
1620: PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat,MatNullSpace);
1621: PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat,MatNullSpace);
1622: PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat,MatNullSpace*);
1623: PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscBool  *);
1624: PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace,PetscViewer);
1625: PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace,PetscBool*,PetscInt*,const Vec**);
1626: PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec,MatNullSpace*);

1628: PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS);
1629: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1630: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
1631: PETSC_EXTERN PetscErrorCode MatSeqBAIJInvertBlockDiagonal(Mat);

1633: PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*);
1634: PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*);
1635: PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*);

1637: PETSC_EXTERN PetscErrorCode MatComputeOperator(Mat,MatType,Mat*);
1638: PETSC_EXTERN PetscErrorCode MatComputeOperatorTranspose(Mat,MatType,Mat*);

1640: PETSC_DEPRECATED_FUNCTION("Use MatComputeOperator() (since version 3.12)") PETSC_STATIC_INLINE PetscErrorCode MatComputeExplicitOperator(Mat A,Mat* B) { return MatComputeOperator(A,NULL,B); }
1641: PETSC_DEPRECATED_FUNCTION("Use MatComputeOperatorTranspose() (since version 3.12)") PETSC_STATIC_INLINE PetscErrorCode MatComputeExplicitOperatorTranspose(Mat A,Mat* B) { return MatComputeOperatorTranspose(A,NULL,B); }

1643: PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec);

1645: PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
1646: PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec);
1647: PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
1648: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
1649: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
1650: PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
1651: PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat);
1652: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal);
1653: PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt);
1654: PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat,PetscScalar *);
1655: PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat,const char[]);
1656: PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
1657: PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);

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

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

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

1668:     Level: developer

1670: .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister()
1671: S*/
1672: typedef struct _p_MatMFFD* MatMFFD;

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

1677:    Level: beginner

1679: .seealso: MatMFFDSetType(), MatMFFDRegister()
1680: J*/
1681: typedef const char* MatMFFDType;
1682: #define MATMFFD_DS  "ds"
1683: #define MATMFFD_WP  "wp"

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

1688: PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal);
1689: PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscBool );

1691: PETSC_EXTERN PetscErrorCode MatFDColoringSetType(MatFDColoring,MatMFFDType);

1693: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1694: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);

1696: /*
1697:    PETSc interface to MUMPS
1698: */
1699: #ifdef PETSC_HAVE_MUMPS
1700: PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt);
1701: PETSC_EXTERN PetscErrorCode MatMumpsGetIcntl(Mat,PetscInt,PetscInt*);
1702: PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat,PetscInt,PetscReal);
1703: PETSC_EXTERN PetscErrorCode MatMumpsGetCntl(Mat,PetscInt,PetscReal*);

1705: PETSC_EXTERN PetscErrorCode MatMumpsGetInfo(Mat,PetscInt,PetscInt*);
1706: PETSC_EXTERN PetscErrorCode MatMumpsGetInfog(Mat,PetscInt,PetscInt*);
1707: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfo(Mat,PetscInt,PetscReal*);
1708: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfog(Mat,PetscInt,PetscReal*);
1709: PETSC_EXTERN PetscErrorCode MatMumpsGetInverse(Mat,Mat);
1710: PETSC_EXTERN PetscErrorCode MatMumpsGetInverseTranspose(Mat,Mat);
1711: #endif

1713: /*
1714:    PETSc interface to Mkl_Pardiso
1715: */
1716: #ifdef PETSC_HAVE_MKL_PARDISO
1717: PETSC_EXTERN PetscErrorCode MatMkl_PardisoSetCntl(Mat,PetscInt,PetscInt);
1718: #endif

1720: /*
1721:    PETSc interface to Mkl_CPardiso
1722: */
1723: #ifdef PETSC_HAVE_MKL_CPARDISO
1724: PETSC_EXTERN PetscErrorCode MatMkl_CPardisoSetCntl(Mat,PetscInt,PetscInt);
1725: #endif

1727: /*
1728:    PETSc interface to SUPERLU
1729: */
1730: #ifdef PETSC_HAVE_SUPERLU
1731: PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal);
1732: #endif

1734: /*
1735:    PETSc interface to SUPERLU_DIST
1736: */
1737: #ifdef PETSC_HAVE_SUPERLU_DIST
1738: PETSC_EXTERN PetscErrorCode MatSuperluDistGetDiagU(Mat,PetscScalar*);
1739: #endif

1741: /*
1742:    PETSc interface to STRUMPACK
1743: */
1744: #ifdef PETSC_HAVE_STRUMPACK
1745: /*E
1746:     MatSTRUMPACKReordering - sparsity reducing ordering to be used in STRUMPACK

1748:     Level: intermediate
1749: E*/
1750: typedef enum {MAT_STRUMPACK_NATURAL=0,
1751:               MAT_STRUMPACK_METIS=1,
1752:               MAT_STRUMPACK_PARMETIS=2,
1753:               MAT_STRUMPACK_SCOTCH=3,
1754:               MAT_STRUMPACK_PTSCOTCH=4,
1755:               MAT_STRUMPACK_RCM=5} MatSTRUMPACKReordering;
1756: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetReordering(Mat,MatSTRUMPACKReordering);
1757: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetColPerm(Mat,PetscBool);
1758: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSRelTol(Mat,PetscReal);
1759: PETSC_DEPRECATED_FUNCTION("Use MatSTRUMPACKSetHSSRelTol() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSTRUMPACKSetHSSRelCompTol(Mat mat,PetscReal rtol) {return MatSTRUMPACKSetHSSRelTol(mat,rtol);}
1760: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSAbsTol(Mat,PetscReal);
1761: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMinSepSize(Mat,PetscInt);
1762: PETSC_DEPRECATED_FUNCTION("Use MatSTRUMPACKSetHSSMinSepSize() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSTRUMPACKSetHSSMinSize(Mat mat,PetscInt hssminsize) {return MatSTRUMPACKSetHSSMinSepSize(mat,hssminsize);}
1763: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMaxRank(Mat,PetscInt);
1764: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSLeafSize(Mat,PetscInt);
1765: #endif


1768: PETSC_EXTERN PetscErrorCode MatPinToCPU(Mat,PetscBool);

1770: #ifdef PETSC_HAVE_CUDA
1771: /*E
1772:     MatCUSPARSEStorageFormat - indicates the storage format for CUSPARSE (GPU)
1773:     matrices.

1775:     Not Collective

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

1781:     Level: intermediate

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

1785: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEFormatOperation
1786: E*/

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

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

1793: /*E
1794:     MatCUSPARSEFormatOperation - indicates the operation of CUSPARSE (GPU)
1795:     matrices whose operation should use a particular storage format.

1797:     Not Collective

1799: +   MAT_CUSPARSE_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult
1800: .   MAT_CUSPARSE_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult
1801: .   MAT_CUSPARSE_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult
1802: -   MAT_CUSPARSE_ALL - sets the storage format for all CUSPARSE (GPU) matrices

1804:     Level: intermediate

1806: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEStorageFormat
1807: E*/
1808: typedef enum {MAT_CUSPARSE_MULT_DIAG, MAT_CUSPARSE_MULT_OFFDIAG, MAT_CUSPARSE_MULT, MAT_CUSPARSE_ALL} MatCUSPARSEFormatOperation;

1810: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1811: PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1812: PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat,MatCUSPARSEFormatOperation,MatCUSPARSEStorageFormat);
1813: #endif

1815: #if defined(PETSC_HAVE_VIENNACL)
1816: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1817: PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1818: #endif

1820: /*
1821:    PETSc interface to FFTW
1822: */
1823: #if defined(PETSC_HAVE_FFTW)
1824: PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec);
1825: PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec);
1826: PETSC_EXTERN PetscErrorCode MatCreateVecsFFTW(Mat,Vec*,Vec*,Vec*);
1827: #endif

1829: PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*);
1830: PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*);
1831: PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat,IS[],IS[]);
1832: PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat,IS[],IS[]);
1833: PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***);
1834: PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*);
1835: PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat,VecType);
1836: PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]);
1837: PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat);

1839: PETSC_EXTERN PetscErrorCode MatChop(Mat,PetscReal);
1840: PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat,PetscReal,PetscInt*);

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

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

1846: PETSC_INTERN PetscErrorCode MatHeaderMerge(Mat,Mat*);
1847: PETSC_EXTERN PetscErrorCode MatHeaderReplace(Mat,Mat*);

1849: #endif