Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update preconditioner docs #460

Merged
merged 2 commits into from
Jan 23, 2024
Merged

Update preconditioner docs #460

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f5abb5
Fix typo.
termi-official Jan 22, 2024
eb65943
add KrylovPreconditioners.jl
termi-official Jan 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions docs/src/basics/Preconditioners.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,13 +83,13 @@ The following preconditioners match the interface of LinearSolve.jl.
- [Preconditioners.CholeskyPreconditioner(A, i)](https://github.com/JuliaLinearAlgebra/Preconditioners.jl):
An incomplete Cholesky preconditioner with cut-off level `i`. Requires `A` as
a `AbstractMatrix` and positive semi-definite.
- [AlgebraicMultiGrid](https://github.com/JuliaLinearAlgebra/AlgebraicMultigrid.jl):
- [AlgebraicMultigrid](https://github.com/JuliaLinearAlgebra/AlgebraicMultigrid.jl):
Implementations of the algebraic multigrid method. Must be converted to a
preconditioner via `AlgebraicMultiGrid.aspreconditioner(AlgebraicMultiGrid.precmethod(A))`.
preconditioner via `AlgebraicMultigrid.aspreconditioner(AlgebraicMultigrid.precmethod(A))`.
Requires `A` as a `AbstractMatrix`. Provides the following methods:

+ `AlgebraicMultiGrid.ruge_stuben(A)`
+ `AlgebraicMultiGrid.smoothed_aggregation(A)`
+ `AlgebraicMultigrid.ruge_stuben(A)`
+ `AlgebraicMultigrid.smoothed_aggregation(A)`
- [PyAMG](https://github.com/cortner/PyAMG.jl):
Implementations of the algebraic multigrid method. Must be converted to a
preconditioner via `PyAMG.aspreconditioner(PyAMG.precmethod(A))`.
Expand All @@ -111,3 +111,9 @@ The following preconditioners match the interface of LinearSolve.jl.
preconditioners which supports distributed computing via MPI. These can be
written using the LinearSolve.jl interface choosing algorithms like `HYPRE.ILU`
and `HYPRE.BoomerAMG`.
- [KrylovPreconditioners.jl](https://github.com/JuliaSmoothOptimizers/KrylovPreconditioners.jl/): Provides GPU-ready
preconditioners via KernelAbstractions.jl. At the time of writing the package provides the following methods:

+ Incomplete Cholesky decomposition `KrylovPreconditioners.kp_ic0(A)`
+ Incomplete LU decomposition `KrylovPreconditioners.kp_ilu0(A)`
+ Block Jacobi `KrylovPreconditioners.BlockJacobiPreconditioner(A, nblocks, device)`
Loading