petsc4py.PETSc.Mat
==================

.. autoclass:: petsc4py.PETSc.Mat
   :show-inheritance:

   
   .. rubric:: Enumerations
   .. autosummary::
      :toctree:
   
      ~petsc4py.PETSc.Mat.AssemblyType
      ~petsc4py.PETSc.Mat.DuplicateOption
      ~petsc4py.PETSc.Mat.FactorShiftType
      ~petsc4py.PETSc.Mat.InfoType
      ~petsc4py.PETSc.Mat.Option
      ~petsc4py.PETSc.Mat.OrderingType
      ~petsc4py.PETSc.Mat.SORType
      ~petsc4py.PETSc.Mat.SolverType
      ~petsc4py.PETSc.Mat.Stencil
      ~petsc4py.PETSc.Mat.Structure
      ~petsc4py.PETSc.Mat.Type

   
   .. rubric:: Methods Summary
   .. autosummary::
   
      ~petsc4py.PETSc.Mat.H2OpusCompress
      ~petsc4py.PETSc.Mat.H2OpusLowRankUpdate
      ~petsc4py.PETSc.Mat.H2OpusOrthogonalize
      ~petsc4py.PETSc.Mat.SOR
      ~petsc4py.PETSc.Mat.appendOptionsPrefix
      ~petsc4py.PETSc.Mat.assemble
      ~petsc4py.PETSc.Mat.assemblyBegin
      ~petsc4py.PETSc.Mat.assemblyEnd
      ~petsc4py.PETSc.Mat.axpy
      ~petsc4py.PETSc.Mat.aypx
      ~petsc4py.PETSc.Mat.bindToCPU
      ~petsc4py.PETSc.Mat.boundToCPU
      ~petsc4py.PETSc.Mat.chop
      ~petsc4py.PETSc.Mat.conjugate
      ~petsc4py.PETSc.Mat.convert
      ~petsc4py.PETSc.Mat.copy
      ~petsc4py.PETSc.Mat.create
      ~petsc4py.PETSc.Mat.createAIJ
      ~petsc4py.PETSc.Mat.createAIJCRL
      ~petsc4py.PETSc.Mat.createAIJWithArrays
      ~petsc4py.PETSc.Mat.createBAIJ
      ~petsc4py.PETSc.Mat.createConstantDiagonal
      ~petsc4py.PETSc.Mat.createDense
      ~petsc4py.PETSc.Mat.createDenseCUDA
      ~petsc4py.PETSc.Mat.createDiagonal
      ~petsc4py.PETSc.Mat.createH2OpusFromMat
      ~petsc4py.PETSc.Mat.createHermitianTranspose
      ~petsc4py.PETSc.Mat.createIS
      ~petsc4py.PETSc.Mat.createLRC
      ~petsc4py.PETSc.Mat.createNest
      ~petsc4py.PETSc.Mat.createNormal
      ~petsc4py.PETSc.Mat.createNormalHermitian
      ~petsc4py.PETSc.Mat.createPython
      ~petsc4py.PETSc.Mat.createSBAIJ
      ~petsc4py.PETSc.Mat.createScatter
      ~petsc4py.PETSc.Mat.createSubMatrices
      ~petsc4py.PETSc.Mat.createSubMatrix
      ~petsc4py.PETSc.Mat.createSubMatrixVirtual
      ~petsc4py.PETSc.Mat.createTranspose
      ~petsc4py.PETSc.Mat.createVecLeft
      ~petsc4py.PETSc.Mat.createVecRight
      ~petsc4py.PETSc.Mat.createVecs
      ~petsc4py.PETSc.Mat.destroy
      ~petsc4py.PETSc.Mat.diagonalScale
      ~petsc4py.PETSc.Mat.duplicate
      ~petsc4py.PETSc.Mat.equal
      ~petsc4py.PETSc.Mat.factorCholesky
      ~petsc4py.PETSc.Mat.factorICC
      ~petsc4py.PETSc.Mat.factorILU
      ~petsc4py.PETSc.Mat.factorLU
      ~petsc4py.PETSc.Mat.factorNumericCholesky
      ~petsc4py.PETSc.Mat.factorNumericLU
      ~petsc4py.PETSc.Mat.factorSymbolicCholesky
      ~petsc4py.PETSc.Mat.factorSymbolicICC
      ~petsc4py.PETSc.Mat.factorSymbolicILU
      ~petsc4py.PETSc.Mat.factorSymbolicLU
      ~petsc4py.PETSc.Mat.findZeroRows
      ~petsc4py.PETSc.Mat.fixISLocalEmpty
      ~petsc4py.PETSc.Mat.getBlockSize
      ~petsc4py.PETSc.Mat.getBlockSizes
      ~petsc4py.PETSc.Mat.getColumnIJ
      ~petsc4py.PETSc.Mat.getColumnVector
      ~petsc4py.PETSc.Mat.getDM
      ~petsc4py.PETSc.Mat.getDenseArray
      ~petsc4py.PETSc.Mat.getDenseColumnVec
      ~petsc4py.PETSc.Mat.getDenseLDA
      ~petsc4py.PETSc.Mat.getDenseLocalMatrix
      ~petsc4py.PETSc.Mat.getDiagonal
      ~petsc4py.PETSc.Mat.getDiagonalBlock
      ~petsc4py.PETSc.Mat.getISLocalMat
      ~petsc4py.PETSc.Mat.getInertia
      ~petsc4py.PETSc.Mat.getInfo
      ~petsc4py.PETSc.Mat.getLGMap
      ~petsc4py.PETSc.Mat.getLRCMats
      ~petsc4py.PETSc.Mat.getLocalSize
      ~petsc4py.PETSc.Mat.getLocalSubMatrix
      ~petsc4py.PETSc.Mat.getMumpsCntl
      ~petsc4py.PETSc.Mat.getMumpsIcntl
      ~petsc4py.PETSc.Mat.getMumpsInfo
      ~petsc4py.PETSc.Mat.getMumpsInfog
      ~petsc4py.PETSc.Mat.getMumpsRinfo
      ~petsc4py.PETSc.Mat.getMumpsRinfog
      ~petsc4py.PETSc.Mat.getNearNullSpace
      ~petsc4py.PETSc.Mat.getNestISs
      ~petsc4py.PETSc.Mat.getNestLocalISs
      ~petsc4py.PETSc.Mat.getNestSize
      ~petsc4py.PETSc.Mat.getNestSubMatrix
      ~petsc4py.PETSc.Mat.getNullSpace
      ~petsc4py.PETSc.Mat.getOption
      ~petsc4py.PETSc.Mat.getOptionsPrefix
      ~petsc4py.PETSc.Mat.getOrdering
      ~petsc4py.PETSc.Mat.getOwnershipIS
      ~petsc4py.PETSc.Mat.getOwnershipRange
      ~petsc4py.PETSc.Mat.getOwnershipRangeColumn
      ~petsc4py.PETSc.Mat.getOwnershipRanges
      ~petsc4py.PETSc.Mat.getOwnershipRangesColumn
      ~petsc4py.PETSc.Mat.getPythonContext
      ~petsc4py.PETSc.Mat.getPythonType
      ~petsc4py.PETSc.Mat.getRedundantMatrix
      ~petsc4py.PETSc.Mat.getRow
      ~petsc4py.PETSc.Mat.getRowIJ
      ~petsc4py.PETSc.Mat.getRowSum
      ~petsc4py.PETSc.Mat.getSize
      ~petsc4py.PETSc.Mat.getSizes
      ~petsc4py.PETSc.Mat.getTransposeNullSpace
      ~petsc4py.PETSc.Mat.getType
      ~petsc4py.PETSc.Mat.getValue
      ~petsc4py.PETSc.Mat.getValues
      ~petsc4py.PETSc.Mat.getValuesCSR
      ~petsc4py.PETSc.Mat.getVecType
      ~petsc4py.PETSc.Mat.hermitianTranspose
      ~petsc4py.PETSc.Mat.imagPart
      ~petsc4py.PETSc.Mat.increaseOverlap
      ~petsc4py.PETSc.Mat.invertBlockDiagonal
      ~petsc4py.PETSc.Mat.isAssembled
      ~petsc4py.PETSc.Mat.isHermitian
      ~petsc4py.PETSc.Mat.isHermitianKnown
      ~petsc4py.PETSc.Mat.isStructurallySymmetric
      ~petsc4py.PETSc.Mat.isSymmetric
      ~petsc4py.PETSc.Mat.isSymmetricKnown
      ~petsc4py.PETSc.Mat.isTranspose
      ~petsc4py.PETSc.Mat.kron
      ~petsc4py.PETSc.Mat.load
      ~petsc4py.PETSc.Mat.matMatMult
      ~petsc4py.PETSc.Mat.matMult
      ~petsc4py.PETSc.Mat.matSolve
      ~petsc4py.PETSc.Mat.matTransposeMult
      ~petsc4py.PETSc.Mat.mult
      ~petsc4py.PETSc.Mat.multAdd
      ~petsc4py.PETSc.Mat.multHermitian
      ~petsc4py.PETSc.Mat.multHermitianAdd
      ~petsc4py.PETSc.Mat.multTranspose
      ~petsc4py.PETSc.Mat.multTransposeAdd
      ~petsc4py.PETSc.Mat.norm
      ~petsc4py.PETSc.Mat.permute
      ~petsc4py.PETSc.Mat.ptap
      ~petsc4py.PETSc.Mat.rart
      ~petsc4py.PETSc.Mat.realPart
      ~petsc4py.PETSc.Mat.reorderForNonzeroDiagonal
      ~petsc4py.PETSc.Mat.restoreDenseColumnVec
      ~petsc4py.PETSc.Mat.restoreISLocalMat
      ~petsc4py.PETSc.Mat.restoreLocalSubMatrix
      ~petsc4py.PETSc.Mat.retrieveValues
      ~petsc4py.PETSc.Mat.scale
      ~petsc4py.PETSc.Mat.setBlockSize
      ~petsc4py.PETSc.Mat.setBlockSizes
      ~petsc4py.PETSc.Mat.setDM
      ~petsc4py.PETSc.Mat.setDenseLDA
      ~petsc4py.PETSc.Mat.setDiagonal
      ~petsc4py.PETSc.Mat.setFromOptions
      ~petsc4py.PETSc.Mat.setISLocalMat
      ~petsc4py.PETSc.Mat.setISPreallocation
      ~petsc4py.PETSc.Mat.setLGMap
      ~petsc4py.PETSc.Mat.setLRCMats
      ~petsc4py.PETSc.Mat.setMumpsCntl
      ~petsc4py.PETSc.Mat.setMumpsIcntl
      ~petsc4py.PETSc.Mat.setNearNullSpace
      ~petsc4py.PETSc.Mat.setNestVecType
      ~petsc4py.PETSc.Mat.setNullSpace
      ~petsc4py.PETSc.Mat.setOption
      ~petsc4py.PETSc.Mat.setOptionsPrefix
      ~petsc4py.PETSc.Mat.setPreallocationCSR
      ~petsc4py.PETSc.Mat.setPreallocationDense
      ~petsc4py.PETSc.Mat.setPreallocationNNZ
      ~petsc4py.PETSc.Mat.setPythonContext
      ~petsc4py.PETSc.Mat.setPythonType
      ~petsc4py.PETSc.Mat.setRandom
      ~petsc4py.PETSc.Mat.setSizes
      ~petsc4py.PETSc.Mat.setStencil
      ~petsc4py.PETSc.Mat.setTransposeNullSpace
      ~petsc4py.PETSc.Mat.setTransposePrecursor
      ~petsc4py.PETSc.Mat.setType
      ~petsc4py.PETSc.Mat.setUnfactored
      ~petsc4py.PETSc.Mat.setUp
      ~petsc4py.PETSc.Mat.setValue
      ~petsc4py.PETSc.Mat.setValueBlockedStagStencil
      ~petsc4py.PETSc.Mat.setValueBlockedStencil
      ~petsc4py.PETSc.Mat.setValueLocal
      ~petsc4py.PETSc.Mat.setValueStagStencil
      ~petsc4py.PETSc.Mat.setValueStencil
      ~petsc4py.PETSc.Mat.setValues
      ~petsc4py.PETSc.Mat.setValuesBlocked
      ~petsc4py.PETSc.Mat.setValuesBlockedCSR
      ~petsc4py.PETSc.Mat.setValuesBlockedIJV
      ~petsc4py.PETSc.Mat.setValuesBlockedLocal
      ~petsc4py.PETSc.Mat.setValuesBlockedLocalCSR
      ~petsc4py.PETSc.Mat.setValuesBlockedLocalIJV
      ~petsc4py.PETSc.Mat.setValuesBlockedLocalRCV
      ~petsc4py.PETSc.Mat.setValuesBlockedRCV
      ~petsc4py.PETSc.Mat.setValuesCSR
      ~petsc4py.PETSc.Mat.setValuesIJV
      ~petsc4py.PETSc.Mat.setValuesLocal
      ~petsc4py.PETSc.Mat.setValuesLocalCSR
      ~petsc4py.PETSc.Mat.setValuesLocalIJV
      ~petsc4py.PETSc.Mat.setValuesLocalRCV
      ~petsc4py.PETSc.Mat.setValuesRCV
      ~petsc4py.PETSc.Mat.setVecType
      ~petsc4py.PETSc.Mat.shift
      ~petsc4py.PETSc.Mat.solve
      ~petsc4py.PETSc.Mat.solveAdd
      ~petsc4py.PETSc.Mat.solveBackward
      ~petsc4py.PETSc.Mat.solveForward
      ~petsc4py.PETSc.Mat.solveTranspose
      ~petsc4py.PETSc.Mat.solveTransposeAdd
      ~petsc4py.PETSc.Mat.storeValues
      ~petsc4py.PETSc.Mat.toDLPack
      ~petsc4py.PETSc.Mat.transpose
      ~petsc4py.PETSc.Mat.transposeMatMult
      ~petsc4py.PETSc.Mat.view
      ~petsc4py.PETSc.Mat.zeroEntries
      ~petsc4py.PETSc.Mat.zeroRows
      ~petsc4py.PETSc.Mat.zeroRowsColumns
      ~petsc4py.PETSc.Mat.zeroRowsColumnsLocal
      ~petsc4py.PETSc.Mat.zeroRowsColumnsStencil
      ~petsc4py.PETSc.Mat.zeroRowsLocal

   
   .. rubric:: Attributes Summary
   .. autosummary::
   
      ~petsc4py.PETSc.Mat.assembled
      ~petsc4py.PETSc.Mat.block_size
      ~petsc4py.PETSc.Mat.block_sizes
      ~petsc4py.PETSc.Mat.hermitian
      ~petsc4py.PETSc.Mat.local_size
      ~petsc4py.PETSc.Mat.owner_range
      ~petsc4py.PETSc.Mat.owner_ranges
      ~petsc4py.PETSc.Mat.size
      ~petsc4py.PETSc.Mat.sizes
      ~petsc4py.PETSc.Mat.structsymm
      ~petsc4py.PETSc.Mat.symmetric

   
   .. rubric:: Methods Documentation
   
   .. automethod:: H2OpusCompress
   .. automethod:: H2OpusLowRankUpdate
   .. automethod:: H2OpusOrthogonalize
   .. automethod:: SOR
   .. automethod:: appendOptionsPrefix
   .. automethod:: assemble
   .. automethod:: assemblyBegin
   .. automethod:: assemblyEnd
   .. automethod:: axpy
   .. automethod:: aypx
   .. automethod:: bindToCPU
   .. automethod:: boundToCPU
   .. automethod:: chop
   .. automethod:: conjugate
   .. automethod:: convert
   .. automethod:: copy
   .. automethod:: create
   .. automethod:: createAIJ
   .. automethod:: createAIJCRL
   .. automethod:: createAIJWithArrays
   .. automethod:: createBAIJ
   .. automethod:: createConstantDiagonal
   .. automethod:: createDense
   .. automethod:: createDenseCUDA
   .. automethod:: createDiagonal
   .. automethod:: createH2OpusFromMat
   .. automethod:: createHermitianTranspose
   .. automethod:: createIS
   .. automethod:: createLRC
   .. automethod:: createNest
   .. automethod:: createNormal
   .. automethod:: createNormalHermitian
   .. automethod:: createPython
   .. automethod:: createSBAIJ
   .. automethod:: createScatter
   .. automethod:: createSubMatrices
   .. automethod:: createSubMatrix
   .. automethod:: createSubMatrixVirtual
   .. automethod:: createTranspose
   .. automethod:: createVecLeft
   .. automethod:: createVecRight
   .. automethod:: createVecs
   .. automethod:: destroy
   .. automethod:: diagonalScale
   .. automethod:: duplicate
   .. automethod:: equal
   .. automethod:: factorCholesky
   .. automethod:: factorICC
   .. automethod:: factorILU
   .. automethod:: factorLU
   .. automethod:: factorNumericCholesky
   .. automethod:: factorNumericLU
   .. automethod:: factorSymbolicCholesky
   .. automethod:: factorSymbolicICC
   .. automethod:: factorSymbolicILU
   .. automethod:: factorSymbolicLU
   .. automethod:: findZeroRows
   .. automethod:: fixISLocalEmpty
   .. automethod:: getBlockSize
   .. automethod:: getBlockSizes
   .. automethod:: getColumnIJ
   .. automethod:: getColumnVector
   .. automethod:: getDM
   .. automethod:: getDenseArray
   .. automethod:: getDenseColumnVec
   .. automethod:: getDenseLDA
   .. automethod:: getDenseLocalMatrix
   .. automethod:: getDiagonal
   .. automethod:: getDiagonalBlock
   .. automethod:: getISLocalMat
   .. automethod:: getInertia
   .. automethod:: getInfo
   .. automethod:: getLGMap
   .. automethod:: getLRCMats
   .. automethod:: getLocalSize
   .. automethod:: getLocalSubMatrix
   .. automethod:: getMumpsCntl
   .. automethod:: getMumpsIcntl
   .. automethod:: getMumpsInfo
   .. automethod:: getMumpsInfog
   .. automethod:: getMumpsRinfo
   .. automethod:: getMumpsRinfog
   .. automethod:: getNearNullSpace
   .. automethod:: getNestISs
   .. automethod:: getNestLocalISs
   .. automethod:: getNestSize
   .. automethod:: getNestSubMatrix
   .. automethod:: getNullSpace
   .. automethod:: getOption
   .. automethod:: getOptionsPrefix
   .. automethod:: getOrdering
   .. automethod:: getOwnershipIS
   .. automethod:: getOwnershipRange
   .. automethod:: getOwnershipRangeColumn
   .. automethod:: getOwnershipRanges
   .. automethod:: getOwnershipRangesColumn
   .. automethod:: getPythonContext
   .. automethod:: getPythonType
   .. automethod:: getRedundantMatrix
   .. automethod:: getRow
   .. automethod:: getRowIJ
   .. automethod:: getRowSum
   .. automethod:: getSize
   .. automethod:: getSizes
   .. automethod:: getTransposeNullSpace
   .. automethod:: getType
   .. automethod:: getValue
   .. automethod:: getValues
   .. automethod:: getValuesCSR
   .. automethod:: getVecType
   .. automethod:: hermitianTranspose
   .. automethod:: imagPart
   .. automethod:: increaseOverlap
   .. automethod:: invertBlockDiagonal
   .. automethod:: isAssembled
   .. automethod:: isHermitian
   .. automethod:: isHermitianKnown
   .. automethod:: isStructurallySymmetric
   .. automethod:: isSymmetric
   .. automethod:: isSymmetricKnown
   .. automethod:: isTranspose
   .. automethod:: kron
   .. automethod:: load
   .. automethod:: matMatMult
   .. automethod:: matMult
   .. automethod:: matSolve
   .. automethod:: matTransposeMult
   .. automethod:: mult
   .. automethod:: multAdd
   .. automethod:: multHermitian
   .. automethod:: multHermitianAdd
   .. automethod:: multTranspose
   .. automethod:: multTransposeAdd
   .. automethod:: norm
   .. automethod:: permute
   .. automethod:: ptap
   .. automethod:: rart
   .. automethod:: realPart
   .. automethod:: reorderForNonzeroDiagonal
   .. automethod:: restoreDenseColumnVec
   .. automethod:: restoreISLocalMat
   .. automethod:: restoreLocalSubMatrix
   .. automethod:: retrieveValues
   .. automethod:: scale
   .. automethod:: setBlockSize
   .. automethod:: setBlockSizes
   .. automethod:: setDM
   .. automethod:: setDenseLDA
   .. automethod:: setDiagonal
   .. automethod:: setFromOptions
   .. automethod:: setISLocalMat
   .. automethod:: setISPreallocation
   .. automethod:: setLGMap
   .. automethod:: setLRCMats
   .. automethod:: setMumpsCntl
   .. automethod:: setMumpsIcntl
   .. automethod:: setNearNullSpace
   .. automethod:: setNestVecType
   .. automethod:: setNullSpace
   .. automethod:: setOption
   .. automethod:: setOptionsPrefix
   .. automethod:: setPreallocationCSR
   .. automethod:: setPreallocationDense
   .. automethod:: setPreallocationNNZ
   .. automethod:: setPythonContext
   .. automethod:: setPythonType
   .. automethod:: setRandom
   .. automethod:: setSizes
   .. automethod:: setStencil
   .. automethod:: setTransposeNullSpace
   .. automethod:: setTransposePrecursor
   .. automethod:: setType
   .. automethod:: setUnfactored
   .. automethod:: setUp
   .. automethod:: setValue
   .. automethod:: setValueBlockedStagStencil
   .. automethod:: setValueBlockedStencil
   .. automethod:: setValueLocal
   .. automethod:: setValueStagStencil
   .. automethod:: setValueStencil
   .. automethod:: setValues
   .. automethod:: setValuesBlocked
   .. automethod:: setValuesBlockedCSR
   .. automethod:: setValuesBlockedIJV
   .. automethod:: setValuesBlockedLocal
   .. automethod:: setValuesBlockedLocalCSR
   .. automethod:: setValuesBlockedLocalIJV
   .. automethod:: setValuesBlockedLocalRCV
   .. automethod:: setValuesBlockedRCV
   .. automethod:: setValuesCSR
   .. automethod:: setValuesIJV
   .. automethod:: setValuesLocal
   .. automethod:: setValuesLocalCSR
   .. automethod:: setValuesLocalIJV
   .. automethod:: setValuesLocalRCV
   .. automethod:: setValuesRCV
   .. automethod:: setVecType
   .. automethod:: shift
   .. automethod:: solve
   .. automethod:: solveAdd
   .. automethod:: solveBackward
   .. automethod:: solveForward
   .. automethod:: solveTranspose
   .. automethod:: solveTransposeAdd
   .. automethod:: storeValues
   .. automethod:: toDLPack
   .. automethod:: transpose
   .. automethod:: transposeMatMult
   .. automethod:: view
   .. automethod:: zeroEntries
   .. automethod:: zeroRows
   .. automethod:: zeroRowsColumns
   .. automethod:: zeroRowsColumnsLocal
   .. automethod:: zeroRowsColumnsStencil
   .. automethod:: zeroRowsLocal

   
   .. rubric:: Attributes Documentation
   
   .. autoattribute:: assembled
   .. autoattribute:: block_size
   .. autoattribute:: block_sizes
   .. autoattribute:: hermitian
   .. autoattribute:: local_size
   .. autoattribute:: owner_range
   .. autoattribute:: owner_ranges
   .. autoattribute:: size
   .. autoattribute:: sizes
   .. autoattribute:: structsymm
   .. autoattribute:: symmetric