petsc-master 2019-06-22
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 MatEqual MatPreallocateSymmetricSetBlock
MATMFFD_DS MatFactorGetSolverType MatPreallocateSymmetricSetLocalBlock
MATMFFD_WP MatFindNonzeroRows MatPtAP
MATNEST MatFindZeroRows MatPtAPNumeric
MATSOLVERBAS MatGetBlockSize MatPtAPSymbolic
MatAXPY MatGetBlockSizes MatPythonCreate
MatAYPX MatGetColumnNorms MatPythonSetType
MatBlockMatSetPreallocation MatGetDiagonal MatRARt
MatCUSPARSEFormatOperation MatGetFactor MatRARtNumeric
MatCUSPARSESetFormat MatGetFactorAvailable MatRARtSymbolic
MatCUSPARSEStorageFormat MatGetFactorType MatReorderForNonzeroDiagonal
MatChop MatGetInfo MatRestoreLocalSubMatrix
MatColoringWeightType MatGetLocalSubMatrix MatRestrict
MatConvert MatGetNonzeroState MatSTRUMPACKReordering
MatCopy MatGetOption MatScale
MatCreateAIJ MatGetOwnershipIS MatScatterGetVecScatter
MatCreateAIJCUSPARSE MatGetRowMax MatSeqAIJGetArray
MatCreateAIJViennaCL MatGetRowMaxAbs MatSeqAIJGetMaxRowNonzeros
MatCreateBAIJ MatGetRowMin MatSeqAIJRestoreArray
MatCreateBAIJMKL MatGetRowMinAbs MatSeqAIJSetPreallocation
MatCreateBlockMat MatGetRowSum MatSeqAIJSetType
MatCreateDense MatGetSeqNonzeroStructure MatSeqBAIJSetPreallocation
MatCreateFFT MatGetType MatSeqDenseSetLDA
MatCreateHermitianTranspose MatGetVariableBlockSizes MatSeqDenseSetPreallocation
MatCreateLRC MatHYPRESetPreallocation MatSeqSBAIJGetArray
MatCreateMPIAIJCRL MatHermitianTranspose MatSeqSBAIJRestoreArray
MatCreateMPIAIJMKL MatHermitianTransposeGetMat MatSeqSBAIJSetPreallocation
MatCreateMPIAIJPERM MatISSetPreallocation MatSeqSELLRestoreArray
MatCreateMPIAIJSELL MatInfo MatSeqSELLSetPreallocation
MatCreateMPIAIJWithArrays MatInterpolate MatSetBlockSize
MatCreateMPIAdj MatInterpolateAdd MatSetBlockSizes
MatCreateMPIBAIJWithArrays MatIsHermitian MatSetFactorType
MatCreateMPISBAIJWithArrays MatIsHermitianTranspose MatSetLocalToGlobalMapping
MatCreateNormal MatIsLinear MatSetOption
MatCreateNormalHermitian MatIsStructurallySymmetric MatSetRandom
MatCreateSBAIJ MatIsSymmetric MatSetType
MatCreateSELL MatIsTranspose MatSetValuesBlocked
MatCreateScatter MatLRCGetMats MatSetValuesBlockedLocal
MatCreateSeqAIJ MatMPIAIJSetPreallocation MatSetValuesLocal
MatCreateSeqAIJCRL MatMPIAdjSetPreallocation MatSetValuesRowLocal
MatCreateSeqAIJCUSPARSE MatMPIAdjToSeq MatSetVariableBlockSizes
MatCreateSeqAIJFromTriple MatMPIBAIJSetPreallocation MatShift
MatCreateSeqAIJMKL MatMPIDenseSetPreallocation MatSolvePackageGet
MatCreateSeqAIJPERM MatMPISBAIJSetPreallocation MatSolvePackageRegister
MatCreateSeqAIJSELL MatMPISELLSetPreallocation MatStashSetInitialSize
MatCreateSeqAIJViennaCL MatMatMatMult MatTranspose
MatCreateSeqAIJWithArrays MatMatMult MatTransposeColoringCreate
MatCreateSeqBAIJ MatMatMultEqual MatTransposeColoringDestroy
MatCreateSeqBAIJMKL MatMatMultNumeric MatTransposeGetMat
MatCreateSeqCUFFT MatMatMultSymbolic MatTransposeMatMult
MatCreateSeqDense MatMatTransposeMult MatTransposeMatMultEqual
MatCreateSeqSBAIJ MatMatTransposeMultEqual MatUpdateMPIAIJWithArrays
MatCreateSeqSELL MatMkl_CPardisoSetCntl MatZeroEntries
MatCreateTranspose MatMultAddEqual MatZeroRows
MatDenseGetArray MatMultEqual MatZeroRowsColumns
MatDenseGetArrayRead MatMultTransposeAddEqual MatZeroRowsColumnsIS
MatDenseGetColumn MatMultTransposeEqual MatZeroRowsColumnsLocal
MatDenseGetLDA MatNorm MatZeroRowsColumnsLocalIS
MatDenseGetLocalMatrix MatPreallocateFinalize MatZeroRowsColumnsStencil
MatDenseRestoreArray MatPreallocateInitialize MatZeroRowsIS
MatDenseRestoreArrayRead MatPreallocateLocation MatZeroRowsLocal
MatDenseRestoreColumn MatPreallocateSet MatZeroRowsLocalIS
MatDiagonalScale MatPreallocateSetLocal MatZeroRowsStencil
MatDiagonalSet MatPreallocateSetLocalBlock VecScatterFFTWToPetsc
MatDuplicate MatPreallocateSetLocalRemoveDups VecScatterPetscToFFTW
Advanced - Setting more advanced options and customization
MATBLOCKMAT MatFactorGetSchurComplement MatMPIBAIJSetHashTableFactor
MATCOMPOSITE MatFactorInvertSchurComplement MatMPIBAIJSetValuesBlocked
MATIS MatFactorRestoreSchurComplement MatMissingDiagonal
MATMAIJ MatFactorSolveSchurComplement MatNestGetISs
MATMFFD MatFactorSolveSchurComplementTranspose MatNestGetLocalISs
MATPREALLOCATOR MatFreeIntermediateDataStructures MatNestSetSubMats
MATSCATTER MatGetColumnVector MatNullSpace
MATSHELL MatGetDiagonalBlock MatNullSpaceCreate
MatAppendOptionsPrefix MatGetGhosts MatNullSpaceCreateRigidBody
MatAssembled MatGetInertia MatNullSpaceDestroy
MatCompositeAddMat MatGetLayouts MatNullSpaceRemove
MatCompositeGetMat MatGetLocalToGlobalMapping MatNullSpaceSetFunction
MatCompositeGetMatStructure MatGetMultiProcBlock MatNullSpaceTest
MatCompositeGetNumberMat MatGetOptionsPrefix MatNullSpaceView
MatCompositeGetType MatGetRow MatPermute
MatCompositeMerge MatGetRowUpperTriangular MatPreallocatorPreallocate
MatCompositeSetMatStructure MatGetTrace MatRealPart
MatCompositeSetMergeType MatGetValues MatRegister
MatCompositeSetType MatHasOperation MatRegisterAll
MatComputeOperator MatISFixLocalEmpty MatRestoreRow
MatComputeOperatorTranspose MatISGetLocalMat MatRestoreRowUpperTriangular
MatConjugate MatISRestoreLocalMat MatRetrieveValues
MatCreateComposite MatISSetLocalMat MatScatterSetVecScatter
MatCreateConstantDiagonal MatISSetLocalMatType MatSeqAIJGetArrayF90
MatCreateIS MatISStoreL2L MatSeqAIJRegister
MatCreateMAIJ MatImaginaryPart MatSeqAIJRegisterAll
MatCreateMFFD MatInodeGetInodeSizes MatSeqAIJRestoreArrayF90
MatCreateMPIAIJSumSeqAIJ MatInvertBlockDiagonal MatSeqAIJSetColumnIndices
MatCreateMPIAIJWithSeqAIJ MatInvertBlockDiagonalMat MatSeqBAIJSetColumnIndices
MatCreateMPIAIJWithSplitArrays MatInvertVariableBlockDiagonal MatSeqSBAIJSetColumnIndices
MatCreateMPIMatConcatenateSeqMat MatIsHermitianKnown MatSetErrorIfFailure
MatCreateNest MatIsSymmetricKnown MatSetNearNullSpace
MatCreateRedundantMatrix MatMAIJGetAIJ MatSetNullSpace
MatCreateSeqBAIJWithArrays MatMAIJRedimension MatSetOptionsPrefix
MatCreateSeqSBAIJWithArrays MatMFFDCheckPositivity MatSetTransposeNullSpace
MatCreateShell MatMFFDDSSetUmin MatSetValuesBatch
MatCreateSubMatrices MatMFFDGetH MatSetValuesRow
MatCreateSubMatricesMPI MatMFFDResetHHistory MatShellGetContext
MatCreateSubMatrix MatMFFDSetBase MatShellGetOperation
MatCreateVecs MatMFFDSetCheckh MatShellSetContext
MatCreateVecsFFTW MatMFFDSetFunction MatShellSetManageScalingShifts
MatDenseGetArrayF90 MatMFFDSetFunctionError MatShellSetOperation
MatDenseRestoreArrayF90 MatMFFDSetFunctioni MatShellTestMult
MatDestroyMatrices MatMFFDSetFunctioniBase MatShellTestMultTranpose
MatDestroySeqNonzeroStructure MatMFFDSetHHistory MatStashGetInfo
MatDestroySubMatrices MatMFFDSetOptionsPrefix MatStoreValues
MatFactorCreateSchurComplement MatMFFDSetPeriod MatSubdomainsCreateCoalesce
MatFactorFactorizeSchurComplement MatMFFDSetType MatTransColoringApplyDenToSp
MatFactorGetError MatMFFDWPSetComputeNormU MatTransColoringApplySpToDen
MatFactorGetErrorZeroPivot MatMPIAIJSetUseScalableIncreaseOverlap
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
None: Not yet cataloged
MatPinToCPU

Table of Contents