LibHYPRE C API
The submodule HYPRE.LibHYPRE contains auto-generated bindings to the HYPRE library and give access to the HYPRE C API directly[1]. The module exports all HYPRE_* symbols. Function names and arguments are identical to the C-library – refer to the HYPRE manual for details.
The example program examples/ex5.jl is an (almost) line-to-line translation of the corresponding example program examples/ex5.c written in C, and showcases how HYPRE.jl can be used to interact with the HYPRE library directly.
Functions from the LibHYPRE submodule can be used together with the high level interface. This is useful when you need some functionality from the library which isn't exposed in the high level interface. Many functions require passing a reference to a matrix/vector or a solver. These can be obtained as follows:
| C type signature | Argument to pass |
|---|---|
HYPRE_IJMatrix | A.ijmatrix where A::HYPREMatrix |
HYPRE_ParCSRMatrix | A.parmatrix where A::HYPREMatrix |
HYPRE_IJVector | b.ijvector where b::HYPREVector |
HYPRE_ParVector | b.parvector where b::HYPREVector |
HYPRE_Solver | s.solver where s::HYPRESolver |
- 1Bindings are generated using Clang.jl, see gen/generator.jl.