diff --git a/dev/index.html b/dev/index.html index 344b29b..5fb6e86 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,2 +1,2 @@ -Home · HYPRE.jl
GitHub

HYPRE.jl

Documentation for HYPRE.jl

HYPRE.solve! — Function
solve!(solver::HYPRESolver, x::HYPREVector, A::HYPREMatrix, b::HYPREVector)

Solve the linear system A x = b using solver with x as the initial guess. The approximate solution is stored in x.

See also solve.

source
HYPRE.solve — Function
solve(solver::HYPRESolver, A::HYPREMatrix, b::HYPREVector) -> HYPREVector

Solve the linear system A x = b using solver and return the approximate solution.

This method allocates an initial guess/output vector x, initialized to 0.

See also solve!.

source
+Home · HYPRE.jl
GitHub

HYPRE.jl

HYPRE.jl is a Julia wrapper for the HYPRE library, which provide parallel solvers for sparse linear systems.

diff --git a/dev/libhypre/index.html b/dev/libhypre/index.html new file mode 100644 index 0000000..8068836 --- /dev/null +++ b/dev/libhypre/index.html @@ -0,0 +1,2 @@ + +LibHYPRE · HYPRE.jl
GitHub

LibHYPRE

The submodule HYPRE.LibHYPRE contains auto-generated[1] bindings to the HYPRE library. The module exports all HYPRE_* symbols. Function names and arguments are identical to the C-library – refer to the HYPRE manual for details.

Functions from the LibHYPRE submodule can be used together with the "Julian" interface. This is useful when you need some functionality from the library which can't be accessed through the Julia interface. Many functions require passing a reference to a matrix/vector or a solver. These can be obtained as follows:

C type signatureArgument to pass
HYPRE_IJMatrixA.IJMatrix where A::HYPREMatrix
HYPRE_IJVectorb.IJVector where b::HYPREVector
HYPRE_ParCSRMatrixA.ParCSRMatrix where A::HYPREMatrix
HYPRE_ParVectorb.ParVector where b::HYPREVector
HYPRE_Solvers.Solver where s::HYPRESolver
diff --git a/dev/search/index.html b/dev/search/index.html index 6df667f..86e8625 100644 --- a/dev/search/index.html +++ b/dev/search/index.html @@ -1,2 +1,2 @@ -Search · HYPRE.jl
GitHub

Loading search...

    +Search · HYPRE.jl
    GitHub

    Loading search...

      diff --git a/dev/search_index.js b/dev/search_index.js index 96da06a..79f114e 100644 --- a/dev/search_index.js +++ b/dev/search_index.js @@ -1,3 +1,3 @@ var documenterSearchIndex = {"docs": -[{"location":"#HYPRE.jl","page":"Home","title":"HYPRE.jl","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Documentation for HYPRE.jl","category":"page"},{"location":"","page":"Home","title":"Home","text":"HYPRE.solve!\nHYPRE.solve","category":"page"},{"location":"#HYPRE.solve!","page":"Home","title":"HYPRE.solve!","text":"solve!(solver::HYPRESolver, x::HYPREVector, A::HYPREMatrix, b::HYPREVector)\n\nSolve the linear system A x = b using solver with x as the initial guess. The approximate solution is stored in x.\n\nSee also solve.\n\n\n\n\n\n","category":"function"},{"location":"#HYPRE.solve","page":"Home","title":"HYPRE.solve","text":"solve(solver::HYPRESolver, A::HYPREMatrix, b::HYPREVector) -> HYPREVector\n\nSolve the linear system A x = b using solver and return the approximate solution.\n\nThis method allocates an initial guess/output vector x, initialized to 0.\n\nSee also solve!.\n\n\n\n\n\n","category":"function"},{"location":"","page":"Home","title":"Home","text":"HYPRE.HYPRESolver","category":"page"},{"location":"#HYPRE.HYPRESolver","page":"Home","title":"HYPRE.HYPRESolver","text":"HYPRESolver\n\nAbstract super type of all the wrapped HYPRE solvers.\n\n\n\n\n\n","category":"type"}] +[{"location":"#HYPRE.jl","page":"Home","title":"HYPRE.jl","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"HYPRE.jl is a Julia wrapper for the HYPRE library, which provide parallel solvers for sparse linear systems.","category":"page"},{"location":"libhypre/#LibHYPRE","page":"LibHYPRE","title":"LibHYPRE","text":"","category":"section"},{"location":"libhypre/","page":"LibHYPRE","title":"LibHYPRE","text":"The submodule HYPRE.LibHYPRE contains auto-generated[1] bindings to the HYPRE library. The module exports all HYPRE_* symbols. Function names and arguments are identical to the C-library – refer to the HYPRE manual for details.","category":"page"},{"location":"libhypre/","page":"LibHYPRE","title":"LibHYPRE","text":"Functions from the LibHYPRE submodule can be used together with the \"Julian\" interface. This is useful when you need some functionality from the library which can't be accessed through the Julia interface. Many functions require passing a reference to a matrix/vector or a solver. These can be obtained as follows:","category":"page"},{"location":"libhypre/","page":"LibHYPRE","title":"LibHYPRE","text":"C type signature Argument to pass\nHYPRE_IJMatrix A.IJMatrix where A::HYPREMatrix\nHYPRE_IJVector b.IJVector where b::HYPREVector\nHYPRE_ParCSRMatrix A.ParCSRMatrix where A::HYPREMatrix\nHYPRE_ParVector b.ParVector where b::HYPREVector\nHYPRE_Solver s.Solver where s::HYPRESolver","category":"page"},{"location":"libhypre/","page":"LibHYPRE","title":"LibHYPRE","text":"[1]: Bindings are generated using Clang.jl, see gen/generator.jl.","category":"page"}] }