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
66 lines
3.5 KiB
ReStructuredText
66 lines
3.5 KiB
ReStructuredText
.. meta::
|
|
:description: rocALUTION examples
|
|
:keywords: rocALUTION, ROCm, library, API, tool, examples
|
|
|
|
.. _clients:
|
|
|
|
****************************
|
|
rocALUTION client examples
|
|
****************************
|
|
|
|
rocALUTION clients host a variety of different examples as well as a unit test package.
|
|
To build rocALUTION with clients, see :ref:`install-rocalution`.
|
|
|
|
Examples
|
|
=========
|
|
The examples collection offers different possible set-ups of solvers and preconditioners.
|
|
The following tables provide a quick overview of various examples:
|
|
|
|
===================== ====
|
|
Example Description
|
|
===================== ====
|
|
``amg`` Algebraic Multigrid solver (smoothed aggregation scheme, GS smoothing)
|
|
``as-precond`` GMRES solver with Additive Schwarz preconditioning
|
|
``async`` Asynchronous rocALUTION object transfer
|
|
``benchmark`` Benchmarking important sparse functions
|
|
``bicgstab`` BiCGStab solver with multicolored Gauss-Seidel preconditioning
|
|
``block-precond`` GMRES solver with blockwise multicolored ILU preconditioning
|
|
``cg-amg`` CG solver with Algebraic Multigrid (smoothed aggregation scheme) preconditioning
|
|
``cg`` CG solver with Jacobi preconditioning
|
|
``cmk`` CG solver with ILU preconditioning using Cuthill McKee ordering
|
|
``direct`` Matrix inversion
|
|
``fgmres`` Flexible GMRES solver with multicolored Gauss-Seidel preconditioning
|
|
``fixed-point`` Fixed-Point iteration scheme using Jacobi relaxation
|
|
``gmres`` GMRES solver with multicolored Gauss-Seidel preconditioning
|
|
``idr`` Induced Dimension Reduction solver with Jacobi preconditioning
|
|
``key`` Sparse matrix unique key computation
|
|
``me-preconditioner`` CG solver with multi-elimination preconditioning
|
|
``mixed-precision`` Mixed-precision CG solver with multicolored ILU preconditioning
|
|
``power-method`` CG solver using Chebyshev preconditioning and power method for eigenvalue approximation
|
|
``simple-spmv`` Sparse Matrix Vector multiplication
|
|
``sp-precond`` BiCGStab solver with multicolored ILU preconditioning for saddle point problems
|
|
``stencil`` CG solver using stencil as operator
|
|
``tns`` CG solver with Truncated Neumann Series preconditioning
|
|
``var-precond`` FGMRES solver with variable preconditioning
|
|
===================== ====
|
|
|
|
================= ====
|
|
Example (MPI) Description
|
|
================= ====
|
|
``benchmark_mpi`` Benchmarking important sparse functions
|
|
``bicgstab_mpi`` BiCGStab solver with multicolored Gauss-Seidel preconditioning
|
|
``cg-amg_mpi`` CG solver with Algebraic Multigrid (pairwise aggregation scheme) preconditioning
|
|
``cg_mpi`` CG solver with Jacobi preconditioning
|
|
``fcg_mpi`` Flexible CG solver with ILU preconditioning
|
|
``fgmres_mpi`` Flexible GMRES solver with SParse Approximate Inverse preconditioning
|
|
``global-io_mpi`` File I/O with CG solver and Factorized Sparse Approximate Inverse preconditioning
|
|
``idr_mpi`` IDR solver with Factorized Sparse Approximate Inverse preconditioning
|
|
``qmrcgstab_mpi`` QMRCGStab solver with ILU-T preconditioning
|
|
================= ====
|
|
|
|
Unit Tests
|
|
===========
|
|
There are multiple unit tests available to test for bad arguments, invalid parameters, and solver and preconditioner functionality.
|
|
These unit tests are based on google test.
|
|
The tests cover a variety of solver, preconditioning, and matrix format combinations and can be performed on all available backends.
|