petsc-3.11.4 2019-09-28
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 MATSOLVERUMFPACK MatMumpsGetInfog
MATAIJCRL Mat MatMumpsGetInverse
MATAIJCUSPARSE MatAssemblyBegin MatMumpsGetInverseTranspose
MATAIJMKL MatAssemblyEnd MatMumpsGetRinfo
MATAIJPERM MatAssemblyType MatMumpsGetRinfog
MATAIJSELL MatColoring MatMumpsSetCntl
MATAIJVIENNACL MatColoringType MatMumpsSetIcntl
MATBAIJ MatComputeBandwidth MatOption
MATBAIJMKL MatCreate MatOrderingType
MATDENSE MatCreateSubMatrixOption MatPartitioning
MATELEMENTAL MatDestroy MatPartitioningType
MATMPIADJ MatDuplicateOption MatResetPreallocation
MATMPIAIJ MatFDColoring MatReuse
MATMPIBAIJ MatFactorError MatSORType
MATMPISBAIJ MatFactorShiftType MatSTRUMPACKSetColPerm
MATMPISELL MatFactorType MatSTRUMPACKSetHSSAbsTol
MATSBAIJ MatGetLocalSize MatSTRUMPACKSetHSSLeafSize
MATSELL MatGetOwnershipRange MatSTRUMPACKSetHSSMaxRank
MATSEQAIJ MatGetOwnershipRanges MatSTRUMPACKSetHSSMinSepSize
MATSEQAIJCUSPARSE MatGetOwnershipRangesColumn MatSTRUMPACKSetHSSRelTol
MATSEQAIJVIENNACL MatGetSize MatSTRUMPACKSetReordering
MATSEQBAIJ MatHasCongruentLayouts MatSetFromOptions
MATSEQDENSE MatInfoType MatSetSizes
MATSEQSBAIJ MatLoad MatSetStencil
MATSOLVERCHOLMOD MatMFFDType MatSetUp
MATSOLVERCUSPARSE MatMkl_PardisoSetCntl MatSetValue
MATSOLVERESSL MatMult MatSetValues
MATSOLVERKLU MatMultAdd MatSetValuesBlockedStencil
MATSOLVERLUSOL MatMultConstrained MatSetValuesStencil
MATSOLVERMATLAB MatMultHermitianTranspose MatSolverType
MATSOLVERMKL_PARDISO MatMultHermitianTransposeAdd MatStencil
MATSOLVERMUMPS MatMultTranspose MatStructure
MATSOLVERPASTIX MatMultTransposeAdd MatSuperluSetILUDropTol
MATSOLVERSPARSEELEMENTAL MatMultTransposeConstrained MatTransposeColoring
MATSOLVERSSTRUMPACK MatMumpsGetCntl MatType
MATSOLVERSUPERLU MatMumpsGetIcntl MatView
MATSOLVERSUPERLU_DIST MatMumpsGetInfo MatXAIJSetPreallocation
Intermediate - Setting options for algorithms and data structures
MATHYPRE MatFactorGetSolverType MatPreallocateSymmetricSetLocalBlock
MATMFFD_DS MatFindNonzeroRows MatPtAP
MATMFFD_WP MatFindZeroRows MatPtAPNumeric
MATNEST MatGetBlockSize MatPtAPSymbolic
MATSOLVERBAS MatGetBlockSizes MatPythonCreate
MatAXPY MatGetColumnNorms MatPythonSetType
MatAYPX MatGetDiagonal MatRARt
MatBlockMatSetPreallocation MatGetFactor MatRARtNumeric
MatCUSPARSEFormatOperation MatGetFactorAvailable MatRARtSymbolic
MatCUSPARSESetFormat MatGetFactorType MatReorderForNonzeroDiagonal
MatCUSPARSEStorageFormat MatGetInfo MatRestoreLocalSubMatrix
MatChop MatGetLocalSubMatrix MatRestrict
MatColoringWeightType MatGetNonzeroState MatSTRUMPACKReordering
MatConvert MatGetOption MatScale
MatCopy MatGetOwnershipIS MatScatterGetVecScatter
MatCreateAIJ MatGetRowMax MatSeqAIJGetArray
MatCreateAIJCUSPARSE MatGetRowMaxAbs MatSeqAIJGetMaxRowNonzeros
MatCreateAIJViennaCL MatGetRowMin MatSeqAIJRestoreArray
MatCreateBAIJ MatGetRowMinAbs MatSeqAIJSetPreallocation
MatCreateBAIJMKL MatGetRowSum MatSeqAIJSetType
MatCreateBlockMat MatGetSeqNonzeroStructure MatSeqBAIJSetPreallocation
MatCreateDense MatGetType MatSeqDenseSetLDA
MatCreateFFT MatGetVariableBlockSizes MatSeqDenseSetPreallocation
MatCreateHermitianTranspose MatHYPRESetPreallocation MatSeqSBAIJGetArray
MatCreateLRC MatHermitianTranspose MatSeqSBAIJRestoreArray
MatCreateMPIAIJCRL MatHermitianTransposeGetMat MatSeqSBAIJSetPreallocation
MatCreateMPIAIJMKL MatISSetPreallocation MatSeqSELLRestoreArray
MatCreateMPIAIJPERM MatInfo MatSeqSELLSetPreallocation
MatCreateMPIAIJSELL MatInterpolate MatSetBlockSize
MatCreateMPIAIJWithArrays MatInterpolateAdd MatSetBlockSizes
MatCreateMPIAdj MatIsHermitian MatSetFactorType
MatCreateMPIBAIJWithArrays MatIsHermitianTranspose MatSetLocalToGlobalMapping
MatCreateMPISBAIJWithArrays MatIsLinear MatSetOption
MatCreateNormal MatIsStructurallySymmetric MatSetRandom
MatCreateNormalHermitian MatIsSymmetric MatSetType
MatCreateSBAIJ MatIsTranspose MatSetValuesBlocked
MatCreateSELL MatLRCGetMats MatSetValuesBlockedLocal
MatCreateScatter MatMPIAIJSetPreallocation MatSetValuesLocal
MatCreateSeqAIJ MatMPIAdjSetPreallocation MatSetValuesRowLocal
MatCreateSeqAIJCRL MatMPIAdjToSeq MatSetVariableBlockSizes
MatCreateSeqAIJCUSPARSE MatMPIBAIJSetPreallocation MatShift
MatCreateSeqAIJFromTriple MatMPIDenseSetPreallocation MatSolvePackageGet
MatCreateSeqAIJMKL MatMPISBAIJSetPreallocation MatSolvePackageRegister
MatCreateSeqAIJPERM MatMPISELLSetPreallocation MatStashSetInitialSize
MatCreateSeqAIJSELL MatMatMatMult MatTranspose
MatCreateSeqAIJViennaCL MatMatMult MatTransposeColoringCreate
MatCreateSeqAIJWithArrays MatMatMultEqual MatTransposeColoringDestroy
MatCreateSeqBAIJ MatMatMultNumeric MatTransposeGetMat
MatCreateSeqBAIJMKL MatMatMultSymbolic MatTransposeMatMult
MatCreateSeqCUFFT MatMatTransposeMult MatTransposeMatMultEqual
MatCreateSeqDense MatMatTransposeMultEqual MatZeroEntries
MatCreateSeqSBAIJ MatMkl_CPardisoSetCntl MatZeroRows
MatCreateSeqSELL MatMultAddEqual MatZeroRowsColumns
MatCreateTranspose MatMultEqual MatZeroRowsColumnsIS
MatDenseGetArray MatMultTransposeAddEqual MatZeroRowsColumnsLocal
MatDenseGetArrayRead MatMultTransposeEqual MatZeroRowsColumnsLocalIS
MatDenseGetColumn MatNorm MatZeroRowsColumnsStencil
MatDenseGetLocalMatrix MatPreallocateFinalize MatZeroRowsIS
MatDenseRestoreArray MatPreallocateInitialize MatZeroRowsLocal
MatDenseRestoreArrayRead MatPreallocateLocation MatZeroRowsLocalIS
MatDenseRestoreColumn MatPreallocateSet MatZeroRowsStencil
MatDiagonalScale MatPreallocateSetLocal VecScatterFFTWToPetsc
MatDiagonalSet MatPreallocateSetLocalBlock VecScatterPetscToFFTW
MatDuplicate MatPreallocateSetLocalRemoveDups
MatEqual MatPreallocateSymmetricSetBlock
Advanced - Setting more advanced options and customization
MATBLOCKMAT MatFreeIntermediateDataStructures MatNestGetISs
MATCOMPOSITE MatGetColumnVector MatNestGetLocalISs
MATIS MatGetDiagonalBlock MatNestSetSubMats
MATMAIJ MatGetGhosts MatNullSpace
MATMFFD MatGetInertia MatNullSpaceCreate
MATPREALLOCATOR MatGetLayouts MatNullSpaceCreateRigidBody
MATSCATTER MatGetLocalToGlobalMapping MatNullSpaceDestroy
MATSHELL MatGetMultiProcBlock MatNullSpaceRemove
MatAppendOptionsPrefix MatGetOptionsPrefix MatNullSpaceSetFunction
MatAssembled MatGetRow MatNullSpaceTest
MatCompositeAddMat MatGetRowUpperTriangular MatNullSpaceView
MatCompositeMerge MatGetTrace MatPermute
MatCompositeSetType MatGetValues MatPreallocatorPreallocate
MatComputeExplicitOperator MatHasOperation MatRealPart
MatComputeExplicitOperatorTranspose MatISFixLocalEmpty MatRegister
MatConjugate MatISGetLocalMat MatRegisterAll
MatCreateComposite MatISRestoreLocalMat MatRestoreRow
MatCreateIS MatISSetLocalMat MatRestoreRowUpperTriangular
MatCreateMAIJ MatISSetLocalMatType MatRetrieveValues
MatCreateMFFD MatISStoreL2L MatScatterSetVecScatter
MatCreateMPIAIJSumSeqAIJ MatImaginaryPart MatSeqAIJGetArrayF90
MatCreateMPIAIJWithSeqAIJ MatInodeGetInodeSizes MatSeqAIJRegister
MatCreateMPIAIJWithSplitArrays MatInvertBlockDiagonal MatSeqAIJRegisterAll
MatCreateMPIMatConcatenateSeqMat MatInvertBlockDiagonalMat MatSeqAIJRestoreArrayF90
MatCreateNest MatInvertVariableBlockDiagonal MatSeqAIJSetColumnIndices
MatCreateRedundantMatrix MatIsHermitianKnown MatSeqBAIJSetColumnIndices
MatCreateSeqBAIJWithArrays MatIsSymmetricKnown MatSeqSBAIJSetColumnIndices
MatCreateSeqSBAIJWithArrays MatMAIJGetAIJ MatSetErrorIfFailure
MatCreateShell MatMAIJRedimension MatSetNearNullSpace
MatCreateSubMatrices MatMFFDCheckPositivity MatSetNullSpace
MatCreateSubMatricesMPI MatMFFDDSSetUmin MatSetOptionsPrefix
MatCreateSubMatrix MatMFFDGetH MatSetTransposeNullSpace
MatCreateVecs MatMFFDResetHHistory MatSetValuesBatch
MatCreateVecsFFTW MatMFFDSetBase MatSetValuesRow
MatDenseGetArrayF90 MatMFFDSetCheckh MatShellGetContext
MatDenseRestoreArrayF90 MatMFFDSetFunction MatShellGetOperation
MatDestroyMatrices MatMFFDSetFunctionError MatShellSetContext
MatDestroySeqNonzeroStructure MatMFFDSetFunctioni MatShellSetManageScalingShifts
MatDestroySubMatrices MatMFFDSetFunctioniBase MatShellSetOperation
MatFactorCreateSchurComplement MatMFFDSetHHistory MatShellTestMult
MatFactorFactorizeSchurComplement MatMFFDSetOptionsPrefix MatShellTestMultTranpose
MatFactorGetError MatMFFDSetPeriod MatStashGetInfo
MatFactorGetErrorZeroPivot MatMFFDSetType MatStoreValues
MatFactorGetSchurComplement MatMFFDWPSetComputeNormU MatSubdomainsCreateCoalesce
MatFactorInvertSchurComplement MatMPIAIJSetUseScalableIncreaseOverlap MatTransColoringApplyDenToSp
MatFactorRestoreSchurComplement MatMPIBAIJSetHashTableFactor MatTransColoringApplySpToDen
MatFactorSolveSchurComplement MatMPIBAIJSetValuesBlocked
MatFactorSolveSchurComplementTranspose MatMissingDiagonal
Developer - Interfaces intended primarily for library developers, not for typical applications programmers
MATDUMMY MatGetRowIJ MatMultDiagonalBlock
MatBackwardSolve MatGetTransposeNullSpace MatNestGetSize
MatCheckCompressedRow MatICCFactor MatNestGetSubMat
MatCholeskyFactor MatICCFactorSymbolic MatNestGetSubMats
MatCholeskyFactorNumeric MatILUFactor MatNestSetSubMat
MatCholeskyFactorSymbolic MatILUFactorSymbolic MatNestSetVecType
MatColoringPatch MatISGetMPIXAIJ MatNullSpaceGetVecs
MatCreateLocalRef MatIncreaseOverlap MatRegisterRootName
MatCreateSubMatrixVirtual MatIncreaseOverlapSplit MatResidual
MatDensePlaceArray MatInitializePackage MatRestoreColumnIJ
MatDenseResetArray MatLUFactor MatRestoreRowIJ
MatDiagonalScaleLocal MatLUFactorNumeric MatSOR
MatFactorClearError MatLUFactorSymbolic MatSeqAIJSetPreallocationCSR
MatFactorInfo MatMFFD MatSeqBAIJSetPreallocationCSR
MatFactorInfoInitialize MatMFFDFinalizePackage MatSeqSBAIJSetPreallocationCSR
MatFactorSetSchurIS MatMFFDInitializePackage MatSetBlockSizesFromMats
MatFinalizePackage MatMFFDRegister MatSetOperation
MatFindOffBlockDiagonalEntries MatMFFDRegisterAll MatSetUnfactored
MatFindZeroDiagonals MatMPIAIJGetLocalMat MatSolve
MatForwardSolve MatMPIAIJGetLocalMatCondensed MatSolveAdd
MatGalerkin MatMPIAIJSetPreallocationCSR MatSolveTranspose
MatGetBrowsOfAcols MatMPIAdjCreateNonemptySubcommMat MatSolveTransposeAdd
MatGetColumnIJ MatMPIBAIJSetPreallocationCSR MatSolves
MatGetCommunicationStructs MatMPISBAIJSetPreallocationCSR MatSubMatrixVirtualUpdate
MatGetNearNullSpace MatMPISELLGetLocalMatCondensed PetscElementalFinalizePackage
MatGetNullSpace MatMatSolve PetscElementalInitializePackage
MatGetOperation MatMatSolveTranspose
MatGetOwnershipRangeColumn MatMatTransposeSolve
No deprecated routines

Table of Contents