petsc-master 2021-02-25
Report Typos and Errors

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

Table of Contents