This document describes the FleCSI C++ API. The high-level documentation provides an introduction to the design and usage of the library more suitable to the new reader or developer as well as full examples for context.

The application layer provides a portable interface for defining and executing tasks and kernels, defining and accessing field data, utilities for creating command-line options, a logging utility (flog), and an interface for performance analysis using Caliper.

The topology layer provides several core FleCSI topology types, along with utilities designed to aid in the creation of application specialization libraries.

Warning

This version includes internal interfaces. Specialization and application developers should use only the interfaces documented in the user API reference, as there is no guarantee that those that appear only here will remain stable, e.g., a type or interface may simply be removed or changed.