Actual source code: petscmat.h
petsc-3.6.2 2015-10-02
Report Typos and Errors

      1: /*
      2:      Include file for the matrix component of PETSc
      3: */
      4: #ifndef __PETSCMAT_H
      6: #include <petscvec.h>

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

     12:    Level: beginner

     14:   Concepts: matrix; linear operator

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

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

     23:    Level: beginner

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

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

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

     95:    Level: beginner

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

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

    123:     Level: beginner

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

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

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

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

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

    155:     Level: beginner

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

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

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

    167:     Level: beginner

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

    173: PETSC_EXTERN PetscErrorCode MatInitializePackage(void);

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

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

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

    195:     Level: beginner

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    281:    Level: beginner

    283:   Concepts: matrix; linear operator

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

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

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

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

    302:     Level: beginner

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

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

    316:     Level: beginner

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

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

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

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

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

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

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

    394:     Level: beginner

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

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

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

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

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

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

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

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

    430:    Level: intermediate

    432:   Concepts: matrix^nonzero information

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

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

    450:     Level: beginner

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    567:    Not collective

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

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

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

    584:    Level: beginner

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

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

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

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

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

    602:    Collective on MPI_Comm

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

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

    613:    Level: intermediate

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

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

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

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

    624:   Concepts: preallocation^Matrix

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

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

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

    645:    Not Collective

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

    657:    Level: intermediate

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

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

    664:   Concepts: preallocation^Matrix

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

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

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

    687:    Not Collective

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

    699:    Level: intermediate

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

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

    706:   Concepts: preallocation^Matrix

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

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

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

    729:    Not Collective

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

    740:    Level: intermediate

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

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

    747:   Concepts: preallocation^Matrix

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

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

    769:    Not Collective

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

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

    780:    Level: intermediate

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

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

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

    789:   Concepts: preallocation^Matrix

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

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

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

    812:    Not Collective

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

    822:    Level: intermediate

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

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

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

    831:   Concepts: preallocation^Matrix

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

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

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

    851:    Not Collective

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

    861:    Level: intermediate

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

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

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

    870:   Concepts: preallocation^Matrix

    872: .seealso: MatPreallocateInitialize(), MatPreallocateSet(), MatPreallocateSymmetricSetBlock(), MatPreallocateSetLocal(),
    873:           MatPreallocateSymmetricSetLocalBlock()
    874: M*/
    875: #define MatPreallocateLocation(A,row,ncols,cols,dnz,onz) 0;if (A) {MatSetValues(A,1,&row,ncols,cols,NULL,INSERT_VALUES);} else { MatPreallocateSet(row,ncols,cols,dnz,onz);}

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

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

    886:    Collective on MPI_Comm

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

    892:    Level: intermediate

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

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

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

    901:   Concepts: preallocation^Matrix

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

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

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

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

    921: #define MAT_SKIP_ALLOCATION -4

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

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

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

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

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

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

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

    959:    Level: beginner

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

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

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

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

    985:    Level: beginner

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

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

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

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

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

    1002:    Level: developer

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

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

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

    1043: PETSC_EXTERN PetscErrorCode MatSetUnfactored(Mat);

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

    1048:     Level: beginner

    1050:    May be bitwise ORd together

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

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

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

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

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

    1071:    Level: beginner

    1073:   Concepts: matrix, coloring

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

    1081:    Level: beginner

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

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

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

    1098:     Not Collective

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

    1104:     Level: intermediate

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

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

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

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

    1133:    Level: beginner

    1135:   Concepts: coloring, sparse Jacobian, finite differences

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

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

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

    1158:    Level: beginner

    1160:   Concepts: coloring, sparse matrix product

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

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

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

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

    1179:    Level: beginner

    1181:   Concepts: partitioning

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    1274:    Level: beginner

    1276:   Concepts: coarsen

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

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

    1285:    Level: beginner

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

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

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

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

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

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

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

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

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

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

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

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

    1509:    Level: advanced

    1511:   Concepts: matrix; linear operator, null space

    1513:   Users manual sections:
    1514: .   Section 4.19 Solving Singular Systems

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

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

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

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

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

    1546: PETSC_EXTERN PetscErrorCode MatDiagonalScaleLocal(Mat,Vec);

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

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

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

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

    1570:     Level: developer

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

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

    1579:    Level: beginner

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

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

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

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

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

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

    1610: PETSC_EXTERN PetscErrorCode MatMumpsSetSchurIndices(Mat,PetscInt,PetscInt[]);
    1611: PETSC_EXTERN PetscErrorCode MatMumpsInvertSchurComplement(Mat);
    1612: PETSC_EXTERN PetscErrorCode MatMumpsCreateSchurComplement(Mat,Mat*);
    1613: PETSC_EXTERN PetscErrorCode MatMumpsGetSchurComplement(Mat,Mat*);
    1614: PETSC_EXTERN PetscErrorCode MatMumpsRestoreSchurComplement(Mat,Mat*);
    1615: PETSC_EXTERN PetscErrorCode MatMumpsSolveSchurComplement(Mat,Vec,Vec);
    1616: PETSC_EXTERN PetscErrorCode MatMumpsSolveSchurComplementTranspose(Mat,Vec,Vec);
    1617: #endif

    1619: /*
    1620:    PETSc interface to Mkl_Pardiso
    1621: */
    1622: #ifdef PETSC_HAVE_MKL_PARDISO
    1623: PETSC_EXTERN PetscErrorCode MatMkl_PardisoSetCntl(Mat,PetscInt,PetscInt);
    1624: #endif

    1626: /*
    1627:    PETSc interface to Mkl_CPardiso
    1628: */
    1629: #ifdef PETSC_HAVE_MKL_CPARDISO
    1630: PETSC_EXTERN PetscErrorCode MatMkl_CPardisoSetCntl(Mat,PetscInt,PetscInt);
    1631: #endif

    1633: /*
    1634:    PETSc interface to SUPERLU
    1635: */
    1636: #ifdef PETSC_HAVE_SUPERLU
    1637: PETSC_EXTERN PetscErrorCode MatSuperluSetILUDropTol(Mat,PetscReal);
    1638: #endif

    1640: #ifdef PETSC_HAVE_CUDA
    1641: /*E
    1642:     MatCUSPARSEStorageFormat - indicates the storage format for CUSPARSE (GPU)
    1643:     matrices.

    1645:     Not Collective

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

    1651:     Level: intermediate

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

    1655: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEFormatOperation
    1656: E*/

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

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

    1663: /*E
    1664:     MatCUSPARSEFormatOperation - indicates the operation of CUSPARSE (GPU)
    1665:     matrices whose operation should use a particular storage format.

    1667:     Not Collective

    1669: +   MAT_CUSPARSE_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult
    1670: .   MAT_CUSPARSE_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult
    1671: .   MAT_CUSPARSE_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult
    1672: -   MAT_CUSPARSE_ALL - sets the storage format for all CUSPARSE (GPU) matrices

    1674:     Level: intermediate

    1676: .seealso: MatCUSPARSESetFormat(), MatCUSPARSEStorageFormat
    1677: E*/
    1678: typedef enum {MAT_CUSPARSE_MULT_DIAG, MAT_CUSPARSE_MULT_OFFDIAG, MAT_CUSPARSE_MULT, MAT_CUSPARSE_ALL} MatCUSPARSEFormatOperation;

    1680: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
    1681: PETSC_EXTERN PetscErrorCode MatCreateAIJCUSPARSE(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
    1682: PETSC_EXTERN PetscErrorCode MatCUSPARSESetFormat(Mat,MatCUSPARSEFormatOperation,MatCUSPARSEStorageFormat);
    1683: #endif

    1685: #if defined(PETSC_HAVE_CUSP)
    1686: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJCUSP(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
    1687: PETSC_EXTERN PetscErrorCode MatCreateAIJCUSP(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);

    1689: /*E
    1690:     MatCUSPStorageFormat - indicates the storage format for CUSP (GPU)
    1691:     matrices.

    1693:     Not Collective

    1695: +   MAT_CUSP_CSR - Compressed Sparse Row
    1696: .   MAT_CUSP_DIA - Diagonal
    1697: -   MAT_CUSP_ELL - Ellpack

    1699:     Level: intermediate

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

    1703: .seealso: MatCUSPSetFormat(), MatCUSPFormatOperation
    1704: E*/
    1705: typedef enum {MAT_CUSP_CSR, MAT_CUSP_DIA, MAT_CUSP_ELL} MatCUSPStorageFormat;

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

    1710: /*E
    1711:     MatCUSPFormatOperation - indicates the operation of CUSP (GPU)
    1712:     matrices whose operation should use a particular storage format.

    1714:     Not Collective

    1716: +   MAT_CUSP_MULT_DIAG - sets the storage format for the diagonal matrix in the parallel MatMult
    1717: .   MAT_CUSP_MULT_OFFDIAG - sets the storage format for the offdiagonal matrix in the parallel MatMult
    1718: .   MAT_CUSP_MULT - sets the storage format for the entire matrix in the serial (single GPU) MatMult
    1719: -   MAT_CUSP_ALL - sets the storage format for all CUSP (GPU) matrices

    1721:     Level: intermediate

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

    1725: .seealso: MatCUSPSetFormat(), MatCUSPStorageFormat
    1726: E*/
    1727: typedef enum {MAT_CUSP_MULT_DIAG, MAT_CUSP_MULT_OFFDIAG, MAT_CUSP_MULT, MAT_CUSP_ALL} MatCUSPFormatOperation;

    1729: PETSC_EXTERN PetscErrorCode MatCUSPSetFormat(Mat,MatCUSPFormatOperation,MatCUSPStorageFormat);
    1730: #endif

    1732: #if defined(PETSC_HAVE_VIENNACL)
    1733: PETSC_EXTERN PetscErrorCode MatCreateSeqAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Mat*);
    1734: PETSC_EXTERN PetscErrorCode MatCreateAIJViennaCL(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],PetscInt,const PetscInt[],Mat*);
    1735: #endif

    1737: /*
    1738:    PETSc interface to FFTW
    1739: */
    1740: #if defined(PETSC_HAVE_FFTW)
    1741: PETSC_EXTERN PetscErrorCode VecScatterPetscToFFTW(Mat,Vec,Vec);
    1742: PETSC_EXTERN PetscErrorCode VecScatterFFTWToPetsc(Mat,Vec,Vec);
    1743: PETSC_EXTERN PetscErrorCode MatCreateVecsFFTW(Mat,Vec*,Vec*,Vec*);
    1744: #endif

    1746: /*
    1747:    PETSc interface to ELEMENTAL
    1748: */
    1749: #if defined(PETSC_HAVE_ELEMENTAL)
    1750: #if defined(PETSC_USE_COMPLEX)
    1751: typedef El::Complex<PetscReal> PetscElemScalar;
    1752: #else
    1753: typedef PetscScalar PetscElemScalar;
    1754: #endif
    1755: PETSC_EXTERN PetscErrorCode PetscElementalInitializePackage(void);
    1756: PETSC_EXTERN PetscErrorCode PetscElementalFinalizePackage(void);
    1757: #endif

    1759: PETSC_EXTERN PetscErrorCode MatCreateNest(MPI_Comm,PetscInt,const IS[],PetscInt,const IS[],const Mat[],Mat*);
    1760: PETSC_EXTERN PetscErrorCode MatNestGetSize(Mat,PetscInt*,PetscInt*);
    1761: PETSC_EXTERN PetscErrorCode MatNestGetISs(Mat,IS[],IS[]);
    1762: PETSC_EXTERN PetscErrorCode MatNestGetLocalISs(Mat,IS[],IS[]);
    1763: PETSC_EXTERN PetscErrorCode MatNestGetSubMats(Mat,PetscInt*,PetscInt*,Mat***);
    1764: PETSC_EXTERN PetscErrorCode MatNestGetSubMat(Mat,PetscInt,PetscInt,Mat*);
    1765: PETSC_EXTERN PetscErrorCode MatNestSetVecType(Mat,VecType);
    1766: PETSC_EXTERN PetscErrorCode MatNestSetSubMats(Mat,PetscInt,const IS[],PetscInt,const IS[],const Mat[]);
    1767: PETSC_EXTERN PetscErrorCode MatNestSetSubMat(Mat,PetscInt,PetscInt,Mat);

    1769: PETSC_EXTERN PetscErrorCode MatChop(Mat,PetscReal);
    1770: PETSC_EXTERN PetscErrorCode MatComputeBandwidth(Mat,PetscReal,PetscInt*);

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

    1774: #endif