Actual source code: petscmat.h
petsc-3.12.4 2020-02-04
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 MATAIJVIENNACL     "aijviennacl"
     44: #define MATSEQAIJVIENNACL  "seqaijviennacl"
     45: #define MATMPIAIJVIENNACL  "mpiaijviennacl"
     46: #define MATAIJPERM         "aijperm"
     47: #define MATSEQAIJPERM      "seqaijperm"
     48: #define MATMPIAIJPERM      "mpiaijperm"
     49: #define MATAIJSELL         "aijsell"
     50: #define MATSEQAIJSELL      "seqaijsell"
     51: #define MATMPIAIJSELL      "mpiaijsell"
     52: #define MATAIJMKL          "aijmkl"
     53: #define MATSEQAIJMKL       "seqaijmkl"
     54: #define MATMPIAIJMKL       "mpiaijmkl"
     55: #define MATBAIJMKL         "baijmkl"
     56: #define MATSEQBAIJMKL      "seqbaijmkl"
     57: #define MATMPIBAIJMKL      "mpibaijmkl"
     58: #define MATSHELL           "shell"
     59: #define MATDENSE           "dense"
     60: #define MATSEQDENSE        "seqdense"
     61: #define MATSEQDENSECUDA    "seqdensecuda"
     62: #define MATMPIDENSE        "mpidense"
     63: #define MATELEMENTAL       "elemental"
     64: #define MATBAIJ            "baij"
     65: #define MATSEQBAIJ         "seqbaij"
     66: #define MATMPIBAIJ         "mpibaij"
     67: #define MATMPIADJ          "mpiadj"
     68: #define MATSBAIJ           "sbaij"
     69: #define MATSEQSBAIJ        "seqsbaij"
     70: #define MATMPISBAIJ        "mpisbaij"
     71: #define MATDAAD            "daad"
     72: #define MATMFFD            "mffd"
     73: #define MATNORMAL          "normal"
     74: #define MATNORMALHERMITIAN "normalh"
     75: #define MATLRC             "lrc"
     76: #define MATSCATTER         "scatter"
     77: #define MATBLOCKMAT        "blockmat"
     78: #define MATCOMPOSITE       "composite"
     79: #define MATFFT             "fft"
     80: #define MATFFTW            "fftw"
     81: #define MATSEQCUFFT        "seqcufft"
     82: #define MATTRANSPOSEMAT    "transpose"
     83: #define MATSCHURCOMPLEMENT "schurcomplement"
     84: #define MATPYTHON          "python"
     85: #define MATHYPRE           "hypre"
     86: #define MATHYPRESTRUCT     "hyprestruct"
     87: #define MATHYPRESSTRUCT    "hypresstruct"
     88: #define MATSUBMATRIX       "submatrix"
     89: #define MATLOCALREF        "localref"
     90: #define MATNEST            "nest"
     91: #define MATPREALLOCATOR    "preallocator"
     92: #define MATSELL            "sell"
     93: #define MATSEQSELL         "seqsell"
     94: #define MATMPISELL         "mpisell"
     95: #define MATDUMMY           "dummy"
     96: #define MATLMVM            "lmvm"
     97: #define MATLMVMDFP         "lmvmdfp"
     98: #define MATLMVMBFGS        "lmvmbfgs"
     99: #define MATLMVMSR1         "lmvmsr1"
    100: #define MATLMVMBRDN        "lmvmbrdn"
    101: #define MATLMVMBADBRDN     "lmvmbadbrdn"
    102: #define MATLMVMSYMBRDN     "lmvmsymbrdn"
    103: #define MATLMVMSYMBADBRDN  "lmvmsymbadbrdn"
    104: #define MATLMVMDIAGBRDN    "lmvmdiagbrdn"
    105: #define MATCONSTANTDIAGONAL "constantdiagonal"

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

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

    112:    Level: beginner

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

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

    139: /*E
    140:     MatFactorType - indicates what type of factorization is requested

    142:     Level: beginner

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

    146: .seealso: MatSolverType, MatGetFactor()
    147: E*/
    148: typedef enum {MAT_FACTOR_NONE, MAT_FACTOR_LU, MAT_FACTOR_CHOLESKY, MAT_FACTOR_ILU, MAT_FACTOR_ICC,MAT_FACTOR_ILUDT} MatFactorType;
    149: PETSC_EXTERN const char *const MatFactorTypes[];

    151: PETSC_EXTERN PetscErrorCode MatGetFactor(Mat,MatSolverType,MatFactorType,Mat*);
    152: PETSC_EXTERN PetscErrorCode MatGetFactorAvailable(Mat,MatSolverType,MatFactorType,PetscBool *);
    153: PETSC_EXTERN PetscErrorCode MatFactorGetSolverType(Mat,MatSolverType*);
    154: PETSC_EXTERN PetscErrorCode MatGetFactorType(Mat,MatFactorType*);
    155: PETSC_EXTERN PetscErrorCode MatSetFactorType(Mat,MatFactorType);
    156: PETSC_EXTERN PetscErrorCode MatSolverTypeRegister(MatSolverType,MatType,MatFactorType,PetscErrorCode(*)(Mat,MatFactorType,Mat*));
    157: PETSC_EXTERN PetscErrorCode MatSolverTypeGet(MatSolverType,MatType,MatFactorType,PetscBool*,PetscBool*,PetscErrorCode (**)(Mat,MatFactorType,Mat*));
    158: typedef MatSolverType MatSolverPackage PETSC_DEPRECATED_TYPEDEF("Use MatSolverType (since version 3.9)");
    159: PETSC_DEPRECATED_FUNCTION("Use MatSolverTypeRegister() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSolverPackageRegister(MatSolverType stype,MatType mtype,MatFactorType ftype,PetscErrorCode(*f)(Mat,MatFactorType,Mat*))
    160: { return MatSolverTypeRegister(stype,mtype,ftype,f); }
    161: PETSC_DEPRECATED_FUNCTION("Use MatSolverTypeGet() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSolverPackageGet(MatSolverType stype,MatType mtype,MatFactorType ftype,PetscBool *foundmtype,PetscBool *foundstype,PetscErrorCode(**f)(Mat,MatFactorType,Mat*))
    162: { return MatSolverTypeGet(stype,mtype,ftype,foundmtype,foundstype,f); }

    164: /* Logging support */
    165: #define    MAT_FILE_CLASSID 1211216    /* used to indicate matrices in binary files */
    166: PETSC_EXTERN PetscClassId MAT_CLASSID;
    167: PETSC_EXTERN PetscClassId MAT_COLORING_CLASSID;
    168: PETSC_EXTERN PetscClassId MAT_FDCOLORING_CLASSID;
    169: PETSC_EXTERN PetscClassId MAT_TRANSPOSECOLORING_CLASSID;
    170: PETSC_EXTERN PetscClassId MAT_PARTITIONING_CLASSID;
    171: PETSC_EXTERN PetscClassId MAT_COARSEN_CLASSID;
    172: PETSC_EXTERN PetscClassId MAT_NULLSPACE_CLASSID;
    173: PETSC_EXTERN PetscClassId MATMFFD_CLASSID;

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

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

    184:     Level: beginner

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

    188: .seealso: MatCreateSubMatrices(), MatCreateSubMatrix(), MatDestroyMatrices(), MatConvert()
    189: E*/
    190: typedef enum {MAT_INITIAL_MATRIX,MAT_REUSE_MATRIX,MAT_IGNORE_MATRIX,MAT_INPLACE_MATRIX} MatReuse;

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

    196:     Level: beginner

    198: .seealso: MatGetSeqNonzerostructure()
    199: E*/
    200: typedef enum {MAT_DO_NOT_GET_VALUES,MAT_GET_VALUES} MatCreateSubMatrixOption;

    202: PETSC_EXTERN PetscErrorCode MatInitializePackage(void);

    204: PETSC_EXTERN PetscErrorCode MatCreate(MPI_Comm,Mat*);
    205: PETSC_EXTERN PetscErrorCode MatSetSizes(Mat,PetscInt,PetscInt,PetscInt,PetscInt);
    206: PETSC_EXTERN PetscErrorCode MatSetType(Mat,MatType);
    207: PETSC_EXTERN PetscErrorCode MatSetFromOptions(Mat);
    208: PETSC_STATIC_INLINE PetscErrorCode MatViewFromOptions(Mat A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
    209: PETSC_EXTERN PetscErrorCode MatRegister(const char[],PetscErrorCode(*)(Mat));
    210: PETSC_EXTERN PetscErrorCode MatRegisterRootName(const char[],const char[],const char[]);
    211: PETSC_EXTERN PetscErrorCode MatSetOptionsPrefix(Mat,const char[]);
    212: PETSC_EXTERN PetscErrorCode MatAppendOptionsPrefix(Mat,const char[]);
    213: PETSC_EXTERN PetscErrorCode MatGetOptionsPrefix(Mat,const char*[]);
    214: PETSC_EXTERN PetscErrorCode MatSetErrorIfFailure(Mat,PetscBool);

    216: PETSC_EXTERN PetscFunctionList MatList;
    217: PETSC_EXTERN PetscFunctionList MatColoringList;
    218: PETSC_EXTERN PetscFunctionList MatPartitioningList;

    220: /*E
    221:     MatStructure - Indicates if two matrices have the same nonzero structure

    223:     Level: beginner

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

    227: .seealso: MatCopy(), MatAXPY()
    228: E*/
    229: typedef enum {DIFFERENT_NONZERO_PATTERN,SUBSET_NONZERO_PATTERN,SAME_NONZERO_PATTERN} MatStructure;

    231: #if defined PETSC_HAVE_MKL_SPARSE
    232: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
    233: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
    234: PETSC_EXTERN PetscErrorCode MatCreateBAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
    235: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJMKL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
    236: #endif

    238: PETSC_EXTERN PetscErrorCode MatCreateSeqSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
    239: PETSC_EXTERN PetscErrorCode MatCreateSELL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
    240: PETSC_EXTERN PetscErrorCode MatSeqSELLSetPreallocation(Mat,PetscInt,const PetscInt[]);
    241: PETSC_EXTERN PetscErrorCode MatMPISELLSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);

    243: PETSC_EXTERN PetscErrorCode MatCreateSeqDense(MPI_Comm,PetscInt,PetscInt,PetscScalar[],Mat*);
    244: PETSC_EXTERN PetscErrorCode MatCreateDense(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar[],Mat*);
    245: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
    246: PETSC_EXTERN PetscErrorCode MatCreateAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
    247: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
    248: PETSC_EXTERN PetscErrorCode MatUpdateMPIAIJWithArrays(Mat,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
    249: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSplitArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],PetscInt[],PetscInt[],PetscScalar[],Mat*);
    250: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJWithSeqAIJ(MPI_Comm,Mat,Mat,const PetscInt[],Mat*);

    252: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
    253: PETSC_EXTERN PetscErrorCode MatCreateBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
    254: PETSC_EXTERN PetscErrorCode MatCreateMPIBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat*);

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

    259: PETSC_EXTERN PetscErrorCode MatCreateSBAIJ(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
    260: PETSC_EXTERN PetscErrorCode MatCreateMPISBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[],Mat *);
    261: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
    262: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
    263: PETSC_EXTERN PetscErrorCode MatXAIJSetPreallocation(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],const PetscInt[]);

    265: PETSC_EXTERN PetscErrorCode MatCreateShell(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,void *,Mat*);
    266: PETSC_EXTERN PetscErrorCode MatCreateNormal(Mat,Mat*);
    267: PETSC_EXTERN PetscErrorCode MatCreateNormalHermitian(Mat,Mat*);
    268: PETSC_EXTERN PetscErrorCode MatCreateLRC(Mat,Mat,Vec,Mat,Mat*);
    269: PETSC_EXTERN PetscErrorCode MatLRCGetMats(Mat,Mat*,Mat*,Vec*,Mat*);
    270: PETSC_EXTERN PetscErrorCode MatCreateIS(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,ISLocalToGlobalMapping,ISLocalToGlobalMapping,Mat*);
    271: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
    272: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJCRL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);

    274: PETSC_EXTERN PetscErrorCode MatCreateScatter(MPI_Comm,VecScatter,Mat*);
    275: PETSC_EXTERN PetscErrorCode MatScatterSetVecScatter(Mat,VecScatter);
    276: PETSC_EXTERN PetscErrorCode MatScatterGetVecScatter(Mat,VecScatter*);
    277: PETSC_EXTERN PetscErrorCode MatCreateBlockMat(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt*,Mat*);
    278: PETSC_EXTERN PetscErrorCode MatCompositeAddMat(Mat,Mat);
    279: PETSC_EXTERN PetscErrorCode MatCompositeMerge(Mat);
    280: typedef enum {MAT_COMPOSITE_MERGE_RIGHT,MAT_COMPOSITE_MERGE_LEFT} MatCompositeMergeType;
    281: PETSC_EXTERN PetscErrorCode MatCompositeSetMergeType(Mat,MatCompositeMergeType);
    282: PETSC_EXTERN PetscErrorCode MatCreateComposite(MPI_Comm,PetscInt,const Mat*,Mat*);
    283: typedef enum {MAT_COMPOSITE_ADDITIVE,MAT_COMPOSITE_MULTIPLICATIVE} MatCompositeType;
    284: PETSC_EXTERN PetscErrorCode MatCompositeSetType(Mat,MatCompositeType);
    285: PETSC_EXTERN PetscErrorCode MatCompositeGetType(Mat,MatCompositeType*);
    286: PETSC_EXTERN PetscErrorCode MatCompositeSetMatStructure(Mat,MatStructure);
    287: PETSC_EXTERN PetscErrorCode MatCompositeGetMatStructure(Mat,MatStructure*);
    288: PETSC_EXTERN PetscErrorCode MatCompositeGetNumberMat(Mat,PetscInt*);
    289: PETSC_EXTERN PetscErrorCode MatCompositeGetMat(Mat,PetscInt,Mat*);
    290: PETSC_EXTERN PetscErrorCode MatCompositeSetScalings(Mat,const PetscScalar*);

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

    295: PETSC_EXTERN PetscErrorCode MatCreateTranspose(Mat,Mat*);
    296: PETSC_EXTERN PetscErrorCode MatTransposeGetMat(Mat,Mat*);
    297: PETSC_EXTERN PetscErrorCode MatCreateHermitianTranspose(Mat,Mat*);
    298: PETSC_EXTERN PetscErrorCode MatHermitianTransposeGetMat(Mat,Mat*);
    299: PETSC_EXTERN PetscErrorCode MatCreateSubMatrixVirtual(Mat,IS,IS,Mat*);
    300: PETSC_EXTERN PetscErrorCode MatSubMatrixVirtualUpdate(Mat,Mat,IS,IS);
    301: PETSC_EXTERN PetscErrorCode MatCreateLocalRef(Mat,IS,IS,Mat*);
    302: PETSC_EXTERN PetscErrorCode MatCreateConstantDiagonal(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar,Mat*);

    304: #if defined(PETSC_HAVE_HYPRE)
    305: PETSC_EXTERN PetscErrorCode MatHYPRESetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
    306: #endif

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

    310: PETSC_EXTERN PetscErrorCode MatResetPreallocation(Mat);
    311: PETSC_EXTERN PetscErrorCode MatSetUp(Mat);
    312: PETSC_EXTERN PetscErrorCode MatDestroy(Mat*);
    313: PETSC_EXTERN PetscErrorCode MatGetNonzeroState(Mat,PetscObjectState*);

    315: PETSC_EXTERN PetscErrorCode MatConjugate(Mat);
    316: PETSC_EXTERN PetscErrorCode MatRealPart(Mat);
    317: PETSC_EXTERN PetscErrorCode MatImaginaryPart(Mat);
    318: PETSC_EXTERN PetscErrorCode MatGetDiagonalBlock(Mat,Mat*);
    319: PETSC_EXTERN PetscErrorCode MatGetTrace(Mat,PetscScalar*);
    320: PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonal(Mat,const PetscScalar **);
    321: PETSC_EXTERN PetscErrorCode MatInvertVariableBlockDiagonal(Mat,PetscInt,const PetscInt*,PetscScalar*);
    322: PETSC_EXTERN PetscErrorCode MatInvertBlockDiagonalMat(Mat,Mat);

    324: /* ------------------------------------------------------------*/
    325: PETSC_EXTERN PetscErrorCode MatSetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
    326: PETSC_EXTERN PetscErrorCode MatSetValuesBlocked(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
    327: PETSC_EXTERN PetscErrorCode MatSetValuesRow(Mat,PetscInt,const PetscScalar[]);
    328: PETSC_EXTERN PetscErrorCode MatSetValuesRowLocal(Mat,PetscInt,const PetscScalar[]);
    329: PETSC_EXTERN PetscErrorCode MatSetValuesBatch(Mat,PetscInt,PetscInt,PetscInt[],const PetscScalar[]);
    330: PETSC_EXTERN PetscErrorCode MatSetRandom(Mat,PetscRandom);

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

    336:    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).
    337:    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.

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

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

    343:    Level: beginner

    345: .seealso:  MatSetValuesStencil(), MatSetStencil(), MatSetValuesBlockedStencil(), DMDAVecGetArray(), DMDAVecGetArrayF90()
    346: S*/
    347: typedef struct {
    348:   PetscInt k,j,i,c;
    349: } MatStencil;

    351: PETSC_EXTERN PetscErrorCode MatSetValuesStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
    352: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedStencil(Mat,PetscInt,const MatStencil[],PetscInt,const MatStencil[],const PetscScalar[],InsertMode);
    353: PETSC_EXTERN PetscErrorCode MatSetStencil(Mat,PetscInt,const PetscInt[],const PetscInt[],PetscInt);

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

    359:     Level: beginner

    361: .seealso: MatAssemblyBegin(), MatAssemblyEnd()
    362: E*/
    363: typedef enum {MAT_FLUSH_ASSEMBLY=1,MAT_FINAL_ASSEMBLY=0} MatAssemblyType;
    364: PETSC_EXTERN PetscErrorCode MatAssemblyBegin(Mat,MatAssemblyType);
    365: PETSC_EXTERN PetscErrorCode MatAssemblyEnd(Mat,MatAssemblyType);
    366: PETSC_EXTERN PetscErrorCode MatAssembled(Mat,PetscBool *);

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

    373:     Level: beginner

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

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

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

    411: PETSC_EXTERN const char *const *MatOptions;
    412: PETSC_EXTERN PetscErrorCode MatSetOption(Mat,MatOption,PetscBool);
    413: PETSC_EXTERN PetscErrorCode MatGetOption(Mat,MatOption,PetscBool*);
    414: PETSC_EXTERN PetscErrorCode MatGetType(Mat,MatType*);

    416: PETSC_EXTERN PetscErrorCode MatGetValues(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],PetscScalar[]);
    417: PETSC_EXTERN PetscErrorCode MatGetRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
    418: PETSC_EXTERN PetscErrorCode MatRestoreRow(Mat,PetscInt,PetscInt *,const PetscInt *[],const PetscScalar*[]);
    419: PETSC_EXTERN PetscErrorCode MatGetRowUpperTriangular(Mat);
    420: PETSC_EXTERN PetscErrorCode MatRestoreRowUpperTriangular(Mat);
    421: PETSC_EXTERN PetscErrorCode MatGetColumnVector(Mat,Vec,PetscInt);
    422: PETSC_EXTERN PetscErrorCode MatSeqAIJGetArray(Mat,PetscScalar *[]);
    423: PETSC_EXTERN PetscErrorCode MatSeqAIJGetArrayRead(Mat,const PetscScalar *[]);
    424: PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArray(Mat,PetscScalar *[]);
    425: PETSC_EXTERN PetscErrorCode MatSeqAIJRestoreArrayRead(Mat,const PetscScalar *[]);
    426: PETSC_EXTERN PetscErrorCode MatSeqAIJGetMaxRowNonzeros(Mat,PetscInt*);
    427: PETSC_EXTERN PetscErrorCode MatSeqAIJSetValuesLocalFast(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
    428: PETSC_EXTERN PetscErrorCode MatSeqAIJSetType(Mat,MatType);
    429: PETSC_EXTERN PetscErrorCode MatSeqAIJRegister(const char[],PetscErrorCode (*)(Mat,MatType,MatReuse,Mat *));
    430: PETSC_EXTERN PetscFunctionList MatSeqAIJList;
    431: PETSC_EXTERN PetscErrorCode MatSeqBAIJGetArray(Mat,PetscScalar *[]);
    432: PETSC_EXTERN PetscErrorCode MatSeqBAIJRestoreArray(Mat,PetscScalar *[]);
    433: PETSC_EXTERN PetscErrorCode MatSeqSBAIJGetArray(Mat,PetscScalar *[]);
    434: PETSC_EXTERN PetscErrorCode MatSeqSBAIJRestoreArray(Mat,PetscScalar *[]);
    435: PETSC_EXTERN PetscErrorCode MatDenseGetArray(Mat,PetscScalar *[]);
    436: PETSC_EXTERN PetscErrorCode MatDenseRestoreArray(Mat,PetscScalar *[]);
    437: PETSC_EXTERN PetscErrorCode MatDensePlaceArray(Mat,const PetscScalar[]);
    438: PETSC_EXTERN PetscErrorCode MatDenseResetArray(Mat);
    439: PETSC_EXTERN PetscErrorCode MatDenseGetArrayRead(Mat,const PetscScalar *[]);
    440: PETSC_EXTERN PetscErrorCode MatDenseRestoreArrayRead(Mat,const PetscScalar *[]);
    441: PETSC_EXTERN PetscErrorCode MatGetBlockSize(Mat,PetscInt *);
    442: PETSC_EXTERN PetscErrorCode MatSetBlockSize(Mat,PetscInt);
    443: PETSC_EXTERN PetscErrorCode MatGetBlockSizes(Mat,PetscInt *,PetscInt *);
    444: PETSC_EXTERN PetscErrorCode MatSetBlockSizes(Mat,PetscInt,PetscInt);
    445: PETSC_EXTERN PetscErrorCode MatSetBlockSizesFromMats(Mat,Mat,Mat);
    446: PETSC_EXTERN PetscErrorCode MatSetVariableBlockSizes(Mat,PetscInt,PetscInt*);
    447: PETSC_EXTERN PetscErrorCode MatGetVariableBlockSizes(Mat,PetscInt*,const PetscInt**);

    449: PETSC_EXTERN PetscErrorCode MatDenseGetColumn(Mat,PetscInt,PetscScalar *[]);
    450: PETSC_EXTERN PetscErrorCode MatDenseRestoreColumn(Mat,PetscScalar *[]);

    452: PETSC_EXTERN PetscErrorCode MatMult(Mat,Vec,Vec);
    453: PETSC_EXTERN PetscErrorCode MatMultDiagonalBlock(Mat,Vec,Vec);
    454: PETSC_EXTERN PetscErrorCode MatMultAdd(Mat,Vec,Vec,Vec);
    455: PETSC_EXTERN PetscErrorCode MatMultTranspose(Mat,Vec,Vec);
    456: PETSC_EXTERN PetscErrorCode MatMultHermitianTranspose(Mat,Vec,Vec);
    457: PETSC_EXTERN PetscErrorCode MatIsTranspose(Mat,Mat,PetscReal,PetscBool *);
    458: PETSC_EXTERN PetscErrorCode MatIsHermitianTranspose(Mat,Mat,PetscReal,PetscBool *);
    459: PETSC_EXTERN PetscErrorCode MatMultTransposeAdd(Mat,Vec,Vec,Vec);
    460: PETSC_EXTERN PetscErrorCode MatMultHermitianTransposeAdd(Mat,Vec,Vec,Vec);
    461: PETSC_EXTERN PetscErrorCode MatMultConstrained(Mat,Vec,Vec);
    462: PETSC_EXTERN PetscErrorCode MatMultTransposeConstrained(Mat,Vec,Vec);
    463: PETSC_EXTERN PetscErrorCode MatMatSolve(Mat,Mat,Mat);
    464: PETSC_EXTERN PetscErrorCode MatMatSolveTranspose(Mat,Mat,Mat);
    465: PETSC_EXTERN PetscErrorCode MatMatTransposeSolve(Mat,Mat,Mat);
    466: PETSC_EXTERN PetscErrorCode MatResidual(Mat,Vec,Vec,Vec);

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

    472:     Level: beginner

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

    476: $   MAT_DO_NOT_COPY_VALUES    - Create a matrix using the same nonzero pattern as the original matrix,
    477: $                               with zeros for the numerical values.
    478: $   MAT_COPY_VALUES           - Create a matrix with the same nonzero pattern as the original matrix
    479: $                               and with the same numerical values.
    480: $   MAT_SHARE_NONZERO_PATTERN - Create a matrix that shares the nonzero structure with the previous matrix
    481: $                               and does not copy it, using zeros for the numerical values. The parent and
    482: $                               child matrices will share their index (i and j) arrays, and you cannot
    483: $                               insert new nonzero entries into either matrix.

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

    489: .seealso: MatDuplicate()
    490: E*/
    491: typedef enum {MAT_DO_NOT_COPY_VALUES,MAT_COPY_VALUES,MAT_SHARE_NONZERO_PATTERN} MatDuplicateOption;

    493: PETSC_EXTERN PetscErrorCode MatConvert(Mat,MatType,MatReuse,Mat*);
    494: PETSC_EXTERN PetscErrorCode MatDuplicate(Mat,MatDuplicateOption,Mat*);

    497: PETSC_EXTERN PetscErrorCode MatCopy(Mat,Mat,MatStructure);
    498: PETSC_EXTERN PetscErrorCode MatView(Mat,PetscViewer);
    499: PETSC_EXTERN PetscErrorCode MatIsSymmetric(Mat,PetscReal,PetscBool *);
    500: PETSC_EXTERN PetscErrorCode MatIsStructurallySymmetric(Mat,PetscBool *);
    501: PETSC_EXTERN PetscErrorCode MatIsHermitian(Mat,PetscReal,PetscBool *);
    502: PETSC_EXTERN PetscErrorCode MatIsSymmetricKnown(Mat,PetscBool *,PetscBool *);
    503: PETSC_EXTERN PetscErrorCode MatIsHermitianKnown(Mat,PetscBool *,PetscBool *);
    504: PETSC_EXTERN PetscErrorCode MatMissingDiagonal(Mat,PetscBool  *,PetscInt *);
    505: PETSC_EXTERN PetscErrorCode MatLoad(Mat, PetscViewer);

    507: PETSC_EXTERN PetscErrorCode MatGetRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool  *);
    508: PETSC_EXTERN PetscErrorCode MatRestoreRowIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool  *);
    509: PETSC_EXTERN PetscErrorCode MatGetColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt*,const PetscInt *[],const PetscInt *[],PetscBool  *);
    510: PETSC_EXTERN PetscErrorCode MatRestoreColumnIJ(Mat,PetscInt,PetscBool ,PetscBool ,PetscInt *,const PetscInt *[],const PetscInt *[],PetscBool  *);

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

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

    517:    Level: intermediate

    519: .seealso:  MatGetInfo(), MatInfoType
    520: S*/
    521: typedef struct {
    522:   PetscLogDouble block_size;                         /* block size */
    523:   PetscLogDouble nz_allocated,nz_used,nz_unneeded;   /* number of nonzeros */
    524:   PetscLogDouble memory;                             /* memory allocated */
    525:   PetscLogDouble assemblies;                         /* number of matrix assemblies called */
    526:   PetscLogDouble mallocs;                            /* number of mallocs during MatSetValues() */
    527:   PetscLogDouble fill_ratio_given,fill_ratio_needed; /* fill ratio for LU/ILU */
    528:   PetscLogDouble factor_mallocs;                     /* number of mallocs during factorization */
    529: } MatInfo;

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

    535:     Level: beginner

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

    539: .seealso: MatGetInfo(), MatInfo
    540: E*/
    541: typedef enum {MAT_LOCAL=1,MAT_GLOBAL_MAX=2,MAT_GLOBAL_SUM=3} MatInfoType;
    542: PETSC_EXTERN PetscErrorCode MatGetInfo(Mat,MatInfoType,MatInfo*);
    543: PETSC_EXTERN PetscErrorCode MatGetDiagonal(Mat,Vec);
    544: PETSC_EXTERN PetscErrorCode MatGetRowMax(Mat,Vec,PetscInt[]);
    545: PETSC_EXTERN PetscErrorCode MatGetRowMin(Mat,Vec,PetscInt[]);
    546: PETSC_EXTERN PetscErrorCode MatGetRowMaxAbs(Mat,Vec,PetscInt[]);
    547: PETSC_EXTERN PetscErrorCode MatGetRowMinAbs(Mat,Vec,PetscInt[]);
    548: PETSC_EXTERN PetscErrorCode MatGetRowSum(Mat,Vec);
    549: PETSC_EXTERN PetscErrorCode MatTranspose(Mat,MatReuse,Mat*);
    550: PETSC_EXTERN PetscErrorCode MatHermitianTranspose(Mat,MatReuse,Mat*);
    551: PETSC_EXTERN PetscErrorCode MatPermute(Mat,IS,IS,Mat*);
    552: PETSC_EXTERN PetscErrorCode MatDiagonalScale(Mat,Vec,Vec);
    553: PETSC_EXTERN PetscErrorCode MatDiagonalSet(Mat,Vec,InsertMode);

    555: PETSC_EXTERN PetscErrorCode MatEqual(Mat,Mat,PetscBool*);
    556: PETSC_EXTERN PetscErrorCode MatMultEqual(Mat,Mat,PetscInt,PetscBool*);
    557: PETSC_EXTERN PetscErrorCode MatMultAddEqual(Mat,Mat,PetscInt,PetscBool*);
    558: PETSC_EXTERN PetscErrorCode MatMultTransposeEqual(Mat,Mat,PetscInt,PetscBool*);
    559: PETSC_EXTERN PetscErrorCode MatMultTransposeAddEqual(Mat,Mat,PetscInt,PetscBool*);
    560: PETSC_EXTERN PetscErrorCode MatMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
    561: PETSC_EXTERN PetscErrorCode MatTransposeMatMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
    562: PETSC_EXTERN PetscErrorCode MatMatTransposeMultEqual(Mat,Mat,Mat,PetscInt,PetscBool*);
    563: PETSC_EXTERN PetscErrorCode MatIsLinear(Mat,PetscInt,PetscBool*);

    565: PETSC_EXTERN PetscErrorCode MatNorm(Mat,NormType,PetscReal*);
    566: PETSC_EXTERN PetscErrorCode MatGetColumnNorms(Mat,NormType,PetscReal*);
    567: PETSC_EXTERN PetscErrorCode MatZeroEntries(Mat);
    568: PETSC_EXTERN PetscErrorCode MatZeroRows(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
    569: PETSC_EXTERN PetscErrorCode MatZeroRowsIS(Mat,IS,PetscScalar,Vec,Vec);
    570: PETSC_EXTERN PetscErrorCode MatZeroRowsStencil(Mat,PetscInt,const MatStencil [],PetscScalar,Vec,Vec);
    571: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsStencil(Mat,PetscInt,const MatStencil[],PetscScalar,Vec,Vec);
    572: PETSC_EXTERN PetscErrorCode MatZeroRowsColumns(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
    573: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsIS(Mat,IS,PetscScalar,Vec,Vec);

    575: PETSC_EXTERN PetscErrorCode MatGetSize(Mat,PetscInt*,PetscInt*);
    576: PETSC_EXTERN PetscErrorCode MatGetLocalSize(Mat,PetscInt*,PetscInt*);
    577: PETSC_EXTERN PetscErrorCode MatGetOwnershipRange(Mat,PetscInt*,PetscInt*);
    578: PETSC_EXTERN PetscErrorCode MatGetOwnershipRanges(Mat,const PetscInt**);
    579: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangeColumn(Mat,PetscInt*,PetscInt*);
    580: PETSC_EXTERN PetscErrorCode MatGetOwnershipRangesColumn(Mat,const PetscInt**);
    581: PETSC_EXTERN PetscErrorCode MatGetOwnershipIS(Mat,IS*,IS*);

    583: PETSC_EXTERN PetscErrorCode MatCreateSubMatrices(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
    584: 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);}
    585: PETSC_EXTERN PetscErrorCode MatCreateSubMatricesMPI(Mat,PetscInt,const IS[],const IS[],MatReuse,Mat *[]);
    586: 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);}
    587: PETSC_EXTERN PetscErrorCode MatDestroyMatrices(PetscInt,Mat *[]);
    588: PETSC_EXTERN PetscErrorCode MatDestroySubMatrices(PetscInt,Mat *[]);
    589: PETSC_EXTERN PetscErrorCode MatCreateSubMatrix(Mat,IS,IS,MatReuse,Mat *);
    590: 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);}
    591: PETSC_EXTERN PetscErrorCode MatGetLocalSubMatrix(Mat,IS,IS,Mat*);
    592: PETSC_EXTERN PetscErrorCode MatRestoreLocalSubMatrix(Mat,IS,IS,Mat*);
    593: PETSC_EXTERN PetscErrorCode MatGetSeqNonzeroStructure(Mat,Mat*);
    594: PETSC_EXTERN PetscErrorCode MatDestroySeqNonzeroStructure(Mat*);

    596: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJ(MPI_Comm,Mat,PetscInt,PetscInt,MatReuse,Mat*);
    597: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJSymbolic(MPI_Comm,Mat,PetscInt,PetscInt,Mat*);
    598: PETSC_EXTERN PetscErrorCode MatCreateMPIAIJSumSeqAIJNumeric(Mat,Mat);
    599: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMat(Mat,MatReuse,Mat*);
    600: PETSC_EXTERN PetscErrorCode MatMPIAIJGetLocalMatCondensed(Mat,MatReuse,IS*,IS*,Mat*);
    601: PETSC_EXTERN PetscErrorCode MatGetBrowsOfAcols(Mat,Mat,MatReuse,IS*,IS*,Mat*);
    602: PETSC_EXTERN PetscErrorCode MatGetGhosts(Mat, PetscInt *,const PetscInt *[]);

    604: PETSC_EXTERN PetscErrorCode MatIncreaseOverlap(Mat,PetscInt,IS[],PetscInt);
    605: PETSC_EXTERN PetscErrorCode MatIncreaseOverlapSplit(Mat mat,PetscInt n,IS is[],PetscInt ov);
    606: PETSC_EXTERN PetscErrorCode MatMPIAIJSetUseScalableIncreaseOverlap(Mat,PetscBool);

    608: PETSC_EXTERN PetscErrorCode MatMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
    609: PETSC_EXTERN PetscErrorCode MatMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
    610: PETSC_EXTERN PetscErrorCode MatMatMultNumeric(Mat,Mat,Mat);

    612: PETSC_EXTERN PetscErrorCode MatMatMatMult(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);
    613: PETSC_EXTERN PetscErrorCode MatGalerkin(Mat,Mat,Mat,MatReuse,PetscReal,Mat*);

    615: PETSC_EXTERN PetscErrorCode MatPtAP(Mat,Mat,MatReuse,PetscReal,Mat*);
    616: PETSC_EXTERN PetscErrorCode MatPtAPSymbolic(Mat,Mat,PetscReal,Mat*);
    617: PETSC_EXTERN PetscErrorCode MatPtAPNumeric(Mat,Mat,Mat);
    618: PETSC_EXTERN PetscErrorCode MatRARt(Mat,Mat,MatReuse,PetscReal,Mat*);
    619: PETSC_EXTERN PetscErrorCode MatRARtSymbolic(Mat,Mat,PetscReal,Mat*);
    620: PETSC_EXTERN PetscErrorCode MatRARtNumeric(Mat,Mat,Mat);

    622: PETSC_EXTERN PetscErrorCode MatTransposeMatMult(Mat,Mat,MatReuse,PetscReal,Mat*);
    623: PETSC_EXTERN PetscErrorCode MatTransposetMatMultSymbolic(Mat,Mat,PetscReal,Mat*);
    624: PETSC_EXTERN PetscErrorCode MatTransposetMatMultNumeric(Mat,Mat,Mat);
    625: PETSC_EXTERN PetscErrorCode MatMatTransposeMult(Mat,Mat,MatReuse,PetscReal,Mat*);
    626: PETSC_EXTERN PetscErrorCode MatMatTransposeMultSymbolic(Mat,Mat,PetscReal,Mat*);
    627: PETSC_EXTERN PetscErrorCode MatMatTransposeMultNumeric(Mat,Mat,Mat);

    629: PETSC_EXTERN PetscErrorCode MatAXPY(Mat,PetscScalar,Mat,MatStructure);
    630: PETSC_EXTERN PetscErrorCode MatAYPX(Mat,PetscScalar,Mat,MatStructure);

    632: PETSC_EXTERN PetscErrorCode MatScale(Mat,PetscScalar);
    633: PETSC_EXTERN PetscErrorCode MatShift(Mat,PetscScalar);

    635: PETSC_EXTERN PetscErrorCode MatSetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping,ISLocalToGlobalMapping);
    636: PETSC_EXTERN PetscErrorCode MatGetLocalToGlobalMapping(Mat,ISLocalToGlobalMapping*,ISLocalToGlobalMapping*);
    637: PETSC_EXTERN PetscErrorCode MatGetLayouts(Mat,PetscLayout*,PetscLayout*);
    638: PETSC_EXTERN PetscErrorCode MatZeroRowsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
    639: PETSC_EXTERN PetscErrorCode MatZeroRowsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
    640: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocal(Mat,PetscInt,const PetscInt [],PetscScalar,Vec,Vec);
    641: PETSC_EXTERN PetscErrorCode MatZeroRowsColumnsLocalIS(Mat,IS,PetscScalar,Vec,Vec);
    642: PETSC_EXTERN PetscErrorCode MatSetValuesLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
    643: PETSC_EXTERN PetscErrorCode MatSetValuesBlockedLocal(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[],const PetscScalar[],InsertMode);

    645: PETSC_EXTERN PetscErrorCode MatStashSetInitialSize(Mat,PetscInt,PetscInt);
    646: PETSC_EXTERN PetscErrorCode MatStashGetInfo(Mat,PetscInt*,PetscInt*,PetscInt*,PetscInt*);

    648: PETSC_EXTERN PetscErrorCode MatInterpolate(Mat,Vec,Vec);
    649: PETSC_EXTERN PetscErrorCode MatInterpolateAdd(Mat,Vec,Vec,Vec);
    650: PETSC_EXTERN PetscErrorCode MatRestrict(Mat,Vec,Vec);
    651: PETSC_EXTERN PetscErrorCode MatCreateVecs(Mat,Vec*,Vec*);
    652: 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);}
    653: PETSC_EXTERN PetscErrorCode MatCreateRedundantMatrix(Mat,PetscInt,MPI_Comm,MatReuse,Mat*);
    654: PETSC_EXTERN PetscErrorCode MatGetMultiProcBlock(Mat,MPI_Comm,MatReuse,Mat*);
    655: PETSC_EXTERN PetscErrorCode MatFindZeroDiagonals(Mat,IS*);
    656: PETSC_EXTERN PetscErrorCode MatFindOffBlockDiagonalEntries(Mat,IS*);
    657: PETSC_EXTERN PetscErrorCode MatCreateMPIMatConcatenateSeqMat(MPI_Comm,Mat,PetscInt,MatReuse,Mat*);

    659: /*MC
    660:    MatSetValue - Set a single entry into a matrix.

    662:    Not collective

    664:    Synopsis:
    665:      #include <petscmat.h>
    666:      PetscErrorCode MatSetValue(Mat m,PetscInt row,PetscInt col,PetscScalar value,InsertMode mode)

    668:    Input Parameters:
    669: +  m - the matrix
    670: .  row - the row location of the entry
    671: .  col - the column location of the entry
    672: .  value - the value to insert
    673: -  mode - either INSERT_VALUES or ADD_VALUES

    675:    Notes:
    676:    For efficiency one should use MatSetValues() and set several or many
    677:    values simultaneously if possible.

    679:    Level: beginner

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

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

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

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

    693:    Synopsis:
    694:    #include <petscmat.h>
    695:    PetscErrorCode MatPreallocateInitialize(MPI_Comm comm, PetscInt nrows, PetscInt ncols, PetscInt *dnz, PetscInt *onz)

    697:    Collective

    699:    Input Parameters:
    700: +  comm - the communicator that will share the eventually allocated matrix
    701: .  nrows - the number of LOCAL rows in the matrix
    702: -  ncols - the number of LOCAL columns in the matrix

    704:    Output Parameters:
    705: +  dnz - the array that will be passed to the matrix preallocation routines
    706: -  onz - the other array passed to the matrix preallocation routines

    708:    Level: intermediate

    710:    Notes:
    711:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

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

    717: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
    718:           MatPreallocateSymmetricSetLocalBlock()
    719: M*/
    720: #define MatPreallocateInitialize(comm,nrows,ncols,dnz,onz) 0; \
    721: do { \
    722:   PetscErrorCode _4_ierr; PetscInt __nrows = (nrows),__ncols = (ncols),__rstart,__start,__end; \
    723:   _4_PetscCalloc2((size_t)__nrows,&dnz,(size_t)__nrows,&onz);CHKERRQ(_4_ierr); \
    724:   __start = 0; __end = __start;                                         \
    725:   _4_MPI_Scan(&__ncols,&__end,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __start = __end - __ncols;\
    726:   _4_MPI_Scan(&__nrows,&__rstart,1,MPIU_INT,MPI_SUM,comm);CHKERRQ(_4_ierr); __rstart = __rstart - __nrows; \
    727:   do { } while(0)

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

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

    737:    Not Collective

    739:    Input Parameters:
    740: +  map - the row mapping from local numbering to global numbering
    741: .  nrows - the number of rows indicated
    742: .  rows - the indices of the rows
    743: .  cmap - the column mapping from local to global numbering
    744: .  ncols - the number of columns in the matrix
    745: .  cols - the columns indicated
    746: .  dnz - the array that will be passed to the matrix preallocation routines
    747: -  onz - the other array passed to the matrix preallocation routines

    749:    Level: intermediate

    751:    Notes:
    752:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

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

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

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

    777:    Not Collective

    779:    Input Parameters:
    780: +  map - the row mapping from local numbering to global numbering
    781: .  nrows - the number of rows indicated
    782: .  rows - the indices of the rows (these values are mapped to the global values)
    783: .  cmap - the column mapping from local to global numbering
    784: .  ncols - the number of columns in the matrix   (this value will be changed if duplicate columns are found)
    785: .  cols - the columns indicated (these values are mapped to the global values, they are then sorted and duplicates removed)
    786: .  dnz - the array that will be passed to the matrix preallocation routines
    787: -  onz - the other array passed to the matrix preallocation routines

    789:    Level: intermediate

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

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

    796: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
    797:           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal()
    798: M*/
    799: #define MatPreallocateSetLocalRemoveDups(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
    800: do {\
    801:   PetscInt __l;\
    802:   _4_ISLocalToGlobalMappingApply(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
    803:   _4_ISLocalToGlobalMappingApply(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
    804:   _4_PetscSortRemoveDupsInt(&ncols,cols);CHKERRQ(_4_ierr);\
    805:   for (__l=0;__l<nrows;__l++) {\
    806:     _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
    807:   }\
    808:  } while (0)

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

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

    818:    Not Collective

    820:    Input Parameters:
    821: +  map - the row mapping from local numbering to global numbering
    822: .  nrows - the number of rows indicated
    823: .  rows - the indices of the rows
    824: .  cmap - the column mapping from local to global numbering
    825: .  ncols - the number of columns in the matrix
    826: .  cols - the columns indicated
    827: .  dnz - the array that will be passed to the matrix preallocation routines
    828: -  onz - the other array passed to the matrix preallocation routines

    830:    Level: intermediate

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

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

    837: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
    838:           MatPreallocateInitialize(), MatPreallocateSymmetricSetLocalBlock()
    839: M*/
    840: #define MatPreallocateSetLocalBlock(rmap,nrows,rows,cmap,ncols,cols,dnz,onz) 0; \
    841: do {\
    842:   PetscInt __l;\
    843:   _4_ISLocalToGlobalMappingApplyBlock(rmap,nrows,rows,rows);CHKERRQ(_4_ierr);\
    844:   _4_ISLocalToGlobalMappingApplyBlock(cmap,ncols,cols,cols);CHKERRQ(_4_ierr);\
    845:   for (__l=0;__l<nrows;__l++) {\
    846:     _4_MatPreallocateSet((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
    847:   }\
    848: } while (0)

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

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

    858:    Not Collective

    860:    Input Parameters:
    861: +  map - the mapping between local numbering and global numbering
    862: .  nrows - the number of rows indicated
    863: .  rows - the indices of the rows
    864: .  ncols - the number of columns in the matrix
    865: .  cols - the columns indicated
    866: .  dnz - the array that will be passed to the matrix preallocation routines
    867: -  onz - the other array passed to the matrix preallocation routines

    869:    Level: intermediate

    871:    Notes:
    872:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

    876: .seealso: MatPreallocateFinalize(), MatPreallocateSet()
    877:           MatPreallocateInitialize(),  MatPreallocateSetLocal()
    878: M*/
    879: #define MatPreallocateSymmetricSetLocalBlock(map,nrows,rows,ncols,cols,dnz,onz) 0;\
    880: do {\
    881:   PetscInt __l;\
    882:   _4_ISLocalToGlobalMappingApplyBlock(map,nrows,rows,rows);CHKERRQ(_4_ierr);\
    883:   _4_ISLocalToGlobalMappingApplyBlock(map,ncols,cols,cols);CHKERRQ(_4_ierr);\
    884:   for (__l=0;__l<nrows;__l++) {\
    885:     _4_MatPreallocateSymmetricSetBlock((rows)[__l],ncols,cols,dnz,onz);CHKERRQ(_4_ierr);\
    886:   }\
    887: } while (0)

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

    893:    Synopsis:
    894:    #include <petscmat.h>
    895:    PetscErrorCode MatPreallocateSet(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

    897:    Not Collective

    899:    Input Parameters:
    900: +  row - the row
    901: .  ncols - the number of columns in the matrix
    902: -  cols - the columns indicated

    904:    Output Parameters:
    905: +  dnz - the array that will be passed to the matrix preallocation routines
    906: -  onz - the other array passed to the matrix preallocation routines

    908:    Level: intermediate

    910:    Notes:
    911:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

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

    917: .seealso: MatPreallocateFinalize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock()
    918:           MatPreallocateInitialize(), MatPreallocateSetLocal()
    919: M*/
    920: #define MatPreallocateSet(row,nc,cols,dnz,onz) 0;\
    921: do { PetscInt __i; \
    922:   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);\
    923:   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);\
    924:   for (__i=0; __i<nc; __i++) {\
    925:     if ((cols)[__i] < __start || (cols)[__i] >= __end) onz[row - __rstart]++; \
    926:     else if (dnz[row - __rstart] < __ncols) dnz[row - __rstart]++;\
    927:   }\
    928: } while (0)

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

    934:    Synopsis:
    935:    #include <petscmat.h>
    936:    PetscErrorCode MatPreallocateSymmetricSetBlock(PetscInt nrows, PetscInt *rows,PetscInt ncols, PetscInt *cols,PetscInt *dnz, PetscInt *onz)

    938:    Not Collective

    940:    Input Parameters:
    941: +  nrows - the number of rows indicated
    942: .  rows - the indices of the rows
    943: .  ncols - the number of columns in the matrix
    944: .  cols - the columns indicated
    945: .  dnz - the array that will be passed to the matrix preallocation routines
    946: -  onz - the other array passed to the matrix preallocation routines

    948:    Level: intermediate

    950:    Notes:
    951:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

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

    957: .seealso: MatPreallocateFinalize(), MatPreallocateSet(),  MatPreallocateInitialize(),
    958:           MatPreallocateSymmetricSetLocalBlock(), MatPreallocateSetLocal()
    959: M*/
    960: #define MatPreallocateSymmetricSetBlock(row,nc,cols,dnz,onz) 0;\
    961: do { PetscInt __i; \
    962:   for (__i=0; __i<nc; __i++) {\
    963:     if (cols[__i] >= __end) onz[row - __rstart]++; \
    964:     else if (cols[__i] >= row && dnz[row - __rstart] < __ncols) dnz[row - __rstart]++;\
    965:   }\
    966: } while (0)

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

    971:    Synopsis:
    972:    #include <petscmat.h>
    973:    PetscErrorCode MatPreallocateLocations(Mat A,PetscInt row,PetscInt ncols,PetscInt *cols,PetscInt *dnz,PetscInt *onz)

    975:    Not Collective

    977:    Input Parameters:
    978: +  A - matrix
    979: .  row - row where values exist (must be local to this process)
    980: .  ncols - number of columns
    981: .  cols - columns with nonzeros
    982: .  dnz - the array that will be passed to the matrix preallocation routines
    983: -  onz - the other array passed to the matrix preallocation routines

    985:    Level: intermediate

    987:    Notes:
    988:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

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

    994: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
    995:           MatPreallocateSymmetricSetLocalBlock()
    996: M*/
    997: #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)

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

    1004:    Synopsis:
    1005:    #include <petscmat.h>
    1006:    PetscErrorCode MatPreallocateFinalize(PetscInt *dnz, PetscInt *onz)

    1008:    Collective

    1010:    Input Parameters:
    1011: +  dnz - the array that was be passed to the matrix preallocation routines
    1012: -  onz - the other array passed to the matrix preallocation routines

    1014:    Level: intermediate

    1016:    Notes:
    1017:     See Users-Manual: Chapter 14 Hints for Performance Tuning for more details.

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

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

    1023: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
    1024:           MatPreallocateSymmetricSetLocalBlock()
    1025: M*/
    1026: #define MatPreallocateFinalize(dnz,onz) 0;_4_PetscFree2(dnz,onz);CHKERRQ(_4_ierr);} while(0)

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

    1031: PETSC_EXTERN PetscErrorCode MatInodeAdjustForInodes(Mat,IS*,IS*);
    1032: PETSC_EXTERN PetscErrorCode MatInodeGetInodeSizes(Mat,PetscInt *,PetscInt *[],PetscInt *);

    1034: PETSC_EXTERN PetscErrorCode MatSeqAIJSetColumnIndices(Mat,PetscInt[]);
    1035: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetColumnIndices(Mat,PetscInt[]);
    1036: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
    1037: PETSC_EXTERN PetscErrorCode MatCreateSeqBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
    1038: PETSC_EXTERN PetscErrorCode MatCreateSeqSBAIJWithArrays(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*);
    1039: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJFromTriple(MPI_Comm,PetscInt,PetscInt,PetscInt[],PetscInt[],PetscScalar[],Mat*,PetscInt,PetscBool);

    1041: #define MAT_SKIP_ALLOCATION -4

    1043: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
    1044: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[]);
    1045: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocation(Mat,PetscInt,const PetscInt[]);

    1047: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
    1048: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetPreallocation(Mat,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
    1049: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
    1050: PETSC_EXTERN PetscErrorCode MatSeqAIJSetPreallocationCSR(Mat,const PetscInt [],const PetscInt [],const PetscScalar []);
    1051: PETSC_EXTERN PetscErrorCode MatSeqBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
    1052: PETSC_EXTERN PetscErrorCode MatMPIAIJSetPreallocationCSR(Mat,const PetscInt[],const PetscInt[],const PetscScalar[]);
    1053: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetPreallocationCSR(Mat,PetscInt,const PetscInt[],const PetscInt[],const PetscScalar[]);
    1054: PETSC_EXTERN PetscErrorCode MatMPIAdjSetPreallocation(Mat,PetscInt[],PetscInt[],PetscInt[]);
    1055: PETSC_EXTERN PetscErrorCode MatMPIAdjToSeq(Mat,Mat*);
    1056: PETSC_EXTERN PetscErrorCode MatMPIDenseSetPreallocation(Mat,PetscScalar[]);
    1057: PETSC_EXTERN PetscErrorCode MatSeqDenseSetPreallocation(Mat,PetscScalar[]);
    1058: PETSC_EXTERN PetscErrorCode MatMPIAIJGetSeqAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
    1059: PETSC_EXTERN PetscErrorCode MatMPIBAIJGetSeqBAIJ(Mat,Mat*,Mat*,const PetscInt*[]);
    1060: PETSC_EXTERN PetscErrorCode MatMPIAdjCreateNonemptySubcommMat(Mat,Mat*);

    1062: PETSC_EXTERN PetscErrorCode MatSeqDenseSetLDA(Mat,PetscInt);
    1063: PETSC_EXTERN PetscErrorCode MatDenseGetLDA(Mat,PetscInt*);
    1064: PETSC_EXTERN PetscErrorCode MatDenseGetLocalMatrix(Mat,Mat*);

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

    1068: PETSC_EXTERN PetscErrorCode MatStoreValues(Mat);
    1069: PETSC_EXTERN PetscErrorCode MatRetrieveValues(Mat);

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

    1073: PETSC_EXTERN PetscErrorCode MatFindNonzeroRows(Mat,IS*);
    1074: PETSC_EXTERN PetscErrorCode MatFindZeroRows(Mat,IS*);
    1075: /*
    1076:   These routines are not usually accessed directly, rather solving is
    1077:   done through the KSP and PC interfaces.
    1078: */

    1080: /*J
    1081:     MatOrderingType - String with the name of a PETSc matrix ordering

    1083:    Level: beginner

    1085: .seealso: MatGetOrdering()
    1086: J*/
    1087: typedef const char* MatOrderingType;
    1088: #define MATORDERINGNATURAL     "natural"
    1089: #define MATORDERINGND          "nd"
    1090: #define MATORDERING1WD         "1wd"
    1091: #define MATORDERINGRCM         "rcm"
    1092: #define MATORDERINGQMD         "qmd"
    1093: #define MATORDERINGROWLENGTH   "rowlength"
    1094: #define MATORDERINGWBM         "wbm"
    1095: #define MATORDERINGSPECTRAL    "spectral"
    1096: #define MATORDERINGAMD         "amd"            /* only works if UMFPACK is installed with PETSc */

    1098: PETSC_EXTERN PetscErrorCode MatGetOrdering(Mat,MatOrderingType,IS*,IS*);
    1099: PETSC_EXTERN PetscErrorCode MatGetOrderingList(PetscFunctionList*);
    1100: PETSC_EXTERN PetscErrorCode MatOrderingRegister(const char[],PetscErrorCode(*)(Mat,MatOrderingType,IS*,IS*));
    1101: PETSC_EXTERN PetscFunctionList MatOrderingList;

    1103: PETSC_EXTERN PetscErrorCode MatReorderForNonzeroDiagonal(Mat,PetscReal,IS,IS);
    1104: PETSC_EXTERN PetscErrorCode MatCreateLaplacian(Mat,PetscReal,PetscBool,Mat*);

    1106: /*S
    1107:     MatFactorShiftType - Numeric Shift.

    1109:    Level: beginner

    1111: S*/
    1112: typedef enum {MAT_SHIFT_NONE,MAT_SHIFT_NONZERO,MAT_SHIFT_POSITIVE_DEFINITE,MAT_SHIFT_INBLOCKS} MatFactorShiftType;
    1113: PETSC_EXTERN const char *const MatFactorShiftTypes[];
    1114: PETSC_EXTERN const char *const MatFactorShiftTypesDetail[];

    1116: /*S
    1117:     MatFactorError - indicates what type of error in matrix factor

    1119:     Level: beginner

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

    1124: .seealso: MatGetFactor()
    1125: S*/
    1126: typedef enum {MAT_FACTOR_NOERROR,MAT_FACTOR_STRUCT_ZEROPIVOT,MAT_FACTOR_NUMERIC_ZEROPIVOT,MAT_FACTOR_OUTMEMORY,MAT_FACTOR_OTHER} MatFactorError;

    1128: PETSC_EXTERN PetscErrorCode MatFactorGetError(Mat,MatFactorError*);
    1129: PETSC_EXTERN PetscErrorCode MatFactorClearError(Mat);
    1130: PETSC_EXTERN PetscErrorCode MatFactorGetErrorZeroPivot(Mat,PetscReal*,PetscInt*);

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

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

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

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

    1143:    Level: developer

    1145: .seealso: MatLUFactorSymbolic(), MatILUFactorSymbolic(), MatCholeskyFactorSymbolic(), MatICCFactorSymbolic(), MatICCFactor(),
    1146:           MatFactorInfoInitialize()

    1148: S*/
    1149: typedef struct {
    1150:   PetscReal     diagonal_fill;  /* force diagonal to fill in if initially not filled */
    1151:   PetscReal     usedt;
    1152:   PetscReal     dt;             /* drop tolerance */
    1153:   PetscReal     dtcol;          /* tolerance for pivoting */
    1154:   PetscReal     dtcount;        /* maximum nonzeros to be allowed per row */
    1155:   PetscReal     fill;           /* expected fill, nonzeros in factored matrix/nonzeros in original matrix */
    1156:   PetscReal     levels;         /* ICC/ILU(levels) */
    1157:   PetscReal     pivotinblocks;  /* for BAIJ and SBAIJ matrices pivot in factorization on blocks, default 1.0
    1158:                                    factorization may be faster if do not pivot */
    1159:   PetscReal     zeropivot;      /* pivot is called zero if less than this */
    1160:   PetscReal     shifttype;      /* type of shift added to matrix factor to prevent zero pivots */
    1161:   PetscReal     shiftamount;     /* how large the shift is */
    1162: } MatFactorInfo;

    1164: PETSC_EXTERN PetscErrorCode MatFactorInfoInitialize(MatFactorInfo*);
    1165: PETSC_EXTERN PetscErrorCode MatCholeskyFactor(Mat,IS,const MatFactorInfo*);
    1166: PETSC_EXTERN PetscErrorCode MatCholeskyFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
    1167: PETSC_EXTERN PetscErrorCode MatCholeskyFactorNumeric(Mat,Mat,const MatFactorInfo*);
    1168: PETSC_EXTERN PetscErrorCode MatLUFactor(Mat,IS,IS,const MatFactorInfo*);
    1169: PETSC_EXTERN PetscErrorCode MatILUFactor(Mat,IS,IS,const MatFactorInfo*);
    1170: PETSC_EXTERN PetscErrorCode MatLUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
    1171: PETSC_EXTERN PetscErrorCode MatILUFactorSymbolic(Mat,Mat,IS,IS,const MatFactorInfo*);
    1172: PETSC_EXTERN PetscErrorCode MatICCFactorSymbolic(Mat,Mat,IS,const MatFactorInfo*);
    1173: PETSC_EXTERN PetscErrorCode MatICCFactor(Mat,IS,const MatFactorInfo*);
    1174: PETSC_EXTERN PetscErrorCode MatLUFactorNumeric(Mat,Mat,const MatFactorInfo*);
    1175: PETSC_EXTERN PetscErrorCode MatGetInertia(Mat,PetscInt*,PetscInt*,PetscInt*);
    1176: PETSC_EXTERN PetscErrorCode MatSolve(Mat,Vec,Vec);
    1177: PETSC_EXTERN PetscErrorCode MatForwardSolve(Mat,Vec,Vec);
    1178: PETSC_EXTERN PetscErrorCode MatBackwardSolve(Mat,Vec,Vec);
    1179: PETSC_EXTERN PetscErrorCode MatSolveAdd(Mat,Vec,Vec,Vec);
    1180: PETSC_EXTERN PetscErrorCode MatSolveTranspose(Mat,Vec,Vec);
    1181: PETSC_EXTERN PetscErrorCode MatSolveTransposeAdd(Mat,Vec,Vec,Vec);
    1182: PETSC_EXTERN PetscErrorCode MatSolves(Mat,Vecs,Vecs);
    1183: PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat);

    1185: typedef enum {MAT_FACTOR_SCHUR_UNFACTORED, MAT_FACTOR_SCHUR_FACTORED, MAT_FACTOR_SCHUR_INVERTED} MatFactorSchurStatus;
    1186: PETSC_EXTERN PetscErrorCode MatFactorSetSchurIS(Mat,IS);
    1187: PETSC_EXTERN PetscErrorCode MatFactorGetSchurComplement(Mat,Mat*,MatFactorSchurStatus*);
    1188: PETSC_EXTERN PetscErrorCode MatFactorRestoreSchurComplement(Mat,Mat*,MatFactorSchurStatus);
    1189: PETSC_EXTERN PetscErrorCode MatFactorInvertSchurComplement(Mat);
    1190: PETSC_EXTERN PetscErrorCode MatFactorCreateSchurComplement(Mat,Mat*,MatFactorSchurStatus*);
    1191: PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplement(Mat,Vec,Vec);
    1192: PETSC_EXTERN PetscErrorCode MatFactorSolveSchurComplementTranspose(Mat,Vec,Vec);
    1193: PETSC_EXTERN PetscErrorCode MatFactorFactorizeSchurComplement(Mat);

    1195: /*E
    1196:     MatSORType - What type of (S)SOR to perform

    1198:     Level: beginner

    1200:    May be bitwise ORd together

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

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

    1206: .seealso: MatSOR()
    1207: E*/
    1208: typedef enum {SOR_FORWARD_SWEEP=1,SOR_BACKWARD_SWEEP=2,SOR_SYMMETRIC_SWEEP=3,
    1209:               SOR_LOCAL_FORWARD_SWEEP=4,SOR_LOCAL_BACKWARD_SWEEP=8,
    1210:               SOR_LOCAL_SYMMETRIC_SWEEP=12,SOR_ZERO_INITIAL_GUESS=16,
    1211:               SOR_EISENSTAT=32,SOR_APPLY_UPPER=64,SOR_APPLY_LOWER=128} MatSORType;
    1212: PETSC_EXTERN PetscErrorCode MatSOR(Mat,Vec,PetscReal,MatSORType,PetscReal,PetscInt,PetscInt,Vec);

    1214: /*
    1215:     These routines are for efficiently computing Jacobians via finite differences.
    1216: */

    1218: /*S
    1219:      MatColoring - Object for managing the coloring of matrices.

    1221:    Level: beginner

    1223: .seealso:  MatFDColoringCreate() ISColoring MatFDColoring
    1224: S*/
    1225: typedef struct _p_MatColoring* MatColoring;
    1226: /*J
    1227:     MatColoringType - String with the name of a PETSc matrix coloring

    1229:    Level: beginner

    1231: .seealso: MatColoringSetType(), MatColoring
    1232: J*/

    1234: typedef const  char*           MatColoringType;
    1235: #define MATCOLORINGJP      "jp"
    1236: #define MATCOLORINGPOWER   "power"
    1237: #define MATCOLORINGNATURAL "natural"
    1238: #define MATCOLORINGSL      "sl"
    1239: #define MATCOLORINGLF      "lf"
    1240: #define MATCOLORINGID      "id"
    1241: #define MATCOLORINGGREEDY  "greedy"

    1243: /*E
    1244:    MatColoringWeightType - Type of weight scheme

    1246:     Not Collective

    1248: +   MAT_COLORING_RANDOM  - Random weights
    1249: .   MAT_COLORING_LEXICAL - Lexical weighting based upon global numbering.
    1250: -   MAT_COLORING_LF      - Last-first weighting.

    1252:     Level: intermediate

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

    1258: PETSC_EXTERN PetscErrorCode MatColoringCreate(Mat,MatColoring*);
    1259: PETSC_EXTERN PetscErrorCode MatColoringGetDegrees(Mat,PetscInt,PetscInt*);
    1260: PETSC_EXTERN PetscErrorCode MatColoringDestroy(MatColoring*);
    1261: PETSC_EXTERN PetscErrorCode MatColoringView(MatColoring,PetscViewer);
    1262: PETSC_EXTERN PetscErrorCode MatColoringSetType(MatColoring,MatColoringType);
    1263: PETSC_EXTERN PetscErrorCode MatColoringSetFromOptions(MatColoring);
    1264: PETSC_EXTERN PetscErrorCode MatColoringSetDistance(MatColoring,PetscInt);
    1265: PETSC_EXTERN PetscErrorCode MatColoringGetDistance(MatColoring,PetscInt*);
    1266: PETSC_EXTERN PetscErrorCode MatColoringSetMaxColors(MatColoring,PetscInt);
    1267: PETSC_EXTERN PetscErrorCode MatColoringGetMaxColors(MatColoring,PetscInt*);
    1268: PETSC_EXTERN PetscErrorCode MatColoringApply(MatColoring,ISColoring*);
    1269: PETSC_EXTERN PetscErrorCode MatColoringRegister(const char[],PetscErrorCode(*)(MatColoring));
    1270: PETSC_EXTERN PetscErrorCode MatColoringPatch(Mat,PetscInt,PetscInt,ISColoringValue[],ISColoring*);
    1271: PETSC_EXTERN PetscErrorCode MatColoringSetWeightType(MatColoring,MatColoringWeightType);
    1272: PETSC_EXTERN PetscErrorCode MatColoringSetWeights(MatColoring,PetscReal*,PetscInt*);
    1273: PETSC_EXTERN PetscErrorCode MatColoringCreateWeights(MatColoring,PetscReal **,PetscInt **lperm);
    1274: PETSC_EXTERN PetscErrorCode MatColoringTest(MatColoring,ISColoring);
    1275: PETSC_DEPRECATED_FUNCTION("Use MatColoringTest() (since version 3.10)") PETSC_STATIC_INLINE PetscErrorCode MatColoringTestValid(MatColoring matcoloring,ISColoring iscoloring) {return MatColoringTest(matcoloring,iscoloring);}
    1276: PETSC_EXTERN PetscErrorCode MatISColoringTest(Mat,ISColoring);

    1278: /*S
    1279:      MatFDColoring - Object for computing a sparse Jacobian via finite differences
    1280:         and coloring

    1282:    Level: beginner

    1284: .seealso:  MatFDColoringCreate()
    1285: S*/
    1286: typedef struct _p_MatFDColoring* MatFDColoring;

    1288: PETSC_EXTERN PetscErrorCode MatFDColoringCreate(Mat,ISColoring,MatFDColoring *);
    1289: PETSC_EXTERN PetscErrorCode MatFDColoringDestroy(MatFDColoring*);
    1290: PETSC_EXTERN PetscErrorCode MatFDColoringView(MatFDColoring,PetscViewer);
    1291: PETSC_EXTERN PetscErrorCode MatFDColoringSetFunction(MatFDColoring,PetscErrorCode (*)(void),void*);
    1292: PETSC_EXTERN PetscErrorCode MatFDColoringGetFunction(MatFDColoring,PetscErrorCode (**)(void),void**);
    1293: PETSC_EXTERN PetscErrorCode MatFDColoringSetParameters(MatFDColoring,PetscReal,PetscReal);
    1294: PETSC_EXTERN PetscErrorCode MatFDColoringSetFromOptions(MatFDColoring);
    1295: PETSC_EXTERN PetscErrorCode MatFDColoringApply(Mat,MatFDColoring,Vec,void *);
    1296: PETSC_EXTERN PetscErrorCode MatFDColoringSetF(MatFDColoring,Vec);
    1297: PETSC_EXTERN PetscErrorCode MatFDColoringGetPerturbedColumns(MatFDColoring,PetscInt*,const PetscInt*[]);
    1298: PETSC_EXTERN PetscErrorCode MatFDColoringSetUp(Mat,ISColoring,MatFDColoring);
    1299: PETSC_EXTERN PetscErrorCode MatFDColoringSetBlockSize(MatFDColoring,PetscInt,PetscInt);
    1300: PETSC_EXTERN PetscErrorCode MatFDColoringSetValues(Mat,MatFDColoring,const PetscScalar*);

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

    1305:    Level: beginner

    1307: .seealso:  MatTransposeColoringCreate()
    1308: S*/
    1309: typedef struct _p_MatTransposeColoring* MatTransposeColoring;

    1311: PETSC_EXTERN PetscErrorCode MatTransposeColoringCreate(Mat,ISColoring,MatTransposeColoring *);
    1312: PETSC_EXTERN PetscErrorCode MatTransColoringApplySpToDen(MatTransposeColoring,Mat,Mat);
    1313: PETSC_EXTERN PetscErrorCode MatTransColoringApplyDenToSp(MatTransposeColoring,Mat,Mat);
    1314: PETSC_EXTERN PetscErrorCode MatTransposeColoringDestroy(MatTransposeColoring*);

    1316: /*
    1317:     These routines are for partitioning matrices: currently used only
    1318:   for adjacency matrix, MatCreateMPIAdj().
    1319: */

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

    1324:    Level: beginner

    1326: .seealso:  MatPartitioningCreate(), MatPartitioningType
    1327: S*/
    1328: typedef struct _p_MatPartitioning* MatPartitioning;

    1330: /*J
    1331:     MatPartitioningType - String with the name of a PETSc matrix partitioning

    1333:    Level: beginner
    1334: dm
    1335: .seealso: MatPartitioningCreate(), MatPartitioning
    1336: J*/
    1337: typedef const char* MatPartitioningType;
    1338: #define MATPARTITIONINGCURRENT  "current"
    1339: #define MATPARTITIONINGAVERAGE   "average"
    1340: #define MATPARTITIONINGSQUARE   "square"
    1341: #define MATPARTITIONINGPARMETIS "parmetis"
    1342: #define MATPARTITIONINGCHACO    "chaco"
    1343: #define MATPARTITIONINGPARTY    "party"
    1344: #define MATPARTITIONINGPTSCOTCH "ptscotch"
    1345: #define MATPARTITIONINGHIERARCH  "hierarch"

    1348: PETSC_EXTERN PetscErrorCode MatPartitioningCreate(MPI_Comm,MatPartitioning*);
    1349: PETSC_EXTERN PetscErrorCode MatPartitioningSetType(MatPartitioning,MatPartitioningType);
    1350: PETSC_EXTERN PetscErrorCode MatPartitioningSetNParts(MatPartitioning,PetscInt);
    1351: PETSC_EXTERN PetscErrorCode MatPartitioningSetAdjacency(MatPartitioning,Mat);
    1352: PETSC_EXTERN PetscErrorCode MatPartitioningSetVertexWeights(MatPartitioning,const PetscInt[]);
    1353: PETSC_EXTERN PetscErrorCode MatPartitioningSetPartitionWeights(MatPartitioning,const PetscReal []);
    1354: PETSC_EXTERN PetscErrorCode MatPartitioningSetUseEdgeWeights(MatPartitioning,PetscBool);
    1355: PETSC_EXTERN PetscErrorCode MatPartitioningGetUseEdgeWeights(MatPartitioning,PetscBool*);
    1356: PETSC_EXTERN PetscErrorCode MatPartitioningApply(MatPartitioning,IS*);
    1357: PETSC_EXTERN PetscErrorCode MatPartitioningImprove(MatPartitioning,IS*);
    1358: PETSC_EXTERN PetscErrorCode MatPartitioningViewImbalance(MatPartitioning,IS);
    1359: PETSC_EXTERN PetscErrorCode MatPartitioningApplyND(MatPartitioning,IS*);
    1360: PETSC_EXTERN PetscErrorCode MatPartitioningDestroy(MatPartitioning*);

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

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

    1369: PETSC_EXTERN PetscErrorCode MatPartitioningSetFromOptions(MatPartitioning);
    1370: PETSC_EXTERN PetscErrorCode MatPartitioningGetType(MatPartitioning,MatPartitioningType*);

    1372: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetRepartition(MatPartitioning part);
    1373: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisSetCoarseSequential(MatPartitioning);
    1374: PETSC_EXTERN PetscErrorCode MatPartitioningParmetisGetEdgeCut(MatPartitioning, PetscInt *);

    1376: typedef enum { MP_CHACO_MULTILEVEL=1,MP_CHACO_SPECTRAL=2,MP_CHACO_LINEAR=4,MP_CHACO_RANDOM=5,MP_CHACO_SCATTERED=6 } MPChacoGlobalType;
    1377: PETSC_EXTERN const char *const MPChacoGlobalTypes[];
    1378: typedef enum { MP_CHACO_KERNIGHAN=1,MP_CHACO_NONE=2 } MPChacoLocalType;
    1379: PETSC_EXTERN const char *const MPChacoLocalTypes[];
    1380: typedef enum { MP_CHACO_LANCZOS=0,MP_CHACO_RQI=1 } MPChacoEigenType;
    1381: PETSC_EXTERN const char *const MPChacoEigenTypes[];

    1383: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetGlobal(MatPartitioning,MPChacoGlobalType);
    1384: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetGlobal(MatPartitioning,MPChacoGlobalType*);
    1385: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetLocal(MatPartitioning,MPChacoLocalType);
    1386: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetLocal(MatPartitioning,MPChacoLocalType*);
    1387: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetCoarseLevel(MatPartitioning,PetscReal);
    1388: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenSolver(MatPartitioning,MPChacoEigenType);
    1389: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenSolver(MatPartitioning,MPChacoEigenType*);
    1390: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenTol(MatPartitioning,PetscReal);
    1391: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenTol(MatPartitioning,PetscReal*);
    1392: PETSC_EXTERN PetscErrorCode MatPartitioningChacoSetEigenNumber(MatPartitioning,PetscInt);
    1393: PETSC_EXTERN PetscErrorCode MatPartitioningChacoGetEigenNumber(MatPartitioning,PetscInt*);

    1395: #define MP_PARTY_OPT "opt"
    1396: #define MP_PARTY_LIN "lin"
    1397: #define MP_PARTY_SCA "sca"
    1398: #define MP_PARTY_RAN "ran"
    1399: #define MP_PARTY_GBF "gbf"
    1400: #define MP_PARTY_GCF "gcf"
    1401: #define MP_PARTY_BUB "bub"
    1402: #define MP_PARTY_DEF "def"
    1403: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetGlobal(MatPartitioning,const char*);
    1404: #define MP_PARTY_HELPFUL_SETS "hs"
    1405: #define MP_PARTY_KERNIGHAN_LIN "kl"
    1406: #define MP_PARTY_NONE "no"
    1407: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetLocal(MatPartitioning,const char*);
    1408: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetCoarseLevel(MatPartitioning,PetscReal);
    1409: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetBipart(MatPartitioning,PetscBool);
    1410: PETSC_EXTERN PetscErrorCode MatPartitioningPartySetMatchOptimization(MatPartitioning,PetscBool);

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

    1415: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetImbalance(MatPartitioning,PetscReal);
    1416: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetImbalance(MatPartitioning,PetscReal*);
    1417: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchSetStrategy(MatPartitioning,MPPTScotchStrategyType);
    1418: PETSC_EXTERN PetscErrorCode MatPartitioningPTScotchGetStrategy(MatPartitioning,MPPTScotchStrategyType*);

    1420: /*
    1421:  * hierarchical partitioning
    1422:  */
    1423: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetFineparts(MatPartitioning,IS*);
    1424: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalGetCoarseparts(MatPartitioning,IS*);
    1425: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNcoarseparts(MatPartitioning,PetscInt);
    1426: PETSC_EXTERN PetscErrorCode MatPartitioningHierarchicalSetNfineparts(MatPartitioning, PetscInt);

    1428: PETSC_EXTERN PetscErrorCode MatMeshToVertexGraph(Mat,PetscInt,Mat*);
    1429: PETSC_EXTERN PetscErrorCode MatMeshToCellGraph(Mat,PetscInt,Mat*);

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

    1586: PETSC_EXTERN PetscErrorCode MatShellSetOperation(Mat,MatOperation,void(*)(void));
    1587: PETSC_EXTERN PetscErrorCode MatShellGetOperation(Mat,MatOperation,void(**)(void));
    1588: PETSC_EXTERN PetscErrorCode MatShellSetContext(Mat,void*);
    1589: PETSC_EXTERN PetscErrorCode MatShellTestMult(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*);
    1590: PETSC_EXTERN PetscErrorCode MatShellTestMultTranspose(Mat,PetscErrorCode (*)(void*,Vec,Vec),Vec,void*,PetscBool*);
    1591: PETSC_EXTERN PetscErrorCode MatShellSetManageScalingShifts(Mat);

    1593: /*
    1594:    Codes for matrices stored on disk. By default they are
    1595:    stored in a universal format. By changing the format with
    1596:    PetscViewerPushFormat(viewer,PETSC_VIEWER_NATIVE); the matrices will
    1597:    be stored in a way natural for the matrix, for example dense matrices
    1598:    would be stored as dense. Matrices stored this way may only be
    1599:    read into matrices of the same type.
    1600: */
    1601: #define MATRIX_BINARY_FORMAT_DENSE -1

    1603: PETSC_EXTERN PetscErrorCode MatMPIBAIJSetHashTableFactor(Mat,PetscReal);

    1605: PETSC_EXTERN PetscErrorCode MatISSetLocalMatType(Mat,MatType);
    1606: PETSC_EXTERN PetscErrorCode MatISSetPreallocation(Mat,PetscInt,const PetscInt[],PetscInt,const PetscInt[]);
    1607: PETSC_EXTERN PetscErrorCode MatISStoreL2L(Mat,PetscBool);
    1608: PETSC_EXTERN PetscErrorCode MatISFixLocalEmpty(Mat,PetscBool);
    1609: PETSC_EXTERN PetscErrorCode MatISGetLocalMat(Mat,Mat*);
    1610: PETSC_EXTERN PetscErrorCode MatISRestoreLocalMat(Mat,Mat*);
    1611: PETSC_EXTERN PetscErrorCode MatISSetLocalMat(Mat,Mat);
    1612: PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use the MatConvert() interface (since version 3.10)") PetscErrorCode MatISGetMPIXAIJ(Mat,MatReuse,Mat*);

    1614: /*S
    1615:      MatNullSpace - Object that removes a null space from a vector, i.e.
    1616:          orthogonalizes the vector to a subsapce

    1618:    Level: advanced

    1620:   Users manual sections:
    1621: .   Section 4.19 Solving Singular Systems

    1623: .seealso:  MatNullSpaceCreate()
    1624: S*/
    1625: typedef struct _p_MatNullSpace* MatNullSpace;

    1627: PETSC_EXTERN PetscErrorCode MatNullSpaceCreate(MPI_Comm,PetscBool ,PetscInt,const Vec[],MatNullSpace*);
    1628: PETSC_EXTERN PetscErrorCode MatNullSpaceSetFunction(MatNullSpace,PetscErrorCode (*)(MatNullSpace,Vec,void*),void*);
    1629: PETSC_EXTERN PetscErrorCode MatNullSpaceDestroy(MatNullSpace*);
    1630: PETSC_EXTERN PetscErrorCode MatNullSpaceRemove(MatNullSpace,Vec);
    1631: PETSC_EXTERN PetscErrorCode MatGetNullSpace(Mat, MatNullSpace *);
    1632: PETSC_EXTERN PetscErrorCode MatGetTransposeNullSpace(Mat, MatNullSpace *);
    1633: PETSC_EXTERN PetscErrorCode MatSetTransposeNullSpace(Mat,MatNullSpace);
    1634: PETSC_EXTERN PetscErrorCode MatSetNullSpace(Mat,MatNullSpace);
    1635: PETSC_EXTERN PetscErrorCode MatSetNearNullSpace(Mat,MatNullSpace);
    1636: PETSC_EXTERN PetscErrorCode MatGetNearNullSpace(Mat,MatNullSpace*);
    1637: PETSC_EXTERN PetscErrorCode MatNullSpaceTest(MatNullSpace,Mat,PetscBool  *);
    1638: PETSC_EXTERN PetscErrorCode MatNullSpaceView(MatNullSpace,PetscViewer);
    1639: PETSC_EXTERN PetscErrorCode MatNullSpaceGetVecs(MatNullSpace,PetscBool*,PetscInt*,const Vec**);
    1640: PETSC_EXTERN PetscErrorCode MatNullSpaceCreateRigidBody(Vec,MatNullSpace*);

    1642: PETSC_EXTERN PetscErrorCode MatReorderingSeqSBAIJ(Mat,IS);
    1643: PETSC_EXTERN PetscErrorCode MatMPISBAIJSetHashTableFactor(Mat,PetscReal);
    1644: PETSC_EXTERN PetscErrorCode MatSeqSBAIJSetColumnIndices(Mat,PetscInt *);
    1645: PETSC_EXTERN PetscErrorCode MatSeqBAIJInvertBlockDiagonal(Mat);

    1647: PETSC_EXTERN PetscErrorCode MatCreateMAIJ(Mat,PetscInt,Mat*);
    1648: PETSC_EXTERN PetscErrorCode MatMAIJRedimension(Mat,PetscInt,Mat*);
    1649: PETSC_EXTERN PetscErrorCode MatMAIJGetAIJ(Mat,Mat*);

    1651: PETSC_EXTERN PetscErrorCode MatComputeOperator(Mat,MatType,Mat*);
    1652: PETSC_EXTERN PetscErrorCode MatComputeOperatorTranspose(Mat,MatType,Mat*);

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

    1657: PETSC_EXTERN PetscErrorCode MatCreateKAIJ(Mat,PetscInt,PetscInt,const PetscScalar[],const PetscScalar[],Mat*);
    1658: PETSC_EXTERN PetscErrorCode MatKAIJGetAIJ(Mat,Mat*);
    1659: PETSC_EXTERN PetscErrorCode MatKAIJGetS(Mat,PetscInt*,PetscInt*,PetscScalar**);
    1660: PETSC_EXTERN PetscErrorCode MatKAIJGetSRead(Mat,PetscInt*,PetscInt*,const PetscScalar**);
    1661: PETSC_EXTERN PetscErrorCode MatKAIJRestoreS(Mat,PetscScalar**);
    1662: PETSC_EXTERN PetscErrorCode MatKAIJRestoreSRead(Mat,const PetscScalar**);
    1663: PETSC_EXTERN PetscErrorCode MatKAIJGetT(Mat,PetscInt*,PetscInt*,PetscScalar**);
    1664: PETSC_EXTERN PetscErrorCode MatKAIJGetTRead(Mat,PetscInt*,PetscInt*,const PetscScalar**);
    1665: PETSC_EXTERN PetscErrorCode MatKAIJRestoreT(Mat,PetscScalar**);
    1666: PETSC_EXTERN PetscErrorCode MatKAIJRestoreTRead(Mat,const PetscScalar**);
    1667: PETSC_EXTERN PetscErrorCode MatKAIJSetAIJ(Mat,Mat);
    1668: PETSC_EXTERN PetscErrorCode MatKAIJSetS(Mat,PetscInt,PetscInt,const PetscScalar []);
    1669: PETSC_EXTERN PetscErrorCode MatKAIJSetT(Mat,PetscInt,PetscInt,const PetscScalar []);

    1671: PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec);

    1673: PETSC_EXTERN PetscErrorCode MatCreateMFFD(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,Mat*);
    1674: PETSC_EXTERN PetscErrorCode MatMFFDSetBase(Mat,Vec,Vec);
    1675: PETSC_EXTERN PetscErrorCode MatMFFDSetFunction(Mat,PetscErrorCode(*)(void*,Vec,Vec),void*);
    1676: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioni(Mat,PetscErrorCode (*)(void*,PetscInt,Vec,PetscScalar*));
    1677: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctioniBase(Mat,PetscErrorCode (*)(void*,Vec));
    1678: PETSC_EXTERN PetscErrorCode MatMFFDSetHHistory(Mat,PetscScalar[],PetscInt);
    1679: PETSC_EXTERN PetscErrorCode MatMFFDResetHHistory(Mat);
    1680: PETSC_EXTERN PetscErrorCode MatMFFDSetFunctionError(Mat,PetscReal);
    1681: PETSC_EXTERN PetscErrorCode MatMFFDSetPeriod(Mat,PetscInt);
    1682: PETSC_EXTERN PetscErrorCode MatMFFDGetH(Mat,PetscScalar *);
    1683: PETSC_EXTERN PetscErrorCode MatMFFDSetOptionsPrefix(Mat,const char[]);
    1684: PETSC_EXTERN PetscErrorCode MatMFFDCheckPositivity(void*,Vec,Vec,PetscScalar*);
    1685: PETSC_EXTERN PetscErrorCode MatMFFDSetCheckh(Mat,PetscErrorCode (*)(void*,Vec,Vec,PetscScalar*),void*);

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

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

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

    1696:     Level: developer

    1698: .seealso: MATMFFD, MatCreateMFFD(), MatMFFDSetFuction(), MatMFFDSetType(), MatMFFDRegister()
    1699: S*/
    1700: typedef struct _p_MatMFFD* MatMFFD;

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

    1705:    Level: beginner

    1707: .seealso: MatMFFDSetType(), MatMFFDRegister()
    1708: J*/
    1709: typedef const char* MatMFFDType;
    1710: #define MATMFFD_DS  "ds"
    1711: #define MATMFFD_WP  "wp"

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

    1716: PETSC_EXTERN PetscErrorCode MatMFFDDSSetUmin(Mat,PetscReal);
    1717: PETSC_EXTERN PetscErrorCode MatMFFDWPSetComputeNormU(Mat,PetscBool );

    1719: PETSC_EXTERN PetscErrorCode MatFDColoringSetType(MatFDColoring,MatMFFDType);

    1721: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutMatrix(PetscViewer, PetscInt, PetscInt, PetscReal *);
    1722: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutCSRMatrix(PetscViewer, PetscInt, PetscInt, PetscInt *, PetscInt *, PetscReal *);

    1724: /*
    1725:    PETSc interface to MUMPS
    1726: */
    1727: #ifdef PETSC_HAVE_MUMPS
    1728: PETSC_EXTERN PetscErrorCode MatMumpsSetIcntl(Mat,PetscInt,PetscInt);
    1729: PETSC_EXTERN PetscErrorCode MatMumpsGetIcntl(Mat,PetscInt,PetscInt*);
    1730: PETSC_EXTERN PetscErrorCode MatMumpsSetCntl(Mat,PetscInt,PetscReal);
    1731: PETSC_EXTERN PetscErrorCode MatMumpsGetCntl(Mat,PetscInt,PetscReal*);

    1733: PETSC_EXTERN PetscErrorCode MatMumpsGetInfo(Mat,PetscInt,PetscInt*);
    1734: PETSC_EXTERN PetscErrorCode MatMumpsGetInfog(Mat,PetscInt,PetscInt*);
    1735: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfo(Mat,PetscInt,PetscReal*);
    1736: PETSC_EXTERN PetscErrorCode MatMumpsGetRinfog(Mat,PetscInt,PetscReal*);
    1737: PETSC_EXTERN PetscErrorCode MatMumpsGetInverse(Mat,Mat);
    1738: PETSC_EXTERN PetscErrorCode MatMumpsGetInverseTranspose(Mat,Mat);
    1739: #endif

    1741: /*
    1742:    PETSc interface to Mkl_Pardiso
    1743: */
    1744: #ifdef PETSC_HAVE_MKL_PARDISO
    1745: PETSC_EXTERN PetscErrorCode MatMkl_PardisoSetCntl(Mat,PetscInt,PetscInt);
    1746: #endif

    1748: /*
    1749:    PETSc interface to Mkl_CPardiso
    1750: */
    1751: #ifdef PETSC_HAVE_MKL_CPARDISO
    1752: PETSC_EXTERN PetscErrorCode MatMkl_CPardisoSetCntl(Mat,PetscInt,PetscInt);
    1753: #endif

    1755: /*
    1756:    PETSc interface to SUPERLU
    1757: */
    1758: #ifdef PETSC_HAVE_SUPERLU
    1759: PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal);
    1760: #endif

    1762: /*
    1763:    PETSc interface to SUPERLU_DIST
    1764: */
    1765: #ifdef PETSC_HAVE_SUPERLU_DIST
    1766: PETSC_EXTERN PetscErrorCode MatSuperluDistGetDiagU(Mat,PetscScalar*);
    1767: #endif

    1769: /*
    1770:    PETSc interface to STRUMPACK
    1771: */
    1772: #ifdef PETSC_HAVE_STRUMPACK
    1773: /*E
    1774:     MatSTRUMPACKReordering - sparsity reducing ordering to be used in STRUMPACK

    1776:     Level: intermediate
    1777: E*/
    1778: typedef enum {MAT_STRUMPACK_NATURAL=0,
    1779:               MAT_STRUMPACK_METIS=1,
    1780:               MAT_STRUMPACK_PARMETIS=2,
    1781:               MAT_STRUMPACK_SCOTCH=3,
    1782:               MAT_STRUMPACK_PTSCOTCH=4,
    1783:               MAT_STRUMPACK_RCM=5} MatSTRUMPACKReordering;
    1784: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetReordering(Mat,MatSTRUMPACKReordering);
    1785: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetColPerm(Mat,PetscBool);
    1786: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSRelTol(Mat,PetscReal);
    1787: PETSC_DEPRECATED_FUNCTION("Use MatSTRUMPACKSetHSSRelTol() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSTRUMPACKSetHSSRelCompTol(Mat mat,PetscReal rtol) {return MatSTRUMPACKSetHSSRelTol(mat,rtol);}
    1788: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSAbsTol(Mat,PetscReal);
    1789: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMinSepSize(Mat,PetscInt);
    1790: PETSC_DEPRECATED_FUNCTION("Use MatSTRUMPACKSetHSSMinSepSize() (since version 3.9)") PETSC_STATIC_INLINE PetscErrorCode MatSTRUMPACKSetHSSMinSize(Mat mat,PetscInt hssminsize) {return MatSTRUMPACKSetHSSMinSepSize(mat,hssminsize);}
    1791: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSMaxRank(Mat,PetscInt);
    1792: PETSC_EXTERN PetscErrorCode MatSTRUMPACKSetHSSLeafSize(Mat,PetscInt);
    1793: #endif

    1796: PETSC_EXTERN PetscErrorCode MatPinToCPU(Mat,PetscBool);

    1798: #ifdef PETSC_HAVE_CUDA
    1799: /*E
    1800:     MatCUSPARSEStorageFormat - indicates the storage format for CUSPARSE (GPU)
    1801:     matrices.

    1803:     Not Collective

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

    1809:     Level: intermediate

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

    1813: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEFormatOperation
    1814: E*/

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

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

    1821: /*E
    1822:     MatCUSPARSEFormatOperation - indicates the operation of CUSPARSE (GPU)
    1823:     matrices whose operation should use a particular storage format.

    1825:     Not Collective

    1827: +   MAT_CUSPARSE_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult
    1828: .   MAT_CUSPARSE_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult
    1829: .   MAT_CUSPARSE_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult
    1830: -   MAT_CUSPARSE_ALL - sets the storage format for all CUSPARSE (GPU) matrices

    1832:     Level: intermediate

    1834: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEStorageFormat
    1835: E*/
    1836: typedef enum {MAT_CUSPARSE_MULT_DIAG, MAT_CUSPARSE_MULT_OFFDIAG, MAT_CUSPARSE_MULT, MAT_CUSPARSE_ALL} MatCUSPARSEFormatOperation;

    1838: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
    1839: PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
    1840: PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat,MatCUSPARSEFormatOperation,MatCUSPARSEStorageFormat);
    1841: #endif

    1843: #if defined(PETSC_HAVE_VIENNACL)
    1844: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
    1845: PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
    1846: #endif

    1848: /*
    1849:    PETSc interface to FFTW
    1850: */
    1851: #if defined(PETSC_HAVE_FFTW)
    1852: PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec);
    1853: PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec);
    1854: PETSC_EXTERN PetscErrorCode MatCreateVecsFFTW(Mat,Vec*,Vec*,Vec*);
    1855: #endif

    1857: PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*);
    1858: PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*);
    1859: PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat,IS[],IS[]);
    1860: PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat,IS[],IS[]);
    1861: PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***);
    1862: PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*);
    1863: PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat,VecType);
    1864: PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]);
    1865: PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat);

    1867: PETSC_EXTERN PetscErrorCode MatChop(Mat,PetscReal);
    1868: PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat,PetscReal,PetscInt*);

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

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

    1874: PETSC_INTERN PetscErrorCode MatHeaderMerge(Mat,Mat*);
    1875: PETSC_EXTERN PetscErrorCode MatHeaderReplace(Mat,Mat*);

    1877: #endif