User Manual

Contents:

• Introduction
  • Overview
  • License
• Building and Installing
  • Installation and Building for Linux
    • Prerequisites
    • Installing pre-built packages
    • Building from GitHub repository
  • Installation and Building for Windows
    • Prerequisites
    • Installing Prebuilt Packages
    • Building and Installing rocALUTION
• Basics
  • Operators and Vectors
    • Local Operators and Vectors
    • Global Operators and Vectors
  • Backend Descriptor and User Control
    • Initialization of rocALUTION
    • Thread-core Mapping
    • OpenMP Threshold Size
    • Accelerator Selection
    • Disable the Accelerator
    • Backend Information
    • MPI and Multi-Accelerators
  • Automatic Object Tracking
  • Verbose Output
  • Verbose Output and MPI
  • Debug Output
  • File Logging
  • Versions
• Single-node Computation
  • Introduction
  • ValueType
  • Complex Support
  • Allocation and Free
    • Allocate()
    • Clear()
    • AllocateCOO()
    • AllocateCSR()
    • AllocateBCSR()
    • AllocateMCSR()
    • AllocateELL()
    • AllocateDIA()
    • AllocateHYB()
    • AllocateDENSE()
    • Clear()
  • Matrix Formats
    • COO storage format
    • CSR storage format
    • BCSR storage format
    • ELL storage format
    • DIA storage format
    • HYB storage format
    • Memory Usage
  • File I/O
    • ReadFileASCII()
    • WriteFileASCII()
    • ReadFileBinary()
    • WriteFileBinary()
    • ReadFileMTX()
    • WriteFileMTX()
    • ReadFileCSR()
    • WriteFileCSR()
  • Access
  • Raw Access to the Data
    • SetDataPtr
    • LeaveDataPtr
  • Copy CSR Matrix Host Data
    • CopyFromHostCSR()
  • Copy Data
    • CopyFromData()
    • CopyToData()
  • Object Info
    • Info()
  • Copy
    • CopyFrom()
    • CopyFrom()
  • Clone
    • CloneFrom
    • CloneBackend
  • Check
    • Check()
    • Check()
  • Sort
    • Sort()
  • Keying
    • Key()
  • Graph Analyzers
    • Cuthill-McKee Ordering
    • Maximal Independent Set
    • Multi-Coloring
    • Zero Block Permutation
    • Connectivity Ordering
  • Basic Linear Algebra Operations
• Multi-node Computation
  • Introduction
  • Code Structure
  • Parallel Manager
    • ParallelManager
  • Global Matrices and Vectors
    • GetInterior()
    • GetGhost()
    • Asynchronous SpMV
  • File I/O
    • File Organization
    • Parallel Manager
    • Matrices
    • Vectors
• Solvers
  • Code Structure
    • Solver
  • Iterative Linear Solvers
    • IterativeLinearSolver
  • Building and Solving Phase
  • Clear Function and Destructor
  • Numerical Update
  • Fixed-Point Iteration
    • FixedPoint
  • Krylov Subspace Solvers
    • CG
    • CR
    • GMRES
    • FGMRES
    • BiCGStab
    • IDR
    • FCG
    • QMRCGStab
    • BiCGStab(l)
  • Chebyshev Iteration Scheme
    • Chebyshev
  • Mixed-Precision Defect Correction Scheme
    • MixedPrecisionDC
  • MultiGrid Solvers
    • BaseMultiGrid
    • Geometric MultiGrid
    • Algebraic MultiGrid
  • Unsmoothed Aggregation AMG
    • UAAMG
  • Smoothed Aggregation AMG
    • SAAMG
  • Ruge-Stueben AMG
    • RugeStuebenAMG
  • Pairwise AMG
    • PairwiseAMG
  • Direct Linear Solvers
    • DirectLinearSolver
    • LU
    • QR
    • Inversion
• Preconditioners
  • Preconditioner
  • Code Structure
  • Jacobi Method
    • Jacobi
  • (Symmetric) Gauss-Seidel / (S)SOR Method
    • GS
    • SGS
  • Incomplete Factorizations
    • ILU
    • ILUT
    • IC
  • AI Chebyshev
    • AIChebyshev
  • FSAI
    • FSAI
  • SPAI
    • SPAI
  • TNS
    • TNS
  • MultiColored Preconditioners
    • MultiColored
    • MultiColored (Symmetric) Gauss-Seidel / (S)SOR
    • MultiColored Power(q)-pattern method ILU(p,q)
  • Multi-Elimination Incomplete LU
    • MultiElimination
  • Diagonal Preconditioner for Saddle-Point Problems
    • DiagJacobiSaddlePointPrecond
  • (Restricted) Additive Schwarz Preconditioner
    • AS
    • RAS
  • Block-Jacobi (MPI) Preconditioner
    • BlockJacobi
  • Block Preconditioner
    • BlockPreconditioner
  • Variable Preconditioner
    • VariablePreconditioner
• Backends
  • Moving Objects To and From the Accelerator
    • MoveToAccelerator()
    • MoveToHost()
  • Asynchronous Transfers
    • MoveToAcceleratorAsync()
    • MoveToHostAsync()
    • Sync()
  • Systems without Accelerators
  • Memory Allocations
    • Allocation Problems
    • Memory Alignment
    • Pinned Memory Allocation (HIP)
• Remarks
  • Performance
  • Accelerators
  • Correctness
• Supported Targets