From 379fbbe75e9c980e6b77bb97456e06ca5f8445fd Mon Sep 17 00:00:00 2001 From: "Documenter.jl" Date: Wed, 5 Oct 2022 13:11:24 +0000 Subject: [PATCH] build based on 19bfeaf --- dev/api/index.html | 2 +- dev/assets/documenter.js | 3 +++ dev/index.html | 2 +- dev/libhypre/index.html | 2 +- dev/matrix-vector/index.html | 2 +- dev/search/index.html | 2 +- dev/solvers-preconditioners/index.html | 2 +- 7 files changed, 9 insertions(+), 6 deletions(-) diff --git a/dev/api/index.html b/dev/api/index.html index f85cdd2..e107592 100644 --- a/dev/api/index.html +++ b/dev/api/index.html @@ -1,2 +1,2 @@ -API · HYPRE.jl
GitHub

API

Initialization and configuration

HYPRE.Init — Function
Init(; finalize_atexit=true)

Wrapper around HYPRE_Init. If finalize_atexit is true a Julia exit hook is added, which calls HYPRE_Finalize. This method will also call MPI.Init unless MPI is already initialized.

Note: This function must be called before using HYPRE functions.

source

Solvers and preconditioners

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
+API · HYPRE.jl
GitHub

API

Initialization and configuration

HYPRE.Init — Function
Init(; finalize_atexit=true)

Wrapper around HYPRE_Init. If finalize_atexit is true a Julia exit hook is added, which calls HYPRE_Finalize. This method will also call MPI.Init unless MPI is already initialized.

Note: This function must be called before using HYPRE functions.

source

Solvers and preconditioners

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
diff --git a/dev/assets/documenter.js b/dev/assets/documenter.js index 6adfbbb..ca0e34e 100644 --- a/dev/assets/documenter.js +++ b/dev/assets/documenter.js @@ -77,6 +77,9 @@ function addCopyButtonCallbacks() { for (const el of document.getElementsByTagName("pre")) { const button = document.createElement("button"); button.classList.add("copy-button", "fas", "fa-copy"); + button.setAttribute("aria-label", "Copy this code block"); + button.setAttribute("title", "Copy"); + el.appendChild(button); const success = function () { diff --git a/dev/index.html b/dev/index.html index b2f3c94..9f4ac5a 100644 --- a/dev/index.html +++ b/dev/index.html @@ -1,2 +1,2 @@ -Home · HYPRE.jl
GitHub

HYPRE.jl

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

High level interface

HYPRE.jl provide a high level interface to the HYPRE library. The goal of this interface is that the style and API should feel natural to most Julia programmers (it is "Julian"). In particular, you can use standard sparse matrices together with HYPRE's solvers through this interface.

The high level interface does not (currently) provide access to all of HYPREs functionality, but it can easily be combined with the low level interface when necessary.

Low level interface

HYPRE.jl also provide a low level interface for interacting with HYPRE. The goal of this interface is to stay close to the HYPRE C API. In fact, this interface is automatically generated based on HYPRE's header files, so this API maps one-to-one with the C API, see LibHYPRE C API for more details.

+Home · HYPRE.jl
GitHub

HYPRE.jl

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

High level interface

HYPRE.jl provide a high level interface to the HYPRE library. The goal of this interface is that the style and API should feel natural to most Julia programmers (it is "Julian"). In particular, you can use standard sparse matrices together with HYPRE's solvers through this interface.

The high level interface does not (currently) provide access to all of HYPREs functionality, but it can easily be combined with the low level interface when necessary.

Low level interface

HYPRE.jl also provide a low level interface for interacting with HYPRE. The goal of this interface is to stay close to the HYPRE C API. In fact, this interface is automatically generated based on HYPRE's header files, so this API maps one-to-one with the C API, see LibHYPRE C API for more details.

diff --git a/dev/libhypre/index.html b/dev/libhypre/index.html index afdd939..bf84620 100644 --- a/dev/libhypre/index.html +++ b/dev/libhypre/index.html @@ -1,2 +1,2 @@ -LibHYPRE C API · HYPRE.jl
GitHub

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 signatureArgument to pass
HYPRE_IJMatrixA.ijmatrix where A::HYPREMatrix
HYPRE_ParCSRMatrixA.parmatrix where A::HYPREMatrix
HYPRE_IJVectorb.ijvector where b::HYPREVector
HYPRE_ParVectorb.parvector where b::HYPREVector
HYPRE_Solvers.solver where s::HYPRESolver
+LibHYPRE C API · HYPRE.jl
GitHub

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 signatureArgument to pass
HYPRE_IJMatrixA.ijmatrix where A::HYPREMatrix
HYPRE_ParCSRMatrixA.parmatrix where A::HYPREMatrix
HYPRE_IJVectorb.ijvector where b::HYPREVector
HYPRE_ParVectorb.parvector where b::HYPREVector
HYPRE_Solvers.solver where s::HYPRESolver
diff --git a/dev/matrix-vector/index.html b/dev/matrix-vector/index.html index 41c3fd6..990e94c 100644 --- a/dev/matrix-vector/index.html +++ b/dev/matrix-vector/index.html @@ -30,4 +30,4 @@ x = solve(solver, A, b) # Inplace solve with x as initial guess x = zeros(length(b)) -solve!(solver, x, A, b)

SparseMatrixCSC / SparseMatrixCSR (multi-process)

Warning

This interface isn't finalized yet and is therefore not documented since it is subject to change.

+solve!(solver, x, A, b)

SparseMatrixCSC / SparseMatrixCSR (multi-process)

Warning

This interface isn't finalized yet and is therefore not documented since it is subject to change.

diff --git a/dev/search/index.html b/dev/search/index.html index d65c80d..1b9dd74 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/solvers-preconditioners/index.html b/dev/solvers-preconditioners/index.html index 4985b08..0830399 100644 --- a/dev/solvers-preconditioners/index.html +++ b/dev/solvers-preconditioners/index.html @@ -44,4 +44,4 @@ HYPRE_PCGSetPrecond(solver, (HYPRE_PtrToSolverFcn) HYPRE_BoomerAMGSolve, /* Solve */ HYPRE_ParCSRPCGSetup(solver, A, b, x); -HYPRE_ParCSRPCGSolve(solver, A, b, x); +HYPRE_ParCSRPCGSolve(solver, A, b, x);