Axom provides libraries that address common computer science needs. It grew from the recognition that physics codes at Lawrence Livermore National Laboratories had encountered the need for logging, a data store, geometric computation, file I/O, and other facilities and had addressed the needs in various idiosyncratic methods. Axom is designed to provide a drop-in replacement for code that wants to adopt it.
Axom components
- Core provides shared utility functionality to all components.
- Lumberjack: Log filtering and aggregation provides logging aggregation and filtering capability.
- Mint: Mesh Data Model provides a comprehensive mesh data model.
- Primal: Geometric primitives and associated computational geometry tests provides an API for geometric primitives and computational geometry tests.
- Quest: Query points in meshes provides an API to query point distance and position relative to meshes.
- Sidre: Simulation Data Repository provides a data store with hierarchical structure.
- Slam: A (S)et-theoretic (L)ightweight (A)PI for (M)eshes provides an API to construct and process meshes.
- Slic: Simple Logging Interface Code provides infrastructure for logging application messages.
- Spin: Spatial indexes, spatial acceleration data structures provides spatial acceleration data structures, also known as spatial indexes.
Dependencies between components are as follows:
- Core has no dependencies, and the other modules depend on Core
- Slic optionally depends on Lumberjack
- Slam, Primal, Mint, Quest, Spin, and Sidre depend on Slic
- Mint optionally depends on Sidre
- Spin depends on Primal and Slam
- Quest depends on Slam, Primal, Spin, and Mint
The figure below summarizes the dependencies between the modules. Solid links indicate hard dependencies; dashed links indicate optional dependencies.
Further documentation
- User manual
- Quick start guide
- Development guide (intended for Axom contributors)
- Coding style guide (intended for Axom contributors)
- Please see our license.
Each component contains a test subdirectory containing numerous code unit tests and an example subdirectory with more extensive demonstrations of the Axom library. The Sidre, Mint, and Slam examples include several versions of the lulesh mini-app, an implementation of the heat equation and a 1-D shock tube simulation.
