Skip to content

Commit

Permalink
More in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fverdugo committed Jan 23, 2024
1 parent 8378be1 commit 29e436c
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 15 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- Configuration of PETSc installation using Preferences.jl.
- High-level wrapper of KSP solvers.
- Support for sequential runs
- Support for parallel parallel runs with PartitionedArrays.jl
- Support for sequential runs.
- Support for parallel parallel runs with PartitionedArrays.jl.
- Commonly used low-level API for KSP solvers.
21 changes: 8 additions & 13 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,17 @@ Documentation for [PETSC](https://github.com/fverdugo/PETSC.jl).

## What

The goal of this package is to provide a high-level Julia interface to solvers from the PETSc library.
The goal of this package is to provide a high-level Julia interface to solvers from the [PETSc](https://petsc.org/) library.
At this moment it wraps linear solvers from the KSP module in PETSc, but the goal is to also
provide nonlinear solvers from the SNES module in PETSc. The package also provides a low-level interface with functions
that are almost 1-to-1 to the corresponding C functions for advanced users. The low level API is mostly taken from GridapPETSc.jl.
that are almost 1-to-1 to the corresponding C functions for advanced users. The low level API is mostly taken from [GridapPETSc.jl](https://github.com/gridap/GridapPETSc.jl).

## Why
## Features

The main difference of this package with respect to other Julia bindings to PETSc (e.g., PETSc.jl),
is that our high-level interface is based on pure Julia types.
I.e., the high-level interface only provides new functions, and the inputs and outputs of the
such functions are pure Julia types. For instance, the functions to solve systems of linear equations
take standard Julia (sparse) matrices and vectors. For parallel computations, one can use the pure
Julia parallel sparse matrices and vectors implemented in PartitionedArrays.jl.
- Configuration of PETSc installation using [Preferences.jl](https://github.com/JuliaPackaging/Preferences.jl).
- High-level wrapper of KSP solvers.
- Support for sequential runs.
- Support for parallel parallel runs with [PartitionedArrays.jl](https://github.com/fverdugo/PartitionedArrays.jl).
- Commonly used low-level API for KSP solvers.

## Related packages

- https://github.com/JuliaParallel/PETSc.jl
- https://github.com/gridap/GridapPETSc.jl

0 comments on commit 29e436c

Please sign in to comment.