PETSc version 3.16.4

Matrices Mat: : Examples

PETSc matrices (Mat objects) are used to store Jacobians and other sparse matrices in PDE-based (or other) simulations.

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

Table of Contents