HyBIT documentation
HyBIT 0.8.0 is the current published release. The immutable release source is tagged v0.8.0.
Rendered documentation: https://michioga.github.io/hybit/
The site is built with mdBook from the Markdown files in this directory and GitHub Pages deploys the frozen release documentation from main.
Start here
For library users:
- User guide — choose a problem class, configure a solver, prepare reusable state, solve, and validate the result.
- Solver selection and Krylov theory — understand why SPD uses PCG, GeneralSquare uses FGMRES, how preconditioning changes the mathematical contract, and what MINRES/LSQR-class future routes require.
- Prepared execution — understand
analyze -> prepare -> solve-many, reuse boundaries, and memory ownership. - General-square systems — FGMRES, restart policies, Jacobi versus ILU(0), pivot stabilization, and current limitations.
- Structural Auto API — 3-D structural SPD systems with rigid-body coarse correction.
- Threading and host-runtime interoperability — Rayon/OpenMP thread-count precedence, MPI/OpenMP embedding, and oversubscription rules.
For numerical background:
- Solver selection and Krylov theory — matrix-class contracts, PCG/FGMRES mechanics, restart cost, compatibility, and breakdown.
- Hybrid SPD mathematics — selective local direct correction, overlap weighting, and resumable PCG logic.
- Architecture — crate boundaries, execution architecture, resident CPU work, FGMRES checkpoints, and internal policy flow.
- ABTM topology algebra — planned symbolic/topology layer, metadata-first numerical pruning, adaptive/block layouts, and validation sequence for CPU, GPU, and distributed execution.
For project status:
- Development status — published release versus the current development branch.
- Roadmap — completed and planned work.
- FEM benchmark and benchmark README — reproducible validation.
- Publishing — release discipline and immutable release tags.
Documentation layers
| Layer | Primary question | Main documents |
|---|---|---|
| User | How do I solve my system correctly? | USER_GUIDE.md, PREPARED_API.md, GENERAL_SQUARE.md, STRUCTURAL_AUTO_API.md |
| Numerical | What mathematical method is being applied, and why? | SOLVER_SELECTION.md, GENERAL_SQUARE.md, HYBRID_MATH.md |
| Architecture | How are reusable/execution and symbolic topology states organized? | ARCHITECTURE.md, ABTM_TOPOLOGY.md |
| Development | What is published, validated, experimental, or planned? | DEVELOPMENT_STATUS.md, ROADMAP.md, CHANGELOG.md |
Benchmark results are evidence for tested cases, not universal performance claims.