hybit 0.6.0

Autonomous hybrid sparse linear solver with adaptive local direct correction
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

//! HyBIT — Autonomous Hybrid Sparse Solver.
//!
//! HyBIT 0.6.0 provides a Rust facade for real SPD sparse systems using
//! CSR32 input, PCG, adaptive selective local Cholesky correction, weighted
//! overlapping Schwarz, geometry-aware rigid-body coarse correction for 3-D
//! structural systems, and reusable analyze/prepare/solve-many contexts.
//!
//! # Example
//!
//! ```
//! use hybit::{Csr32Matrix, HybitSolver};
//!
//! let a = Csr32Matrix::new(
//!     3,
//!     3,
//!     vec![0, 2, 5, 7],
//!     vec![0, 1, 0, 1, 2, 1, 2],
//!     vec![2.0, -1.0, -1.0, 2.0, -1.0, -1.0, 2.0],
//! )?;
//! let b = vec![1.0, 0.0, 1.0];
//! let mut x = vec![0.0; 3];
//! let solver = HybitSolver::new();
//! let report = solver.solve_csr32(&a, &b, &mut x)?;
//! assert!(report.relative_residual < 1.0e-8);
//! # Ok::<(), hybit::HybitError>(())
//! ```
//!
//! The automatic path is currently experimental and restricted to real SPD
//! systems with PCG. See the repository README for current limitations.

pub use hybit_auto::{
    BackendPolicy, HybitAnalysis, HybitPreparedStructuralSystem, HybitPreparedSystem, HybitSolver,
    HybridOptions, StructuralOptions, StructuralPcgVectorPolicy, StructuralPreconditionerPolicy,
    StructuralSpmvPolicy, STRUCTURAL_PARALLEL_PCG_VECTOR_MIN_N,
    STRUCTURAL_PARALLEL_PCG_VECTOR_MIN_THREADS, STRUCTURAL_PARALLEL_PRECONDITIONER_MIN_NNZ,
    STRUCTURAL_PARALLEL_SPMV_MIN_NNZ,
};
pub use hybit_core::{
    HybitError, LinearOperator, MatrixBackend, Preconditioner, PreconditionerKind, SolveReport,
    SolveStatus, SolverKind, SolverOptions,
};
pub use hybit_krylov::{
    parallel_vector_worker_count, pcg, pcg_with_workspace, pcg_with_workspace_parallel_vectors,
    KrylovOutcome, PcgWorkspace, PARALLEL_PCG_VECTOR_CHUNK,
};
pub use hybit_matrix::{
    analyze_csr32, read_matrix_market, read_matrix_market_from_reader, write_matrix_market_general,
    AbtmConfig, AbtmMatrix, AbtmStats, Csr32Matrix, DofMask, MatrixMarketError, MatrixMarketInfo,
    MatrixMarketSymmetry, MatrixProfile, ParallelCsr32Operator, TileDesc, TileKind, TILE_WIDTH,
};
pub use hybit_precond::{
    recommend_rigid_body_aggregate_nodes, BalancedRigidBodyTwoLevelBlockJacobiPreconditioner,
    BlockJacobiPreconditioner, HybridPreconditioner, IdentityPreconditioner, JacobiPreconditioner,
    LocalCholeskyRegion, ParallelRigidBodyTwoLevelPreconditioner, RigidBodyAggregation,
    RigidBodyApplyProfile, RigidBodyTwoLevelBlockJacobiPreconditioner,
    TwoLevelBlockJacobiPreconditioner,
};

pub fn solve(matrix: &Csr32Matrix, b: &[f64]) -> Result<(Vec<f64>, SolveReport), HybitError> {
    let solver = HybitSolver::new();
    let mut x = vec![0.0; matrix.ncols()];
    let report = solver.solve_csr32(matrix, b, &mut x)?;
    Ok((x, report))
}