Skip to content

Commit 1a43091

Browse files
committed
Readme [ci skip]
1 parent 7704db2 commit 1a43091

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,19 @@ This package lets you solve sparse linear systems using Algebraic Multigrid (AMG
99

1010
## Usage
1111

12+
### Using the CommonSolve interface
13+
14+
This is highest level API. It internally creates the multilevel object
15+
and calls the multigrid cycling `_solve`.
16+
17+
```julia
18+
A = poisson(100);
19+
b = rand(100);
20+
solve(A, b, RugeStubenAMG(), maxiter = 1, abstol = 1e-6)
21+
```
22+
23+
### Multigrid cycling
24+
1225
```julia
1326
using AlgebraicMultigrid
1427

@@ -32,7 +45,7 @@ ml = ruge_stuben(A) # Construct a Ruge-Stuben solver
3245
# 8 7 19 [ 0.32%]
3346

3447

35-
solve(ml, A * ones(1000)) # should return ones(1000)
48+
AlgebraicMultigrid._solve(ml, A * ones(1000)) # should return ones(1000)
3649
```
3750

3851
### As a Preconditioner

0 commit comments

Comments
 (0)