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
256 lines
4.6 KiB
ReStructuredText
256 lines
4.6 KiB
ReStructuredText
.. meta::
|
|
:description: rocALUTION multi-node computation
|
|
:keywords: rocALUTION, ROCm, library, API, tool, API library.
|
|
|
|
.. _api:
|
|
|
|
************************
|
|
rocALUTION API library
|
|
************************
|
|
|
|
This document provides the detailed API list.
|
|
|
|
Backend Module
|
|
==============
|
|
.. doxygengroup:: backend_module
|
|
|
|
Base Rocalution
|
|
===============
|
|
.. doxygenclass:: rocalution::BaseRocalution
|
|
:members:
|
|
|
|
Operator
|
|
========
|
|
.. doxygenclass:: rocalution::Operator
|
|
:members:
|
|
|
|
Vector
|
|
======
|
|
.. doxygenclass:: rocalution::Vector
|
|
:members:
|
|
|
|
Local Matrix
|
|
============
|
|
.. doxygenclass:: rocalution::LocalMatrix
|
|
:members:
|
|
|
|
Local Stencil
|
|
=============
|
|
.. doxygenclass:: rocalution::LocalStencil
|
|
:members:
|
|
|
|
Global Matrix
|
|
=============
|
|
.. doxygenclass:: rocalution::GlobalMatrix
|
|
:members:
|
|
|
|
Local Vector
|
|
============
|
|
.. doxygenclass:: rocalution::LocalVector
|
|
:members:
|
|
|
|
Global Vector
|
|
=============
|
|
.. doxygenclass:: rocalution::GlobalVector
|
|
:members:
|
|
|
|
Base Classes
|
|
============
|
|
.. doxygenclass:: rocalution::BaseMatrix
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::BaseStencil
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::BaseVector
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::HostMatrix
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::HostStencil
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::HostVector
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::AcceleratorMatrix
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::AcceleratorStencil
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::AcceleratorVector
|
|
:members:
|
|
|
|
Parallel Manager
|
|
================
|
|
.. doxygenclass:: rocalution::ParallelManager
|
|
:members:
|
|
|
|
Solvers
|
|
=======
|
|
.. doxygenclass:: rocalution::Solver
|
|
:members:
|
|
|
|
Iterative Linear Solvers
|
|
------------------------
|
|
.. doxygenclass:: rocalution::IterativeLinearSolver
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::FixedPoint
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::MixedPrecisionDC
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::Chebyshev
|
|
:members:
|
|
|
|
Krylov Subspace Solvers
|
|
```````````````````````
|
|
.. doxygenclass:: rocalution::BiCGStab
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::BiCGStabl
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::CG
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::CR
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::FCG
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::GMRES
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::FGMRES
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::IDR
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::QMRCGStab
|
|
:members:
|
|
|
|
MultiGrid Solvers
|
|
`````````````````
|
|
.. doxygenclass:: rocalution::BaseMultiGrid
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::MultiGrid
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::BaseAMG
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::UAAMG
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::SAAMG
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::RugeStuebenAMG
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::PairwiseAMG
|
|
:members:
|
|
|
|
Direct Solvers
|
|
--------------
|
|
.. doxygenclass:: rocalution::DirectLinearSolver
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::Inversion
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::LU
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::QR
|
|
:members:
|
|
|
|
|
|
Preconditioners
|
|
===============
|
|
.. doxygenclass:: rocalution::Preconditioner
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::AIChebyshev
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::FSAI
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::SPAI
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::TNS
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::AS
|
|
:members:
|
|
|
|
.. figure:: ../data/AS.png
|
|
:alt: 4 block additive schwarz
|
|
:align: center
|
|
|
|
Example of a 4 block-decomposed matrix - Additive Schwarz with overlapping preconditioner (left) and Restricted Additive Schwarz preconditioner (right).
|
|
|
|
.. doxygenclass:: rocalution::RAS
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::BlockJacobi
|
|
:members:
|
|
|
|
.. figure:: ../data/BJ.png
|
|
:alt: 4 block jacobi
|
|
:align: center
|
|
|
|
Example of a 4 block-decomposed matrix - Block-Jacobi preconditioner.
|
|
|
|
.. doxygenclass:: rocalution::BlockPreconditioner
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::Jacobi
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::GS
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::SGS
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::ILU
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::ILUT
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::IC
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::VariablePreconditioner
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::MultiColored
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::MultiColoredSGS
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::MultiColoredGS
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::MultiColoredILU
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::MultiElimination
|
|
:members:
|
|
|
|
.. doxygenclass:: rocalution::DiagJacobiSaddlePointPrecond
|
|
:members:
|