Actual source code: petscmat.h

petsc-master 2021-01-18
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 MATKAIJ            "kaij"
 31: #define MATSEQKAIJ         "seqkaij"
 32: #define MATMPIKAIJ         "mpikaij"
 33: #define MATIS              "is"
 34: #define MATAIJ             "aij"
 35: #define MATSEQAIJ          "seqaij"
 36: #define MATMPIAIJ          "mpiaij"
 37: #define MATAIJCRL          "aijcrl"
 38: #define MATSEQAIJCRL       "seqaijcrl"
 39: #define MATMPIAIJCRL       "mpiaijcrl"
 40: #define MATAIJCUSPARSE     "aijcusparse"
 41: #define MATSEQAIJCUSPARSE  "seqaijcusparse"
 42: #define MATMPIAIJCUSPARSE  "mpiaijcusparse"
 43: #define MATAIJKOKKOS       "aijkokkos"
 44: #define MATSEQAIJKOKKOS    "seqaijkokkos"
 45: #define MATMPIAIJKOKKOS    "mpiaijkokkos"
 46: #define MATAIJVIENNACL     "aijviennacl"
 47: #define MATSEQAIJVIENNACL  "seqaijviennacl"
 48: #define MATMPIAIJVIENNACL  "mpiaijviennacl"
 49: #define MATAIJPERM         "aijperm"
 50: #define MATSEQAIJPERM      "seqaijperm"
 51: #define MATMPIAIJPERM      "mpiaijperm"
 52: #define MATAIJSELL         "aijsell"
 53: #define MATSEQAIJSELL      "seqaijsell"
 54: #define MATMPIAIJSELL      "mpiaijsell"
 55: #define MATAIJMKL          "aijmkl"
 56: #define MATSEQAIJMKL       "seqaijmkl"
 57: #define MATMPIAIJMKL       "mpiaijmkl"
 58: #define MATBAIJMKL         "baijmkl"
 59: #define MATSEQBAIJMKL      "seqbaijmkl"
 60: #define MATMPIBAIJMKL      "mpibaijmkl"
 61: #define MATSHELL           "shell"
 62: #define MATDENSE           "dense"
 63: #define MATDENSECUDA       "densecuda"
 64: #define MATSEQDENSE        "seqdense"
 65: #define MATSEQDENSECUDA    "seqdensecuda"
 66: #define MATMPIDENSE        "mpidense"
 67: #define MATMPIDENSECUDA    "mpidensecuda"
 68: #define MATELEMENTAL       "elemental"
 69: #define MATSCALAPACK       "scalapack"
 70: #define MATBAIJ            "baij"
 71: #define MATSEQBAIJ         "seqbaij"
 72: #define MATMPIBAIJ         "mpibaij"
 73: #define MATMPIADJ          "mpiadj"
 74: #define MATSBAIJ           "sbaij"
 75: #define MATSEQSBAIJ        "seqsbaij"
 76: #define MATMPISBAIJ        "mpisbaij"
 77: #define MATMFFD            "mffd"
 78: #define MATNORMAL          "normal"
 79: #define MATNORMALHERMITIAN "normalh"
 80: #define MATLRC             "lrc"
 81: #define MATSCATTER         "scatter"
 82: #define MATBLOCKMAT        "blockmat"
 83: #define MATCOMPOSITE       "composite"
 84: #define MATFFT             "fft"
 85: #define MATFFTW            "fftw"
 86: #define MATSEQCUFFT        "seqcufft"
 87: #define MATTRANSPOSEMAT    "transpose"
 88: #define MATSCHURCOMPLEMENT "schurcomplement"
 89: #define MATPYTHON          "python"
 90: #define MATHYPRE           "hypre"
 91: #define MATHYPRESTRUCT     "hyprestruct"
 92: #define MATHYPRESSTRUCT    "hypresstruct"
 93: #define MATSUBMATRIX       "submatrix"
 94: #define MATLOCALREF        "localref"
 95: #define MATNEST            "nest"
 96: #define MATPREALLOCATOR    "preallocator"
 97: #define MATSELL            "sell"
 98: #define MATSEQSELL         "seqsell"
 99: #define MATMPISELL         "mpisell"
100: #define MATDUMMY           "dummy"
101: #define MATLMVM            "lmvm"
102: #define MATLMVMDFP         "lmvmdfp"
103: #define MATLMVMBFGS        "lmvmbfgs"
104: #define MATLMVMSR1         "lmvmsr1"
105: #define MATLMVMBROYDEN     "lmvmbroyden"
106: #define MATLMVMBADBROYDEN  "lmvmbadbroyden"
107: #define MATLMVMSYMBROYDEN  "lmvmsymbroyden"
108: #define MATLMVMSYMBADBROYDEN "lmvmsymbadbroyden"
109: #define MATLMVMDIAGBROYDEN   "lmvmdiagbroyden"
110: #define MATCONSTANTDIAGONAL  "constantdiagonal"
111: #define MATHARA              "hara"

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

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

118:    Level: beginner

120:    Notes:  MATSOLVERUMFPACK, MATSOLVERCHOLMOD, MATSOLVERKLU form the SuiteSparse package for which you can use --download-suitesparse

122: .seealso: MatGetFactor(), PCFactorSetMatSolverType(), PCFactorGetMatSolverType()
123: J*/
124: typedef const char* MatSolverType;
125: #define MATSOLVERSUPERLU          "superlu"
126: #define MATSOLVERSUPERLU_DIST     "superlu_dist"
127: #define MATSOLVERSTRUMPACK        "strumpack"
128: #define MATSOLVERUMFPACK          "umfpack"
129: #define MATSOLVERCHOLMOD          "cholmod"
130: #define MATSOLVERKLU              "klu"
131: #define MATSOLVERSPARSEELEMENTAL  "sparseelemental"
132: #define MATSOLVERELEMENTAL        "elemental"
133: #define MATSOLVERSCALAPACK        "scalapack"
134: #define MATSOLVERESSL             "essl"
135: #define MATSOLVERLUSOL            "lusol"
136: #define MATSOLVERMUMPS            "mumps"
137: #define MATSOLVERMKL_PARDISO      "mkl_pardiso"
138: #define MATSOLVERMKL_CPARDISO     "mkl_cpardiso"
139: #define MATSOLVERPASTIX           "pastix"
140: #define MATSOLVERMATLAB           "matlab"
141: #define MATSOLVERPETSC            "petsc"
142: #define MATSOLVERBAS              "bas"
143: #define MATSOLVERCUSPARSE         "cusparse"
144: #define MATSOLVERCUDA             "cuda"
145: #define MATSOLVERKOKKOS           "kokkos"

147: /*E
148:     MatFactorType - indicates what type of factorization is requested

150:     Level: beginner

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

154: .seealso: MatSolverType, MatGetFactor(), MatGetFactorAvailable(), MatSolverTypeRegister()
155: E*/
156: typedef enum {MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC,MAT_FACTOR_ILUDT} MatFactorType;
157: PETSC_EXTERN const char *const MatFactorTypes[];

159: PETSC_EXTERN PetscErrorCode MatGetFactor(Mat,MatSolverType,MatFactorType,Mat*);
160: PETSC_EXTERN PetscErrorCode MatGetFactorAvailable(Mat,MatSolverType,MatFactorType,PetscBool *);
161: PETSC_EXTERN PetscErrorCode MatFactorGetUseOrdering(Mat, PetscBool*);
162: PETSC_EXTERN PetscErrorCode MatFactorGetSolverType(Mat,MatSolverType*);
163: PETSC_EXTERN PetscErrorCode MatGetFactorType(Mat,MatFactorType*);
164: PETSC_EXTERN PetscErrorCode MatSetFactorType(Mat,MatFactorType);
165: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*MatSolverFunction)(Mat,MatFactorType,Mat*);
166: PETSC_EXTERN PetscErrorCode MatSolverTypeRegister(MatSolverType,MatType,MatFactorType,MatSolverFunction);
167: PETSC_EXTERN PetscErrorCode MatSolverTypeGet(MatSolverType,MatType,MatFactorType,PetscBool*,PetscBool*,MatSolverFunction*);
168: typedef MatSolverType MatSolverPackage PETSC_DEPRECATED_TYPEDEF("Use MatSolverType (since version 3.9)");
169: PETSC_DEPRECATED_FUNCTION("Use MatSolverTypeRegister() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSolverPackageRegister(MatSolverType stype,MatType mtype,MatFactorType ftype,MatSolverFunction f)
170: { return MatSolverTypeRegister(stype,mtype,ftype,f); }
171: PETSC_DEPRECATED_FUNCTION("Use MatSolverTypeGet() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSolverPackageGet(MatSolverType stype,MatType mtype,MatFactorType ftype,PetscBool *foundmtype,PetscBool *foundstype,MatSolverFunction *f)
172: { return MatSolverTypeGet(stype,mtype,ftype,foundmtype,foundstype,f); }

174: /*E
175:     MatProductType - indicates what type of matrix product is requested

177:     Level: beginner

179: .seealso: MatSolverType, MatProductSetType()
180: E*/
181: typedef enum {MATPRODUCT_UNSPECIFIED=0,MATPRODUCT_AB,MATPRODUCT_AtB,MATPRODUCT_ABt,MATPRODUCT_PtAP,MATPRODUCT_RARt,MATPRODUCT_ABC} MatProductType;
182: PETSC_EXTERN const char *const MatProductTypes[];

184: /*J
185:     MatProductAlgorithm - String with the name of an algorithm for a PETSc matrix product implementation

187:    Level: beginner

189: .seealso: MatSetType(), Mat, MatSolverType, MatRegister(), MatProductSetAlgorithm(), MatProductType
190: J*/
191: typedef const char* MatProductAlgorithm;
192: #define MATPRODUCTALGORITHM_DEFAULT "default"

194: PETSC_EXTERN PetscErrorCode MatProductCreate(Mat,Mat,Mat,Mat*);
195: PETSC_EXTERN PetscErrorCode MatProductCreateWithMat(Mat,Mat,Mat,Mat);
196: PETSC_EXTERN PetscErrorCode MatProductSetType(Mat,MatProductType);
197: PETSC_EXTERN PetscErrorCode MatProductSetAlgorithm(Mat,MatProductAlgorithm);
198: PETSC_EXTERN PetscErrorCode MatProductSetFill(Mat,PetscReal);
199: PETSC_EXTERN PetscErrorCode MatProductSetFromOptions(Mat);
200: PETSC_EXTERN PetscErrorCode MatProductSymbolic(Mat);
201: PETSC_EXTERN PetscErrorCode MatProductNumeric(Mat);
202: PETSC_EXTERN PetscErrorCode MatProductReplaceMats(Mat,Mat,Mat,Mat);
203: PETSC_EXTERN PetscErrorCode MatProductClear(Mat);
204: PETSC_EXTERN PetscErrorCode MatProductView(Mat,PetscViewer);

206: /* Logging support */
207: #define    MAT_FILE_CLASSID 1211216    /* used to indicate matrices in binary files */
208: PETSC_EXTERN PetscClassId MAT_CLASSID;
209: PETSC_EXTERN PetscClassId MAT_COLORING_CLASSID;
210: PETSC_EXTERN PetscClassId MAT_FDCOLORING_CLASSID;
211: PETSC_EXTERN PetscClassId MAT_TRANSPOSECOLORING_CLASSID;
212: PETSC_EXTERN PetscClassId MAT_PARTITIONING_CLASSID;
213: PETSC_EXTERN PetscClassId MAT_COARSEN_CLASSID;
214: PETSC_EXTERN PetscClassId MAT_NULLSPACE_CLASSID;
215: PETSC_EXTERN PetscClassId MATMFFD_CLASSID;

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

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

226:     Level: beginner

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

230: .seealso: MatCreateSubMatrices(), MatCreateSubMatrix(), MatDestroyMatrices(), MatConvert()
231: E*/
232: typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX,MAT_INPLACE_MATRIX} MatReuse;

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

238:     Level: beginner

240: .seealso: MatGetSeqNonzerostructure()
241: E*/
242: typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatCreateSubMatrixOption;

244: PETSC_EXTERN PetscErrorCode MatInitializePackage(void);

246: PETSC_EXTERN PetscErrorCode MatCreate(MPI_Comm,Mat*);
247: PETSC_EXTERN PetscErrorCode MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
248: PETSC_EXTERN PetscErrorCode MatSetType(Mat,MatType);
249: PETSC_EXTERN PetscErrorCode MatGetVecType(Mat,VecType*);
250: PETSC_EXTERN PetscErrorCode MatSetVecType(Mat,VecType);
251: PETSC_EXTERN PetscErrorCode MatSetFromOptions(Mat);
252: PETSC_EXTERN PetscErrorCode MatViewFromOptions(Mat,PetscObject,const char[]);
253: PETSC_EXTERN PetscErrorCode MatRegister(const char[],PetscErrorCode(*)(Mat));
254: PETSC_EXTERN PetscErrorCode MatRegisterRootName(const char[],const char[],const char[]);
255: PETSC_EXTERN PetscErrorCode MatSetOptionsPrefix(Mat,const char[]);
256: PETSC_EXTERN PetscErrorCode MatAppendOptionsPrefix(Mat,const char[]);
257: PETSC_EXTERN PetscErrorCode MatGetOptionsPrefix(Mat,const char*[]);
258: PETSC_EXTERN PetscErrorCode MatSetErrorIfFailure(Mat,PetscBool);

260: PETSC_EXTERN PetscFunctionList MatList;
261: PETSC_EXTERN PetscFunctionList MatColoringList;
262: PETSC_EXTERN PetscFunctionList MatPartitioningList;

264: /*E
265:     MatStructure - Indicates if two matrices have the same nonzero structure

267:     Level: beginner

269:    Any additions/changes here MUST also be made in src/mat/f90-mod/petscmat.h

271: .seealso: MatCopy(), MatAXPY()
272: E*/
273: typedef enum {DIFFERENT_NONZERO_PATTERN,SUBSET_NONZERO_PATTERN,SAME_NONZERO_PATTERN,UNKNOWN_NONZERO_PATTERN} MatStructure;
274: PETSC_EXTERN const char *const MatStructures[];

276: #if defined PETSC_HAVE_MKL_SPARSE
277: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
278: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
279: PETSC_EXTERN PetscErrorCode MatCreateBAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
280: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
281: #endif

283: PETSC_EXTERN PetscErrorCode MatCreateSeqSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
284: PETSC_EXTERN PetscErrorCode MatCreateSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
285: PETSC_EXTERN PetscErrorCode MatSeqSELLSetPreallocation(Mat,PetscInt,const PetscInt[]);
286: PETSC_EXTERN PetscErrorCode MatMPISELLSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);

288: PETSC_EXTERN PetscErrorCode MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
289: PETSC_EXTERN PetscErrorCode MatCreateDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
290: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
291: PETSC_EXTERN PetscErrorCode MatCreateAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
292: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat*);
293: PETSC_EXTERN PetscErrorCode MatUpdateMPIAIJWithArrays(Mat,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
294: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*);
295: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSeqAIJ(MPI_Comm,Mat,Mat,const PetscInt[],Mat*);

297: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
298: PETSC_EXTERN PetscErrorCode MatCreateBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
299: PETSC_EXTERN PetscErrorCode MatCreateMPIBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat*);

301: PETSC_EXTERN PetscErrorCode MatSetPreallocationCOO(Mat,PetscInt,const PetscInt[],const PetscInt[]);
302: PETSC_EXTERN PetscErrorCode MatSetValuesCOO(Mat,const PetscScalar[],InsertMode);

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

307: PETSC_EXTERN PetscErrorCode MatCreateSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
308: PETSC_EXTERN PetscErrorCode MatCreateMPISBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
309: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
310: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
311: PETSC_EXTERN PetscErrorCode MatXAIJSetPreallocation(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],const PetscInt[]);

313: PETSC_EXTERN PetscErrorCode MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
314: PETSC_EXTERN PetscErrorCode MatCreateNormal(Mat,Mat*);
315: PETSC_EXTERN PetscErrorCode MatCreateNormalHermitian(Mat,Mat*);
316: PETSC_EXTERN PetscErrorCode MatCreateLRC(Mat,Mat,Vec,Mat,Mat*);
317: PETSC_EXTERN PetscErrorCode MatLRCGetMats(Mat,Mat*,Mat*,Vec*,Mat*);
318: PETSC_EXTERN PetscErrorCode MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,ISLocalToGlobalMapping,Mat*);
319: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
320: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);

322: PETSC_EXTERN PetscErrorCode MatCreateScatter(MPI_Comm,VecScatter,Mat*);
323: PETSC_EXTERN PetscErrorCode MatScatterSetVecScatter(Mat,VecScatter);
324: PETSC_EXTERN PetscErrorCode MatScatterGetVecScatter(Mat,VecScatter*);
325: PETSC_EXTERN PetscErrorCode MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*);
326: PETSC_EXTERN PetscErrorCode MatCompositeAddMat(Mat,Mat);
327: PETSC_EXTERN PetscErrorCode MatCompositeMerge(Mat);
328: typedef enum {MAT_COMPOSITE_MERGE_RIGHT,MAT_COMPOSITE_MERGE_LEFT} MatCompositeMergeType;
329: PETSC_EXTERN PetscErrorCode MatCompositeSetMergeType(Mat,MatCompositeMergeType);
330: PETSC_EXTERN PetscErrorCode MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*);
331: typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType;
332: PETSC_EXTERN PetscErrorCode MatCompositeSetType(Mat,MatCompositeType);
333: PETSC_EXTERN PetscErrorCode MatCompositeGetType(Mat,MatCompositeType*);
334: PETSC_EXTERN PetscErrorCode MatCompositeSetMatStructure(Mat,MatStructure);
335: PETSC_EXTERN PetscErrorCode MatCompositeGetMatStructure(Mat,MatStructure*);
336: PETSC_EXTERN PetscErrorCode MatCompositeGetNumberMat(Mat,PetscInt*);
337: PETSC_EXTERN PetscErrorCode MatCompositeGetMat(Mat,PetscInt,Mat*);
338: PETSC_EXTERN PetscErrorCode MatCompositeSetScalings(Mat,const PetscScalar*);

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

343: PETSC_EXTERN PetscErrorCode MatCreateTranspose(Mat,Mat*);
344: PETSC_EXTERN PetscErrorCode MatTransposeGetMat(Mat,Mat*);
345: PETSC_EXTERN PetscErrorCode MatCreateHermitianTranspose(Mat,Mat*);
346: PETSC_EXTERN PetscErrorCode MatHermitianTransposeGetMat(Mat,Mat*);
347: PETSC_EXTERN PetscErrorCode MatCreateSubMatrixVirtual(Mat,IS,IS,Mat*);
348: PETSC_EXTERN PetscErrorCode MatSubMatrixVirtualUpdate(Mat,Mat,IS,IS);
349: PETSC_EXTERN PetscErrorCode MatCreateLocalRef(Mat,IS,IS,Mat*);
350: PETSC_EXTERN PetscErrorCode MatCreateConstantDiagonal(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar,Mat*);

352: #if defined(PETSC_HAVE_HYPRE)
353: PETSC_EXTERN PetscErrorCode MatHYPRESetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
354: #endif

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

358: PETSC_EXTERN PetscErrorCode MatResetPreallocation(Mat);
359: PETSC_EXTERN PetscErrorCode MatSetUp(Mat);
360: PETSC_EXTERN PetscErrorCode MatDestroy(Mat*);
361: PETSC_EXTERN PetscErrorCode MatGetNonzeroState(Mat,PetscObjectState*);

363: PETSC_EXTERN PetscErrorCode MatConjugate(Mat);
364: PETSC_EXTERN PetscErrorCode MatRealPart(Mat);
365: PETSC_EXTERN PetscErrorCode MatImaginaryPart(Mat);
366: PETSC_EXTERN PetscErrorCode MatGetDiagonalBlock(Mat,Mat*);
367: PETSC_EXTERN PetscErrorCode MatGetTrace(Mat,PetscScalar*);
368: PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonal(Mat,const PetscScalar **);
369: PETSC_EXTERN PetscErrorCode MatInvertVariableBlockDiagonal(Mat,PetscInt,const PetscInt*,PetscScalar*);
370: PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonalMat(Mat,Mat);

372: /* ------------------------------------------------------------*/
373: PETSC_EXTERN PetscErrorCode MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
374: PETSC_EXTERN PetscErrorCode MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
375: PETSC_EXTERN PetscErrorCode MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
376: PETSC_EXTERN PetscErrorCode MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);
377: PETSC_EXTERN PetscErrorCode MatSetValuesBatch(Mat,PetscInt,PetscInt,PetscInt[],const PetscScalar[]);
378: PETSC_EXTERN PetscErrorCode MatSetRandom(Mat,PetscRandom);

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

384:    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).
385:    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.

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

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

391:    Level: beginner

393: .seealso:  MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockedStencil(), DMDAVecGetArray(), DMDAVecGetArrayF90()
394: S*/
395: typedef struct {
396:   PetscInt k,j,i,c;
397: } MatStencil;

399: PETSC_EXTERN PetscErrorCode MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
400: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
401: PETSC_EXTERN PetscErrorCode MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);

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

407:     Level: beginner

409: .seealso: MatAssemblyBegin(), MatAssemblyEnd()
410: E*/
411: typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
412: PETSC_EXTERN PetscErrorCode MatAssemblyBegin(Mat,MatAssemblyType);
413: PETSC_EXTERN PetscErrorCode MatAssemblyEnd(Mat,MatAssemblyType);
414: PETSC_EXTERN PetscErrorCode MatAssembled(Mat,PetscBool *);



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

421:     Level: beginner

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

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

429: .seealso: MatSetOption()
430: E*/
431: typedef enum {MAT_OPTION_MIN = -3,
432:               MAT_UNUSED_NONZERO_LOCATION_ERR = -2,
433:               MAT_ROW_ORIENTED = -1,
434:               MAT_SYMMETRIC = 1,
435:               MAT_STRUCTURALLY_SYMMETRIC = 2,
436:               MAT_FORCE_DIAGONAL_ENTRIES = 3,
437:               MAT_IGNORE_OFF_PROC_ENTRIES = 4,
438:               MAT_USE_HASH_TABLE = 5,
439:               MAT_KEEP_NONZERO_PATTERN = 6,
440:               MAT_IGNORE_ZERO_ENTRIES = 7,
441:               MAT_USE_INODES = 8,
442:               MAT_HERMITIAN = 9,
443:               MAT_SYMMETRY_ETERNAL = 10,
444:               MAT_NEW_NONZERO_LOCATION_ERR = 11,
445:               MAT_IGNORE_LOWER_TRIANGULAR = 12,
446:               MAT_ERROR_LOWER_TRIANGULAR = 13,
447:               MAT_GETROW_UPPERTRIANGULAR = 14,
448:               MAT_SPD = 15,
449:               MAT_NO_OFF_PROC_ZERO_ROWS = 16,
450:               MAT_NO_OFF_PROC_ENTRIES = 17,
451:               MAT_NEW_NONZERO_LOCATIONS = 18,
452:               MAT_NEW_NONZERO_ALLOCATION_ERR = 19,
453:               MAT_SUBSET_OFF_PROC_ENTRIES = 20,
454:               MAT_SUBMAT_SINGLEIS = 21,
455:               MAT_STRUCTURE_ONLY = 22,
456:               MAT_SORTED_FULL = 23,
457:               MAT_OPTION_MAX = 24} MatOption;

459: PETSC_EXTERN const char *const *MatOptions;
460: PETSC_EXTERN PetscErrorCode MatSetOption(Mat,MatOption,PetscBool);
461: PETSC_EXTERN PetscErrorCode MatGetOption(Mat,MatOption,PetscBool*);
462: PETSC_EXTERN PetscErrorCode MatPropagateSymmetryOptions(Mat,Mat);
463: PETSC_EXTERN PetscErrorCode MatGetType(Mat,MatType*);

465: PETSC_EXTERN PetscErrorCode MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
466: PETSC_EXTERN PetscErrorCode MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
467: PETSC_EXTERN PetscErrorCode MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
468: PETSC_EXTERN PetscErrorCode MatGetRowUpperTriangular(Mat);
469: PETSC_EXTERN PetscErrorCode MatRestoreRowUpperTriangular(Mat);
470: PETSC_EXTERN PetscErrorCode MatGetColumnVector(Mat,Vec,PetscInt);
471: PETSC_EXTERN PetscErrorCode MatSeqAIJGetArray(Mat,PetscScalar *[]);
472: PETSC_EXTERN PetscErrorCode MatSeqAIJGetArrayRead(Mat,const PetscScalar *[]);
473: PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArray(Mat,PetscScalar *[]);
474: PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArrayRead(Mat,const PetscScalar *[]);
475: PETSC_EXTERN PetscErrorCode MatSeqAIJGetMaxRowNonzeros(Mat,PetscInt*);
476: PETSC_EXTERN PetscErrorCode MatSeqAIJSetValuesLocalFast(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
477: PETSC_EXTERN PetscErrorCode MatSeqAIJSetType(Mat,MatType);
478: PETSC_EXTERN PetscErrorCode MatSeqAIJRegister(const char[],PetscErrorCode (*)(Mat,MatType,MatReuse,Mat *));
479: PETSC_EXTERN PetscFunctionList MatSeqAIJList;
480: PETSC_EXTERN PetscErrorCode MatSeqBAIJGetArray(Mat,PetscScalar *[]);
481: PETSC_EXTERN PetscErrorCode MatSeqBAIJRestoreArray(Mat,PetscScalar *[]);
482: PETSC_EXTERN PetscErrorCode MatSeqSBAIJGetArray(Mat,PetscScalar *[]);
483: PETSC_EXTERN PetscErrorCode MatSeqSBAIJRestoreArray(Mat,PetscScalar *[]);
484: PETSC_EXTERN PetscErrorCode MatDenseGetArray(Mat,PetscScalar *[]);
485: PETSC_EXTERN PetscErrorCode MatDenseRestoreArray(Mat,PetscScalar *[]);
486: PETSC_EXTERN PetscErrorCode MatDensePlaceArray(Mat,const PetscScalar[]);
487: PETSC_EXTERN PetscErrorCode MatDenseReplaceArray(Mat,const PetscScalar[]);
488: PETSC_EXTERN PetscErrorCode MatDenseResetArray(Mat);
489: PETSC_EXTERN PetscErrorCode MatDenseGetArrayRead(Mat,const PetscScalar *[]);
490: PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayRead(Mat,const PetscScalar *[]);
491: PETSC_EXTERN PetscErrorCode MatDenseGetArrayWrite(Mat,PetscScalar *[]);
492: PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayWrite(Mat,PetscScalar *[]);
493: PETSC_EXTERN PetscErrorCode MatGetBlockSize(Mat,PetscInt *);
494: PETSC_EXTERN PetscErrorCode MatSetBlockSize(Mat,PetscInt);
495: PETSC_EXTERN PetscErrorCode MatGetBlockSizes(Mat,PetscInt *,PetscInt *);
496: PETSC_EXTERN PetscErrorCode MatSetBlockSizes(Mat,PetscInt,PetscInt);
497: PETSC_EXTERN PetscErrorCode MatSetBlockSizesFromMats(Mat,Mat,Mat);
498: PETSC_EXTERN PetscErrorCode MatSetVariableBlockSizes(Mat,PetscInt,PetscInt*);
499: PETSC_EXTERN PetscErrorCode MatGetVariableBlockSizes(Mat,PetscInt*,const PetscInt**);

501: PETSC_EXTERN PetscErrorCode MatDenseGetColumn(Mat,PetscInt,PetscScalar*[]);
502: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumn(Mat,PetscScalar*[]);
503: PETSC_EXTERN PetscErrorCode MatDenseGetColumnVec(Mat,PetscInt,Vec*);
504: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVec(Mat,PetscInt,Vec*);
505: PETSC_EXTERN PetscErrorCode MatDenseGetColumnVecRead(Mat,PetscInt,Vec*);
506: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVecRead(Mat,PetscInt,Vec*);
507: PETSC_EXTERN PetscErrorCode MatDenseGetColumnVecWrite(Mat,PetscInt,Vec*);
508: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumnVecWrite(Mat,PetscInt,Vec*);
509: PETSC_EXTERN PetscErrorCode MatDenseGetSubMatrix(Mat,PetscInt,PetscInt,Mat*);
510: PETSC_EXTERN PetscErrorCode MatDenseRestoreSubMatrix(Mat,Mat*);

512: PETSC_EXTERN PetscErrorCode MatMult(Mat,Vec,Vec);
513: PETSC_EXTERN PetscErrorCode MatMultDiagonalBlock(Mat,Vec,Vec);
514: PETSC_EXTERN PetscErrorCode MatMultAdd(Mat,Vec,Vec,Vec);
515: PETSC_EXTERN PetscErrorCode MatMultTranspose(Mat,Vec,Vec);
516: PETSC_EXTERN PetscErrorCode MatMultHermitianTranspose(Mat,Vec,Vec);
517: PETSC_EXTERN PetscErrorCode MatIsTranspose(Mat,Mat,PetscReal,PetscBool *);
518: PETSC_EXTERN PetscErrorCode MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscBool *);
519: PETSC_EXTERN PetscErrorCode MatMultTransposeAdd(Mat,Vec,Vec,Vec);
520: PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec);
521: PETSC_EXTERN PetscErrorCode MatMultConstrained(Mat,Vec,Vec);
522: PETSC_EXTERN PetscErrorCode MatMultTransposeConstrained(Mat,Vec,Vec);
523: PETSC_EXTERN PetscErrorCode MatMatSolve(Mat,Mat,Mat);
524: PETSC_EXTERN PetscErrorCode MatMatSolveTranspose(Mat,Mat,Mat);
525: PETSC_EXTERN PetscErrorCode MatMatTransposeSolve(Mat,Mat,Mat);
526: PETSC_EXTERN PetscErrorCode MatResidual(Mat,Vec,Vec,Vec);

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

532:     Level: beginner

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

536: $   MAT_DO_NOT_COPY_VALUES    - Create a matrix using the same nonzero pattern as the original matrix,
537: $                               with zeros for the numerical values.
538: $   MAT_COPY_VALUES           - Create a matrix with the same nonzero pattern as the original matrix
539: $                               and with the same numerical values.
540: $   MAT_SHARE_NONZERO_PATTERN - Create a matrix that shares the nonzero structure with the previous matrix
541: $                               and does not copy it, using zeros for the numerical values. The parent and
542: $                               child matrices will share their index (i and j) arrays, and you cannot
543: $                               insert new nonzero entries into either matrix.

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

549: .seealso: MatDuplicate()
550: E*/
551: typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption;

553: PETSC_EXTERN PetscErrorCode MatConvert(Mat,MatType,MatReuse,Mat*);
554: PETSC_EXTERN PetscErrorCode MatDuplicate(Mat,MatDuplicateOption,Mat*);


557: PETSC_EXTERN PetscErrorCode MatCopy(Mat,Mat,MatStructure);
558: PETSC_EXTERN PetscErrorCode MatView(Mat,PetscViewer);
559: PETSC_EXTERN PetscErrorCode MatIsSymmetric(Mat,PetscReal,PetscBool *);
560: PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat,PetscBool *);
561: PETSC_EXTERN PetscErrorCode MatIsHermitian(Mat,PetscReal,PetscBool *);
562: PETSC_EXTERN PetscErrorCode MatIsSymmetricKnown(Mat,PetscBool *,PetscBool *);
563: PETSC_EXTERN PetscErrorCode MatIsHermitianKnown(Mat,PetscBool *,PetscBool *);
564: PETSC_EXTERN PetscErrorCode MatMissingDiagonal(Mat,PetscBool  *,PetscInt *);
565: PETSC_EXTERN PetscErrorCode MatLoad(Mat, PetscViewer);

567: PETSC_EXTERN PetscErrorCode MatGetRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool  *);
568: PETSC_EXTERN PetscErrorCode MatRestoreRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool  *);
569: PETSC_EXTERN PetscErrorCode MatGetColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool  *);
570: PETSC_EXTERN PetscErrorCode MatRestoreColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool  *);

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

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

577:    Level: intermediate

579: .seealso:  MatGetInfo(), MatInfoType
580: S*/
581: typedef struct {
582:   PetscLogDouble block_size;                         /* block size */
583:   PetscLogDouble nz_allocated,nz_used,nz_unneeded;   /* number of nonzeros */
584:   PetscLogDouble memory;                             /* memory allocated */
585:   PetscLogDouble assemblies;                         /* number of matrix assemblies called */
586:   PetscLogDouble mallocs;                            /* number of mallocs during MatSetValues() */
587:   PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
588:   PetscLogDouble factor_mallocs;                     /* number of mallocs during factorization */
589: } MatInfo;

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

595:     Level: beginner

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

599: .seealso: MatGetInfo(), MatInfo
600: E*/
601: typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
602: PETSC_EXTERN PetscErrorCode MatGetInfo(Mat,MatInfoType,MatInfo*);
603: PETSC_EXTERN PetscErrorCode MatGetDiagonal(Mat,Vec);
604: PETSC_EXTERN PetscErrorCode MatGetRowMax(Mat,Vec,PetscInt[]);
605: PETSC_EXTERN PetscErrorCode MatGetRowMin(Mat,Vec,PetscInt[]);
606: PETSC_EXTERN PetscErrorCode MatGetRowMaxAbs(Mat,Vec,PetscInt[]);
607: PETSC_EXTERN PetscErrorCode MatGetRowMinAbs(Mat,Vec,PetscInt[]);
608: PETSC_EXTERN PetscErrorCode MatGetRowSum(Mat,Vec);
609: PETSC_EXTERN PetscErrorCode MatTranspose(Mat,MatReuse,Mat*);
610: PETSC_EXTERN PetscErrorCode MatHermitianTranspose(Mat,MatReuse,Mat*);
611: PETSC_EXTERN PetscErrorCode MatPermute(Mat,IS,IS,Mat*);
612: PETSC_EXTERN PetscErrorCode MatDiagonalScale(Mat,Vec,Vec);
613: PETSC_EXTERN PetscErrorCode MatDiagonalSet(Mat,Vec,InsertMode);

615: PETSC_EXTERN PetscErrorCode MatEqual(Mat,Mat,PetscBool*);
616: PETSC_EXTERN PetscErrorCode MatMultEqual(Mat,Mat,PetscInt,PetscBool*);
617: PETSC_EXTERN PetscErrorCode MatMultAddEqual(Mat,Mat,PetscInt,PetscBool*);
618: PETSC_EXTERN PetscErrorCode MatMultTransposeEqual(Mat,Mat,PetscInt,PetscBool*);
619: PETSC_EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscBool*);
620: PETSC_EXTERN PetscErrorCode MatMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
621: PETSC_EXTERN PetscErrorCode MatTransposeMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
622: PETSC_EXTERN PetscErrorCode MatMatTransposeMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
623: PETSC_EXTERN PetscErrorCode MatPtAPMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
624: PETSC_EXTERN PetscErrorCode MatRARtMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
625: PETSC_EXTERN PetscErrorCode MatIsLinear(Mat,PetscInt,PetscBool*);

627: PETSC_EXTERN PetscErrorCode MatNorm(Mat,NormType,PetscReal*);
628: PETSC_EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal*);
629: PETSC_EXTERN PetscErrorCode MatZeroEntries(Mat);
630: PETSC_EXTERN PetscErrorCode MatSetInf(Mat);
631: PETSC_EXTERN PetscErrorCode MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
632: PETSC_EXTERN PetscErrorCode MatZeroRowsIS(Mat,IS,PetscScalar,Vec,Vec);
633: PETSC_EXTERN PetscErrorCode MatZeroRowsStencil(Mat,PetscInt,const MatStencil [],PetscScalar,Vec,Vec);
634: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsStencil(Mat,PetscInt,const MatStencil[],PetscScalar,Vec,Vec);
635: PETSC_EXTERN PetscErrorCode MatZeroRowsColumns(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
636: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsIS(Mat,IS,PetscScalar,Vec,Vec);

638: PETSC_EXTERN PetscErrorCode MatGetSize(Mat,PetscInt*,PetscInt*);
639: PETSC_EXTERN PetscErrorCode MatGetLocalSize(Mat,PetscInt*,PetscInt*);
640: PETSC_EXTERN PetscErrorCode MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
641: PETSC_EXTERN PetscErrorCode MatGetOwnershipRanges(Mat,const PetscInt**);
642: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*);
643: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat,const PetscInt**);
644: PETSC_EXTERN PetscErrorCode MatGetOwnershipIS(Mat,IS*,IS*);

646: PETSC_EXTERN PetscErrorCode MatCreateSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
647: 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);}
648: PETSC_EXTERN PetscErrorCode MatCreateSubMatricesMPI(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
649: 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);}
650: PETSC_EXTERN PetscErrorCode MatDestroyMatrices(PetscInt,Mat *[]);
651: PETSC_EXTERN PetscErrorCode MatDestroySubMatrices(PetscInt,Mat *[]);
652: PETSC_EXTERN PetscErrorCode MatCreateSubMatrix(Mat,IS,IS,MatReuse,Mat *);
653: 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);}
654: PETSC_EXTERN PetscErrorCode MatGetLocalSubMatrix(Mat,IS,IS,Mat*);
655: PETSC_EXTERN PetscErrorCode MatRestoreLocalSubMatrix(Mat,IS,IS,Mat*);
656: PETSC_EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat,Mat*);
657: PETSC_EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat*);

659: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJ(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
660: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJSymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
661: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJNumeric(Mat,Mat);
662: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMat(Mat,MatReuse,Mat*);
663: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
664: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatMerge(Mat,MatReuse,IS*,Mat*);
665: PETSC_EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,Mat*);
666: PETSC_EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *,const PetscInt *[]);

668: PETSC_EXTERN PetscErrorCode MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
669: PETSC_EXTERN PetscErrorCode MatIncreaseOverlapSplit(Mat mat,PetscInt n,IS is[],PetscInt ov);
670: PETSC_EXTERN PetscErrorCode MatMPIAIJSetUseScalableIncreaseOverlap(Mat,PetscBool);

672: PETSC_EXTERN PetscErrorCode MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);

674: PETSC_EXTERN PetscErrorCode MatMatMatMult(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);
675: PETSC_EXTERN PetscErrorCode MatGalerkin(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);

677: PETSC_EXTERN PetscErrorCode MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
678: PETSC_EXTERN PetscErrorCode MatRARt(Mat,Mat,MatReuse,PetscReal,Mat*);

680: PETSC_EXTERN PetscErrorCode MatTransposeMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
681: PETSC_EXTERN PetscErrorCode MatMatTransposeMult(Mat,Mat,MatReuse,PetscReal,Mat*);

683: PETSC_EXTERN PetscErrorCode MatAXPY(Mat,PetscScalar,Mat,MatStructure);
684: PETSC_EXTERN PetscErrorCode MatAYPX(Mat,PetscScalar,Mat,MatStructure);

686: PETSC_EXTERN PetscErrorCode MatScale(Mat,PetscScalar);
687: PETSC_EXTERN PetscErrorCode MatShift(Mat,PetscScalar);

689: PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping);
690: PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*);
691: PETSC_EXTERN PetscErrorCode MatGetLayouts(Mat,PetscLayout*,PetscLayout*);
692: PETSC_EXTERN PetscErrorCode MatSetLayouts(Mat,PetscLayout,PetscLayout);
693: PETSC_EXTERN PetscErrorCode MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
694: PETSC_EXTERN PetscErrorCode MatZeroRowsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
695: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
696: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
697: PETSC_EXTERN PetscErrorCode MatGetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
698: PETSC_EXTERN PetscErrorCode MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
699: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);

701: PETSC_EXTERN PetscErrorCode MatStashSetInitialSize(Mat,PetscInt,PetscInt);
702: PETSC_EXTERN PetscErrorCode MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);

704: PETSC_EXTERN PetscErrorCode MatInterpolate(Mat,Vec,Vec);
705: PETSC_EXTERN PetscErrorCode MatInterpolateAdd(Mat,Vec,Vec,Vec);
706: PETSC_EXTERN PetscErrorCode MatRestrict(Mat,Vec,Vec);
707: PETSC_EXTERN PetscErrorCode MatCreateVecs(Mat,Vec*,Vec*);
708: 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);}
709: PETSC_EXTERN PetscErrorCode MatCreateRedundantMatrix(Mat,PetscInt,MPI_Comm,MatReuse,Mat*);
710: PETSC_EXTERN PetscErrorCode MatGetMultiProcBlock(Mat,MPI_Comm,MatReuse,Mat*);
711: PETSC_EXTERN PetscErrorCode MatFindZeroDiagonals(Mat,IS*);
712: PETSC_EXTERN PetscErrorCode MatFindOffBlockDiagonalEntries(Mat,IS*);
713: PETSC_EXTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);

715: /*MC
716:    MatSetValue - Set a single entry into a matrix.

718:    Not collective

720:    Synopsis:
721: #include <petscmat.h>
722:      PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode)

724:    Input Parameters:
725: +  m - the matrix
726: .  row - the row location of the entry
727: .  col - the column location of the entry
728: .  value - the value to insert
729: -  mode - either INSERT_VALUES or ADD_VALUES

731:    Notes:
732:    For efficiency one should use MatSetValues() and set several or many
733:    values simultaneously if possible.

735:    Level: beginner

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

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

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

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

749:    Synopsis:
750: #include <petscmat.h>
751:    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)

753:    Collective

755:    Input Parameters:
756: +  comm - the communicator that will share the eventually allocated matrix
757: .  nrows - the number of LOCAL rows in the matrix
758: -  ncols - the number of LOCAL columns in the matrix

760:    Output Parameters:
761: +  dnz - the array that will be passed to the matrix preallocation routines
762: -  onz - the other array passed to the matrix preallocation routines

764:    Level: intermediate

766:    Notes:
767:     See Users-Manual: ch_performance for more details.

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

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

773: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
774:           MatPreallocateSymmetricSetLocalBlock()
775: M*/
776: #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
777: do { \
778:   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ncols = (ncols),__rstart,__start,__end; \
779:   _4_PetscCalloc2((size_t)__nrows,&dnz,(size_t)__nrows,&onz);CHKERRQ(_4_ierr); \
780:   __start = 0; __end = __start;                                         \
781:   _4_MPI_Scan(&__ncols,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRMPI(_4_ierr); __start = __end - __ncols;\
782:   _4_MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRMPI(_4_ierr); __rstart = __rstart - __nrows; \
783:   do { } while (0)

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

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

793:    Not Collective

795:    Input Parameters:
796: +  map - the row mapping from local numbering to global numbering
797: .  nrows - the number of rows indicated
798: .  rows - the indices of the rows
799: .  cmap - the column mapping from local to global numbering
800: .  ncols - the number of columns in the matrix
801: .  cols - the columns indicated
802: .  dnz - the array that will be passed to the matrix preallocation routines
803: -  onz - the other array passed to the matrix preallocation routines

805:    Level: intermediate

807:    Notes:
808:     See Users-Manual: ch_performance for more details.

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

812: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
813:           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocalRemoveDups()
814: M*/
815: #define MatPreallocateSetLocal(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
816: do {\
817:   PetscInt __l;\
818:   _4_ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
819:   _4_ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
820:   for (__l=0;__l<nrows;__l++) {\
821:     _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
822:   }\
823:  } while (0)

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

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

833:    Not Collective

835:    Input Parameters:
836: +  map - the row mapping from local numbering to global numbering
837: .  nrows - the number of rows indicated
838: .  rows - the indices of the rows (these values are mapped to the global values)
839: .  cmap - the column mapping from local to global numbering
840: .  ncols - the number of columns in the matrix   (this value will be changed if duplicate columns are found)
841: .  cols - the columns indicated (these values are mapped to the global values, they are then sorted and duplicates removed)
842: .  dnz - the array that will be passed to the matrix preallocation routines
843: -  onz - the other array passed to the matrix preallocation routines

845:    Level: intermediate

847:    Notes:
848:     See Users-Manual: ch_performance for more details.

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

852: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
853:           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal()
854: M*/
855: #define MatPreallocateSetLocalRemoveDups(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
856: do {\
857:   PetscInt __l;\
858:   _4_ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
859:   _4_ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
860:   _4_PetscSortRemoveDupsInt(&ncols,cols);CHKERRQ(_4_ierr);\
861:   for (__l=0;__l<nrows;__l++) {\
862:     _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
863:   }\
864:  } while (0)

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

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

874:    Not Collective

876:    Input Parameters:
877: +  map - the row mapping from local numbering to global numbering
878: .  nrows - the number of rows indicated
879: .  rows - the indices of the rows
880: .  cmap - the column mapping from local to global numbering
881: .  ncols - the number of columns in the matrix
882: .  cols - the columns indicated
883: .  dnz - the array that will be passed to the matrix preallocation routines
884: -  onz - the other array passed to the matrix preallocation routines

886:    Level: intermediate

888:    Notes:
889:     See Users-Manual: ch_performance for more details.

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

893: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
894:           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock()
895: M*/
896: #define MatPreallocateSetLocalBlock(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
897: do {\
898:   PetscInt __l;\
899:   _4_ISLocalToGlobalMappingApplyBlock(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
900:   _4_ISLocalToGlobalMappingApplyBlock(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
901:   for (__l=0;__l<nrows;__l++) {\
902:     _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
903:   }\
904: } while (0)

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

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

914:    Not Collective

916:    Input Parameters:
917: +  map - the mapping between local numbering and global numbering
918: .  nrows - the number of rows indicated
919: .  rows - the indices of the rows
920: .  ncols - the number of columns in the matrix
921: .  cols - the columns indicated
922: .  dnz - the array that will be passed to the matrix preallocation routines
923: -  onz - the other array passed to the matrix preallocation routines

925:    Level: intermediate

927:    Notes:
928:     See Users-Manual: ch_performance for more details.

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

932: .seealso: MatPreallocateFinalize(), MatPreallocateSet()
933:           MatPreallocateInitialize(),  MatPreallocateSetLocal()
934: M*/
935: #define MatPreallocateSymmetricSetLocalBlock(map,nrows,rows,ncols,cols,dnz,onz) 0;\
936: do {\
937:   PetscInt __l;\
938:   _4_ISLocalToGlobalMappingApplyBlock(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
939:   _4_ISLocalToGlobalMappingApplyBlock(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
940:   for (__l=0;__l<nrows;__l++) {\
941:     _4_MatPreallocateSymmetricSetBlock((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
942:   }\
943: } while (0)

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

949:    Synopsis:
950: #include <petscmat.h>
951:    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

953:    Not Collective

955:    Input Parameters:
956: +  row - the row
957: .  ncols - the number of columns in the matrix
958: -  cols - the columns indicated

960:    Output Parameters:
961: +  dnz - the array that will be passed to the matrix preallocation routines
962: -  onz - the other array passed to the matrix preallocation routines

964:    Level: intermediate

966:    Notes:
967:     See Users-Manual: ch_performance for more details.

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

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

973: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
974:           MatPreallocateInitialize(), MatPreallocateSetLocal()
975: M*/
976: #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
977: do { PetscInt __i; \
978:   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);\
979:   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);\
980:   for (__i=0; __i<nc; __i++) {\
981:     if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
982:     else if (dnz[row - __rstart] < __ncols) dnz[row - __rstart]++;\
983:   }\
984: } while (0)

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

990:    Synopsis:
991: #include <petscmat.h>
992:    PetscErrorCode MatPreallocateSymmetricSetBlock(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

994:    Not Collective

996:    Input Parameters:
997: +  nrows - the number of rows indicated
998: .  rows - the indices of the rows
999: .  ncols - the number of columns in the matrix
1000: .  cols - the columns indicated
1001: .  dnz - the array that will 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: ch_performance 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 uses variables declared in MatPreallocateInitialize().

1013: .seealso: MatPreallocateFinalize(), MatPreallocateSet(),  MatPreallocateInitialize(),
1014:           MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal()
1015: M*/
1016: #define MatPreallocateSymmetricSetBlock(row,nc,cols,dnz,onz) 0;\
1017: do { PetscInt __i; \
1018:   for (__i=0; __i<nc; __i++) {\
1019:     if (cols[__i] >= __end) onz[row - __rstart]++; \
1020:     else if (cols[__i] >= row && dnz[row - __rstart] < __ncols) dnz[row - __rstart]++;\
1021:   }\
1022: } while (0)

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

1027:    Synopsis:
1028: #include <petscmat.h>
1029:    PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)

1031:    Not Collective

1033:    Input Parameters:
1034: +  A - matrix
1035: .  row - row where values exist (must be local to this process)
1036: .  ncols - number of columns
1037: .  cols - columns with nonzeros
1038: .  dnz - the array that will be passed to the matrix preallocation routines
1039: -  onz - the other array passed to the matrix preallocation routines

1041:    Level: intermediate

1043:    Notes:
1044:     See Users-Manual: ch_performance for more details.

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

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

1050: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
1051:           MatPreallocateSymmetricSetLocalBlock()
1052: M*/
1053: #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)


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

1060:    Synopsis:
1061: #include <petscmat.h>
1062:    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)

1064:    Collective

1066:    Input Parameters:
1067: +  dnz - the array that was be passed to the matrix preallocation routines
1068: -  onz - the other array passed to the matrix preallocation routines

1070:    Level: intermediate

1072:    Notes:
1073:     See Users-Manual: ch_performance for more details.

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

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

1079: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
1080:           MatPreallocateSymmetricSetLocalBlock()
1081: M*/
1082: #define MatPreallocateFinalize(dnz,onz) 0;_4_PetscFree2(dnz,onz);CHKERRQ(_4_ierr);} while (0)

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

1087: PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*);
1088: PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);

1090: PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
1091: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
1092: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1093: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1094: PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
1095: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*,PetscInt,PetscBool);

1097: #define MAT_SKIP_ALLOCATION -4

1099: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1100: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
1101: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);
1102: PETSC_EXTERN PetscErrorCode MatSeqAIJSetTotalPreallocation(Mat,PetscInt);

1104: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1105: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1106: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1107: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
1108: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1109: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
1110: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
1111: PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
1112: PETSC_EXTERN PetscErrorCode MatMPIAdjToSeq(Mat,Mat*);
1113: PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
1114: PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
1115: PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
1116: PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
1117: PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat,Mat*);

1119: PETSC_EXTERN PetscErrorCode MatDenseGetLDA(Mat,PetscInt*);
1120: PETSC_EXTERN PetscErrorCode MatDenseSetLDA(Mat,PetscInt);
1121: PETSC_DEPRECATED_FUNCTION("Use MatDenseSetLDA() (since version 3.14)") PETSC_STATIC_INLINE PetscErrorCode MatSeqDenseSetLDA(Mat A,PetscInt lda) {return MatDenseSetLDA(A,lda);}
1122: PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*);

1124: PETSC_EXTERN PetscErrorCode MatBlockMatSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);

1126: PETSC_EXTERN PetscErrorCode MatStoreValues(Mat);
1127: PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat);

1129: PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat,IS*);
1130: PETSC_EXTERN PetscErrorCode MatFindZeroRows(Mat,IS*);
1131: /*
1132:   These routines are not usually accessed directly, rather solving is
1133:   done through the KSP and PC interfaces.
1134: */

1136: /*J
1137:     MatOrderingType - String with the name of a PETSc matrix ordering

1139:    Level: beginner

1141:    Notes:
1142:       If MATORDERINGEXTERNAL is used then PETSc does not compute an ordering and utilizes one built into the factorization package

1144: .seealso: MatGetOrdering()
1145: J*/
1146: typedef const char* MatOrderingType;
1147: #define MATORDERINGNATURAL        "natural"
1148: #define MATORDERINGND             "nd"
1149: #define MATORDERING1WD            "1wd"
1150: #define MATORDERINGRCM            "rcm"
1151: #define MATORDERINGQMD            "qmd"
1152: #define MATORDERINGROWLENGTH      "rowlength"
1153: #define MATORDERINGWBM            "wbm"
1154: #define MATORDERINGSPECTRAL       "spectral"
1155: #define MATORDERINGAMD            "amd"            /* only works if UMFPACK is installed with PETSc */
1156: #define MATORDERINGNATURAL_OR_ND  "natural_or_nd"  /* special coase used for Cholesky and ICC, allows ND when AIJ matrix is used but Natural when SBAIJ is used */
1157: #define MATORDERINGEXTERNAL       "external"       /* uses an ordering type internal to the factorization package */

1159: PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat,MatOrderingType,IS*,IS*);
1160: PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFunctionList*);
1161: PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[],PetscErrorCode(*)(Mat,MatOrderingType,IS*,IS*));
1162: PETSC_EXTERN PetscFunctionList MatOrderingList;

1164: PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
1165: PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat,PetscReal,PetscBool,Mat*);

1167: /*S
1168:     MatFactorShiftType - Numeric Shift for factorizations

1170:    Level: beginner

1172: .seealso: MatGetFactor()
1173: S*/
1174: typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType;
1175: PETSC_EXTERN const char *const MatFactorShiftTypes[];
1176: PETSC_EXTERN const char *const MatFactorShiftTypesDetail[];

1178: /*S
1179:     MatFactorError - indicates what type of error was generated in a matrix factorization

1181:     Level: beginner

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

1186: .seealso: MatGetFactor()
1187: S*/
1188: typedef enum {MAT_FACTOR_NOERROR,MAT_FACTOR_STRUCT_ZEROPIVOT,MAT_FACTOR_NUMERIC_ZEROPIVOT,MAT_FACTOR_OUTMEMORY,MAT_FACTOR_OTHER} MatFactorError;

1190: PETSC_EXTERN PetscErrorCode MatFactorGetError(Mat,MatFactorError*);
1191: PETSC_EXTERN PetscErrorCode MatFactorClearError(Mat);
1192: PETSC_EXTERN PetscErrorCode MatFactorGetErrorZeroPivot(Mat,PetscReal*,PetscInt*);

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

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

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

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

1205:    Level: developer

1207: .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
1208:           MatFactorInfoInitialize()

1210: S*/
1211: typedef struct {
1212:   PetscReal     diagonal_fill;  /* force diagonal to fill in if initially not filled */
1213:   PetscReal     usedt;
1214:   PetscReal     dt;             /* drop tolerance */
1215:   PetscReal     dtcol;          /* tolerance for pivoting */
1216:   PetscReal     dtcount;        /* maximum nonzeros to be allowed per row */
1217:   PetscReal     fill;           /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
1218:   PetscReal     levels;         /* ICC/ILU(levels) */
1219:   PetscReal     pivotinblocks;  /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
1220:                                    factorization may be faster if do not pivot */
1221:   PetscReal     zeropivot;      /* pivot is called zero if less than this */
1222:   PetscReal     shifttype;      /* type of shift added to matrix factor to prevent zero pivots */
1223:   PetscReal     shiftamount;     /* how large the shift is */
1224: } MatFactorInfo;

1226: PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*);
1227: PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*);
1228: PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1229: PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*);
1230: PETSC_EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*);
1231: PETSC_EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*);
1232: PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1233: PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
1234: PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
1235: PETSC_EXTERN PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*);
1236: PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*);
1237: PETSC_EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
1238: PETSC_EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec);
1239: PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec);
1240: PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec);
1241: PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec);
1242: PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec);
1243: PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
1244: PETSC_EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs);
1245: PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat);

1247: typedef enum {MAT_FACTOR_SCHUR_UNFACTORED, MAT_FACTOR_SCHUR_FACTORED, MAT_FACTOR_SCHUR_INVERTED} MatFactorSchurStatus;
1248: PETSC_EXTERN PetscErrorCode MatFactorSetSchurIS(Mat,IS);
1249: PETSC_EXTERN PetscErrorCode MatFactorGetSchurComplement(Mat,Mat*,MatFactorSchurStatus*);
1250: PETSC_EXTERN PetscErrorCode MatFactorRestoreSchurComplement(Mat,Mat*,MatFactorSchurStatus);
1251: PETSC_EXTERN PetscErrorCode MatFactorInvertSchurComplement(Mat);
1252: PETSC_EXTERN PetscErrorCode MatFactorCreateSchurComplement(Mat,Mat*,MatFactorSchurStatus*);
1253: PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplement(Mat,Vec,Vec);
1254: PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplementTranspose(Mat,Vec,Vec);
1255: PETSC_EXTERN PetscErrorCode MatFactorFactorizeSchurComplement(Mat);

1257: /*E
1258:     MatSORType - What type of (S)SOR to perform

1260:     Level: beginner

1262:    May be bitwise ORd together

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

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

1268: .seealso: MatSOR()
1269: E*/
1270: typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
1271:               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
1272:               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
1273:               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
1274: PETSC_EXTERN PetscErrorCode MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);

1276: /*
1277:     These routines are for efficiently computing Jacobians via finite differences.
1278: */

1280: /*S
1281:      MatColoring - Object for managing the coloring of matrices.

1283:    Level: beginner

1285:     Notes:
1286:        Coloring of matrices can be computed directly from the sparse matrix nonzero structure via the MatColoring object or from the mesh from which the
1287:        matrix comes from via DMCreateColoring(). In general using the mesh produces a more optimal coloring (fewer colors).

1289:        Once a coloring is available MatFDColoringCreate() creates an object that can be used to efficiently compute Jacobians using that coloring. This
1290:        same object can also be used to efficiently convert data created by Automatic Differentation tools to PETSc sparse matrices.

1292: .seealso:  MatFDColoringCreate(), MatColoringWeightType, ISColoring, MatFDColoring, DMCreateColoring(), MatColoringCreate(), MatOrdering, MatPartitioning
1293: S*/
1294: typedef struct _p_MatColoring* MatColoring;

1296: /*J
1297:     MatColoringType - String with the name of a PETSc matrix coloring

1299:    Level: beginner

1301: .seealso: MatColoringSetType(), MatColoring
1302: J*/
1303: typedef const  char*           MatColoringType;
1304: #define MATCOLORINGJP      "jp"
1305: #define MATCOLORINGPOWER   "power"
1306: #define MATCOLORINGNATURAL "natural"
1307: #define MATCOLORINGSL      "sl"
1308: #define MATCOLORINGLF      "lf"
1309: #define MATCOLORINGID      "id"
1310: #define MATCOLORINGGREEDY  "greedy"

1312: /*E
1313:    MatColoringWeightType - Type of weight scheme

1315:     Not Collective

1317: +   MAT_COLORING_RANDOM  - Random weights
1318: .   MAT_COLORING_LEXICAL - Lexical weighting based upon global numbering.
1319: -   MAT_COLORING_LF      - Last-first weighting.

1321:     Level: intermediate

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

1325: .seealso: MatColoring, MatColoringCreate()
1326: E*/
1327: typedef enum {MAT_COLORING_WEIGHT_RANDOM,MAT_COLORING_WEIGHT_LEXICAL,MAT_COLORING_WEIGHT_LF,MAT_COLORING_WEIGHT_SL} MatColoringWeightType;

1329: PETSC_EXTERN PetscErrorCode MatColoringCreate(Mat,MatColoring*);
1330: PETSC_EXTERN PetscErrorCode MatColoringGetDegrees(Mat,PetscInt,PetscInt*);
1331: PETSC_EXTERN PetscErrorCode MatColoringDestroy(MatColoring*);
1332: PETSC_EXTERN PetscErrorCode MatColoringView(MatColoring,PetscViewer);
1333: PETSC_EXTERN PetscErrorCode MatColoringSetType(MatColoring,MatColoringType);
1334: PETSC_EXTERN PetscErrorCode MatColoringSetFromOptions(MatColoring);
1335: PETSC_EXTERN PetscErrorCode MatColoringSetDistance(MatColoring,PetscInt);
1336: PETSC_EXTERN PetscErrorCode MatColoringGetDistance(MatColoring,PetscInt*);
1337: PETSC_EXTERN PetscErrorCode MatColoringSetMaxColors(MatColoring,PetscInt);
1338: PETSC_EXTERN PetscErrorCode MatColoringGetMaxColors(MatColoring,PetscInt*);
1339: PETSC_EXTERN PetscErrorCode MatColoringApply(MatColoring,ISColoring*);
1340: PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[],PetscErrorCode(*)(MatColoring));
1341: PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
1342: PETSC_EXTERN PetscErrorCode MatColoringSetWeightType(MatColoring,MatColoringWeightType);
1343: PETSC_EXTERN PetscErrorCode MatColoringSetWeights(MatColoring,PetscReal*,PetscInt*);
1344: PETSC_EXTERN PetscErrorCode MatColoringCreateWeights(MatColoring,PetscReal **,PetscInt **lperm);
1345: PETSC_EXTERN PetscErrorCode MatColoringTest(MatColoring,ISColoring);
1346: PETSC_DEPRECATED_FUNCTION("Use MatColoringTest() (since version 3.10)") PETSC_STATIC_INLINE PetscErrorCode MatColoringTestValid(MatColoring matcoloring,ISColoring iscoloring) {return MatColoringTest(matcoloring,iscoloring);}
1347: PETSC_EXTERN PetscErrorCode MatISColoringTest(Mat,ISColoring);

1349: /*S
1350:      MatFDColoring - Object for computing a sparse Jacobian via finite differences
1351:         and coloring

1353:    Level: beginner

1355:    Notes:
1356:       This object is creating utilizing a coloring provided by the MatColoring object or DMCreateColoring()

1358: .seealso:  MatFDColoringCreate(), MatColoring, DMCreateColoring()
1359: S*/
1360: typedef struct _p_MatFDColoring* MatFDColoring;

1362: PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
1363: PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring*);
1364: PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer);
1365: PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
1366: PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
1367: PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
1368: PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring);
1369: PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,void *);
1370: PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec);
1371: PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,const PetscInt*[]);
1372: PETSC_EXTERN PetscErrorCode MatFDColoringSetUp(Mat,ISColoring,MatFDColoring);
1373: PETSC_EXTERN PetscErrorCode MatFDColoringSetBlockSize(MatFDColoring,PetscInt,PetscInt);
1374: PETSC_EXTERN PetscErrorCode MatFDColoringSetValues(Mat,MatFDColoring,const PetscScalar*);

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

1379:    Level: beginner

1381: .seealso:  MatTransposeColoringCreate()
1382: S*/
1383: typedef struct _p_MatTransposeColoring* MatTransposeColoring;

1385: PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat,ISColoring,MatTransposeColoring *);
1386: PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring,Mat,Mat);
1387: PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring,Mat,Mat);
1388: PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring*);

1390: /*
1391:     These routines are for partitioning matrices: currently used only
1392:   for adjacency matrix, MatCreateMPIAdj().
1393: */

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

1398:    Level: beginner

1400:    Notes:
1401:      There is also a PetscPartitioner object that provides the same functionality. It can utilize the MatPartitioning operations
1402:      via PetscPartitionerSetType(p,PETSCPARTITIONERMATPARTITIONING)

1404:    Developers Note:
1405:      It is an extra maintainance and documentation cost to have two objects with the same functionality.

1407: .seealso:  MatPartitioningCreate(), MatPartitioningType, MatColoring, MatGetOrdering()
1408: S*/
1409: typedef struct _p_MatPartitioning* MatPartitioning;

1411: /*J
1412:     MatPartitioningType - String with the name of a PETSc matrix partitioning

1414:    Level: beginner
1415: dm
1416: .seealso: MatPartitioningCreate(), MatPartitioning
1417: J*/
1418: typedef const char* MatPartitioningType;
1419: #define MATPARTITIONINGCURRENT  "current"
1420: #define MATPARTITIONINGAVERAGE   "average"
1421: #define MATPARTITIONINGSQUARE   "square"
1422: #define MATPARTITIONINGPARMETIS "parmetis"
1423: #define MATPARTITIONINGCHACO    "chaco"
1424: #define MATPARTITIONINGPARTY    "party"
1425: #define MATPARTITIONINGPTSCOTCH "ptscotch"
1426: #define MATPARTITIONINGHIERARCH  "hierarch"

1428: PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*);
1429: PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,MatPartitioningType);
1430: PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt);
1431: PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat);
1432: PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
1433: PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
1434: PETSC_EXTERN PetscErrorCode MatPartitioningSetUseEdgeWeights(MatPartitioning,PetscBool);
1435: PETSC_EXTERN PetscErrorCode MatPartitioningGetUseEdgeWeights(MatPartitioning,PetscBool*);
1436: PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*);
1437: PETSC_EXTERN PetscErrorCode MatPartitioningImprove(MatPartitioning,IS*);
1438: PETSC_EXTERN PetscErrorCode MatPartitioningViewImbalance(MatPartitioning,IS);
1439: PETSC_EXTERN PetscErrorCode MatPartitioningApplyND(MatPartitioning,IS*);
1440: PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning*);
1441: PETSC_EXTERN PetscErrorCode MatPartitioningRegister(const char[],PetscErrorCode (*)(MatPartitioning));
1442: PETSC_EXTERN PetscErrorCode MatPartitioningView(MatPartitioning,PetscViewer);
1443: PETSC_EXTERN PetscErrorCode MatPartitioningViewFromOptions(MatPartitioning,PetscObject,const char[]);
1444: PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning);
1445: PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,MatPartitioningType*);

1447: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetRepartition(MatPartitioning part);
1448: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
1449: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);

1451: typedef enum { MP_CHACO_MULTILEVEL=1,MP_CHACO_SPECTRAL=2,MP_CHACO_LINEAR=4,MP_CHACO_RANDOM=5,MP_CHACO_SCATTERED=6 } MPChacoGlobalType;
1452: PETSC_EXTERN const char *const MPChacoGlobalTypes[];
1453: typedef enum { MP_CHACO_KERNIGHAN=1,MP_CHACO_NONE=2 } MPChacoLocalType;
1454: PETSC_EXTERN const char *const MPChacoLocalTypes[];
1455: typedef enum { MP_CHACO_LANCZOS=0,MP_CHACO_RQI=1 } MPChacoEigenType;
1456: PETSC_EXTERN const char *const MPChacoEigenTypes[];

1458: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning,MPChacoGlobalType);
1459: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning,MPChacoGlobalType*);
1460: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning,MPChacoLocalType);
1461: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning,MPChacoLocalType*);
1462: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
1463: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
1464: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning,MPChacoEigenType*);
1465: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning,PetscReal);
1466: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning,PetscReal*);
1467: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning,PetscInt);
1468: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning,PetscInt*);

1470: #define MP_PARTY_OPT "opt"
1471: #define MP_PARTY_LIN "lin"
1472: #define MP_PARTY_SCA "sca"
1473: #define MP_PARTY_RAN "ran"
1474: #define MP_PARTY_GBF "gbf"
1475: #define MP_PARTY_GCF "gcf"
1476: #define MP_PARTY_BUB "bub"
1477: #define MP_PARTY_DEF "def"
1478: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning,const char*);
1479: #define MP_PARTY_HELPFUL_SETS "hs"
1480: #define MP_PARTY_KERNIGHAN_LIN "kl"
1481: #define MP_PARTY_NONE "no"
1482: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning,const char*);
1483: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
1484: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscBool);
1485: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool);

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

1490: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal);
1491: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*);
1492: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType);
1493: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*);

1495: /*
1496:  * hierarchical partitioning
1497:  */
1498: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetFineparts(MatPartitioning,IS*);
1499: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetCoarseparts(MatPartitioning,IS*);
1500: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNcoarseparts(MatPartitioning,PetscInt);
1501: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNfineparts(MatPartitioning, PetscInt);

1503: PETSC_EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*);
1504: PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*);

1506: /*
1507:     If you add entries here you must also add them to include/petscmat.h
1508:     and src/mat/f90-mod/petscmat.h
1509: */
1510: typedef enum { MATOP_SET_VALUES=0,
1511:                MATOP_GET_ROW=1,
1512:                MATOP_RESTORE_ROW=2,
1513:                MATOP_MULT=3,
1514:                MATOP_MULT_ADD=4,
1515:                MATOP_MULT_TRANSPOSE=5,
1516:                MATOP_MULT_TRANSPOSE_ADD=6,
1517:                MATOP_SOLVE=7,
1518:                MATOP_SOLVE_ADD=8,
1519:                MATOP_SOLVE_TRANSPOSE=9,
1520:                MATOP_SOLVE_TRANSPOSE_ADD=10,
1521:                MATOP_LUFACTOR=11,
1522:                MATOP_CHOLESKYFACTOR=12,
1523:                MATOP_SOR=13,
1524:                MATOP_TRANSPOSE=14,
1525:                MATOP_GETINFO=15,
1526:                MATOP_EQUAL=16,
1527:                MATOP_GET_DIAGONAL=17,
1528:                MATOP_DIAGONAL_SCALE=18,
1529:                MATOP_NORM=19,
1530:                MATOP_ASSEMBLY_BEGIN=20,
1531:                MATOP_ASSEMBLY_END=21,
1532:                MATOP_SET_OPTION=22,
1533:                MATOP_ZERO_ENTRIES=23,
1534:                MATOP_ZERO_ROWS=24,
1535:                MATOP_LUFACTOR_SYMBOLIC=25,
1536:                MATOP_LUFACTOR_NUMERIC=26,
1537:                MATOP_CHOLESKY_FACTOR_SYMBOLIC=27,
1538:                MATOP_CHOLESKY_FACTOR_NUMERIC=28,
1539:                MATOP_SETUP_PREALLOCATION=29,
1540:                MATOP_ILUFACTOR_SYMBOLIC=30,
1541:                MATOP_ICCFACTOR_SYMBOLIC=31,
1542:                MATOP_GET_DIAGONAL_BLOCK=32,
1543:                MATOP_FREE_INTER_STRUCT=33,
1544:                MATOP_DUPLICATE=34,
1545:                MATOP_FORWARD_SOLVE=35,
1546:                MATOP_BACKWARD_SOLVE=36,
1547:                MATOP_ILUFACTOR=37,
1548:                MATOP_ICCFACTOR=38,
1549:                MATOP_AXPY=39,
1550:                MATOP_CREATE_SUBMATRICES=40,
1551:                MATOP_INCREASE_OVERLAP=41,
1552:                MATOP_GET_VALUES=42,
1553:                MATOP_COPY=43,
1554:                MATOP_GET_ROW_MAX=44,
1555:                MATOP_SCALE=45,
1556:                MATOP_SHIFT=46,
1557:                MATOP_DIAGONAL_SET=47,
1558:                MATOP_ZERO_ROWS_COLUMNS=48,
1559:                MATOP_SET_RANDOM=49,
1560:                MATOP_GET_ROW_IJ=50,
1561:                MATOP_RESTORE_ROW_IJ=51,
1562:                MATOP_GET_COLUMN_IJ=52,
1563:                MATOP_RESTORE_COLUMN_IJ=53,
1564:                MATOP_FDCOLORING_CREATE=54,
1565:                MATOP_COLORING_PATCH=55,
1566:                MATOP_SET_UNFACTORED=56,
1567:                MATOP_PERMUTE=57,
1568:                MATOP_SET_VALUES_BLOCKED=58,
1569:                MATOP_CREATE_SUBMATRIX=59,
1570:                MATOP_DESTROY=60,
1571:                MATOP_VIEW=61,
1572:                MATOP_CONVERT_FROM=62,
1573:                MATOP_MATMAT_MULT=63,
1574:                MATOP_MATMAT_MULT_SYMBOLIC=64,
1575:                MATOP_MATMAT_MULT_NUMERIC=65,
1576:                MATOP_SET_LOCAL_TO_GLOBAL_MAP=66,
1577:                MATOP_SET_VALUES_LOCAL=67,
1578:                MATOP_ZERO_ROWS_LOCAL=68,
1579:                MATOP_GET_ROW_MAX_ABS=69,
1580:                MATOP_GET_ROW_MIN_ABS=70,
1581:                MATOP_CONVERT=71,
1582:                MATOP_SET_COLORING=72,
1583:                /* MATOP_PLACEHOLDER_73=73, */
1584:                MATOP_SET_VALUES_ADIFOR=74,
1585:                MATOP_FD_COLORING_APPLY=75,
1586:                MATOP_SET_FROM_OPTIONS=76,
1587:                MATOP_MULT_CONSTRAINED=77,
1588:                MATOP_MULT_TRANSPOSE_CONSTRAIN=78,
1589:                MATOP_FIND_ZERO_DIAGONALS=79,
1590:                MATOP_MULT_MULTIPLE=80,
1591:                MATOP_SOLVE_MULTIPLE=81,
1592:                MATOP_GET_INERTIA=82,
1593:                MATOP_LOAD=83,
1594:                MATOP_IS_SYMMETRIC=84,
1595:                MATOP_IS_HERMITIAN=85,
1596:                MATOP_IS_STRUCTURALLY_SYMMETRIC=86,
1597:                MATOP_SET_VALUES_BLOCKEDLOCAL=87,
1598:                MATOP_CREATE_VECS=88,
1599:                MATOP_MAT_MULT=89,
1600:                MATOP_MAT_MULT_SYMBOLIC=90,
1601:                MATOP_MAT_MULT_NUMERIC=91,
1602:                MATOP_PTAP=92,
1603:                MATOP_PTAP_SYMBOLIC=93,
1604:                MATOP_PTAP_NUMERIC=94,
1605:                MATOP_MAT_TRANSPOSE_MULT=95,
1606:                MATOP_MAT_TRANSPOSE_MULT_SYMBO=96,
1607:                MATOP_MAT_TRANSPOSE_MULT_NUMER=97,
1608:                /* MATOP_PLACEHOLDER_98=98, */
1609:                MATOP_PRODUCTSETFROMOPTIONS=99,
1610:                MATOP_PRODUCTSYMBOLIC=100,
1611:                MATOP_PRODUCTNUMERIC=101,
1612:                MATOP_CONJUGATE=102,
1613:                /* MATOP_PLACEHOLDER_103=103, */
1614:                MATOP_SET_VALUES_ROW=104,
1615:                MATOP_REAL_PART=105,
1616:                MATOP_IMAGINARY_PART=106,
1617:                MATOP_GET_ROW_UPPER_TRIANGULAR=107,
1618:                MATOP_RESTORE_ROW_UPPER_TRIANG=108,
1619:                MATOP_MAT_SOLVE=109,
1620:                MATOP_MAT_SOLVE_TRANSPOSE=110,
1621:                MATOP_GET_ROW_MIN=111,
1622:                MATOP_GET_COLUMN_VECTOR=112,
1623:                MATOP_MISSING_DIAGONAL=113,
1624:                MATOP_GET_SEQ_NONZERO_STRUCTUR=114,
1625:                MATOP_CREATE=115,
1626:                MATOP_GET_GHOSTS=116,
1627:                MATOP_GET_LOCAL_SUB_MATRIX=117,
1628:                MATOP_RESTORE_LOCALSUB_MATRIX=118,
1629:                MATOP_MULT_DIAGONAL_BLOCK=119,
1630:                MATOP_HERMITIAN_TRANSPOSE=120,
1631:                MATOP_MULT_HERMITIAN_TRANSPOSE=121,
1632:                MATOP_MULT_HERMITIAN_TRANS_ADD=122,
1633:                MATOP_GET_MULTI_PROC_BLOCK=123,
1634:                MATOP_FIND_NONZERO_ROWS=124,
1635:                MATOP_GET_COLUMN_NORMS=125,
1636:                MATOP_INVERT_BLOCK_DIAGONAL=126,
1637:                /* MATOP_PLACEHOLDER_127=127, */
1638:                MATOP_CREATE_SUB_MATRICES_MPI=128,
1639:                MATOP_SET_VALUES_BATCH=129,
1640:                MATOP_TRANSPOSE_MAT_MULT=130,
1641:                MATOP_TRANSPOSE_MAT_MULT_SYMBO=131,
1642:                MATOP_TRANSPOSE_MAT_MULT_NUMER=132,
1643:                MATOP_TRANSPOSE_COLORING_CREAT=133,
1644:                MATOP_TRANS_COLORING_APPLY_SPT=134,
1645:                MATOP_TRANS_COLORING_APPLY_DEN=135,
1646:                MATOP_RART=136,
1647:                MATOP_RART_SYMBOLIC=137,
1648:                MATOP_RART_NUMERIC=138,
1649:                MATOP_SET_BLOCK_SIZES=139,
1650:                MATOP_AYPX=140,
1651:                MATOP_RESIDUAL=141,
1652:                MATOP_FDCOLORING_SETUP=142,
1653:                MATOP_MPICONCATENATESEQ=144,
1654:                MATOP_DESTROYSUBMATRICES=145,
1655:                MATOP_TRANSPOSE_SOLVE=146,
1656:                MATOP_GET_VALUES_LOCAL=147
1657:              } MatOperation;
1658: PETSC_EXTERN PetscErrorCode MatSetOperation(Mat,MatOperation,void(*)(void));
1659: PETSC_EXTERN PetscErrorCode MatGetOperation(Mat,MatOperation,void(**)(void));
1660: PETSC_EXTERN PetscErrorCode MatHasOperation(Mat,MatOperation,PetscBool*);
1661: PETSC_EXTERN PetscErrorCode MatHasCongruentLayouts(Mat,PetscBool*);
1662: PETSC_DEPRECATED_FUNCTION("Use MatProductClear() (since version 3.14)") PETSC_STATIC_INLINE PetscErrorCode MatFreeIntermediateDataStructures(Mat A) {return MatProductClear(A);}
1663: PETSC_EXTERN PetscErrorCode MatShellSetOperation(Mat,MatOperation,void(*)(void));
1664: PETSC_EXTERN PetscErrorCode MatShellGetOperation(Mat,MatOperation,void(**)(void));
1665: PETSC_EXTERN PetscErrorCode MatShellSetContext(Mat,void*);
1666: PETSC_EXTERN PetscErrorCode MatShellSetVecType(Mat,VecType);
1667: PETSC_EXTERN PetscErrorCode MatShellTestMult(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*);
1668: PETSC_EXTERN PetscErrorCode MatShellTestMultTranspose(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*);
1669: PETSC_EXTERN PetscErrorCode MatShellSetManageScalingShifts(Mat);
1670: PETSC_EXTERN PetscErrorCode MatShellSetMatProductOperation(Mat,MatProductType,PetscErrorCode (*)(Mat,Mat,Mat,void**),PetscErrorCode (*)(Mat,Mat,Mat,void*),PetscErrorCode (*)(void*),MatType,MatType);
1671: PETSC_EXTERN PetscErrorCode MatIsShell(Mat,PetscBool*);

1673: /*
1674:    Codes for matrices stored on disk. By default they are
1675:    stored in a universal format. By changing the format with
1676:    PetscViewerPushFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
1677:    be stored in a way natural for the matrix, for example dense matrices
1678:    would be stored as dense. Matrices stored this way may only be
1679:    read into matrices of the same type.
1680: */
1681: #define MATRIX_BINARY_FORMAT_DENSE -1

1683: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal);

1685: PETSC_EXTERN PetscErrorCode MatISSetLocalMatType(Mat,MatType);
1686: PETSC_EXTERN PetscErrorCode MatISSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
1687: PETSC_EXTERN PetscErrorCode MatISStoreL2L(Mat,PetscBool);
1688: PETSC_EXTERN PetscErrorCode MatISFixLocalEmpty(Mat,PetscBool);
1689: PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*);
1690: PETSC_EXTERN PetscErrorCode MatISRestoreLocalMat(Mat,Mat*);
1691: PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat,Mat);
1692: PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use the MatConvert() interface (since version 3.10)") PetscErrorCode MatISGetMPIXAIJ(Mat,MatReuse,Mat*);

1694: /*S
1695:      MatNullSpace - Object that removes a null space from a vector, i.e.
1696:          orthogonalizes the vector to a subsapce

1698:    Level: advanced

1700:   Users manual sections:
1701: .   sec_singular

1703: .seealso:  MatNullSpaceCreate()
1704: S*/
1705: typedef struct _p_MatNullSpace* MatNullSpace;

1707: PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*);
1708: PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*);
1709: PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace*);
1710: PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec);
1711: PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *);
1712: PETSC_EXTERN PetscErrorCode MatGetTransposeNullSpace(Mat, MatNullSpace *);
1713: PETSC_EXTERN PetscErrorCode MatSetTransposeNullSpace(Mat,MatNullSpace);
1714: PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat,MatNullSpace);
1715: PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat,MatNullSpace);
1716: PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat,MatNullSpace*);
1717: PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscBool  *);
1718: PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace,PetscViewer);
1719: PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace,PetscBool*,PetscInt*,const Vec**);
1720: PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec,MatNullSpace*);

1722: PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS);
1723: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
1724: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);

1726: PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*);
1727: PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*);
1728: PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*);

1730: PETSC_EXTERN PetscErrorCode MatComputeOperator(Mat,MatType,Mat*);
1731: PETSC_EXTERN PetscErrorCode MatComputeOperatorTranspose(Mat,MatType,Mat*);

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

1736: PETSC_EXTERN PetscErrorCode MatCreateKAIJ(Mat,PetscInt,PetscInt,const PetscScalar[],const PetscScalar[],Mat*);
1737: PETSC_EXTERN PetscErrorCode MatKAIJGetAIJ(Mat,Mat*);
1738: PETSC_EXTERN PetscErrorCode MatKAIJGetS(Mat,PetscInt*,PetscInt*,PetscScalar**);
1739: PETSC_EXTERN PetscErrorCode MatKAIJGetSRead(Mat,PetscInt*,PetscInt*,const PetscScalar**);
1740: PETSC_EXTERN PetscErrorCode MatKAIJRestoreS(Mat,PetscScalar**);
1741: PETSC_EXTERN PetscErrorCode MatKAIJRestoreSRead(Mat,const PetscScalar**);
1742: PETSC_EXTERN PetscErrorCode MatKAIJGetT(Mat,PetscInt*,PetscInt*,PetscScalar**);
1743: PETSC_EXTERN PetscErrorCode MatKAIJGetTRead(Mat,PetscInt*,PetscInt*,const PetscScalar**);
1744: PETSC_EXTERN PetscErrorCode MatKAIJRestoreT(Mat,PetscScalar**);
1745: PETSC_EXTERN PetscErrorCode MatKAIJRestoreTRead(Mat,const PetscScalar**);
1746: PETSC_EXTERN PetscErrorCode MatKAIJSetAIJ(Mat,Mat);
1747: PETSC_EXTERN PetscErrorCode MatKAIJSetS(Mat,PetscInt,PetscInt,const PetscScalar[]);
1748: PETSC_EXTERN PetscErrorCode MatKAIJSetT(Mat,PetscInt,PetscInt,const PetscScalar[]);
1749: PETSC_EXTERN PetscErrorCode MatKAIJGetScaledIdentity(Mat,PetscBool*);

1751: PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec);

1753: PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
1754: PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec);
1755: PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
1756: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
1757: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
1758: PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
1759: PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat);
1760: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal);
1761: PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt);
1762: PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat,PetscScalar *);
1763: PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat,const char[]);
1764: PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
1765: PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);

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

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

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

1776:     Level: developer

1778: .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister()
1779: S*/
1780: typedef struct _p_MatMFFD* MatMFFD;

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

1785:    Level: beginner

1787: .seealso: MatMFFDSetType(), MatMFFDRegister()
1788: J*/
1789: typedef const char* MatMFFDType;
1790: #define MATMFFD_DS  "ds"
1791: #define MATMFFD_WP  "wp"

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

1796: PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal);
1797: PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscBool);

1799: PETSC_EXTERN PetscErrorCode MatFDColoringSetType(MatFDColoring,MatMFFDType);

1801: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
1802: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);

1804: #ifdef PETSC_HAVE_HARA
1805: PETSC_EXTERN_TYPEDEF typedef PetscScalar (*MatHaraKernel)(PetscInt,PetscReal[],PetscReal[],void*);
1806: PETSC_EXTERN PetscErrorCode MatCreateHaraFromKernel(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscReal[],MatHaraKernel,void*,PetscReal,PetscInt,PetscInt,Mat*);
1807: PETSC_EXTERN PetscErrorCode MatCreateHaraFromMat(Mat,PetscInt,const PetscReal[],PetscReal,PetscInt,PetscInt,PetscInt,PetscReal,Mat*);
1808: PETSC_EXTERN PetscErrorCode MatHaraSetSamplingMat(Mat,Mat,PetscInt,PetscReal);
1809: #endif

1811: /*
1812:    PETSc interface to MUMPS
1813: */
1814: #ifdef PETSC_HAVE_MUMPS
1815: PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt);
1816: PETSC_EXTERN PetscErrorCode MatMumpsGetIcntl(Mat,PetscInt,PetscInt*);
1817: PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat,PetscInt,PetscReal);
1818: PETSC_EXTERN PetscErrorCode MatMumpsGetCntl(Mat,PetscInt,PetscReal*);

1820: PETSC_EXTERN PetscErrorCode MatMumpsGetInfo(Mat,PetscInt,PetscInt*);
1821: PETSC_EXTERN PetscErrorCode MatMumpsGetInfog(Mat,PetscInt,PetscInt*);
1822: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfo(Mat,PetscInt,PetscReal*);
1823: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfog(Mat,PetscInt,PetscReal*);
1824: PETSC_EXTERN PetscErrorCode MatMumpsGetInverse(Mat,Mat);
1825: PETSC_EXTERN PetscErrorCode MatMumpsGetInverseTranspose(Mat,Mat);
1826: #endif

1828: /*
1829:    PETSc interface to Mkl_Pardiso
1830: */
1831: #ifdef PETSC_HAVE_MKL_PARDISO
1832: PETSC_EXTERN PetscErrorCode MatMkl_PardisoSetCntl(Mat,PetscInt,PetscInt);
1833: #endif

1835: /*
1836:    PETSc interface to Mkl_CPardiso
1837: */
1838: #ifdef PETSC_HAVE_MKL_CPARDISO
1839: PETSC_EXTERN PetscErrorCode MatMkl_CPardisoSetCntl(Mat,PetscInt,PetscInt);
1840: #endif

1842: /*
1843:    PETSc interface to SUPERLU
1844: */
1845: #ifdef PETSC_HAVE_SUPERLU
1846: PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal);
1847: #endif

1849: /*
1850:    PETSc interface to SUPERLU_DIST
1851: */
1852: #ifdef PETSC_HAVE_SUPERLU_DIST
1853: PETSC_EXTERN PetscErrorCode MatSuperluDistGetDiagU(Mat,PetscScalar*);
1854: #endif

1856: /*
1857:    PETSc interface to STRUMPACK
1858: */
1859: #ifdef PETSC_HAVE_STRUMPACK
1860: /*E
1861:     MatSTRUMPACKReordering - sparsity reducing ordering to be used in STRUMPACK

1863:     Level: intermediate
1864: E*/
1865: typedef enum {MAT_STRUMPACK_NATURAL=0,
1866:               MAT_STRUMPACK_METIS=1,
1867:               MAT_STRUMPACK_PARMETIS=2,
1868:               MAT_STRUMPACK_SCOTCH=3,
1869:               MAT_STRUMPACK_PTSCOTCH=4,
1870:               MAT_STRUMPACK_RCM=5} MatSTRUMPACKReordering;
1871: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetReordering(Mat,MatSTRUMPACKReordering);
1872: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetColPerm(Mat,PetscBool);
1873: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSRelTol(Mat,PetscReal);
1874: PETSC_DEPRECATED_FUNCTION("Use MatSTRUMPACKSetHSSRelTol() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSTRUMPACKSetHSSRelCompTol(Mat mat,PetscReal rtol) {return MatSTRUMPACKSetHSSRelTol(mat,rtol);}
1875: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSAbsTol(Mat,PetscReal);
1876: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMinSepSize(Mat,PetscInt);
1877: PETSC_DEPRECATED_FUNCTION("Use MatSTRUMPACKSetHSSMinSepSize() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSTRUMPACKSetHSSMinSize(Mat mat,PetscInt hssminsize) {return MatSTRUMPACKSetHSSMinSepSize(mat,hssminsize);}
1878: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMaxRank(Mat,PetscInt);
1879: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSLeafSize(Mat,PetscInt);
1880: #endif


1883: PETSC_EXTERN PetscErrorCode MatBindToCPU(Mat,PetscBool);
1884: PETSC_DEPRECATED_FUNCTION("Use MatBindToCPU (since v3.13)") PETSC_STATIC_INLINE PetscErrorCode MatPinToCPU(Mat A,PetscBool flg) {return MatBindToCPU(A,flg);}

1886: typedef struct _p_SplitCSRMat PetscSplitCSRDataStructure;

1888: #ifdef PETSC_HAVE_KOKKOS_KERNELS
1889: PETSC_EXTERN PetscErrorCode MatKokkosGetDeviceMatWrite(Mat,PetscSplitCSRDataStructure**);
1890: PETSC_EXTERN PetscErrorCode MatSeqAIJKokkosSetDeviceMat(Mat, PetscSplitCSRDataStructure *);
1891: PETSC_EXTERN PetscErrorCode MatSeqAIJKokkosGetDeviceMat(Mat, PetscSplitCSRDataStructure **);
1892: #endif

1894: #ifdef PETSC_HAVE_CUDA
1895: /*E
1896:     MatCUSPARSEStorageFormat - indicates the storage format for CUSPARSE (GPU)
1897:     matrices.

1899:     Not Collective

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

1905:     Level: intermediate

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

1909: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEFormatOperation
1910: E*/

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

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

1917: /*E
1918:     MatCUSPARSEFormatOperation - indicates the operation of CUSPARSE (GPU)
1919:     matrices whose operation should use a particular storage format.

1921:     Not Collective

1923: +   MAT_CUSPARSE_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult
1924: .   MAT_CUSPARSE_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult
1925: .   MAT_CUSPARSE_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult
1926: -   MAT_CUSPARSE_ALL - sets the storage format for all CUSPARSE (GPU) matrices

1928:     Level: intermediate

1930: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEStorageFormat
1931: E*/
1932: typedef enum {MAT_CUSPARSE_MULT_DIAG, MAT_CUSPARSE_MULT_OFFDIAG, MAT_CUSPARSE_MULT, MAT_CUSPARSE_ALL} MatCUSPARSEFormatOperation;

1934: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1935: PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1936: PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat,MatCUSPARSEFormatOperation,MatCUSPARSEStorageFormat);
1937: PETSC_EXTERN PetscErrorCode MatSeqAIJCUSPARSESetGenerateTranspose(Mat,PetscBool);
1938: PETSC_EXTERN PetscErrorCode MatAIJCUSPARSESetGenerateTranspose(Mat,PetscBool);

1940: PETSC_EXTERN PetscErrorCode MatCUSPARSEGetDeviceMatWrite(Mat,PetscSplitCSRDataStructure**);

1942: PETSC_EXTERN PetscErrorCode MatCreateDenseCUDA(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
1943: PETSC_EXTERN PetscErrorCode MatCreateSeqDenseCUDA(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
1944: PETSC_EXTERN PetscErrorCode MatMPIDenseCUDASetPreallocation(Mat,PetscScalar[]);
1945: PETSC_EXTERN PetscErrorCode MatSeqDenseCUDASetPreallocation(Mat,PetscScalar[]);
1946: PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArrayWrite(Mat,PetscScalar**);
1947: PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArrayRead(Mat,const PetscScalar**);
1948: PETSC_EXTERN PetscErrorCode MatDenseCUDAGetArray(Mat,PetscScalar**);
1949: PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArrayWrite(Mat,PetscScalar**);
1950: PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArrayRead(Mat,const PetscScalar**);
1951: PETSC_EXTERN PetscErrorCode MatDenseCUDARestoreArray(Mat,PetscScalar**);
1952: PETSC_EXTERN PetscErrorCode MatDenseCUDAPlaceArray(Mat,const PetscScalar*);
1953: PETSC_EXTERN PetscErrorCode MatDenseCUDAReplaceArray(Mat,const PetscScalar*);
1954: PETSC_EXTERN PetscErrorCode MatDenseCUDAResetArray(Mat);

1956: #endif

1958: #if defined(PETSC_HAVE_VIENNACL)
1959: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
1960: PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
1961: #endif

1963: /*
1964:    PETSc interface to FFTW
1965: */
1966: #if defined(PETSC_HAVE_FFTW)
1967: PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec);
1968: PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec);
1969: PETSC_EXTERN PetscErrorCode MatCreateVecsFFTW(Mat,Vec*,Vec*,Vec*);
1970: #endif

1972: #if defined(PETSC_HAVE_SCALAPACK)
1973: PETSC_EXTERN PetscErrorCode MatCreateScaLAPACK(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
1974: PETSC_EXTERN PetscErrorCode MatScaLAPACKSetBlockSizes(Mat,PetscInt,PetscInt);
1975: PETSC_EXTERN PetscErrorCode MatScaLAPACKGetBlockSizes(Mat,PetscInt*,PetscInt*);
1976: #endif

1978: PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*);
1979: PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*);
1980: PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat,IS[],IS[]);
1981: PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat,IS[],IS[]);
1982: PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***);
1983: PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*);
1984: PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat,VecType);
1985: PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]);
1986: PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat);

1988: PETSC_EXTERN PetscErrorCode MatChop(Mat,PetscReal);
1989: PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat,PetscReal,PetscInt*);

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

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

1995: PETSC_INTERN PetscErrorCode MatHeaderMerge(Mat,Mat*);
1996: PETSC_EXTERN PetscErrorCode MatHeaderReplace(Mat,Mat*);
1997: #endif