derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
114 lines
2.6 KiB
ReStructuredText
114 lines
2.6 KiB
ReStructuredText
.. meta::
|
|
:description: rocALUTION preconditioners
|
|
:keywords: rocALUTION, ROCm, library, API, preconditioners
|
|
|
|
.. _preconditioners:
|
|
|
|
***************************
|
|
rocALUTION Preconditioners
|
|
***************************
|
|
|
|
This document provides a category-wise listing of the preconditioners. All preconditioners support local operators. They can be used as a global preconditioner via block-jacobi scheme, which works locally on each interior matrix. To provide fast application, all preconditioners require extra memory to keep the approximated operator.
|
|
|
|
Member documentation, configuration routines, and usage notes for each class are on the :ref:`api` page.
|
|
|
|
Code structure
|
|
==============
|
|
|
|
The preconditioners provide a solution to the system :math:`Mz = r`, where the solution :math:`z` is either directly computed by the approximation scheme or iteratively obtained with :math:`z = 0` initial guess.
|
|
|
|
:cpp:class:`rocalution::Preconditioner`
|
|
|
|
Jacobi method
|
|
=============
|
|
|
|
:cpp:class:`rocalution::Jacobi`
|
|
|
|
(Symmetric) Gauss-Seidel or (S)SOR method
|
|
==========================================
|
|
|
|
:cpp:class:`rocalution::GS`, :cpp:class:`rocalution::SGS`
|
|
|
|
Incomplete factorizations
|
|
=========================
|
|
|
|
ILU
|
|
---
|
|
|
|
:cpp:class:`rocalution::ILU`
|
|
|
|
ILUT
|
|
----
|
|
|
|
:cpp:class:`rocalution::ILUT`
|
|
|
|
IC
|
|
---
|
|
|
|
:cpp:class:`rocalution::IC`
|
|
|
|
AI Chebyshev
|
|
============
|
|
|
|
:cpp:class:`rocalution::AIChebyshev`
|
|
|
|
FSAI
|
|
====
|
|
|
|
:cpp:class:`rocalution::FSAI`
|
|
|
|
SPAI
|
|
====
|
|
|
|
:cpp:class:`rocalution::SPAI`
|
|
|
|
TNS
|
|
===
|
|
|
|
:cpp:class:`rocalution::TNS`
|
|
|
|
MultiColored preconditioners
|
|
============================
|
|
|
|
:cpp:class:`rocalution::MultiColored`
|
|
|
|
MultiColored (symmetric) Gauss-Seidel / (S)SOR
|
|
----------------------------------------------
|
|
|
|
:cpp:class:`rocalution::MultiColoredGS`, :cpp:class:`rocalution::MultiColoredSGS`
|
|
|
|
MultiColored power(q)-pattern method ILU(p,q)
|
|
---------------------------------------------
|
|
|
|
:cpp:class:`rocalution::MultiColoredILU`
|
|
|
|
Multi-elimination incomplete LU
|
|
===============================
|
|
|
|
:cpp:class:`rocalution::MultiElimination`
|
|
|
|
Diagonal preconditioner for saddle-point problems
|
|
=================================================
|
|
|
|
:cpp:class:`rocalution::DiagJacobiSaddlePointPrecond`
|
|
|
|
(Restricted) Additive Schwarz preconditioner
|
|
============================================
|
|
|
|
:cpp:class:`rocalution::AS`, :cpp:class:`rocalution::RAS`
|
|
|
|
Block-Jacobi (MPI) preconditioner
|
|
=================================
|
|
|
|
:cpp:class:`rocalution::BlockJacobi`
|
|
|
|
Block preconditioner
|
|
====================
|
|
|
|
:cpp:class:`rocalution::BlockPreconditioner`
|
|
|
|
Variable preconditioner
|
|
=======================
|
|
|
|
:cpp:class:`rocalution::VariablePreconditioner`
|