Skip to content

Commit b2fc788

Browse files
committed
slightly reorder preconditioner docs
1 parent 0cb41f2 commit b2fc788

File tree

2 files changed

+14
-23
lines changed

2 files changed

+14
-23
lines changed

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "ExtendableSparse"
22
uuid = "95c220a8-a1cf-11e9-0c77-dbfce5f500b3"
33
authors = ["Juergen Fuhrmann <juergen.fuhrmann@wias-berlin.de>"]
4-
version = "1.3"
4+
version = "1.3.1"
55

66
[deps]
77
AMGCLWrap = "4f76b812-4ba5-496d-b042-d70715554288"

docs/src/iter.md

Lines changed: 13 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@ This functionality probably will be reduced in favor of LinearSolve.jl.
77
In this package, preconditioners and LU factorizations are both seen
88
as complete or approximate _factorizations_. Correspondingly we provide a common API for them.
99

10-
```docs
1110

12-
```
1311
ExtendableSparse.AbstractLUFactorization
1412
```@autodocs
1513
Modules = [ExtendableSparse]
@@ -67,8 +65,6 @@ nm2 = norm(factorization \ b)
6765
nm1, nm2
6866
```
6967

70-
### API
71-
Available by default:
7268
```@autodocs
7369
Modules = [ExtendableSparse]
7470
Pages = ["umfpack_lu.jl", "sparspak.jl"]
@@ -80,14 +76,6 @@ ExtendableSparse.CholeskyFactorization
8076
Base.:\
8177
```
8278

83-
84-
Pardiso extension:
85-
```@docs
86-
PardisoLU
87-
MKLPardisoLU
88-
```
89-
90-
9179
## Preconditioners
9280

9381
The API is similar to that for LU factorizations.
@@ -136,37 +124,40 @@ nm2 = norm(cg(A, b; Pl = preconditioner))
136124
nm1, nm2
137125
```
138126

139-
### API
140-
141-
#### Recommended
142-
Available by default:
143-
144127
```@docs
145128
ExtendableSparse.AbstractPreconditioner
146129
```
130+
147131
```@autodocs
148132
Modules = [ExtendableSparse]
149133
Pages = ["iluzero.jl","ilut.jl","amg.jl","blockpreconditioner.jl"]
150134
```
151135

152-
Extensions:
153136
```@docs
154-
ILUTPreconditioner
155137
ExtendableSparse.AMGCL_AMGPreconditioner
156138
ExtendableSparse.AMGCL_RLXPreconditioner
157-
ExtendableSparse.RS_AMGPreconditioner
158139
ExtendableSparse.SA_AMGPreconditioner
140+
ExtendableSparse.RS_AMGPreconditioner
141+
ILUTPreconditioner
142+
```
143+
144+
145+
## Experimental/deprecated
146+
147+
148+
```@docs
149+
PardisoLU
150+
MKLPardisoLU
159151
ExtendableSparse.AMGPreconditioner
160152
```
161153

162154

163-
#### Experimental
164155
```@autodocs
165156
Modules = [ExtendableSparse]
166157
Pages = ["jacobi.jl","parallel_jacobi.jl","ilu0.jl",]
167158
```
168159

169-
### Iteration schemes
160+
## Iteration schemes
170161
```@docs
171162
ExtendableSparse.simple!
172163
```

0 commit comments

Comments
 (0)