Examples

Annotated walkthroughs of every example shipped under examples/ in the Ginkgo source tree. Each page interleaves the source with explanatory commentary, lists the prerequisite examples it builds on, and reproduces the expected output. The full program is included at the bottom so you can copy it verbatim.

Navigation graph

Edges flow from each example to the ones that build on it — follow the arrows to go from the simplest setups toward more advanced material. Click any node to jump to its page.

        %%{init: {'theme': 'base', 'themeVariables': {'fontSize': '20px', 'fontFamily': 'system-ui'}, 'flowchart': {'nodeSpacing': 40, 'rankSpacing': 60, 'useMaxWidth': false, 'htmlLabels': true, 'padding': 16}}}%%
graph TB
  adaptiveprecision_blockjacobi[adaptiveprecision-blockjacobi]
  batched_solver[batched-solver]
  cb_gmres[cb-gmres]
  custom_logger[custom-logger]
  custom_matrix_format[custom-matrix-format]
  custom_stopping_criterion[custom-stopping-criterion]
  distributed_multigrid_preconditioned_solver[distributed-multigrid-preconditioned-solver]
  distributed_solver[distributed-solver]
  external_lib_interfacing[external-lib-interfacing]
  file_config_solver[file-config-solver]
  ginkgo_overhead[ginkgo-overhead]
  ginkgo_ranges[ginkgo-ranges]
  heat_equation[heat-equation]
  ilu_preconditioned_solver[ilu-preconditioned-solver]
  inverse_iteration[inverse-iteration]
  ir_ilu_preconditioned_solver[ir-ilu-preconditioned-solver]
  iterative_refinement[iterative-refinement]
  kokkos_assembly[kokkos-assembly]
  minimal_cuda_solver[minimal-cuda-solver]
  mixed_multigrid_preconditioned_solver[mixed-multigrid-preconditioned-solver]
  mixed_multigrid_solver[mixed-multigrid-solver]
  mixed_precision_ir[mixed-precision-ir]
  mixed_spmv[mixed-spmv]
  multigrid_preconditioned_solver[multigrid-preconditioned-solver]
  multigrid_preconditioned_solver_customized[multigrid-preconditioned-solver-customized]
  nine_pt_stencil_solver[nine-pt-stencil-solver]
  papi_logging[papi-logging]
  par_ilu_convergence[par-ilu-convergence]
  performance_debugging[performance-debugging]
  poisson_solver[poisson-solver]
  preconditioned_solver[preconditioned-solver]
  preconditioner_export[preconditioner-export]
  reordered_preconditioned_solver[reordered-preconditioned-solver]
  schroedinger_splitting[schroedinger-splitting]
  simple_solver[simple-solver]
  simple_solver_logging[simple-solver-logging]
  three_pt_stencil_solver[three-pt-stencil-solver]
  preconditioned_solver --> adaptiveprecision_blockjacobi
  simple_solver --> custom_logger
  simple_solver_logging --> custom_logger
  minimal_cuda_solver --> custom_logger
  simple_solver --> custom_matrix_format
  poisson_solver --> custom_matrix_format
  three_pt_stencil_solver --> custom_matrix_format
  simple_solver --> custom_stopping_criterion
  minimal_cuda_solver --> custom_stopping_criterion
  distributed_solver --> distributed_multigrid_preconditioned_solver
  simple_solver --> distributed_solver
  three_pt_stencil_solver --> distributed_solver
  simple_solver --> file_config_solver
  simple_solver --> heat_equation
  three_pt_stencil_solver --> heat_equation
  simple_solver --> ilu_preconditioned_solver
  simple_solver --> inverse_iteration
  ilu_preconditioned_solver --> ir_ilu_preconditioned_solver
  iterative_refinement --> ir_ilu_preconditioned_solver
  simple_solver --> iterative_refinement
  simple_solver --> kokkos_assembly
  poisson_solver --> kokkos_assembly
  three_pt_stencil_solver --> kokkos_assembly
  simple_solver --> minimal_cuda_solver
  multigrid_preconditioned_solver --> mixed_multigrid_preconditioned_solver
  mixed_multigrid_solver --> mixed_multigrid_preconditioned_solver
  simple_solver --> mixed_multigrid_solver
  iterative_refinement --> mixed_precision_ir
  preconditioned_solver --> multigrid_preconditioned_solver
  multigrid_preconditioned_solver --> multigrid_preconditioned_solver_customized
  simple_solver --> nine_pt_stencil_solver
  three_pt_stencil_solver --> nine_pt_stencil_solver
  poisson_solver --> nine_pt_stencil_solver
  simple_solver_logging --> papi_logging
  simple_solver --> par_ilu_convergence
  simple_solver_logging --> performance_debugging
  minimal_cuda_solver --> performance_debugging
  simple_solver --> poisson_solver
  simple_solver --> preconditioned_solver
  simple_solver --> preconditioner_export
  preconditioned_solver --> reordered_preconditioned_solver
  heat_equation --> schroedinger_splitting
  simple_solver --> simple_solver_logging
  minimal_cuda_solver --> simple_solver_logging
  simple_solver --> three_pt_stencil_solver
  poisson_solver --> three_pt_stencil_solver
  click adaptiveprecision_blockjacobi "adaptiveprecision-blockjacobi.html" "Open adaptiveprecision-blockjacobi"
  click batched_solver "batched-solver.html" "Open batched-solver"
  click cb_gmres "cb-gmres.html" "Open cb-gmres"
  click custom_logger "custom-logger.html" "Open custom-logger"
  click custom_matrix_format "custom-matrix-format.html" "Open custom-matrix-format"
  click custom_stopping_criterion "custom-stopping-criterion.html" "Open custom-stopping-criterion"
  click distributed_multigrid_preconditioned_solver "distributed-multigrid-preconditioned-solver.html" "Open distributed-multigrid-preconditioned-solver"
  click distributed_solver "distributed-solver.html" "Open distributed-solver"
  click external_lib_interfacing "external-lib-interfacing.html" "Open external-lib-interfacing"
  click file_config_solver "file-config-solver.html" "Open file-config-solver"
  click ginkgo_overhead "ginkgo-overhead.html" "Open ginkgo-overhead"
  click ginkgo_ranges "ginkgo-ranges.html" "Open ginkgo-ranges"
  click heat_equation "heat-equation.html" "Open heat-equation"
  click ilu_preconditioned_solver "ilu-preconditioned-solver.html" "Open ilu-preconditioned-solver"
  click inverse_iteration "inverse-iteration.html" "Open inverse-iteration"
  click ir_ilu_preconditioned_solver "ir-ilu-preconditioned-solver.html" "Open ir-ilu-preconditioned-solver"
  click iterative_refinement "iterative-refinement.html" "Open iterative-refinement"
  click kokkos_assembly "kokkos-assembly.html" "Open kokkos-assembly"
  click minimal_cuda_solver "minimal-cuda-solver.html" "Open minimal-cuda-solver"
  click mixed_multigrid_preconditioned_solver "mixed-multigrid-preconditioned-solver.html" "Open mixed-multigrid-preconditioned-solver"
  click mixed_multigrid_solver "mixed-multigrid-solver.html" "Open mixed-multigrid-solver"
  click mixed_precision_ir "mixed-precision-ir.html" "Open mixed-precision-ir"
  click mixed_spmv "mixed-spmv.html" "Open mixed-spmv"
  click multigrid_preconditioned_solver "multigrid-preconditioned-solver.html" "Open multigrid-preconditioned-solver"
  click multigrid_preconditioned_solver_customized "multigrid-preconditioned-solver-customized.html" "Open multigrid-preconditioned-solver-customized"
  click nine_pt_stencil_solver "nine-pt-stencil-solver.html" "Open nine-pt-stencil-solver"
  click papi_logging "papi-logging.html" "Open papi-logging"
  click par_ilu_convergence "par-ilu-convergence.html" "Open par-ilu-convergence"
  click performance_debugging "performance-debugging.html" "Open performance-debugging"
  click poisson_solver "poisson-solver.html" "Open poisson-solver"
  click preconditioned_solver "preconditioned-solver.html" "Open preconditioned-solver"
  click preconditioner_export "preconditioner-export.html" "Open preconditioner-export"
  click reordered_preconditioned_solver "reordered-preconditioned-solver.html" "Open reordered-preconditioned-solver"
  click schroedinger_splitting "schroedinger-splitting.html" "Open schroedinger-splitting"
  click simple_solver "simple-solver.html" "Open simple-solver"
  click simple_solver_logging "simple-solver-logging.html" "Open simple-solver-logging"
  click three_pt_stencil_solver "three-pt-stencil-solver.html" "Open three-pt-stencil-solver"
  classDef basic fill:#dcfce7,stroke:#16a34a,color:#14532d
  classDef precond fill:#dbeafe,stroke:#2563eb,color:#1e3a8a
  classDef stop fill:#fef3c7,stroke:#d97706,color:#78350f
  classDef mixed fill:#fce7f3,stroke:#db2777,color:#831843
  classDef logging fill:#ede9fe,stroke:#7c3aed,color:#4c1d95
  classDef tech fill:#f1f5f9,stroke:#475569,color:#1e293b
  classDef batched fill:#ffe4e6,stroke:#e11d48,color:#881337
  classDef distributed fill:#ffedd5,stroke:#ea580c,color:#7c2d12
  class adaptiveprecision_blockjacobi mixed
  class mixed_multigrid_solver mixed
  class mixed_precision_ir mixed
  class mixed_spmv mixed
  class batched_solver batched
  class cb_gmres tech
  class custom_matrix_format tech
  class external_lib_interfacing tech
  class file_config_solver tech
  class ginkgo_overhead tech
  class ginkgo_ranges tech
  class heat_equation tech
  class inverse_iteration tech
  class kokkos_assembly tech
  class schroedinger_splitting tech
  class custom_logger logging
  class papi_logging logging
  class performance_debugging logging
  class simple_solver_logging logging
  class custom_stopping_criterion stop
  class distributed_multigrid_preconditioned_solver distributed
  class distributed_solver distributed
  class ilu_preconditioned_solver precond
  class ir_ilu_preconditioned_solver precond
  class mixed_multigrid_preconditioned_solver precond
  class multigrid_preconditioned_solver precond
  class multigrid_preconditioned_solver_customized precond
  class par_ilu_convergence precond
  class preconditioned_solver precond
  class preconditioner_export precond
  class reordered_preconditioned_solver precond
  class iterative_refinement basic
  class minimal_cuda_solver basic
  class nine_pt_stencil_solver basic
  class poisson_solver basic
  class simple_solver basic
  class three_pt_stencil_solver basic
    

Browse by category

Basic solver setups

• iterative-refinement — The iterative refinement solver example.

• minimal-cuda-solver — The minimal CUDA solver example.

• nine-pt-stencil-solver — The 9-point stencil example.

• poisson-solver — The poisson solver example.

• simple-solver — The simple solver example.

• three-pt-stencil-solver — The 3-point stencil example.

Preconditioners

• ilu-preconditioned-solver — The ILU-preconditioned solver example.

• ir-ilu-preconditioned-solver — The IR-ILU preconditioned solver example.

• mixed-multigrid-preconditioned-solver — The preconditioned solver example.

• multigrid-preconditioned-solver — The preconditioned solver example.

• multigrid-preconditioned-solver-customized — The customized multigrid preconditioned solver example.

• par-ilu-convergence — The ParILU convergence example.

• preconditioned-solver — The preconditioned solver example.

• preconditioner-export — The preconditioner export example.

• reordered-preconditioned-solver — The reordered preconditioned solver example.

Stopping criteria

• custom-stopping-criterion — The custom stopping criterion creation example.

Mixed precision

• adaptiveprecision-blockjacobi — The preconditioned solver example.

• mixed-multigrid-solver — The mixed multigrid solver example.

• mixed-precision-ir — The Mixed Precision Iterative Refinement (MPIR) solver example.

• mixed-spmv — The mixed spmv example.

Logging and observability

• custom-logger — The simple solver with a custom logger example.

• papi-logging — The papi logging example.

• performance-debugging — The simple solver with performance debugging example.

• simple-solver-logging — The simple solver with logging example.

Techniques and integrations

• cb-gmres — The CB-GMRES solver example.

• custom-matrix-format — The custom matrix format example.

• external-lib-interfacing — The external library(deal.II) interfacing example.

• file-config-solver — The file config solver example.

• ginkgo-overhead — The ginkgo overhead measurement example.

• ginkgo-ranges — The ranges and accessor example.

• heat-equation — The heat equation example.

• inverse-iteration — The inverse iteration example.

• kokkos-assembly — The Kokkos assembly example.

• schroedinger-splitting — The Schroedinger equation example.

Batched functionality

• batched-solver — Using and interfacing with a batched solver.

Distributed solvers

• distributed-multigrid-preconditioned-solver — The distributed multigrid preconditioned solver with customized components example.

• distributed-solver — The distributed solver example.