Mat Manual Pages#
PETSc matrices (Mat objects) are used to store Jacobians and other sparse matrices
in PDE-based (or other) simulations.
Beginner - Basic usage#
- MATAIJ
- MATAIJCRL
- MATAIJCUSPARSE
- MATAIJMKL
- MATAIJPERM
- MATAIJSELL
- MATAIJVIENNACL
- MATBAIJ
- MATBAIJMKL
- MATDENSE
- MATDENSECUDA
- MATELEMENTAL
- MATH2OPUS
- MATHTOOL
- MATMPIADJ
- MATMPIAIJ
- MATMPIAIJCUSPARSE
- MATMPIBAIJ
- MATMPIDENSE
- MATMPIDENSECUDA
- MATMPISBAIJ
- MATMPISELL
- MATSBAIJ
- MATSCALAPACK
- MATSELL
- MATSEQAIJ
- MATSEQAIJCUSPARSE
- MATSEQAIJKOKKOS
- MATSEQAIJVIENNACL
- MATSEQBAIJ
- MATSEQDENSE
- MATSEQDENSECUDA
- MATSEQSBAIJ
- MATSEQSELL
- MATSMPIAIJKOKKOS
- MATSOLVERCHOLMOD
- MATSOLVERCUSPARSE
- MATSOLVERESSL
- MATSOLVERKLU
- MATSOLVERKOKKOS
- MATSOLVERLUSOL
- MATSOLVERMATLAB
- MATSOLVERMKL_CPARDISO
- MATSOLVERMKL_PARDISO
- MATSOLVERMUMPS
- MATSOLVERPASTIX
- MATSOLVERSPARSEELEMENTAL
- MATSOLVERSPQR
- MATSOLVERSSTRUMPACK
- MATSOLVERSUPERLU
- MATSOLVERSUPERLU_DIST
- MATSOLVERUMFPACK
- Mat
- MatAssemblyBegin
- MatAssemblyEnd
- MatAssemblyType
- MatCoarsenType
- MatColoring
- MatColoringType
- MatComputeBandwidth
- MatCreate
- MatCreateSubMatrixOption
- MatDestroy
- MatDuplicateOption
- MatFDColoring
- MatFactorError
- MatFactorShiftType
- MatFactorType
- MatGetLocalSize
- MatGetOwnershipRange
- MatGetOwnershipRanges
- MatGetOwnershipRangesColumn
- MatGetSize
- MatHasCongruentLayouts
- MatHtoolClusteringType
- MatHtoolCompressorType
- MatInfoType
- MatLoad
- MatMFFDType
- MatMkl_PardisoSetCntl
- MatMult
- MatMultAdd
- MatMultHermitianTranspose
- MatMultHermitianTransposeAdd
- MatMultTranspose
- MatMultTransposeAdd
- MatMumpsGetCntl
- MatMumpsGetIcntl
- MatMumpsGetInfo
- MatMumpsGetInfog
- MatMumpsGetInverse
- MatMumpsGetInverseTranspose
- MatMumpsGetRinfo
- MatMumpsGetRinfog
- MatMumpsSetCntl
- MatMumpsSetIcntl
- MatOption
- MatOrderingType
- MatPartitioning
- MatPartitioningType
- MatProductAlgorithm
- MatProductType
- MatPropagateSymmetryOptions
- MatResetPreallocation
- MatReuse
- MatSORType
- MatSTRUMPACKSetColPerm
- MatSTRUMPACKSetHSSAbsTol
- MatSTRUMPACKSetHSSLeafSize
- MatSTRUMPACKSetHSSMaxRank
- MatSTRUMPACKSetHSSMinSepSize
- MatSTRUMPACKSetHSSRelTol
- MatSTRUMPACKSetReordering
- MatSetFromOptions
- MatSetPreallocationCOO
- MatSetPreallocationCOOLocal
- MatSetSizes
- MatSetStencil
- MatSetUp
- MatSetValue
- MatSetValues
- MatSetValuesBlockedStencil
- MatSetValuesCOO
- MatSetValuesIS
- MatSetValuesStencil
- MatSolverType
- MatStencil
- MatStructure
- MatSuperluSetILUDropTol
- MatTransposeColoring
- MatType
- MatView
- MatXAIJSetPreallocation
Intermediate - Setting options for algorithms and data structures#
- MATHYPRE
- MATMFFD_DS
- MATMFFD_WP
- MATNEST
- MATSOLVERBAS
- MatAXPY
- MatAYPX
- MatBindToCPU
- MatBlockMatSetPreallocation
- MatBoundToCPU
- MatCUSPARSEFormatOperation
- MatCUSPARSESetFormat
- MatCUSPARSESetUseCPUSolve
- MatCUSPARSEStorageFormat
- MatChop
- MatColoringWeightType
- MatConvert
- MatCopy
- MatCreateAIJ
- MatCreateAIJCUSPARSE
- MatCreateAIJKokkos
- MatCreateAIJViennaCL
- MatCreateBAIJ
- MatCreateBAIJMKL
- MatCreateBlockMat
- MatCreateCentering
- MatCreateDense
- MatCreateDenseCUDA
- MatCreateFFT
- MatCreateH2OpusFromKernel
- MatCreateH2OpusFromMat
- MatCreateHermitianTranspose
- MatCreateHtoolFromKernel
- MatCreateLRC
- MatCreateMPIAIJCRL
- MatCreateMPIAIJMKL
- MatCreateMPIAIJPERM
- MatCreateMPIAIJSELL
- MatCreateMPIAIJWithArrays
- MatCreateMPIAdj
- MatCreateMPIBAIJWithArrays
- MatCreateMPISBAIJWithArrays
- MatCreateNormal
- MatCreateNormalHermitian
- MatCreateSBAIJ
- MatCreateSELL
- MatCreateScaLAPACK
- MatCreateScatter
- MatCreateSeqAIJ
- MatCreateSeqAIJCRL
- MatCreateSeqAIJCUSPARSE
- MatCreateSeqAIJFromTriple
- MatCreateSeqAIJKokkos
- MatCreateSeqAIJMKL
- MatCreateSeqAIJPERM
- MatCreateSeqAIJSELL
- MatCreateSeqAIJViennaCL
- MatCreateSeqAIJWithArrays
- MatCreateSeqBAIJ
- MatCreateSeqBAIJMKL
- MatCreateSeqCUFFT
- MatCreateSeqDense
- MatCreateSeqDenseCUDA
- MatCreateSeqSBAIJ
- MatCreateSeqSELL
- MatCreateTranspose
- MatDenseGetArray
- MatDenseGetArrayRead
- MatDenseGetArrayWrite
- MatDenseGetColumn
- MatDenseGetColumnVec
- MatDenseGetColumnVecRead
- MatDenseGetColumnVecWrite
- MatDenseGetLDA
- MatDenseGetLocalMatrix
- MatDenseGetSubMatrix
- MatDenseRestoreArray
- MatDenseRestoreArrayRead
- MatDenseRestoreArrayWrite
- MatDenseRestoreColumn
- MatDenseRestoreColumnVec
- MatDenseRestoreColumnVecRead
- MatDenseRestoreColumnVecWrite
- MatDenseRestoreSubMatrix
- MatDenseSetLDA
- MatDiagonalScale
- MatDiagonalSet
- MatDuplicate
- MatEqual
- MatFDColoringSetValues
- MatFactorGetSolverType
- MatFindNonzeroRows
- MatFindZeroRows
- MatGetBlockSize
- MatGetBlockSizes
- MatGetColumnMeans
- MatGetColumnMeansImaginaryPart
- MatGetColumnMeansRealPart
- MatGetColumnNorms
- MatGetColumnSums
- MatGetColumnSumsImaginaryPart
- MatGetColumnSumsRealPart
- MatGetDiagonal
- MatGetFactor
- MatGetFactorAvailable
- MatGetFactorType
- MatGetInfo
- MatGetLocalSubMatrix
- MatGetNonzeroState
- MatGetOption
- MatGetOwnershipIS
- MatGetRowMax
- MatGetRowMaxAbs
- MatGetRowMin
- MatGetRowMinAbs
- MatGetRowSum
- MatGetSeqNonzeroStructure
- MatGetType
- MatGetVariableBlockSizes
- MatGetVecType
- MatH2OpusCompress
- MatH2OpusGetIndexMap
- MatH2OpusLowRankUpdate
- MatH2OpusMapVec
- MatH2OpusOrthogonalize
- MatH2OpusSetSamplingMat
- MatHYPRESetPreallocation
- MatHermitianTranspose
- MatHermitianTransposeGetMat
- MatISSetPreallocation
- MatInfo
- MatInterpolate
- MatInterpolateAdd
- MatIsHermitian
- MatIsHermitianTranspose
- MatIsLinear
- MatIsStructurallySymmetric
- MatIsSymmetric
- MatIsTranspose
- MatLRCGetMats
- MatMPIAIJGetSeqAIJ
- MatMPIAIJSetPreallocation
- MatMPIAdjSetPreallocation
- MatMPIAdjToSeq
- MatMPIBAIJSetPreallocation
- MatMPIDenseSetPreallocation
- MatMPISBAIJSetPreallocation
- MatMPISELLSetPreallocation
- MatMatInterpolate
- MatMatInterpolateAdd
- MatMatMatMult
- MatMatMult
- MatMatMultEqual
- MatMatRestrict
- MatMatTransposeMult
- MatMatTransposeMultEqual
- MatMkl_CPardisoSetCntl
- MatMultAddEqual
- MatMultEqual
- MatMultHermitianTransposeAddEqual
- MatMultHermitianTransposeEqual
- MatMultTransposeAddEqual
- MatMultTransposeEqual
- MatNorm
- MatNormalGetMat
- MatNormalHermitianGetMat
- MatPreallocateBegin
- MatPreallocateEnd
- MatPreallocateLocation
- MatPreallocateSet
- MatPreallocateSetLocal
- MatPreallocateSetLocalBlock
- MatPreallocateSetLocalRemoveDups
- MatPreallocateSymmetricSetBlock
- MatPreallocateSymmetricSetLocalBlock
- MatProductClear
- MatProductCreate
- MatProductCreateWithMat
- MatProductGetMats
- MatProductGetType
- MatProductNumeric
- MatProductReplaceMats
- MatProductSetAlgorithm
- MatProductSetFill
- MatProductSetFromOptions
- MatProductSetType
- MatProductSymbolic
- MatProductView
- MatPtAP
- MatPtAPMultEqual
- MatPythonCreate
- MatPythonSetType
- MatRARt
- MatRARtMultEqual
- MatReorderForNonzeroDiagonal
- MatRestoreLocalSubMatrix
- MatRestrict
- MatSTRUMPACKReordering
- MatScaLAPACKGetBlockSizes
- MatScaLAPACKSetBlockSizes
- MatScale
- MatScatterGetVecScatter
- MatSeqAIJGetArray
- MatSeqAIJGetArrayRead
- MatSeqAIJGetArrayWrite
- MatSeqAIJGetMaxRowNonzeros
- MatSeqAIJKron
- MatSeqAIJRestoreArray
- MatSeqAIJRestoreArrayRead
- MatSeqAIJRestoreArrayWrite
- MatSeqAIJSetPreallocation
- MatSeqAIJSetType
- MatSeqBAIJGetArray
- MatSeqBAIJRestoreArray
- MatSeqBAIJSetPreallocation
- MatSeqDenseSetPreallocation
- MatSeqSBAIJGetArray
- MatSeqSBAIJRestoreArray
- MatSeqSBAIJSetPreallocation
- MatSeqSELLRestoreArray
- MatSeqSELLSetPreallocation
- MatSetBlockSize
- MatSetBlockSizes
- MatSetFactorType
- MatSetLocalToGlobalMapping
- MatSetOption
- MatSetRandom
- MatSetType
- MatSetValueLocal
- MatSetValuesBlocked
- MatSetValuesBlockedLocal
- MatSetValuesLocal
- MatSetValuesRowLocal
- MatSetVariableBlockSizes
- MatSetVecType
- MatShift
- MatSolverTypeGet
- MatSolverTypeRegister
- MatStashSetInitialSize
- MatTranspose
- MatTransposeColoringCreate
- MatTransposeColoringDestroy
- MatTransposeGetMat
- MatTransposeMatMult
- MatTransposeMatMultEqual
- MatUpdateMPIAIJWithArrays
- MatViewFromOptions
- MatZeroEntries
- MatZeroRows
- MatZeroRowsColumns
- MatZeroRowsColumnsIS
- MatZeroRowsColumnsLocal
- MatZeroRowsColumnsLocalIS
- MatZeroRowsColumnsStencil
- MatZeroRowsIS
- MatZeroRowsLocal
- MatZeroRowsLocalIS
- MatZeroRowsStencil
- VecScatterFFTWToPetsc
- VecScatterPetscToFFTW
Advanced - Setting more advanced options and customization#
- MATBLOCKMAT
- MATCOMPOSITE
- MATIS
- MATKAIJ
- MATMAIJ
- MATMFFD
- MATPREALLOCATOR
- MATSCATTER
- MATSHELL
- MatAppendOptionsPrefix
- MatAssembled
- MatCoarsen
- MatCompositeAddMat
- MatCompositeGetMat
- MatCompositeGetMatStructure
- MatCompositeGetNumberMat
- MatCompositeGetType
- MatCompositeMerge
- MatCompositeSetMatStructure
- MatCompositeSetMergeType
- MatCompositeSetScalings
- MatCompositeSetType
- MatComputeOperator
- MatComputeOperatorTranspose
- MatConjugate
- MatCreateComposite
- MatCreateConstantDiagonal
- MatCreateIS
- MatCreateKAIJ
- MatCreateMAIJ
- MatCreateMFFD
- MatCreateMPIAIJSumSeqAIJ
- MatCreateMPIAIJWithSeqAIJ
- MatCreateMPIAIJWithSplitArrays
- MatCreateMPIMatConcatenateSeqMat
- MatCreateNest
- MatCreateRedundantMatrix
- MatCreateSeqBAIJWithArrays
- MatCreateSeqSBAIJWithArrays
- MatCreateShell
- MatCreateSubMatrices
- MatCreateSubMatricesMPI
- MatCreateSubMatrix
- MatCreateVecs
- MatCreateVecsFFTW
- MatDenseGetArrayF90
- MatDenseRestoreArrayF90
- MatDestroyMatrices
- MatDestroySeqNonzeroStructure
- MatDestroySubMatrices
- MatFactorCreateSchurComplement
- MatFactorFactorizeSchurComplement
- MatFactorGetError
- MatFactorGetErrorZeroPivot
- MatFactorGetSchurComplement
- MatFactorInvertSchurComplement
- MatFactorRestoreSchurComplement
- MatFactorSolveSchurComplement
- MatFactorSolveSchurComplementTranspose
- MatGetColumnVector
- MatGetDiagonalBlock
- MatGetGhosts
- MatGetInertia
- MatGetLayouts
- MatGetLocalToGlobalMapping
- MatGetMultiProcBlock
- MatGetOptionsPrefix
- MatGetRow
- MatGetRowUpperTriangular
- MatGetTrace
- MatGetValue
- MatGetValues
- MatGetValuesLocal
- MatHasOperation
- MatHtoolGetHierarchicalMat
- MatHtoolGetPermutationSource
- MatHtoolGetPermutationTarget
- MatHtoolSetKernel
- MatHtoolUsePermutation
- MatISFixLocalEmpty
- MatISGetLocalMat
- MatISGetLocalToGlobalMapping
- MatISRestoreLocalMat
- MatISSetLocalMat
- MatISSetLocalMatType
- MatISStoreL2L
- MatImaginaryPart
- MatInodeGetInodeSizes
- MatInvertBlockDiagonal
- MatInvertBlockDiagonalMat
- MatInvertVariableBlockDiagonal
- MatInvertVariableBlockEnvelope
- MatIsHermitianKnown
- MatIsSymmetricKnown
- MatKAIJGetAIJ
- MatKAIJGetS
- MatKAIJGetSRead
- MatKAIJGetScaledIdentity
- MatKAIJGetT
- MatKAIJGetTRead
- MatKAIJRestoreS
- MatKAIJRestoreSRead
- MatKAIJRestoreT
- MatKAIJRestoreTRead
- MatKAIJSetAIJ
- MatKAIJSetS
- MatKAIJSetT
- MatMAIJGetAIJ
- MatMAIJRedimension
- MatMFFDCheckPositivity
- MatMFFDDSSetUmin
- MatMFFDGetH
- MatMFFDResetHHistory
- MatMFFDSetBase
- MatMFFDSetCheckh
- MatMFFDSetFunction
- MatMFFDSetFunctionError
- MatMFFDSetFunctioni
- MatMFFDSetFunctioniBase
- MatMFFDSetHHistory
- MatMFFDSetOptionsPrefix
- MatMFFDSetPeriod
- MatMFFDSetType
- MatMFFDWPSetComputeNormU
- MatMPIAIJSetUseScalableIncreaseOverlap
- MatMPIBAIJSetHashTableFactor
- MatMPIBAIJSetPreallocationCSR
- MatMPIBAIJSetValuesBlocked
- MatMPISBAIJSetPreallocationCSR
- MatMissingDiagonal
- MatNestGetISs
- MatNestGetLocalISs
- MatNestSetSubMats
- MatNullSpace
- MatNullSpaceCreate
- MatNullSpaceCreateRigidBody
- MatNullSpaceDestroy
- MatNullSpaceRemove
- MatNullSpaceSetFunction
- MatNullSpaceTest
- MatNullSpaceView
- MatPermute
- MatPreallocatorPreallocate
- MatRealPart
- MatRegister
- MatRegisterAll
- MatRestoreRow
- MatRestoreRowUpperTriangular
- MatRetrieveValues
- MatScatterSetVecScatter
- MatSeqAIJGetArrayF90
- MatSeqAIJRegister
- MatSeqAIJRegisterAll
- MatSeqAIJRestoreArrayF90
- MatSeqAIJSetColumnIndices
- MatSeqAIJSetTotalPreallocation
- MatSeqBAIJSetColumnIndices
- MatSeqBAIJSetPreallocationCSR
- MatSeqSBAIJSetColumnIndices
- MatSeqSBAIJSetPreallocationCSR
- MatSetErrorIfFailure
- MatSetLayouts
- MatSetNearNullSpace
- MatSetNullSpace
- MatSetOptionsPrefix
- MatSetTransposeNullSpace
- MatSetValuesBatch
- MatSetValuesDevice
- MatSetValuesRow
- MatShellGetContext
- MatShellGetOperation
- MatShellSetContext
- MatShellSetManageScalingShifts
- MatShellSetMatProductOperation
- MatShellSetOperation
- MatShellSetVecType
- MatShellTestMult
- MatShellTestMultTranspose
- MatStashGetInfo
- MatStoreValues
- MatSubdomainsCreateCoalesce
- MatTransColoringApplyDenToSp
- MatTransColoringApplySpToDen
Developer - Interfaces intended primarily for library developers, not for typical applications programmers#
- MATDUMMY
- MatAIJGetLocalMat
- MatAppendOptionsPrefixFactor
- MatBackwardSolve
- MatCheckCompressedRow
- MatCholeskyFactor
- MatCholeskyFactorNumeric
- MatCholeskyFactorSymbolic
- MatColoringPatch
- MatCreateLocalRef
- MatCreateSubMatrixVirtual
- MatDenseCUDAGetArray
- MatDenseCUDAGetArrayRead
- MatDenseCUDAGetArrayWrite
- MatDenseCUDAPlaceArray
- MatDenseCUDAReplaceArray
- MatDenseCUDAResetArray
- MatDenseCUDARestoreArray
- MatDenseCUDARestoreArrayRead
- MatDenseCUDARestoreArrayWrite
- MatDensePlaceArray
- MatDenseReplaceArray
- MatDenseResetArray
- MatDiagonalScaleLocal
- MatFactorClearError
- MatFactorGetCanUseOrdering
- MatFactorGetPreferredOrdering
- MatFactorInfo
- MatFactorInfoInitialize
- MatFactorSetSchurIS
- MatFilter_AIJ
- MatFinalizePackage
- MatFindOffBlockDiagonalEntries
- MatFindZeroDiagonals
- MatForwardSolve
- MatGalerkin
- MatGetBindingPropagates
- MatGetBrowsOfAcols
- MatGetColumnIJ
- MatGetColumnReductions
- MatGetNearNullSpace
- MatGetNullSpace
- MatGetOperation
- MatGetOwnershipRangeColumn
- MatGetRowIJ
- MatGetTransposeNullSpace
- MatICCFactor
- MatICCFactorSymbolic
- MatILUFactor
- MatILUFactorSymbolic
- MatISGetMPIXAIJ
- MatIncreaseOverlap
- MatIncreaseOverlapSplit
- MatInitializePackage
- MatIsShell
- MatLUFactor
- MatLUFactorNumeric
- MatLUFactorSymbolic
- MatMFFD
- MatMFFDFinalizePackage
- MatMFFDInitializePackage
- MatMFFDRegister
- MatMFFDRegisterAll
- MatMPIAIJGetLocalMat
- MatMPIAIJGetLocalMatCondensed
- MatMPIAIJGetLocalMatMerge
- MatMPIAIJSetPreallocationCSR
- MatMPIAdjCreateNonemptySubcommMat
- MatMPISELLGetLocalMatCondensed
- MatMatSolve
- MatMatSolveTranspose
- MatMatTransposeSolve
- MatMultDiagonalBlock
- MatNestGetSize
- MatNestGetSubMat
- MatNestGetSubMats
- MatNestSetSubMat
- MatNestSetVecType
- MatNullSpaceGetVecs
- MatQRFactor
- MatQRFactorNumeric
- MatQRFactorSymbolic
- MatRegisterRootName
- MatResidual
- MatRestoreColumnIJ
- MatRestoreRowIJ
- MatSOR
- MatSeqAIJCUSPARSEGetArray
- MatSeqAIJCUSPARSEGetArrayRead
- MatSeqAIJCUSPARSEGetArrayWrite
- MatSeqAIJCUSPARSEGetIJ
- MatSeqAIJCUSPARSERestoreArray
- MatSeqAIJCUSPARSERestoreArrayRead
- MatSeqAIJCUSPARSERestoreArrayWrite
- MatSeqAIJCUSPARSERestoreIJ
- MatSeqAIJGetCSRAndMemType
- MatSeqAIJSetPreallocationCSR
- MatSetBindingPropagates
- MatSetBlockSizesFromMats
- MatSetOperation
- MatSetOptionsPrefixFactor
- MatSetUnfactored
- MatSolve
- MatSolveAdd
- MatSolveTranspose
- MatSolveTransposeAdd
- MatSolves
- MatSubMatrixVirtualUpdate