2 Programming Guide

NOTE: The information on these pages attempts to stay up to date with latest release of the library. Please open an issue if something is misleading or could be improved.

The Cabana programming guide covers core concepts and directed examples of using the library API. Cabana is built on Kokkos - understanding of Kokkos concepts and syntax is a necessary prerequisite (Kokkos wiki). Other optional libraries are used for specific purposes within Cabana as shown in the figure below, each with a separate tutorial example.

Some relevant similarities and differences between Cabana and Kokkos are noted here.

Core Package

• Introduction

• Particle data structures:

  • Tuple
  • SoA
  • AoSoA
  • Slice
  • ParticleList

• Particle algorithms:

  • Deep Copy
  • Sorting and Binning
  • Linked Cell List
  • Verlet neighbor lists
  • Tree-based neighbor lists (Experimental) through optional ArborX library
  • Parallel Loops

• Particle MPI Communication:

  • Migration
  • Halo Exchange

• Particle I/O

Note: these are likely best understood in this order.

Grid

Optional grid and particle-grid infrastructure is also included in Cabana.

Originally a separate library called Cajita, the Cabana::Grid subpackage provides logically rectilinear grids, algorithms and parallel iteration over those grids, and particle-grid algorithms.

• Uniform grid data structures

  • Types
  • Global Mesh
  • Partitioners
  • Global Grid
  • Index Space
  • Local Grid
  • Local Mesh
  • Array

• Grid algorithms

  • Grid Parallel
  • FFT (Experimental) through optional heFFTe library
  • Structured solvers
  • Structured solvers through optional HYPRE library

• Grid MPI communication

  • Halo
  • Load balancing (Experimental) through optional ALL library

• Particle-grid algorithms

  • Splines
  • Interpolation

• Grid I/O

• Sparse Grid (in progress)

  • Sparse Index Space
  • Sparse Partitioner