From eb5bcedac9d1a7f3ad99de210e57d7be71a769d1 Mon Sep 17 00:00:00 2001 From: "Documenter.jl" Date: Tue, 1 Oct 2024 09:08:56 +0000 Subject: [PATCH] build based on 65158ef --- dev/.documenter-siteinfo.json | 2 +- dev/api/index.html | 8 ++++---- dev/changelog/index.html | 2 +- dev/index.html | 2 +- dev/libhypre/index.html | 2 +- dev/matrix-vector/index.html | 2 +- dev/solvers-preconditioners/index.html | 2 +- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 4e4228b..b59a49b 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-29T01:27:53","documenter_version":"1.7.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-10-01T09:08:51","documenter_version":"1.7.0"}} \ No newline at end of file diff --git a/dev/api/index.html b/dev/api/index.html index a140c4e..e64c100 100644 --- a/dev/api/index.html +++ b/dev/api/index.html @@ -1,12 +1,12 @@ -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

Matrix/vector creation

HYPRE.start_assemble! — Function
HYPRE.start_assemble!(A::HYPREMatrix)                 -> HYPREMatrixAssembler
+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
Matrix/vector creation
HYPRE.start_assemble! — Function
HYPRE.start_assemble!(A::HYPREMatrix)                 -> HYPREMatrixAssembler
 HYPRE.start_assemble!(b::HYPREVector)                 -> HYPREVectorAssembler
-HYPRE.start_assemble!(A::HYPREMatrix, b::HYPREVector) -> HYPREAssembler
Initialize a new assembly for matrix A, vector b, or for both. This zeroes out any previous data in the arrays. Return a HYPREAssembler with allocated data buffers needed to perform the assembly efficiently.
See also: HYPRE.assemble!, HYPRE.finish_assemble!.
source
HYPRE.assemble! — Function
HYPRE.assemble!(A::HYPREMatrixAssembler, i, j, a::Matrix)
+HYPRE.start_assemble!(A::HYPREMatrix, b::HYPREVector) -> HYPREAssembler
Initialize a new assembly for matrix A, vector b, or for both. This zeroes out any previous data in the arrays. Return a HYPREAssembler with allocated data buffers needed to perform the assembly efficiently.
See also: HYPRE.assemble!, HYPRE.finish_assemble!.
source
HYPRE.assemble! — Function
HYPRE.assemble!(A::HYPREMatrixAssembler, i, j, a::Matrix)
 HYPRE.assemble!(A::HYPREVectorAssembler, i,    b::Vector)
 HYPRE.assemble!(A::HYPREAssembler,       ij,   a::Matrix, b::Vector)
Assemble (by adding) matrix contribution a, vector contribution b, into the underlying array(s) of the assembler at global row indices i and column indices j.
This is roughly equivalent to:
# A.A::HYPREMatrix
 A.A[i, j] += a
 
 # A.b::HYPREVector
-A.b[i] += b
See also: HYPRE.start_assemble!, HYPRE.finish_assemble!.
source
HYPRE.finish_assemble! — Function
HYPRE.finish_assemble!(A::HYPREMatrixAssembler)
 HYPRE.finish_assemble!(A::HYPREVectorAssembler)
-HYPRE.finish_assemble!(A::HYPREAssembler)
Finish the assembly. This synchronizes the data between processors.
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
HYPRE.GetNumIterations — Function
HYPRE.GetNumIterations(s::HYPRESolver)
Return number of iterations during the last solve with solver s.
This function dispatches on the solver to the corresponding C API wrapper LibHYPRE.HYPRE_$(Solver)GetNumIterations.
source
HYPRE.GetFinalRelativeResidualNorm — Function
HYPRE.GetFinalRelativeResidualNorm(s::HYPRESolver)
Return the final relative residual norm from the last solve with solver s.
This function dispatches on the solver to the corresponding C API wrapper LibHYPRE.HYPRE_$(Solver)GetFinalRelativeResidualNorm.
source

+HYPRE.finish_assemble!(A::HYPREAssembler)

Finish the assembly. This synchronizes the data between processors.

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
HYPRE.GetNumIterations — Function
HYPRE.GetNumIterations(s::HYPRESolver)

Return number of iterations during the last solve with solver s.

This function dispatches on the solver to the corresponding C API wrapper LibHYPRE.HYPRE_$(Solver)GetNumIterations.

source
HYPRE.GetFinalRelativeResidualNorm — Function
HYPRE.GetFinalRelativeResidualNorm(s::HYPRESolver)

Return the final relative residual norm from the last solve with solver s.

This function dispatches on the solver to the corresponding C API wrapper LibHYPRE.HYPRE_$(Solver)GetFinalRelativeResidualNorm.

source
diff --git a/dev/changelog/index.html b/dev/changelog/index.html index 653edf4..e5e4d5f 100644 --- a/dev/changelog/index.html +++ b/dev/changelog/index.html @@ -1,2 +1,2 @@ -Changelog · HYPRE.jl
GitHub

HYPRE.jl changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

v1.6.0 - 2024-09-29

Changed

  • PartitionedArrays.jl dependency upgraded from release series 0.3.x to release series 0.5.x. (#17, #18)
  • CEnum.jl dependency upgraded to release series 0.5.x (release series 0.4.x still allowed). (#17, #18)
  • PartitionedArrays.jl support (PSparseMatrix, PVector) is now provided by a package extension. (#23)
  • SparseMatricesCSR.jl support (SparseMatrixCSR) is now provided by a package extension. (#24)
  • SparseArrays.jl support (SparseMatrixCSC) is now provided by a package extension. (#25)

v1.5.0 - 2023-05-26

Changed

  • PartitionedArrays.jl dependency upgraded from version 0.2.x to version 0.3.x. (#16)

v1.4.0 - 2023-01-20

Added

  • New function HYPRE.GetFinalRelativeResidualNorm(s::HYPRESolver) for getting the final residual norm from a solver. This function dispatches on the solver to the corresponding C API wrapper LibHYPRE.HYPRE_${Solver}GetFinalRelativeResidualNorm. (#14)
  • New function HYPRE.GetNumIterations(s::HYPRESolver) for getting the number of iterations from a solver. This function dispatches on the solver to the corresponding C API wrapper LibHYPRE.HYPRE_${Solver}GetNumIterations. (#14)

v1.3.1 - 2023-01-14

Fixed

  • Solvers now keep an reference to the added preconditioner to make sure the preconditioner is not finalized before the solver. This fixes crashes (segfaults) that could happen in case no other reference to the preconditioner existed in the program. (#12)
  • The proper conversion methods for ccall are now defined for HYPREMatrix, HYPREVector, and HYPRESolver such that they can be passed direcly to HYPRE_* functions and let ccall guarantee the GC preservation of these objects. Although not observed in practice, this fixes a possible race condition where the matrix/vector/solver could be finalized too early. (#13)

v1.3.0 - 2022-12-30

Added

  • Rectangular matrices can now be assembled by the new method HYPRE.assemble!(::HYPREMatrixAssembler, i::Vector, j::Vector, a::Matrix) where i are the rows and j the columns. (#7)

Fixed

  • All created HYPRE objects (HYPREMatrix, HYPREVector, and HYPRESolvers) are now kept track of internally and explicitly finalized (if they haven't been GC'd) before finalizing HYPRE. This fixes a "race condition" where MPI and/or HYPRE would finalize before these Julia objects are garbage collected and finalized. (#8)

Deprecated

  • The method HYPRE.assemble!(A::HYPREMatrixAssembler, ij::Vector, a::Matrix) have been deprecated in favor of HYPRE.assemble!(A::HYPREMatrixAssembler, i::Vector, j::Vector, a::Matrix), i.e. it is now required to explicitly pass rows and column indices individually. The motivation behind this is to support assembling of rectangular matrices. Note that HYPRE.assemble!(A::HYPREAssembler, ij::Vector, a::Matrix, b::Vector) is still supported, where ij are used as row and column indices for a, as well as row indices for b. (#6)

v1.2.0 - 2022-10-12

Added

  • Added assembler interface to assemble HYPREMatrix and/or HYPREVector directly without an intermediate sparse structure in Julia. (#5)

v1.1.0 - 2022-10-05

Added

  • Added support for MPI.jl version 0.20.x (in addition to the existing version 0.19.x support). (#2)

v1.0.0 - 2022-07-28

Initial release of HYPRE.jl.

+Changelog · HYPRE.jl
GitHub

HYPRE.jl changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

v1.6.0 - 2024-09-29

Changed

  • PartitionedArrays.jl dependency upgraded from release series 0.3.x to release series 0.5.x. (#17, #18)
  • CEnum.jl dependency upgraded to release series 0.5.x (release series 0.4.x still allowed). (#17, #18)
  • PartitionedArrays.jl support (PSparseMatrix, PVector) is now provided by a package extension. (#23)
  • SparseMatricesCSR.jl support (SparseMatrixCSR) is now provided by a package extension. (#24)
  • SparseArrays.jl support (SparseMatrixCSC) is now provided by a package extension. (#25)

v1.5.0 - 2023-05-26

Changed

  • PartitionedArrays.jl dependency upgraded from version 0.2.x to version 0.3.x. (#16)

v1.4.0 - 2023-01-20

Added

  • New function HYPRE.GetFinalRelativeResidualNorm(s::HYPRESolver) for getting the final residual norm from a solver. This function dispatches on the solver to the corresponding C API wrapper LibHYPRE.HYPRE_${Solver}GetFinalRelativeResidualNorm. (#14)
  • New function HYPRE.GetNumIterations(s::HYPRESolver) for getting the number of iterations from a solver. This function dispatches on the solver to the corresponding C API wrapper LibHYPRE.HYPRE_${Solver}GetNumIterations. (#14)

v1.3.1 - 2023-01-14

Fixed

  • Solvers now keep an reference to the added preconditioner to make sure the preconditioner is not finalized before the solver. This fixes crashes (segfaults) that could happen in case no other reference to the preconditioner existed in the program. (#12)
  • The proper conversion methods for ccall are now defined for HYPREMatrix, HYPREVector, and HYPRESolver such that they can be passed direcly to HYPRE_* functions and let ccall guarantee the GC preservation of these objects. Although not observed in practice, this fixes a possible race condition where the matrix/vector/solver could be finalized too early. (#13)

v1.3.0 - 2022-12-30

Added

  • Rectangular matrices can now be assembled by the new method HYPRE.assemble!(::HYPREMatrixAssembler, i::Vector, j::Vector, a::Matrix) where i are the rows and j the columns. (#7)

Fixed

  • All created HYPRE objects (HYPREMatrix, HYPREVector, and HYPRESolvers) are now kept track of internally and explicitly finalized (if they haven't been GC'd) before finalizing HYPRE. This fixes a "race condition" where MPI and/or HYPRE would finalize before these Julia objects are garbage collected and finalized. (#8)

Deprecated

  • The method HYPRE.assemble!(A::HYPREMatrixAssembler, ij::Vector, a::Matrix) have been deprecated in favor of HYPRE.assemble!(A::HYPREMatrixAssembler, i::Vector, j::Vector, a::Matrix), i.e. it is now required to explicitly pass rows and column indices individually. The motivation behind this is to support assembling of rectangular matrices. Note that HYPRE.assemble!(A::HYPREAssembler, ij::Vector, a::Matrix, b::Vector) is still supported, where ij are used as row and column indices for a, as well as row indices for b. (#6)

v1.2.0 - 2022-10-12

Added

  • Added assembler interface to assemble HYPREMatrix and/or HYPREVector directly without an intermediate sparse structure in Julia. (#5)

v1.1.0 - 2022-10-05

Added

  • Added support for MPI.jl version 0.20.x (in addition to the existing version 0.19.x support). (#2)

v1.0.0 - 2022-07-28

Initial release of HYPRE.jl.

diff --git a/dev/index.html b/dev/index.html index 9b17ec8..d572a39 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 22956e5..23880ee 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. HYPRE.jl defines the appropriate conversion methods used by ccall such that

  • A::HYPREMatrix can be passed to HYPRE_* functions with HYPRE_IJMatrix or HYPRE_ParCSRMatrix in the signature
  • b::HYPREVector can be passed to HYPRE_* functions with HYPRE_IJVector or HYPRE_ParVector in the signature
  • s::HYPRESolver can be passed to HYPRE_* functions with HYPRE_Solver in the signature
+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. HYPRE.jl defines the appropriate conversion methods used by ccall such that

  • A::HYPREMatrix can be passed to HYPRE_* functions with HYPRE_IJMatrix or HYPRE_ParCSRMatrix in the signature
  • b::HYPREVector can be passed to HYPRE_* functions with HYPRE_IJVector or HYPRE_ParVector in the signature
  • s::HYPRESolver can be passed to HYPRE_* functions with HYPRE_Solver in the signature
diff --git a/dev/matrix-vector/index.html b/dev/matrix-vector/index.html index e58145d..446975f 100644 --- a/dev/matrix-vector/index.html +++ b/dev/matrix-vector/index.html @@ -48,4 +48,4 @@ # Inplace solve with x as initial guess x = zeros(length(b)) -solve!(solver, x, A, b) +solve!(solver, x, A, b) diff --git a/dev/solvers-preconditioners/index.html b/dev/solvers-preconditioners/index.html index e5b29ef..aa6bd8a 100644 --- a/dev/solvers-preconditioners/index.html +++ b/dev/solvers-preconditioners/index.html @@ -44,4 +44,4 @@ /* Solve */ HYPRE_ParCSRPCGSetup(solver, A, b, x); -HYPRE_ParCSRPCGSolve(solver, A, b, x); +HYPRE_ParCSRPCGSolve(solver, A, b, x);