1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
|
.. _doc_matrix:
==========================================
Summary of Matrix Types Available In PETSc
==========================================
.. list-table::
:widths: auto
:align: center
:header-rows: 1
* - Format
- Matrix Types
- Constructor
- External Packages
- Details
* - CSR
- ``MATAIJ``
- ``MatCreateAIJ()``
-
- Compressed sparse row
* -
- ``MATAIJMKL``
- ``MatCreateMPIAIJMKL()``
- Intel oneAPI MKL
- OpenMP support
* -
- ``MATAIJSELL``
- ``MatCreateMPIAIJSELL()``
-
- SIMD acceleration
* -
- ``MATAIJPERM``
- ``MatCreateMPIAIJPERM()``
-
- Vectorized version
* -
- ``MATAIJCUSPARSE``
- ``MatCreateAIJCUSPARSE()``
- NVIDIA cuSPARSE library
- NVIDIA GPU acceleration
* -
- ``MATAIJKOKKOS``
- ``MatCreateAIJKokkos()``
- Kokkos
- GPU acceleration
* - Constant row length
- ``MATAIJCRL``
- ``MatCreateMPIAIJCRL()``
-
- Vectorized version
* - Multiple applications of single ``MATAIJ``
- ``MATMAIJ``
- ``MatCreateMAIJ()``
-
- Commonly used for identical interpolations on each component of a multi-component vector
* - Kronecker product of sparse matrix :math:`A`; :math:`I \otimes S + A \otimes T`
- ``MATKAIJ``
- ``MatCreateKAIJ()``
-
-
* - Sliced Ellpack
- ``MATSELL``
- ``MatCreateSELL()``
-
- SIMD and GPU acceleration
* - Block CSR
- ``MATBAIJ``
- ``MatCreateBAIJ()``
-
- Block compressed sparse row
* - Symmetric Block CSR
- ``MATSBAIJ``
- ``MatCreateSBAIJ()``
-
- Upper triangular compressed sparse row
* - Dense
- ``MATDENSE``
- ``MatCreateDense()``
-
- Row oriented storage
* -
- ``MATELEMENTAL``
- ``MatCreateElemental()``
- Elemental by Jack Poulson
- Block cyclic storage
* -
- ``MATSCALAPACK``
- ``MatCreateScaLAPACK()``
- ScaLAPACK
- Block cyclic storage
* -
- ``MATDENSECUDA``
- ``MatCreateDenseCUDA()``
-
- NVIDIA GPU Acceleration
* - ``MatMult()`` via finite differencing of a function
- ``MATMFFD``, see :any:`sec_nlmatrixfree`
- ``MatCreateMFFD()``, see also ``MatCreateSNESMF()``
-
- Provides only matrix-vector products
* - User-provided operations
- ``MATSHELL``, see also :any:`sec_matrixfree`
- ``MatCreateShell()``
-
-
* - Low-rank updates
- ``MATLMVM``, ``MATLMVMDFP``, ``MATLMVMBFGS``, ``MATLMVMSR1``, ...
- ``MatCreateLMVM()``
-
- limited-memory BFGS style matrices
* -
- ``MATLRC``
- ``MatCreateLRC()``
-
- :math:`A + UCV^T`
* - FFT
- ``MATFFTW``
- ``MatCreateFFT()``
- FFTW
-
* -
- ``MATSEQCUFFT``
- ``MatCreateSeqCUFFT()``
- NVIDIA's CuFFT
- NVIDIA GPUs
* - Hierarchical
- ``MATHTOOL``
- ``MatCreateHtoolFromKernel()``
- Htool
-
* -
- ``MATH2OPUS``
- ``MatCreateH2OpusFromMat()``
- :math:`\mathcal H^2` matrices
-
* - Transpose, :math:`A^T`, virtual
- ``MATTRANSPOSEVIRTUAL``
- ``MatCreateTranspose()``
-
-
* - Hermitian Transpose, :math:`A^H`, virtual
- ``MATHERMITIANTRANSPOSEVIRTUAL``
- ``MatCreateHermitianTranspose()``
-
-
* - Normal, :math:`A^TA`, virtual
- ``MATNORMAL``
- ``MatCreateNormal()``
-
-
* - Hermitian Normal, :math:`A^HA`, virtual
- ``MATNORMALHERMITIAN``
- ``MatCreateNormalHermitian()``
-
-
* - Schur complement
- ``MATSCHURCOMPLEMENT``
- ``MatCreateSchurComplement()``, ``MatGetSchurComplement()``
-
-
* - Sub-matrix, virtual
- ``MATSUBMATRIX``
- ``MatCreateSubMatrixVirtual()``
-
- Provides ``MatMult()`` and similar operations
* -
- ``MATLOCALREF``
- ``MatCreateLocalRef()``
-
- For use in matrix assembly
* - Nested matrix
- ``MATNEST``
- ``MatCreateNest()``
-
-
* - Scatter operator
- ``MATSCATTER``
- ``MatCreateScatter()``
-
-
* - Centering operator
- ``MATCENTERING``
- ``MatCreateCentering()``
-
- :math:`I - \frac{1}{N}e e^T`, :math:`e=[1,\dots,1]^T`
* - Block matrix
- ``MATBLOCKMAT``
- ``MatCreateBlockMat()``
-
-
|