Skip to content

Commit

Permalink
slightly reorder preconditioner docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@j-fu
j-fu committed Jan 17, 2024
1 parent 0cb41f2 commit b2fc788
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 23 deletions.
2 changes: 1 addition & 1 deletion Project.toml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "ExtendableSparse"
uuid = "95c220a8-a1cf-11e9-0c77-dbfce5f500b3"
authors = ["Juergen Fuhrmann <juergen.fuhrmann@wias-berlin.de>"]
version = "1.3"
version = "1.3.1"

[deps]
AMGCLWrap = "4f76b812-4ba5-496d-b042-d70715554288"
Expand Down
35 changes: 13 additions & 22 deletions docs/src/iter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@ This functionality probably will be reduced in favor of LinearSolve.jl.
In this package, preconditioners and LU factorizations are both seen
as complete or approximate _factorizations_. Correspondingly we provide a common API for them.

```docs

```
ExtendableSparse.AbstractLUFactorization
```@autodocs
Modules = [ExtendableSparse]
Expand Down Expand Up @@ -67,8 +65,6 @@ nm2 = norm(factorization \ b)
nm1, nm2
```

### API
Available by default:
```@autodocs
Modules = [ExtendableSparse]
Pages = ["umfpack_lu.jl", "sparspak.jl"]
Expand All @@ -80,14 +76,6 @@ ExtendableSparse.CholeskyFactorization
Base.:\
```


Pardiso extension:
```@docs
PardisoLU
MKLPardisoLU
```


## Preconditioners

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

### API

#### Recommended
Available by default:

```@docs
ExtendableSparse.AbstractPreconditioner
```

```@autodocs
Modules = [ExtendableSparse]
Pages = ["iluzero.jl","ilut.jl","amg.jl","blockpreconditioner.jl"]
```

Extensions:
```@docs
ILUTPreconditioner
ExtendableSparse.AMGCL_AMGPreconditioner
ExtendableSparse.AMGCL_RLXPreconditioner
ExtendableSparse.RS_AMGPreconditioner
ExtendableSparse.SA_AMGPreconditioner
ExtendableSparse.RS_AMGPreconditioner
ILUTPreconditioner
```


## Experimental/deprecated


```@docs
PardisoLU
MKLPardisoLU
ExtendableSparse.AMGPreconditioner
```


#### Experimental
```@autodocs
Modules = [ExtendableSparse]
Pages = ["jacobi.jl","parallel_jacobi.jl","ilu0.jl",]
```

### Iteration schemes
## Iteration schemes
```@docs
ExtendableSparse.simple!
```

2 comments on commit b2fc788

@j-fu
Copy link
Owner Author

@j-fu j-fu commented on b2fc788 Jan 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/99030

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.3.1 -m "<description of version>" b2fc788fd25a08b7110d90bc517143a5805591c7
git push origin v1.3.1

Please sign in to comment.